Redshift / Paginator / DescribeSnapshotCopyGrants

DescribeSnapshotCopyGrants

class Redshift.Paginator.DescribeSnapshotCopyGrants

paginator = client.get_paginator('describe_snapshot_copy_grants')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_snapshot_copy_grants().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SnapshotCopyGrantName='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SnapshotCopyGrantName (string) – The name of the snapshot copy grant.

• TagKeys (list) –

  A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

  • (string) –

• TagValues (list) –

  A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

  • (string) –

• 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

{
    'SnapshotCopyGrants': [
        {
            'SnapshotCopyGrantName': 'string',
            'KmsKeyId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • SnapshotCopyGrants (list) –

    The list of SnapshotCopyGrant objects.

    • (dict) –

      The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination region.

      For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

      • SnapshotCopyGrantName (string) –

        The name of the snapshot copy grant.

      • KmsKeyId (string) –

        The unique identifier of the encrypted symmetric key in Amazon Web Services KMS to which Amazon Redshift is granted permission.

      • Tags (list) –

        A list of tag instances.

        • (dict) –

          A tag consisting of a name/value pair for a resource.

          • Key (string) –

            The key, or name, for the resource tag.

          • Value (string) –

            The value for the resource tag.

  • NextToken (string) –

    A token to resume pagination.