Skip to content

EC2  >  Structures  >  Image

Image

Structure Class

Image dataclass

Bases: _SerdeShape

Describes an image.

Attributes

architecture class-attribute instance-attribute
architecture: str | None = ...

The architecture of the image.

block_device_mappings class-attribute instance-attribute
block_device_mappings: list[BlockDeviceMapping] | None = ...

Any block device mapping entries.

boot_mode class-attribute instance-attribute
boot_mode: str | None = ...

The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

creation_date class-attribute instance-attribute
creation_date: str | None = ...

The date and time the image was created.

deprecation_time class-attribute instance-attribute
deprecation_time: str | None = ...

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.

deregistration_protection class-attribute instance-attribute
deregistration_protection: str | None = ...

Indicates whether deregistration protection is enabled for the AMI.

description class-attribute instance-attribute
description: str | None = ...

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

ena_support class-attribute instance-attribute
ena_support: bool | None = ...

Specifies whether enhanced networking with ENA is enabled.

free_tier_eligible class-attribute instance-attribute
free_tier_eligible: bool | None = ...

Indicates whether the image is eligible for Amazon Web Services Free Tier.

  • If true, the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits.

  • If false, the AMI is not eligible for Free Tier.

hypervisor class-attribute instance-attribute
hypervisor: str | None = ...

The hypervisor type of the image. Only xen is supported. ovm is not supported.

image_allowed class-attribute instance-attribute
image_allowed: bool | None = ...

If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

image_id class-attribute instance-attribute
image_id: str | None = ...

The ID of the AMI.

image_location class-attribute instance-attribute
image_location: str | None = ...

The location of the AMI.

image_owner_alias class-attribute instance-attribute
image_owner_alias: str | None = ...

The owner alias (amazon | aws-backup-vault | aws-marketplace).

image_type class-attribute instance-attribute
image_type: str | None = ...

The type of image.

image_watermarks class-attribute instance-attribute
image_watermarks: list[ImageWatermark] | None = ...

The watermarks attached to the AMI.

imds_support class-attribute instance-attribute
imds_support: str | None = ...

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.

instance_type_specification class-attribute instance-attribute
instance_type_specification: InstanceTypeSpecification | None = ...

The instance type specification for the AMI, which defines which instance types are compatible with this image.

kernel_id class-attribute instance-attribute
kernel_id: str | None = ...

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

last_launched_time class-attribute instance-attribute
last_launched_time: str | None = ...

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.

name class-attribute instance-attribute
name: str | None = ...

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

owner_id class-attribute instance-attribute
owner_id: str | None = ...

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

platform class-attribute instance-attribute
platform: str | None = ...

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

platform_details class-attribute instance-attribute
platform_details: str | None = ...

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.

product_codes class-attribute instance-attribute
product_codes: list[ProductCode] | None = ...

Any product codes associated with the AMI.

public class-attribute instance-attribute
public: bool | None = ...

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.

public_ssm_parameter_name class-attribute instance-attribute
public_ssm_parameter_name: str | None = ...

The name of the public Systems Manager parameter that resolves to this AMI, under the aws/service/ namespace.

ramdisk_id class-attribute instance-attribute
ramdisk_id: str | None = ...

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

root_device_name class-attribute instance-attribute
root_device_name: str | None = ...

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

root_device_type class-attribute instance-attribute
root_device_type: str | None = ...

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

scan_results class-attribute instance-attribute
scan_results: ScanResults | None = ...

The Amazon Inspector scan results for the AMI. This information is present only for AMIs that Amazon Inspector has scanned.

When you share an AMI with other accounts, organizations, or organizational units (OUs), or make it public, its scan results are available to the accounts that can use the AMI.

source_image_id class-attribute instance-attribute
source_image_id: str | None = ...

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

source_image_region class-attribute instance-attribute
source_image_region: str | None = ...

The Region of the source AMI.

source_instance_id class-attribute instance-attribute
source_instance_id: str | None = ...

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.

sriov_net_support class-attribute instance-attribute
sriov_net_support: str | None = ...

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

state class-attribute instance-attribute
state: str | None = ...

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

state_reason class-attribute instance-attribute
state_reason: StateReason | None = ...

The reason for the state change.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

Any tags assigned to the image.

tpm_support class-attribute instance-attribute
tpm_support: str | None = ...

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

usage_operation class-attribute instance-attribute
usage_operation: str | None = ...

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.

virtualization_type class-attribute instance-attribute
virtualization_type: str | None = ...

The type of virtualization of the AMI.