Personalize / Client / list_event_trackers

list_event_trackers#

Personalize.Client.list_event_trackers(**kwargs)#

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

See also: AWS API Documentation

Request Syntax

response = client.list_event_trackers(
    datasetGroupArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • datasetGroupArn (string) – The ARN of a dataset group used to filter the response.

  • nextToken (string) – A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

  • maxResults (integer) – The maximum number of event trackers to return.

Return type:

dict

Returns:

Response Syntax

{
    'eventTrackers': [
        {
            'name': 'string',
            'eventTrackerArn': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • eventTrackers (list) –

      A list of event trackers.

      • (dict) –

        Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.

        • name (string) –

          The name of the event tracker.

        • eventTrackerArn (string) –

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

        • 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 time) that the event tracker was created.

        • lastUpdatedDateTime (datetime) –

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

    • nextToken (string) –

      A token for getting the next set of event trackers (if they exist).

Exceptions

  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.InvalidNextTokenException