:doc:`Personalize <../../personalize>` / Client / create_event_tracker

********************
create_event_tracker
********************



.. py:method:: Personalize.Client.create_event_tracker(**kwargs)

  

  Creates an event tracker that you use when adding event data to a specified dataset group using the `PutEvents <https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html>`__ 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 <https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html>`__ 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 <https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html>`__.

   

  .. note::

    

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

    

   

  **Related APIs**

   

  
  * `ListEventTrackers <https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html>`__
   
  * `DescribeEventTracker <https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html>`__
   
  * `DeleteEventTracker <https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html>`__
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTracker>`_  


  **Request Syntax**
  ::

    response = client.create_event_tracker(
        name='string',
        datasetGroupArn='string',
        tags=[
            {
                'tagKey': 'string',
                'tagValue': 'string'
            },
        ]
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name for the event tracker.

    

  
  :type datasetGroupArn: string
  :param datasetGroupArn: **[REQUIRED]** 

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

    

  
  :type tags: list
  :param tags: 

    A list of `tags <https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html>`__ to apply to the event tracker.

    

  
    - *(dict) --* 

      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 Amazon Personalize resources <https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html>`__.

      

    
      - **tagKey** *(string) --* **[REQUIRED]** 

        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) --* **[REQUIRED]** 

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'eventTrackerArn': 'string',
          'trackingId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **eventTrackerArn** *(string) --* 

        The ARN of the event tracker.

        
      

      - **trackingId** *(string) --* 

        The ID of the event tracker. Include this ID in requests to the `PutEvents <https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html>`__ API.

        
  
  **Exceptions**
  
  *   :py:class:`Personalize.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Personalize.Client.exceptions.ResourceAlreadyExistsException`

  
  *   :py:class:`Personalize.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Personalize.Client.exceptions.LimitExceededException`

  
  *   :py:class:`Personalize.Client.exceptions.ResourceInUseException`

  
  *   :py:class:`Personalize.Client.exceptions.TooManyTagsException`

  