URI HTTP methods Schemas Properties See also

Event Stream

The Kinesis platform offers services that you can use to load and analyze streaming data on AWS. You can configure Amazon Pinpoint to stream events to Firehose or Kinesis Data Streams. By streaming events, you enable more flexible options for analysis and storage.

You can use the Event Stream resource to create, retrieve information about, update, or delete an event stream for an application. You can configure only one event stream for each Amazon Pinpoint application. To combine data from multiple applications, configure each application to use the same stream.

URI

/v1/apps/application-id/eventstream

HTTP methods

GET

Operation ID: GetEventStream

Retrieves information about the event stream settings for an application.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`EventStream`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

POST

Operation ID: PutEventStream

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`EventStream`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

DELETE

Operation ID: DeleteEventStream

Deletes the event stream for an application.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`EventStream`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Event Stream resource.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Responses
Status code	Response model	Description
`200`	None	The request succeeded.

Schemas

Request bodies


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

Response bodies


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


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

Properties

EventStream

Specifies settings for publishing event data to Amazon Kinesis Data Streams or Amazon Data Firehose delivery streams.

Property	Type	Required	Description
`ApplicationId`	string	True	The unique identifier for the application to publish event data for.
`DestinationStreamArn`	string	True	The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon 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 Firehose delivery stream, the ARN format is: `arn:aws:firehose:region:account-id:deliverystream/stream_name`
`ExternalId`	string	False	(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.
`LastModifiedDate`	string	False	The date, in ISO 8601 format, when the event stream was last modified.
`LastUpdatedBy`	string	False	The user who last modified the event stream.
`RoleArn`	string	True	The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

MessageBody

Provides information about an API request or response.

Property	Type	Required	Description
`Message`	string	False	The message that's returned from the API.
`RequestID`	string	False	The unique identifier for the request or response.

WriteEventStream

Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

Property Type Required Description

Property	Type	Required	Description
`DestinationStreamArn`	string	True	The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want 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 Firehose delivery stream, the ARN format is: `arn:aws:firehose:region:account-id:deliverystream/stream_name`
`RoleArn`	string	True	The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

DestinationStreamArn

string

True

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want 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 Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

RoleArn

string

True

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