[ aws . redshift ]



Modifies the settings for a set of cluster snapshots.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--snapshot-identifier-list <value>
[--manual-snapshot-retention-period <value>]
[--force | --no-force]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--snapshot-identifier-list (list)

A list of snapshot identifiers you want to modify.



"string" "string" ...

--manual-snapshot-retention-period (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 | --no-force (boolean)

A boolean value indicating whether to override an exception if the retention period has passed.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To modify a set of cluster snapshots

The following batch-modify-cluster-snapshots example modifies the settings for a set of cluster snapshots.

aws redshift batch-modify-cluster-snapshots \
    --snapshot-identifier-list mycluster-2019-11-06-16-31 mycluster-2019-11-06-16-32 \
    --manual-snapshot-retention-period 30


    "Resources": [
    "Errors": [],
    "ResponseMetadata": {
        "RequestId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE",
        "HTTPStatusCode": 200,
        "HTTPHeaders": {
                "x-amzn-requestid": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE,
                "content-type": "text/xml",
                "content-length": "480",
                "date": "Sat, 07 Dec 2019 00:36:09 GMT",
                "connection": "keep-alive"
        "RetryAttempts": 0

For more information, see Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.


Resources -> (list)

A list of the snapshots that were modified.


Errors -> (list)

A list of any errors returned.


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.