Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
post/startIncident
Request body
clientTokenstring
A token ensuring that the operation is called only once with the specified details.
impactinteger
<p>Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.</p> <p class="title"> <b>Possible impacts:</b> </p> <ul> <li> <p> <code>1</code> - Critical impact, this typically relates to full application failure that impacts many to all customers. </p> </li> <li> <p> <code>2</code> - High impact, partial application failure with impact to many customers.</p> </li> <li> <p> <code>3</code> - Medium impact, the application is providing reduced service to customers.</p> </li> <li> <p> <code>4</code> - Low impact, customer might aren't impacted by the problem yet.</p> </li> <li> <p> <code>5</code> - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.</p> </li> </ul>
responsePlanArnstring required
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
titlestring
Provide a title for the incident. Providing a title overwrites the title provided by the response plan.
Response
Success
incidentRecordArnstring required
The ARN of the newly created incident record.