ec2_describe_local_gateways {aws.ecx}

Describe Local Gateways

Description

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

Usage

ec2_describe_local_gateways(
  LocalGatewayId = NULL,
  Filter = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  DryRun = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

LocalGatewayId

List. One or more filters.[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of results to return with a single call.[optional]

NextToken

Characters. The token for the next page of results[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

LocalGatewayId

One or more filters.

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

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

• local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.

• local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.

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

• state - The state of the association.

Filter

One or more filters.

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.

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.