Skip to content

EC2  >  Operations  >  get_vpn_tunnel_replacement_status

get_vpn_tunnel_replacement_status

Operation

get_vpn_tunnel_replacement_status async

get_vpn_tunnel_replacement_status(request: GetVpnTunnelReplacementStatusInput | GetVpnTunnelReplacementStatusInputDict, /, *, plugins: list[Plugin] | None = None) -> GetVpnTunnelReplacementStatusOutput
get_vpn_tunnel_replacement_status(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetVpnTunnelReplacementStatusInputDict]) -> GetVpnTunnelReplacementStatusOutput

Get details of available tunnel endpoint maintenance.

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
GetVpnTunnelReplacementStatusOutput

An instance of GetVpnTunnelReplacementStatusOutput.

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

GetVpnTunnelReplacementStatusInput dataclass

Bases: _SerdeShape

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

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

The ID of the Site-to-Site VPN connection.

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

The external IP address of the VPN tunnel.

Dictionaries

GetVpnTunnelReplacementStatusInputDict

Bases: TypedDict

Dictionary form of GetVpnTunnelReplacementStatusInput.

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.

vpn_connection_id instance-attribute
vpn_connection_id: Required[str]

The ID of the Site-to-Site VPN connection.

vpn_tunnel_outside_ip_address instance-attribute
vpn_tunnel_outside_ip_address: Required[str]

The external IP address of the VPN tunnel.

Output

GetVpnTunnelReplacementStatusOutput dataclass

Bases: _SerdeShape

Dataclass for GetVpnTunnelReplacementStatusOutput structure.

Attributes

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

The ID of the customer gateway.

maintenance_details class-attribute instance-attribute
maintenance_details: MaintenanceDetails | None = ...

Get details of pending tunnel endpoint maintenance.

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.

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

The ID of the transit gateway associated with the VPN connection.

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

The ID of the Site-to-Site VPN connection.

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

The ID of the virtual private gateway.

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

The external IP address of the VPN tunnel.