Skip to content

describe_local_gateway_route_tables

describe_local_gateway_route_tables(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    local_gateway_route_table_ids: Optional[LocalGatewayRouteTableIdSet] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[LocalGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeLocalGatewayRouteTablesResult

Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.

Parameters:

  • local_gateway_route_table_ids (Optional[LocalGatewayRouteTableIdSet], default: None ) –

    The IDs of the local gateway route tables.

  • filters (Optional[FilterList], default: None ) –

    One or more filters.

    • local-gateway-id - The ID of a local gateway.

    • local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.

    • local-gateway-route-table-id - The ID of a local gateway route table.

    • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

    • owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.

    • state - The state of the local gateway route table.

  • max_results (Optional[LocalGatewayMaxResults], default: None ) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_local_gateway_route_tables(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    local_gateway_route_table_ids: Optional[
        "capo_ec2.types.local_gateway_route_table_id_set.LocalGatewayRouteTableIdSet"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.local_gateway_max_results.LocalGatewayMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_local_gateway_route_tables_result.DescribeLocalGatewayRouteTablesResult":
    """<p>Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.</p>

    Args:
        local_gateway_route_table_ids: <p>The IDs of the local gateway route tables.</p>
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of a local gateway route table.</p> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway route table.</p> </li> <li> <p> <code>state</code> - The state of the local gateway route table.</p> </li> </ul>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_local_gateway_route_tables_request.DescribeLocalGatewayRouteTablesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_local_gateway_route_tables_result.DescribeLocalGatewayRouteTablesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_local_gateway_route_tables

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_local_gateway_route_tables.describe_local_gateway_route_tables(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLocalGatewayRouteTables")
    )
    input_: capo_ec2.types.describe_local_gateway_route_tables_request.DescribeLocalGatewayRouteTablesRequest = {}
    if local_gateway_route_table_ids is not None:
        input_["local_gateway_route_table_ids"] = local_gateway_route_table_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output