Skip to content

EC2  >  Operations  >  describe_local_gateway_virtual_interfaces

describe_local_gateway_virtual_interfaces

Operation

describe_local_gateway_virtual_interfaces async

describe_local_gateway_virtual_interfaces(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeLocalGatewayVirtualInterfacesInputDict]) -> DescribeLocalGatewayVirtualInterfacesOutput

Describes the specified local gateway virtual interfaces.

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
DescribeLocalGatewayVirtualInterfacesOutput

An instance of DescribeLocalGatewayVirtualInterfacesOutput.

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

DescribeLocalGatewayVirtualInterfacesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeLocalGatewayVirtualInterfacesInput 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-address - The local address.

  • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

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

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

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.

  • peer-address - The peer address.

  • peer-bgp-asn - The peer BGP ASN.

  • vlan - The ID of the VLAN.

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

The IDs of the virtual interfaces.

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

DescribeLocalGatewayVirtualInterfacesInputDict

Bases: TypedDict

Dictionary form of DescribeLocalGatewayVirtualInterfacesInput.

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-address - The local address.

  • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

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

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

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.

  • peer-address - The peer address.

  • peer-bgp-asn - The peer BGP ASN.

  • vlan - The ID of the VLAN.

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

The IDs of the virtual interfaces.

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

DescribeLocalGatewayVirtualInterfacesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeLocalGatewayVirtualInterfacesOutput structure.

Attributes

local_gateway_virtual_interfaces class-attribute instance-attribute
local_gateway_virtual_interfaces: list[LocalGatewayVirtualInterface] | None = ...

Information about the virtual interfaces.

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.