Module: Aws::SSMIncidents::Types

Defined in:
gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb

Defined Under Namespace

Classes: AccessDeniedException, Action, AddRegionAction, AttributeValueList, AutomationExecution, ChatChannel, Condition, ConflictException, CreateReplicationSetInput, CreateReplicationSetOutput, CreateResponsePlanInput, CreateResponsePlanOutput, CreateTimelineEventInput, CreateTimelineEventOutput, DeleteIncidentRecordInput, DeleteIncidentRecordOutput, DeleteRegionAction, DeleteReplicationSetInput, DeleteReplicationSetOutput, DeleteResourcePolicyInput, DeleteResourcePolicyOutput, DeleteResponsePlanInput, DeleteResponsePlanOutput, DeleteTimelineEventInput, DeleteTimelineEventOutput, DynamicSsmParameterValue, EventReference, EventSummary, Filter, GetIncidentRecordInput, GetIncidentRecordOutput, GetReplicationSetInput, GetReplicationSetOutput, GetResourcePoliciesInput, GetResourcePoliciesOutput, GetResponsePlanInput, GetResponsePlanOutput, GetTimelineEventInput, GetTimelineEventOutput, IncidentRecord, IncidentRecordSource, IncidentRecordSummary, IncidentTemplate, Integration, InternalServerException, ItemIdentifier, ItemValue, ListIncidentRecordsInput, ListIncidentRecordsOutput, ListRelatedItemsInput, ListRelatedItemsOutput, ListReplicationSetsInput, ListReplicationSetsOutput, ListResponsePlansInput, ListResponsePlansOutput, ListTagsForResourceRequest, ListTagsForResourceResponse, ListTimelineEventsInput, ListTimelineEventsOutput, NotificationTargetItem, PagerDutyConfiguration, PagerDutyIncidentConfiguration, PagerDutyIncidentDetail, PutResourcePolicyInput, PutResourcePolicyOutput, RegionInfo, RegionMapInputValue, RelatedItem, RelatedItemsUpdate, ReplicationSet, ResourceNotFoundException, ResourcePolicy, ResponsePlanSummary, ServiceQuotaExceededException, SsmAutomation, StartIncidentInput, StartIncidentOutput, TagResourceRequest, TagResourceResponse, ThrottlingException, TimelineEvent, TriggerDetails, UntagResourceRequest, UntagResourceResponse, UpdateDeletionProtectionInput, UpdateDeletionProtectionOutput, UpdateIncidentRecordInput, UpdateIncidentRecordOutput, UpdateRelatedItemsInput, UpdateRelatedItemsOutput, UpdateReplicationSetAction, UpdateReplicationSetInput, UpdateReplicationSetOutput, UpdateResponsePlanInput, UpdateResponsePlanOutput, UpdateTimelineEventInput, UpdateTimelineEventOutput, ValidationException

Instance Attribute Summary collapse

Instance Attribute Details

#add_region_actionTypes::AddRegionAction

Details about the Amazon Web Services Region that you're adding to the replication set.



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2203

class UpdateReplicationSetAction < Struct.new(
  :add_region_action,
  :delete_region_action,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddRegionAction < UpdateReplicationSetAction; end
  class DeleteRegionAction < UpdateReplicationSetAction; end
  class Unknown < UpdateReplicationSetAction; end
end

#afterTime

After the specified timestamp.

Returns:

  • (Time)


174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 174

class Condition < Struct.new(
  :after,
  :before,
  :equals,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class After < Condition; end
  class Before < Condition; end
  class Equals < Condition; end
  class Unknown < Condition; end
end

#arnString

The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

Returns:

  • (String)


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

class ItemValue < Struct.new(
  :arn,
  :metric_definition,
  :pager_duty_incident_detail,
  :url,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Arn < ItemValue; end
  class MetricDefinition < ItemValue; end
  class PagerDutyIncidentDetail < ItemValue; end
  class Url < ItemValue; end
  class Unknown < ItemValue; end
end

#beforeTime

Before the specified timestamp

Returns:

  • (Time)


174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 174

class Condition < Struct.new(
  :after,
  :before,
  :equals,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class After < Condition; end
  class Before < Condition; end
  class Equals < Condition; end
  class Unknown < Condition; end
end

#chatbot_snsArray<String>

The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.

Returns:

  • (Array<String>)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 139

class ChatChannel < Struct.new(
  :chatbot_sns,
  :empty,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ChatbotSns < ChatChannel; end
  class Empty < ChatChannel; end
  class Unknown < ChatChannel; end
end

#delete_region_actionTypes::DeleteRegionAction

Details about the Amazon Web Services Region that you're deleting to the replication set.



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2203

class UpdateReplicationSetAction < Struct.new(
  :add_region_action,
  :delete_region_action,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddRegionAction < UpdateReplicationSetAction; end
  class DeleteRegionAction < UpdateReplicationSetAction; end
  class Unknown < UpdateReplicationSetAction; end
end

#emptyTypes::EmptyChatChannel

Used to remove the chat channel from an incident record or response plan.

Returns:

  • (Types::EmptyChatChannel)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 139

class ChatChannel < Struct.new(
  :chatbot_sns,
  :empty,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ChatbotSns < ChatChannel; end
  class Empty < ChatChannel; end
  class Unknown < ChatChannel; end
end

#equalsTypes::AttributeValueList

The value is equal to the provided string or integer.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 174

class Condition < Struct.new(
  :after,
  :before,
  :equals,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class After < Condition; end
  class Before < Condition; end
  class Equals < Condition; end
  class Unknown < Condition; end
end

#integer_valuesArray<Integer>

The list of integer values that the filter matches.

Returns:

  • (Array<Integer>)


85
86
87
88
89
90
91
92
93
94
95
96
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 85

class AttributeValueList < Struct.new(
  :integer_values,
  :string_values,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class IntegerValues < AttributeValueList; end
  class StringValues < AttributeValueList; end
  class Unknown < AttributeValueList; end
end

#item_to_addTypes::RelatedItem

Details about the related item you're adding.

Returns:



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1604

class RelatedItemsUpdate < Struct.new(
  :item_to_add,
  :item_to_remove,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ItemToAdd < RelatedItemsUpdate; end
  class ItemToRemove < RelatedItemsUpdate; end
  class Unknown < RelatedItemsUpdate; end
end

#item_to_removeTypes::ItemIdentifier

Details about the related item you're deleting.



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1604

class RelatedItemsUpdate < Struct.new(
  :item_to_add,
  :item_to_remove,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ItemToAdd < RelatedItemsUpdate; end
  class ItemToRemove < RelatedItemsUpdate; end
  class Unknown < RelatedItemsUpdate; end
end

#metric_definitionString

The metric definition, if the related item is a metric in Amazon CloudWatch.

Returns:

  • (String)


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

class ItemValue < Struct.new(
  :arn,
  :metric_definition,
  :pager_duty_incident_detail,
  :url,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Arn < ItemValue; end
  class MetricDefinition < ItemValue; end
  class PagerDutyIncidentDetail < ItemValue; end
  class Url < ItemValue; end
  class Unknown < ItemValue; end
end

#pager_duty_configurationTypes::PagerDutyConfiguration

Information about the PagerDuty service where the response plan creates an incident.



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1038

class Integration < Struct.new(
  :pager_duty_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class PagerDutyConfiguration < Integration; end
  class Unknown < Integration; end
end

#pager_duty_incident_detailTypes::PagerDutyIncidentDetail

Details about an incident that is associated with a PagerDuty incident.



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

class ItemValue < Struct.new(
  :arn,
  :metric_definition,
  :pager_duty_incident_detail,
  :url,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Arn < ItemValue; end
  class MetricDefinition < ItemValue; end
  class PagerDutyIncidentDetail < ItemValue; end
  class Url < ItemValue; end
  class Unknown < ItemValue; end
end

The ID of a RelatedItem referenced in a TimelineEvent.

Returns:

  • (String)


559
560
561
562
563
564
565
566
567
568
569
570
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 559

class EventReference < Struct.new(
  :related_item_id,
  :resource,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RelatedItemId < EventReference; end
  class Resource < EventReference; end
  class Unknown < EventReference; end
end

#resourceString

The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

Returns:

  • (String)


559
560
561
562
563
564
565
566
567
568
569
570
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 559

class EventReference < Struct.new(
  :related_item_id,
  :resource,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RelatedItemId < EventReference; end
  class Resource < EventReference; end
  class Unknown < EventReference; end
end

#sns_topic_arnString

The Amazon Resource Name (ARN) of the SNS topic.

Returns:

  • (String)


1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1402

class NotificationTargetItem < Struct.new(
  :sns_topic_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SnsTopicArn < NotificationTargetItem; end
  class Unknown < NotificationTargetItem; end
end

#ssm_automationTypes::SsmAutomation

The Systems Manager automation document to start as the runbook at the beginning of the incident.



40
41
42
43
44
45
46
47
48
49
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 40

class Action < Struct.new(
  :ssm_automation,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SsmAutomation < Action; end
  class Unknown < Action; end
end

#ssm_execution_arnString

The Amazon Resource Name (ARN) of the automation process.

Returns:

  • (String)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 109

class AutomationExecution < Struct.new(
  :ssm_execution_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SsmExecutionArn < AutomationExecution; end
  class Unknown < AutomationExecution; end
end

#string_valuesArray<String>

The list of string values that the filter matches.

Returns:

  • (Array<String>)


85
86
87
88
89
90
91
92
93
94
95
96
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 85

class AttributeValueList < Struct.new(
  :integer_values,
  :string_values,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class IntegerValues < AttributeValueList; end
  class StringValues < AttributeValueList; end
  class Unknown < AttributeValueList; end
end

#urlString

The URL, if the related item is a non-Amazon Web Services resource.

Returns:

  • (String)


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

class ItemValue < Struct.new(
  :arn,
  :metric_definition,
  :pager_duty_incident_detail,
  :url,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Arn < ItemValue; end
  class MetricDefinition < ItemValue; end
  class PagerDutyIncidentDetail < ItemValue; end
  class Url < ItemValue; end
  class Unknown < ItemValue; end
end

#variableString

Variable dynamic parameters. A parameter value is determined when an incident is created.

Returns:

  • (String)


520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 520

class DynamicSsmParameterValue < Struct.new(
  :variable,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Variable < DynamicSsmParameterValue; end
  class Unknown < DynamicSsmParameterValue; end
end