[ aws . personalize ]
create-event-tracker¶
Description¶
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 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
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-event-tracker
--name <value>
--dataset-group-arn <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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.
--tags (list)
A list of tags to apply to the event tracker.
(structure)
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources .
tagKey -> (string)
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
tagValue -> (string)
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
Shorthand Syntax:
tagKey=string,tagValue=string ...
JSON Syntax:
[
{
"tagKey": "string",
"tagValue": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.