EC2 / Client / enable_fast_snapshot_restores

enable_fast_snapshot_restores

EC2.Client.enable_fast_snapshot_restores(**kwargs)

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 EBS User Guide.

See also: AWS API Documentation

Request Syntax

response = client.enable_fast_snapshot_restores(
    AvailabilityZones=[
        'string',
    ],
    SourceSnapshotIds=[
        'string',
    ],
    DryRun=True|False
)

Parameters:

• AvailabilityZones (list) –

  [REQUIRED]

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

  • (string) –

• SourceSnapshotIds (list) –

  [REQUIRED]

  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) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Successful': [
        {
            'SnapshotId': 'string',
            'AvailabilityZone': 'string',
            'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled',
            'StateTransitionReason': 'string',
            'OwnerId': 'string',
            'OwnerAlias': 'string',
            'EnablingTime': datetime(2015, 1, 1),
            'OptimizingTime': datetime(2015, 1, 1),
            'EnabledTime': datetime(2015, 1, 1),
            'DisablingTime': datetime(2015, 1, 1),
            'DisabledTime': datetime(2015, 1, 1)
        },
    ],
    'Unsuccessful': [
        {
            'SnapshotId': 'string',
            'FastSnapshotRestoreStateErrors': [
                {
                    'AvailabilityZone': 'string',
                    'Error': {
                        'Code': 'string',
                        'Message': 'string'
                    }
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • Successful (list) –

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

    • (dict) –

      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 (datetime) –

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

      • OptimizingTime (datetime) –

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

      • EnabledTime (datetime) –

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

      • DisablingTime (datetime) –

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

      • DisabledTime (datetime) –

        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.

    • (dict) –

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

      • SnapshotId (string) –

        The ID of the snapshot.

      • FastSnapshotRestoreStateErrors (list) –

        The errors.

        • (dict) –

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

          • AvailabilityZone (string) –

            The Availability Zone.

          • Error (dict) –

            The error.

            • Code (string) –

              The error code.

            • Message (string) –

              The error message.