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 one or more of your carrier gateways.
This operation returns paginated results.
Synopsis
- data DescribeCarrierGateways = DescribeCarrierGateways' {}
- newDescribeCarrierGateways :: DescribeCarrierGateways
- describeCarrierGateways_carrierGatewayIds :: Lens' DescribeCarrierGateways (Maybe [Text])
- describeCarrierGateways_dryRun :: Lens' DescribeCarrierGateways (Maybe Bool)
- describeCarrierGateways_filters :: Lens' DescribeCarrierGateways (Maybe [Filter])
- describeCarrierGateways_maxResults :: Lens' DescribeCarrierGateways (Maybe Natural)
- describeCarrierGateways_nextToken :: Lens' DescribeCarrierGateways (Maybe Text)
- data DescribeCarrierGatewaysResponse = DescribeCarrierGatewaysResponse' {}
- newDescribeCarrierGatewaysResponse :: Int -> DescribeCarrierGatewaysResponse
- describeCarrierGatewaysResponse_carrierGateways :: Lens' DescribeCarrierGatewaysResponse (Maybe [CarrierGateway])
- describeCarrierGatewaysResponse_nextToken :: Lens' DescribeCarrierGatewaysResponse (Maybe Text)
- describeCarrierGatewaysResponse_httpStatus :: Lens' DescribeCarrierGatewaysResponse Int
Creating a Request
data DescribeCarrierGateways Source #
See: newDescribeCarrierGateways
smart constructor.
DescribeCarrierGateways' | |
|
Instances
newDescribeCarrierGateways :: DescribeCarrierGateways Source #
Create a value of DescribeCarrierGateways
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:carrierGatewayIds:DescribeCarrierGateways'
, describeCarrierGateways_carrierGatewayIds
- One or more carrier gateway IDs.
$sel:dryRun:DescribeCarrierGateways'
, describeCarrierGateways_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:DescribeCarrierGateways'
, describeCarrierGateways_filters
- One or more filters.
carrier-gateway-id
- The ID of the carrier gateway.state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
).owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway.tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.vpc-id
- The ID of the VPC associated with the carrier gateway.
$sel:maxResults:DescribeCarrierGateways'
, describeCarrierGateways_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.
DescribeCarrierGateways
, describeCarrierGateways_nextToken
- The token for the next page of results.
Request Lenses
describeCarrierGateways_carrierGatewayIds :: Lens' DescribeCarrierGateways (Maybe [Text]) Source #
One or more carrier gateway IDs.
describeCarrierGateways_dryRun :: Lens' DescribeCarrierGateways (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
.
describeCarrierGateways_filters :: Lens' DescribeCarrierGateways (Maybe [Filter]) Source #
One or more filters.
carrier-gateway-id
- The ID of the carrier gateway.state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
).owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway.tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.vpc-id
- The ID of the VPC associated with the carrier gateway.
describeCarrierGateways_maxResults :: Lens' DescribeCarrierGateways (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.
describeCarrierGateways_nextToken :: Lens' DescribeCarrierGateways (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data DescribeCarrierGatewaysResponse Source #
See: newDescribeCarrierGatewaysResponse
smart constructor.
DescribeCarrierGatewaysResponse' | |
|
Instances
newDescribeCarrierGatewaysResponse Source #
Create a value of DescribeCarrierGatewaysResponse
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:carrierGateways:DescribeCarrierGatewaysResponse'
, describeCarrierGatewaysResponse_carrierGateways
- Information about the carrier gateway.
DescribeCarrierGateways
, describeCarrierGatewaysResponse_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:DescribeCarrierGatewaysResponse'
, describeCarrierGatewaysResponse_httpStatus
- The response's http status code.
Response Lenses
describeCarrierGatewaysResponse_carrierGateways :: Lens' DescribeCarrierGatewaysResponse (Maybe [CarrierGateway]) Source #
Information about the carrier gateway.
describeCarrierGatewaysResponse_nextToken :: Lens' DescribeCarrierGatewaysResponse (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.
describeCarrierGatewaysResponse_httpStatus :: Lens' DescribeCarrierGatewaysResponse Int Source #
The response's http status code.