aws_sdk_pinpoint/client/

get_journey_run_execution_metrics.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetJourneyRunExecutionMetrics`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p><br>
    ///   - [`journey_id(impl Into<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::journey_id) / [`set_journey_id(Option<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::set_journey_id):<br>required: **true**<br><p>The unique identifier for the journey.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code></code> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p><br>
    ///   - [`page_size(impl Into<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::set_page_size):<br>required: **false**<br><p>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.</p><br>
    ///   - [`run_id(impl Into<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::set_run_id):<br>required: **true**<br><p>The unique identifier for the journey run.</p><br>
    /// - On success, responds with [`GetJourneyRunExecutionMetricsOutput`](crate::operation::get_journey_run_execution_metrics::GetJourneyRunExecutionMetricsOutput) with field(s):
    ///   - [`journey_run_execution_metrics_response(Option<JourneyRunExecutionMetricsResponse>)`](crate::operation::get_journey_run_execution_metrics::GetJourneyRunExecutionMetricsOutput::journey_run_execution_metrics_response): <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.</p>
    /// - On failure, responds with [`SdkError<GetJourneyRunExecutionMetricsError>`](crate::operation::get_journey_run_execution_metrics::GetJourneyRunExecutionMetricsError)
    pub fn get_journey_run_execution_metrics(
        &self,
    ) -> crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder {
        crate::operation::get_journey_run_execution_metrics::builders::GetJourneyRunExecutionMetricsFluentBuilder::new(self.handle.clone())
    }
}