describe_image_usage_report_entries¶
Operation¶
describe_image_usage_report_entries
async
¶
describe_image_usage_report_entries(request: DescribeImageUsageReportEntriesInput | DescribeImageUsageReportEntriesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeImageUsageReportEntriesOutput
describe_image_usage_report_entries(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeImageUsageReportEntriesInputDict]) -> DescribeImageUsageReportEntriesOutput
Describes the entries in image usage reports, showing how your images are used across other Amazon Web Services accounts.
For more information, see View your AMI usage in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
DescribeImageUsageReportEntriesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeImageUsageReportEntriesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeImageUsageReportEntriesInput 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
¶
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-DDThhss.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|imagebuilder:ImageRecipe|imagebuilder:ContainerRecipe).
image_ids
class-attribute
instance-attribute
¶
The IDs of the images for filtering the report entries. If specified, only report entries 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.
Dictionaries¶
DescribeImageUsageReportEntriesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeImageUsageReportEntriesInput.
Attributes¶
dry_run
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
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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-DDThhss.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|imagebuilder:ImageRecipe|imagebuilder:ContainerRecipe).
image_ids
instance-attribute
¶
The IDs of the images for filtering the report entries. If specified, only report entries containing these images are returned.
max_results
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.
Output¶
DescribeImageUsageReportEntriesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeImageUsageReportEntriesOutput structure.
Attributes¶
image_usage_report_entries
class-attribute
instance-attribute
¶
image_usage_report_entries: list[ImageUsageReportEntry] | None = ...
The content of the 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
¶
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.