EC2 / Client / describe_fast_snapshot_restores

describe_fast_snapshot_restores

EC2.Client.describe_fast_snapshot_restores(**kwargs)

Describes the state of fast snapshot restores for your snapshots.

See also: AWS API Documentation

Request Syntax

response = client.describe_fast_snapshot_restores(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• Filters (list) –

  The filters. The possible values are:

  • availability-zone: The Availability Zone of the snapshot.

  • owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.

  • snapshot-id: The ID of the snapshot.

  • state: The state of fast snapshot restores for the snapshot ( enabling | optimizing | enabled | disabling | disabled).

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• 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

{
    'FastSnapshotRestores': [
        {
            '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • FastSnapshotRestores (list) –

    Information about the state of fast snapshot restores.

    • (dict) –

      Describes fast snapshot restores for a snapshot.

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

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.