Struct aws_sdk_pinpointsmsvoicev2::client::fluent_builders::DescribeOptOutLists

pub struct DescribeOptOutLists { /* private fields */ }

Fluent builder constructing a request to DescribeOptOutLists.

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an Error is returned.

Implementations

impl DescribeOptOutLists

pub async fn send(
    self
) -> Result<DescribeOptOutListsOutput, SdkError<DescribeOptOutListsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeOptOutListsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn opt_out_list_names(self, input: impl Into<String>) -> Self

Appends an item to OptOutListNames.

To override the contents of this collection use set_opt_out_list_names.

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

pub fn set_opt_out_list_names(self, input: Option<Vec<String>>) -> Self

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return per each request.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return per each request.

Trait Implementations

impl Clone for DescribeOptOutLists

fn clone(&self) -> DescribeOptOutLists

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeOptOutLists

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.