SESV2 / Paginator / ListMultiRegionEndpoints

ListMultiRegionEndpoints#

class SESV2.Paginator.ListMultiRegionEndpoints#
paginator = client.get_paginator('list_multi_region_endpoints')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SESV2.Client.list_multi_region_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

{
    'MultiRegionEndpoints': [
        {
            'EndpointName': 'string',
            'Status': 'CREATING'|'READY'|'FAILED'|'DELETING',
            'EndpointId': 'string',
            'Regions': [
                'string',
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    The following elements are returned by the service.

    • MultiRegionEndpoints (list) –

      An array that contains key multi-region endpoint (global-endpoint) properties.

      • (dict) –

        An object that contains multi-region endpoint (global-endpoint) properties.

        • EndpointName (string) –

          The name of the multi-region endpoint (global-endpoint).

        • Status (string) –

          The status of the multi-region endpoint (global-endpoint).

          • CREATING – The resource is being provisioned.

          • READY – The resource is ready to use.

          • FAILED – The resource failed to be provisioned.

          • DELETING – The resource is being deleted as requested.

        • EndpointId (string) –

          The ID of the multi-region endpoint (global-endpoint).

        • Regions (list) –

          Primary and secondary regions between which multi-region endpoint splits sending traffic.

          • (string) –

            The name of an AWS-Region.

        • CreatedTimestamp (datetime) –

          The time stamp of when the multi-region endpoint (global-endpoint) was created.

        • LastUpdatedTimestamp (datetime) –

          The time stamp of when the multi-region endpoint (global-endpoint) was last updated.