amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeInstanceAttribute

Description

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

Synopsis

Creating a Request

data DescribeInstanceAttribute Source #

See: newDescribeInstanceAttribute smart constructor.

Constructors

DescribeInstanceAttribute' 

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 :: InstanceAttributeName

    The instance attribute.

    Note: The enaSupport attribute is not supported at this time.

  • instanceId :: Text

    The ID of the instance.

Instances

Instances details
ToHeaders DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

toHeaders :: DescribeInstanceAttribute -> [Header] #

ToPath DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

toPath :: DescribeInstanceAttribute -> ByteString #

ToQuery DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

toQuery :: DescribeInstanceAttribute -> QueryString #

AWSRequest DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Associated Types

type AWSResponse DescribeInstanceAttribute #

Methods

request :: (Service -> Service) -> DescribeInstanceAttribute -> Request DescribeInstanceAttribute #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeInstanceAttribute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInstanceAttribute))) #

Generic DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Associated Types

type Rep DescribeInstanceAttribute :: Type -> Type #

Methods

from :: DescribeInstanceAttribute -> Rep DescribeInstanceAttribute x #

to :: Rep DescribeInstanceAttribute x -> DescribeInstanceAttribute #

Read DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

readsPrec :: Int -> ReadS DescribeInstanceAttribute #

readList :: ReadS [DescribeInstanceAttribute] #

readPrec :: ReadPrec DescribeInstanceAttribute #

readListPrec :: ReadPrec [DescribeInstanceAttribute] #

Show DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

showsPrec :: Int -> DescribeInstanceAttribute -> ShowS #

show :: DescribeInstanceAttribute -> String #

showList :: [DescribeInstanceAttribute] -> ShowS #

NFData DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

rnf :: DescribeInstanceAttribute -> () #

Eq DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

(==) :: DescribeInstanceAttribute -> DescribeInstanceAttribute -> Bool #

(/=) :: DescribeInstanceAttribute -> DescribeInstanceAttribute -> Bool #

Hashable DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

hashWithSalt :: Int -> DescribeInstanceAttribute -> Int #

hash :: DescribeInstanceAttribute -> Int #

type AWSResponse DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

type AWSResponse DescribeInstanceAttribute = DescribeInstanceAttributeResponse
type Rep DescribeInstanceAttribute Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

type Rep DescribeInstanceAttribute = D1 ('MetaData "DescribeInstanceAttribute" "Amazonka.EC2.DescribeInstanceAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeInstanceAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "attribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InstanceAttributeName) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeInstanceAttribute Source #

Arguments

:: InstanceAttributeName

$sel:attribute:DescribeInstanceAttribute'

-> Text

DescribeInstanceAttribute

-> DescribeInstanceAttribute 

Create a value of DescribeInstanceAttribute 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:DescribeInstanceAttribute', describeInstanceAttribute_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:DescribeInstanceAttribute', describeInstanceAttribute_attribute - The instance attribute.

Note: The enaSupport attribute is not supported at this time.

DescribeInstanceAttribute, describeInstanceAttribute_instanceId - The ID of the instance.

Request Lenses

describeInstanceAttribute_dryRun :: Lens' DescribeInstanceAttribute (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.

describeInstanceAttribute_attribute :: Lens' DescribeInstanceAttribute InstanceAttributeName Source #

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

describeInstanceAttribute_instanceId :: Lens' DescribeInstanceAttribute Text Source #

The ID of the instance.

Destructuring the Response

data DescribeInstanceAttributeResponse Source #

Describes an instance attribute.

See: newDescribeInstanceAttributeResponse smart constructor.

Constructors

DescribeInstanceAttributeResponse' 

Fields

Instances

Instances details
Generic DescribeInstanceAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Associated Types

type Rep DescribeInstanceAttributeResponse :: Type -> Type #

Methods

from :: DescribeInstanceAttributeResponse -> Rep DescribeInstanceAttributeResponse x #

to :: Rep DescribeInstanceAttributeResponse x -> DescribeInstanceAttributeResponse #

Read DescribeInstanceAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

readsPrec :: Int -> ReadS DescribeInstanceAttributeResponse #

readList :: ReadS [DescribeInstanceAttributeResponse] #

readPrec :: ReadPrec DescribeInstanceAttributeResponse #

readListPrec :: ReadPrec [DescribeInstanceAttributeResponse] #

Show DescribeInstanceAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

showsPrec :: Int -> DescribeInstanceAttributeResponse -> ShowS #

show :: DescribeInstanceAttributeResponse -> String #

showList :: [DescribeInstanceAttributeResponse] -> ShowS #

NFData DescribeInstanceAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

rnf :: DescribeInstanceAttributeResponse -> () #

Eq DescribeInstanceAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

Methods

(==) :: DescribeInstanceAttributeResponse -> DescribeInstanceAttributeResponse -> Bool #

(/=) :: DescribeInstanceAttributeResponse -> DescribeInstanceAttributeResponse -> Bool #

type Rep DescribeInstanceAttributeResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceAttribute

type Rep DescribeInstanceAttributeResponse = D1 ('MetaData "DescribeInstanceAttributeResponse" "Amazonka.EC2.DescribeInstanceAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeInstanceAttributeResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "blockDeviceMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceBlockDeviceMapping])) :*: S1 ('MetaSel ('Just "disableApiStop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue))) :*: (S1 ('MetaSel ('Just "disableApiTermination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: S1 ('MetaSel ('Just "ebsOptimized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)))) :*: ((S1 ('MetaSel ('Just "enaSupport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue)) :*: S1 ('MetaSel ('Just "enclaveOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnclaveOptions))) :*: (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupIdentifier])) :*: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceInitiatedShutdownBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)))))) :*: (((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :*: S1 ('MetaSel ('Just "kernelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue))) :*: (S1 ('MetaSel ('Just "productCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProductCode])) :*: S1 ('MetaSel ('Just "ramdiskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)))) :*: ((S1 ('MetaSel ('Just "rootDeviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :*: S1 ('MetaSel ('Just "sourceDestCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeBooleanValue))) :*: (S1 ('MetaSel ('Just "sriovNetSupport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :*: (S1 ('MetaSel ('Just "userData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeInstanceAttributeResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeInstanceAttributeResponse'

-> DescribeInstanceAttributeResponse 

Create a value of DescribeInstanceAttributeResponse 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:

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_blockDeviceMappings - The block device mapping of the instance.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_disableApiStop - To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_disableApiTermination - If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_ebsOptimized - Indicates whether the instance is optimized for Amazon EBS I/O.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_enaSupport - Indicates whether enhanced networking with ENA is enabled.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_enclaveOptions - To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_groups - The security groups associated with the instance.

DescribeInstanceAttribute, describeInstanceAttributeResponse_instanceId - The ID of the instance.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_instanceInitiatedShutdownBehavior - Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_instanceType - The instance type.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_kernelId - The kernel ID.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_productCodes - A list of product codes.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_ramdiskId - The RAM disk ID.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_rootDeviceName - The device name of the root device volume (for example, /dev/sda1).

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_sourceDestCheck - Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_sriovNetSupport - Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

DescribeInstanceAttributeResponse, describeInstanceAttributeResponse_userData - The user data.

$sel:httpStatus:DescribeInstanceAttributeResponse', describeInstanceAttributeResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceAttributeResponse_blockDeviceMappings :: Lens' DescribeInstanceAttributeResponse (Maybe [InstanceBlockDeviceMapping]) Source #

The block device mapping of the instance.

describeInstanceAttributeResponse_disableApiStop :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeBooleanValue) Source #

To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

describeInstanceAttributeResponse_disableApiTermination :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeBooleanValue) Source #

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

describeInstanceAttributeResponse_ebsOptimized :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeBooleanValue) Source #

Indicates whether the instance is optimized for Amazon EBS I/O.

describeInstanceAttributeResponse_enaSupport :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeBooleanValue) Source #

Indicates whether enhanced networking with ENA is enabled.

describeInstanceAttributeResponse_enclaveOptions :: Lens' DescribeInstanceAttributeResponse (Maybe EnclaveOptions) Source #

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

describeInstanceAttributeResponse_groups :: Lens' DescribeInstanceAttributeResponse (Maybe [GroupIdentifier]) Source #

The security groups associated with the instance.

describeInstanceAttributeResponse_instanceId :: Lens' DescribeInstanceAttributeResponse (Maybe Text) Source #

The ID of the instance.

describeInstanceAttributeResponse_instanceInitiatedShutdownBehavior :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

describeInstanceAttributeResponse_instanceType :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

The instance type.

describeInstanceAttributeResponse_kernelId :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

The kernel ID.

describeInstanceAttributeResponse_productCodes :: Lens' DescribeInstanceAttributeResponse (Maybe [ProductCode]) Source #

A list of product codes.

describeInstanceAttributeResponse_ramdiskId :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

The RAM disk ID.

describeInstanceAttributeResponse_rootDeviceName :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

The device name of the root device volume (for example, /dev/sda1).

describeInstanceAttributeResponse_sourceDestCheck :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeBooleanValue) Source #

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

describeInstanceAttributeResponse_sriovNetSupport :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

describeInstanceAttributeResponse_userData :: Lens' DescribeInstanceAttributeResponse (Maybe AttributeValue) Source #

The user data.

describeInstanceAttributeResponse_httpStatus :: Lens' DescribeInstanceAttributeResponse Int Source #

The response's http status code.