PinpointSMSVoiceV2 / Paginator / DescribeOptOutLists

DescribeOptOutLists

class PinpointSMSVoiceV2.Paginator.DescribeOptOutLists

paginator = client.get_paginator('describe_opt_out_lists')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_opt_out_lists().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OptOutListNames=[
        'string',
    ],
    Owner='SELF'|'SHARED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OptOutListNames (list) –

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

  Warning

  If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

  • (string) –

• Owner (string) – Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can’t be used at the same time.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'OptOutLists': [
        {
            'OptOutListArn': 'string',
            'OptOutListName': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • OptOutLists (list) –

    An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

    • (dict) –

      The information for all OptOutList in an Amazon Web Services account.

      • OptOutListArn (string) –

        The Amazon Resource Name (ARN) of the OptOutList.

      • OptOutListName (string) –

        The name of the OptOutList.

      • CreatedTimestamp (datetime) –

        The time when the OutOutList was created, in UNIX epoch time format.