:doc:`SSMIncidents <../../ssm-incidents>` / Client / update_timeline_event

*********************
update_timeline_event
*********************



.. py:method:: SSMIncidents.Client.update_timeline_event(**kwargs)

  

  Updates a timeline event. You can update events of type ``Custom Event``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateTimelineEvent>`_  


  **Request Syntax**
  ::

    response = client.update_timeline_event(
        clientToken='string',
        eventData='string',
        eventId='string',
        eventReferences=[
            {
                'relatedItemId': 'string',
                'resource': 'string'
            },
        ],
        eventTime=datetime(2015, 1, 1),
        eventType='string',
        incidentRecordArn='string'
    )
    
  :type clientToken: string
  :param clientToken: 

    A token that ensures that a client calls the operation only once with the specified details.

    This field is autopopulated if not provided.

  
  :type eventData: string
  :param eventData: 

    A short description of the event.

    

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

    The ID of the event to update. You can use ``ListTimelineEvents`` to find an event's ID.

    

  
  :type eventReferences: list
  :param eventReferences: 

    Updates all existing references in a ``TimelineEvent``. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

     

    .. warning::

       

      This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

      

    

  
    - *(dict) --* 

      An item referenced in a ``TimelineEvent`` that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a ``RelatedItem`` ID.

      .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``relatedItemId``, ``resource``. 

    
      - **relatedItemId** *(string) --* 

        The ID of a ``RelatedItem`` referenced in a ``TimelineEvent``.

        

      
      - **resource** *(string) --* 

        The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a ``TimelineEvent``.

        

      
    

  :type eventTime: datetime
  :param eventTime: 

    The timestamp for when the event occurred.

    

  
  :type eventType: string
  :param eventType: 

    The type of event. You can update events of type ``Custom Event`` and ``Note``.

    

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

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`SSMIncidents.Client.exceptions.ThrottlingException`

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

  
  *   :py:class:`SSMIncidents.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSMIncidents.Client.exceptions.ValidationException`

  
  *   :py:class:`SSMIncidents.Client.exceptions.ConflictException`

  
  *   :py:class:`SSMIncidents.Client.exceptions.InternalServerException`

  