AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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 UpdateIncidentRecordInput data as a hash:

{
  arn: "Arn", # required
  chat_channel: {
    chatbot_sns: ["SnsArn"],
    empty: {
    },
  },
  client_token: "ClientToken",
  impact: 1,
  notification_targets: [
    {
      sns_topic_arn: "Arn",
    },
  ],
  status: "OPEN", # accepts OPEN, RESOLVED
  summary: "IncidentSummary",
  title: "IncidentTitle",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#chat_channelTypes::ChatChannel

The AWS Chatbot chat channel for responders to collaborate in.

Returns:



2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#client_tokenString

A token ensuring that the action 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)


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#impactInteger

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

Possible impacts:

  • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

  • 2 - High impact, partial application failure with impact to many customers.

  • 3 - Medium impact, the application is providing reduced service to customers.

  • 4 - Low impact, customer might aren't impacted by the problem yet.

  • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

Returns:

  • (Integer)


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#notification_targetsArray<Types::NotificationTargetItem>

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

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

Returns:



2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#statusString

The status of the incident. An incident can be Open or Resolved.

Returns:

  • (String)


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#summaryString

The summary describes what has happened during the incident.

Returns:

  • (String)


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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

#titleString

The title of the incident is a brief and easily recognizable.

Returns:

  • (String)


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2302

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