SSMIncidents / Client / update_timeline_event

update_timeline_event#

SSMIncidents.Client.update_timeline_event(**kwargs)#

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

See also: AWS API Documentation

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'
)
Parameters:

  • clientToken (string) –

    A token ensuring that the operation is called only once with the specified details.

    This field is autopopulated if not provided.

  • eventData (string) – A short description of the event.

  • eventId (string) –

    [REQUIRED]

    The ID of the event you are updating. You can find this by using ListTimelineEvents.

  • eventReferences (list) –

    Updates all existing references in a TimelineEvent. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the 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 them 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.

  • eventTime (datetime) – The time that the event occurred.

  • eventType (string) – The type of the event. You can update events of type Custom Event.

  • incidentRecordArn (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSMIncidents.Client.exceptions.ThrottlingException

  • SSMIncidents.Client.exceptions.ResourceNotFoundException

  • SSMIncidents.Client.exceptions.AccessDeniedException

  • SSMIncidents.Client.exceptions.ValidationException

  • SSMIncidents.Client.exceptions.ConflictException

  • SSMIncidents.Client.exceptions.InternalServerException