ListMultiRegionEndpointsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SESv2Client, ListMultiRegionEndpointsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, ListMultiRegionEndpointsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // ListMultiRegionEndpointsRequest
  NextToken: "STRING_VALUE",
  PageSize: Number("int"),
};
const command = new ListMultiRegionEndpointsCommand(input);
const response = await client.send(command);
// { // ListMultiRegionEndpointsResponse
//   MultiRegionEndpoints: [ // MultiRegionEndpoints
//     { // MultiRegionEndpoint
//       EndpointName: "STRING_VALUE",
//       Status: "CREATING" || "READY" || "FAILED" || "DELETING",
//       EndpointId: "STRING_VALUE",
//       Regions: [ // Regions
//         "STRING_VALUE",
//       ],
//       CreatedTimestamp: new Date("TIMESTAMP"),
//       LastUpdatedTimestamp: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListMultiRegionEndpointsCommand Input

See ListMultiRegionEndpointsCommandInput for more details

Parameter
Type
Description
NextToken
string | undefined

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

PageSize
number | undefined

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.

ListMultiRegionEndpointsCommand Output

See ListMultiRegionEndpointsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MultiRegionEndpoints
MultiRegionEndpoint[] | undefined

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

NextToken
string | undefined

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.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

TooManyRequestsException
client

Too many requests have been made to the operation.

SESv2ServiceException
Base exception class for all service exceptions from SESv2 service.