GET

/#Action=DescribeTransitGatewayAttachments

http://ec2.{region}.amazonaws.com/#Action=DescribeTransitGatewayAttachments

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.

Access Token Required: API Key

Query Params

TransitGatewayAttachmentIdsarray

The IDs of the attachments.

Filterarray

One or more filters. The possible values are: <ul> <li> <code>association.state</code> - The state of the association (<code>associating</code> | <code>associated</code> | <code>disassociating</code>). </li> <li> <code>association.transit-gateway-route-table-id</code> - The ID of the route table for the transit gateway. </li> <li> <code>resource-id</code> - The ID of the resource. </li> <li> <code>resource-owner-id</code> - The ID of the Amazon Web Services account that owns the resource. </li> <li> <code>resource-type</code> - The resource type. Valid values are <code>vpc</code> | <code>vpn</code> | <code>direct-connect-gateway</code> | <code>peering</code> | <code>connect</code>. </li> <li> <code>state</code> - The state of the attachment. Valid values are <code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>failed</code> | <code>failing</code> | <code>initiatingRequest</code> | <code>modifying</code> | <code>pendingAcceptance</code> | <code>pending</code> | <code>rollingBack</code> | <code>rejected</code> | <code>rejecting</code>. </li> <li> <code>transit-gateway-attachment-id</code> - The ID of the attachment. </li> <li> <code>transit-gateway-id</code> - The ID of the transit gateway. </li> <li> <code>transit-gateway-owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway. </li> </ul>

MaxResultsinteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.

NextTokenstring

The token for the next page of results.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=DescribeTransitGatewayAttachments' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}