Struct aws_sdk_pinpoint::input::GetApplicationDateRangeKpiInput

#[non_exhaustive]
pub struct GetApplicationDateRangeKpiInput {
    pub application_id: Option<String>,
    pub end_time: Option<DateTime>,
    pub kpi_name: Option<String>,
    pub next_token: Option<String>,
    pub page_size: Option<String>,
    pub start_time: Option<DateTime>,
}

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. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

end_time: Option<DateTime>

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

kpi_name: Option<String>

The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data 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. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

next_token: Option<String>

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

page_size: Option<String>

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

start_time: Option<DateTime>

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

Implementations

impl GetApplicationDateRangeKpiInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GetApplicationDateRangeKpi, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GetApplicationDateRangeKpi>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetApplicationDateRangeKpiInput

impl GetApplicationDateRangeKpiInput

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

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

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

The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data 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. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

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

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

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

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

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

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

Trait Implementations

impl Clone for GetApplicationDateRangeKpiInput

fn clone(&self) -> GetApplicationDateRangeKpiInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetApplicationDateRangeKpiInput

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

Formats the value using the given formatter.

impl PartialEq<GetApplicationDateRangeKpiInput> for GetApplicationDateRangeKpiInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for GetApplicationDateRangeKpiInput