Image - Amazon Elastic Compute Cloud
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Image

Describes an image.

Contents

architecture

The architecture of the image.

Type: String

Valid Values: i386 | x86_64 | arm64 | x86_64_mac | arm64_mac

Required: No

blockDeviceMapping

Any block device mapping entries.

Type: Array of BlockDeviceMapping objects

Required: No

bootMode

The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

Type: String

Valid Values: legacy-bios | uefi | uefi-preferred

Required: No

creationDate

The date and time the image was created.

Type: String

Required: No

deprecationTime

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

Type: String

Required: No

description

The description of the AMI that was provided during image creation.

Type: String

Required: No

enaSupport

Specifies whether enhanced networking with ENA is enabled.

Type: Boolean

Required: No

hypervisor

The hypervisor type of the image.

Type: String

Valid Values: ovm | xen

Required: No

imageId

The ID of the AMI.

Type: String

Required: No

imageLocation

The location of the AMI.

Type: String

Required: No

imageOwnerAlias

The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.

Type: String

Required: No

imageOwnerId

The ID of the Amazon Web Services account that owns the image.

Type: String

Required: No

imageState

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Type: String

Valid Values: pending | available | invalid | deregistered | transient | failed | error

Required: No

imageType

The type of image.

Type: String

Valid Values: machine | kernel | ramdisk

Required: No

imdsSupport

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Type: String

Valid Values: v2.0

Required: No

isPublic

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

Type: Boolean

Required: No

kernelId

The kernel associated with the image, if any. Only applicable for machine images.

Type: String

Required: No

name

The name of the AMI that was provided during image creation.

Type: String

Required: No

platform

This value is set to windows for Windows AMIs; otherwise, it is blank.

Type: String

Valid Values: Windows

Required: No

platformDetails

The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

Type: String

Required: No

productCodes

Any product codes associated with the AMI.

Type: Array of ProductCode objects

Required: No

ramdiskId

The RAM disk associated with the image, if any. Only applicable for machine images.

Type: String

Required: No

rootDeviceName

The device name of the root device volume (for example, /dev/sda1).

Type: String

Required: No

rootDeviceType

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

Type: String

Valid Values: ebs | instance-store

Required: No

sriovNetSupport

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Type: String

Required: No

stateReason

The reason for the state change.

Type: StateReason object

Required: No

tagSet

Any tags assigned to the image.

Type: Array of Tag objects

Required: No

tpmSupport

If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

Type: String

Valid Values: v2.0

Required: No

usageOperation

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Cost and Usage Report and in the Amazon Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the Amazon CLI.

Type: String

Required: No

virtualizationType

The type of virtualization of the AMI.

Type: String

Valid Values: hvm | paravirtual

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: