CreateResponsePlan - AWS Systems Manager Incident Manager

CreateResponsePlan

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

Request Syntax

POST /createResponsePlan HTTP/1.1 Content-type: application/json { "actions": [ { "ssmAutomation": { "documentName": "string", "documentVersion": "string", "parameters": { "string" : [ "string" ] }, "roleArn": "string", "targetAccount": "string" } } ], "chatChannel": { "chatbotSns": [ "string" ], "empty": { } }, "clientToken": "string", "displayName": "string", "engagements": [ "string" ], "incidentTemplate": { "dedupeString": "string", "impact": number, "notificationTargets": [ { "snsTopicArn": "string" } ], "summary": "string", "title": "string" }, "name": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

actions

The actions that the response plan starts at the beginning of an incident.

Type: Array of Action objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

chatChannel

The AWS Chatbot chat channel used for collaboration during an incident.

Type: ChatChannel object

Required: No

clientToken

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

Type: String

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

Required: No

displayName

The long format of the response plan name. This field can contain spaces.

Type: String

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

Required: No

engagements

The contacts and escalation plans that the response plan engages during an incident.

Type: Array of strings

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

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

Pattern: ^arn:[-\w+=/,.@]+:ssm-contacts:[-\w+=/,.@]*:[0-9]+:([\w+=/,.@:-]+)*$

Required: No

incidentTemplate

Details used to create an incident when using this response plan.

Type: IncidentTemplate object

Required: Yes

name

The short format name of the response plan. Can't include spaces.

Type: String

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

Pattern: ^[a-zA-Z0-9-_]*$

Required: Yes

tags

A list of tags that you are adding to the response plan.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[A-Za-z0-9 _=@:.+-/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[A-Za-z0-9 _=@:.+-/]*$

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "arn": "string" }

Response Elements

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

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

arn

The Amazon Resource Name (ARN) of the response plan.

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 action.

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 does not 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: