Redshift / Client / batch_modify_cluster_snapshots

batch_modify_cluster_snapshots#

Redshift.Client.batch_modify_cluster_snapshots(**kwargs)#

Modifies the settings for a set of cluster snapshots.

See also: AWS API Documentation

Request Syntax

response = client.batch_modify_cluster_snapshots(
    SnapshotIdentifierList=[
        'string',
    ],
    ManualSnapshotRetentionPeriod=123,
    Force=True|False
)
Parameters:

  • SnapshotIdentifierList (list) –

    [REQUIRED]

    A list of snapshot identifiers you want to modify.

    • (string) –

  • ManualSnapshotRetentionPeriod (integer) –

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

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

    If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

  • Force (boolean) – A boolean value indicating whether to override an exception if the retention period has passed.

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 snapshots that were modified.

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

  • Redshift.Client.exceptions.BatchModifyClusterSnapshotsLimitExceededFault