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 internet gateways.
This operation returns paginated results.
Synopsis
- data DescribeInternetGateways = DescribeInternetGateways' {}
- newDescribeInternetGateways :: DescribeInternetGateways
- describeInternetGateways_dryRun :: Lens' DescribeInternetGateways (Maybe Bool)
- describeInternetGateways_filters :: Lens' DescribeInternetGateways (Maybe [Filter])
- describeInternetGateways_internetGatewayIds :: Lens' DescribeInternetGateways (Maybe [Text])
- describeInternetGateways_maxResults :: Lens' DescribeInternetGateways (Maybe Natural)
- describeInternetGateways_nextToken :: Lens' DescribeInternetGateways (Maybe Text)
- data DescribeInternetGatewaysResponse = DescribeInternetGatewaysResponse' {}
- newDescribeInternetGatewaysResponse :: Int -> DescribeInternetGatewaysResponse
- describeInternetGatewaysResponse_internetGateways :: Lens' DescribeInternetGatewaysResponse (Maybe [InternetGateway])
- describeInternetGatewaysResponse_nextToken :: Lens' DescribeInternetGatewaysResponse (Maybe Text)
- describeInternetGatewaysResponse_httpStatus :: Lens' DescribeInternetGatewaysResponse Int
Creating a Request
data DescribeInternetGateways Source #
See: newDescribeInternetGateways
smart constructor.
DescribeInternetGateways' | |
|
Instances
newDescribeInternetGateways :: DescribeInternetGateways Source #
Create a value of DescribeInternetGateways
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:DescribeInternetGateways'
, describeInternetGateways_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:DescribeInternetGateways'
, describeInternetGateways_filters
- One or more filters.
attachment.state
- The current state of the attachment between the gateway and the VPC (available
). Present only if a VPC is attached.attachment.vpc-id
- The ID of an attached VPC.internet-gateway-id
- The ID of the Internet gateway.owner-id
- The ID of the Amazon Web Services account that owns the internet 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.
$sel:internetGatewayIds:DescribeInternetGateways'
, describeInternetGateways_internetGatewayIds
- One or more internet gateway IDs.
Default: Describes all your internet gateways.
$sel:maxResults:DescribeInternetGateways'
, describeInternetGateways_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.
DescribeInternetGateways
, describeInternetGateways_nextToken
- The token for the next page of results.
Request Lenses
describeInternetGateways_dryRun :: Lens' DescribeInternetGateways (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
.
describeInternetGateways_filters :: Lens' DescribeInternetGateways (Maybe [Filter]) Source #
One or more filters.
attachment.state
- The current state of the attachment between the gateway and the VPC (available
). Present only if a VPC is attached.attachment.vpc-id
- The ID of an attached VPC.internet-gateway-id
- The ID of the Internet gateway.owner-id
- The ID of the Amazon Web Services account that owns the internet 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.
describeInternetGateways_internetGatewayIds :: Lens' DescribeInternetGateways (Maybe [Text]) Source #
One or more internet gateway IDs.
Default: Describes all your internet gateways.
describeInternetGateways_maxResults :: Lens' DescribeInternetGateways (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.
describeInternetGateways_nextToken :: Lens' DescribeInternetGateways (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data DescribeInternetGatewaysResponse Source #
See: newDescribeInternetGatewaysResponse
smart constructor.
DescribeInternetGatewaysResponse' | |
|
Instances
newDescribeInternetGatewaysResponse Source #
Create a value of DescribeInternetGatewaysResponse
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:internetGateways:DescribeInternetGatewaysResponse'
, describeInternetGatewaysResponse_internetGateways
- Information about one or more internet gateways.
DescribeInternetGateways
, describeInternetGatewaysResponse_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:DescribeInternetGatewaysResponse'
, describeInternetGatewaysResponse_httpStatus
- The response's http status code.
Response Lenses
describeInternetGatewaysResponse_internetGateways :: Lens' DescribeInternetGatewaysResponse (Maybe [InternetGateway]) Source #
Information about one or more internet gateways.
describeInternetGatewaysResponse_nextToken :: Lens' DescribeInternetGatewaysResponse (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.
describeInternetGatewaysResponse_httpStatus :: Lens' DescribeInternetGatewaysResponse Int Source #
The response's http status code.