Skip to content

EC2  >  Operations  >  modify_client_vpn_endpoint_authorization_policy

modify_client_vpn_endpoint_authorization_policy

Operation

modify_client_vpn_endpoint_authorization_policy async

modify_client_vpn_endpoint_authorization_policy(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyClientVpnEndpointAuthorizationPolicyInputDict]) -> ModifyClientVpnEndpointAuthorizationPolicyOutput

Creates or updates the authorization policy for a Client VPN endpoint. A Client VPN endpoint can have one authorization policy. If a policy already exists for the endpoint, the values that you specify replace the corresponding values in the existing policy, and values that you do not specify remain unchanged.

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
ModifyClientVpnEndpointAuthorizationPolicyOutput

An instance of ModifyClientVpnEndpointAuthorizationPolicyOutput.

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

ModifyClientVpnEndpointAuthorizationPolicyInput dataclass

Bases: _SerdeShape

Dataclass for ModifyClientVpnEndpointAuthorizationPolicyInput structure.

Attributes
client_token class-attribute instance-attribute
client_token: str | None = ...

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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

The ID of the Client VPN endpoint.

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

A brief description of the authorization policy.

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.

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

The authorization policy document, written in the Cedar policy language. This parameter is required when you create the authorization policy for a Client VPN endpoint that does not already have one.

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

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.

The default value is disabled.

Dictionaries

ModifyClientVpnEndpointAuthorizationPolicyInputDict

Bases: TypedDict

Dictionary form of ModifyClientVpnEndpointAuthorizationPolicyInput.

Attributes
client_token instance-attribute
client_token: str | None

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

client_vpn_endpoint_id instance-attribute
client_vpn_endpoint_id: Required[str]

The ID of the Client VPN endpoint.

description instance-attribute
description: str | None

A brief description of the authorization policy.

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.

policy_document instance-attribute
policy_document: str | None

The authorization policy document, written in the Cedar policy language. This parameter is required when you create the authorization policy for a Client VPN endpoint that does not already have one.

shadow_mode instance-attribute
shadow_mode: str | None

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.

The default value is disabled.

Output

ModifyClientVpnEndpointAuthorizationPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyClientVpnEndpointAuthorizationPolicyOutput structure.

Attributes

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.

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

The current state of the authorization policy.