pub struct GetJourneyDateRangeKpi<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description
Fluent builder constructing a request to GetJourneyDateRangeKpi
.
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
Implementations
impl<C, M, R> GetJourneyDateRangeKpi<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> GetJourneyDateRangeKpi<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<GetJourneyDateRangeKpiOutput, SdkError<GetJourneyDateRangeKpiError>> where
R::Policy: SmithyRetryPolicy<GetJourneyDateRangeKpiInputOperationOutputAlias, GetJourneyDateRangeKpiOutput, GetJourneyDateRangeKpiError, GetJourneyDateRangeKpiInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<GetJourneyDateRangeKpiOutput, SdkError<GetJourneyDateRangeKpiError>> where
R::Policy: SmithyRetryPolicy<GetJourneyDateRangeKpiInputOperationOutputAlias, GetJourneyDateRangeKpiOutput, GetJourneyDateRangeKpiError, GetJourneyDateRangeKpiInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
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.
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.
The unique identifier for the journey.
The unique identifier for the journey.
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.
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.
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.
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.
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.
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.
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.
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
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for GetJourneyDateRangeKpi<C, M, R>
impl<C, M, R> Send for GetJourneyDateRangeKpi<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for GetJourneyDateRangeKpi<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for GetJourneyDateRangeKpi<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for GetJourneyDateRangeKpi<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more