GetTimelineEventCommand

Retrieves a timeline event based on its ID and incident record.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMIncidentsClient, GetTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
// const { SSMIncidentsClient, GetTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
const client = new SSMIncidentsClient(config);
const input = { // GetTimelineEventInput
  incidentRecordArn: "STRING_VALUE", // required
  eventId: "STRING_VALUE", // required
};
const command = new GetTimelineEventCommand(input);
const response = await client.send(command);
// { // GetTimelineEventOutput
//   event: { // TimelineEvent
//     incidentRecordArn: "STRING_VALUE", // required
//     eventId: "STRING_VALUE", // required
//     eventTime: new Date("TIMESTAMP"), // required
//     eventUpdatedTime: new Date("TIMESTAMP"), // required
//     eventType: "STRING_VALUE", // required
//     eventData: "STRING_VALUE", // required
//     eventReferences: [ // EventReferenceList
//       { // EventReference Union: only one key present
//         resource: "STRING_VALUE",
//         relatedItemId: "STRING_VALUE",
//       },
//     ],
//   },
// };

GetTimelineEventCommand Input

See GetTimelineEventCommandInput for more details

Parameter
Type
Description
eventId
Required
string | undefined

The ID of the event. You can get an event's ID when you create it, or by using ListTimelineEvents.

incidentRecordArn
Required
string | undefined

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

GetTimelineEventCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
event
Required
TimelineEvent | undefined

Details about the timeline event.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this operation.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

Request references a resource which doesn't exist.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an Amazon Web Services service.

SSMIncidentsServiceException
Base exception class for all service exceptions from SSMIncidents service.