[ aws . ssm-incidents ]
create-response-plan¶
Description¶
Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-response-plan
[--actions <value>]
[--chat-channel <value>]
[--client-token <value>]
[--display-name <value>]
[--engagements <value>]
--incident-template <value>
--name <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--actions (list)
The actions that the response plan starts 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"
}
}
...
]
--chat-channel (structure)
The Chatbot chat channel used for collaboration during an incident.
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 of the response plan name. This field can contain spaces.
--engagements (list)
The contacts and escalation plans that the response plan engages during an incident.
(string)
Syntax:
"string" "string" ...
--incident-template (structure)
Details used to create an incident when using this response plan.
dedupeString -> (string)
Used to stop Incident Manager from creating multiple incident records for the same incident.
impact -> (integer)
The impact of the incident on your customers and applications.
notificationTargets -> (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.
summary -> (string)
The summary of the incident. The summary is a brief synopsis of what occurred, what’s currently happening, and context.
title -> (string)
The title of the incident.
Shorthand Syntax:
dedupeString=string,impact=integer,notificationTargets=[{snsTopicArn=string},{snsTopicArn=string}],summary=string,title=string
JSON Syntax:
{
"dedupeString": "string",
"impact": integer,
"notificationTargets": [
{
"snsTopicArn": "string"
}
...
],
"summary": "string",
"title": "string"
}
--name (string)
The short format name of the response plan. Can’t include spaces.
--tags (map)
A list of tags that you are adding to the response plan.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--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 create a response plan
The following create-response-plan example creates a response plan with the specified details.
aws ssm-incidents create-response-plan \
--chat-channel '{"chatbotSns": ["arn:aws:sns:us-east-1:111122223333:Standard_User"]}' \
--display-name "Example response plan" \
--incident-template '{"impact": 5, "title": "example-incident"}' \
--name "example-response" \
--actions '[{"ssmAutomation": {"documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT", "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager", "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"}}]' \
--engagements '["arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"]'
Output:
{
"arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response"
}
For more information, see Incident preparation in the Incident Manager User Guide.