:doc:`GuardDuty <../../guardduty>` / Client / get_ip_set

**********
get_ip_set
**********



.. py:method:: GuardDuty.Client.get_ip_set(**kwargs)

  

  Retrieves the IPSet specified by the ``ipSetId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetIPSet>`_  


  **Request Syntax**
  ::

    response = client.get_ip_set(
        DetectorId='string',
        IpSetId='string'
    )
    
  :type DetectorId: string
  :param DetectorId: **[REQUIRED]** 

    The unique ID of the detector that is associated with the IPSet.

     

    To find the ``detectorId`` in the current Region, see the Settings page in the GuardDuty console, or run the `ListDetectors <https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html>`__ API.

    

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

    The unique ID of the IPSet to retrieve.

    

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

    
    ::

      {
          'Name': 'string',
          'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
          'Location': 'string',
          'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED',
          'Tags': {
              'string': 'string'
          },
          'ExpectedBucketOwner': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Name** *(string) --* 

        The user-friendly name for the IPSet.

        
      

      - **Format** *(string) --* 

        The format of the file that contains the IPSet.

        
      

      - **Location** *(string) --* 

        The URI of the file that contains the IPSet.

        
      

      - **Status** *(string) --* 

        The status of IPSet file that was uploaded.

        
      

      - **Tags** *(dict) --* 

        The tags of the IPSet resource.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **ExpectedBucketOwner** *(string) --* 

        The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the **location** parameter. This field appears in the response only if it was provided during IPSet creation or update.

        
  
  **Exceptions**
  
  *   :py:class:`GuardDuty.Client.exceptions.BadRequestException`

  
  *   :py:class:`GuardDuty.Client.exceptions.InternalServerErrorException`

  