View a markdown version of this page

AWS::Personalize::EventTracker - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Personalize::EventTracker

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

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

Note

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

Related APIs

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Personalize::EventTracker",
  "Properties" : {
      "DatasetGroupArn" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Personalize::EventTracker
Properties:
  DatasetGroupArn: String
  Name: String
  Tags: 
    - Tag

Properties

DatasetGroupArn

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

Required: Yes

Type: String

Pattern: ^arn:([a-z\d-]+):personalize:.*:.*:.+$

Maximum: 256

Update requires: Replacement

Name

The name of the event tracker.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*$

Minimum: 1

Maximum: 63

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

EventTrackerArn

The ARN of the event tracker.

TrackingId

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