UpdateIncidentRecord - AWS Systems Manager Incident Manager

UpdateIncidentRecord

Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.

Request Syntax

POST /updateIncidentRecord HTTP/1.1 Content-type: application/json { "arn": "string", "chatChannel": { "chatbotSns": [ "string" ], "empty": { } }, "clientToken": "string", "impact": number, "notificationTargets": [ { "snsTopicArn": "string" } ], "status": "string", "summary": "string", "title": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

The Amazon Resource Name (ARN) of the incident record you are updating.

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 for responders to collaborate in.

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

impact

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

Possible impacts:

  • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

  • 2 - High impact, partial application failure with impact to many customers.

  • 3 - Medium impact, the application is providing reduced service to customers.

  • 4 - Low impact, customer might aren't impacted by the problem yet.

  • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

Type: Integer

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

Required: No

notificationTargets

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

Using multiple SNS topics creates redundancy in the case that a Region is down during the incident.

Type: Array of NotificationTargetItem objects

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

Required: No

status

The status of the incident. An incident can be Open or Resolved.

Type: String

Valid Values: OPEN | RESOLVED

Required: No

summary

The summary describes what has happened during the incident.

Type: String

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

Required: No

title

The title of the incident is a brief and easily recognizable.

Type: String

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

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 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: