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.

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, EventSummary, Filter, GetIncidentRecordInput, GetIncidentRecordOutput, GetReplicationSetInput, GetReplicationSetOutput, GetResourcePoliciesInput, GetResourcePoliciesOutput, GetResponsePlanInput, GetResponsePlanOutput, GetTimelineEventInput, GetTimelineEventOutput, IncidentRecord, IncidentRecordSource, IncidentRecordSummary, IncidentTemplate, InternalServerException, ItemIdentifier, ItemValue, ListIncidentRecordsInput, ListIncidentRecordsOutput, ListRelatedItemsInput, ListRelatedItemsOutput, ListReplicationSetsInput, ListReplicationSetsOutput, ListResponsePlansInput, ListResponsePlansOutput, ListTagsForResourceRequest, ListTagsForResourceResponse, ListTimelineEventsInput, ListTimelineEventsOutput, NotificationTargetItem, 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 Region that you're adding to the replication set.



2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2394

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)


182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 182

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)


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1184

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

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

#beforeTime

Before the specified timestamp

Returns:

  • (Time)


182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 182

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 SNS targets that AWS 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 SNS topics.

Returns:

  • (Array<String>)


147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 147

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 Region that you're deleting to the replication set.



2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2394

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)


147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 147

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.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 182

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>)


92
93
94
95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 92

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:



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1678

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.



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1678

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 CloudWatch.

Returns:

  • (String)


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1184

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

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

#sns_topic_arnString

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

Returns:

  • (String)


1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1530

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)


116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 116

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>)


92
93
94
95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 92

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-AWS resource.

Returns:

  • (String)


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1184

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

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