Class: Aws::SSMIncidents::Types::IncidentRecord

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

Overview

The record of the incident that's created when an incident occurs.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#automation_executionsArray<Types::AutomationExecution>

The runbook, or automation document, that's run at the beginning of the incident.

Returns:



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#chat_channelTypes::ChatChannel

The chat channel used for collaboration during an incident.

Returns:



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The timestamp for when Incident Manager created the incident record.

Returns:

  • (Time)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#dedupe_stringString

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

Returns:

  • (String)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#impactInteger

The impact of the incident on customers and applications.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

Returns:

  • (Integer)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#incident_record_sourceTypes::IncidentRecordSource

Details about the action that started the incident.



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_byString

Who modified the incident most recently.

Returns:

  • (String)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

The timestamp for when the incident was most recently modified.

Returns:

  • (Time)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#notification_targetsArray<Types::NotificationTargetItem>

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

Returns:



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#resolved_timeTime

The timestamp for when the incident was resolved. This appears as a timeline event.

Returns:

  • (Time)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the incident.

Returns:

  • (String)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#summaryString

The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.

Returns:

  • (String)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

The title of the incident.

Returns:

  • (String)


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1106

class IncidentRecord < Struct.new(
  :arn,
  :automation_executions,
  :chat_channel,
  :creation_time,
  :dedupe_string,
  :impact,
  :incident_record_source,
  :last_modified_by,
  :last_modified_time,
  :notification_targets,
  :resolved_time,
  :status,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end