Menu
Amazon Pinpoint
REST API Reference

Event Stream

Use this resource to configure Amazon Pinpoint to stream events to Amazon Kinesis. Amazon Pinpoint can send events to an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. By streaming your events, you enable more flexible options for analysis and storage. You can use this resource to look up, create, update, or delete an event stream.

You can configure only 1 event stream for each Amazon Pinpoint app. To combine data from multiple apps, configure each app to use the same stream.

URI

/v1/apps/application-id/eventstream

HTTP Methods

DELETE

Deletes the event stream for an app.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

EventStream

GET

Returns the event stream for an app.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

EventStream

POST

Use to create or update the event stream for an app.

Body

Name Required Type

WriteEventStream

true

WriteEventStream

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

EventStream

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Request Schemas

Example WriteEventStream

Copy
{ "DestinationStreamArn": "string", "RoleArn": "string" }

Response Schemas

Example EventStream

Copy
{ "ApplicationId": "string", "DestinationStreamArn": "string", "RoleArn": "string", "ExternalId": "string", "LastModifiedDate": "string", "LastUpdatedBy": "string" }

Example MessageBody

Copy
{ "RequestID": "string", "Message": "string" }

Attributes

WriteEventStream

Attribute Type Description

DestinationStreamArn

string

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME

RoleArn

string

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

EventStream

Attribute Type Description

ApplicationId

string

The ID of the application from which events should be published.

DestinationStreamArn

string

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME

ExternalId

string

DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

LastModifiedDate

string

The date the event stream was last updated in ISO 8601 format.

LastUpdatedBy

string

The IAM user who last modified the event stream.

RoleArn

string

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.