Skip to content

Describe Local Gateways

ec2_describe_local_gateways R Documentation

Describes one or more 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(LocalGatewayIds, Filters, MaxResults,
  NextToken, DryRun)

Arguments

LocalGatewayIds

The IDs of the local gateways.

Filters

One or more filters.

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

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

  • state - The state of the association.

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(
  LocalGateways = list(
    list(
      LocalGatewayId = "string",
      OutpostArn = "string",
      OwnerId = "string",
      State = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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