describe_image_usage_reports
async
¶
describe_image_usage_reports(
*,
config_overrides: Optional[AsyncEC2ClientConfig] = None,
image_ids: Optional[DescribeImageUsageReportsImageIdStringList] = None,
report_ids: Optional[ImageUsageReportIdStringList] = None,
next_token: Optional[String] = None,
filters: Optional[FilterList] = None,
dry_run: Optional[Boolean] = None,
max_results: Optional[DescribeImageUsageReportsMaxResults] = None,
) -> DescribeImageUsageReportsResult
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:
-
image_ids(Optional[DescribeImageUsageReportsImageIdStringList], default:None) –The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.
-
report_ids(Optional[ImageUsageReportIdStringList], default:None) –The IDs of the image usage reports.
-
next_token(Optional[String], default:None) –The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
filters(Optional[FilterList], default: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: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:- 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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
-
-
dry_run(Optional[Boolean], default: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 isUnauthorizedOperation. -
max_results(Optional[DescribeImageUsageReportsMaxResults], default: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.
Raises:
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ec2/_services/async_ec2.py
26321 26322 26323 26324 26325 26326 26327 26328 26329 26330 26331 26332 26333 26334 26335 26336 26337 26338 26339 26340 26341 26342 26343 26344 26345 26346 26347 26348 26349 26350 26351 26352 26353 26354 26355 26356 26357 26358 26359 26360 26361 26362 26363 26364 26365 26366 26367 26368 26369 26370 26371 26372 26373 26374 26375 26376 26377 26378 26379 26380 26381 26382 26383 26384 26385 26386 26387 26388 26389 26390 | |