Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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-response-plan

Description

Updates the specified response plan.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-response-plan
[--actions <value>]
--arn <value>
[--chat-channel <value>]
[--client-token <value>]
[--display-name <value>]
[--engagements <value>]
[--incident-template-dedupe-string <value>]
[--incident-template-impact <value>]
[--incident-template-notification-targets <value>]
[--incident-template-summary <value>]
[--incident-template-title <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--actions (list)

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

(structure)

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

ssmAutomation -> (structure)

The Systems Manager automation document to start as the runbook at the beginning of the incident.

documentName -> (string)

The automation document's name.

documentVersion -> (string)

The automation document's version to use when running.

parameters -> (map)

The key-value pair parameters to use when running the automation document.

key -> (string)

value -> (list)

(string)

roleArn -> (string)

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

targetAccount -> (string)

The account that the automation document will be run in. This can be in either the management account or an application account.

Shorthand Syntax:

ssmAutomation={documentName=string,documentVersion=string,parameters={KeyName1=[string,string],KeyName2=[string,string]},roleArn=string,targetAccount=string} ...

JSON Syntax:

[
  {
    "ssmAutomation": {
      "documentName": "string",
      "documentVersion": "string",
      "parameters": {"string": ["string", ...]
        ...},
      "roleArn": "string",
      "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"|"IMPACTED_ACCOUNT"
    }
  }
  ...
]

--arn (string)

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

--chat-channel (structure)

The Chatbot chat channel used for collaboration during an incident.

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

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 ensuring that the operation is called only once with the specified details.

--display-name (string)

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

--engagements (list)

The contacts and escalation plans that Incident Manager engages at the start of the incident.

(string)

Syntax:

"string" "string" ...

--incident-template-dedupe-string (string)

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

--incident-template-impact (integer)

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

--incident-template-notification-targets (list)

The Amazon SNS targets that are notified when updates are made to an 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"
  }
  ...
]

--incident-template-summary (string)

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

--incident-template-title (string)

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

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

See 'aws help' for descriptions of global parameters.

Examples

To update a response plan

The following update-response-plan example removes a chat channel from the specified response plan.

aws ssm-incidents update-response-plan \
    --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \
    --chat-channel '{"empty":{}}'

This command produces no output.

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

Output

None