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

Inherits:

Struct

• Object
• Struct
• Aws::SSMIncidents::Types::UpdateResponsePlanInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssmincidents/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an 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 assign to the template.

• #incident_template_title ⇒ String

  The short format name of the incident.

• #integrations ⇒ Array<Types::Integration>

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

Instance Attribute Details

#actions ⇒ Array<Types::Action>

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

Returns:

• (Array<Types::Action>)

# File '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

#arn ⇒ String

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

Returns:

• (String)

# File '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_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:

• (Types::ChatChannel)

# File '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_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)

# File '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_name ⇒ String

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

Returns:

• (String)

# File '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

#engagements ⇒ Array<String>

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

Returns:

• (Array<String>)

# File '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_string ⇒ String

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

Returns:

• (String)

# File '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_impact ⇒ Integer

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)

# File '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_targets ⇒ Array<Types::NotificationTargetItem>

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

Returns:

• (Array<Types::NotificationTargetItem>)

# File '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_summary ⇒ String

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

Returns:

• (String)

# File '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_tags ⇒ Hash<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>)

# File '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_title ⇒ String

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

Returns:

• (String)

# File '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

#integrations ⇒ Array<Types::Integration>

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

Returns:

• (Array<Types::Integration>)

# File '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