# 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](CommonParameters.md).

 **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` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `peering` \$1 `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` \$1 `blackhole`).
+  `type` - The type of route (`propagated` \$1 `static`).
Type: Array of [Filter](API_Filter.md) 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

 **NextToken**   
The token for the next page of results.  
Type: String  
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

 **nextToken**   
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

 **requestId**   
The ID of the request.  
Type: String

 **routeSet**   
Information about the routes.  
Type: Array of [TransitGatewayRoute](API_TransitGatewayRoute.md) objects

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SearchTransitGatewayRoutes)