:doc:`EC2 <../../ec2>` / Client / revoke_client_vpn_ingress

*************************
revoke_client_vpn_ingress
*************************



.. py:method:: EC2.Client.revoke_client_vpn_ingress(**kwargs)

  

  Removes an ingress authorization rule from a Client VPN endpoint.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/RevokeClientVpnIngress>`_  


  **Request Syntax**
  ::

    response = client.revoke_client_vpn_ingress(
        ClientVpnEndpointId='string',
        TargetNetworkCidr='string',
        AccessGroupId='string',
        RevokeAllGroups=True|False,
        DryRun=True|False
    )
    
  :type ClientVpnEndpointId: string
  :param ClientVpnEndpointId: **[REQUIRED]** 

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

    

  
  :type TargetNetworkCidr: string
  :param TargetNetworkCidr: **[REQUIRED]** 

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

    

  
  :type AccessGroupId: string
  :param AccessGroupId: 

    The ID of the Active Directory group for which to revoke access.

    

  
  :type RevokeAllGroups: boolean
  :param RevokeAllGroups: 

    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``.

    

  
  :type DryRun: boolean
  :param DryRun: 

    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``.

    

  
  
  :rtype: 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.

          
    
  