EC2 / Paginator / ListImagesInRecycleBin

ListImagesInRecycleBin

class EC2.Paginator.ListImagesInRecycleBin

paginator = client.get_paginator('list_images_in_recycle_bin')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

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) –

• 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

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

}

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.