describe_event_tracker

Personalize.Client.describe_event_tracker(**kwargs)

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

Request Syntax

response = client.describe_event_tracker(
    eventTrackerArn='string'
)

Parameters

eventTrackerArn (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'eventTracker': {
        'name': 'string',
        'eventTrackerArn': 'string',
        'accountId': 'string',
        'trackingId': 'string',
        'datasetGroupArn': 'string',
        'status': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --
  • eventTracker (dict) --

    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 Web Services 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 (datetime) --

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

    • lastUpdatedDateTime (datetime) --

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

Exceptions

• Personalize.Client.exceptions.InvalidInputException
• Personalize.Client.exceptions.ResourceNotFoundException