PinpointSMSVoiceV2 / Paginator / DescribeOptedOutNumbers

DescribeOptedOutNumbers

class PinpointSMSVoiceV2.Paginator.DescribeOptedOutNumbers

paginator = client.get_paginator('describe_opted_out_numbers')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OptOutListName='string',
    OptedOutNumbers=[
        'string',
    ],
    Filters=[
        {
            'Name': 'end-user-opted-out',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OptOutListName (string) –

  [REQUIRED]

  The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and 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).

• OptedOutNumbers (list) –

  An array of phone numbers to search for in the OptOutList.

  If you specify an opted out number that isn’t valid, an exception is returned.

  • (string) –

• Filters (list) –

  An array of OptedOutFilter objects to filter the results on.

  • (dict) –

    The information for opted out numbers that meet a specified criteria.

    • Name (string) – [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) – [REQUIRED]

      An array of values to filter for.

      • (string) –

• 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

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'OptedOutNumbers': [
        {
            'OptedOutNumber': 'string',
            'OptedOutTimestamp': datetime(2015, 1, 1),
            'EndUserOptedOut': True|False
        },
    ],

}

Response Structure

• (dict) –

  • OptOutListArn (string) –

    The Amazon Resource Name (ARN) of the OptOutList.

  • OptOutListName (string) –

    The name of the OptOutList.

  • OptedOutNumbers (list) –

    An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

    • (dict) –

      The information for an opted out number in an Amazon Web Services account.

      • OptedOutNumber (string) –

        The phone number that is opted out.

      • OptedOutTimestamp (datetime) –

        The time that the op tout occurred, in UNIX epoch time format.

      • EndUserOptedOut (boolean) –

        This is set to true if it was the end recipient that opted out.