Skip to content

EventStream

Source code in docs_src/capo_pinpoint/types/event_stream.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
class EventStream(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application to publish event data for.</p>"""
    destination_stream_arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.</p> <p>For a Kinesis data stream, the ARN format is: arn:aws:kinesis:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:stream/<replaceable>stream_name</replaceable> </p> <p>For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:deliverystream/<replaceable>stream_name</replaceable> </p>"""
    external_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.</p>"""
    last_modified_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the event stream was last modified.</p>"""
    last_updated_by: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The IAM user who last modified the event stream.</p>"""
    role_arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.</p>"""

application_id instance-attribute 

application_id: NotRequired[__string]

The unique identifier for the application to publish event data for.

destination_stream_arn instance-attribute 

destination_stream_arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

external_id instance-attribute 

external_id: NotRequired[__string]

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

last_modified_date instance-attribute 

last_modified_date: NotRequired[__string]

The date, in ISO 8601 format, when the event stream was last modified.

last_updated_by instance-attribute 

last_updated_by: NotRequired[__string]

The IAM user who last modified the event stream.

role_arn instance-attribute 

role_arn: NotRequired[__string]

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.