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

disable-fast-snapshot-restores

Description

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

See also: AWS API Documentation

Synopsis

  disable-fast-snapshot-restores
--availability-zones <value>
--source-snapshot-ids <value>
[--dry-run | --no-dry-run]
[--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

--availability-zones (list)

One or more Availability Zones. For example, us-east-2a .

(string)

Syntax:

"string" "string" ...

--source-snapshot-ids (list)

The IDs of one or more snapshots. For example, snap-1234567890abcdef0 .

(string)

Syntax:

"string" "string" ...

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To disable fast snapshot restore

The following disable-fast-snapshot-restores example disables fast snapshot restore for the specified snapshot in the specified Availability Zone.

aws ec2 disable-fast-snapshot-restores \
    --availability-zones us-east-2a \
    --source-snapshot-ids snap-1234567890abcdef0

Output:

{
    "Successful": [
        {
            "SnapshotId": "snap-1234567890abcdef0"
            "AvailabilityZone": "us-east-2a",
            "State": "disabling",
            "StateTransitionReason": "Client.UserInitiated",
            "OwnerId": "123456789012",
            "EnablingTime": "2020-01-25T23:57:49.602Z"
        }
    ],
    "Unsuccessful": []
}

Output

Successful -> (list)

Information about the snapshots for which fast snapshot restores were successfully disabled.

(structure)

Describes fast snapshot restores that were successfully disabled.

SnapshotId -> (string)

The ID of the snapshot.

AvailabilityZone -> (string)

The Availability Zone.

State -> (string)

The state of fast snapshot restores for the snapshot.

StateTransitionReason -> (string)

The reason for the state transition. The possible values are as follows:

  • Client.UserInitiated - The state successfully transitioned to enabling or disabling .
  • Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing , enabled , or disabled .

OwnerId -> (string)

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

OwnerAlias -> (string)

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

EnablingTime -> (timestamp)

The time at which fast snapshot restores entered the enabling state.

OptimizingTime -> (timestamp)

The time at which fast snapshot restores entered the optimizing state.

EnabledTime -> (timestamp)

The time at which fast snapshot restores entered the enabled state.

DisablingTime -> (timestamp)

The time at which fast snapshot restores entered the disabling state.

DisabledTime -> (timestamp)

The time at which fast snapshot restores entered the disabled state.

Unsuccessful -> (list)

Information about the snapshots for which fast snapshot restores could not be disabled.

(structure)

Contains information about the errors that occurred when disabling fast snapshot restores.

SnapshotId -> (string)

The ID of the snapshot.

FastSnapshotRestoreStateErrors -> (list)

The errors.

(structure)

Contains information about an error that occurred when disabling fast snapshot restores.

AvailabilityZone -> (string)

The Availability Zone.

Error -> (structure)

The error.

Code -> (string)

The error code.

Message -> (string)

The error message.