get_replication_set

get_replication_set(**kwargs)

Retrieve your Incident Manager replication set.

See also: AWS API Documentation

Request Syntax

response = client.get_replication_set(
    arn='string'
)

Parameters

arn (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'replicationSet': {
        'arn': 'string',
        'createdBy': 'string',
        'createdTime': datetime(2015, 1, 1),
        'deletionProtected': True|False,
        'lastModifiedBy': 'string',
        'lastModifiedTime': datetime(2015, 1, 1),
        'regionMap': {
            'string': {
                'sseKmsKeyId': 'string',
                'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED',
                'statusMessage': 'string',
                'statusUpdateDateTime': datetime(2015, 1, 1)
            }
        },
        'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
    }
}

Response Structure

• (dict) --
  • replicationSet (dict) --

    Details of the replication set.

    • arn (string) --

      The Amazon Resource Name (ARN) of the replication set.

    • createdBy (string) --

      Details about who created the replication set.

    • createdTime (datetime) --

      When the replication set was created.

    • deletionProtected (boolean) --

      Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.

    • lastModifiedBy (string) --

      Who last modified the replication set.

    • lastModifiedTime (datetime) --

      When the replication set was last updated.

    • regionMap (dict) --

      The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.

      • (string) --
        • (dict) --

          Information about a Amazon Web Services Region in your replication set.

          • sseKmsKeyId (string) --

            The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.

          • status (string) --

            The status of the Amazon Web Services Region in the replication set.

          • statusMessage (string) --

            Information displayed about the status of the Amazon Web Services Region.

          • statusUpdateDateTime (datetime) --

            The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.

    • status (string) --

      The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.

Exceptions

• SSMIncidents.Client.exceptions.ThrottlingException
• SSMIncidents.Client.exceptions.ResourceNotFoundException
• SSMIncidents.Client.exceptions.AccessDeniedException
• SSMIncidents.Client.exceptions.ValidationException
• SSMIncidents.Client.exceptions.InternalServerException