EC2 / Client / search_local_gateway_routes

search_local_gateway_routes

EC2.Client.search_local_gateway_routes(**kwargs)

Searches for routes in the specified local gateway route table.

See also: AWS API Documentation

Request Syntax

response = client.search_local_gateway_routes(
    LocalGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• LocalGatewayRouteTableId (string) –

  [REQUIRED]

  The ID of the local gateway route table.

• Filters (list) –

  One or more filters.

  • 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.

  • type - The route type.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Routes': [
        {
            'DestinationCidrBlock': 'string',
            'LocalGatewayVirtualInterfaceGroupId': 'string',
            'Type': 'static'|'propagated',
            'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
            'LocalGatewayRouteTableId': 'string',
            'LocalGatewayRouteTableArn': 'string',
            'OwnerId': 'string',
            'SubnetId': 'string',
            'CoipPoolId': 'string',
            'NetworkInterfaceId': 'string',
            'DestinationPrefixListId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Routes (list) –

    Information about the routes.

    • (dict) –

      Describes a route for a local gateway route table.

      • DestinationCidrBlock (string) –

        The CIDR block used for destination matches.

      • LocalGatewayVirtualInterfaceGroupId (string) –

        The ID of the virtual interface group.

      • Type (string) –

        The route type.

      • State (string) –

        The state of the route.

      • LocalGatewayRouteTableId (string) –

        The ID of the local gateway route table.

      • LocalGatewayRouteTableArn (string) –

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

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the local gateway route.

      • SubnetId (string) –

        The ID of the subnet.

      • CoipPoolId (string) –

        The ID of the customer-owned address pool.

      • NetworkInterfaceId (string) –

        The ID of the network interface.

      • DestinationPrefixListId (string) –

        The ID of the prefix list.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.