EC2 / Client / get_active_vpn_tunnel_status

get_active_vpn_tunnel_status

EC2.Client.get_active_vpn_tunnel_status(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_active_vpn_tunnel_status(
    VpnConnectionId='string',
    VpnTunnelOutsideIpAddress='string',
    DryRun=True|False
)
Parameters:

  • VpnConnectionId (string) –

    [REQUIRED]

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

  • VpnTunnelOutsideIpAddress (string) –

    [REQUIRED]

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

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request.

Return type:

dict

Returns:

Response Syntax

{
    'ActiveVpnTunnelStatus': {
        'Phase1EncryptionAlgorithm': 'string',
        'Phase2EncryptionAlgorithm': 'string',
        'Phase1IntegrityAlgorithm': 'string',
        'Phase2IntegrityAlgorithm': 'string',
        'Phase1DHGroup': 123,
        'Phase2DHGroup': 123,
        'IkeVersion': 'string',
        'ProvisioningStatus': 'available'|'pending'|'failed',
        'ProvisioningStatusReason': 'string'
    }
}

Response Structure

  • (dict) –

    • ActiveVpnTunnelStatus (dict) –

      Information about the current security configuration of the VPN tunnel.

      • Phase1EncryptionAlgorithm (string) –

        The encryption algorithm negotiated in Phase 1 IKE negotiations.

      • Phase2EncryptionAlgorithm (string) –

        The encryption algorithm negotiated in Phase 2 IKE negotiations.

      • Phase1IntegrityAlgorithm (string) –

        The integrity algorithm negotiated in Phase 1 IKE negotiations.

      • Phase2IntegrityAlgorithm (string) –

        The integrity algorithm negotiated in Phase 2 IKE negotiations.

      • Phase1DHGroup (integer) –

        The Diffie-Hellman group number being used in Phase 1 IKE negotiations.

      • Phase2DHGroup (integer) –

        The Diffie-Hellman group number being used in Phase 2 IKE negotiations.

      • IkeVersion (string) –

        The version of the Internet Key Exchange (IKE) protocol being used.

      • ProvisioningStatus (string) –

        The current provisioning status of the VPN tunnel.

      • ProvisioningStatusReason (string) –

        The reason for the current provisioning status.