Skip to content

SegmentGroup

Source code in docs_src/capo_pinpoint/types/segment_group.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class SegmentGroup(TypedDict, closed=True):
    dimensions: NotRequired[
        "capo_pinpoint.types.list_of_segment_dimensions.ListOfSegmentDimensions"
    ]
    """<p>An array that defines the dimensions for the segment.</p>"""
    source_segments: NotRequired[
        "capo_pinpoint.types.list_of_segment_reference.ListOfSegmentReference"
    ]
    """<p>The base segment to build the segment on. A base segment, also referred to as a <i>source segment</i>, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.</p> <p>You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.</p>"""
    source_type: NotRequired["capo_pinpoint.types.source_type.SourceType"]
    """<p>Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.</p>"""
    type: NotRequired["capo_pinpoint.types.type.Type"]
    """<p>Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.</p>"""

dimensions instance-attribute 

dimensions: NotRequired[ListOfSegmentDimensions]

An array that defines the dimensions for the segment.

source_segments instance-attribute 

source_segments: NotRequired[ListOfSegmentReference]

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

source_type instance-attribute 

source_type: NotRequired[SourceType]

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

type instance-attribute 

type: NotRequired[Type]

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.