AMI

This table represents the AMI resource from Amazon Web Services.

aws.ami

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
architecturecorestringThe architecture of the image.
arncorestring
block_device_mappingscorejsonAny block device mapping entries.
boot_modecorestringThe boot mode of the image. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Instance launch behavior with Amazon EC2 boot modes</a> in the <i>Amazon EC2 User Guide</i>.
creation_datecorestringThe date and time the image was created.
deprecation_timecorestringThe date and time to deprecate the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
deregistration_protectioncorestringIndicates whether deregistration protection is enabled for the AMI.
descriptioncorestringThe description of the AMI that was provided during image creation.
ena_supportcoreboolSpecifies whether enhanced networking with ENA is enabled.
hypervisorcorestringThe hypervisor type of the image. Only <code>xen</code> is supported. <code>ovm</code> is not supported.
image_allowedcoreboolIf <code>true</code>, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If <code>false</code> and Allowed AMIs is set to <code>enabled</code>, the AMI can't be discovered or used in the account. If <code>false</code> and Allowed AMIs is set to <code>audit-mode</code>, the AMI can be discovered and used in the account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html">Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs</a> in <i>Amazon EC2 User Guide</i>.
image_idcorestringThe ID of the AMI.
image_locationcorestringThe location of the AMI.
image_owner_aliascorestringThe owner alias (<code>amazon</code> | <code>aws-backup-vault</code> | <code>aws-marketplace</code>).
image_typecorestringThe type of image.
imds_supportcorestringIf <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration">Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.
kernel_idcorestringThe kernel associated with the image, if any. Only applicable for machine images.
last_launched_timecorestringThe date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, 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> <code>lastLaunchedTime</code> data is available starting April 2017. </note>
launch_permissionscorejsonThe launch permissions.
namecorestringThe name of the AMI that was provided during image creation.
owner_idcorestringThe ID of the Amazon Web Services account that owns the image.
platformcorestringThis value is set to <code>windows</code> for Windows AMIs; otherwise, it is blank.
platform_detailscorestringThe platform details associated with the billing code of the AMI. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html">Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.
product_codescorejsonThe product codes.
publiccoreboolIndicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions.
ramdisk_idcorestringThe RAM disk associated with the image, if any. Only applicable for machine images.
root_device_namecorestringThe device name of the root device volume (for example, <code>/dev/sda1</code>).
root_device_typecorestringThe type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
source_image_idcorestringThe ID of the source AMI from which the AMI was created. The ID only appears if the AMI was created using <a>CreateImage</a>, <a>CopyImage</a>, or <a>CreateRestoreImageTask</a>. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify-source-ami-used-to-create-new-ami.html">Identify the source AMI used to create a new Amazon EC2 AMI</a> in the <i>Amazon EC2 User Guide</i>.
source_image_regioncorestringThe Region of the source AMI. The Region only appears if the AMI was created using <a>CreateImage</a>, <a>CopyImage</a>, or <a>CreateRestoreImageTask</a>. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify-source-ami-used-to-create-new-ami.html">Identify the source AMI used to create a new Amazon EC2 AMI</a> in the <i>Amazon EC2 User Guide</i>.
source_instance_idcorestringThe ID of the instance that the AMI was created from if the AMI was created using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html">CreateImage</a>. This field only appears if the AMI was created using CreateImage.
sriov_net_supportcorestringSpecifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
statecorestringThe current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.
state_reasoncorejsonThe reason for the state change.
tagscorehstore
tpm_supportcorestringIf the image is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html">NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.
uefi_datacorejsonBase64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData">GetInstanceUefiData</a> command. You can inspect and modify the UEFI data by using the <a href="https://github.com/awslabs/python-uefivars">python-uefivars tool</a> on GitHub. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html">UEFI Secure Boot for Amazon EC2 instances</a> in the <i>Amazon EC2 User Guide</i>.
usage_operationcorestringThe operation of the Amazon EC2 instance and the billing code that is associated with the AMI. <code>usageOperation</code> corresponds to the <a href="https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation">lineitem/Operation</a> column on your Amazon Web Services Cost and Usage Report and in the <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Amazon Web Services Price List API</a>. You can view these fields on the <b>Instances</b> or <b>AMIs</b> pages in the Amazon EC2 console, or in the responses that are returned by the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html">DescribeImages</a> command in the Amazon EC2 API, or the <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html">describe-images</a> command in the CLI.
virtualization_typecorestringThe type of virtualization of the AMI.