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 that ensures that a client calls the operation 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 to update. You can use ListTimelineEvents to find an event’s ID.

  • eventReferences (list) –

    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.

  • eventTime (datetime) – The timestamp for when the event occurred.

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

  • 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