EC2 / Client / disable_fast_snapshot_restores

disable_fast_snapshot_restores

EC2.Client.disable_fast_snapshot_restores(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disable_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.

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

    • (dict) –

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

    • (dict) –

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

      • SnapshotId (string) –

        The ID of the snapshot.

      • FastSnapshotRestoreStateErrors (list) –

        The errors.

        • (dict) –

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

          • AvailabilityZone (string) –

            The Availability Zone.

          • Error (dict) –

            The error.

            • Code (string) –

              The error code.

            • Message (string) –

              The error message.