modify_client_vpn_endpoint_authorization_policy¶
Operation¶
modify_client_vpn_endpoint_authorization_policy
¶
modify_client_vpn_endpoint_authorization_policy(request: ModifyClientVpnEndpointAuthorizationPolicyInput | ModifyClientVpnEndpointAuthorizationPolicyInputDict | None = None, /, *, 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 |
|---|---|---|---|
request
|
ModifyClientVpnEndpointAuthorizationPolicyInput | ModifyClientVpnEndpointAuthorizationPolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ModifyClientVpnEndpointAuthorizationPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyClientVpnEndpointAuthorizationPolicyOutput
|
An instance of |
modify_client_vpn_endpoint_authorization_policy
async
¶
modify_client_vpn_endpoint_authorization_policy(request: ModifyClientVpnEndpointAuthorizationPolicyInput | ModifyClientVpnEndpointAuthorizationPolicyInputDict | None = None, /, *, 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 |
|---|---|---|---|
request
|
ModifyClientVpnEndpointAuthorizationPolicyInput | ModifyClientVpnEndpointAuthorizationPolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ModifyClientVpnEndpointAuthorizationPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyClientVpnEndpointAuthorizationPolicyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
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
¶
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.
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.
Output¶
ModifyClientVpnEndpointAuthorizationPolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyClientVpnEndpointAuthorizationPolicyOutput structure.