EC2 / Paginator / ListSnapshotsInRecycleBin

ListSnapshotsInRecycleBin

class EC2.Paginator.ListSnapshotsInRecycleBin

paginator = client.get_paginator('list_snapshots_in_recycle_bin')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.list_snapshots_in_recycle_bin().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SnapshotIds=[
        'string',
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SnapshotIds (list) –

  The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Snapshots': [
        {
            'SnapshotId': 'string',
            'RecycleBinEnterTime': datetime(2015, 1, 1),
            'RecycleBinExitTime': datetime(2015, 1, 1),
            'Description': 'string',
            'VolumeId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Snapshots (list) –

    Information about the snapshots.

    • (dict) –

      Information about a snapshot that is currently in the Recycle Bin.

      • SnapshotId (string) –

        The ID of the snapshot.

      • RecycleBinEnterTime (datetime) –

        The date and time when the snaphsot entered the Recycle Bin.

      • RecycleBinExitTime (datetime) –

        The date and time when the snapshot is to be permanently deleted from the Recycle Bin.

      • Description (string) –

        The description for the snapshot.

      • VolumeId (string) –

        The ID of the volume from which the snapshot was created.