list-snapshots¶

Description¶

Returns list of snapshot names.

Synopsis¶

  list-snapshots
--environment-name <value>
--database-name <value>
[--table-name <value>]
[--command-id <value>]
[--from-creation-time <value>]
[--to-creation-time <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The name of the environment.

--database-name (string)

The name of the database.

--table-name (string)

The table name.

--command-id (integer)

The submitted Command ID of the snapshots.

--from-creation-time (datetime)

The creation time of the snapshots to search (inclusive).

--to-creation-time (datetime)

The ending time of the snapshot creation to search (inclusive).

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

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

environmentName -> (string)

The name of the environment.

databaseName -> (string)

The name of the database.

snapshots -> (array)

List of snapshots.

item -> (object)

An instance of a table’s snapshot.

tableName -> (string)

The table name.

snapshotName -> (string)

The name of the snapshot.

creationTime -> (integer)

The creation time of the snapshot.

status -> (string)

Snapshot Status Type. NEW - Expected when a snapshot request was just requested. IN_PROGRESS - When a snapshot request is in progress. FAILED - If for any reason a snapshot request has failed. SUCCESSFUL - A snapshot request has completed successfully. LOCKED - A snapshot exists, but can’t be restored or read. DELETED - A snapshot existed but was just deleted. CORRUPT - A snapshot got corrupted. DELETING - A snapshot is being deleted.

commandID -> (integer)

The submitted Command ID of the snapshot.

snapshotLocation -> (string)

The location of the snapshot.

failureReason -> (string)

Reason for the failure in case of snapshot creation failed.

status -> (string)

Snapshot Status Type. NEW - Expected when a snapshot request was just requested. IN_PROGRESS - When a snapshot request is in progress. FAILED - If for any reason a snapshot request has failed. SUCCESSFUL - A snapshot request has completed successfully. LOCKED - A snapshot exists, but can’t be restored or read. DELETED - A snapshot existed but was just deleted. CORRUPT - A snapshot got corrupted. DELETING - A snapshot is being deleted.

statusReason -> (string)

Reason for the status.

Form Factors¶

public