authorize_client_vpn_ingress¶
Operation¶
authorize_client_vpn_ingress
async
¶
authorize_client_vpn_ingress(request: AuthorizeClientVpnIngressInput | AuthorizeClientVpnIngressInputDict, /, *, plugins: list[Plugin] | None = None) -> AuthorizeClientVpnIngressOutput
authorize_client_vpn_ingress(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AuthorizeClientVpnIngressInputDict]) -> AuthorizeClientVpnIngressOutput
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
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 |
|---|---|
AuthorizeClientVpnIngressOutput
|
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¶
AuthorizeClientVpnIngressInput
dataclass
¶
Bases: _SerdeShape
Dataclass for AuthorizeClientVpnIngressInput structure.
Attributes¶
access_group_id
class-attribute
instance-attribute
¶
access_group_id: str | None = ...
The ID of the group to grant access to, for example, the Active
Directory group or identity provider (IdP) group. Required if
AuthorizeAllGroups is false or not specified.
authorize_all_groups
class-attribute
instance-attribute
¶
authorize_all_groups: bool | None = ...
Indicates whether to grant access to all clients. Specify true to
grant all clients who successfully establish a VPN connection access to
the network. Must be set to true if AccessGroupId is not specified.
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 rule.
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¶
AuthorizeClientVpnIngressInputDict
¶
Bases: TypedDict
Dictionary form of AuthorizeClientVpnIngressInput.
Attributes¶
access_group_id
instance-attribute
¶
access_group_id: str | None
The ID of the group to grant access to, for example, the Active
Directory group or identity provider (IdP) group. Required if
AuthorizeAllGroups is false or not specified.
authorize_all_groups
instance-attribute
¶
authorize_all_groups: bool | None
Indicates whether to grant access to all clients. Specify true to
grant all clients who successfully establish a VPN connection access to
the network. Must be set to true if AccessGroupId is not specified.
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 rule.
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¶
AuthorizeClientVpnIngressOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AuthorizeClientVpnIngressOutput 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.