EC2 / Client / list_images_in_recycle_bin

list_images_in_recycle_bin#

EC2.Client.list_images_in_recycle_bin(**kwargs)#

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_images_in_recycle_bin(
    ImageIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    DryRun=True|False
)
Parameters:
  • ImageIds (list) –

    The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request.

    • (string) –

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

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

  • 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

{
    'Images': [
        {
            'ImageId': 'string',
            'Name': 'string',
            'Description': 'string',
            'RecycleBinEnterTime': datetime(2015, 1, 1),
            'RecycleBinExitTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Images (list) –

      Information about the AMIs.

      • (dict) –

        Information about an AMI that is currently in the Recycle Bin.

        • ImageId (string) –

          The ID of the AMI.

        • Name (string) –

          The name of the AMI.

        • Description (string) –

          The description of the AMI.

        • RecycleBinEnterTime (datetime) –

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

        • RecycleBinExitTime (datetime) –

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

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