Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

StartIncident

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Request Syntax


POST /startIncident HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "impact": number,
   "relatedItems": [ 
      { 
         "generatedId": "string",
         "identifier": { 
            "type": "string",
            "value": { ... }
         },
         "title": "string"
      }
   ],
   "responsePlanArn": "string",
   "title": "string",
   "triggerDetails": { 
      "rawData": "string",
      "source": "string",
      "timestamp": number,
      "triggerArn": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A token ensuring that the operation is called only once with the specified details.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No

impact

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Supported impact codes

1 - Critical
2 - High
3 - Medium
4 - Low
5 - No Impact

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5.

Required: No

relatedItems

Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an Amazon S3 bucket.

Type: Array of RelatedItem objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

responsePlanArn

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$

Required: Yes

title

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: No

triggerDetails

Details of what created the incident record in Incident Manager.

Type: TriggerDetails object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "incidentRecordArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

incidentRecordArn

The ARN of the newly created incident record.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

ConflictException

Updating or deleting a resource causes an inconsistent state.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of StartIncident.

Sample Request


POST /startIncident HTTP/1.1
Host: ssm-incidents.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-incidents.start-incident
X-Amz-Date: 20210811T181411Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=AKIAIOSFODNN7EXAMPLE
Content-Length: 144

{
	"responsePlanArn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}

Sample Response


{
    "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/1abd9b35-ff4c-eb47-f20f-712a6c4c88cc"
}