Class: Aws::SSMIncidents::Types::UpdateIncidentRecordInput

Inherits:

Struct

• Object
• Struct
• Aws::SSMIncidents::Types::UpdateIncidentRecordInput

Defined in:

gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the incident record you are updating.

• #chat_channel ⇒ Types::ChatChannel

  The Chatbot chat channel where responders can collaborate.

• #client_token ⇒ String

  A token that ensures that a client calls the operation only once with the specified details.

• #impact ⇒ Integer

  Defines the impact of the incident to customers and applications.

• #notification_targets ⇒ Array<Types::NotificationTargetItem>

  The Amazon SNS targets that Incident Manager notifies when a client updates an incident.

• #status ⇒ String

  The status of the incident.

• #summary ⇒ String

  A longer description of what occurred during the incident.

• #title ⇒ String

  A brief description of the incident.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the incident record you are updating.

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#chat_channel ⇒ Types::ChatChannel

The Chatbot chat channel where responders can collaborate.

Returns:

• (Types::ChatChannel)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that ensures that a client calls the operation 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 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#impact ⇒ Integer

Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.

Supported impact codes

• 1 - Critical

• 2 - High

• 3 - Medium

• 4 - Low

• 5 - No Impact

Returns:

• (Integer)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#notification_targets ⇒ Array<Types::NotificationTargetItem>

The Amazon SNS targets that Incident Manager notifies when a client updates an incident.

Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.

Returns:

• (Array<Types::NotificationTargetItem>)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the incident. Possible statuses are Open or Resolved.

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#summary ⇒ String

A longer description of what occurred during the incident.

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

A brief description of the incident.

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2437

class UpdateIncidentRecordInput < Struct.new(
  :arn,
  :chat_channel,
  :client_token,
  :impact,
  :notification_targets,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end