Class: Aws::SSMIncidents::Types::UpdateResponsePlanInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb

Overview

Note:

When making an API call, you may pass UpdateResponsePlanInput data as a hash:

{
  actions: [
    {
      ssm_automation: {
        document_name: "SsmAutomationDocumentNameString", # required
        document_version: "SsmAutomationDocumentVersionString",
        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_title: "IncidentTitle",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::Action>

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

Returns:



2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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_title)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

  • (String) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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

Returns:



2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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

Returns:

  • (String) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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_title)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

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

Returns:

  • (String) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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_title)
  SENSITIVE = []
  include Aws::Structure
end

#engagements ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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

Returns:

  • (String) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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_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 impact

  • 4 - High impact

  • 3 - Medium impact

  • 2 - Low impact

  • 1 - No impact

Returns:

  • (Integer) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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

Returns:



2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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

Returns:

  • (String) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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_title)
  SENSITIVE = []
  include Aws::Structure
end

#incident_template_title ⇒ String

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

Returns:

  • (String) 


2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2603

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_title)
  SENSITIVE = []
  include Aws::Structure
end