Skip to content

Search Local Gateway Routes

ec2_search_local_gateway_routes R Documentation

Searches for routes in the specified local gateway route table

Description

Searches for routes in the specified local gateway route table.

Usage

ec2_search_local_gateway_routes(LocalGatewayRouteTableId, Filters,
  MaxResults, NextToken, DryRun)

Arguments

LocalGatewayRouteTableId

[required] The ID of the local gateway route table.
Filters

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

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

The token for the next page of results.
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.

Value

A list with the following syntax:

list(
  Routes = list(
    list(
      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"
)

Request syntax

svc$search_local_gateway_routes(
  LocalGatewayRouteTableId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)