SSMIncidents / Client / create_timeline_event

create_timeline_event

SSMIncidents.Client.create_timeline_event(**kwargs)

Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• clientToken (string) –

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

  This field is autopopulated if not provided.

• eventData (string) –

  [REQUIRED]

  A short description of the event.

• eventReferences (list) –

  Adds one or more references to the 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.

  • (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) –

  [REQUIRED]

  The time that the event occurred.

• eventType (string) –

  [REQUIRED]

  The type of the event. You can create timeline events of type Custom Event.

• incidentRecordArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the incident record to which the event will be added.

Return type:

dict

Returns:

Response Syntax

{
    'eventId': 'string',
    'incidentRecordArn': 'string'
}

Response Structure

• (dict) –

  • eventId (string) –

    The ID of the event for easy reference later.

  • incidentRecordArn (string) –

    The ARN of the incident record that you added the event to.

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