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 a list of all the CIDR allocations in an IPAM pool.
This operation returns paginated results.
Synopsis
- data GetIpamPoolAllocations = GetIpamPoolAllocations' {}
- newGetIpamPoolAllocations :: Text -> GetIpamPoolAllocations
- getIpamPoolAllocations_dryRun :: Lens' GetIpamPoolAllocations (Maybe Bool)
- getIpamPoolAllocations_filters :: Lens' GetIpamPoolAllocations (Maybe [Filter])
- getIpamPoolAllocations_ipamPoolAllocationId :: Lens' GetIpamPoolAllocations (Maybe Text)
- getIpamPoolAllocations_maxResults :: Lens' GetIpamPoolAllocations (Maybe Natural)
- getIpamPoolAllocations_nextToken :: Lens' GetIpamPoolAllocations (Maybe Text)
- getIpamPoolAllocations_ipamPoolId :: Lens' GetIpamPoolAllocations Text
- data GetIpamPoolAllocationsResponse = GetIpamPoolAllocationsResponse' {}
- newGetIpamPoolAllocationsResponse :: Int -> GetIpamPoolAllocationsResponse
- getIpamPoolAllocationsResponse_ipamPoolAllocations :: Lens' GetIpamPoolAllocationsResponse (Maybe [IpamPoolAllocation])
- getIpamPoolAllocationsResponse_nextToken :: Lens' GetIpamPoolAllocationsResponse (Maybe Text)
- getIpamPoolAllocationsResponse_httpStatus :: Lens' GetIpamPoolAllocationsResponse Int
Creating a Request
data GetIpamPoolAllocations Source #
See: newGetIpamPoolAllocations
smart constructor.
GetIpamPoolAllocations' | |
|
Instances
newGetIpamPoolAllocations Source #
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.
GetIpamPoolAllocationsResponse' | |
|
Instances
newGetIpamPoolAllocationsResponse Source #
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.