Create Event Tracker

personalize_create_event_tracker

R Documentation

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API¶

Description¶

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 create_event_tracker 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 describe_event_tracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

list_event_trackers
describe_event_tracker
delete_event_tracker

Usage¶

personalize_create_event_tracker(name, datasetGroupArn, tags)

Arguments¶

name: [required] The name for the event tracker.
datasetGroupArn: [required] The Amazon Resource Name (ARN) of the dataset group that receives the event data.
tags: A list of tags to apply to the event tracker.

Value¶

A list with the following syntax:

list(
  eventTrackerArn = "string",
  trackingId = "string"
)

Request syntax¶

svc$create_event_tracker(
  name = "string",
  datasetGroupArn = "string",
  tags = list(
    list(
      tagKey = "string",
      tagValue = "string"
    )
  )
)