AWS CLI Command Reference

[ aws . ec2 ]

describe-image-references

Description

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 .

See also: AWS API Documentation

describe-image-references is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ImageReferences

Synopsis

  describe-image-references
--image-ids <value>
[--include-all-resource-types | --no-include-all-resource-types]
[--resource-types <value>]
[--dry-run | --no-dry-run]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--image-ids (list) [required]

The IDs of the images to check for resource references.

Constraints:

  • min: 1
  • max: 10

(string)

Syntax:

"string" "string" ...

--include-all-resource-types | --no-include-all-resource-types (boolean)

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.

--resource-types (list)

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

Either IncludeAllResourceTypes or ResourceTypes must be specified.

(structure)

A resource type to check for image references. Associated options can also be specified if the resource type is an EC2 instance or launch template.

ResourceType -> (string)

The resource type.

Possible values:

  • ec2:Instance
  • ec2:LaunchTemplate
  • ssm:Parameter
  • imagebuilder:ImageRecipe
  • imagebuilder:ContainerRecipe

ResourceTypeOptions -> (list)

The options that affect the scope of the response. Valid only when ResourceType is ec2:Instance or ec2:LaunchTemplate .

(structure)

The options that affect the scope of the response.

OptionName -> (string)

The name of the option.

  • For ec2:Instance : Specify