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

Description

Get a list of all the CIDR allocations in an IPAM pool.

This operation returns paginated results.

Synopsis

Creating a Request

data GetIpamPoolAllocations Source #

See: newGetIpamPoolAllocations smart constructor.

Constructors

GetIpamPoolAllocations' 

Fields

  • dryRun :: Maybe Bool

    A check for 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.

  • filters :: Maybe [Filter]

    One or more filters for the request. For more information about filtering, see Filtering CLI output.

  • ipamPoolAllocationId :: Maybe Text

    The ID of the allocation.

  • maxResults :: Maybe Natural

    The maximum number of results you would like returned per page.

  • nextToken :: Maybe Text

    The token for the next page of results.

  • ipamPoolId :: Text

    The ID of the IPAM pool you want to see the allocations for.

Instances

Instances details
ToHeaders GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

toHeaders :: GetIpamPoolAllocations -> [Header] #

ToPath GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

toPath :: GetIpamPoolAllocations -> ByteString #

ToQuery GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

toQuery :: GetIpamPoolAllocations -> QueryString #

AWSPager GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

page :: GetIpamPoolAllocations -> AWSResponse GetIpamPoolAllocations -> Maybe GetIpamPoolAllocations #

AWSRequest GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Associated Types

type AWSResponse GetIpamPoolAllocations #

Methods

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

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

Generic GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Associated Types

type Rep GetIpamPoolAllocations :: Type -> Type #

Methods

from :: GetIpamPoolAllocations -> Rep GetIpamPoolAllocations x #

to :: Rep GetIpamPoolAllocations x -> GetIpamPoolAllocations #

Read GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

readsPrec :: Int -> ReadS GetIpamPoolAllocations #

readList :: ReadS [GetIpamPoolAllocations] #

readPrec :: ReadPrec GetIpamPoolAllocations #

readListPrec :: ReadPrec [GetIpamPoolAllocations] #

Show GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

showsPrec :: Int -> GetIpamPoolAllocations -> ShowS #

show :: GetIpamPoolAllocations -> String #

showList :: [GetIpamPoolAllocations] -> ShowS #

NFData GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

rnf :: GetIpamPoolAllocations -> () #

Eq GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

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

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

Hashable GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

hashWithSalt :: Int -> GetIpamPoolAllocations -> Int #

hash :: GetIpamPoolAllocations -> Int #

type AWSResponse GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

type AWSResponse GetIpamPoolAllocations = GetIpamPoolAllocationsResponse
type Rep GetIpamPoolAllocations Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

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

newGetIpamPoolAllocations Source #

Arguments

:: Text

GetIpamPoolAllocations

-> GetIpamPoolAllocations 

Create a value of GetIpamPoolAllocations 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:GetIpamPoolAllocations', getIpamPoolAllocations_dryRun - A check for 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:filters:GetIpamPoolAllocations', getIpamPoolAllocations_filters - One or more filters for the request. For more information about filtering, see Filtering CLI output.

GetIpamPoolAllocations, getIpamPoolAllocations_ipamPoolAllocationId - The ID of the allocation.

$sel:maxResults:GetIpamPoolAllocations', getIpamPoolAllocations_maxResults - The maximum number of results you would like returned per page.

GetIpamPoolAllocations, getIpamPoolAllocations_nextToken - The token for the next page of results.

GetIpamPoolAllocations, getIpamPoolAllocations_ipamPoolId - The ID of the IPAM pool you want to see the allocations for.

Request Lenses

getIpamPoolAllocations_dryRun :: Lens' GetIpamPoolAllocations (Maybe Bool) Source #

A check for 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.

getIpamPoolAllocations_filters :: Lens' GetIpamPoolAllocations (Maybe [Filter]) Source #

One or more filters for the request. For more information about filtering, see Filtering CLI output.

getIpamPoolAllocations_ipamPoolAllocationId :: Lens' GetIpamPoolAllocations (Maybe Text) Source #

The ID of the allocation.

getIpamPoolAllocations_maxResults :: Lens' GetIpamPoolAllocations (Maybe Natural) Source #

The maximum number of results you would like returned per page.

getIpamPoolAllocations_nextToken :: Lens' GetIpamPoolAllocations (Maybe Text) Source #

The token for the next page of results.

getIpamPoolAllocations_ipamPoolId :: Lens' GetIpamPoolAllocations Text Source #

The ID of the IPAM pool you want to see the allocations for.

Destructuring the Response

data GetIpamPoolAllocationsResponse Source #

See: newGetIpamPoolAllocationsResponse smart constructor.

Constructors

GetIpamPoolAllocationsResponse' 

Fields

Instances

Instances details
Generic GetIpamPoolAllocationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Associated Types

type Rep GetIpamPoolAllocationsResponse :: Type -> Type #

Methods

from :: GetIpamPoolAllocationsResponse -> Rep GetIpamPoolAllocationsResponse x #

to :: Rep GetIpamPoolAllocationsResponse x -> GetIpamPoolAllocationsResponse #

Read GetIpamPoolAllocationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

readsPrec :: Int -> ReadS GetIpamPoolAllocationsResponse #

readList :: ReadS [GetIpamPoolAllocationsResponse] #

readPrec :: ReadPrec GetIpamPoolAllocationsResponse #

readListPrec :: ReadPrec [GetIpamPoolAllocationsResponse] #

Show GetIpamPoolAllocationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

showsPrec :: Int -> GetIpamPoolAllocationsResponse -> ShowS #

show :: GetIpamPoolAllocationsResponse -> String #

showList :: [GetIpamPoolAllocationsResponse] -> ShowS #

NFData GetIpamPoolAllocationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

rnf :: GetIpamPoolAllocationsResponse -> () #

Eq GetIpamPoolAllocationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

Methods

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

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

type Rep GetIpamPoolAllocationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetIpamPoolAllocations

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

newGetIpamPoolAllocationsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetIpamPoolAllocationsResponse'

-> GetIpamPoolAllocationsResponse 

Create a value of GetIpamPoolAllocationsResponse 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:ipamPoolAllocations:GetIpamPoolAllocationsResponse', getIpamPoolAllocationsResponse_ipamPoolAllocations - The IPAM pool allocations you want information on.

GetIpamPoolAllocations, getIpamPoolAllocationsResponse_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:httpStatus:GetIpamPoolAllocationsResponse', getIpamPoolAllocationsResponse_httpStatus - The response's http status code.

Response Lenses

getIpamPoolAllocationsResponse_ipamPoolAllocations :: Lens' GetIpamPoolAllocationsResponse (Maybe [IpamPoolAllocation]) Source #

The IPAM pool allocations you want information on.

getIpamPoolAllocationsResponse_nextToken :: Lens' GetIpamPoolAllocationsResponse (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.

getIpamPoolAllocationsResponse_httpStatus :: Lens' GetIpamPoolAllocationsResponse Int Source #

The response's http status code.