Skip to content

EC2  >  Operations  >  describe_service_link_virtual_interfaces

describe_service_link_virtual_interfaces

Operation

describe_service_link_virtual_interfaces(request: DescribeServiceLinkVirtualInterfacesInput | DescribeServiceLinkVirtualInterfacesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeServiceLinkVirtualInterfacesOutput
describe_service_link_virtual_interfaces(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeServiceLinkVirtualInterfacesInputDict]) -> DescribeServiceLinkVirtualInterfacesOutput

Describes the Outpost service link 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
DescribeServiceLinkVirtualInterfacesOutput

An instance of DescribeServiceLinkVirtualInterfacesOutput.

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

DescribeServiceLinkVirtualInterfacesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeServiceLinkVirtualInterfacesInput 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 = ...

The filters to use for narrowing down the request. The following filters are supported:

  • outpost-lag-id - The ID of the Outpost LAG.

  • outpost-arn - The Outpost ARN.

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

  • state - The state of the Outpost LAG.

  • vlan - The ID of the address pool.

  • service-link-virtual-interface-id - The ID of the service link virtual interface.

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

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.

service_link_virtual_interface_ids: list[str] | None = ...

The IDs of the service link virtual interfaces.

Dictionaries

DescribeServiceLinkVirtualInterfacesInputDict

Bases: TypedDict

Dictionary form of DescribeServiceLinkVirtualInterfacesInput.

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

The filters to use for narrowing down the request. The following filters are supported:

  • outpost-lag-id - The ID of the Outpost LAG.

  • outpost-arn - The Outpost ARN.

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

  • state - The state of the Outpost LAG.

  • vlan - The ID of the address pool.

  • service-link-virtual-interface-id - The ID of the service link virtual interface.

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

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.

service_link_virtual_interface_ids: Sequence[str] | None

The IDs of the service link virtual interfaces.

Output

DescribeServiceLinkVirtualInterfacesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeServiceLinkVirtualInterfacesOutput structure.

Attributes

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.

service_link_virtual_interfaces: list[ServiceLinkVirtualInterface] | None = ...

Describes the service link virtual interfaces.