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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about your IPAM pools.

This operation returns paginated results.

Synopsis

data DescribeIpamPools = DescribeIpamPools' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- ipamPoolIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeIpamPools :: DescribeIpamPools
describeIpamPools_dryRun :: Lens' DescribeIpamPools (Maybe Bool)
describeIpamPools_filters :: Lens' DescribeIpamPools (Maybe [Filter])
describeIpamPools_ipamPoolIds :: Lens' DescribeIpamPools (Maybe [Text])
describeIpamPools_maxResults :: Lens' DescribeIpamPools (Maybe Natural)
describeIpamPools_nextToken :: Lens' DescribeIpamPools (Maybe Text)
data DescribeIpamPoolsResponse = DescribeIpamPoolsResponse' {
- ipamPools :: Maybe [IpamPool]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeIpamPoolsResponse :: Int -> DescribeIpamPoolsResponse
describeIpamPoolsResponse_ipamPools :: Lens' DescribeIpamPoolsResponse (Maybe [IpamPool])
describeIpamPoolsResponse_nextToken :: Lens' DescribeIpamPoolsResponse (Maybe Text)
describeIpamPoolsResponse_httpStatus :: Lens' DescribeIpamPoolsResponse Int

Creating a Request

data DescribeIpamPools Source #

See: newDescribeIpamPools smart constructor.

Constructors

DescribeIpamPools'

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.
ipamPoolIds :: Maybe [Text]
The IDs of the IPAM pools you would like information on.
maxResults :: Maybe Natural
The maximum number of results to return in the request.
nextToken :: Maybe Text
The token for the next page of results.

Instances

Instances details

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

newDescribeIpamPools :: DescribeIpamPools Source #

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

$sel:ipamPoolIds:DescribeIpamPools', describeIpamPools_ipamPoolIds - The IDs of the IPAM pools you would like information on.

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

DescribeIpamPools, describeIpamPools_nextToken - The token for the next page of results.

Request Lenses

describeIpamPools_dryRun :: Lens' DescribeIpamPools (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.

describeIpamPools_filters :: Lens' DescribeIpamPools (Maybe [Filter]) Source #

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

describeIpamPools_ipamPoolIds :: Lens' DescribeIpamPools (Maybe [Text]) Source #

The IDs of the IPAM pools you would like information on.

describeIpamPools_maxResults :: Lens' DescribeIpamPools (Maybe Natural) Source #

The maximum number of results to return in the request.

describeIpamPools_nextToken :: Lens' DescribeIpamPools (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeIpamPoolsResponse Source #

See: newDescribeIpamPoolsResponse smart constructor.

Constructors

DescribeIpamPoolsResponse'
Fields ipamPools :: Maybe [IpamPool] Information about the IPAM pools. 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 DescribeIpamPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamPools Associated Types type Rep DescribeIpamPoolsResponse :: Type -> Type # Methods from :: DescribeIpamPoolsResponse -> Rep DescribeIpamPoolsResponse x # to :: Rep DescribeIpamPoolsResponse x -> DescribeIpamPoolsResponse #
Read DescribeIpamPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamPools Methods readsPrec :: Int -> ReadS DescribeIpamPoolsResponse # readList :: ReadS [DescribeIpamPoolsResponse] # readPrec :: ReadPrec DescribeIpamPoolsResponse # readListPrec :: ReadPrec [DescribeIpamPoolsResponse] #
Show DescribeIpamPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamPools Methods showsPrec :: Int -> DescribeIpamPoolsResponse -> ShowS # show :: DescribeIpamPoolsResponse -> String # showList :: [DescribeIpamPoolsResponse] -> ShowS #
NFData DescribeIpamPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamPools Methods rnf :: DescribeIpamPoolsResponse -> () #
Eq DescribeIpamPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamPools Methods (==) :: DescribeIpamPoolsResponse -> DescribeIpamPoolsResponse -> Bool # (/=) :: DescribeIpamPoolsResponse -> DescribeIpamPoolsResponse -> Bool #
type Rep DescribeIpamPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamPools type Rep DescribeIpamPoolsResponse = D1 ('MetaData "DescribeIpamPoolsResponse" "Amazonka.EC2.DescribeIpamPools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeIpamPoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipamPools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamPool])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeIpamPoolsResponse Source #

Arguments

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

Create a value of DescribeIpamPoolsResponse 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:ipamPools:DescribeIpamPoolsResponse', describeIpamPoolsResponse_ipamPools - Information about the IPAM pools.

DescribeIpamPools, describeIpamPoolsResponse_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:DescribeIpamPoolsResponse', describeIpamPoolsResponse_httpStatus - The response's http status code.

Response Lenses

describeIpamPoolsResponse_ipamPools :: Lens' DescribeIpamPoolsResponse (Maybe [IpamPool]) Source #

Information about the IPAM pools.

describeIpamPoolsResponse_nextToken :: Lens' DescribeIpamPoolsResponse (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.

describeIpamPoolsResponse_httpStatus :: Lens' DescribeIpamPoolsResponse Int Source #

The response's http status code.