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 your transit gateway peering attachments.
This operation returns paginated results.
Synopsis
- data DescribeTransitGatewayPeeringAttachments = DescribeTransitGatewayPeeringAttachments' {}
- newDescribeTransitGatewayPeeringAttachments :: DescribeTransitGatewayPeeringAttachments
- describeTransitGatewayPeeringAttachments_dryRun :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe Bool)
- describeTransitGatewayPeeringAttachments_filters :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe [Filter])
- describeTransitGatewayPeeringAttachments_maxResults :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe Natural)
- describeTransitGatewayPeeringAttachments_nextToken :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe Text)
- describeTransitGatewayPeeringAttachments_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe [Text])
- data DescribeTransitGatewayPeeringAttachmentsResponse = DescribeTransitGatewayPeeringAttachmentsResponse' {}
- newDescribeTransitGatewayPeeringAttachmentsResponse :: Int -> DescribeTransitGatewayPeeringAttachmentsResponse
- describeTransitGatewayPeeringAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse (Maybe Text)
- describeTransitGatewayPeeringAttachmentsResponse_transitGatewayPeeringAttachments :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse (Maybe [TransitGatewayPeeringAttachment])
- describeTransitGatewayPeeringAttachmentsResponse_httpStatus :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse Int
Creating a Request
data DescribeTransitGatewayPeeringAttachments Source #
See: newDescribeTransitGatewayPeeringAttachments
smart constructor.
DescribeTransitGatewayPeeringAttachments' | |
|
Instances
newDescribeTransitGatewayPeeringAttachments :: DescribeTransitGatewayPeeringAttachments Source #
Create a value of DescribeTransitGatewayPeeringAttachments
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:DescribeTransitGatewayPeeringAttachments'
, describeTransitGatewayPeeringAttachments_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:DescribeTransitGatewayPeeringAttachments'
, describeTransitGatewayPeeringAttachments_filters
- One or more filters. The possible values are:
transit-gateway-attachment-id
- The ID of the transit gateway attachment.local-owner-id
- The ID of your Amazon Web Services account.remote-owner-id
- The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.state
- The state of the peering attachment. Valid values areavailable
|deleted
|deleting
|failed
|failing
|initiatingRequest
|modifying
|pendingAcceptance
|pending
|rollingBack
|rejected
|rejecting
).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 that have a tag with a specific key, regardless of the tag value.transit-gateway-id
- The ID of the transit gateway.
$sel:maxResults:DescribeTransitGatewayPeeringAttachments'
, describeTransitGatewayPeeringAttachments_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.
DescribeTransitGatewayPeeringAttachments
, describeTransitGatewayPeeringAttachments_nextToken
- The token for the next page of results.
$sel:transitGatewayAttachmentIds:DescribeTransitGatewayPeeringAttachments'
, describeTransitGatewayPeeringAttachments_transitGatewayAttachmentIds
- One or more IDs of the transit gateway peering attachments.
Request Lenses
describeTransitGatewayPeeringAttachments_dryRun :: Lens' DescribeTransitGatewayPeeringAttachments (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
.
describeTransitGatewayPeeringAttachments_filters :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe [Filter]) Source #
One or more filters. The possible values are:
transit-gateway-attachment-id
- The ID of the transit gateway attachment.local-owner-id
- The ID of your Amazon Web Services account.remote-owner-id
- The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.state
- The state of the peering attachment. Valid values areavailable
|deleted
|deleting
|failed
|failing
|initiatingRequest
|modifying
|pendingAcceptance
|pending
|rollingBack
|rejected
|rejecting
).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 that have a tag with a specific key, regardless of the tag value.transit-gateway-id
- The ID of the transit gateway.
describeTransitGatewayPeeringAttachments_maxResults :: Lens' DescribeTransitGatewayPeeringAttachments (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.
describeTransitGatewayPeeringAttachments_nextToken :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe Text) Source #
The token for the next page of results.
describeTransitGatewayPeeringAttachments_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe [Text]) Source #
One or more IDs of the transit gateway peering attachments.
Destructuring the Response
data DescribeTransitGatewayPeeringAttachmentsResponse Source #
See: newDescribeTransitGatewayPeeringAttachmentsResponse
smart constructor.
DescribeTransitGatewayPeeringAttachmentsResponse' | |
|
Instances
newDescribeTransitGatewayPeeringAttachmentsResponse Source #
:: Int |
|
-> DescribeTransitGatewayPeeringAttachmentsResponse |
Create a value of DescribeTransitGatewayPeeringAttachmentsResponse
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:
DescribeTransitGatewayPeeringAttachments
, describeTransitGatewayPeeringAttachmentsResponse_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:transitGatewayPeeringAttachments:DescribeTransitGatewayPeeringAttachmentsResponse'
, describeTransitGatewayPeeringAttachmentsResponse_transitGatewayPeeringAttachments
- The transit gateway peering attachments.
$sel:httpStatus:DescribeTransitGatewayPeeringAttachmentsResponse'
, describeTransitGatewayPeeringAttachmentsResponse_httpStatus
- The response's http status code.
Response Lenses
describeTransitGatewayPeeringAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse (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.
describeTransitGatewayPeeringAttachmentsResponse_transitGatewayPeeringAttachments :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse (Maybe [TransitGatewayPeeringAttachment]) Source #
The transit gateway peering attachments.
describeTransitGatewayPeeringAttachmentsResponse_httpStatus :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse Int Source #
The response's http status code.