Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . redshift ]

batch-modify-cluster-snapshots

Description

Modifies the settings for a list of snapshots.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  batch-modify-cluster-snapshots
--snapshot-identifier-list <value>
[--manual-snapshot-retention-period <value>]
[--force | --no-force]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--snapshot-identifier-list (list)

A list of snapshot identifiers you want to modify.

Syntax:

"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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Resources -> (list)

A list of the snapshots that were modified.

(string)

Errors -> (list)

A list of any errors returned.

(structure)

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.