revoke_client_vpn_ingress¶
Operation¶
revoke_client_vpn_ingress
¶
revoke_client_vpn_ingress(request: RevokeClientVpnIngressInput | RevokeClientVpnIngressInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RevokeClientVpnIngressInputDict]) -> RevokeClientVpnIngressOutput
Removes an ingress authorization rule from a Client VPN endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RevokeClientVpnIngressInput | RevokeClientVpnIngressInputDict | 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[RevokeClientVpnIngressInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RevokeClientVpnIngressOutput
|
An instance of |
revoke_client_vpn_ingress
async
¶
revoke_client_vpn_ingress(request: RevokeClientVpnIngressInput | RevokeClientVpnIngressInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RevokeClientVpnIngressInputDict]) -> RevokeClientVpnIngressOutput
Removes an ingress authorization rule from a Client VPN endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RevokeClientVpnIngressInput | RevokeClientVpnIngressInputDict | 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[RevokeClientVpnIngressInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RevokeClientVpnIngressOutput
|
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.
RevokeClientVpnIngressInputDict
¶
Bases: TypedDict
Dictionary form of RevokeClientVpnIngressInput.
Attributes¶
access_group_id
instance-attribute
¶
access_group_id: str | None
The ID of the Active Directory group for which to revoke access.
client_vpn_endpoint_id
instance-attribute
¶
The ID of the Client VPN endpoint with which the authorization rule is associated.
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.
revoke_all_groups
instance-attribute
¶
revoke_all_groups: bool | None
Indicates whether access should be revoked for all groups for a single
TargetNetworkCidr that earlier authorized ingress for all groups using
AuthorizeAllGroups. This does not impact other authorization rules
that allowed ingress to the same TargetNetworkCidr with a specific
AccessGroupId.
RevokeClientVpnIngressInput
dataclass
¶
Bases: _SerdeShape
Dataclass for RevokeClientVpnIngressInput structure.
Attributes¶
access_group_id
class-attribute
instance-attribute
¶
access_group_id: str | None = ...
The ID of the Active Directory group for which to revoke access.
client_vpn_endpoint_id
class-attribute
instance-attribute
¶
client_vpn_endpoint_id: str | None = ...
The ID of the Client VPN endpoint with which the authorization rule is associated.
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.
revoke_all_groups
class-attribute
instance-attribute
¶
revoke_all_groups: bool | None = ...
Indicates whether access should be revoked for all groups for a single
TargetNetworkCidr that earlier authorized ingress for all groups using
AuthorizeAllGroups. This does not impact other authorization rules
that allowed ingress to the same TargetNetworkCidr with a specific
AccessGroupId.
Output¶
RevokeClientVpnIngressOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for RevokeClientVpnIngressOutput structure.
Attributes¶
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.
status
class-attribute
instance-attribute
¶
status: ClientVpnAuthorizationRuleStatus | None = ...
The current state of the authorization rule.