event_trackers

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

Overview

Name	event_trackers
Type	Resource
Id	aws.personalize.event_trackers

Fields

The following fields are returned by SELECT queries:

describe_event_tracker

Name	Datatype	Description
name	string	The name of the event tracker. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
account_id	string	The Amazon Web Services account that owns the event tracker.
creation_date_time	string (date-time)	The date and time (in Unix format) that the event tracker was created.
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group that receives the event data. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
event_tracker_arn	string	The ARN of the event tracker. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
last_updated_date_time	string (date-time)	The date and time (in Unix time) that the event tracker was last updated.
status	string	The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS
tracking_id	string	The ID of the event tracker. Include this ID in requests to the PutEvents API.

list_event_trackers

Name	Datatype	Description
name	string	The name of the event tracker. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
creation_date_time	string (date-time)	The date and time (in Unix time) that the event tracker was created.
event_tracker_arn	string	The Amazon Resource Name (ARN) of the event tracker. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
last_updated_date_time	string (date-time)	The date and time (in Unix time) that the event tracker was last updated.
status	string	The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_event_tracker	select	region		Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
list_event_trackers	select	region		Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
create_event_tracker	insert	region, name, datasetGroupArn		Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
delete_event_tracker	delete	region		Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_event_tracker

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

SELECT
name,
account_id,
creation_date_time,
dataset_group_arn,
event_tracker_arn,
last_updated_date_time,
status,
tracking_id
FROM aws.personalize.event_trackers
WHERE region = '{{ region }}' -- required
;

list_event_trackers

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

SELECT
name,
creation_date_time,
event_tracker_arn,
last_updated_date_time,
status
FROM aws.personalize.event_trackers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_event_tracker

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker

INSERT INTO aws.personalize.event_trackers (
name,
datasetGroupArn,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ datasetGroupArn }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
event_tracker_arn,
tracking_id
;

Manifest

# Description fields are for documentation purposes
- name: event_trackers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_trackers resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name for the event tracker.
  - name: datasetGroupArn
    value: "{{ datasetGroupArn }}"
    description: |
      The Amazon Resource Name (ARN) of the dataset group that receives the event data.
  - name: tags
    description: |
      A list of tags to apply to the event tracker.
    value:
      - tagKey: "{{ tagKey }}"
        tagValue: "{{ tagValue }}"

DELETE examples

delete_event_tracker

Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.

DELETE FROM aws.personalize.event_trackers
WHERE region = '{{ region }}' --required
;