AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Systems Manager Incident Manager CreateResponsePlan API operation.

Syntax

New-SSMIResponsePlan
-Name <String>
-Action <Action[]>
-ChatChannel_ChatbotSn <String[]>
-IncidentTemplate_DedupeString <String>
-DisplayName <String>
-ChatChannel_Empty <EmptyChatChannel>
-Engagement <String[]>
-IncidentTemplate_Impact <Int32>
-IncidentTemplate_IncidentTag <Hashtable>
-Integration <Integration[]>
-IncidentTemplate_NotificationTarget <NotificationTargetItem[]>
-IncidentTemplate_Summary <String>
-Tag <Hashtable>
-IncidentTemplate_Title <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSSMIncidentsConfig>

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.

Parameters

-Action <Action[]>
The actions that the response plan starts at the beginning of an incident.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActions
-ChatChannel_ChatbotSn <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChatChannel_ChatbotSns
-ChatChannel_Empty <EmptyChatChannel>
Used to remove the chat channel from an incident record or response plan.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSSMIncidentsConfig>
Amazon.PowerShell.Cmdlets.SSMI.AmazonSSMIncidentsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A token ensuring that the operation is called only once with the specified details.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The long format of the response plan name. This field can contain spaces.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engagement <String[]>
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEngagements
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncidentTemplate_DedupeString <String>
The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncidentTemplate_Impact <Int32>
The impact of the incident on your customers and applications.Supported impact codes
  • 1 - Critical
  • 2 - High
  • 3 - Medium
  • 4 - Low
  • 5 - No Impact
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncidentTemplate_IncidentTag <Hashtable>
Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncidentTemplate_IncidentTags
-IncidentTemplate_NotificationTarget <NotificationTargetItem[]>
The Amazon SNS targets that are notified when updates are made to an incident.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncidentTemplate_NotificationTargets
-IncidentTemplate_Summary <String>
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncidentTemplate_Title <String>
The title of the incident.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Integration <Integration[]>
Information about third-party services integrated into the response plan.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIntegrations
-Name <String>
The short format name of the response plan. Can't include spaces.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMIncidents.Model.CreateResponsePlanResponse). Specifying the name of a property of type Amazon.SSMIncidents.Model.CreateResponsePlanResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A list of tags that you are adding to the response plan.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.SSMIncidents.Model.CreateResponsePlanResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z