EC2 / Client / list_snapshots_in_recycle_bin

list_snapshots_in_recycle_bin#

EC2.Client.list_snapshots_in_recycle_bin(**kwargs)#

Lists one or more snapshots that are currently in the Recycle Bin.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshots_in_recycle_bin(
    MaxResults=123,
    NextToken='string',
    SnapshotIds=[
        'string',
    ],
    DryRun=True|False
)
Parameters:
  • 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'Snapshots': [
        {
            'SnapshotId': 'string',
            'RecycleBinEnterTime': datetime(2015, 1, 1),
            'RecycleBinExitTime': datetime(2015, 1, 1),
            'Description': 'string',
            'VolumeId': 'string'
        },
    ],
    'NextToken': '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.

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