:doc:`CustomerProfiles <../../customer-profiles>` / Client / get_segment_estimate

********************
get_segment_estimate
********************



.. py:method:: CustomerProfiles.Client.get_segment_estimate(**kwargs)

  

  Gets the result of a segment estimate query.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentEstimate>`_  


  **Request Syntax**
  ::

    response = client.get_segment_estimate(
        DomainName='string',
        EstimateId='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

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

    The query Id passed by a previous ``CreateSegmentEstimate`` operation.

    

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

    
    ::

      {
          'DomainName': 'string',
          'EstimateId': 'string',
          'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
          'Estimate': 'string',
          'Message': 'string',
          'StatusCode': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DomainName** *(string) --* 

        The unique name of the domain.

        
      

      - **EstimateId** *(string) --* 

        The ``QueryId`` which is the same as the value passed in ``QueryId``.

        
      

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

        The current status of the query.

        
      

      - **Estimate** *(string) --* 

        The estimated number of profiles contained in the segment.

        
      

      - **Message** *(string) --* 

        The error message if there is any error.

        
      

      - **StatusCode** *(integer) --* 

        The status code of the segment estimate.

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

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

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

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

  
  *   :py:class:`CustomerProfiles.Client.exceptions.InternalServerException`

  