aws_sdk_pinpoint/client/
get_journey_run_execution_activity_metrics.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetJourneyRunExecutionActivityMetrics`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::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>
7    ///   - [`journey_activity_id(impl Into<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::journey_activity_id) / [`set_journey_activity_id(Option<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::set_journey_activity_id):<br>required: **true**<br><p>The unique identifier for the journey activity.</p><br>
8    ///   - [`journey_id(impl Into<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::journey_id) / [`set_journey_id(Option<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::set_journey_id):<br>required: **true**<br><p>The unique identifier for the journey.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::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>
10    ///   - [`page_size(impl Into<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::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>
11    ///   - [`run_id(impl Into<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::set_run_id):<br>required: **true**<br><p>The unique identifier for the journey run.</p><br>
12    /// - On success, responds with [`GetJourneyRunExecutionActivityMetricsOutput`](crate::operation::get_journey_run_execution_activity_metrics::GetJourneyRunExecutionActivityMetricsOutput) with field(s):
13    ///   - [`journey_run_execution_activity_metrics_response(Option<JourneyRunExecutionActivityMetricsResponse>)`](crate::operation::get_journey_run_execution_activity_metrics::GetJourneyRunExecutionActivityMetricsOutput::journey_run_execution_activity_metrics_response): <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.</p>
14    /// - On failure, responds with [`SdkError<GetJourneyRunExecutionActivityMetricsError>`](crate::operation::get_journey_run_execution_activity_metrics::GetJourneyRunExecutionActivityMetricsError)
15    pub fn get_journey_run_execution_activity_metrics(
16        &self,
17    ) -> crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder {
18        crate::operation::get_journey_run_execution_activity_metrics::builders::GetJourneyRunExecutionActivityMetricsFluentBuilder::new(
19            self.handle.clone(),
20        )
21    }
22}