GetMultiRegionEndpointCommand

Suggest an Edit

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.

Example Syntax

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

import { SESv2Client, GetMultiRegionEndpointCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, GetMultiRegionEndpointCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // GetMultiRegionEndpointRequest
  EndpointName: "STRING_VALUE", // required
};
const command = new GetMultiRegionEndpointCommand(input);
const response = await client.send(command);
// { // GetMultiRegionEndpointResponse
//   EndpointName: "STRING_VALUE",
//   EndpointId: "STRING_VALUE",
//   Routes: [ // Routes
//     { // Route
//       Region: "STRING_VALUE", // required
//     },
//   ],
//   Status: "CREATING" || "READY" || "FAILED" || "DELETING",
//   CreatedTimestamp: new Date("TIMESTAMP"),
//   LastUpdatedTimestamp: new Date("TIMESTAMP"),
// };

GetMultiRegionEndpointCommand Input

See GetMultiRegionEndpointCommandInput for more details

Parameter
Type
Description
EndpointName
Required
string | undefined

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

GetMultiRegionEndpointCommand Output

See GetMultiRegionEndpointCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreatedTimestamp
Date | undefined

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

EndpointId
string | undefined

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

EndpointName
string | undefined

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

LastUpdatedTimestamp
Date | undefined

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

Routes
Route[] | undefined

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

Status
Status | undefined

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.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

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