Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
Synopsis
- data DescribeImageAttribute = DescribeImageAttribute' {}
- newDescribeImageAttribute :: ImageAttributeName -> Text -> DescribeImageAttribute
- describeImageAttribute_dryRun :: Lens' DescribeImageAttribute (Maybe Bool)
- describeImageAttribute_attribute :: Lens' DescribeImageAttribute ImageAttributeName
- describeImageAttribute_imageId :: Lens' DescribeImageAttribute Text
- data DescribeImageAttributeResponse = DescribeImageAttributeResponse' {
- blockDeviceMappings :: Maybe [BlockDeviceMapping]
- bootMode :: Maybe AttributeValue
- description :: Maybe AttributeValue
- imageId :: Maybe Text
- imdsSupport :: Maybe AttributeValue
- kernelId :: Maybe AttributeValue
- lastLaunchedTime :: Maybe AttributeValue
- launchPermissions :: Maybe [LaunchPermission]
- productCodes :: Maybe [ProductCode]
- ramdiskId :: Maybe AttributeValue
- sriovNetSupport :: Maybe AttributeValue
- tpmSupport :: Maybe AttributeValue
- uefiData :: Maybe AttributeValue
- httpStatus :: Int
- newDescribeImageAttributeResponse :: Int -> DescribeImageAttributeResponse
- describeImageAttributeResponse_blockDeviceMappings :: Lens' DescribeImageAttributeResponse (Maybe [BlockDeviceMapping])
- describeImageAttributeResponse_bootMode :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_description :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_imageId :: Lens' DescribeImageAttributeResponse (Maybe Text)
- describeImageAttributeResponse_imdsSupport :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_kernelId :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_lastLaunchedTime :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_launchPermissions :: Lens' DescribeImageAttributeResponse (Maybe [LaunchPermission])
- describeImageAttributeResponse_productCodes :: Lens' DescribeImageAttributeResponse (Maybe [ProductCode])
- describeImageAttributeResponse_ramdiskId :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_sriovNetSupport :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_tpmSupport :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_uefiData :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue)
- describeImageAttributeResponse_httpStatus :: Lens' DescribeImageAttributeResponse Int
Creating a Request
data DescribeImageAttribute Source #
Contains the parameters for DescribeImageAttribute.
See: newDescribeImageAttribute
smart constructor.
DescribeImageAttribute' | |
|
Instances
newDescribeImageAttribute Source #
Create a value of DescribeImageAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DescribeImageAttribute'
, describeImageAttribute_dryRun
- 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
.
$sel:attribute:DescribeImageAttribute'
, describeImageAttribute_attribute
- 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, use the DescribeImages
action.
DescribeImageAttribute
, describeImageAttribute_imageId
- The ID of the AMI.
Request Lenses
describeImageAttribute_dryRun :: Lens' DescribeImageAttribute (Maybe Bool) Source #
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
.
describeImageAttribute_attribute :: Lens' DescribeImageAttribute ImageAttributeName Source #
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, use the DescribeImages
action.
describeImageAttribute_imageId :: Lens' DescribeImageAttribute Text Source #
The ID of the AMI.
Destructuring the Response
data DescribeImageAttributeResponse Source #
Describes an image attribute.
See: newDescribeImageAttributeResponse
smart constructor.
DescribeImageAttributeResponse' | |
|
Instances
newDescribeImageAttributeResponse Source #
Create a value of DescribeImageAttributeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeImageAttributeResponse
, describeImageAttributeResponse_blockDeviceMappings
- The block device mapping entries.
DescribeImageAttributeResponse
, describeImageAttributeResponse_bootMode
- The boot mode.
DescribeImageAttributeResponse
, describeImageAttributeResponse_description
- A description for the AMI.
DescribeImageAttribute
, describeImageAttributeResponse_imageId
- The ID of the AMI.
DescribeImageAttributeResponse
, describeImageAttributeResponse_imdsSupport
- 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.
DescribeImageAttributeResponse
, describeImageAttributeResponse_kernelId
- The kernel ID.
$sel:lastLaunchedTime:DescribeImageAttributeResponse'
, describeImageAttributeResponse_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.
lastLaunchedTime
data is available starting April 2017.
$sel:launchPermissions:DescribeImageAttributeResponse'
, describeImageAttributeResponse_launchPermissions
- The launch permissions.
DescribeImageAttributeResponse
, describeImageAttributeResponse_productCodes
- The product codes.
DescribeImageAttributeResponse
, describeImageAttributeResponse_ramdiskId
- The RAM disk ID.
DescribeImageAttributeResponse
, describeImageAttributeResponse_sriovNetSupport
- Indicates whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.
DescribeImageAttributeResponse
, describeImageAttributeResponse_tpmSupport
- If the image is configured for NitroTPM support, the value is v2.0
.
$sel:uefiData:DescribeImageAttributeResponse'
, describeImageAttributeResponse_uefiData
- 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
in the Amazon EC2 User Guide.
$sel:httpStatus:DescribeImageAttributeResponse'
, describeImageAttributeResponse_httpStatus
- The response's http status code.
Response Lenses
describeImageAttributeResponse_blockDeviceMappings :: Lens' DescribeImageAttributeResponse (Maybe [BlockDeviceMapping]) Source #
The block device mapping entries.
describeImageAttributeResponse_bootMode :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
The boot mode.
describeImageAttributeResponse_description :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
A description for the AMI.
describeImageAttributeResponse_imageId :: Lens' DescribeImageAttributeResponse (Maybe Text) Source #
The ID of the AMI.
describeImageAttributeResponse_imdsSupport :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
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.
describeImageAttributeResponse_kernelId :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
The kernel ID.
describeImageAttributeResponse_lastLaunchedTime :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
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.
lastLaunchedTime
data is available starting April 2017.
describeImageAttributeResponse_launchPermissions :: Lens' DescribeImageAttributeResponse (Maybe [LaunchPermission]) Source #
The launch permissions.
describeImageAttributeResponse_productCodes :: Lens' DescribeImageAttributeResponse (Maybe [ProductCode]) Source #
The product codes.
describeImageAttributeResponse_ramdiskId :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
The RAM disk ID.
describeImageAttributeResponse_sriovNetSupport :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
describeImageAttributeResponse_tpmSupport :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
If the image is configured for NitroTPM support, the value is v2.0
.
describeImageAttributeResponse_uefiData :: Lens' DescribeImageAttributeResponse (Maybe AttributeValue) Source #
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 in the Amazon EC2 User Guide.
describeImageAttributeResponse_httpStatus :: Lens' DescribeImageAttributeResponse Int Source #
The response's http status code.