Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
NoteThe order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Request ParametersThe following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
The AMI attribute.
Note: The blockDeviceMapping
attribute is deprecated. Using this attribute returns the Client.AuthFailure
error. To get information about the block device mappings for an AMI, describe the image instead.
Type: String
Valid Values: description | kernel | ramdisk | launchPermission | productCodes | blockDeviceMapping | sriovNetSupport | bootMode | tpmSupport | uefiData | lastLaunchedTime | imdsSupport | deregistrationProtection
Required: Yes
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Type: Boolean
Required: No
The ID of the AMI.
Type: String
Required: Yes
The following elements are returned by the service.
The block device mapping entries.
Type: Array of BlockDeviceMapping objects
The boot mode.
Type: AttributeValue object
Indicates whether deregistration protection is enabled for the AMI.
Type: AttributeValue object
A description for the AMI.
Type: AttributeValue object
The ID of the AMI.
Type: String
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.
Type: AttributeValue object
The kernel ID.
Type: AttributeValue object
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.
NotelastLaunchedTime
data is available starting April 2017.
Type: AttributeValue object
The launch permissions.
Type: Array of LaunchPermission objects
The product codes.
Type: Array of ProductCode objects
The RAM disk ID.
Type: AttributeValue object
The ID of the request.
Type: String
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Type: AttributeValue object
If the image is configured for NitroTPM support, the value is v2.0
.
Type: AttributeValue object
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot for Amazon EC2 instances in the Amazon EC2 User Guide.
Type: AttributeValue object
For information about the errors that are common to all actions, see Common client error codes.
Examples Example 1This example lists the launch permissions for the specified AMI.
Sample Requesthttps://ec2.amazonaws.com/?Action=DescribeImageAttribute
&ImageId=ami-61a54008
&Attribute=launchPermission
&AUTHPARAMS
Sample Response
<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<imageId>ami-61a54008</imageId>
<launchPermission>
<item>
<group>all</group>
</item>
<item>
<userId>495219933132</userId>
</item>
</launchPermission>
</DescribeImageAttributeResponse>
Example 2
This example lists the product codes for the specified AMI.
Sample Requesthttps://ec2.amazonaws.com/?Action=DescribeImageAttribute
&ImageId=ami-2bb65342
&Attribute=productCodes
&AUTHPARAMS
Sample Response
<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/>
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<imageId>ami-2bb65342</imageId>
<productCodes>
<item>
<productCode>a1b2c3d4e5f6g7h8i9j10k11</productCode>
<type>marketplace</type>
</item>
</productCodes>
</DescribeImageAttributeResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4