[ aws . personalize ]

describe-event-tracker

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-event-tracker
--event-tracker-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--event-tracker-arn (string)

The Amazon Resource Name (ARN) of the event tracker to describe.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

eventTracker -> (structure)

An object that describes the event tracker.

name -> (string)

The name of the event tracker.

eventTrackerArn -> (string)

The ARN of the event tracker.

accountId -> (string)

The Amazon AWS account that owns the event tracker.

trackingId -> (string)

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

datasetGroupArn -> (string)

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

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

creationDateTime -> (timestamp)

The date and time (in Unix format) that the event tracker was created.

lastUpdatedDateTime -> (timestamp)

The date and time (in Unix time) that the event tracker was last updated.