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 |
Get information about your IPAM pools.
This operation returns paginated results.
Synopsis
- data DescribeIpamPools = DescribeIpamPools' {}
- 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' {}
- 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.
DescribeIpamPools' | |
|
Instances
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.
Instances
newDescribeIpamPoolsResponse Source #
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.