SearchTransitGatewayRoutes - Amazon Elastic Compute Cloud
Request ParametersResponse ElementsErrorsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SearchTransitGatewayRoutes

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.

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.

Type: Boolean

Required: No

Filter.N

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 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

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

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

Type: Array of Filter objects

Required: Yes

MaxResults

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

TransitGatewayRouteTableId

The ID of the transit gateway route table.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

additionalRoutesAvailable

Indicates whether there are additional routes available.

Type: Boolean

requestId

The ID of the request.

Type: String

routeSet

Information about the routes.

Type: Array of TransitGatewayRoute objects

Errors

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 Amazon SDKs, see the following: