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

****************************
authorize_client_vpn_ingress
****************************



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

  

  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.

  

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


  **Request Syntax**
  ::

    response = client.authorize_client_vpn_ingress(
        ClientVpnEndpointId='string',
        TargetNetworkCidr='string',
        AccessGroupId='string',
        AuthorizeAllGroups=True|False,
        Description='string',
        ClientToken='string',
        DryRun=True|False
    )
    
  :type ClientVpnEndpointId: string
  :param ClientVpnEndpointId: **[REQUIRED]** 

    The ID of the Client VPN endpoint.

    

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

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

    

  
  :type AccessGroupId: string
  :param AccessGroupId: 

    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.

    

  
  :type AuthorizeAllGroups: boolean
  :param AuthorizeAllGroups: 

    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.

    

  
  :type Description: string
  :param Description: 

    A brief description of the authorization rule.

    

  
  :type ClientToken: string
  :param ClientToken: 

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html>`__.

    This field is autopopulated if not provided.

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

          
    
  