aws_sdk_pinpoint/client/
get_journey_runs.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 [`GetJourneyRuns`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::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_id(impl Into<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::journey_id) / [`set_journey_id(Option<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::set_journey_id):<br>required: **true**<br><p>The unique identifier for the journey.</p><br>
8    ///   - [`page_size(impl Into<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::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>
9    ///   - [`token(impl Into<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::token) / [`set_token(Option<String>)`](crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::set_token):<br>required: **false**<br><p>The NextToken string that specifies which page of results to return in a paginated response.</p><br>
10    /// - On success, responds with [`GetJourneyRunsOutput`](crate::operation::get_journey_runs::GetJourneyRunsOutput) with field(s):
11    ///   - [`journey_runs_response(Option<JourneyRunsResponse>)`](crate::operation::get_journey_runs::GetJourneyRunsOutput::journey_runs_response): <p>Provides information from all runs of a journey.</p>
12    /// - On failure, responds with [`SdkError<GetJourneyRunsError>`](crate::operation::get_journey_runs::GetJourneyRunsError)
13    pub fn get_journey_runs(&self) -> crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder {
14        crate::operation::get_journey_runs::builders::GetJourneyRunsFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_pinpoint/client/get_journey_runs.rs

aws_sdk_pinpoint/client/
get_journey_runs.rs
