Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

Image

Describes an image.

Contents

architecture

The architecture of the image.

Type: String

Valid Values: i386 | x86_64

Required: No

blockDeviceMapping

Any block device mapping entries.

Type: Array of BlockDeviceMapping objects

Required: No

creationDate

The date and time the image was created.

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 AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

Type: String

Required: No

imageOwnerId

The AWS account ID of the image owner.

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

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

The value is Windows for Windows AMIs; otherwise blank.

Type: String

Valid Values: Windows

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 (for example, /dev/sda1 or /dev/xvda).

Type: String

Required: No

rootDeviceType

The type of root device used by the AMI. The AMI can use an 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

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 AWS SDKs, see the following:

On this page: