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 attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
This operation returns paginated results.
Synopsis
- data DescribeTransitGatewayAttachments = DescribeTransitGatewayAttachments' {}
- newDescribeTransitGatewayAttachments :: DescribeTransitGatewayAttachments
- describeTransitGatewayAttachments_dryRun :: Lens' DescribeTransitGatewayAttachments (Maybe Bool)
- describeTransitGatewayAttachments_filters :: Lens' DescribeTransitGatewayAttachments (Maybe [Filter])
- describeTransitGatewayAttachments_maxResults :: Lens' DescribeTransitGatewayAttachments (Maybe Natural)
- describeTransitGatewayAttachments_nextToken :: Lens' DescribeTransitGatewayAttachments (Maybe Text)
- describeTransitGatewayAttachments_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayAttachments (Maybe [Text])
- data DescribeTransitGatewayAttachmentsResponse = DescribeTransitGatewayAttachmentsResponse' {}
- newDescribeTransitGatewayAttachmentsResponse :: Int -> DescribeTransitGatewayAttachmentsResponse
- describeTransitGatewayAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayAttachmentsResponse (Maybe Text)
- describeTransitGatewayAttachmentsResponse_transitGatewayAttachments :: Lens' DescribeTransitGatewayAttachmentsResponse (Maybe [TransitGatewayAttachment])
- describeTransitGatewayAttachmentsResponse_httpStatus :: Lens' DescribeTransitGatewayAttachmentsResponse Int
Creating a Request
data DescribeTransitGatewayAttachments Source #
See: newDescribeTransitGatewayAttachments
smart constructor.
DescribeTransitGatewayAttachments' | |
|
Instances
newDescribeTransitGatewayAttachments :: DescribeTransitGatewayAttachments Source #
Create a value of DescribeTransitGatewayAttachments
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:DescribeTransitGatewayAttachments'
, describeTransitGatewayAttachments_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:DescribeTransitGatewayAttachments'
, describeTransitGatewayAttachments_filters
- One or more filters. The possible values are:
association.state
- The state of the association (associating
|associated
|disassociating
).association.transit-gateway-route-table-id
- The ID of the route table for the transit gateway.resource-id
- The ID of the resource.resource-owner-id
- The ID of the Amazon Web Services account that owns the resource.resource-type
- The resource type. Valid values arevpc
|vpn
|direct-connect-gateway
|peering
|connect
.state
- The state of the attachment. Valid values areavailable
|deleted
|deleting
|failed
|failing
|initiatingRequest
|modifying
|pendingAcceptance
|pending
|rollingBack
|rejected
|rejecting
.transit-gateway-attachment-id
- The ID of the attachment.transit-gateway-id
- The ID of the transit gateway.transit-gateway-owner-id
- The ID of the Amazon Web Services account that owns the transit gateway.
$sel:maxResults:DescribeTransitGatewayAttachments'
, describeTransitGatewayAttachments_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.
DescribeTransitGatewayAttachments
, describeTransitGatewayAttachments_nextToken
- The token for the next page of results.
$sel:transitGatewayAttachmentIds:DescribeTransitGatewayAttachments'
, describeTransitGatewayAttachments_transitGatewayAttachmentIds
- The IDs of the attachments.
Request Lenses
describeTransitGatewayAttachments_dryRun :: Lens' DescribeTransitGatewayAttachments (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
.
describeTransitGatewayAttachments_filters :: Lens' DescribeTransitGatewayAttachments (Maybe [Filter]) Source #
One or more filters. The possible values are:
association.state
- The state of the association (associating
|associated
|disassociating
).association.transit-gateway-route-table-id
- The ID of the route table for the transit gateway.resource-id
- The ID of the resource.resource-owner-id
- The ID of the Amazon Web Services account that owns the resource.resource-type
- The resource type. Valid values arevpc
|vpn
|direct-connect-gateway
|peering
|connect
.state
- The state of the attachment. Valid values areavailable
|deleted
|deleting
|failed
|failing
|initiatingRequest
|modifying
|pendingAcceptance
|pending
|rollingBack
|rejected
|rejecting
.transit-gateway-attachment-id
- The ID of the attachment.transit-gateway-id
- The ID of the transit gateway.transit-gateway-owner-id
- The ID of the Amazon Web Services account that owns the transit gateway.
describeTransitGatewayAttachments_maxResults :: Lens' DescribeTransitGatewayAttachments (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.
describeTransitGatewayAttachments_nextToken :: Lens' DescribeTransitGatewayAttachments (Maybe Text) Source #
The token for the next page of results.
describeTransitGatewayAttachments_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayAttachments (Maybe [Text]) Source #
The IDs of the attachments.
Destructuring the Response
data DescribeTransitGatewayAttachmentsResponse Source #
See: newDescribeTransitGatewayAttachmentsResponse
smart constructor.
DescribeTransitGatewayAttachmentsResponse' | |
|
Instances
newDescribeTransitGatewayAttachmentsResponse Source #
Create a value of DescribeTransitGatewayAttachmentsResponse
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:
DescribeTransitGatewayAttachments
, describeTransitGatewayAttachmentsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
DescribeTransitGatewayAttachmentsResponse
, describeTransitGatewayAttachmentsResponse_transitGatewayAttachments
- Information about the attachments.
$sel:httpStatus:DescribeTransitGatewayAttachmentsResponse'
, describeTransitGatewayAttachmentsResponse_httpStatus
- The response's http status code.
Response Lenses
describeTransitGatewayAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayAttachmentsResponse (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.
describeTransitGatewayAttachmentsResponse_transitGatewayAttachments :: Lens' DescribeTransitGatewayAttachmentsResponse (Maybe [TransitGatewayAttachment]) Source #
Information about the attachments.
describeTransitGatewayAttachmentsResponse_httpStatus :: Lens' DescribeTransitGatewayAttachmentsResponse Int Source #
The response's http status code.