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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get the CIDRs provisioned to an IPAM pool.

This operation returns paginated results.

Synopsis

data GetIpamPoolCidrs = GetIpamPoolCidrs' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- ipamPoolId :: Text
}
newGetIpamPoolCidrs :: Text -> GetIpamPoolCidrs
getIpamPoolCidrs_dryRun :: Lens' GetIpamPoolCidrs (Maybe Bool)
getIpamPoolCidrs_filters :: Lens' GetIpamPoolCidrs (Maybe [Filter])
getIpamPoolCidrs_maxResults :: Lens' GetIpamPoolCidrs (Maybe Natural)
getIpamPoolCidrs_nextToken :: Lens' GetIpamPoolCidrs (Maybe Text)
getIpamPoolCidrs_ipamPoolId :: Lens' GetIpamPoolCidrs Text
data GetIpamPoolCidrsResponse = GetIpamPoolCidrsResponse' {
- ipamPoolCidrs :: Maybe [IpamPoolCidr]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetIpamPoolCidrsResponse :: Int -> GetIpamPoolCidrsResponse
getIpamPoolCidrsResponse_ipamPoolCidrs :: Lens' GetIpamPoolCidrsResponse (Maybe [IpamPoolCidr])
getIpamPoolCidrsResponse_nextToken :: Lens' GetIpamPoolCidrsResponse (Maybe Text)
getIpamPoolCidrsResponse_httpStatus :: Lens' GetIpamPoolCidrsResponse Int

Creating a Request

data GetIpamPoolCidrs Source #

See: newGetIpamPoolCidrs smart constructor.

Constructors

GetIpamPoolCidrs'

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.
maxResults :: Maybe Natural
The maximum number of results to return in the request.
nextToken :: Maybe Text
The token for the next page of results.
ipamPoolId :: Text
The ID of the IPAM pool you want the CIDR for.

Instances

Instances details

ToHeaders GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods toHeaders :: GetIpamPoolCidrs -> [Header] #
ToPath GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods toPath :: GetIpamPoolCidrs -> ByteString #
ToQuery GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods toQuery :: GetIpamPoolCidrs -> QueryString #
AWSPager GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods page :: GetIpamPoolCidrs -> AWSResponse GetIpamPoolCidrs -> Maybe GetIpamPoolCidrs #
AWSRequest GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Associated Types type AWSResponse GetIpamPoolCidrs # Methods request :: (Service -> Service) -> GetIpamPoolCidrs -> Request GetIpamPoolCidrs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIpamPoolCidrs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIpamPoolCidrs))) #
Generic GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Associated Types type Rep GetIpamPoolCidrs :: Type -> Type # Methods from :: GetIpamPoolCidrs -> Rep GetIpamPoolCidrs x # to :: Rep GetIpamPoolCidrs x -> GetIpamPoolCidrs #
Read GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods readsPrec :: Int -> ReadS GetIpamPoolCidrs # readList :: ReadS [GetIpamPoolCidrs] # readPrec :: ReadPrec GetIpamPoolCidrs # readListPrec :: ReadPrec [GetIpamPoolCidrs] #
Show GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods showsPrec :: Int -> GetIpamPoolCidrs -> ShowS # show :: GetIpamPoolCidrs -> String # showList :: [GetIpamPoolCidrs] -> ShowS #
NFData GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods rnf :: GetIpamPoolCidrs -> () #
Eq GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods (==) :: GetIpamPoolCidrs -> GetIpamPoolCidrs -> Bool # (/=) :: GetIpamPoolCidrs -> GetIpamPoolCidrs -> Bool #
Hashable GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods hashWithSalt :: Int -> GetIpamPoolCidrs -> Int # hash :: GetIpamPoolCidrs -> Int #
type AWSResponse GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs type AWSResponse GetIpamPoolCidrs = GetIpamPoolCidrsResponse
type Rep GetIpamPoolCidrs Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs type Rep GetIpamPoolCidrs = D1 ('MetaData "GetIpamPoolCidrs" "Amazonka.EC2.GetIpamPoolCidrs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetIpamPoolCidrs'" '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 "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)))))

newGetIpamPoolCidrs Source #

Arguments

:: Text	`GetIpamPoolCidrs`
-> GetIpamPoolCidrs

Create a value of GetIpamPoolCidrs 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:GetIpamPoolCidrs', getIpamPoolCidrs_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:GetIpamPoolCidrs', getIpamPoolCidrs_filters - One or more filters for the request. For more information about filtering, see Filtering CLI output.

$sel:maxResults:GetIpamPoolCidrs', getIpamPoolCidrs_maxResults - The maximum number of results to return in the request.

GetIpamPoolCidrs, getIpamPoolCidrs_nextToken - The token for the next page of results.

GetIpamPoolCidrs, getIpamPoolCidrs_ipamPoolId - The ID of the IPAM pool you want the CIDR for.

Request Lenses

getIpamPoolCidrs_dryRun :: Lens' GetIpamPoolCidrs (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.

getIpamPoolCidrs_filters :: Lens' GetIpamPoolCidrs (Maybe [Filter]) Source #

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

getIpamPoolCidrs_maxResults :: Lens' GetIpamPoolCidrs (Maybe Natural) Source #

The maximum number of results to return in the request.

getIpamPoolCidrs_nextToken :: Lens' GetIpamPoolCidrs (Maybe Text) Source #

The token for the next page of results.

getIpamPoolCidrs_ipamPoolId :: Lens' GetIpamPoolCidrs Text Source #

The ID of the IPAM pool you want the CIDR for.

Destructuring the Response

data GetIpamPoolCidrsResponse Source #

See: newGetIpamPoolCidrsResponse smart constructor.

Constructors

GetIpamPoolCidrsResponse'
Fields ipamPoolCidrs :: Maybe [IpamPoolCidr] Information about the CIDRs provisioned to an IPAM pool. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetIpamPoolCidrsResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Associated Types type Rep GetIpamPoolCidrsResponse :: Type -> Type # Methods from :: GetIpamPoolCidrsResponse -> Rep GetIpamPoolCidrsResponse x # to :: Rep GetIpamPoolCidrsResponse x -> GetIpamPoolCidrsResponse #
Read GetIpamPoolCidrsResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods readsPrec :: Int -> ReadS GetIpamPoolCidrsResponse # readList :: ReadS [GetIpamPoolCidrsResponse] # readPrec :: ReadPrec GetIpamPoolCidrsResponse # readListPrec :: ReadPrec [GetIpamPoolCidrsResponse] #
Show GetIpamPoolCidrsResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods showsPrec :: Int -> GetIpamPoolCidrsResponse -> ShowS # show :: GetIpamPoolCidrsResponse -> String # showList :: [GetIpamPoolCidrsResponse] -> ShowS #
NFData GetIpamPoolCidrsResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods rnf :: GetIpamPoolCidrsResponse -> () #
Eq GetIpamPoolCidrsResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs Methods (==) :: GetIpamPoolCidrsResponse -> GetIpamPoolCidrsResponse -> Bool # (/=) :: GetIpamPoolCidrsResponse -> GetIpamPoolCidrsResponse -> Bool #
type Rep GetIpamPoolCidrsResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamPoolCidrs type Rep GetIpamPoolCidrsResponse = D1 ('MetaData "GetIpamPoolCidrsResponse" "Amazonka.EC2.GetIpamPoolCidrs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetIpamPoolCidrsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipamPoolCidrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamPoolCidr])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetIpamPoolCidrsResponse Source #

Arguments

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

Create a value of GetIpamPoolCidrsResponse 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:ipamPoolCidrs:GetIpamPoolCidrsResponse', getIpamPoolCidrsResponse_ipamPoolCidrs - Information about the CIDRs provisioned to an IPAM pool.

GetIpamPoolCidrs, getIpamPoolCidrsResponse_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:GetIpamPoolCidrsResponse', getIpamPoolCidrsResponse_httpStatus - The response's http status code.

Response Lenses

getIpamPoolCidrsResponse_ipamPoolCidrs :: Lens' GetIpamPoolCidrsResponse (Maybe [IpamPoolCidr]) Source #

Information about the CIDRs provisioned to an IPAM pool.

getIpamPoolCidrsResponse_nextToken :: Lens' GetIpamPoolCidrsResponse (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.

getIpamPoolCidrsResponse_httpStatus :: Lens' GetIpamPoolCidrsResponse Int Source #

The response's http status code.