aws_sdk_pinpoint/client/

get_segments.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSegments`](crate::operation::get_segments::builders::GetSegmentsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::get_segments::builders::GetSegmentsFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_segments::builders::GetSegmentsFluentBuilder::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::get_segments::builders::GetSegmentsFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::get_segments::builders::GetSegmentsFluentBuilder::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::get_segments::builders::GetSegmentsFluentBuilder::token) / [`set_token(Option<String>)`](crate::operation::get_segments::builders::GetSegmentsFluentBuilder::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 [`GetSegmentsOutput`](crate::operation::get_segments::GetSegmentsOutput) with field(s):
    ///   - [`segments_response(Option<SegmentsResponse>)`](crate::operation::get_segments::GetSegmentsOutput::segments_response): <p>Provides information about all the segments that are associated with an application.</p>
    /// - On failure, responds with [`SdkError<GetSegmentsError>`](crate::operation::get_segments::GetSegmentsError)
    pub fn get_segments(&self) -> crate::operation::get_segments::builders::GetSegmentsFluentBuilder {
        crate::operation::get_segments::builders::GetSegmentsFluentBuilder::new(self.handle.clone())
    }
}