Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-171,1822,9897.4 MB

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

get/#Action=DescribeLocalGateways

Query parameters

LocalGatewayIdstring[]

The IDs of the local gateways.

Namestring

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

Valuesstring[]

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

<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> </ul>
MaxResultsinteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.

NextTokenstring

The token for the next page of results.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Action'DescribeLocalGateways' required
Version'2016-11-15' required

Response

Success