GetMultiRegionEndpoint - Amazon Simple Email Service
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetMultiRegionEndpoint

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.

Request Syntax

GET /v2/email/multi-region-endpoints/EndpointName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EndpointName

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w\-_]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "CreatedTimestamp": number,
   "EndpointId": "string",
   "EndpointName": "string",
   "LastUpdatedTimestamp": number,
   "Routes": [ 
      { 
         "Region": "string"
      }
   ],
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedTimestamp

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

Type: Timestamp

EndpointId

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

Type: String

EndpointName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w\-_]+$

LastUpdatedTimestamp

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

Type: Timestamp

Routes

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

Type: Array of Route objects

Status

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.

Type: String

Valid Values: CREATING | READY | FAILED | DELETING

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: