Struct aws_sdk_pinpoint::model::CampaignDateRangeKpiResponse

#[non_exhaustive]
pub struct CampaignDateRangeKpiResponse {
    pub application_id: Option<String>,
    pub campaign_id: Option<String>,
    pub end_time: Option<DateTime>,
    pub kpi_name: Option<String>,
    pub kpi_result: Option<BaseKpiResult>,
    pub next_token: Option<String>,
    pub start_time: Option<DateTime>,
}

Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

application_id: Option<String>

The unique identifier for the application that the metric applies to.

campaign_id: Option<String>

The unique identifier for the campaign that the metric applies to.

end_time: Option<DateTime>

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

kpi_name: Option<String>

The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

kpi_result: Option<BaseKpiResult>

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

next_token: Option<String>

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

start_time: Option<DateTime>

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

Implementations

impl CampaignDateRangeKpiResponse

pub fn application_id(&self) -> Option<&str>

The unique identifier for the application that the metric applies to.

pub fn campaign_id(&self) -> Option<&str>

The unique identifier for the campaign that the metric applies to.

pub fn end_time(&self) -> Option<&DateTime>

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

pub fn kpi_name(&self) -> Option<&str>

The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

pub fn kpi_result(&self) -> Option<&BaseKpiResult>

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

pub fn next_token(&self) -> Option<&str>

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

pub fn start_time(&self) -> Option<&DateTime>

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

impl CampaignDateRangeKpiResponse

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CampaignDateRangeKpiResponse

Trait Implementations

impl Clone for CampaignDateRangeKpiResponse

fn clone(&self) -> CampaignDateRangeKpiResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CampaignDateRangeKpiResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CampaignDateRangeKpiResponse> for CampaignDateRangeKpiResponse

fn eq(&self, other: &CampaignDateRangeKpiResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CampaignDateRangeKpiResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for CampaignDateRangeKpiResponse