GetReplicationSetCommand

Retrieve your Incident Manager replication set.

Example Syntax

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

import { SSMIncidentsClient, GetReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
// const { SSMIncidentsClient, GetReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
const client = new SSMIncidentsClient(config);
const input = { // GetReplicationSetInput
  arn: "STRING_VALUE", // required
};
const command = new GetReplicationSetCommand(input);
const response = await client.send(command);
// { // GetReplicationSetOutput
//   replicationSet: { // ReplicationSet
//     arn: "STRING_VALUE",
//     regionMap: { // RegionInfoMap // required
//       "<keys>": { // RegionInfo
//         sseKmsKeyId: "STRING_VALUE",
//         status: "STRING_VALUE", // required
//         statusMessage: "STRING_VALUE",
//         statusUpdateDateTime: new Date("TIMESTAMP"), // required
//       },
//     },
//     status: "STRING_VALUE", // required
//     deletionProtected: true || false, // required
//     createdTime: new Date("TIMESTAMP"), // required
//     createdBy: "STRING_VALUE", // required
//     lastModifiedTime: new Date("TIMESTAMP"), // required
//     lastModifiedBy: "STRING_VALUE", // required
//   },
// };

GetReplicationSetCommand Input

See GetReplicationSetCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

The Amazon Resource Name (ARN) of the replication set you want to retrieve.

GetReplicationSetCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
replicationSet
Required
ReplicationSet | undefined

Details of the replication set.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this operation.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

Request references a resource which doesn't exist.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an Amazon Web Services service.

SSMIncidentsServiceException
Base exception class for all service exceptions from SSMIncidents service.