Skip to content

GetCalculatedAttributeDefinitionResponse

Source code in docs_src/capo_customer_profiles/types/get_calculated_attribute_definition_response.py
class GetCalculatedAttributeDefinitionResponse(TypedDict, closed=True):
    calculated_attribute_name: NotRequired[
        "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>"""
    created_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the calculated attribute definition was created.</p>"""
    last_updated_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the calculated attribute definition was most recently edited.</p>"""
    statistic: NotRequired["capo_customer_profiles.types.statistic.Statistic"]
    """<p>The aggregation operation to perform for the calculated attribute.</p>"""
    filter: NotRequired["capo_customer_profiles.types.filter.Filter"]
    """<p>The filter assigned to this calculated attribute definition.</p>"""
    conditions: NotRequired["capo_customer_profiles.types.conditions.Conditions"]
    """<p>The conditions including range, object count, and threshold for the calculated attribute.</p>"""
    attribute_details: NotRequired[
        "capo_customer_profiles.types.attribute_details.AttributeDetails"
    ]
    """<p>Mathematical expression and a list of attribute items specified in that expression.</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>"""
    status: NotRequired["capo_customer_profiles.types.readiness_status.ReadinessStatus"]
    """<p>Status of the Calculated Attribute creation (whether all historical data has been indexed).</p>"""
    readiness: NotRequired["capo_customer_profiles.types.readiness.Readiness"]
    """<p>Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.</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: NotRequired[AttributeDetails]

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

calculated_attribute_name instance-attribute

calculated_attribute_name: NotRequired[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.

created_at instance-attribute

created_at: NotRequired[timestamp]

The timestamp of when the calculated attribute definition was created.

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.

filter instance-attribute

filter: NotRequired[Filter]

The filter assigned to this calculated attribute definition.

last_updated_at instance-attribute

last_updated_at: NotRequired[timestamp]

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

readiness instance-attribute

readiness: NotRequired[Readiness]

Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

statistic instance-attribute

statistic: NotRequired[Statistic]

The aggregation operation to perform for the calculated attribute.

status instance-attribute

status: NotRequired[ReadinessStatus]

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

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.