Skip to content

EC2  >  Operations  >  describe_local_gateway_virtual_interface_groups

describe_local_gateway_virtual_interface_groups

Operation

describe_local_gateway_virtual_interface_groups async 

describe_local_gateway_virtual_interface_groups(input: DescribeLocalGatewayVirtualInterfaceGroupsInput, plugins: list[Plugin] | None = None) -> DescribeLocalGatewayVirtualInterfaceGroupsOutput

Describes the specified local gateway virtual interface groups.

Parameters:

Name Type Description Default
input DescribeLocalGatewayVirtualInterfaceGroupsInput

An instance of DescribeLocalGatewayVirtualInterfaceGroupsInput.

 required
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
DescribeLocalGatewayVirtualInterfaceGroupsOutput

An instance of DescribeLocalGatewayVirtualInterfaceGroupsOutput.

Input

DescribeLocalGatewayVirtualInterfaceGroupsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeLocalGatewayVirtualInterfaceGroupsInput 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.

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

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

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

The IDs of the virtual interface groups.

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.

Output

DescribeLocalGatewayVirtualInterfaceGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeLocalGatewayVirtualInterfaceGroupsOutput structure.

Attributes

local_gateway_virtual_interface_groups class-attribute instance-attribute 
local_gateway_virtual_interface_groups: list[LocalGatewayVirtualInterfaceGroup] | None = ...

The virtual interface groups.

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.