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 |
Describes the specified customer-owned address pools or all of your customer-owned address pools.
This operation returns paginated results.
Synopsis
- data DescribeCoipPools = DescribeCoipPools' {}
- newDescribeCoipPools :: DescribeCoipPools
- describeCoipPools_dryRun :: Lens' DescribeCoipPools (Maybe Bool)
- describeCoipPools_filters :: Lens' DescribeCoipPools (Maybe [Filter])
- describeCoipPools_maxResults :: Lens' DescribeCoipPools (Maybe Natural)
- describeCoipPools_nextToken :: Lens' DescribeCoipPools (Maybe Text)
- describeCoipPools_poolIds :: Lens' DescribeCoipPools (Maybe [Text])
- data DescribeCoipPoolsResponse = DescribeCoipPoolsResponse' {}
- newDescribeCoipPoolsResponse :: Int -> DescribeCoipPoolsResponse
- describeCoipPoolsResponse_coipPools :: Lens' DescribeCoipPoolsResponse (Maybe [CoipPool])
- describeCoipPoolsResponse_nextToken :: Lens' DescribeCoipPoolsResponse (Maybe Text)
- describeCoipPoolsResponse_httpStatus :: Lens' DescribeCoipPoolsResponse Int
Creating a Request
data DescribeCoipPools Source #
See: newDescribeCoipPools
smart constructor.
DescribeCoipPools' | |
|
Instances
newDescribeCoipPools :: DescribeCoipPools Source #
Create a value of DescribeCoipPools
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:DescribeCoipPools'
, describeCoipPools_dryRun
- Checks 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:DescribeCoipPools'
, describeCoipPools_filters
- One or more filters.
coip-pool.local-gateway-route-table-id
- The ID of the local gateway route table.coip-pool.pool-id
- The ID of the address pool.
$sel:maxResults:DescribeCoipPools'
, describeCoipPools_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
DescribeCoipPools
, describeCoipPools_nextToken
- The token for the next page of results.
$sel:poolIds:DescribeCoipPools'
, describeCoipPools_poolIds
- The IDs of the address pools.
Request Lenses
describeCoipPools_dryRun :: Lens' DescribeCoipPools (Maybe Bool) Source #
Checks 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
.
describeCoipPools_filters :: Lens' DescribeCoipPools (Maybe [Filter]) Source #
One or more filters.
coip-pool.local-gateway-route-table-id
- The ID of the local gateway route table.coip-pool.pool-id
- The ID of the address pool.
describeCoipPools_maxResults :: Lens' DescribeCoipPools (Maybe Natural) Source #
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
describeCoipPools_nextToken :: Lens' DescribeCoipPools (Maybe Text) Source #
The token for the next page of results.
describeCoipPools_poolIds :: Lens' DescribeCoipPools (Maybe [Text]) Source #
The IDs of the address pools.
Destructuring the Response
data DescribeCoipPoolsResponse Source #
See: newDescribeCoipPoolsResponse
smart constructor.
Instances
newDescribeCoipPoolsResponse Source #
Create a value of DescribeCoipPoolsResponse
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:coipPools:DescribeCoipPoolsResponse'
, describeCoipPoolsResponse_coipPools
- Information about the address pools.
DescribeCoipPools
, describeCoipPoolsResponse_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:DescribeCoipPoolsResponse'
, describeCoipPoolsResponse_httpStatus
- The response's http status code.
Response Lenses
describeCoipPoolsResponse_coipPools :: Lens' DescribeCoipPoolsResponse (Maybe [CoipPool]) Source #
Information about the address pools.
describeCoipPoolsResponse_nextToken :: Lens' DescribeCoipPoolsResponse (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.
describeCoipPoolsResponse_httpStatus :: Lens' DescribeCoipPoolsResponse Int Source #
The response's http status code.