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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::Action>

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

Returns:



2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#arnString

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

Returns:

  • (String)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#chat_channelTypes::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:



2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#client_tokenString

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)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#display_nameString

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

Returns:

  • (String)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#engagementsArray<String>

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

Returns:

  • (Array<String>)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#incident_template_dedupe_stringString

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

Returns:

  • (String)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#incident_template_impactInteger

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

Returns:

  • (Integer)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#incident_template_notification_targetsArray<Types::NotificationTargetItem>

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

Returns:



2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#incident_template_summaryString

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

Returns:

  • (String)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#incident_template_tagsHash<String,String>

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. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

Returns:

  • (Hash<String,String>)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#incident_template_titleString

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

Returns:

  • (String)


2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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

#integrationsArray<Types::Integration>

Information about third-party services integrated into the response plan.

Returns:



2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2632

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