Redshift / Client / create_snapshot_copy_grant

create_snapshot_copy_grant#

Redshift.Client.create_snapshot_copy_grant(**kwargs)#

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

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

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot_copy_grant(
    SnapshotCopyGrantName='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • SnapshotCopyGrantName (string) –

    [REQUIRED]

    The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an Amazon Web Services account.

  • KmsKeyId (string) – The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

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

Exceptions

  • Redshift.Client.exceptions.SnapshotCopyGrantAlreadyExistsFault

  • Redshift.Client.exceptions.SnapshotCopyGrantQuotaExceededFault

  • Redshift.Client.exceptions.LimitExceededFault

  • Redshift.Client.exceptions.TagLimitExceededFault

  • Redshift.Client.exceptions.InvalidTagFault

  • Redshift.Client.exceptions.DependentServiceRequestThrottlingFault