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

Amazonka.EC2.DescribeImageAttribute

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

Synopsis

Creating a Request

data DescribeImageAttribute Source #

Contains the parameters for DescribeImageAttribute.

See: newDescribeImageAttribute smart constructor.

Constructors

DescribeImageAttribute'

Fields

dryRun :: Maybe Bool
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.
attribute :: ImageAttributeName
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.
imageId :: Text
The ID of the AMI.

Instances

Instances details

ToHeaders DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods toHeaders :: DescribeImageAttribute -> [Header] #
ToPath DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods toPath :: DescribeImageAttribute -> ByteString #
ToQuery DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods toQuery :: DescribeImageAttribute -> QueryString #
AWSRequest DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Associated Types type AWSResponse DescribeImageAttribute # Methods request :: (Service -> Service) -> DescribeImageAttribute -> Request DescribeImageAttribute # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeImageAttribute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeImageAttribute))) #
Generic DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Associated Types type Rep DescribeImageAttribute :: Type -> Type # Methods from :: DescribeImageAttribute -> Rep DescribeImageAttribute x # to :: Rep DescribeImageAttribute x -> DescribeImageAttribute #
Read DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods readsPrec :: Int -> ReadS DescribeImageAttribute # readList :: ReadS [DescribeImageAttribute] # readPrec :: ReadPrec DescribeImageAttribute # readListPrec :: ReadPrec [DescribeImageAttribute] #
Show DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods showsPrec :: Int -> DescribeImageAttribute -> ShowS # show :: DescribeImageAttribute -> String # showList :: [DescribeImageAttribute] -> ShowS #
NFData DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods rnf :: DescribeImageAttribute -> () #
Eq DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods (==) :: DescribeImageAttribute -> DescribeImageAttribute -> Bool # (/=) :: DescribeImageAttribute -> DescribeImageAttribute -> Bool #
Hashable DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods hashWithSalt :: Int -> DescribeImageAttribute -> Int # hash :: DescribeImageAttribute -> Int #
type AWSResponse DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute type AWSResponse DescribeImageAttribute = DescribeImageAttributeResponse
type Rep DescribeImageAttribute Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute type Rep DescribeImageAttribute = D1 ('MetaData "DescribeImageAttribute" "Amazonka.EC2.DescribeImageAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeImageAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "attribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageAttributeName) :: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeImageAttribute Source #

Arguments

:: ImageAttributeName	`$sel:attribute:DescribeImageAttribute'`
-> Text	`DescribeImageAttribute`
-> DescribeImageAttribute

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.

Constructors

DescribeImageAttributeResponse'

Fields

blockDeviceMappings :: Maybe [BlockDeviceMapping]
The block device mapping entries.
bootMode :: Maybe AttributeValue
The boot mode.
description :: Maybe AttributeValue
A description for the AMI.
imageId :: Maybe Text
The ID of the AMI.
imdsSupport :: Maybe AttributeValue
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.
kernelId :: Maybe AttributeValue
The kernel ID.
lastLaunchedTime :: Maybe AttributeValue
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.
launchPermissions :: Maybe [LaunchPermission]
The launch permissions.
productCodes :: Maybe [ProductCode]
The product codes.
ramdiskId :: Maybe AttributeValue
The RAM disk ID.
sriovNetSupport :: Maybe AttributeValue
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
tpmSupport :: Maybe AttributeValue
If the image is configured for NitroTPM support, the value is v2.0.
uefiData :: Maybe AttributeValue
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Associated Types type Rep DescribeImageAttributeResponse :: Type -> Type # Methods from :: DescribeImageAttributeResponse -> Rep DescribeImageAttributeResponse x # to :: Rep DescribeImageAttributeResponse x -> DescribeImageAttributeResponse #
Read DescribeImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods readsPrec :: Int -> ReadS DescribeImageAttributeResponse # readList :: ReadS [DescribeImageAttributeResponse] # readPrec :: ReadPrec DescribeImageAttributeResponse # readListPrec :: ReadPrec [DescribeImageAttributeResponse] #
Show DescribeImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods showsPrec :: Int -> DescribeImageAttributeResponse -> ShowS # show :: DescribeImageAttributeResponse -> String # showList :: [DescribeImageAttributeResponse] -> ShowS #
NFData DescribeImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods rnf :: DescribeImageAttributeResponse -> () #
Eq DescribeImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute Methods (==) :: DescribeImageAttributeResponse -> DescribeImageAttributeResponse -> Bool # (/=) :: DescribeImageAttributeResponse -> DescribeImageAttributeResponse -> Bool #
type Rep DescribeImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.DescribeImageAttribute type Rep DescribeImageAttributeResponse = D1 ('MetaData "DescribeImageAttributeResponse" "Amazonka.EC2.DescribeImageAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeImageAttributeResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blockDeviceMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BlockDeviceMapping])) :: (S1 ('MetaSel ('Just "bootMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)))) :: ((S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imdsSupport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue))) :: (S1 ('MetaSel ('Just "kernelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :: S1 ('MetaSel ('Just "lastLaunchedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue))))) :: ((S1 ('MetaSel ('Just "launchPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LaunchPermission])) :: (S1 ('MetaSel ('Just "productCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProductCode])) :: S1 ('MetaSel ('Just "ramdiskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)))) :: ((S1 ('MetaSel ('Just "sriovNetSupport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :: S1 ('MetaSel ('Just "tpmSupport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue))) :: (S1 ('MetaSel ('Just "uefiData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeImageAttributeResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeImageAttributeResponse'`
-> DescribeImageAttributeResponse

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.