aws_sdk_pinpoint/client/

list_journeys.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListJourneys`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder::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>
    ///   - [`page_size(impl Into<String>)`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder::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>
    ///   - [`token(impl Into<String>)`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder::token) / [`set_token(Option<String>)`](crate::operation::list_journeys::builders::ListJourneysFluentBuilder::set_token):<br>required: **false**<br><p>The NextToken string that specifies which page of results to return in a paginated response.</p><br>
    /// - On success, responds with [`ListJourneysOutput`](crate::operation::list_journeys::ListJourneysOutput) with field(s):
    ///   - [`journeys_response(Option<JourneysResponse>)`](crate::operation::list_journeys::ListJourneysOutput::journeys_response): <p>Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.</p>
    /// - On failure, responds with [`SdkError<ListJourneysError>`](crate::operation::list_journeys::ListJourneysError)
    pub fn list_journeys(&self) -> crate::operation::list_journeys::builders::ListJourneysFluentBuilder {
        crate::operation::list_journeys::builders::ListJourneysFluentBuilder::new(self.handle.clone())
    }
}