update-incident-record¶

Description¶

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

Synopsis¶

  update-incident-record
--arn <value>
[--chat-channel <value>]
[--client-token <value>]
[--impact <value>]
[--notification-targets <value>]
[--status <value>]
[--summary <value>]
[--title <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--arn (string)

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

--chat-channel (structure)

The Chatbot chat channel where responders can collaborate.

chatbotSns -> (list)

The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.

(string)

empty -> (structure)

Used to remove the chat channel from an incident record or response plan.

Shorthand Syntax:

chatbotSns=string,string,empty={}

JSON Syntax:

{
  "chatbotSns": ["string", ...],
  "empty": {

  }
}

--client-token (string)

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

--impact (integer)

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

Possible impacts:

1 - Critical impact, 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 aren’t impacted by the problem yet.

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

--notification-targets (list)

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

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

(structure)

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

snsTopicArn -> (string)

The Amazon Resource Name (ARN) of the SNS topic.

Shorthand Syntax:

snsTopicArn=string ...

JSON Syntax:

[
  {
    "snsTopicArn": "string"
  }
  ...
]

--status (string)

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

Possible values:

OPEN

RESOLVED

--summary (string)

A longer description of what occurred during the incident.

--title (string)

A brief description of the incident.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To update an incident record

The following command-name example resolves the specified incident.

aws ssm-incidents update-incident-record \
    --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \
    --status "RESOLVED"

This command produces no output.

For more information, see Incident details in the Incident Manager User Guide.

Output¶

None

Table of Contents

Feedback

User Guide