get_client_vpn_endpoint_authorization_policy¶
Operation¶
get_client_vpn_endpoint_authorization_policy
async
¶
get_client_vpn_endpoint_authorization_policy(request: GetClientVpnEndpointAuthorizationPolicyInput | GetClientVpnEndpointAuthorizationPolicyInputDict, /, *, plugins: list[Plugin] | None = None) -> GetClientVpnEndpointAuthorizationPolicyOutput
get_client_vpn_endpoint_authorization_policy(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetClientVpnEndpointAuthorizationPolicyInputDict]) -> GetClientVpnEndpointAuthorizationPolicyOutput
Describes the authorization policy for a Client VPN endpoint.
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 |
|---|---|
GetClientVpnEndpointAuthorizationPolicyOutput
|
An instance of |
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¶
GetClientVpnEndpointAuthorizationPolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetClientVpnEndpointAuthorizationPolicyInput structure.
Attributes¶
client_vpn_endpoint_id
class-attribute
instance-attribute
¶
client_vpn_endpoint_id: str | None = ...
The ID of the Client VPN endpoint.
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.
Dictionaries¶
GetClientVpnEndpointAuthorizationPolicyInputDict
¶
Bases: TypedDict
Dictionary form of GetClientVpnEndpointAuthorizationPolicyInput.
Attributes¶
client_vpn_endpoint_id
instance-attribute
¶
The ID of the Client VPN endpoint.
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.
Output¶
GetClientVpnEndpointAuthorizationPolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetClientVpnEndpointAuthorizationPolicyOutput structure.
Attributes¶
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.
policy_document
class-attribute
instance-attribute
¶
policy_document: str | None = ...
The authorization policy document, written in the Cedar policy language.
response_metadata
class-attribute
instance-attribute
¶
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.
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.