RedshiftServerless / Client / create_snapshot_copy_configuration

create_snapshot_copy_configuration#

RedshiftServerless.Client.create_snapshot_copy_configuration(**kwargs)#

Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot_copy_configuration(
    destinationKmsKeyId='string',
    destinationRegion='string',
    namespaceName='string',
    snapshotRetentionPeriod=123
)
Parameters:

  • destinationKmsKeyId (string) – The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.

  • destinationRegion (string) –

    [REQUIRED]

    The destination Amazon Web Services Region that you want to copy snapshots to.

  • namespaceName (string) –

    [REQUIRED]

    The name of the namespace to copy snapshots from.

  • snapshotRetentionPeriod (integer) – The retention period of the snapshots that you copy to the destination Amazon Web Services Region.

Return type:

dict

Returns:

Response Syntax

{
    'snapshotCopyConfiguration': {
        'destinationKmsKeyId': 'string',
        'destinationRegion': 'string',
        'namespaceName': 'string',
        'snapshotCopyConfigurationArn': 'string',
        'snapshotCopyConfigurationId': 'string',
        'snapshotRetentionPeriod': 123
    }
}

Response Structure

  • (dict) –

    • snapshotCopyConfiguration (dict) –

      The snapshot copy configuration object that is returned.

      • destinationKmsKeyId (string) –

        The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.

      • destinationRegion (string) –

        The destination Amazon Web Services Region to copy snapshots to.

      • namespaceName (string) –

        The name of the namespace to copy snapshots from in the source Amazon Web Services Region.

      • snapshotCopyConfigurationArn (string) –

        The ARN of the snapshot copy configuration object.

      • snapshotCopyConfigurationId (string) –

        The ID of the snapshot copy configuration object.

      • snapshotRetentionPeriod (integer) –

        The retention period of snapshots that are copied to the destination Amazon Web Services Region.

Exceptions

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.ResourceNotFoundException

  • RedshiftServerless.Client.exceptions.ConflictException

  • RedshiftServerless.Client.exceptions.ValidationException

  • RedshiftServerless.Client.exceptions.AccessDeniedException

  • RedshiftServerless.Client.exceptions.ServiceQuotaExceededException