Redshift / Client / batch_delete_cluster_snapshots

batch_delete_cluster_snapshots#

Redshift.Client.batch_delete_cluster_snapshots(**kwargs)#

Deletes a set of cluster snapshots.

Request Syntax

response = client.batch_delete_cluster_snapshots(
    Identifiers=[
        {
            'SnapshotIdentifier': 'string',
            'SnapshotClusterIdentifier': 'string'
        },
    ]
)

Parameters:

Identifiers (list) –

[REQUIRED]

A list of identifiers for the snapshots that you want to delete.

(dict) –
- SnapshotIdentifier (string) – [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.
- SnapshotClusterIdentifier (string) –
  
  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.

Return type:

dict

Returns:

Response Syntax

{
    'Resources': [
        'string',
    ],
    'Errors': [
        {
            'SnapshotIdentifier': 'string',
            'SnapshotClusterIdentifier': 'string',
            'FailureCode': 'string',
            'FailureReason': 'string'
        },
    ]
}

Response Structure

(dict) –
- Resources (list) –
  
  A list of the snapshot identifiers that were deleted.
  - (string) –
- Errors (list) –
  
  A list of any errors returned.
  - (dict) –
    
    Describes the errors returned by a snapshot.
    - SnapshotIdentifier (string) –
      
      A unique identifier for the snapshot returning the error.
    - SnapshotClusterIdentifier (string) –
      
      A unique identifier for the cluster.
    - FailureCode (string) –
      
      The failure code for the error.
    - FailureReason (string) –
      
      The text message describing the error.

Exceptions

Redshift.Client.exceptions.BatchDeleteRequestSizeExceededFault