Request Parameters Response Elements Errors See Also

DescribeLocalGateways

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

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.

Type: Boolean

Required: No

Filter.N

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 AWS account that owns the local gateway.
state - The state of the association.

Type: Array of Filter objects

Required: No

LocalGatewayId.N

The IDs of the local gateways.

Type: Array of strings

Required: No

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.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 1000.

Required: No

NextToken

The token for the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

localGatewaySet

Information about the local gateways.

Type: Array of LocalGateway objects

nextToken

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

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.