AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . redshift-serverless ]

delete-snapshot

Description

Deletes a snapshot from Amazon Redshift Serverless.

See also: AWS API Documentation

Synopsis

  delete-snapshot
--snapshot-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--snapshot-name (string)

The name of the snapshot to be deleted.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

snapshot -> (structure)

The deleted snapshot object.

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.

adminPasswordSecretArn -> (string)

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

adminPasswordSecretKmsKeyId -> (string)

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

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.