Skip to content

EC2  >  Operations  >  describe_image_usage_reports

describe_image_usage_reports

Operation

describe_image_usage_reports async 

describe_image_usage_reports(input: DescribeImageUsageReportsInput, plugins: list[Plugin] | None = None) -> DescribeImageUsageReportsOutput

Describes the configuration and status of image usage reports, filtered by report IDs or image IDs.

For more information, see View your AMI usage in the Amazon EC2 User Guide.

Parameters:

Name Type Description Default
input DescribeImageUsageReportsInput

An instance of DescribeImageUsageReportsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeImageUsageReportsOutput

An instance of DescribeImageUsageReportsOutput.

Input

DescribeImageUsageReportsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeImageUsageReportsInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute 
filters: list[Filter] | None = ...

The filters.

  • creation-time - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh🇲🇲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.

image_ids class-attribute instance-attribute 
image_ids: list[str] | None = ...

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

max_results class-attribute instance-attribute 
max_results: int | None = ...

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.

next_token class-attribute instance-attribute 
next_token: str | None = ...

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

report_ids class-attribute instance-attribute 
report_ids: list[str] | None = ...

The IDs of the image usage reports.

Output

DescribeImageUsageReportsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeImageUsageReportsOutput structure.

Attributes

image_usage_reports class-attribute instance-attribute 
image_usage_reports: list[ImageUsageReport] | None = ...

The image usage reports.

next_token class-attribute instance-attribute 
next_token: str | None = ...

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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.