:doc:`WorkSpacesWeb <../../workspaces-web>` / Client / get_ip_access_settings

**********************
get_ip_access_settings
**********************



.. py:method:: WorkSpacesWeb.Client.get_ip_access_settings(**kwargs)

  

  Gets the IP access settings.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetIpAccessSettings>`_  


  **Request Syntax**
  ::

    response = client.get_ip_access_settings(
        ipAccessSettingsArn='string'
    )
    
  :type ipAccessSettingsArn: string
  :param ipAccessSettingsArn: **[REQUIRED]** 

    The ARN of the IP access settings.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ipAccessSettings': {
              'ipAccessSettingsArn': 'string',
              'associatedPortalArns': [
                  'string',
              ],
              'ipRules': [
                  {
                      'ipRange': 'string',
                      'description': 'string'
                  },
              ],
              'displayName': 'string',
              'description': 'string',
              'creationDate': datetime(2015, 1, 1),
              'customerManagedKey': 'string',
              'additionalEncryptionContext': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ipAccessSettings** *(dict) --* 

        The IP access settings.

        
        

        - **ipAccessSettingsArn** *(string) --* 

          The ARN of the IP access settings resource.

          
        

        - **associatedPortalArns** *(list) --* 

          A list of web portal ARNs that this IP access settings resource is associated with.

          
          

          - *(string) --* 
      
        

        - **ipRules** *(list) --* 

          The IP rules of the IP access settings.

          
          

          - *(dict) --* 

            The IP rules of the IP access settings.

            
            

            - **ipRange** *(string) --* 

              The IP range of the IP rule.

              
            

            - **description** *(string) --* 

              The description of the IP rule.

              
        
      
        

        - **displayName** *(string) --* 

          The display name of the IP access settings.

          
        

        - **description** *(string) --* 

          The description of the IP access settings.

          
        

        - **creationDate** *(datetime) --* 

          The creation date timestamp of the IP access settings.

          
        

        - **customerManagedKey** *(string) --* 

          The customer managed key used to encrypt sensitive information in the IP access settings.

          
        

        - **additionalEncryptionContext** *(dict) --* 

          The additional encryption context of the IP access settings.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.InternalServerException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ValidationException`

  