restore-snapshot¶

Description¶

Returns the snapshot that was restored.

Synopsis¶

  restore-snapshot
--environment-name <value>
--database-name <value>
--snapshot-name <value>
--target-environment-name <value>
--target-database-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The name of the original environment.

--database-name (string)

The name of the original database.

--snapshot-name (string)

The name of the snapshot.

--target-environment-name (string)

The name of the target environment where the snapshot should be restored.

--target-database-name (string)

The name of the target database where the snapshot should be restored.

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

snapshotName -> (string)

The name of the snapshot.

targetEnvironmentName -> (string)

The name of the target environment.

targetDatabaseName -> (string)

The name of the target database.

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.

restoreTime -> (integer)

The time when the snapshot restore was started.

commandID -> (integer)

The submitted Command ID of the restore snapshot.

statusReason -> (string)

Reason for the status.

Form Factors¶

public