CustomerProfiles / Client / get_segment_estimate

get_segment_estimate#

CustomerProfiles.Client.get_segment_estimate(**kwargs)#

Gets the result of a segment estimate query.

See also: AWS API Documentation

Request Syntax

response = client.get_segment_estimate(
    DomainName='string',
    EstimateId='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • EstimateId (string) –

    [REQUIRED]

    The query Id passed by a previous CreateSegmentEstimate operation.

Return type:

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