Skip to content

StartIncident

Source: src/AWS/SSMIncidents/StartIncident.ts

Runtime binding for ssm-incidents:StartIncident.

Starts an incident from the bound ResponsePlan — Incident Manager creates the incident record, engages the plan’s contacts, posts to its chat channel, and runs its Automation runbooks. The response plan ARN is injected from the binding; pass triggerDetails to record what fired the incident. Provide the implementation with Effect.provide(AWS.SSMIncidents.StartIncidentHttp).

// init — bind the operation to the response plan
const startIncident = yield* AWS.SSMIncidents.StartIncident(plan);
// runtime
const { incidentRecordArn } = yield* startIncident({
title: "checkout p99 breach",
impact: 2,
triggerDetails: {
source: "custom.checkout-monitor",
timestamp: new Date(),
},
});