Skip to content

EC2  >  Operations  >  get_active_vpn_tunnel_status

get_active_vpn_tunnel_status

Operation

get_active_vpn_tunnel_status async

get_active_vpn_tunnel_status(request: GetActiveVpnTunnelStatusInput | GetActiveVpnTunnelStatusInputDict, /, *, plugins: list[Plugin] | None = None) -> GetActiveVpnTunnelStatusOutput
get_active_vpn_tunnel_status(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetActiveVpnTunnelStatusInputDict]) -> GetActiveVpnTunnelStatusOutput

Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.

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
GetActiveVpnTunnelStatusOutput

An instance of GetActiveVpnTunnelStatusOutput.

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

GetActiveVpnTunnelStatusInput dataclass

Bases: _SerdeShape

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

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

The ID of the VPN connection for which to retrieve the active tunnel status.

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

The external IP address of the VPN tunnel for which to retrieve the active status.

Dictionaries

GetActiveVpnTunnelStatusInputDict

Bases: TypedDict

Dictionary form of GetActiveVpnTunnelStatusInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request.

vpn_connection_id instance-attribute
vpn_connection_id: Required[str]

The ID of the VPN connection for which to retrieve the active tunnel status.

vpn_tunnel_outside_ip_address instance-attribute
vpn_tunnel_outside_ip_address: Required[str]

The external IP address of the VPN tunnel for which to retrieve the active status.

Output

GetActiveVpnTunnelStatusOutput dataclass

Bases: _SerdeShape

Dataclass for GetActiveVpnTunnelStatusOutput structure.

Attributes

active_vpn_tunnel_status class-attribute instance-attribute
active_vpn_tunnel_status: ActiveVpnTunnelStatus | None = ...

Information about the current security configuration of the VPN tunnel.

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.