Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
Request ParametersThe following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
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
.
Type: Boolean
Required: No
One or more filters. The possible values are:
options.propagation-default-route-table-id
- The ID of the default propagation route table.
options.amazon-side-asn
- The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id
- The ID of the default association route table.
options.auto-accept-shared-attachments
- Indicates whether there is automatic acceptance of attachment requests (enable
| disable
).
options.default-route-table-association
- Indicates whether resource attachments are automatically associated with the default association route table (enable
| disable
).
options.default-route-table-propagation
- Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable
| disable
).
options.dns-support
- Indicates whether DNS support is enabled (enable
| disable
).
options.vpn-ecmp-support
- Indicates whether Equal Cost Multipath Protocol support is enabled (enable
| disable
).
owner-id
- The ID of the AWS account that owns the transit gateway.
state
- The state of the transit gateway (available
| deleted
| deleting
| modifying
| pending
).
transit-gateway-id
- The ID of the transit 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 key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
Type: Array of Filter objects
Required: No
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 1000.
Required: No
The token for the next page of results.
Type: String
Required: No
The IDs of the transit gateways.
Type: Array of strings
Required: No
The following elements are returned by the service.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
Type: String
The ID of the request.
Type: String
Information about the transit gateways.
Type: Array of TransitGateway objects
For information about the errors that are common to all actions, see Common client error codes.
Examples ExampleThis example describes your transit gateways.
Sample Requesthttps://ec2.amazonaws.com/?Action=DescribeTransitGateways
&AUTHPARAMS
Sample Response
<DescribeTransitGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>151283df-f7dc-4317-89b4-01c9888b1d45</requestId>
<transitGatewaySet>
<item>
<creationTime>2019-05-08T13:21:33.000Z</creationTime>
<description>example tgw</description>
<options>
<amazonSideAsn>64512</amazonSideAsn>
<associationDefaultRouteTableId>tgw-rtb-002573ed1eEXAMPLE</associationDefaultRouteTableId>
<autoAcceptSharedAttachments>disable</autoAcceptSharedAttachments>
<defaultRouteTableAssociation>enable</defaultRouteTableAssociation>
<defaultRouteTablePropagation>enable</defaultRouteTablePropagation>
<dnsSupport>enable</dnsSupport>
<propagationDefaultRouteTableId>tgw-rtb-002573ed1eEXAMPLE</propagationDefaultRouteTableId>
<vpnEcmpSupport>enable</vpnEcmpSupport>
</options>
<ownerId>111122223333</ownerId>
<state>available</state>
<tagSet/>
<transitGatewayArn>arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-02f776b1a7EXAMPLE</transitGatewayArn>
<transitGatewayId>tgw-02f776b1a7EXAMPLE</transitGatewayId>
</item>
</transitGatewaySet>
</DescribeTransitGatewaysResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4