Skip to content

GetSegmentDefinitionResponse

Source code in docs_src/capo_customer_profiles/types/get_segment_definition_response.py
class GetSegmentDefinitionResponse(TypedDict, closed=True):
    segment_definition_name: NotRequired["capo_customer_profiles.types.name.name"]
    """<p>The name of the segment definition.</p>"""
    display_name: NotRequired["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>The segment criteria associated with this definition.</p>"""
    segment_sort: NotRequired["capo_customer_profiles.types.segment_sort.SegmentSort"]
    """<p>The segment sort.</p>"""
    segment_definition_arn: (
        "capo_customer_profiles.types.segment_definition_arn.SegmentDefinitionArn"
    )
    """<p>The arn of the segment definition.</p>"""
    created_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the segment definition was created.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    segment_sql_query: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to50000.sensitiveString1To50000"
    ]
    """<p>The segment SQL query.</p>"""
    segment_type: NotRequired["capo_customer_profiles.types.segment_type.SegmentType"]
    """<p>The segment type.</p> <p> Classic : Segments created using traditional SegmentGroup structure</p> <p> Enhanced : Segments created using SQL queries </p>"""

created_at instance-attribute

created_at: NotRequired[timestamp]

The timestamp of when the segment definition was created.

description instance-attribute

description: NotRequired[sensitiveString1To4000]

The description of the segment definition.

display_name instance-attribute

display_name: NotRequired[string1To255]

The display name of the segment definition.

segment_definition_arn instance-attribute

segment_definition_arn: SegmentDefinitionArn

The arn of the segment definition.

segment_definition_name instance-attribute

segment_definition_name: NotRequired[name]

The name of the segment definition.

segment_groups instance-attribute

segment_groups: NotRequired[SegmentGroup]

The segment criteria associated with this definition.

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.

segment_type instance-attribute

segment_type: NotRequired[SegmentType]

The segment type.

Classic : Segments created using traditional SegmentGroup structure

Enhanced : Segments created using SQL queries

tags instance-attribute

tags: NotRequired[TagMap]

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