Skip to content

SegmentResponse

Source code in docs_src/capo_pinpoint/types/segment_response.py
class SegmentResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the segment is associated with.</p>"""
    arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the segment.</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date and time when the segment was created.</p>"""
    dimensions: NotRequired["capo_pinpoint.types.segment_dimensions.SegmentDimensions"]
    """<p>The dimension settings for the segment.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the segment.</p>"""
    import_definition: NotRequired[
        "capo_pinpoint.types.segment_import_resource.SegmentImportResource"
    ]
    """<p>The settings for the import job that's associated with the segment.</p>"""
    last_modified_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date and time when the segment was last modified.</p>"""
    name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the segment.</p>"""
    segment_groups: NotRequired[
        "capo_pinpoint.types.segment_group_list.SegmentGroupList"
    ]
    """<p>A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.</p>"""
    segment_type: NotRequired["capo_pinpoint.types.segment_type.SegmentType"]
    """<p>The segment type. Valid values are:</p> <ul><li><p>DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.</p></li> <li><p>IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.</p></li></ul>"""
    tags: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.</p>"""
    version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The version number of the segment.</p>"""

application_id instance-attribute

application_id: NotRequired[__string]

The unique identifier for the application that the segment is associated with.

arn instance-attribute

arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the segment.

creation_date instance-attribute

creation_date: NotRequired[__string]

The date and time when the segment was created.

dimensions instance-attribute

dimensions: NotRequired[SegmentDimensions]

The dimension settings for the segment.

id instance-attribute

id: NotRequired[__string]

The unique identifier for the segment.

import_definition instance-attribute

import_definition: NotRequired[SegmentImportResource]

The settings for the import job that's associated with the segment.

last_modified_date instance-attribute

last_modified_date: NotRequired[__string]

The date and time when the segment was last modified.

name instance-attribute

name: NotRequired[__string]

The name of the segment.

segment_groups instance-attribute

segment_groups: NotRequired[SegmentGroupList]

A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

segment_type instance-attribute

segment_type: NotRequired[SegmentType]

The segment type. Valid values are:

  • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

  • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

tags instance-attribute

tags: NotRequired[MapOf__string]

A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

version instance-attribute

version: NotRequired[__integer]

The version number of the segment.