EC2 / Client / revoke_client_vpn_ingress

revoke_client_vpn_ingress#

EC2.Client.revoke_client_vpn_ingress(**kwargs)#

Removes an ingress authorization rule from a Client VPN endpoint.

See also: AWS API Documentation

Request Syntax

response = client.revoke_client_vpn_ingress(
    ClientVpnEndpointId='string',
    TargetNetworkCidr='string',
    AccessGroupId='string',
    RevokeAllGroups=True|False,
    DryRun=True|False
)
Parameters:

  • ClientVpnEndpointId (string) –

    [REQUIRED]

    The ID of the Client VPN endpoint with which the authorization rule is associated.

  • TargetNetworkCidr (string) –

    [REQUIRED]

    The IPv4 address range, in CIDR notation, of the network for which access is being removed.

  • AccessGroupId (string) – The ID of the Active Directory group for which to revoke access.

  • RevokeAllGroups (boolean) – 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.

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Status': {
        'Code': 'authorizing'|'active'|'failed'|'revoking',
        'Message': 'string'
    }
}

Response Structure

  • (dict) –

    • Status (dict) –

      The current state of the authorization rule.

      • Code (string) –

        The state of the authorization rule.

      • Message (string) –

        A message about the status of the authorization rule, if applicable.