enable-fast-snapshot-restores¶

Description¶

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

You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores . To disable fast snapshot restores, use DisableFastSnapshotRestores .

For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide .

Synopsis¶

  enable-fast-snapshot-restores
--availability-zones <value>
--source-snapshot-ids <value>
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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 . You can specify a snapshot that was shared with you from another Amazon Web Services account.

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

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

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 enable fast snapshot restore

The following enable-fast-snapshot-restores example enables fast snapshot restore for the specified snapshot in the specified Availability Zones.

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

Output:

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

Output¶

Successful -> (list)

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

(structure)

Describes fast snapshot restores that were successfully enabled.

SnapshotId -> (string)

The ID of the snapshot.

AvailabilityZone -> (string)

The Availability Zone.

State -> (string)

The state of fast snapshot restores.

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

(structure)

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

SnapshotId -> (string)

The ID of the snapshot.

FastSnapshotRestoreStateErrors -> (list)

The errors.

(structure)

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

AvailabilityZone -> (string)

The Availability Zone.

Error -> (structure)

The error.

Code -> (string)

The error code.

Message -> (string)

The error message.

Table of Contents

Feedback

User Guide