CustomerProfiles / Client / list_calculated_attribute_definitions

list_calculated_attribute_definitions

CustomerProfiles.Client.list_calculated_attribute_definitions(**kwargs)

Lists calculated attribute definitions for Customer Profiles

See also: AWS API Documentation

Request Syntax

response = client.list_calculated_attribute_definitions(
    DomainName='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• NextToken (string) – The pagination token from the previous call to ListCalculatedAttributeDefinitions.

• MaxResults (integer) – The maximum number of calculated attribute definitions returned per page.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'CalculatedAttributeName': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'UseHistoricalData': True|False,
            'Status': 'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Items (list) –

    The list of calculated attribute definitions.

    • (dict) –

      The details of a single calculated attribute definition.

      • CalculatedAttributeName (string) –

        The unique name of the calculated attribute.

      • DisplayName (string) –

        The display name of the calculated attribute.

      • Description (string) –

        The threshold for the calculated attribute.

      • CreatedAt (datetime) –

        The threshold for the calculated attribute.

      • LastUpdatedAt (datetime) –

        The timestamp of when the calculated attribute definition was most recently edited.

      • UseHistoricalData (boolean) –

        Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

      • Status (string) –

        Status of the Calculated Attribute creation (whether all historical data has been indexed.)

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    The pagination token from the previous call to ListCalculatedAttributeDefinitions.

Exceptions

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.AccessDeniedException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.InternalServerException