Skip to content

Create Timeline Event

ssmincidents_create_timeline_event R Documentation

Creates a custom timeline event on the incident details page of an incident record

Description

Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.

Usage

ssmincidents_create_timeline_event(clientToken, eventData,
  eventReferences, eventTime, eventType, incidentRecordArn)

Arguments

clientToken

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

eventData

[required] A short description of the event.

eventReferences

Adds one or more references to the 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 a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

eventTime

[required] The timestamp for when the event occurred.

eventType

[required] The type of event. You can create timeline events of type ⁠Custom Event⁠ and Note.

To make a Note-type event appear on the Incident notes panel in the console, specify eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for eventReference.

incidentRecordArn

[required] The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.

Value

A list with the following syntax: 

list(
  eventId = "string",
  incidentRecordArn = "string"
)

Request syntax

svc$create_timeline_event(
  clientToken = "string",
  eventData = "string",
  eventReferences = list(
    list(
      relatedItemId = "string",
      resource = "string"
    )
  ),
  eventTime = as.POSIXct(
    "2015-01-01"
  ),
  eventType = "string",
  incidentRecordArn = "string"
)