ec2_describe_transit_gateway_attachments {aws.ecx} | R Documentation |
Describe Transit Gateway Attachments
Description
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.
Usage
ec2_describe_transit_gateway_attachments(
TransitGatewayAttachmentIds = NULL,
Filter = NULL,
MaxResults = NULL,
NextToken = NULL,
DryRun = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
TransitGatewayAttachmentIds |
List. The IDs of the attachments.[optional] |
Filter |
Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional] |
MaxResults |
Integer. The maximum number of results to return with a single call.[optional] |
NextToken |
Characters. The token for the next page of results[optional] |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
TransitGatewayAttachmentIds
The IDs of the attachments.
Filter
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 AWS 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 AWS account that owns the transit gateway.
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.
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
.