SESV2 / Client / get_multi_region_endpoint

get_multi_region_endpoint#

SESV2.Client.get_multi_region_endpoint(**kwargs)#

Displays the multi-region endpoint (global-endpoint) configuration.

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

See also: AWS API Documentation

Request Syntax

response = client.get_multi_region_endpoint(
    EndpointName='string'
)
Parameters:

EndpointName (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

    • EndpointName (string) –

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

    • EndpointId (string) –

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

    • Routes (list) –

      Contains routes information for the multi-region endpoint (global-endpoint).

      • (dict) –

        An object which contains an AWS-Region and routing status.

        • Region (string) –

          The name of an AWS-Region.

    • 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.

    • 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.

Exceptions

  • SESV2.Client.exceptions.NotFoundException

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException