event_streams

Creates, updates, deletes, gets or lists an event_streams resource.

Overview

Name	event_streams
Type	Resource
Id	aws.pinpoint.event_streams

Fields

The following fields are returned by SELECT queries:

get_event_stream

Name	Datatype	Description
application_id	string	The unique identifier for the application to publish event data for.
destination_stream_arn	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	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	string	The date, in ISO 8601 format, when the event stream was last modified.
last_updated_by	string	The IAM user who last modified the event stream.
role_arn	string	The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_stream	select	application-id, region		Retrieves information about the event stream settings for an application.
put_event_stream	replace	application-id, region, WriteEventStream		Creates a new event stream for an application or updates the settings of an existing event stream for an application.
delete_event_stream	delete	application-id, region		Deletes the event stream for an application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application-id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
region	string	AWS region (default: us-east-1)

SELECT examples

get_event_stream

Retrieves information about the event stream settings for an application.

SELECT
application_id,
destination_stream_arn,
external_id,
last_modified_date,
last_updated_by,
role_arn
FROM aws.pinpoint.event_streams
WHERE `application-id` = '{{ application-id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_event_stream

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

REPLACE aws.pinpoint.event_streams
SET 
WriteEventStream = '{{ WriteEventStream }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND WriteEventStream = '{{ WriteEventStream }}' --required
RETURNING
event_stream;

DELETE examples

delete_event_stream

Deletes the event stream for an application.

DELETE FROM aws.pinpoint.event_streams
WHERE `application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
;