Documentation

Describes an image.

See: newImage smart constructor.

Create a value of Image with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blockDeviceMappings:Image', image_blockDeviceMappings - Any block device mapping entries.

$sel:bootMode:Image', image_bootMode - The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

$sel:creationDate:Image', image_creationDate - The date and time the image was created.

$sel:deprecationTime:Image', image_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.

$sel:description:Image', image_description - The description of the AMI that was provided during image creation.

$sel:enaSupport:Image', image_enaSupport - Specifies whether enhanced networking with ENA is enabled.

$sel:imageOwnerAlias:Image', image_imageOwnerAlias - The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.

$sel:imdsSupport:Image', image_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.

$sel:kernelId:Image', image_kernelId - The kernel associated with the image, if any. Only applicable for machine images.

$sel:name:Image', image_name - The name of the AMI that was provided during image creation.

$sel:platform:Image', image_platform - This value is set to windows for Windows AMIs; otherwise, it is blank.

$sel:platformDetails:Image', image_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.

$sel:productCodes:Image', image_productCodes - Any product codes associated with the AMI.

$sel:ramdiskId:Image', image_ramdiskId - The RAM disk associated with the image, if any. Only applicable for machine images.

$sel:rootDeviceName:Image', image_rootDeviceName - The device name of the root device volume (for example, /dev/sda1).

$sel:sriovNetSupport:Image', image_sriovNetSupport - Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

$sel:stateReason:Image', image_stateReason - The reason for the state change.

$sel:tags:Image', image_tags - Any tags assigned to the image.

$sel:tpmSupport:Image', image_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.

$sel:usageOperation:Image', image_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 Web Services Cost and Usage Report and in the Amazon Web Services 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 CLI.

$sel:imageId:Image', image_imageId - The ID of the AMI.

$sel:imageLocation:Image', image_imageLocation - The location of the AMI.

$sel:state:Image', image_state - The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

$sel:ownerId:Image', image_ownerId - The ID of the Amazon Web Services account that owns the image.

$sel:public:Image', image_public - 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.

$sel:architecture:Image', image_architecture - The architecture of the image.

$sel:imageType:Image', image_imageType - The type of image.

$sel:rootDeviceType:Image', image_rootDeviceType - The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

$sel:virtualizationType:Image', image_virtualizationType - The type of virtualization of the AMI.

$sel:hypervisor:Image', image_hypervisor - The hypervisor type of the image.

Any block device mapping entries.

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

The date and time the image was created.

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.

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

Specifies whether enhanced networking with ENA is enabled.

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

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.

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

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

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

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.

Any product codes associated with the AMI.

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

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

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

The reason for the state change.

Any tags assigned to the image.

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

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

The ID of the AMI.

The location of the AMI.

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

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

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.

The architecture of the image.

The type of image.

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

The type of virtualization of the AMI.

The hypervisor type of the image.