aws_sdk_pinpointsmsvoicev2/client/

describe_opt_out_lists.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeOptOutLists`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`opt_out_list_names(impl Into<String>)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::opt_out_list_names) / [`set_opt_out_list_names(Option<Vec::<String>>)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::set_opt_out_list_names):<br>required: **false**<br><p>The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.</p><important>  <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per each request.</p><br>
    ///   - [`owner(Owner)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::owner) / [`set_owner(Option<Owner>)`](crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::set_owner):<br>required: **false**<br><p>Use <code>SELF</code> to filter the list of Opt-Out List to ones your account owns or use <code>SHARED</code> to filter on Opt-Out List shared with your account. The <code>Owner</code> and <code>OptOutListNames</code> parameters can't be used at the same time.</p><br>
    /// - On success, responds with [`DescribeOptOutListsOutput`](crate::operation::describe_opt_out_lists::DescribeOptOutListsOutput) with field(s):
    ///   - [`opt_out_lists(Option<Vec::<OptOutListInformation>>)`](crate::operation::describe_opt_out_lists::DescribeOptOutListsOutput::opt_out_lists): <p>An array of OptOutListInformation objects that contain the details for the requested OptOutLists.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_opt_out_lists::DescribeOptOutListsOutput::next_token): <p>The token to be used for the next set of paginated results. If this field is empty then there are no more results.</p>
    /// - On failure, responds with [`SdkError<DescribeOptOutListsError>`](crate::operation::describe_opt_out_lists::DescribeOptOutListsError)
    pub fn describe_opt_out_lists(&self) -> crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder {
        crate::operation::describe_opt_out_lists::builders::DescribeOptOutListsFluentBuilder::new(self.handle.clone())
    }
}