SESV2 / Client / list_multi_region_endpoints

list_multi_region_endpoints¶

SESV2.Client.list_multi_region_endpoints(**kwargs)¶

List the multi-region endpoints (global-endpoints).

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.

Request Syntax

response = client.list_multi_region_endpoints(
    NextToken='string',
    PageSize=123
)

Parameters:

NextToken (string) – A token returned from a previous call to ListMultiRegionEndpoints to indicate the position in the list of multi-region endpoints (global-endpoints).
PageSize (integer) – The number of results to show in a single call to ListMultiRegionEndpoints. If the number of results is larger than the number you specified in this parameter, the response includes a NextToken element that you can use to retrieve the next page of results.

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)
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  A token indicating that there are additional multi-region endpoints (global-endpoints) available to be listed. Pass this token to a subsequent ListMultiRegionEndpoints call to retrieve the next page.

Exceptions

SESV2.Client.exceptions.TooManyRequestsException
SESV2.Client.exceptions.BadRequestException