describe_image_attribute¶
Operation¶
async
¶
describe_image_attribute(input: DescribeImageAttributeInput, plugins: list[Plugin] | None = None) -> DescribeImageAttributeOutput
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
Note
The 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeImageAttributeInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeImageAttributeOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DescribeImageAttribute.
Attributes¶
class-attribute
instance-attribute
¶
attribute: str | None = ...
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.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Describes an image attribute.
Attributes¶
class-attribute
instance-attribute
¶
block_device_mappings: list[BlockDeviceMapping] | None = ...
The block device mapping entries.
class-attribute
instance-attribute
¶
The boot mode.
class-attribute
instance-attribute
¶
Indicates whether deregistration protection is enabled for the AMI.
class-attribute
instance-attribute
¶
A description for the AMI.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
The kernel ID.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
launch_permissions: list[LaunchPermission] | None = ...
The launch permissions.
class-attribute
instance-attribute
¶
product_codes: list[ProductCode] | None = ...
The product codes.
class-attribute
instance-attribute
¶
The RAM disk ID.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
class-attribute
instance-attribute
¶
If the image is configured for NitroTPM support, the value is v2.0.
class-attribute
instance-attribute
¶
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.