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 allocations from the specified customer-owned address pool.
Synopsis
- data GetCoipPoolUsage = GetCoipPoolUsage' {}
- newGetCoipPoolUsage :: Text -> GetCoipPoolUsage
- getCoipPoolUsage_dryRun :: Lens' GetCoipPoolUsage (Maybe Bool)
- getCoipPoolUsage_filters :: Lens' GetCoipPoolUsage (Maybe [Filter])
- getCoipPoolUsage_maxResults :: Lens' GetCoipPoolUsage (Maybe Natural)
- getCoipPoolUsage_nextToken :: Lens' GetCoipPoolUsage (Maybe Text)
- getCoipPoolUsage_poolId :: Lens' GetCoipPoolUsage Text
- data GetCoipPoolUsageResponse = GetCoipPoolUsageResponse' {}
- newGetCoipPoolUsageResponse :: Int -> GetCoipPoolUsageResponse
- getCoipPoolUsageResponse_coipAddressUsages :: Lens' GetCoipPoolUsageResponse (Maybe [CoipAddressUsage])
- getCoipPoolUsageResponse_coipPoolId :: Lens' GetCoipPoolUsageResponse (Maybe Text)
- getCoipPoolUsageResponse_localGatewayRouteTableId :: Lens' GetCoipPoolUsageResponse (Maybe Text)
- getCoipPoolUsageResponse_httpStatus :: Lens' GetCoipPoolUsageResponse Int
Creating a Request
data GetCoipPoolUsage Source #
See: newGetCoipPoolUsage
smart constructor.
GetCoipPoolUsage' | |
|
Instances
Create a value of GetCoipPoolUsage
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:GetCoipPoolUsage'
, getCoipPoolUsage_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:GetCoipPoolUsage'
, getCoipPoolUsage_filters
- One or more filters.
coip-address-usage.allocation-id
- The allocation ID of the address.coip-address-usage.aws-account-id
- The ID of the Amazon Web Services account that is using the customer-owned IP address.coip-address-usage.aws-service
- The Amazon Web Services service that is using the customer-owned IP address.coip-address-usage.co-ip
- The customer-owned IP address.
$sel:maxResults:GetCoipPoolUsage'
, getCoipPoolUsage_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.
$sel:nextToken:GetCoipPoolUsage'
, getCoipPoolUsage_nextToken
- The token for the next page of results.
GetCoipPoolUsage
, getCoipPoolUsage_poolId
- The ID of the address pool.
Request Lenses
getCoipPoolUsage_dryRun :: Lens' GetCoipPoolUsage (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
.
getCoipPoolUsage_filters :: Lens' GetCoipPoolUsage (Maybe [Filter]) Source #
One or more filters.
coip-address-usage.allocation-id
- The allocation ID of the address.coip-address-usage.aws-account-id
- The ID of the Amazon Web Services account that is using the customer-owned IP address.coip-address-usage.aws-service
- The Amazon Web Services service that is using the customer-owned IP address.coip-address-usage.co-ip
- The customer-owned IP address.
getCoipPoolUsage_maxResults :: Lens' GetCoipPoolUsage (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.
getCoipPoolUsage_nextToken :: Lens' GetCoipPoolUsage (Maybe Text) Source #
The token for the next page of results.
getCoipPoolUsage_poolId :: Lens' GetCoipPoolUsage Text Source #
The ID of the address pool.
Destructuring the Response
data GetCoipPoolUsageResponse Source #
See: newGetCoipPoolUsageResponse
smart constructor.
GetCoipPoolUsageResponse' | |
|
Instances
newGetCoipPoolUsageResponse Source #
Create a value of GetCoipPoolUsageResponse
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:coipAddressUsages:GetCoipPoolUsageResponse'
, getCoipPoolUsageResponse_coipAddressUsages
- Information about the address usage.
GetCoipPoolUsageResponse
, getCoipPoolUsageResponse_coipPoolId
- The ID of the customer-owned address pool.
GetCoipPoolUsageResponse
, getCoipPoolUsageResponse_localGatewayRouteTableId
- The ID of the local gateway route table.
$sel:httpStatus:GetCoipPoolUsageResponse'
, getCoipPoolUsageResponse_httpStatus
- The response's http status code.
Response Lenses
getCoipPoolUsageResponse_coipAddressUsages :: Lens' GetCoipPoolUsageResponse (Maybe [CoipAddressUsage]) Source #
Information about the address usage.
getCoipPoolUsageResponse_coipPoolId :: Lens' GetCoipPoolUsageResponse (Maybe Text) Source #
The ID of the customer-owned address pool.
getCoipPoolUsageResponse_localGatewayRouteTableId :: Lens' GetCoipPoolUsageResponse (Maybe Text) Source #
The ID of the local gateway route table.
getCoipPoolUsageResponse_httpStatus :: Lens' GetCoipPoolUsageResponse Int Source #
The response's http status code.