Skip to content

Create Calculated Attribute Definition

customerprofiles_create_calculated_attribute_definition R Documentation

Creates a new calculated attribute definition

Description

Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the get_calculated_attribute_for_profile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.

Usage

customerprofiles_create_calculated_attribute_definition(DomainName,
  CalculatedAttributeName, DisplayName, Description, AttributeDetails,
  Conditions, Statistic, Tags)

Arguments

DomainName

[required] The unique name of the domain.

CalculatedAttributeName

[required] The unique name of the calculated attribute.

DisplayName

The display name of the calculated attribute.

Description

The description of the calculated attribute.

AttributeDetails

[required] Mathematical expression and a list of attribute items specified in that expression.

Conditions

The conditions including range, object count, and threshold for the calculated attribute.

Statistic

[required] The aggregation operation to perform for the calculated attribute.

Tags

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

Value

A list with the following syntax: 

list(
  CalculatedAttributeName = "string",
  DisplayName = "string",
  Description = "string",
  AttributeDetails = list(
    Attributes = list(
      list(
        Name = "string"
      )
    ),
    Expression = "string"
  ),
  Conditions = list(
    Range = list(
      Value = 123,
      Unit = "DAYS"
    ),
    ObjectCount = 123,
    Threshold = list(
      Value = "string",
      Operator = "EQUAL_TO"|"GREATER_THAN"|"LESS_THAN"|"NOT_EQUAL_TO"
    )
  ),
  Statistic = "FIRST_OCCURRENCE"|"LAST_OCCURRENCE"|"COUNT"|"SUM"|"MINIMUM"|"MAXIMUM"|"AVERAGE"|"MAX_OCCURRENCE",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$create_calculated_attribute_definition(
  DomainName = "string",
  CalculatedAttributeName = "string",
  DisplayName = "string",
  Description = "string",
  AttributeDetails = list(
    Attributes = list(
      list(
        Name = "string"
      )
    ),
    Expression = "string"
  ),
  Conditions = list(
    Range = list(
      Value = 123,
      Unit = "DAYS"
    ),
    ObjectCount = 123,
    Threshold = list(
      Value = "string",
      Operator = "EQUAL_TO"|"GREATER_THAN"|"LESS_THAN"|"NOT_EQUAL_TO"
    )
  ),
  Statistic = "FIRST_OCCURRENCE"|"LAST_OCCURRENCE"|"COUNT"|"SUM"|"MINIMUM"|"MAXIMUM"|"AVERAGE"|"MAX_OCCURRENCE",
  Tags = list(
    "string"
  )
)