/AWS1/CL_EC2IMAGE¶
Describes an image.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_ARCHITECTURE TYPE /AWS1/EC2ARCHITECTUREVALUES /AWS1/EC2ARCHITECTUREVALUES¶
The architecture of the image.
IV_CREATIONDATE TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The date and time the image was created.
IV_IMAGEID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of the AMI.
IV_IMAGELOCATION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The location of the AMI.
IV_IMAGETYPE TYPE /AWS1/EC2IMAGETYPEVALUES /AWS1/EC2IMAGETYPEVALUES¶
The type of image.
IV_PUBLIC TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
Indicates whether the image has public launch permissions. The value is
trueif this image has public launch permissions orfalseif it has only implicit and explicit launch permissions.
IV_KERNELID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The kernel associated with the image, if any. Only applicable for machine images.
IV_OWNERID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of the Amazon Web Services account that owns the image.
IV_PLATFORM TYPE /AWS1/EC2PLATFORMVALUES /AWS1/EC2PLATFORMVALUES¶
This value is set to
windowsfor Windows AMIs; otherwise, it is blank.
IV_PLATFORMDETAILS TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
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.
IV_USAGEOPERATION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
usageOperationcorresponds 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.
IT_PRODUCTCODES TYPE /AWS1/CL_EC2PRODUCTCODE=>TT_PRODUCTCODELIST TT_PRODUCTCODELIST¶
Any product codes associated with the AMI.
IV_RAMDISKID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The RAM disk associated with the image, if any. Only applicable for machine images.
IV_STATE TYPE /AWS1/EC2IMAGESTATE /AWS1/EC2IMAGESTATE¶
The current state of the AMI. If the state is
available, the image is successfully registered and can be used to launch an instance.
IT_BLOCKDEVICEMAPPINGS TYPE /AWS1/CL_EC2BLOCKDEVICEMAPPING=>TT_BLOCKDEVICEMAPPINGLIST TT_BLOCKDEVICEMAPPINGLIST¶
Any block device mapping entries.
IV_DESCRIPTION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The description of the AMI that was provided during image creation.
IV_ENASUPPORT TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
Specifies whether enhanced networking with ENA is enabled.
IV_HYPERVISOR TYPE /AWS1/EC2HYPERVISORTYPE /AWS1/EC2HYPERVISORTYPE¶
The hypervisor type of the image. Only
xenis supported.ovmis not supported.
IV_IMAGEOWNERALIAS TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The owner alias (
amazon|aws-marketplace).
IV_NAME TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The name of the AMI that was provided during image creation.
IV_ROOTDEVICENAME TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The device name of the root device volume (for example,
/dev/sda1).
IV_ROOTDEVICETYPE TYPE /AWS1/EC2DEVICETYPE /AWS1/EC2DEVICETYPE¶
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
IV_SRIOVNETSUPPORT TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
IO_STATEREASON TYPE REF TO /AWS1/CL_EC2STATEREASON /AWS1/CL_EC2STATEREASON¶
The reason for the state change.
IT_TAGS TYPE /AWS1/CL_EC2TAG=>TT_TAGLIST TT_TAGLIST¶
Any tags assigned to the image.
IV_VIRTUALIZATIONTYPE TYPE /AWS1/EC2VIRTUALIZATIONTYPE /AWS1/EC2VIRTUALIZATIONTYPE¶
The type of virtualization of the AMI.
IV_BOOTMODE TYPE /AWS1/EC2BOOTMODEVALUES /AWS1/EC2BOOTMODEVALUES¶
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
IV_TPMSUPPORT TYPE /AWS1/EC2TPMSUPPORTVALUES /AWS1/EC2TPMSUPPORTVALUES¶
If the image is configured for NitroTPM support, the value is
v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.
IV_DEPRECATIONTIME TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
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.
IV_IMDSSUPPORT TYPE /AWS1/EC2IMDSSUPPORTVALUES /AWS1/EC2IMDSSUPPORTVALUES¶
If
v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokensautomatically set torequiredso that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimitis set to2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
IV_SOURCEINSTANCEID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
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.
IV_DEREGISTRATIONPROTECTION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
Indicates whether deregistration protection is enabled for the AMI.
IV_LASTLAUNCHEDTIME TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
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.
lastLaunchedTimedata is available starting April 2017.
Queryable Attributes¶
Architecture¶
The architecture of the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARCHITECTURE() |
Getter for ARCHITECTURE, with configurable default |
ASK_ARCHITECTURE() |
Getter for ARCHITECTURE w/ exceptions if field has no value |
HAS_ARCHITECTURE() |
Determine if ARCHITECTURE has a value |
CreationDate¶
The date and time the image was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
ImageId¶
The ID of the AMI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGEID() |
Getter for IMAGEID, with configurable default |
ASK_IMAGEID() |
Getter for IMAGEID w/ exceptions if field has no value |
HAS_IMAGEID() |
Determine if IMAGEID has a value |
ImageLocation¶
The location of the AMI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGELOCATION() |
Getter for IMAGELOCATION, with configurable default |
ASK_IMAGELOCATION() |
Getter for IMAGELOCATION w/ exceptions if field has no value |
HAS_IMAGELOCATION() |
Determine if IMAGELOCATION has a value |
ImageType¶
The type of image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGETYPE() |
Getter for IMAGETYPE, with configurable default |
ASK_IMAGETYPE() |
Getter for IMAGETYPE w/ exceptions if field has no value |
HAS_IMAGETYPE() |
Determine if IMAGETYPE has a value |
Public¶
Indicates whether the image has public launch permissions. The value is
trueif this image has public launch permissions orfalseif it has only implicit and explicit launch permissions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PUBLIC() |
Getter for PUBLIC, with configurable default |
ASK_PUBLIC() |
Getter for PUBLIC w/ exceptions if field has no value |
HAS_PUBLIC() |
Determine if PUBLIC has a value |
KernelId¶
The kernel associated with the image, if any. Only applicable for machine images.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KERNELID() |
Getter for KERNELID, with configurable default |
ASK_KERNELID() |
Getter for KERNELID w/ exceptions if field has no value |
HAS_KERNELID() |
Determine if KERNELID has a value |
OwnerId¶
The ID of the Amazon Web Services account that owns the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OWNERID() |
Getter for OWNERID, with configurable default |
ASK_OWNERID() |
Getter for OWNERID w/ exceptions if field has no value |
HAS_OWNERID() |
Determine if OWNERID has a value |
Platform¶
This value is set to
windowsfor Windows AMIs; otherwise, it is blank.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLATFORM() |
Getter for PLATFORM, with configurable default |
ASK_PLATFORM() |
Getter for PLATFORM w/ exceptions if field has no value |
HAS_PLATFORM() |
Determine if PLATFORM has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLATFORMDETAILS() |
Getter for PLATFORMDETAILS, with configurable default |
ASK_PLATFORMDETAILS() |
Getter for PLATFORMDETAILS w/ exceptions if field has no val |
HAS_PLATFORMDETAILS() |
Determine if PLATFORMDETAILS has a value |
UsageOperation¶
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
usageOperationcorresponds 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USAGEOPERATION() |
Getter for USAGEOPERATION, with configurable default |
ASK_USAGEOPERATION() |
Getter for USAGEOPERATION w/ exceptions if field has no valu |
HAS_USAGEOPERATION() |
Determine if USAGEOPERATION has a value |
ProductCodes¶
Any product codes associated with the AMI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRODUCTCODES() |
Getter for PRODUCTCODES, with configurable default |
ASK_PRODUCTCODES() |
Getter for PRODUCTCODES w/ exceptions if field has no value |
HAS_PRODUCTCODES() |
Determine if PRODUCTCODES has a value |
RamdiskId¶
The RAM disk associated with the image, if any. Only applicable for machine images.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RAMDISKID() |
Getter for RAMDISKID, with configurable default |
ASK_RAMDISKID() |
Getter for RAMDISKID w/ exceptions if field has no value |
HAS_RAMDISKID() |
Determine if RAMDISKID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
BlockDeviceMappings¶
Any block device mapping entries.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BLOCKDEVICEMAPPINGS() |
Getter for BLOCKDEVICEMAPPINGS, with configurable default |
ASK_BLOCKDEVICEMAPPINGS() |
Getter for BLOCKDEVICEMAPPINGS w/ exceptions if field has no |
HAS_BLOCKDEVICEMAPPINGS() |
Determine if BLOCKDEVICEMAPPINGS has a value |
Description¶
The description of the AMI that was provided during image creation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
EnaSupport¶
Specifies whether enhanced networking with ENA is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENASUPPORT() |
Getter for ENASUPPORT, with configurable default |
ASK_ENASUPPORT() |
Getter for ENASUPPORT w/ exceptions if field has no value |
HAS_ENASUPPORT() |
Determine if ENASUPPORT has a value |
Hypervisor¶
The hypervisor type of the image. Only
xenis supported.ovmis not supported.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HYPERVISOR() |
Getter for HYPERVISOR, with configurable default |
ASK_HYPERVISOR() |
Getter for HYPERVISOR w/ exceptions if field has no value |
HAS_HYPERVISOR() |
Determine if HYPERVISOR has a value |
ImageOwnerAlias¶
The owner alias (
amazon|aws-marketplace).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGEOWNERALIAS() |
Getter for IMAGEOWNERALIAS, with configurable default |
ASK_IMAGEOWNERALIAS() |
Getter for IMAGEOWNERALIAS w/ exceptions if field has no val |
HAS_IMAGEOWNERALIAS() |
Determine if IMAGEOWNERALIAS has a value |
Name¶
The name of the AMI that was provided during image creation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
RootDeviceName¶
The device name of the root device volume (for example,
/dev/sda1).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROOTDEVICENAME() |
Getter for ROOTDEVICENAME, with configurable default |
ASK_ROOTDEVICENAME() |
Getter for ROOTDEVICENAME w/ exceptions if field has no valu |
HAS_ROOTDEVICENAME() |
Determine if ROOTDEVICENAME has a value |
RootDeviceType¶
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROOTDEVICETYPE() |
Getter for ROOTDEVICETYPE, with configurable default |
ASK_ROOTDEVICETYPE() |
Getter for ROOTDEVICETYPE w/ exceptions if field has no valu |
HAS_ROOTDEVICETYPE() |
Determine if ROOTDEVICETYPE has a value |
SriovNetSupport¶
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SRIOVNETSUPPORT() |
Getter for SRIOVNETSUPPORT, with configurable default |
ASK_SRIOVNETSUPPORT() |
Getter for SRIOVNETSUPPORT w/ exceptions if field has no val |
HAS_SRIOVNETSUPPORT() |
Determine if SRIOVNETSUPPORT has a value |
StateReason¶
The reason for the state change.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATEREASON() |
Getter for STATEREASON |
Tags¶
Any tags assigned to the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
VirtualizationType¶
The type of virtualization of the AMI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VIRTUALIZATIONTYPE() |
Getter for VIRTUALIZATIONTYPE, with configurable default |
ASK_VIRTUALIZATIONTYPE() |
Getter for VIRTUALIZATIONTYPE w/ exceptions if field has no |
HAS_VIRTUALIZATIONTYPE() |
Determine if VIRTUALIZATIONTYPE has a value |
BootMode¶
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BOOTMODE() |
Getter for BOOTMODE, with configurable default |
ASK_BOOTMODE() |
Getter for BOOTMODE w/ exceptions if field has no value |
HAS_BOOTMODE() |
Determine if BOOTMODE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TPMSUPPORT() |
Getter for TPMSUPPORT, with configurable default |
ASK_TPMSUPPORT() |
Getter for TPMSUPPORT w/ exceptions if field has no value |
HAS_TPMSUPPORT() |
Determine if TPMSUPPORT has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPRECATIONTIME() |
Getter for DEPRECATIONTIME, with configurable default |
ASK_DEPRECATIONTIME() |
Getter for DEPRECATIONTIME w/ exceptions if field has no val |
HAS_DEPRECATIONTIME() |
Determine if DEPRECATIONTIME has a value |
ImdsSupport¶
If
v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokensautomatically set torequiredso that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimitis set to2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMDSSUPPORT() |
Getter for IMDSSUPPORT, with configurable default |
ASK_IMDSSUPPORT() |
Getter for IMDSSUPPORT w/ exceptions if field has no value |
HAS_IMDSSUPPORT() |
Determine if IMDSSUPPORT has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEINSTANCEID() |
Getter for SOURCEINSTANCEID, with configurable default |
ASK_SOURCEINSTANCEID() |
Getter for SOURCEINSTANCEID w/ exceptions if field has no va |
HAS_SOURCEINSTANCEID() |
Determine if SOURCEINSTANCEID has a value |
DeregistrationProtection¶
Indicates whether deregistration protection is enabled for the AMI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEREGISTRATIONPROTECTION() |
Getter for DEREGISTRATIONPROTECTION, with configurable defau |
ASK_DEREGISTRATIONPROTECTION() |
Getter for DEREGISTRATIONPROTECTION w/ exceptions if field h |
HAS_DEREGISTRATIONPROTECTION() |
Determine if DEREGISTRATIONPROTECTION has a value |
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.
lastLaunchedTimedata is available starting April 2017.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTLAUNCHEDTIME() |
Getter for LASTLAUNCHEDTIME, with configurable default |
ASK_LASTLAUNCHEDTIME() |
Getter for LASTLAUNCHEDTIME w/ exceptions if field has no va |
HAS_LASTLAUNCHEDTIME() |
Determine if LASTLAUNCHEDTIME has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_IMAGELIST¶
TYPES TT_IMAGELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EC2IMAGE WITH DEFAULT KEY
.