Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMultiRegionEndpoints

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


GET /v2/email/multi-region-endpoints?NextToken=NextToken&PageSize=PageSize HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken

A token returned from a previous call to ListMultiRegionEndpoints to indicate the position in the list of multi-region endpoints (global-endpoints).

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

Pattern: ^^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

PageSize

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.

Valid Range: Minimum value of 1. Maximum value of 1000.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "MultiRegionEndpoints": [ 
      { 
         "CreatedTimestamp": number,
         "EndpointId": "string",
         "EndpointName": "string",
         "LastUpdatedTimestamp": number,
         "Regions": [ "string" ],
         "Status": "string"
      }
   ],
   "NextToken": "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.

MultiRegionEndpoints

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

Type: Array of MultiRegionEndpoint objects

NextToken

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.

Type: String

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

Pattern: ^^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

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

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429