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 ]



Retrieves the details of the specified response plan.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--arn (string)

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

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


To get details of a response plan

The following command-name example gets details about a specified response plan in your AWS account.

aws ssm-incidents get-response-plan \
    --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"


    "actions": [
            "ssmAutomation": {
                "documentName": "AWSIncidents-CriticalIncidentRunbookTemplate",
                "documentVersion": "$DEFAULT",
                "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/",
                "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"
    "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan",
    "chatChannel": {
        "chatbotSns": [
    "displayName": "Example response plan",
    "engagements": [
    "incidentTemplate": {
        "impact": 5,
        "title": "Example-Incident"
    "name": "Example-Response-Plan"

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


actions -> (list)

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


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.

dynamicParameters -> (map)

The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

key -> (string)

value -> (structure)

The dynamic SSM parameter value.

variable -> (string)

Variable dynamic parameters. A parameter value is determined when an incident is created.

parameters -> (map)

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

key -> (string)

value -> (list)


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.

arn -> (string)

The ARN of the response plan.

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


empty -> (structure)

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

displayName -> (string)

The long format name of the response plan. Can contain spaces.

engagements -> (list)

The contacts and escalation plans that the response plan engages during an incident.


incidentTemplate -> (structure)

Details used to create the 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.

incidentTags -> (map)

Tags to apply to an incident when calling the StartIncident API action.

key -> (string)

value -> (string)

notificationTargets -> (list)

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


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.

name -> (string)

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