Update Timeline Event

ssmincidents_update_timeline_event

R Documentation

Updates a timeline event¶

Description¶

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

Usage¶

ssmincidents_update_timeline_event(clientToken, eventData, eventId,
  eventReferences, eventTime, eventType, incidentRecordArn)

Arguments¶

clientToken

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

eventData

A short description of the event.

eventId

[required] The ID of the event to update. You can use list_timeline_events to find an event's ID.

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.

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.

eventTime

The timestamp for when the event occurred.

eventType

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

incidentRecordArn

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

Value¶

An empty list.

Request syntax¶

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