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, BatchGetIncidentFindingsError, BatchGetIncidentFindingsInput, BatchGetIncidentFindingsOutput, ChatChannel, CloudFormationStackUpdate, CodeDeployDeployment, Condition, ConflictException, CreateReplicationSetInput, CreateReplicationSetOutput, CreateResponsePlanInput, CreateResponsePlanOutput, CreateTimelineEventInput, CreateTimelineEventOutput, DeleteIncidentRecordInput, DeleteIncidentRecordOutput, DeleteRegionAction, DeleteReplicationSetInput, DeleteReplicationSetOutput, DeleteResourcePolicyInput, DeleteResourcePolicyOutput, DeleteResponsePlanInput, DeleteResponsePlanOutput, DeleteTimelineEventInput, DeleteTimelineEventOutput, DynamicSsmParameterValue, EventReference, EventSummary, Filter, Finding, FindingDetails, FindingSummary, GetIncidentRecordInput, GetIncidentRecordOutput, GetReplicationSetInput, GetReplicationSetOutput, GetResourcePoliciesInput, GetResourcePoliciesOutput, GetResponsePlanInput, GetResponsePlanOutput, GetTimelineEventInput, GetTimelineEventOutput, IncidentRecord, IncidentRecordSource, IncidentRecordSummary, IncidentTemplate, Integration, InternalServerException, ItemIdentifier, ItemValue, ListIncidentFindingsInput, ListIncidentFindingsOutput, 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_action ⇒ Types::AddRegionAction

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

Returns:



2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2502

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

#after ⇒ Time

After the specified timestamp.

Returns:

  • (Time) 


298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 298

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

#arn ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1360

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

#before ⇒ Time

Before the specified timestamp

Returns:

  • (Time) 


298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 298

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_sns ⇒ Array<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>) 


202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 202

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

#cloud_formation_stack_update ⇒ Types::CloudFormationStackUpdate

Information about the CloudFormation stack creation or update associated with the finding.

Returns:



811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 811

class FindingDetails < Struct.new(
  :cloud_formation_stack_update,
  :code_deploy_deployment,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CloudFormationStackUpdate < FindingDetails; end
  class CodeDeployDeployment < FindingDetails; end
  class Unknown < FindingDetails; end
end

#code_deploy_deployment ⇒ Types::CodeDeployDeployment

Information about the CodeDeploy deployment associated with the finding.

Returns:



811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 811

class FindingDetails < Struct.new(
  :cloud_formation_stack_update,
  :code_deploy_deployment,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CloudFormationStackUpdate < FindingDetails; end
  class CodeDeployDeployment < FindingDetails; end
  class Unknown < FindingDetails; end
end

#delete_region_action ⇒ Types::DeleteRegionAction

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

Returns:



2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2502

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

#empty ⇒ Types::EmptyChatChannel

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

Returns:

  • (Types::EmptyChatChannel) 


202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 202

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

#equals ⇒ Types::AttributeValueList

The value is equal to the provided string or integer.

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 298

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_values ⇒ Array<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_add ⇒ Types::RelatedItem

Details about the related item you're adding.

Returns:



1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1910

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_remove ⇒ Types::ItemIdentifier

Details about the related item you're deleting.

Returns:



1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1910

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_definition ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1360

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_configuration ⇒ Types::PagerDutyConfiguration

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

Returns:



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1289

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_detail ⇒ Types::PagerDutyIncidentDetail

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

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1360

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

#related_item_id ⇒ String

The ID of a RelatedItem referenced in a TimelineEvent.

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 688

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

#resource ⇒ String

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

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 688

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_arn ⇒ String

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

Returns:

  • (String) 


1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1708

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_automation ⇒ Types::SsmAutomation

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

Returns:



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_arn ⇒ String

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_values ⇒ Array<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

#url ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1360

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

#variable ⇒ String

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

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 649

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

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