SearchTransitGatewayRoutes - Amazon Elastic Compute Cloud


Searches for routes in the specified transit gateway route table.

Request Parameters

The 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:

  • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

  • attachment.resource-id - The resource id of the transit gateway attachment.

  • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

  • prefix-list-id - The ID of the prefix list.

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have and routes in your route table and you specify supernet-of-match as, then the result returns

  • state - The state of the route (active | blackhole).

  • type - The type of route (propagated | static).

Type: Array of Filter objects

Required: Yes


The maximum number of routes to return. If a value is not provided, the default is 1000.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 1000.

Required: No


The ID of the transit gateway route table.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.


Indicates whether there are additional routes available.

Type: Boolean


The ID of the request.

Type: String


Information about the routes.

Type: Array of TransitGatewayRoute objects


For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: