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.DescribePublicIpv4Pools

Description

Describes the specified IPv4 address pools.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePublicIpv4Pools Source #

See: newDescribePublicIpv4Pools smart constructor.

Constructors

DescribePublicIpv4Pools' 

Fields

  • filters :: Maybe [Filter]

    One or more filters.

    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

  • poolIds :: Maybe [Text]

    The IDs of the address pools.

Instances

Instances details
ToHeaders DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

toHeaders :: DescribePublicIpv4Pools -> [Header] #

ToPath DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

toPath :: DescribePublicIpv4Pools -> ByteString #

ToQuery DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

toQuery :: DescribePublicIpv4Pools -> QueryString #

AWSPager DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

page :: DescribePublicIpv4Pools -> AWSResponse DescribePublicIpv4Pools -> Maybe DescribePublicIpv4Pools #

AWSRequest DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Associated Types

type AWSResponse DescribePublicIpv4Pools #

Methods

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

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

Generic DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Associated Types

type Rep DescribePublicIpv4Pools :: Type -> Type #

Methods

from :: DescribePublicIpv4Pools -> Rep DescribePublicIpv4Pools x #

to :: Rep DescribePublicIpv4Pools x -> DescribePublicIpv4Pools #

Read DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

readsPrec :: Int -> ReadS DescribePublicIpv4Pools #

readList :: ReadS [DescribePublicIpv4Pools] #

readPrec :: ReadPrec DescribePublicIpv4Pools #

readListPrec :: ReadPrec [DescribePublicIpv4Pools] #

Show DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

showsPrec :: Int -> DescribePublicIpv4Pools -> ShowS #

show :: DescribePublicIpv4Pools -> String #

showList :: [DescribePublicIpv4Pools] -> ShowS #

NFData DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

rnf :: DescribePublicIpv4Pools -> () #

Eq DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

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

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

Hashable DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

hashWithSalt :: Int -> DescribePublicIpv4Pools -> Int #

hash :: DescribePublicIpv4Pools -> Int #

type AWSResponse DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

type AWSResponse DescribePublicIpv4Pools = DescribePublicIpv4PoolsResponse
type Rep DescribePublicIpv4Pools Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

type Rep DescribePublicIpv4Pools = D1 ('MetaData "DescribePublicIpv4Pools" "Amazonka.EC2.DescribePublicIpv4Pools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribePublicIpv4Pools'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "poolIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribePublicIpv4Pools :: DescribePublicIpv4Pools Source #

Create a value of DescribePublicIpv4Pools 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:filters:DescribePublicIpv4Pools', describePublicIpv4Pools_filters - One or more filters.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

$sel:maxResults:DescribePublicIpv4Pools', describePublicIpv4Pools_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribePublicIpv4Pools, describePublicIpv4Pools_nextToken - The token for the next page of results.

$sel:poolIds:DescribePublicIpv4Pools', describePublicIpv4Pools_poolIds - The IDs of the address pools.

Request Lenses

describePublicIpv4Pools_filters :: Lens' DescribePublicIpv4Pools (Maybe [Filter]) Source #

One or more filters.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

describePublicIpv4Pools_maxResults :: Lens' DescribePublicIpv4Pools (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describePublicIpv4Pools_nextToken :: Lens' DescribePublicIpv4Pools (Maybe Text) Source #

The token for the next page of results.

describePublicIpv4Pools_poolIds :: Lens' DescribePublicIpv4Pools (Maybe [Text]) Source #

The IDs of the address pools.

Destructuring the Response

data DescribePublicIpv4PoolsResponse Source #

See: newDescribePublicIpv4PoolsResponse smart constructor.

Constructors

DescribePublicIpv4PoolsResponse' 

Fields

Instances

Instances details
Generic DescribePublicIpv4PoolsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Associated Types

type Rep DescribePublicIpv4PoolsResponse :: Type -> Type #

Methods

from :: DescribePublicIpv4PoolsResponse -> Rep DescribePublicIpv4PoolsResponse x #

to :: Rep DescribePublicIpv4PoolsResponse x -> DescribePublicIpv4PoolsResponse #

Read DescribePublicIpv4PoolsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

readsPrec :: Int -> ReadS DescribePublicIpv4PoolsResponse #

readList :: ReadS [DescribePublicIpv4PoolsResponse] #

readPrec :: ReadPrec DescribePublicIpv4PoolsResponse #

readListPrec :: ReadPrec [DescribePublicIpv4PoolsResponse] #

Show DescribePublicIpv4PoolsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

showsPrec :: Int -> DescribePublicIpv4PoolsResponse -> ShowS #

show :: DescribePublicIpv4PoolsResponse -> String #

showList :: [DescribePublicIpv4PoolsResponse] -> ShowS #

NFData DescribePublicIpv4PoolsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

rnf :: DescribePublicIpv4PoolsResponse -> () #

Eq DescribePublicIpv4PoolsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

Methods

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

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

type Rep DescribePublicIpv4PoolsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribePublicIpv4Pools

type Rep DescribePublicIpv4PoolsResponse = D1 ('MetaData "DescribePublicIpv4PoolsResponse" "Amazonka.EC2.DescribePublicIpv4Pools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribePublicIpv4PoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publicIpv4Pools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PublicIpv4Pool])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePublicIpv4PoolsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribePublicIpv4PoolsResponse'

-> DescribePublicIpv4PoolsResponse 

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

DescribePublicIpv4Pools, describePublicIpv4PoolsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:publicIpv4Pools:DescribePublicIpv4PoolsResponse', describePublicIpv4PoolsResponse_publicIpv4Pools - Information about the address pools.

$sel:httpStatus:DescribePublicIpv4PoolsResponse', describePublicIpv4PoolsResponse_httpStatus - The response's http status code.

Response Lenses

describePublicIpv4PoolsResponse_nextToken :: Lens' DescribePublicIpv4PoolsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describePublicIpv4PoolsResponse_publicIpv4Pools :: Lens' DescribePublicIpv4PoolsResponse (Maybe [PublicIpv4Pool]) Source #

Information about the address pools.

describePublicIpv4PoolsResponse_httpStatus :: Lens' DescribePublicIpv4PoolsResponse Int Source #

The response's http status code.