Skip to content

EC2  >  Operations  >  describe_image_references

describe_image_references

Operation

describe_image_references async

describe_image_references(request: DescribeImageReferencesInput | DescribeImageReferencesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeImageReferencesOutput
describe_image_references(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeImageReferencesInputDict]) -> DescribeImageReferencesOutput

Describes your Amazon Web Services resources that are referencing the specified images.

For more information, see Identify your resources referencing specified AMIs 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
DescribeImageReferencesOutput

An instance of DescribeImageReferencesOutput.

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

DescribeImageReferencesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeImageReferencesInput 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.

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

The IDs of the images to check for resource references.

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

Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for ResourceTypeOptions. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes with ResourceTypeOptions, your specified values override the default values.

Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe

Either IncludeAllResourceTypes or ResourceTypes must be specified.

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.

resource_types class-attribute instance-attribute
resource_types: list[ResourceTypeRequest] | None = ...

The Amazon Web Services resource types to check for image references.

Either IncludeAllResourceTypes or ResourceTypes must be specified.

Dictionaries

DescribeImageReferencesInputDict

Bases: TypedDict

Dictionary form of DescribeImageReferencesInput.

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.

image_ids instance-attribute
image_ids: Required[Sequence[str]]

The IDs of the images to check for resource references.

include_all_resource_types instance-attribute
include_all_resource_types: bool | None

Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for ResourceTypeOptions. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes with ResourceTypeOptions, your specified values override the default values.

Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe

Either IncludeAllResourceTypes or ResourceTypes must be specified.

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.

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

resource_types instance-attribute

The Amazon Web Services resource types to check for image references.

Either IncludeAllResourceTypes or ResourceTypes must be specified.

Output

DescribeImageReferencesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeImageReferencesOutput structure.

Attributes

image_references class-attribute instance-attribute
image_references: list[ImageReference] | None = ...

The resources that are referencing the specified images.

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.