aws-sdk-ssmincidents 1.19.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssmincidents/client.rb +54 -1
- data/lib/aws-sdk-ssmincidents/client_api.rb +36 -0
- data/lib/aws-sdk-ssmincidents/endpoint_provider.rb +35 -96
- data/lib/aws-sdk-ssmincidents/types.rb +121 -543
- data/lib/aws-sdk-ssmincidents.rb +1 -1
- metadata +2 -2
@@ -51,14 +51,6 @@ module Aws::SSMIncidents
|
|
51
51
|
# Defines the Amazon Web Services Region and KMS key to add to the
|
52
52
|
# replication set.
|
53
53
|
#
|
54
|
-
# @note When making an API call, you may pass AddRegionAction
|
55
|
-
# data as a hash:
|
56
|
-
#
|
57
|
-
# {
|
58
|
-
# region_name: "RegionName", # required
|
59
|
-
# sse_kms_key_id: "SseKmsKey",
|
60
|
-
# }
|
61
|
-
#
|
62
54
|
# @!attribute [rw] region_name
|
63
55
|
# The Amazon Web Services Region name to add to the replication set.
|
64
56
|
# @return [String]
|
@@ -223,21 +215,6 @@ module Aws::SSMIncidents
|
|
223
215
|
include Aws::Structure
|
224
216
|
end
|
225
217
|
|
226
|
-
# @note When making an API call, you may pass CreateReplicationSetInput
|
227
|
-
# data as a hash:
|
228
|
-
#
|
229
|
-
# {
|
230
|
-
# client_token: "ClientToken",
|
231
|
-
# regions: { # required
|
232
|
-
# "RegionName" => {
|
233
|
-
# sse_kms_key_id: "SseKmsKey",
|
234
|
-
# },
|
235
|
-
# },
|
236
|
-
# tags: {
|
237
|
-
# "TagKey" => "TagValue",
|
238
|
-
# },
|
239
|
-
# }
|
240
|
-
#
|
241
218
|
# @!attribute [rw] client_token
|
242
219
|
# A token that ensures that the operation is called only once with the
|
243
220
|
# specified details.
|
@@ -277,56 +254,6 @@ module Aws::SSMIncidents
|
|
277
254
|
include Aws::Structure
|
278
255
|
end
|
279
256
|
|
280
|
-
# @note When making an API call, you may pass CreateResponsePlanInput
|
281
|
-
# data as a hash:
|
282
|
-
#
|
283
|
-
# {
|
284
|
-
# actions: [
|
285
|
-
# {
|
286
|
-
# ssm_automation: {
|
287
|
-
# document_name: "SsmAutomationDocumentNameString", # required
|
288
|
-
# document_version: "SsmAutomationDocumentVersionString",
|
289
|
-
# dynamic_parameters: {
|
290
|
-
# "DynamicSsmParametersKeyString" => {
|
291
|
-
# variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
|
292
|
-
# },
|
293
|
-
# },
|
294
|
-
# parameters: {
|
295
|
-
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
296
|
-
# },
|
297
|
-
# role_arn: "RoleArn", # required
|
298
|
-
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
299
|
-
# },
|
300
|
-
# },
|
301
|
-
# ],
|
302
|
-
# chat_channel: {
|
303
|
-
# chatbot_sns: ["SnsArn"],
|
304
|
-
# empty: {
|
305
|
-
# },
|
306
|
-
# },
|
307
|
-
# client_token: "ClientToken",
|
308
|
-
# display_name: "ResponsePlanDisplayName",
|
309
|
-
# engagements: ["SsmContactsArn"],
|
310
|
-
# incident_template: { # required
|
311
|
-
# dedupe_string: "DedupeString",
|
312
|
-
# impact: 1, # required
|
313
|
-
# incident_tags: {
|
314
|
-
# "TagKey" => "TagValue",
|
315
|
-
# },
|
316
|
-
# notification_targets: [
|
317
|
-
# {
|
318
|
-
# sns_topic_arn: "Arn",
|
319
|
-
# },
|
320
|
-
# ],
|
321
|
-
# summary: "IncidentSummary",
|
322
|
-
# title: "IncidentTitle", # required
|
323
|
-
# },
|
324
|
-
# name: "ResponsePlanName", # required
|
325
|
-
# tags: {
|
326
|
-
# "TagKey" => "TagValue",
|
327
|
-
# },
|
328
|
-
# }
|
329
|
-
#
|
330
257
|
# @!attribute [rw] actions
|
331
258
|
# The actions that the response plan starts at the beginning of an
|
332
259
|
# incident.
|
@@ -358,6 +285,11 @@ module Aws::SSMIncidents
|
|
358
285
|
# Details used to create an incident when using this response plan.
|
359
286
|
# @return [Types::IncidentTemplate]
|
360
287
|
#
|
288
|
+
# @!attribute [rw] integrations
|
289
|
+
# Information about third-party services integrated into the response
|
290
|
+
# plan.
|
291
|
+
# @return [Array<Types::Integration>]
|
292
|
+
#
|
361
293
|
# @!attribute [rw] name
|
362
294
|
# The short format name of the response plan. Can't include spaces.
|
363
295
|
# @return [String]
|
@@ -375,6 +307,7 @@ module Aws::SSMIncidents
|
|
375
307
|
:display_name,
|
376
308
|
:engagements,
|
377
309
|
:incident_template,
|
310
|
+
:integrations,
|
378
311
|
:name,
|
379
312
|
:tags)
|
380
313
|
SENSITIVE = []
|
@@ -393,23 +326,6 @@ module Aws::SSMIncidents
|
|
393
326
|
include Aws::Structure
|
394
327
|
end
|
395
328
|
|
396
|
-
# @note When making an API call, you may pass CreateTimelineEventInput
|
397
|
-
# data as a hash:
|
398
|
-
#
|
399
|
-
# {
|
400
|
-
# client_token: "ClientToken",
|
401
|
-
# event_data: "EventData", # required
|
402
|
-
# event_references: [
|
403
|
-
# {
|
404
|
-
# related_item_id: "GeneratedId",
|
405
|
-
# resource: "Arn",
|
406
|
-
# },
|
407
|
-
# ],
|
408
|
-
# event_time: Time.now, # required
|
409
|
-
# event_type: "TimelineEventType", # required
|
410
|
-
# incident_record_arn: "Arn", # required
|
411
|
-
# }
|
412
|
-
#
|
413
329
|
# @!attribute [rw] client_token
|
414
330
|
# A token ensuring that the action is called only once with the
|
415
331
|
# specified details.
|
@@ -477,13 +393,6 @@ module Aws::SSMIncidents
|
|
477
393
|
include Aws::Structure
|
478
394
|
end
|
479
395
|
|
480
|
-
# @note When making an API call, you may pass DeleteIncidentRecordInput
|
481
|
-
# data as a hash:
|
482
|
-
#
|
483
|
-
# {
|
484
|
-
# arn: "Arn", # required
|
485
|
-
# }
|
486
|
-
#
|
487
396
|
# @!attribute [rw] arn
|
488
397
|
# The Amazon Resource Name (ARN) of the incident record you are
|
489
398
|
# deleting.
|
@@ -504,13 +413,6 @@ module Aws::SSMIncidents
|
|
504
413
|
# Defines the information about the Amazon Web Services Region you're
|
505
414
|
# deleting from your replication set.
|
506
415
|
#
|
507
|
-
# @note When making an API call, you may pass DeleteRegionAction
|
508
|
-
# data as a hash:
|
509
|
-
#
|
510
|
-
# {
|
511
|
-
# region_name: "RegionName", # required
|
512
|
-
# }
|
513
|
-
#
|
514
416
|
# @!attribute [rw] region_name
|
515
417
|
# The name of the Amazon Web Services Region you're deleting from the
|
516
418
|
# replication set.
|
@@ -524,13 +426,6 @@ module Aws::SSMIncidents
|
|
524
426
|
include Aws::Structure
|
525
427
|
end
|
526
428
|
|
527
|
-
# @note When making an API call, you may pass DeleteReplicationSetInput
|
528
|
-
# data as a hash:
|
529
|
-
#
|
530
|
-
# {
|
531
|
-
# arn: "Arn", # required
|
532
|
-
# }
|
533
|
-
#
|
534
429
|
# @!attribute [rw] arn
|
535
430
|
# The Amazon Resource Name (ARN) of the replication set you're
|
536
431
|
# deleting.
|
@@ -548,14 +443,6 @@ module Aws::SSMIncidents
|
|
548
443
|
#
|
549
444
|
class DeleteReplicationSetOutput < Aws::EmptyStructure; end
|
550
445
|
|
551
|
-
# @note When making an API call, you may pass DeleteResourcePolicyInput
|
552
|
-
# data as a hash:
|
553
|
-
#
|
554
|
-
# {
|
555
|
-
# policy_id: "PolicyId", # required
|
556
|
-
# resource_arn: "Arn", # required
|
557
|
-
# }
|
558
|
-
#
|
559
446
|
# @!attribute [rw] policy_id
|
560
447
|
# The ID of the resource policy you're deleting.
|
561
448
|
# @return [String]
|
@@ -578,13 +465,6 @@ module Aws::SSMIncidents
|
|
578
465
|
#
|
579
466
|
class DeleteResourcePolicyOutput < Aws::EmptyStructure; end
|
580
467
|
|
581
|
-
# @note When making an API call, you may pass DeleteResponsePlanInput
|
582
|
-
# data as a hash:
|
583
|
-
#
|
584
|
-
# {
|
585
|
-
# arn: "Arn", # required
|
586
|
-
# }
|
587
|
-
#
|
588
468
|
# @!attribute [rw] arn
|
589
469
|
# The Amazon Resource Name (ARN) of the response plan.
|
590
470
|
# @return [String]
|
@@ -601,14 +481,6 @@ module Aws::SSMIncidents
|
|
601
481
|
#
|
602
482
|
class DeleteResponsePlanOutput < Aws::EmptyStructure; end
|
603
483
|
|
604
|
-
# @note When making an API call, you may pass DeleteTimelineEventInput
|
605
|
-
# data as a hash:
|
606
|
-
#
|
607
|
-
# {
|
608
|
-
# event_id: "UUID", # required
|
609
|
-
# incident_record_arn: "Arn", # required
|
610
|
-
# }
|
611
|
-
#
|
612
484
|
# @!attribute [rw] event_id
|
613
485
|
# The ID of the event you are updating. You can find this by using
|
614
486
|
# `ListTimelineEvents`.
|
@@ -739,21 +611,6 @@ module Aws::SSMIncidents
|
|
739
611
|
|
740
612
|
# Filter the selection by using a condition.
|
741
613
|
#
|
742
|
-
# @note When making an API call, you may pass Filter
|
743
|
-
# data as a hash:
|
744
|
-
#
|
745
|
-
# {
|
746
|
-
# condition: { # required
|
747
|
-
# after: Time.now,
|
748
|
-
# before: Time.now,
|
749
|
-
# equals: {
|
750
|
-
# integer_values: [1],
|
751
|
-
# string_values: ["StringListMemberString"],
|
752
|
-
# },
|
753
|
-
# },
|
754
|
-
# key: "FilterKeyString", # required
|
755
|
-
# }
|
756
|
-
#
|
757
614
|
# @!attribute [rw] condition
|
758
615
|
# The condition accepts before or after a specified time, equal to a
|
759
616
|
# string, or equal to an integer.
|
@@ -772,13 +629,6 @@ module Aws::SSMIncidents
|
|
772
629
|
include Aws::Structure
|
773
630
|
end
|
774
631
|
|
775
|
-
# @note When making an API call, you may pass GetIncidentRecordInput
|
776
|
-
# data as a hash:
|
777
|
-
#
|
778
|
-
# {
|
779
|
-
# arn: "Arn", # required
|
780
|
-
# }
|
781
|
-
#
|
782
632
|
# @!attribute [rw] arn
|
783
633
|
# The Amazon Resource Name (ARN) of the incident record.
|
784
634
|
# @return [String]
|
@@ -803,13 +653,6 @@ module Aws::SSMIncidents
|
|
803
653
|
include Aws::Structure
|
804
654
|
end
|
805
655
|
|
806
|
-
# @note When making an API call, you may pass GetReplicationSetInput
|
807
|
-
# data as a hash:
|
808
|
-
#
|
809
|
-
# {
|
810
|
-
# arn: "Arn", # required
|
811
|
-
# }
|
812
|
-
#
|
813
656
|
# @!attribute [rw] arn
|
814
657
|
# The Amazon Resource Name (ARN) of the replication set you want to
|
815
658
|
# retrieve.
|
@@ -835,15 +678,6 @@ module Aws::SSMIncidents
|
|
835
678
|
include Aws::Structure
|
836
679
|
end
|
837
680
|
|
838
|
-
# @note When making an API call, you may pass GetResourcePoliciesInput
|
839
|
-
# data as a hash:
|
840
|
-
#
|
841
|
-
# {
|
842
|
-
# max_results: 1,
|
843
|
-
# next_token: "NextToken",
|
844
|
-
# resource_arn: "Arn", # required
|
845
|
-
# }
|
846
|
-
#
|
847
681
|
# @!attribute [rw] max_results
|
848
682
|
# The maximum number of resource policies to display for each page of
|
849
683
|
# results.
|
@@ -885,13 +719,6 @@ module Aws::SSMIncidents
|
|
885
719
|
include Aws::Structure
|
886
720
|
end
|
887
721
|
|
888
|
-
# @note When making an API call, you may pass GetResponsePlanInput
|
889
|
-
# data as a hash:
|
890
|
-
#
|
891
|
-
# {
|
892
|
-
# arn: "Arn", # required
|
893
|
-
# }
|
894
|
-
#
|
895
722
|
# @!attribute [rw] arn
|
896
723
|
# The Amazon Resource Name (ARN) of the response plan.
|
897
724
|
# @return [String]
|
@@ -930,6 +757,11 @@ module Aws::SSMIncidents
|
|
930
757
|
# Details used to create the incident when using this response plan.
|
931
758
|
# @return [Types::IncidentTemplate]
|
932
759
|
#
|
760
|
+
# @!attribute [rw] integrations
|
761
|
+
# Information about third-party services integrated into the Incident
|
762
|
+
# Manager response plan.
|
763
|
+
# @return [Array<Types::Integration>]
|
764
|
+
#
|
933
765
|
# @!attribute [rw] name
|
934
766
|
# The short format name of the response plan. The name can't contain
|
935
767
|
# spaces.
|
@@ -944,19 +776,12 @@ module Aws::SSMIncidents
|
|
944
776
|
:display_name,
|
945
777
|
:engagements,
|
946
778
|
:incident_template,
|
779
|
+
:integrations,
|
947
780
|
:name)
|
948
781
|
SENSITIVE = []
|
949
782
|
include Aws::Structure
|
950
783
|
end
|
951
784
|
|
952
|
-
# @note When making an API call, you may pass GetTimelineEventInput
|
953
|
-
# data as a hash:
|
954
|
-
#
|
955
|
-
# {
|
956
|
-
# event_id: "UUID", # required
|
957
|
-
# incident_record_arn: "Arn", # required
|
958
|
-
# }
|
959
|
-
#
|
960
785
|
# @!attribute [rw] event_id
|
961
786
|
# The ID of the event. You can get an event's ID when you create it,
|
962
787
|
# or by using `ListTimelineEvents`.
|
@@ -1154,24 +979,6 @@ module Aws::SSMIncidents
|
|
1154
979
|
# Basic details used in creating a response plan. The response plan is
|
1155
980
|
# then used to create an incident record.
|
1156
981
|
#
|
1157
|
-
# @note When making an API call, you may pass IncidentTemplate
|
1158
|
-
# data as a hash:
|
1159
|
-
#
|
1160
|
-
# {
|
1161
|
-
# dedupe_string: "DedupeString",
|
1162
|
-
# impact: 1, # required
|
1163
|
-
# incident_tags: {
|
1164
|
-
# "TagKey" => "TagValue",
|
1165
|
-
# },
|
1166
|
-
# notification_targets: [
|
1167
|
-
# {
|
1168
|
-
# sns_topic_arn: "Arn",
|
1169
|
-
# },
|
1170
|
-
# ],
|
1171
|
-
# summary: "IncidentSummary",
|
1172
|
-
# title: "IncidentTitle", # required
|
1173
|
-
# }
|
1174
|
-
#
|
1175
982
|
# @!attribute [rw] dedupe_string
|
1176
983
|
# Used to stop Incident Manager from creating multiple incident
|
1177
984
|
# records for the same incident.
|
@@ -1214,6 +1021,31 @@ module Aws::SSMIncidents
|
|
1214
1021
|
include Aws::Structure
|
1215
1022
|
end
|
1216
1023
|
|
1024
|
+
# Information about third-party services integrated into a response
|
1025
|
+
# plan.
|
1026
|
+
#
|
1027
|
+
# @note Integration is a union - when making an API calls you must set exactly one of the members.
|
1028
|
+
#
|
1029
|
+
# @note Integration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Integration corresponding to the set member.
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] pager_duty_configuration
|
1032
|
+
# Information about the PagerDuty service where the response plan
|
1033
|
+
# creates an incident.
|
1034
|
+
# @return [Types::PagerDutyConfiguration]
|
1035
|
+
#
|
1036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/Integration AWS API Documentation
|
1037
|
+
#
|
1038
|
+
class Integration < Struct.new(
|
1039
|
+
:pager_duty_configuration,
|
1040
|
+
:unknown)
|
1041
|
+
SENSITIVE = []
|
1042
|
+
include Aws::Structure
|
1043
|
+
include Aws::Structure::Union
|
1044
|
+
|
1045
|
+
class PagerDutyConfiguration < Integration; end
|
1046
|
+
class Unknown < Integration; end
|
1047
|
+
end
|
1048
|
+
|
1217
1049
|
# The request processing has failed because of an unknown error,
|
1218
1050
|
# exception or failure.
|
1219
1051
|
#
|
@@ -1230,18 +1062,6 @@ module Aws::SSMIncidents
|
|
1230
1062
|
|
1231
1063
|
# Details and type of a related item.
|
1232
1064
|
#
|
1233
|
-
# @note When making an API call, you may pass ItemIdentifier
|
1234
|
-
# data as a hash:
|
1235
|
-
#
|
1236
|
-
# {
|
1237
|
-
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
1238
|
-
# value: { # required
|
1239
|
-
# arn: "Arn",
|
1240
|
-
# metric_definition: "MetricDefinition",
|
1241
|
-
# url: "Url",
|
1242
|
-
# },
|
1243
|
-
# }
|
1244
|
-
#
|
1245
1065
|
# @!attribute [rw] type
|
1246
1066
|
# The type of related item.
|
1247
1067
|
# @return [String]
|
@@ -1275,6 +1095,11 @@ module Aws::SSMIncidents
|
|
1275
1095
|
# CloudWatch.
|
1276
1096
|
# @return [String]
|
1277
1097
|
#
|
1098
|
+
# @!attribute [rw] pager_duty_incident_detail
|
1099
|
+
# Details about an incident that is associated with a PagerDuty
|
1100
|
+
# incident.
|
1101
|
+
# @return [Types::PagerDutyIncidentDetail]
|
1102
|
+
#
|
1278
1103
|
# @!attribute [rw] url
|
1279
1104
|
# The URL, if the related item is a non-Amazon Web Services resource.
|
1280
1105
|
# @return [String]
|
@@ -1284,6 +1109,7 @@ module Aws::SSMIncidents
|
|
1284
1109
|
class ItemValue < Struct.new(
|
1285
1110
|
:arn,
|
1286
1111
|
:metric_definition,
|
1112
|
+
:pager_duty_incident_detail,
|
1287
1113
|
:url,
|
1288
1114
|
:unknown)
|
1289
1115
|
SENSITIVE = []
|
@@ -1292,31 +1118,11 @@ module Aws::SSMIncidents
|
|
1292
1118
|
|
1293
1119
|
class Arn < ItemValue; end
|
1294
1120
|
class MetricDefinition < ItemValue; end
|
1121
|
+
class PagerDutyIncidentDetail < ItemValue; end
|
1295
1122
|
class Url < ItemValue; end
|
1296
1123
|
class Unknown < ItemValue; end
|
1297
1124
|
end
|
1298
1125
|
|
1299
|
-
# @note When making an API call, you may pass ListIncidentRecordsInput
|
1300
|
-
# data as a hash:
|
1301
|
-
#
|
1302
|
-
# {
|
1303
|
-
# filters: [
|
1304
|
-
# {
|
1305
|
-
# condition: { # required
|
1306
|
-
# after: Time.now,
|
1307
|
-
# before: Time.now,
|
1308
|
-
# equals: {
|
1309
|
-
# integer_values: [1],
|
1310
|
-
# string_values: ["StringListMemberString"],
|
1311
|
-
# },
|
1312
|
-
# },
|
1313
|
-
# key: "FilterKeyString", # required
|
1314
|
-
# },
|
1315
|
-
# ],
|
1316
|
-
# max_results: 1,
|
1317
|
-
# next_token: "NextToken",
|
1318
|
-
# }
|
1319
|
-
#
|
1320
1126
|
# @!attribute [rw] filters
|
1321
1127
|
# Filters the list of incident records through which you are
|
1322
1128
|
# searching. You can filter on the following keys:
|
@@ -1376,15 +1182,6 @@ module Aws::SSMIncidents
|
|
1376
1182
|
include Aws::Structure
|
1377
1183
|
end
|
1378
1184
|
|
1379
|
-
# @note When making an API call, you may pass ListRelatedItemsInput
|
1380
|
-
# data as a hash:
|
1381
|
-
#
|
1382
|
-
# {
|
1383
|
-
# incident_record_arn: "Arn", # required
|
1384
|
-
# max_results: 1,
|
1385
|
-
# next_token: "NextToken",
|
1386
|
-
# }
|
1387
|
-
#
|
1388
1185
|
# @!attribute [rw] incident_record_arn
|
1389
1186
|
# The Amazon Resource Name (ARN) of the incident record containing the
|
1390
1187
|
# listed related items.
|
@@ -1425,14 +1222,6 @@ module Aws::SSMIncidents
|
|
1425
1222
|
include Aws::Structure
|
1426
1223
|
end
|
1427
1224
|
|
1428
|
-
# @note When making an API call, you may pass ListReplicationSetsInput
|
1429
|
-
# data as a hash:
|
1430
|
-
#
|
1431
|
-
# {
|
1432
|
-
# max_results: 1,
|
1433
|
-
# next_token: "NextToken",
|
1434
|
-
# }
|
1435
|
-
#
|
1436
1225
|
# @!attribute [rw] max_results
|
1437
1226
|
# The maximum number of results per page.
|
1438
1227
|
# @return [Integer]
|
@@ -1467,14 +1256,6 @@ module Aws::SSMIncidents
|
|
1467
1256
|
include Aws::Structure
|
1468
1257
|
end
|
1469
1258
|
|
1470
|
-
# @note When making an API call, you may pass ListResponsePlansInput
|
1471
|
-
# data as a hash:
|
1472
|
-
#
|
1473
|
-
# {
|
1474
|
-
# max_results: 1,
|
1475
|
-
# next_token: "NextToken",
|
1476
|
-
# }
|
1477
|
-
#
|
1478
1259
|
# @!attribute [rw] max_results
|
1479
1260
|
# The maximum number of response plans per page.
|
1480
1261
|
# @return [Integer]
|
@@ -1509,13 +1290,6 @@ module Aws::SSMIncidents
|
|
1509
1290
|
include Aws::Structure
|
1510
1291
|
end
|
1511
1292
|
|
1512
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1513
|
-
# data as a hash:
|
1514
|
-
#
|
1515
|
-
# {
|
1516
|
-
# resource_arn: "String", # required
|
1517
|
-
# }
|
1518
|
-
#
|
1519
1293
|
# @!attribute [rw] resource_arn
|
1520
1294
|
# The Amazon Resource Name (ARN) of the response plan.
|
1521
1295
|
# @return [String]
|
@@ -1540,30 +1314,6 @@ module Aws::SSMIncidents
|
|
1540
1314
|
include Aws::Structure
|
1541
1315
|
end
|
1542
1316
|
|
1543
|
-
# @note When making an API call, you may pass ListTimelineEventsInput
|
1544
|
-
# data as a hash:
|
1545
|
-
#
|
1546
|
-
# {
|
1547
|
-
# filters: [
|
1548
|
-
# {
|
1549
|
-
# condition: { # required
|
1550
|
-
# after: Time.now,
|
1551
|
-
# before: Time.now,
|
1552
|
-
# equals: {
|
1553
|
-
# integer_values: [1],
|
1554
|
-
# string_values: ["StringListMemberString"],
|
1555
|
-
# },
|
1556
|
-
# },
|
1557
|
-
# key: "FilterKeyString", # required
|
1558
|
-
# },
|
1559
|
-
# ],
|
1560
|
-
# incident_record_arn: "Arn", # required
|
1561
|
-
# max_results: 1,
|
1562
|
-
# next_token: "NextToken",
|
1563
|
-
# sort_by: "EVENT_TIME", # accepts EVENT_TIME
|
1564
|
-
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1565
|
-
# }
|
1566
|
-
#
|
1567
1317
|
# @!attribute [rw] filters
|
1568
1318
|
# Filters the timeline events based on the provided conditional
|
1569
1319
|
# values. You can filter timeline events using the following keys:
|
@@ -1660,14 +1410,78 @@ module Aws::SSMIncidents
|
|
1660
1410
|
class Unknown < NotificationTargetItem; end
|
1661
1411
|
end
|
1662
1412
|
|
1663
|
-
#
|
1664
|
-
#
|
1413
|
+
# Details about the PagerDuty configuration for a response plan.
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] name
|
1416
|
+
# The name of the PagerDuty configuration.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] pager_duty_incident_configuration
|
1420
|
+
# Details about the PagerDuty service associated with the
|
1421
|
+
# configuration.
|
1422
|
+
# @return [Types::PagerDutyIncidentConfiguration]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] secret_id
|
1425
|
+
# The ID of the Amazon Web Services Secrets Manager secret that stores
|
1426
|
+
# your PagerDuty key, either a General Access REST API Key or User
|
1427
|
+
# Token REST API Key, and other user credentials.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/PagerDutyConfiguration AWS API Documentation
|
1431
|
+
#
|
1432
|
+
class PagerDutyConfiguration < Struct.new(
|
1433
|
+
:name,
|
1434
|
+
:pager_duty_incident_configuration,
|
1435
|
+
:secret_id)
|
1436
|
+
SENSITIVE = []
|
1437
|
+
include Aws::Structure
|
1438
|
+
end
|
1439
|
+
|
1440
|
+
# Details about the PagerDuty service where the response plan creates an
|
1441
|
+
# incident.
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] service_id
|
1444
|
+
# The ID of the PagerDuty service that the response plan associates
|
1445
|
+
# with an incident when it launches.
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/PagerDutyIncidentConfiguration AWS API Documentation
|
1449
|
+
#
|
1450
|
+
class PagerDutyIncidentConfiguration < Struct.new(
|
1451
|
+
:service_id)
|
1452
|
+
SENSITIVE = []
|
1453
|
+
include Aws::Structure
|
1454
|
+
end
|
1455
|
+
|
1456
|
+
# Details about the PagerDuty incident associated with an incident
|
1457
|
+
# created by an Incident Manager response plan.
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] auto_resolve
|
1460
|
+
# Indicates whether to resolve the PagerDuty incident when you resolve
|
1461
|
+
# the associated Incident Manager incident.
|
1462
|
+
# @return [Boolean]
|
1665
1463
|
#
|
1666
|
-
#
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1464
|
+
# @!attribute [rw] id
|
1465
|
+
# The ID of the incident associated with the PagerDuty service for the
|
1466
|
+
# response plan.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] secret_id
|
1470
|
+
# The ID of the Amazon Web Services Secrets Manager secret that stores
|
1471
|
+
# your PagerDuty key, either a General Access REST API Key or User
|
1472
|
+
# Token REST API Key, and other user credentials.
|
1473
|
+
# @return [String]
|
1474
|
+
#
|
1475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/PagerDutyIncidentDetail AWS API Documentation
|
1670
1476
|
#
|
1477
|
+
class PagerDutyIncidentDetail < Struct.new(
|
1478
|
+
:auto_resolve,
|
1479
|
+
:id,
|
1480
|
+
:secret_id)
|
1481
|
+
SENSITIVE = []
|
1482
|
+
include Aws::Structure
|
1483
|
+
end
|
1484
|
+
|
1671
1485
|
# @!attribute [rw] policy
|
1672
1486
|
# Details of the resource policy.
|
1673
1487
|
# @return [String]
|
@@ -1734,13 +1548,6 @@ module Aws::SSMIncidents
|
|
1734
1548
|
# The mapping between a Amazon Web Services Region and the key that's
|
1735
1549
|
# used to encrypt the data.
|
1736
1550
|
#
|
1737
|
-
# @note When making an API call, you may pass RegionMapInputValue
|
1738
|
-
# data as a hash:
|
1739
|
-
#
|
1740
|
-
# {
|
1741
|
-
# sse_kms_key_id: "SseKmsKey",
|
1742
|
-
# }
|
1743
|
-
#
|
1744
1551
|
# @!attribute [rw] sse_kms_key_id
|
1745
1552
|
# The KMS key used to encrypt the data in your replication set.
|
1746
1553
|
# @return [String]
|
@@ -1755,22 +1562,6 @@ module Aws::SSMIncidents
|
|
1755
1562
|
|
1756
1563
|
# Resources that responders use to triage and mitigate the incident.
|
1757
1564
|
#
|
1758
|
-
# @note When making an API call, you may pass RelatedItem
|
1759
|
-
# data as a hash:
|
1760
|
-
#
|
1761
|
-
# {
|
1762
|
-
# generated_id: "GeneratedId",
|
1763
|
-
# identifier: { # required
|
1764
|
-
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
1765
|
-
# value: { # required
|
1766
|
-
# arn: "Arn",
|
1767
|
-
# metric_definition: "MetricDefinition",
|
1768
|
-
# url: "Url",
|
1769
|
-
# },
|
1770
|
-
# },
|
1771
|
-
# title: "RelatedItemTitleString",
|
1772
|
-
# }
|
1773
|
-
#
|
1774
1565
|
# @!attribute [rw] generated_id
|
1775
1566
|
# A unique ID for a `RelatedItem`.
|
1776
1567
|
#
|
@@ -1987,24 +1778,6 @@ module Aws::SSMIncidents
|
|
1987
1778
|
# Details about the Systems Manager automation document that will be
|
1988
1779
|
# used as a runbook during an incident.
|
1989
1780
|
#
|
1990
|
-
# @note When making an API call, you may pass SsmAutomation
|
1991
|
-
# data as a hash:
|
1992
|
-
#
|
1993
|
-
# {
|
1994
|
-
# document_name: "SsmAutomationDocumentNameString", # required
|
1995
|
-
# document_version: "SsmAutomationDocumentVersionString",
|
1996
|
-
# dynamic_parameters: {
|
1997
|
-
# "DynamicSsmParametersKeyString" => {
|
1998
|
-
# variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
|
1999
|
-
# },
|
2000
|
-
# },
|
2001
|
-
# parameters: {
|
2002
|
-
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
2003
|
-
# },
|
2004
|
-
# role_arn: "RoleArn", # required
|
2005
|
-
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
2006
|
-
# }
|
2007
|
-
#
|
2008
1781
|
# @!attribute [rw] document_name
|
2009
1782
|
# The automation document's name.
|
2010
1783
|
# @return [String]
|
@@ -2046,36 +1819,6 @@ module Aws::SSMIncidents
|
|
2046
1819
|
include Aws::Structure
|
2047
1820
|
end
|
2048
1821
|
|
2049
|
-
# @note When making an API call, you may pass StartIncidentInput
|
2050
|
-
# data as a hash:
|
2051
|
-
#
|
2052
|
-
# {
|
2053
|
-
# client_token: "ClientToken",
|
2054
|
-
# impact: 1,
|
2055
|
-
# related_items: [
|
2056
|
-
# {
|
2057
|
-
# generated_id: "GeneratedId",
|
2058
|
-
# identifier: { # required
|
2059
|
-
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
2060
|
-
# value: { # required
|
2061
|
-
# arn: "Arn",
|
2062
|
-
# metric_definition: "MetricDefinition",
|
2063
|
-
# url: "Url",
|
2064
|
-
# },
|
2065
|
-
# },
|
2066
|
-
# title: "RelatedItemTitleString",
|
2067
|
-
# },
|
2068
|
-
# ],
|
2069
|
-
# response_plan_arn: "Arn", # required
|
2070
|
-
# title: "IncidentTitle",
|
2071
|
-
# trigger_details: {
|
2072
|
-
# raw_data: "RawData",
|
2073
|
-
# source: "IncidentSource", # required
|
2074
|
-
# timestamp: Time.now, # required
|
2075
|
-
# trigger_arn: "Arn",
|
2076
|
-
# },
|
2077
|
-
# }
|
2078
|
-
#
|
2079
1822
|
# @!attribute [rw] client_token
|
2080
1823
|
# A token ensuring that the operation is called only once with the
|
2081
1824
|
# specified details.
|
@@ -2152,16 +1895,6 @@ module Aws::SSMIncidents
|
|
2152
1895
|
include Aws::Structure
|
2153
1896
|
end
|
2154
1897
|
|
2155
|
-
# @note When making an API call, you may pass TagResourceRequest
|
2156
|
-
# data as a hash:
|
2157
|
-
#
|
2158
|
-
# {
|
2159
|
-
# resource_arn: "String", # required
|
2160
|
-
# tags: { # required
|
2161
|
-
# "TagKey" => "TagValue",
|
2162
|
-
# },
|
2163
|
-
# }
|
2164
|
-
#
|
2165
1898
|
# @!attribute [rw] resource_arn
|
2166
1899
|
# The Amazon Resource Name (ARN) of the response plan you're adding
|
2167
1900
|
# the tags to.
|
@@ -2256,16 +1989,6 @@ module Aws::SSMIncidents
|
|
2256
1989
|
# Details about what caused the incident to be created in Incident
|
2257
1990
|
# Manager.
|
2258
1991
|
#
|
2259
|
-
# @note When making an API call, you may pass TriggerDetails
|
2260
|
-
# data as a hash:
|
2261
|
-
#
|
2262
|
-
# {
|
2263
|
-
# raw_data: "RawData",
|
2264
|
-
# source: "IncidentSource", # required
|
2265
|
-
# timestamp: Time.now, # required
|
2266
|
-
# trigger_arn: "Arn",
|
2267
|
-
# }
|
2268
|
-
#
|
2269
1992
|
# @!attribute [rw] raw_data
|
2270
1993
|
# Raw data passed from either Amazon EventBridge, Amazon CloudWatch,
|
2271
1994
|
# or Incident Manager when an incident is created.
|
@@ -2299,14 +2022,6 @@ module Aws::SSMIncidents
|
|
2299
2022
|
include Aws::Structure
|
2300
2023
|
end
|
2301
2024
|
|
2302
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
2303
|
-
# data as a hash:
|
2304
|
-
#
|
2305
|
-
# {
|
2306
|
-
# resource_arn: "String", # required
|
2307
|
-
# tag_keys: ["TagKey"], # required
|
2308
|
-
# }
|
2309
|
-
#
|
2310
2025
|
# @!attribute [rw] resource_arn
|
2311
2026
|
# The Amazon Resource Name (ARN) of the response plan you're removing
|
2312
2027
|
# a tag from.
|
@@ -2329,15 +2044,6 @@ module Aws::SSMIncidents
|
|
2329
2044
|
#
|
2330
2045
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
2331
2046
|
|
2332
|
-
# @note When making an API call, you may pass UpdateDeletionProtectionInput
|
2333
|
-
# data as a hash:
|
2334
|
-
#
|
2335
|
-
# {
|
2336
|
-
# arn: "Arn", # required
|
2337
|
-
# client_token: "ClientToken",
|
2338
|
-
# deletion_protected: false, # required
|
2339
|
-
# }
|
2340
|
-
#
|
2341
2047
|
# @!attribute [rw] arn
|
2342
2048
|
# The Amazon Resource Name (ARN) of the replication set to update.
|
2343
2049
|
# @return [String]
|
@@ -2369,28 +2075,6 @@ module Aws::SSMIncidents
|
|
2369
2075
|
#
|
2370
2076
|
class UpdateDeletionProtectionOutput < Aws::EmptyStructure; end
|
2371
2077
|
|
2372
|
-
# @note When making an API call, you may pass UpdateIncidentRecordInput
|
2373
|
-
# data as a hash:
|
2374
|
-
#
|
2375
|
-
# {
|
2376
|
-
# arn: "Arn", # required
|
2377
|
-
# chat_channel: {
|
2378
|
-
# chatbot_sns: ["SnsArn"],
|
2379
|
-
# empty: {
|
2380
|
-
# },
|
2381
|
-
# },
|
2382
|
-
# client_token: "ClientToken",
|
2383
|
-
# impact: 1,
|
2384
|
-
# notification_targets: [
|
2385
|
-
# {
|
2386
|
-
# sns_topic_arn: "Arn",
|
2387
|
-
# },
|
2388
|
-
# ],
|
2389
|
-
# status: "OPEN", # accepts OPEN, RESOLVED
|
2390
|
-
# summary: "IncidentSummary",
|
2391
|
-
# title: "IncidentTitle",
|
2392
|
-
# }
|
2393
|
-
#
|
2394
2078
|
# @!attribute [rw] arn
|
2395
2079
|
# The Amazon Resource Name (ARN) of the incident record you are
|
2396
2080
|
# updating.
|
@@ -2469,36 +2153,6 @@ module Aws::SSMIncidents
|
|
2469
2153
|
#
|
2470
2154
|
class UpdateIncidentRecordOutput < Aws::EmptyStructure; end
|
2471
2155
|
|
2472
|
-
# @note When making an API call, you may pass UpdateRelatedItemsInput
|
2473
|
-
# data as a hash:
|
2474
|
-
#
|
2475
|
-
# {
|
2476
|
-
# client_token: "ClientToken",
|
2477
|
-
# incident_record_arn: "Arn", # required
|
2478
|
-
# related_items_update: { # required
|
2479
|
-
# item_to_add: {
|
2480
|
-
# generated_id: "GeneratedId",
|
2481
|
-
# identifier: { # required
|
2482
|
-
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
2483
|
-
# value: { # required
|
2484
|
-
# arn: "Arn",
|
2485
|
-
# metric_definition: "MetricDefinition",
|
2486
|
-
# url: "Url",
|
2487
|
-
# },
|
2488
|
-
# },
|
2489
|
-
# title: "RelatedItemTitleString",
|
2490
|
-
# },
|
2491
|
-
# item_to_remove: {
|
2492
|
-
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
2493
|
-
# value: { # required
|
2494
|
-
# arn: "Arn",
|
2495
|
-
# metric_definition: "MetricDefinition",
|
2496
|
-
# url: "Url",
|
2497
|
-
# },
|
2498
|
-
# },
|
2499
|
-
# },
|
2500
|
-
# }
|
2501
|
-
#
|
2502
2156
|
# @!attribute [rw] client_token
|
2503
2157
|
# A token ensuring that the operation is called only once with the
|
2504
2158
|
# specified details.
|
@@ -2559,25 +2213,6 @@ module Aws::SSMIncidents
|
|
2559
2213
|
class Unknown < UpdateReplicationSetAction; end
|
2560
2214
|
end
|
2561
2215
|
|
2562
|
-
# @note When making an API call, you may pass UpdateReplicationSetInput
|
2563
|
-
# data as a hash:
|
2564
|
-
#
|
2565
|
-
# {
|
2566
|
-
# actions: [ # required
|
2567
|
-
# {
|
2568
|
-
# add_region_action: {
|
2569
|
-
# region_name: "RegionName", # required
|
2570
|
-
# sse_kms_key_id: "SseKmsKey",
|
2571
|
-
# },
|
2572
|
-
# delete_region_action: {
|
2573
|
-
# region_name: "RegionName", # required
|
2574
|
-
# },
|
2575
|
-
# },
|
2576
|
-
# ],
|
2577
|
-
# arn: "Arn", # required
|
2578
|
-
# client_token: "ClientToken",
|
2579
|
-
# }
|
2580
|
-
#
|
2581
2216
|
# @!attribute [rw] actions
|
2582
2217
|
# An action to add or delete a Region.
|
2583
2218
|
# @return [Array<Types::UpdateReplicationSetAction>]
|
@@ -2609,51 +2244,6 @@ module Aws::SSMIncidents
|
|
2609
2244
|
#
|
2610
2245
|
class UpdateReplicationSetOutput < Aws::EmptyStructure; end
|
2611
2246
|
|
2612
|
-
# @note When making an API call, you may pass UpdateResponsePlanInput
|
2613
|
-
# data as a hash:
|
2614
|
-
#
|
2615
|
-
# {
|
2616
|
-
# actions: [
|
2617
|
-
# {
|
2618
|
-
# ssm_automation: {
|
2619
|
-
# document_name: "SsmAutomationDocumentNameString", # required
|
2620
|
-
# document_version: "SsmAutomationDocumentVersionString",
|
2621
|
-
# dynamic_parameters: {
|
2622
|
-
# "DynamicSsmParametersKeyString" => {
|
2623
|
-
# variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
|
2624
|
-
# },
|
2625
|
-
# },
|
2626
|
-
# parameters: {
|
2627
|
-
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
2628
|
-
# },
|
2629
|
-
# role_arn: "RoleArn", # required
|
2630
|
-
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
2631
|
-
# },
|
2632
|
-
# },
|
2633
|
-
# ],
|
2634
|
-
# arn: "Arn", # required
|
2635
|
-
# chat_channel: {
|
2636
|
-
# chatbot_sns: ["SnsArn"],
|
2637
|
-
# empty: {
|
2638
|
-
# },
|
2639
|
-
# },
|
2640
|
-
# client_token: "ClientToken",
|
2641
|
-
# display_name: "ResponsePlanDisplayName",
|
2642
|
-
# engagements: ["SsmContactsArn"],
|
2643
|
-
# incident_template_dedupe_string: "DedupeString",
|
2644
|
-
# incident_template_impact: 1,
|
2645
|
-
# incident_template_notification_targets: [
|
2646
|
-
# {
|
2647
|
-
# sns_topic_arn: "Arn",
|
2648
|
-
# },
|
2649
|
-
# ],
|
2650
|
-
# incident_template_summary: "IncidentSummary",
|
2651
|
-
# incident_template_tags: {
|
2652
|
-
# "TagKey" => "TagValue",
|
2653
|
-
# },
|
2654
|
-
# incident_template_title: "IncidentTitle",
|
2655
|
-
# }
|
2656
|
-
#
|
2657
2247
|
# @!attribute [rw] actions
|
2658
2248
|
# The actions that this response plan takes at the beginning of an
|
2659
2249
|
# incident.
|
@@ -2733,6 +2323,11 @@ module Aws::SSMIncidents
|
|
2733
2323
|
# spaces.
|
2734
2324
|
# @return [String]
|
2735
2325
|
#
|
2326
|
+
# @!attribute [rw] integrations
|
2327
|
+
# Information about third-party services integrated into the response
|
2328
|
+
# plan.
|
2329
|
+
# @return [Array<Types::Integration>]
|
2330
|
+
#
|
2736
2331
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateResponsePlanInput AWS API Documentation
|
2737
2332
|
#
|
2738
2333
|
class UpdateResponsePlanInput < Struct.new(
|
@@ -2747,7 +2342,8 @@ module Aws::SSMIncidents
|
|
2747
2342
|
:incident_template_notification_targets,
|
2748
2343
|
:incident_template_summary,
|
2749
2344
|
:incident_template_tags,
|
2750
|
-
:incident_template_title
|
2345
|
+
:incident_template_title,
|
2346
|
+
:integrations)
|
2751
2347
|
SENSITIVE = []
|
2752
2348
|
include Aws::Structure
|
2753
2349
|
end
|
@@ -2756,24 +2352,6 @@ module Aws::SSMIncidents
|
|
2756
2352
|
#
|
2757
2353
|
class UpdateResponsePlanOutput < Aws::EmptyStructure; end
|
2758
2354
|
|
2759
|
-
# @note When making an API call, you may pass UpdateTimelineEventInput
|
2760
|
-
# data as a hash:
|
2761
|
-
#
|
2762
|
-
# {
|
2763
|
-
# client_token: "ClientToken",
|
2764
|
-
# event_data: "EventData",
|
2765
|
-
# event_id: "UUID", # required
|
2766
|
-
# event_references: [
|
2767
|
-
# {
|
2768
|
-
# related_item_id: "GeneratedId",
|
2769
|
-
# resource: "Arn",
|
2770
|
-
# },
|
2771
|
-
# ],
|
2772
|
-
# event_time: Time.now,
|
2773
|
-
# event_type: "TimelineEventType",
|
2774
|
-
# incident_record_arn: "Arn", # required
|
2775
|
-
# }
|
2776
|
-
#
|
2777
2355
|
# @!attribute [rw] client_token
|
2778
2356
|
# A token ensuring that the operation is called only once with the
|
2779
2357
|
# specified details.
|