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 Connect attachments.
This operation returns paginated results.
Synopsis
- data DescribeTransitGatewayConnects = DescribeTransitGatewayConnects' {}
- newDescribeTransitGatewayConnects :: DescribeTransitGatewayConnects
- describeTransitGatewayConnects_dryRun :: Lens' DescribeTransitGatewayConnects (Maybe Bool)
- describeTransitGatewayConnects_filters :: Lens' DescribeTransitGatewayConnects (Maybe [Filter])
- describeTransitGatewayConnects_maxResults :: Lens' DescribeTransitGatewayConnects (Maybe Natural)
- describeTransitGatewayConnects_nextToken :: Lens' DescribeTransitGatewayConnects (Maybe Text)
- describeTransitGatewayConnects_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayConnects (Maybe [Text])
- data DescribeTransitGatewayConnectsResponse = DescribeTransitGatewayConnectsResponse' {}
- newDescribeTransitGatewayConnectsResponse :: Int -> DescribeTransitGatewayConnectsResponse
- describeTransitGatewayConnectsResponse_nextToken :: Lens' DescribeTransitGatewayConnectsResponse (Maybe Text)
- describeTransitGatewayConnectsResponse_transitGatewayConnects :: Lens' DescribeTransitGatewayConnectsResponse (Maybe [TransitGatewayConnect])
- describeTransitGatewayConnectsResponse_httpStatus :: Lens' DescribeTransitGatewayConnectsResponse Int
Creating a Request
data DescribeTransitGatewayConnects Source #
See: newDescribeTransitGatewayConnects
smart constructor.
DescribeTransitGatewayConnects' | |
|
Instances
newDescribeTransitGatewayConnects :: DescribeTransitGatewayConnects Source #
Create a value of DescribeTransitGatewayConnects
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:DescribeTransitGatewayConnects'
, describeTransitGatewayConnects_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:DescribeTransitGatewayConnects'
, describeTransitGatewayConnects_filters
- One or more filters. The possible values are:
options.protocol
- The tunnel protocol (gre
).state
- The state of the attachment (initiating
|initiatingRequest
|pendingAcceptance
|rollingBack
|pending
|available
|modifying
|deleting
|deleted
|failed
|rejected
|rejecting
|failing
).transit-gateway-attachment-id
- The ID of the Connect attachment.transit-gateway-id
- The ID of the transit gateway.transport-transit-gateway-attachment-id
- The ID of the transit gateway attachment from which the Connect attachment was created.
$sel:maxResults:DescribeTransitGatewayConnects'
, describeTransitGatewayConnects_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.
DescribeTransitGatewayConnects
, describeTransitGatewayConnects_nextToken
- The token for the next page of results.
$sel:transitGatewayAttachmentIds:DescribeTransitGatewayConnects'
, describeTransitGatewayConnects_transitGatewayAttachmentIds
- The IDs of the attachments.
Request Lenses
describeTransitGatewayConnects_dryRun :: Lens' DescribeTransitGatewayConnects (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
.
describeTransitGatewayConnects_filters :: Lens' DescribeTransitGatewayConnects (Maybe [Filter]) Source #
One or more filters. The possible values are:
options.protocol
- The tunnel protocol (gre
).state
- The state of the attachment (initiating
|initiatingRequest
|pendingAcceptance
|rollingBack
|pending
|available
|modifying
|deleting
|deleted
|failed
|rejected
|rejecting
|failing
).transit-gateway-attachment-id
- The ID of the Connect attachment.transit-gateway-id
- The ID of the transit gateway.transport-transit-gateway-attachment-id
- The ID of the transit gateway attachment from which the Connect attachment was created.
describeTransitGatewayConnects_maxResults :: Lens' DescribeTransitGatewayConnects (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.
describeTransitGatewayConnects_nextToken :: Lens' DescribeTransitGatewayConnects (Maybe Text) Source #
The token for the next page of results.
describeTransitGatewayConnects_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayConnects (Maybe [Text]) Source #
The IDs of the attachments.
Destructuring the Response
data DescribeTransitGatewayConnectsResponse Source #
See: newDescribeTransitGatewayConnectsResponse
smart constructor.
DescribeTransitGatewayConnectsResponse' | |
|
Instances
newDescribeTransitGatewayConnectsResponse Source #
Create a value of DescribeTransitGatewayConnectsResponse
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:
DescribeTransitGatewayConnects
, describeTransitGatewayConnectsResponse_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:transitGatewayConnects:DescribeTransitGatewayConnectsResponse'
, describeTransitGatewayConnectsResponse_transitGatewayConnects
- Information about the Connect attachments.
$sel:httpStatus:DescribeTransitGatewayConnectsResponse'
, describeTransitGatewayConnectsResponse_httpStatus
- The response's http status code.
Response Lenses
describeTransitGatewayConnectsResponse_nextToken :: Lens' DescribeTransitGatewayConnectsResponse (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.
describeTransitGatewayConnectsResponse_transitGatewayConnects :: Lens' DescribeTransitGatewayConnectsResponse (Maybe [TransitGatewayConnect]) Source #
Information about the Connect attachments.
describeTransitGatewayConnectsResponse_httpStatus :: Lens' DescribeTransitGatewayConnectsResponse Int Source #
The response's http status code.