Skip to content

EventDimensions

Source code in docs_src/capo_pinpoint/types/event_dimensions.py
class EventDimensions(TypedDict, closed=True):
    attributes: NotRequired[
        "capo_pinpoint.types.map_of_attribute_dimension.MapOfAttributeDimension"
    ]
    """<p>One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.</p>"""
    event_type: NotRequired["capo_pinpoint.types.set_dimension.SetDimension"]
    """<p>The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>"""
    metrics: NotRequired[
        "capo_pinpoint.types.map_of_metric_dimension.MapOfMetricDimension"
    ]
    """<p>One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.</p>"""

attributes instance-attribute

attributes: NotRequired[MapOfAttributeDimension]

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

event_type instance-attribute

event_type: NotRequired[SetDimension]

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

metrics instance-attribute

metrics: NotRequired[MapOfMetricDimension]

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.