Amazon Redshift

{'Snapshot': {'SnapshotArn': 'string'}}

Authorizes the specified Amazon Web Services account to restore the specified snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .

See also: AWS API Documentation

Request Syntax

client.authorize_snapshot_access(
    SnapshotIdentifier='string',
    SnapshotArn='string',
    SnapshotClusterIdentifier='string',
    AccountWithRestoreAccess='string'
)

type SnapshotIdentifier

string

param SnapshotIdentifier

The identifier of the snapshot the account is authorized to restore.

type SnapshotArn

string

param SnapshotArn

The Amazon Resource Name (ARN) of the snapshot to authorize access to.

type SnapshotClusterIdentifier

string

param SnapshotClusterIdentifier

The identifier of the cluster the snapshot was created from.

• If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all () snapshots* - This parameter is required. Otherwise, permissions aren't available to check if the snapshot exists.

• If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to validate snapshot authorization.

type AccountWithRestoreAccess

string

param AccountWithRestoreAccess

[REQUIRED]

The identifier of the Amazon Web Services account authorized to restore the specified snapshot.

To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.

rtype

dict

returns

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

• (dict) --

  • Snapshot (dict) --

    Describes a snapshot.

    • SnapshotIdentifier (string) --

      The snapshot identifier that is provided in the request.

    • ClusterIdentifier (string) --

      The identifier of the cluster for which the snapshot was taken.

    • SnapshotCreateTime (datetime) --

      The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    • Status (string) --

      The snapshot status. The value of the status depends on the API operation used:

      • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

      • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

      • DeleteClusterSnapshot returns status as "deleted".

    • Port (integer) --

      The port that the cluster is listening on.

    • AvailabilityZone (string) --

      The Availability Zone in which the cluster was created.

    • ClusterCreateTime (datetime) --

      The time (UTC) when the cluster was originally created.

    • MasterUsername (string) --

      The admin user name for the cluster.

    • ClusterVersion (string) --

      The version ID of the Amazon Redshift engine that is running on the cluster.

    • EngineFullVersion (string) --

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

    • SnapshotType (string) --

      The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

    • NodeType (string) --

      The node type of the nodes in the cluster.

    • NumberOfNodes (integer) --

      The number of nodes in the cluster.

    • DBName (string) --

      The name of the database that was created when the cluster was created.

    • VpcId (string) --

      The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Encrypted (boolean) --

      If true , the data in the snapshot is encrypted at rest.

    • KmsKeyId (string) --

      The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    • EncryptedWithHSM (boolean) --

      A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    • AccountsWithRestoreAccess (list) --

      A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      • (dict) --

        Describes an Amazon Web Services account authorized to restore a snapshot.

        • AccountId (string) --

          The identifier of an Amazon Web Services account authorized to restore a snapshot.

        • AccountAlias (string) --

          The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

    • OwnerAccount (string) --

      For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    • TotalBackupSizeInMegaBytes (float) --

      The size of the complete set of backup data that would be used to restore the cluster.

    • ActualIncrementalBackupSizeInMegaBytes (float) --

      The size of the incremental backup.

    • BackupProgressInMegaBytes (float) --

      The number of megabytes that have been transferred to the snapshot backup.

    • CurrentBackupRateInMegaBytesPerSecond (float) --

      The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    • EstimatedSecondsToCompletion (integer) --

      The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    • ElapsedTimeInSeconds (integer) --

      The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    • SourceRegion (string) --

      The source region from which the snapshot was copied.

    • Tags (list) --

      The list of tags for the cluster snapshot.

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

    • RestorableNodeTypes (list) --

      The list of node types that this cluster snapshot is able to restore into.

      • (string) --

    • EnhancedVpcRouting (boolean) --

      An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

      If this option is true , enhanced VPC routing is enabled.

      Default: false

    • MaintenanceTrackName (string) --

      The name of the maintenance track for the snapshot.

    • ManualSnapshotRetentionPeriod (integer) --

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

    • ManualSnapshotRemainingDays (integer) --

      The number of days until a manual snapshot will pass its retention period.

    • SnapshotRetentionStartTime (datetime) --

      A timestamp representing the start of the retention period for the snapshot.

    • MasterPasswordSecretArn (string) --

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

    • MasterPasswordSecretKmsKeyId (string) --

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

    • SnapshotArn (string) --

      The Amazon Resource Name (ARN) of the snapshot.

{'Snapshot': {'SnapshotArn': 'string'}}

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .

See also: AWS API Documentation

Request Syntax

client.copy_cluster_snapshot(
    SourceSnapshotIdentifier='string',
    SourceSnapshotClusterIdentifier='string',
    TargetSnapshotIdentifier='string',
    ManualSnapshotRetentionPeriod=123
)

type SourceSnapshotIdentifier

string

param SourceSnapshotIdentifier

[REQUIRED]

The identifier for the source snapshot.

Constraints:

• Must be the identifier for a valid automated snapshot whose state is available .

type SourceSnapshotClusterIdentifier

string

param SourceSnapshotClusterIdentifier

The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Constraints:

• Must be the identifier for a valid cluster.

type TargetSnapshotIdentifier

string

param TargetSnapshotIdentifier

[REQUIRED]

The identifier given to the new manual snapshot.

Constraints:

• Cannot be null, empty, or blank.

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

• First character must be a letter.

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

• Must be unique for the Amazon Web Services account that is making the request.

type ManualSnapshotRetentionPeriod

integer

param ManualSnapshotRetentionPeriod

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

rtype

dict

returns

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

• (dict) --

  • Snapshot (dict) --

    Describes a snapshot.

    • SnapshotIdentifier (string) --

      The snapshot identifier that is provided in the request.

    • ClusterIdentifier (string) --

      The identifier of the cluster for which the snapshot was taken.

    • SnapshotCreateTime (datetime) --

      The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    • Status (string) --

      The snapshot status. The value of the status depends on the API operation used:

      • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

      • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

      • DeleteClusterSnapshot returns status as "deleted".

    • Port (integer) --

      The port that the cluster is listening on.

    • AvailabilityZone (string) --

      The Availability Zone in which the cluster was created.

    • ClusterCreateTime (datetime) --

      The time (UTC) when the cluster was originally created.

    • MasterUsername (string) --

      The admin user name for the cluster.

    • ClusterVersion (string) --

      The version ID of the Amazon Redshift engine that is running on the cluster.

    • EngineFullVersion (string) --

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

    • SnapshotType (string) --

      The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

    • NodeType (string) --

      The node type of the nodes in the cluster.

    • NumberOfNodes (integer) --

      The number of nodes in the cluster.

    • DBName (string) --

      The name of the database that was created when the cluster was created.

    • VpcId (string) --

      The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Encrypted (boolean) --

      If true , the data in the snapshot is encrypted at rest.

    • KmsKeyId (string) --

      The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    • EncryptedWithHSM (boolean) --

      A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    • AccountsWithRestoreAccess (list) --

      A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      • (dict) --

        Describes an Amazon Web Services account authorized to restore a snapshot.

        • AccountId (string) --

          The identifier of an Amazon Web Services account authorized to restore a snapshot.

        • AccountAlias (string) --

          The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

    • OwnerAccount (string) --

      For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    • TotalBackupSizeInMegaBytes (float) --

      The size of the complete set of backup data that would be used to restore the cluster.

    • ActualIncrementalBackupSizeInMegaBytes (float) --

      The size of the incremental backup.

    • BackupProgressInMegaBytes (float) --

      The number of megabytes that have been transferred to the snapshot backup.

    • CurrentBackupRateInMegaBytesPerSecond (float) --

      The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    • EstimatedSecondsToCompletion (integer) --

      The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    • ElapsedTimeInSeconds (integer) --

      The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    • SourceRegion (string) --

      The source region from which the snapshot was copied.

    • Tags (list) --

      The list of tags for the cluster snapshot.

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

    • RestorableNodeTypes (list) --

      The list of node types that this cluster snapshot is able to restore into.

      • (string) --

    • EnhancedVpcRouting (boolean) --

      An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

      If this option is true , enhanced VPC routing is enabled.

      Default: false

    • MaintenanceTrackName (string) --

      The name of the maintenance track for the snapshot.

    • ManualSnapshotRetentionPeriod (integer) --

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

    • ManualSnapshotRemainingDays (integer) --

      The number of days until a manual snapshot will pass its retention period.

    • SnapshotRetentionStartTime (datetime) --

      A timestamp representing the start of the retention period for the snapshot.

    • MasterPasswordSecretArn (string) --

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

    • MasterPasswordSecretKmsKeyId (string) --

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

    • SnapshotArn (string) --

      The Amazon Resource Name (ARN) of the snapshot.

{'Snapshot': {'SnapshotArn': 'string'}}

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .

See also: AWS API Documentation

Request Syntax

client.create_cluster_snapshot(
    SnapshotIdentifier='string',
    ClusterIdentifier='string',
    ManualSnapshotRetentionPeriod=123,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type SnapshotIdentifier

string

param SnapshotIdentifier

[REQUIRED]

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

Constraints:

• Cannot be null, empty, or blank

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The cluster identifier for which you want a snapshot.

type ManualSnapshotRetentionPeriod

integer

param ManualSnapshotRetentionPeriod

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

type Tags

list

param Tags

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.

rtype

dict

returns

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

• (dict) --

  • Snapshot (dict) --

    Describes a snapshot.

    • SnapshotIdentifier (string) --

      The snapshot identifier that is provided in the request.

    • ClusterIdentifier (string) --

      The identifier of the cluster for which the snapshot was taken.

    • SnapshotCreateTime (datetime) --

      The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    • Status (string) --

      The snapshot status. The value of the status depends on the API operation used:

      • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

      • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

      • DeleteClusterSnapshot returns status as "deleted".

    • Port (integer) --

      The port that the cluster is listening on.

    • AvailabilityZone (string) --

      The Availability Zone in which the cluster was created.

    • ClusterCreateTime (datetime) --

      The time (UTC) when the cluster was originally created.

    • MasterUsername (string) --

      The admin user name for the cluster.

    • ClusterVersion (string) --

      The version ID of the Amazon Redshift engine that is running on the cluster.

    • EngineFullVersion (string) --

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

    • SnapshotType (string) --

      The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

    • NodeType (string) --

      The node type of the nodes in the cluster.

    • NumberOfNodes (integer) --

      The number of nodes in the cluster.

    • DBName (string) --

      The name of the database that was created when the cluster was created.

    • VpcId (string) --

      The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Encrypted (boolean) --

      If true , the data in the snapshot is encrypted at rest.

    • KmsKeyId (string) --

      The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    • EncryptedWithHSM (boolean) --

      A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    • AccountsWithRestoreAccess (list) --

      A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      • (dict) --

        Describes an Amazon Web Services account authorized to restore a snapshot.

        • AccountId (string) --

          The identifier of an Amazon Web Services account authorized to restore a snapshot.

        • AccountAlias (string) --

          The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

    • OwnerAccount (string) --

      For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    • TotalBackupSizeInMegaBytes (float) --

      The size of the complete set of backup data that would be used to restore the cluster.

    • ActualIncrementalBackupSizeInMegaBytes (float) --

      The size of the incremental backup.

    • BackupProgressInMegaBytes (float) --

      The number of megabytes that have been transferred to the snapshot backup.

    • CurrentBackupRateInMegaBytesPerSecond (float) --

      The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    • EstimatedSecondsToCompletion (integer) --

      The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    • ElapsedTimeInSeconds (integer) --

      The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    • SourceRegion (string) --

      The source region from which the snapshot was copied.

    • Tags (list) --

      The list of tags for the cluster snapshot.

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

    • RestorableNodeTypes (list) --

      The list of node types that this cluster snapshot is able to restore into.

      • (string) --

    • EnhancedVpcRouting (boolean) --

      An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

      If this option is true , enhanced VPC routing is enabled.

      Default: false

    • MaintenanceTrackName (string) --

      The name of the maintenance track for the snapshot.

    • ManualSnapshotRetentionPeriod (integer) --

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

    • ManualSnapshotRemainingDays (integer) --

      The number of days until a manual snapshot will pass its retention period.

    • SnapshotRetentionStartTime (datetime) --

      A timestamp representing the start of the retention period for the snapshot.

    • MasterPasswordSecretArn (string) --

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

    • MasterPasswordSecretKmsKeyId (string) --

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

    • SnapshotArn (string) --

      The Amazon Resource Name (ARN) of the snapshot.

{'Snapshot': {'SnapshotArn': 'string'}}

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

See also: AWS API Documentation

Request Syntax

client.delete_cluster_snapshot(
    SnapshotIdentifier='string',
    SnapshotClusterIdentifier='string'
)

type SnapshotIdentifier

string

param SnapshotIdentifier

[REQUIRED]

The unique identifier of the manual snapshot to be deleted.

Constraints: Must be the name of an existing snapshot that is in the available , failed , or cancelled state.

type SnapshotClusterIdentifier

string

param SnapshotClusterIdentifier

The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Constraints: Must be the name of valid cluster.

rtype

dict

returns

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

• (dict) --

  • Snapshot (dict) --

    Describes a snapshot.

    • SnapshotIdentifier (string) --

      The snapshot identifier that is provided in the request.

    • ClusterIdentifier (string) --

      The identifier of the cluster for which the snapshot was taken.

    • SnapshotCreateTime (datetime) --

      The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    • Status (string) --

      The snapshot status. The value of the status depends on the API operation used:

      • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

      • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

      • DeleteClusterSnapshot returns status as "deleted".

    • Port (integer) --

      The port that the cluster is listening on.

    • AvailabilityZone (string) --

      The Availability Zone in which the cluster was created.

    • ClusterCreateTime (datetime) --

      The time (UTC) when the cluster was originally created.

    • MasterUsername (string) --

      The admin user name for the cluster.

    • ClusterVersion (string) --

      The version ID of the Amazon Redshift engine that is running on the cluster.

    • EngineFullVersion (string) --

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

    • SnapshotType (string) --

      The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

    • NodeType (string) --

      The node type of the nodes in the cluster.

    • NumberOfNodes (integer) --

      The number of nodes in the cluster.

    • DBName (string) --

      The name of the database that was created when the cluster was created.

    • VpcId (string) --

      The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Encrypted (boolean) --

      If true , the data in the snapshot is encrypted at rest.

    • KmsKeyId (string) --

      The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    • EncryptedWithHSM (boolean) --

      A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    • AccountsWithRestoreAccess (list) --

      A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      • (dict) --

        Describes an Amazon Web Services account authorized to restore a snapshot.

        • AccountId (string) --

          The identifier of an Amazon Web Services account authorized to restore a snapshot.

        • AccountAlias (string) --

          The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

    • OwnerAccount (string) --

      For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    • TotalBackupSizeInMegaBytes (float) --

      The size of the complete set of backup data that would be used to restore the cluster.

    • ActualIncrementalBackupSizeInMegaBytes (float) --

      The size of the incremental backup.

    • BackupProgressInMegaBytes (float) --

      The number of megabytes that have been transferred to the snapshot backup.

    • CurrentBackupRateInMegaBytesPerSecond (float) --

      The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    • EstimatedSecondsToCompletion (integer) --

      The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    • ElapsedTimeInSeconds (integer) --

      The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    • SourceRegion (string) --

      The source region from which the snapshot was copied.

    • Tags (list) --

      The list of tags for the cluster snapshot.

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

    • RestorableNodeTypes (list) --

      The list of node types that this cluster snapshot is able to restore into.

      • (string) --

    • EnhancedVpcRouting (boolean) --

      An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

      If this option is true , enhanced VPC routing is enabled.

      Default: false

    • MaintenanceTrackName (string) --

      The name of the maintenance track for the snapshot.

    • ManualSnapshotRetentionPeriod (integer) --

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

    • ManualSnapshotRemainingDays (integer) --

      The number of days until a manual snapshot will pass its retention period.

    • SnapshotRetentionStartTime (datetime) --

      A timestamp representing the start of the retention period for the snapshot.

    • MasterPasswordSecretArn (string) --

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

    • MasterPasswordSecretKmsKeyId (string) --

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

    • SnapshotArn (string) --

      The Amazon Resource Name (ARN) of the snapshot.

{'Snapshots': {'SnapshotArn': 'string'}}

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

See also: AWS API Documentation

Request Syntax

client.describe_cluster_snapshots(
    ClusterIdentifier='string',
    SnapshotIdentifier='string',
    SnapshotArn='string',
    SnapshotType='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    MaxRecords=123,
    Marker='string',
    OwnerAccount='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    ClusterExists=True|False,
    SortingEntities=[
        {
            'Attribute': 'SOURCE_TYPE'|'TOTAL_SIZE'|'CREATE_TIME',
            'SortOrder': 'ASC'|'DESC'
        },
    ]
)

type ClusterIdentifier

string

param ClusterIdentifier

The identifier of the cluster which generated the requested snapshots.

type SnapshotIdentifier

string

param SnapshotIdentifier

The snapshot identifier of the snapshot about which to return information.

type SnapshotArn

string

param SnapshotArn

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

type SnapshotType

string

param SnapshotType

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

type StartTime

datetime

param StartTime

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

type EndTime

datetime

param EndTime

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

type MaxRecords

integer

param MaxRecords

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

type Marker

string

param Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords , Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

type OwnerAccount

string

param OwnerAccount

The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

type TagKeys

list

param TagKeys

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

• (string) --

type TagValues

list

param TagValues

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

• (string) --

type ClusterExists

boolean

param ClusterExists

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

• If ClusterExists is set to true , ClusterIdentifier is required.

• If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

type SortingEntities

list

param SortingEntities

• (dict) --

  Describes a sorting entity

  • Attribute (string) -- [REQUIRED]

    The category for sorting the snapshots.

  • SortOrder (string) --

    The order for listing the attributes.

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'Snapshots': [
        {
            'SnapshotIdentifier': 'string',
            'ClusterIdentifier': 'string',
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'Status': 'string',
            'Port': 123,
            'AvailabilityZone': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'MasterUsername': 'string',
            'ClusterVersion': 'string',
            'EngineFullVersion': 'string',
            'SnapshotType': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'DBName': 'string',
            'VpcId': 'string',
            'Encrypted': True|False,
            'KmsKeyId': 'string',
            'EncryptedWithHSM': True|False,
            'AccountsWithRestoreAccess': [
                {
                    'AccountId': 'string',
                    'AccountAlias': 'string'
                },
            ],
            'OwnerAccount': 'string',
            'TotalBackupSizeInMegaBytes': 123.0,
            'ActualIncrementalBackupSizeInMegaBytes': 123.0,
            'BackupProgressInMegaBytes': 123.0,
            'CurrentBackupRateInMegaBytesPerSecond': 123.0,
            'EstimatedSecondsToCompletion': 123,
            'ElapsedTimeInSeconds': 123,
            'SourceRegion': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'RestorableNodeTypes': [
                'string',
            ],
            'EnhancedVpcRouting': True|False,
            'MaintenanceTrackName': 'string',
            'ManualSnapshotRetentionPeriod': 123,
            'ManualSnapshotRemainingDays': 123,
            'SnapshotRetentionStartTime': datetime(2015, 1, 1),
            'MasterPasswordSecretArn': 'string',
            'MasterPasswordSecretKmsKeyId': 'string',
            'SnapshotArn': 'string'
        },
    ]
}

Response Structure

• (dict) --

  Contains the output from the DescribeClusterSnapshots action.

  • Marker (string) --

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • Snapshots (list) --

    A list of Snapshot instances.

    • (dict) --

      Describes a snapshot.

      • SnapshotIdentifier (string) --

        The snapshot identifier that is provided in the request.

      • ClusterIdentifier (string) --

        The identifier of the cluster for which the snapshot was taken.

      • SnapshotCreateTime (datetime) --

        The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

      • Status (string) --

        The snapshot status. The value of the status depends on the API operation used:

        • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

        • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

        • DeleteClusterSnapshot returns status as "deleted".

      • Port (integer) --

        The port that the cluster is listening on.

      • AvailabilityZone (string) --

        The Availability Zone in which the cluster was created.

      • ClusterCreateTime (datetime) --

        The time (UTC) when the cluster was originally created.

      • MasterUsername (string) --

        The admin user name for the cluster.

      • ClusterVersion (string) --

        The version ID of the Amazon Redshift engine that is running on the cluster.

      • EngineFullVersion (string) --

        The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

      • SnapshotType (string) --

        The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

      • NodeType (string) --

        The node type of the nodes in the cluster.

      • NumberOfNodes (integer) --

        The number of nodes in the cluster.

      • DBName (string) --

        The name of the database that was created when the cluster was created.

      • VpcId (string) --

        The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

      • Encrypted (boolean) --

        If true , the data in the snapshot is encrypted at rest.

      • KmsKeyId (string) --

        The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

      • EncryptedWithHSM (boolean) --

        A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

      • AccountsWithRestoreAccess (list) --

        A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

        • (dict) --

          Describes an Amazon Web Services account authorized to restore a snapshot.

          • AccountId (string) --

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias (string) --

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

      • OwnerAccount (string) --

        For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

      • TotalBackupSizeInMegaBytes (float) --

        The size of the complete set of backup data that would be used to restore the cluster.

      • ActualIncrementalBackupSizeInMegaBytes (float) --

        The size of the incremental backup.

      • BackupProgressInMegaBytes (float) --

        The number of megabytes that have been transferred to the snapshot backup.

      • CurrentBackupRateInMegaBytesPerSecond (float) --

        The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

      • EstimatedSecondsToCompletion (integer) --

        The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

      • ElapsedTimeInSeconds (integer) --

        The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

      • SourceRegion (string) --

        The source region from which the snapshot was copied.

      • Tags (list) --

        The list of tags for the cluster snapshot.

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

      • RestorableNodeTypes (list) --

        The list of node types that this cluster snapshot is able to restore into.

        • (string) --

      • EnhancedVpcRouting (boolean) --

        An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

        If this option is true , enhanced VPC routing is enabled.

        Default: false

      • MaintenanceTrackName (string) --

        The name of the maintenance track for the snapshot.

      • ManualSnapshotRetentionPeriod (integer) --

        The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

        The value must be either -1 or an integer between 1 and 3,653.

      • ManualSnapshotRemainingDays (integer) --

        The number of days until a manual snapshot will pass its retention period.

      • SnapshotRetentionStartTime (datetime) --

        A timestamp representing the start of the retention period for the snapshot.

      • MasterPasswordSecretArn (string) --

        The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

      • MasterPasswordSecretKmsKeyId (string) --

        The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

      • SnapshotArn (string) --

        The Amazon Resource Name (ARN) of the snapshot.

{'Snapshot': {'SnapshotArn': 'string'}}

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

See also: AWS API Documentation

Request Syntax

client.modify_cluster_snapshot(
    SnapshotIdentifier='string',
    ManualSnapshotRetentionPeriod=123,
    Force=True|False
)

type SnapshotIdentifier

string

param SnapshotIdentifier

[REQUIRED]

The identifier of the snapshot whose setting you want to modify.

type ManualSnapshotRetentionPeriod

integer

param ManualSnapshotRetentionPeriod

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

The value must be either -1 or an integer between 1 and 3,653.

type Force

boolean

param Force

A Boolean option to override an exception if the retention period has already passed.

rtype

dict

returns

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

• (dict) --

  • Snapshot (dict) --

    Describes a snapshot.

    • SnapshotIdentifier (string) --

      The snapshot identifier that is provided in the request.

    • ClusterIdentifier (string) --

      The identifier of the cluster for which the snapshot was taken.

    • SnapshotCreateTime (datetime) --

      The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    • Status (string) --

      The snapshot status. The value of the status depends on the API operation used:

      • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

      • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

      • DeleteClusterSnapshot returns status as "deleted".

    • Port (integer) --

      The port that the cluster is listening on.

    • AvailabilityZone (string) --

      The Availability Zone in which the cluster was created.

    • ClusterCreateTime (datetime) --

      The time (UTC) when the cluster was originally created.

    • MasterUsername (string) --

      The admin user name for the cluster.

    • ClusterVersion (string) --

      The version ID of the Amazon Redshift engine that is running on the cluster.

    • EngineFullVersion (string) --

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

    • SnapshotType (string) --

      The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

    • NodeType (string) --

      The node type of the nodes in the cluster.

    • NumberOfNodes (integer) --

      The number of nodes in the cluster.

    • DBName (string) --

      The name of the database that was created when the cluster was created.

    • VpcId (string) --

      The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Encrypted (boolean) --

      If true , the data in the snapshot is encrypted at rest.

    • KmsKeyId (string) --

      The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    • EncryptedWithHSM (boolean) --

      A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    • AccountsWithRestoreAccess (list) --

      A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      • (dict) --

        Describes an Amazon Web Services account authorized to restore a snapshot.

        • AccountId (string) --

          The identifier of an Amazon Web Services account authorized to restore a snapshot.

        • AccountAlias (string) --

          The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

    • OwnerAccount (string) --

      For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    • TotalBackupSizeInMegaBytes (float) --

      The size of the complete set of backup data that would be used to restore the cluster.

    • ActualIncrementalBackupSizeInMegaBytes (float) --

      The size of the incremental backup.

    • BackupProgressInMegaBytes (float) --

      The number of megabytes that have been transferred to the snapshot backup.

    • CurrentBackupRateInMegaBytesPerSecond (float) --

      The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    • EstimatedSecondsToCompletion (integer) --

      The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    • ElapsedTimeInSeconds (integer) --

      The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    • SourceRegion (string) --

      The source region from which the snapshot was copied.

    • Tags (list) --

      The list of tags for the cluster snapshot.

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

    • RestorableNodeTypes (list) --

      The list of node types that this cluster snapshot is able to restore into.

      • (string) --

    • EnhancedVpcRouting (boolean) --

      An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

      If this option is true , enhanced VPC routing is enabled.

      Default: false

    • MaintenanceTrackName (string) --

      The name of the maintenance track for the snapshot.

    • ManualSnapshotRetentionPeriod (integer) --

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

    • ManualSnapshotRemainingDays (integer) --

      The number of days until a manual snapshot will pass its retention period.

    • SnapshotRetentionStartTime (datetime) --

      A timestamp representing the start of the retention period for the snapshot.

    • MasterPasswordSecretArn (string) --

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

    • MasterPasswordSecretKmsKeyId (string) --

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

    • SnapshotArn (string) --

      The Amazon Resource Name (ARN) of the snapshot.

{'Snapshot': {'SnapshotArn': 'string'}}

Removes the ability of the specified Amazon Web Services account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .

See also: AWS API Documentation

Request Syntax

client.revoke_snapshot_access(
    SnapshotIdentifier='string',
    SnapshotArn='string',
    SnapshotClusterIdentifier='string',
    AccountWithRestoreAccess='string'
)

type SnapshotIdentifier

string

param SnapshotIdentifier

The identifier of the snapshot that the account can no longer access.

type SnapshotArn

string

param SnapshotArn

The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access.

type SnapshotClusterIdentifier

string

param SnapshotClusterIdentifier

The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

type AccountWithRestoreAccess

string

param AccountWithRestoreAccess

[REQUIRED]

The identifier of the Amazon Web Services account that can no longer restore the specified snapshot.

rtype

dict

returns

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

• (dict) --

  • Snapshot (dict) --

    Describes a snapshot.

    • SnapshotIdentifier (string) --

      The snapshot identifier that is provided in the request.

    • ClusterIdentifier (string) --

      The identifier of the cluster for which the snapshot was taken.

    • SnapshotCreateTime (datetime) --

      The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    • Status (string) --

      The snapshot status. The value of the status depends on the API operation used:

      • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

      • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

      • DeleteClusterSnapshot returns status as "deleted".

    • Port (integer) --

      The port that the cluster is listening on.

    • AvailabilityZone (string) --

      The Availability Zone in which the cluster was created.

    • ClusterCreateTime (datetime) --

      The time (UTC) when the cluster was originally created.

    • MasterUsername (string) --

      The admin user name for the cluster.

    • ClusterVersion (string) --

      The version ID of the Amazon Redshift engine that is running on the cluster.

    • EngineFullVersion (string) --

      The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

    • SnapshotType (string) --

      The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

    • NodeType (string) --

      The node type of the nodes in the cluster.

    • NumberOfNodes (integer) --

      The number of nodes in the cluster.

    • DBName (string) --

      The name of the database that was created when the cluster was created.

    • VpcId (string) --

      The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Encrypted (boolean) --

      If true , the data in the snapshot is encrypted at rest.

    • KmsKeyId (string) --

      The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    • EncryptedWithHSM (boolean) --

      A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    • AccountsWithRestoreAccess (list) --

      A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

      • (dict) --

        Describes an Amazon Web Services account authorized to restore a snapshot.

        • AccountId (string) --

          The identifier of an Amazon Web Services account authorized to restore a snapshot.

        • AccountAlias (string) --

          The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

    • OwnerAccount (string) --

      For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    • TotalBackupSizeInMegaBytes (float) --

      The size of the complete set of backup data that would be used to restore the cluster.

    • ActualIncrementalBackupSizeInMegaBytes (float) --

      The size of the incremental backup.

    • BackupProgressInMegaBytes (float) --

      The number of megabytes that have been transferred to the snapshot backup.

    • CurrentBackupRateInMegaBytesPerSecond (float) --

      The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    • EstimatedSecondsToCompletion (integer) --

      The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    • ElapsedTimeInSeconds (integer) --

      The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    • SourceRegion (string) --

      The source region from which the snapshot was copied.

    • Tags (list) --

      The list of tags for the cluster snapshot.

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

    • RestorableNodeTypes (list) --

      The list of node types that this cluster snapshot is able to restore into.

      • (string) --

    • EnhancedVpcRouting (boolean) --

      An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

      If this option is true , enhanced VPC routing is enabled.

      Default: false

    • MaintenanceTrackName (string) --

      The name of the maintenance track for the snapshot.

    • ManualSnapshotRetentionPeriod (integer) --

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

    • ManualSnapshotRemainingDays (integer) --

      The number of days until a manual snapshot will pass its retention period.

    • SnapshotRetentionStartTime (datetime) --

      A timestamp representing the start of the retention period for the snapshot.

    • MasterPasswordSecretArn (string) --

      The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

    • MasterPasswordSecretKmsKeyId (string) --

      The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

    • SnapshotArn (string) --

      The Amazon Resource Name (ARN) of the snapshot.