EC2 / Client / get_client_vpn_endpoint_authorization_policy

get_client_vpn_endpoint_authorization_policy

EC2.Client.get_client_vpn_endpoint_authorization_policy(**kwargs)

Describes the authorization policy for a Client VPN endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_client_vpn_endpoint_authorization_policy(
    ClientVpnEndpointId='string',
    DryRun=True|False
)

Parameters:

• ClientVpnEndpointId (string) –

  [REQUIRED]

  The ID of the Client VPN endpoint.

• DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ClientVpnEndpointId': 'string',
    'PolicyDocument': 'string',
    'Description': 'string',
    'ShadowMode': 'enabled'|'disabled',
    'Status': 'creating'|'updating'|'active'|'failed'|'deleting'
}

Response Structure

• (dict) –

  • ClientVpnEndpointId (string) –

    The ID of the Client VPN endpoint.

  • PolicyDocument (string) –

    The authorization policy document, written in the Cedar policy language.

  • Description (string) –

    A brief description of the authorization policy.

  • ShadowMode (string) –

    Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:

    • enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.

    • disabled - The authorization policy is enforced.

  • Status (string) –

    The current state of the authorization policy.