Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . personalize ]

create-event-tracker

Description

Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.

When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user.

Note

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 send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data.

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 .

Note

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

Related APIs

  • ListEventTrackers
  • DescribeEventTracker
  • DeleteEventTracker

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-event-tracker
--name <value>
--dataset-group-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name for the event tracker.

--dataset-group-arn (string)

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

eventTrackerArn -> (string)

The ARN of the event tracker.

trackingId -> (string)

The ID of the event tracker. Include this ID in requests to the PutEvents API.