Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm-incidents ]

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 .

See also: AWS API Documentation

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--arn (string)

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

--chat-channel (tagged union structure)

The Chatbot chat channel where responders can collaborate.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.

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.

(tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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