Skip to content

CreateSegmentDefinitionRequest

Source code in docs_src/capo_customer_profiles/types/create_segment_definition_request.py
class CreateSegmentDefinitionRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    segment_definition_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the segment definition.</p>"""
    display_name: "capo_customer_profiles.types.string1_to255.string1To255"
    """<p>The display name of the segment definition.</p>"""
    description: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to4000.sensitiveString1To4000"
    ]
    """<p>The description of the segment definition.</p>"""
    segment_groups: NotRequired[
        "capo_customer_profiles.types.segment_group.SegmentGroup"
    ]
    """<p>Specifies the base segments and dimensions for a segment definition along with their respective relationship.</p>"""
    segment_sql_query: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to50000.sensitiveString1To50000"
    ]
    """<p>The segment SQL query.</p>"""
    segment_sort: NotRequired["capo_customer_profiles.types.segment_sort.SegmentSort"]
    """<p>The segment sort.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

description instance-attribute

description: NotRequired[sensitiveString1To4000]

The description of the segment definition.

display_name instance-attribute

display_name: string1To255

The display name of the segment definition.

domain_name instance-attribute

domain_name: name

The unique name of the domain.

segment_definition_name instance-attribute

segment_definition_name: name

The unique name of the segment definition.

segment_groups instance-attribute

segment_groups: NotRequired[SegmentGroup]

Specifies the base segments and dimensions for a segment definition along with their respective relationship.

segment_sort instance-attribute

segment_sort: NotRequired[SegmentSort]

The segment sort.

segment_sql_query instance-attribute

segment_sql_query: NotRequired[sensitiveString1To50000]

The segment SQL query.

tags instance-attribute

tags: NotRequired[TagMap]

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