Skip to content

CreateCalculatedAttributeDefinitionRequest

Source code in docs_src/capo_customer_profiles/types/create_calculated_attribute_definition_request.py
class CreateCalculatedAttributeDefinitionRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    calculated_attribute_name: "capo_customer_profiles.types.type_name.typeName"
    """<p>The unique name of the calculated attribute.</p>"""
    display_name: NotRequired["capo_customer_profiles.types.display_name.displayName"]
    """<p>The display name of the calculated attribute.</p>"""
    description: NotRequired[
        "capo_customer_profiles.types.sensitive_text.sensitiveText"
    ]
    """<p>The description of the calculated attribute.</p>"""
    attribute_details: "capo_customer_profiles.types.attribute_details.AttributeDetails"
    """<p>Mathematical expression and a list of attribute items specified in that expression.</p>"""
    conditions: NotRequired["capo_customer_profiles.types.conditions.Conditions"]
    """<p>The conditions including range, object count, and threshold for the calculated attribute.</p>"""
    filter: NotRequired["capo_customer_profiles.types.filter.Filter"]
    """<p>Defines how to filter incoming objects to include part of the Calculated Attribute.</p>"""
    statistic: "capo_customer_profiles.types.statistic.Statistic"
    """<p>The aggregation operation to perform for the calculated attribute.</p>"""
    use_historical_data: NotRequired[
        "capo_customer_profiles.types.optional_boolean.optionalBoolean"
    ]
    """<p>Whether historical data ingested before the Calculated Attribute was created should be included in calculations.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

attribute_details instance-attribute

attribute_details: AttributeDetails

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

calculated_attribute_name instance-attribute

calculated_attribute_name: typeName

The unique name of the calculated attribute.

conditions instance-attribute

conditions: NotRequired[Conditions]

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

description instance-attribute

description: NotRequired[sensitiveText]

The description of the calculated attribute.

display_name instance-attribute

display_name: NotRequired[displayName]

The display name of the calculated attribute.

domain_name instance-attribute

domain_name: name

The unique name of the domain.

filter instance-attribute

filter: NotRequired[Filter]

Defines how to filter incoming objects to include part of the Calculated Attribute.

statistic instance-attribute

statistic: Statistic

The aggregation operation to perform for the calculated attribute.

tags instance-attribute

tags: NotRequired[TagMap]

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

use_historical_data instance-attribute

use_historical_data: NotRequired[optionalBoolean]

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