:doc:`QuickSight <../../quicksight>` / Client / describe_ip_restriction

***********************
describe_ip_restriction
***********************



.. py:method:: QuickSight.Client.describe_ip_restriction(**kwargs)

  

  Provides a summary and status of IP rules.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestriction>`_  


  **Request Syntax**
  ::

    response = client.describe_ip_restriction(
        AwsAccountId='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that contains the IP rules.

    

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

    
    ::

      {
          'AwsAccountId': 'string',
          'IpRestrictionRuleMap': {
              'string': 'string'
          },
          'VpcIdRestrictionRuleMap': {
              'string': 'string'
          },
          'VpcEndpointIdRestrictionRuleMap': {
              'string': 'string'
          },
          'Enabled': True|False,
          'RequestId': 'string',
          'Status': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AwsAccountId** *(string) --* 

        The ID of the Amazon Web Services account that contains the IP rules.

        
      

      - **IpRestrictionRuleMap** *(dict) --* 

        A map that describes the IP rules with CIDR range and description.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **VpcIdRestrictionRuleMap** *(dict) --* 

        A map of allowed VPC IDs and their rule descriptions.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **VpcEndpointIdRestrictionRuleMap** *(dict) --* 

        A map of allowed VPC endpoint IDs and their rule descriptions.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **Enabled** *(boolean) --* 

        A value that specifies whether IP rules are turned on.

        
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status of the request.

        
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

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

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

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  