[ aws . redshift-serverless ]

list-snapshots

Description

Returns a list of snapshots.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-snapshots is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: snapshots

Synopsis

  list-snapshots
[--end-time <value>]
[--namespace-arn <value>]
[--namespace-name <value>]
[--owner-account <value>]
[--start-time <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--end-time (timestamp)

The timestamp showing when the snapshot creation finished.

--namespace-arn (string)

The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

--namespace-name (string)

The namespace from which to list all snapshots.

--owner-account (string)

The owner Amazon Web Services account of the snapshot.

--start-time (timestamp)

The time when the creation of the snapshot was initiated.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

nextToken -> (string)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

snapshots -> (list)

All of the returned snapshot objects.

(structure)

A snapshot object that contains databases.

accountsWithProvisionedRestoreAccess -> (list)

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

(string)

accountsWithRestoreAccess -> (list)

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

(string)

actualIncrementalBackupSizeInMegaBytes -> (double)

The size of the incremental backup in megabytes.

adminUsername -> (string)

The username of the database within a snapshot.

backupProgressInMegaBytes -> (double)

The size in megabytes of the data that has been backed up to a snapshot.

currentBackupRateInMegaBytesPerSecond -> (double)

The rate at which data is backed up into a snapshot in megabytes per second.

elapsedTimeInSeconds -> (long)

The amount of time it took to back up data into a snapshot.

estimatedSecondsToCompletion -> (long)

The estimated amount of seconds until the snapshot completes backup.

kmsKeyId -> (string)

The unique identifier of the KMS key used to encrypt the snapshot.

namespaceArn -> (string)

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

namespaceName -> (string)

The name of the namepsace.

ownerAccount -> (string)

The owner Amazon Web Services; account of the snapshot.

snapshotArn -> (string)

The Amazon Resource Name (ARN) of the snapshot.

snapshotCreateTime -> (timestamp)

The timestamp of when the snapshot was created.

snapshotName -> (string)

The name of the snapshot.

snapshotRemainingDays -> (integer)

The amount of days until the snapshot is deleted.

snapshotRetentionPeriod -> (integer)

The period of time, in days, of how long the snapshot is retained.

snapshotRetentionStartTime -> (timestamp)

The timestamp of when data within the snapshot started getting retained.

status -> (string)

The status of the snapshot.

totalBackupSizeInMegaBytes -> (double)

The total size, in megabytes, of how big the snapshot is.