RedshiftServerless / Paginator / ListSnapshotCopyConfigurations

ListSnapshotCopyConfigurations

class RedshiftServerless.Paginator.ListSnapshotCopyConfigurations

paginator = client.get_paginator('list_snapshot_copy_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_snapshot_copy_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    namespaceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.