Class: Aws::SSMIncidents::Types::UpdateResponsePlanInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSMIncidents::Types::UpdateResponsePlanInput
- Defined in:
- gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb
Overview
When making an API call, you may pass UpdateResponsePlanInput data as a hash:
{
actions: [
{
ssm_automation: {
document_name: "SsmAutomationDocumentNameString", # required
document_version: "SsmAutomationDocumentVersionString",
dynamic_parameters: {
"DynamicSsmParametersKeyString" => {
variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
},
},
parameters: {
"SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
},
role_arn: "RoleArn", # required
target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
},
},
],
arn: "Arn", # required
chat_channel: {
chatbot_sns: ["SnsArn"],
empty: {
},
},
client_token: "ClientToken",
display_name: "ResponsePlanDisplayName",
engagements: ["SsmContactsArn"],
incident_template_dedupe_string: "DedupeString",
incident_template_impact: 1,
incident_template_notification_targets: [
{
sns_topic_arn: "Arn",
},
],
incident_template_summary: "IncidentSummary",
incident_template_tags: {
"TagKey" => "TagValue",
},
incident_template_title: "IncidentTitle",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#actions ⇒ Array<Types::Action>
The actions that this response plan takes at the beginning of an incident.
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the response plan.
-
#chat_channel ⇒ Types::ChatChannel
The Chatbot chat channel used for collaboration during an incident.
-
#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.
-
#engagements ⇒ Array<String>
The contacts and escalation plans that Incident Manager engages at the start of the incident.
-
#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.
-
#incident_template_notification_targets ⇒ Array<Types::NotificationTargetItem>
The Amazon SNS targets that are notified when updates are made to an incident.
-
#incident_template_summary ⇒ String
A brief summary of the incident.
-
#incident_template_tags ⇒ Hash<String,String>
Tags to apply to an incident when calling the
StartIncident
API action. -
#incident_template_title ⇒ String
The short format name of the incident.
Instance Attribute Details
#actions ⇒ Array<Types::Action>
The actions that this response plan takes at the beginning of an incident.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ String
The Amazon Resource Name (ARN) of the response plan.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#chat_channel ⇒ Types::ChatChannel
The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#client_token ⇒ String
A token ensuring that the operation is called only once with the specified details.
A suitable default value is auto-generated. You should normally not need to pass this option.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#display_name ⇒ String
The long format name of the response plan. The display name can't contain spaces.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#engagements ⇒ Array<String>
The contacts and escalation plans that Incident Manager engages at the start of the incident.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#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.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#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 impact4
- High impact3
- Medium impact2
- Low impact1
- No impact
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#incident_template_notification_targets ⇒ Array<Types::NotificationTargetItem>
The Amazon SNS targets that are notified when updates are made to an incident.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#incident_template_summary ⇒ String
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#incident_template_tags ⇒ Hash<String,String>
Tags to apply to an incident when calling the StartIncident
API
action. To call this action, you must also have permission to call
the TagResource
API action for the incident record resource.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |
#incident_template_title ⇒ String
The short format name of the incident. The title can't contain spaces.
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 |
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2657 class UpdateResponsePlanInput < Struct.new( :actions, :arn, :chat_channel, :client_token, :display_name, :engagements, :incident_template_dedupe_string, :incident_template_impact, :incident_template_notification_targets, :incident_template_summary, :incident_template_tags, :incident_template_title) SENSITIVE = [] include Aws::Structure end |