UpdateResponsePlan - AWS Systems Manager Incident Manager

UpdateResponsePlan

Updates the specified response plan.

Request Syntax

POST /updateResponsePlan HTTP/1.1 Content-type: application/json { "actions": [ { "ssmAutomation": { "documentName": "string", "documentVersion": "string", "dynamicParameters": { "string" : { "variable": "string" } }, "parameters": { "string" : [ "string" ] }, "roleArn": "string", "targetAccount": "string" } } ], "arn": "string", "chatChannel": { "chatbotSns": [ "string" ], "empty": { } }, "clientToken": "string", "displayName": "string", "engagements": [ "string" ], "incidentTemplateDedupeString": "string", "incidentTemplateImpact": number, "incidentTemplateNotificationTargets": [ { "snsTopicArn": "string" } ], "incidentTemplateSummary": "string", "incidentTemplateTags": { "string" : "string" }, "incidentTemplateTitle": "string", "integrations": [ { "pagerDutyConfiguration": { "name": "string", "pagerDutyIncidentConfiguration": { "serviceId": "string" }, "secretId": "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 this response plan takes 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

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})?:.+$

Required: Yes

chatChannel

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

Use the empty structure to remove the chat channel from the response plan.

Type: ChatChannel object

Required: No

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

displayName

The long format name of the response plan. The display name can't contain spaces.

Type: String

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

Required: No

engagements

The Amazon Resource Name (ARN) for 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:aws(-cn|-us-gov)?:ssm-contacts:[a-z0-9-]*:([0-9]{12}):contact/[a-z0-9_-]+$

Required: No

incidentTemplateDedupeString

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

Type: String

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

Required: No

incidentTemplateImpact

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

Possible impacts:

  • 5 - Severe impact

  • 4 - High impact

  • 3 - Medium impact

  • 2 - Low impact

  • 1 - No impact

Type: Integer

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

Required: No

incidentTemplateNotificationTargets

The Amazon SNS targets that are notified when updates are made to an incident.

Type: Array of NotificationTargetItem objects

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

Required: No

incidentTemplateSummary

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

Type: String

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

Required: No

incidentTemplateTags

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

Type: String to string map

Map Entries: Minimum number of 0 items. 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

incidentTemplateTitle

The short format name of the incident. The title can't contain spaces.

Type: String

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

Required: No

integrations

Information about third-party services integrated into the response plan.

Type: Array of Integration objects

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

Required: No

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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

Sample Request

POST /updateResponsePlan 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.update-response-plan X-Amz-Date: 20210811T202606Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 162 { "arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response", "chatChannel": {"empty": {}}, "clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE" }

Sample Response

{}

See Also

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