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.OpsWorks.DescribeElasticIps

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes Elastic IP addresses.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Creating a Request

data DescribeElasticIps Source #

See: newDescribeElasticIps smart constructor.

Constructors

DescribeElasticIps'

Fields

instanceId :: Maybe Text
The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.
ips :: Maybe [Text]
An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.
stackId :: Maybe Text
A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

Instances

Instances details

ToJSON DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods toJSON :: DescribeElasticIps -> Value # toEncoding :: DescribeElasticIps -> Encoding # toJSONList :: [DescribeElasticIps] -> Value # toEncodingList :: [DescribeElasticIps] -> Encoding #
ToHeaders DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods toHeaders :: DescribeElasticIps -> [Header] #
ToPath DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods toPath :: DescribeElasticIps -> ByteString #
ToQuery DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods toQuery :: DescribeElasticIps -> QueryString #
AWSRequest DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Associated Types type AWSResponse DescribeElasticIps # Methods request :: (Service -> Service) -> DescribeElasticIps -> Request DescribeElasticIps # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeElasticIps -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeElasticIps))) #
Generic DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Associated Types type Rep DescribeElasticIps :: Type -> Type # Methods from :: DescribeElasticIps -> Rep DescribeElasticIps x # to :: Rep DescribeElasticIps x -> DescribeElasticIps #
Read DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods readsPrec :: Int -> ReadS DescribeElasticIps # readList :: ReadS [DescribeElasticIps] # readPrec :: ReadPrec DescribeElasticIps # readListPrec :: ReadPrec [DescribeElasticIps] #
Show DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods showsPrec :: Int -> DescribeElasticIps -> ShowS # show :: DescribeElasticIps -> String # showList :: [DescribeElasticIps] -> ShowS #
NFData DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods rnf :: DescribeElasticIps -> () #
Eq DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods (==) :: DescribeElasticIps -> DescribeElasticIps -> Bool # (/=) :: DescribeElasticIps -> DescribeElasticIps -> Bool #
Hashable DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods hashWithSalt :: Int -> DescribeElasticIps -> Int # hash :: DescribeElasticIps -> Int #
type AWSResponse DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps type AWSResponse DescribeElasticIps = DescribeElasticIpsResponse
type Rep DescribeElasticIps Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps type Rep DescribeElasticIps = D1 ('MetaData "DescribeElasticIps" "Amazonka.OpsWorks.DescribeElasticIps" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeElasticIps'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ips") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeElasticIps :: DescribeElasticIps Source #

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

DescribeElasticIps, describeElasticIps_instanceId - The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

$sel:ips:DescribeElasticIps', describeElasticIps_ips - An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

DescribeElasticIps, describeElasticIps_stackId - A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

Request Lenses

describeElasticIps_instanceId :: Lens' DescribeElasticIps (Maybe Text) Source #

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

describeElasticIps_ips :: Lens' DescribeElasticIps (Maybe [Text]) Source #

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

describeElasticIps_stackId :: Lens' DescribeElasticIps (Maybe Text) Source #

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

Destructuring the Response

data DescribeElasticIpsResponse Source #

Contains the response to a DescribeElasticIps request.

See: newDescribeElasticIpsResponse smart constructor.

Constructors

DescribeElasticIpsResponse'
Fields elasticIps :: Maybe [ElasticIp] An `ElasticIps` object that describes the specified Elastic IP addresses. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeElasticIpsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Associated Types type Rep DescribeElasticIpsResponse :: Type -> Type # Methods from :: DescribeElasticIpsResponse -> Rep DescribeElasticIpsResponse x # to :: Rep DescribeElasticIpsResponse x -> DescribeElasticIpsResponse #
Read DescribeElasticIpsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods readsPrec :: Int -> ReadS DescribeElasticIpsResponse # readList :: ReadS [DescribeElasticIpsResponse] # readPrec :: ReadPrec DescribeElasticIpsResponse # readListPrec :: ReadPrec [DescribeElasticIpsResponse] #
Show DescribeElasticIpsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods showsPrec :: Int -> DescribeElasticIpsResponse -> ShowS # show :: DescribeElasticIpsResponse -> String # showList :: [DescribeElasticIpsResponse] -> ShowS #
NFData DescribeElasticIpsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods rnf :: DescribeElasticIpsResponse -> () #
Eq DescribeElasticIpsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps Methods (==) :: DescribeElasticIpsResponse -> DescribeElasticIpsResponse -> Bool # (/=) :: DescribeElasticIpsResponse -> DescribeElasticIpsResponse -> Bool #
type Rep DescribeElasticIpsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeElasticIps type Rep DescribeElasticIpsResponse = D1 ('MetaData "DescribeElasticIpsResponse" "Amazonka.OpsWorks.DescribeElasticIps" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeElasticIpsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "elasticIps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ElasticIp])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeElasticIpsResponse Source #

Arguments

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

Create a value of DescribeElasticIpsResponse 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:elasticIps:DescribeElasticIpsResponse', describeElasticIpsResponse_elasticIps - An ElasticIps object that describes the specified Elastic IP addresses.

$sel:httpStatus:DescribeElasticIpsResponse', describeElasticIpsResponse_httpStatus - The response's http status code.

Response Lenses

describeElasticIpsResponse_elasticIps :: Lens' DescribeElasticIpsResponse (Maybe [ElasticIp]) Source #

An ElasticIps object that describes the specified Elastic IP addresses.

describeElasticIpsResponse_httpStatus :: Lens' DescribeElasticIpsResponse Int Source #

The response's http status code.