search_transit_gateway_routes¶
Operation¶
search_transit_gateway_routes
¶
search_transit_gateway_routes(request: SearchTransitGatewayRoutesInput | SearchTransitGatewayRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchTransitGatewayRoutesInputDict]) -> SearchTransitGatewayRoutesOutput
Searches for routes in the specified transit gateway route table.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SearchTransitGatewayRoutesInput | SearchTransitGatewayRoutesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[SearchTransitGatewayRoutesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SearchTransitGatewayRoutesOutput
|
An instance of |
search_transit_gateway_routes
async
¶
search_transit_gateway_routes(request: SearchTransitGatewayRoutesInput | SearchTransitGatewayRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchTransitGatewayRoutesInputDict]) -> SearchTransitGatewayRoutesOutput
Searches for routes in the specified transit gateway route table.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SearchTransitGatewayRoutesInput | SearchTransitGatewayRoutesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[SearchTransitGatewayRoutesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SearchTransitGatewayRoutesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
SearchTransitGatewayRoutesInputDict
¶
Bases: TypedDict
Dictionary form of SearchTransitGatewayRoutesInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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.
filters
instance-attribute
¶
filters: Required[Sequence[Filter | FilterDict]]
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 arevpc|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).
SearchTransitGatewayRoutesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchTransitGatewayRoutesInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
filters
class-attribute
instance-attribute
¶
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 arevpc|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).
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of routes to return. If a value is not provided, the default is 1000.
Output¶
SearchTransitGatewayRoutesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchTransitGatewayRoutesOutput structure.
Attributes¶
additional_routes_available
class-attribute
instance-attribute
¶
additional_routes_available: bool | None = ...
Indicates whether there are additional routes available.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
routes
class-attribute
instance-attribute
¶
routes: list[TransitGatewayRoute] | None = ...
Information about the routes.