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.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
This operation returns paginated results.
Synopsis
- data DescribeIpams = DescribeIpams' {}
- newDescribeIpams :: DescribeIpams
- describeIpams_dryRun :: Lens' DescribeIpams (Maybe Bool)
- describeIpams_filters :: Lens' DescribeIpams (Maybe [Filter])
- describeIpams_ipamIds :: Lens' DescribeIpams (Maybe [Text])
- describeIpams_maxResults :: Lens' DescribeIpams (Maybe Natural)
- describeIpams_nextToken :: Lens' DescribeIpams (Maybe Text)
- data DescribeIpamsResponse = DescribeIpamsResponse' {}
- newDescribeIpamsResponse :: Int -> DescribeIpamsResponse
- describeIpamsResponse_ipams :: Lens' DescribeIpamsResponse (Maybe [Ipam])
- describeIpamsResponse_nextToken :: Lens' DescribeIpamsResponse (Maybe Text)
- describeIpamsResponse_httpStatus :: Lens' DescribeIpamsResponse Int
Creating a Request
data DescribeIpams Source #
See: newDescribeIpams
smart constructor.
DescribeIpams' | |
|
Instances
newDescribeIpams :: DescribeIpams Source #
Create a value of DescribeIpams
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:DescribeIpams'
, describeIpams_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:DescribeIpams'
, describeIpams_filters
- One or more filters for the request. For more information about
filtering, see
Filtering CLI output.
$sel:ipamIds:DescribeIpams'
, describeIpams_ipamIds
- The IDs of the IPAMs you want information on.
$sel:maxResults:DescribeIpams'
, describeIpams_maxResults
- The maximum number of results to return in the request.
DescribeIpams
, describeIpams_nextToken
- The token for the next page of results.
Request Lenses
describeIpams_dryRun :: Lens' DescribeIpams (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
.
describeIpams_filters :: Lens' DescribeIpams (Maybe [Filter]) Source #
One or more filters for the request. For more information about filtering, see Filtering CLI output.
describeIpams_ipamIds :: Lens' DescribeIpams (Maybe [Text]) Source #
The IDs of the IPAMs you want information on.
describeIpams_maxResults :: Lens' DescribeIpams (Maybe Natural) Source #
The maximum number of results to return in the request.
describeIpams_nextToken :: Lens' DescribeIpams (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data DescribeIpamsResponse Source #
See: newDescribeIpamsResponse
smart constructor.
Instances
newDescribeIpamsResponse Source #
Create a value of DescribeIpamsResponse
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:ipams:DescribeIpamsResponse'
, describeIpamsResponse_ipams
- Information about the IPAMs.
DescribeIpams
, describeIpamsResponse_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:DescribeIpamsResponse'
, describeIpamsResponse_httpStatus
- The response's http status code.
Response Lenses
describeIpamsResponse_ipams :: Lens' DescribeIpamsResponse (Maybe [Ipam]) Source #
Information about the IPAMs.
describeIpamsResponse_nextToken :: Lens' DescribeIpamsResponse (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.
describeIpamsResponse_httpStatus :: Lens' DescribeIpamsResponse Int Source #
The response's http status code.