Request Parameters Response Elements Errors See Also

DescribeImageUsageReports

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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Filter.N

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

Type: Array of Filter objects

Required: No

ImageId.N

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

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

Type: String

Required: No

ReportId.N

The IDs of the image usage reports.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Elements

The following elements are returned by the service.

imageUsageReportSet

The image usage reports.

Type: Array of ImageUsageReport objects

nextToken

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.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.