CustomerProfiles / Client / get_calculated_attribute_definition

get_calculated_attribute_definition#

CustomerProfiles.Client.get_calculated_attribute_definition(**kwargs)#

Provides more information on a calculated attribute definition for Customer Profiles.

Request Syntax

response = client.get_calculated_attribute_definition(
    DomainName='string',
    CalculatedAttributeName='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
CalculatedAttributeName (string) –
[REQUIRED]

The unique name of the calculated attribute.

Return type:

dict

Returns:

Response Syntax

{
    'CalculatedAttributeName': 'string',
    'DisplayName': 'string',
    'Description': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Statistic': 'FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
    'Conditions': {
        'Range': {
            'Value': 123,
            'Unit': 'DAYS'
        },
        'ObjectCount': 123,
        'Threshold': {
            'Value': 'string',
            'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
        }
    },
    'AttributeDetails': {
        'Attributes': [
            {
                'Name': 'string'
            },
        ],
        'Expression': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- CalculatedAttributeName (string) –
  
  The unique name of the calculated attribute.
- DisplayName (string) –
  
  The display name of the calculated attribute.
- Description (string) –
  
  The description of the calculated attribute.
- CreatedAt (datetime) –
  
  The timestamp of when the calculated attribute definition was created.
- LastUpdatedAt (datetime) –
  
  The timestamp of when the calculated attribute definition was most recently edited.
- Statistic (string) –
  
  The aggregation operation to perform for the calculated attribute.
- Conditions (dict) –
  
  The conditions including range, object count, and threshold for the calculated attribute.
  - Range (dict) –
    
    The relative time period over which data is included in the aggregation.
    - Value (integer) –
      
      The amount of time of the specified unit.
    - Unit (string) –
      
      The unit of time.
  - ObjectCount (integer) –
    
    The number of profile objects used for the calculated attribute.
  - Threshold (dict) –
    
    The threshold for the calculated attribute.
    - Value (string) –
      
      The value of the threshold.
    - Operator (string) –
      
      The operator of the threshold.
- AttributeDetails (dict) –
  
  Mathematical expression and a list of attribute items specified in that expression.
  - Attributes (list) –
    
    A list of attribute items specified in the mathematical expression.
    - (dict) –
      
      The details of a single attribute item specified in the mathematical expression.
      - Name (string) –
        
        The name of an attribute defined in a profile object type.
  - Expression (string) –
    
    Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of "{ObjectTypeName.AttributeName}".
- Tags (dict) –
  
  The tags used to organize, track, or control access for this resource.
  - (string) –
    - (string) –

Exceptions

CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.AccessDeniedException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.InternalServerException