Image

Describes an image.

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

deregistrationProtection

Indicates whether deregistration protection is enabled for the AMI.

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. Only xen is supported. ovm is not supported.

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 owner alias (amazon | aws-backup-vault | aws-marketplace).

Type: String

Required: No

imageOwnerId

The ID of the AWS 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

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

lastLaunchedTime

The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

Note

lastLaunchedTime data is available starting April 2017.

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

sourceImageId

The ID of the source AMI from which the AMI was created.

The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new AMI in the Amazon EC2 User Guide.

Type: String

Required: No

sourceImageRegion

The Region of the source AMI.

The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new AMI in the Amazon EC2 User Guide.

Type: String

Required: No

sourceInstanceId

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

Type: String

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 AWS Cost and Usage Report and in the AWS 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 AWS CLI.

Type: String

Required: No

virtualizationType

The type of virtualization of the AMI.

Type: String

Valid Values: hvm | paravirtual

Required: No

Image

Contents

Note

See Also