Skip to content

WriteSegmentRequest

Used by
Source code in docs_src/capo_pinpoint/types/write_segment_request.py 
14
15
16
17
18
19
20
21
22
23
24
class WriteSegmentRequest(TypedDict, closed=True):
    dimensions: NotRequired["capo_pinpoint.types.segment_dimensions.SegmentDimensions"]
    """<p>The criteria that define the dimensions for the segment.</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>The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.</p>"""
    tags: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.</p>"""

dimensions instance-attribute 

dimensions: NotRequired[SegmentDimensions]

The criteria that define the dimensions for the segment.

name instance-attribute 

name: NotRequired[__string]

The name of the segment.

segment_groups instance-attribute 

segment_groups: NotRequired[SegmentGroupList]

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

tags instance-attribute 

tags: NotRequired[MapOf__string]

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.