describe_route_tables¶
Operation¶
describe_route_tables
async
¶
describe_route_tables(request: DescribeRouteTablesInput | DescribeRouteTablesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeRouteTablesOutput
describe_route_tables(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeRouteTablesInputDict]) -> DescribeRouteTablesOutput
Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon VPC User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
DescribeRouteTablesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeRouteTablesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeRouteTablesInput 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
¶
The filters.
-
association.gateway-id- The ID of the gateway involved in the association. -
association.route-table-association-id- The ID of an association ID for the route table. -
association.route-table-id- The ID of the route table involved in the association. -
association.subnet-id- The ID of the subnet involved in the association. -
association.main- Indicates whether the route table is the main route table for the VPC (true|false). Route tables that do not have an association ID are not returned in the response. -
owner-id- The ID of the Amazon Web Services account that owns the route table. -
route-table-id- The ID of the route table. -
route.destination-cidr-block- The IPv4 CIDR range specified in a route in the table. -
route.destination-ipv6-cidr-block- The IPv6 CIDR range specified in a route in the route table. -
route.destination-prefix-list-id- The ID (prefix) of the Amazon Web Services service specified in a route in the table. -
route.egress-only-internet-gateway-id- The ID of an egress-only Internet gateway specified in a route in the route table. -
route.gateway-id- The ID of a gateway specified in a route in the table. -
route.instance-id- The ID of an instance specified in a route in the table. -
route.nat-gateway-id- The ID of a NAT gateway. -
route.transit-gateway-id- The ID of a transit gateway. -
route.origin- Describes how the route was created.CreateRouteTableindicates that the route was automatically created when the route table was created;CreateRouteindicates that the route was manually added to the route table;EnableVgwRoutePropagationindicates that the route was propagated by route propagation. -
route.state- The state of a route in the route table (active|blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). -
route.vpc-peering-connection-id- The ID of a VPC peering connection specified in a route in the table. -
tag- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
vpc-id- The ID of the VPC for the route table.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Dictionaries¶
DescribeRouteTablesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeRouteTablesInput.
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: Sequence[Filter | FilterDict] | None
The filters.
-
association.gateway-id- The ID of the gateway involved in the association. -
association.route-table-association-id- The ID of an association ID for the route table. -
association.route-table-id- The ID of the route table involved in the association. -
association.subnet-id- The ID of the subnet involved in the association. -
association.main- Indicates whether the route table is the main route table for the VPC (true|false). Route tables that do not have an association ID are not returned in the response. -
owner-id- The ID of the Amazon Web Services account that owns the route table. -
route-table-id- The ID of the route table. -
route.destination-cidr-block- The IPv4 CIDR range specified in a route in the table. -
route.destination-ipv6-cidr-block- The IPv6 CIDR range specified in a route in the route table. -
route.destination-prefix-list-id- The ID (prefix) of the Amazon Web Services service specified in a route in the table. -
route.egress-only-internet-gateway-id- The ID of an egress-only Internet gateway specified in a route in the route table. -
route.gateway-id- The ID of a gateway specified in a route in the table. -
route.instance-id- The ID of an instance specified in a route in the table. -
route.nat-gateway-id- The ID of a NAT gateway. -
route.transit-gateway-id- The ID of a transit gateway. -
route.origin- Describes how the route was created.CreateRouteTableindicates that the route was automatically created when the route table was created;CreateRouteindicates that the route was manually added to the route table;EnableVgwRoutePropagationindicates that the route was propagated by route propagation. -
route.state- The state of a route in the route table (active|blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). -
route.vpc-peering-connection-id- The ID of a VPC peering connection specified in a route in the table. -
tag- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
vpc-id- The ID of the VPC for the route table.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Output¶
DescribeRouteTablesOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of DescribeRouteTables.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items 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.
route_tables
class-attribute
instance-attribute
¶
route_tables: list[RouteTable] | None = ...
Information about the route tables.