EC2 / Paginator / DescribeImageUsageReports

DescribeImageUsageReports¶

class EC2.Paginator.DescribeImageUsageReports¶

paginator = client.get_paginator('describe_image_usage_reports')

paginate(**kwargs)¶

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

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 reports. If specified, only reports containing these images are returned.
- (string) –
ReportIds (list) –
The IDs of the image usage reports.
- (string) –
Filters (list) –
The filters.
- 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.
- state - The state of the report ( available | pending | error).
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- (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

{
    'ImageUsageReports': [
        {
            'ImageId': 'string',
            'ReportId': 'string',
            'ResourceTypes': [
                {
                    'ResourceType': 'string',
                    'ResourceTypeOptions': [
                        {
                            'OptionName': 'string',
                            'OptionValues': [
                                'string',
                            ]
                        },
                    ]
                },
            ],
            'AccountIds': [
                'string',
            ],
            'State': 'string',
            'StateReason': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'ExpirationTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- ImageUsageReports (list) –
  
  The image usage reports.
  - (dict) –
    
    The configuration and status of an image usage report.
    - ImageId (string) –
      
      The ID of the image that was specified when the report was created.
    - ReportId (string) –
      
      The ID of the report.
    - ResourceTypes (list) –
      
      The resource types that were specified when the report was created.
      - (dict) –
        
        A resource type to include in the report. Associated options can also be specified if the resource type is a launch template.
        
        ResourceType (string) –
        
        The resource type.
        
        Valid values: ec2:Instance | ec2:LaunchTemplate
        
        ResourceTypeOptions (list) –
        
        The options that affect the scope of the report. Valid only when ResourceType is ec2:LaunchTemplate.
        
        (dict) –
        
        The options that affect the scope of the report.
        
        OptionName (string) –
        
        The name of the option.
        
        OptionValues (list) –
        
        The number of launch template versions to check.
        
        (string) –
    - AccountIds (list) –
      
      The IDs of the Amazon Web Services accounts that were specified when the report was created.
      - (string) –
    - State (string) –
      
      The current state of the report. Possible values:
      - available - The report is available to view.
      - pending - The report is being created and not available to view.
      - error - The report could not be created.
    - StateReason (string) –
      
      Provides additional details when the report is in an error state.
    - CreationTime (datetime) –
      
      The date and time when the report was created.
    - ExpirationTime (datetime) –
      
      The date and time when Amazon EC2 will delete the report (30 days after the report was created).
    - Tags (list) –
      
      Any tags assigned to the report.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.