EC2 / Paginator / DescribeImageUsageReportEntries

DescribeImageUsageReportEntries

class EC2.Paginator.DescribeImageUsageReportEntries

paginator = client.get_paginator('describe_image_usage_report_entries')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ImageIds (list) –

  The IDs of the images for filtering the report entries. If specified, only report entries containing these images are returned.

  • (string) –

• ReportIds (list) –

  The IDs of the usage reports.

  • (string) –

• Filters (list) –

  The filters.

  • account-id - A 12-digit Amazon Web Services account ID.

  • creation-time - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2025-11-29T11:04:43.305Z. You can use a wildcard ( *), for example, 2025-11-29T*, which matches an entire day.

  • resource-type - The resource type ( ec2:Instance | ec2:LaunchTemplate).

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

• 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

{
    'ImageUsageReportEntries': [
        {
            'ResourceType': 'string',
            'ReportId': 'string',
            'UsageCount': 123,
            'AccountId': 'string',
            'ImageId': 'string',
            'ReportCreationTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • ImageUsageReportEntries (list) –

    The content of the usage reports.

    • (dict) –

      A single entry in an image usage report, detailing how an image is being used by a specific Amazon Web Services account and resource type.

      • ResourceType (string) –

        The type of resource ( ec2:Instance or ec2:LaunchTemplate).

      • ReportId (string) –

        The ID of the report.

      • UsageCount (integer) –

        The number of times resources of this type reference this image in the account.

      • AccountId (string) –

        The ID of the account that uses the image.

      • ImageId (string) –

        The ID of the image.

      • ReportCreationTime (datetime) –

        The date and time the report creation was initiated.