Skip to content

EC2  >  Operations  >  describe_local_gateways

describe_local_gateways

Operation

describe_local_gateways async

describe_local_gateways(request: DescribeLocalGatewaysInput | DescribeLocalGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeLocalGatewaysOutput
describe_local_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeLocalGatewaysInputDict]) -> DescribeLocalGatewaysOutput

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeLocalGatewaysOutput

An instance of DescribeLocalGatewaysOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeLocalGatewaysInput dataclass

Bases: _SerdeShape

Dataclass for DescribeLocalGatewaysInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

local_gateway_ids class-attribute instance-attribute
local_gateway_ids: list[str] | None = ...

The IDs of the local gateways.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

Dictionaries

DescribeLocalGatewaysInputDict

Bases: TypedDict

Dictionary form of DescribeLocalGatewaysInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

local_gateway_ids instance-attribute
local_gateway_ids: Sequence[str] | None

The IDs of the local gateways.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

The token for the next page of results.

Output

DescribeLocalGatewaysOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeLocalGatewaysOutput structure.

Attributes

local_gateways class-attribute instance-attribute
local_gateways: list[LocalGateway] | None = ...

Information about the local gateways.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.