describe_client_vpn_authorization_rules¶
Operation¶
describe_client_vpn_authorization_rules
async
¶
describe_client_vpn_authorization_rules(request: DescribeClientVpnAuthorizationRulesInput | DescribeClientVpnAuthorizationRulesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeClientVpnAuthorizationRulesOutput
describe_client_vpn_authorization_rules(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnAuthorizationRulesInputDict]) -> DescribeClientVpnAuthorizationRulesOutput
Describes the authorization rules for a specified 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 |
|---|---|
DescribeClientVpnAuthorizationRulesOutput
|
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¶
DescribeClientVpnAuthorizationRulesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeClientVpnAuthorizationRulesInput 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.
filters
class-attribute
instance-attribute
¶
One or more filters. Filter names and values are case-sensitive.
-
description- The description of the authorization rule. -
destination-cidr- The CIDR of the network to which the authorization rule applies. -
group-id- The ID of the Active Directory group to which the authorization rule grants access.
Dictionaries¶
DescribeClientVpnAuthorizationRulesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeClientVpnAuthorizationRulesInput.
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
One or more filters. Filter names and values are case-sensitive.
-
description- The description of the authorization rule. -
destination-cidr- The CIDR of the network to which the authorization rule applies. -
group-id- The ID of the Active Directory group to which the authorization rule grants access.
Output¶
DescribeClientVpnAuthorizationRulesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeClientVpnAuthorizationRulesOutput structure.
Attributes¶
authorization_rules
class-attribute
instance-attribute
¶
authorization_rules: list[AuthorizationRule] | None = ...
Information about the authorization rules.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
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.