RedshiftServerless / Client / list_snapshot_copy_configurations

list_snapshot_copy_configurations#

RedshiftServerless.Client.list_snapshot_copy_configurations(**kwargs)#

Returns a list of snapshot copy configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshot_copy_configurations(
    maxResults=123,
    namespaceName='string',
    nextToken='string'
)
Parameters:

  • maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • namespaceName (string) – The namespace from which to list all snapshot copy configurations.

  • nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'snapshotCopyConfigurations': [
        {
            'destinationKmsKeyId': 'string',
            'destinationRegion': 'string',
            'namespaceName': 'string',
            'snapshotCopyConfigurationArn': 'string',
            'snapshotCopyConfigurationId': 'string',
            'snapshotRetentionPeriod': 123
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    • snapshotCopyConfigurations (list) –

      All of the returned snapshot copy configurations.

      • (dict) –

        The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.

        • 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.InvalidPaginationException

  • RedshiftServerless.Client.exceptions.ResourceNotFoundException

  • RedshiftServerless.Client.exceptions.ConflictException

  • RedshiftServerless.Client.exceptions.ValidationException