aws-sdk-ssmincidents 1.20.0 → 1.22.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.
@@ -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,67 +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
- # integrations: [
325
- # {
326
- # pager_duty_configuration: {
327
- # name: "PagerDutyConfigurationNameString", # required
328
- # pager_duty_incident_configuration: { # required
329
- # service_id: "PagerDutyIncidentConfigurationServiceIdString", # required
330
- # },
331
- # secret_id: "PagerDutyConfigurationSecretIdString", # required
332
- # },
333
- # },
334
- # ],
335
- # name: "ResponsePlanName", # required
336
- # tags: {
337
- # "TagKey" => "TagValue",
338
- # },
339
- # }
340
- #
341
257
  # @!attribute [rw] actions
342
258
  # The actions that the response plan starts at the beginning of an
343
259
  # incident.
@@ -410,26 +326,9 @@ module Aws::SSMIncidents
410
326
  include Aws::Structure
411
327
  end
412
328
 
413
- # @note When making an API call, you may pass CreateTimelineEventInput
414
- # data as a hash:
415
- #
416
- # {
417
- # client_token: "ClientToken",
418
- # event_data: "EventData", # required
419
- # event_references: [
420
- # {
421
- # related_item_id: "GeneratedId",
422
- # resource: "Arn",
423
- # },
424
- # ],
425
- # event_time: Time.now, # required
426
- # event_type: "TimelineEventType", # required
427
- # incident_record_arn: "Arn", # required
428
- # }
429
- #
430
329
  # @!attribute [rw] client_token
431
- # A token ensuring that the action is called only once with the
432
- # specified details.
330
+ # A token that ensures that a client calls the action only once with
331
+ # the specified details.
433
332
  #
434
333
  # **A suitable default value is auto-generated.** You should normally
435
334
  # not need to pass this option.
@@ -440,14 +339,14 @@ module Aws::SSMIncidents
440
339
  # @return [String]
441
340
  #
442
341
  # @!attribute [rw] event_references
443
- # Adds one or more references to the `TimelineEvent`. A reference can
444
- # be an Amazon Web Services resource involved in the incident or in
445
- # some way associated with it. When you specify a reference, you enter
446
- # the Amazon Resource Name (ARN) of the resource. You can also specify
447
- # a related item. As an example, you could specify the ARN of an
448
- # Amazon DynamoDB (DynamoDB) table. The table for this example is the
449
- # resource. You could also specify a Amazon CloudWatch metric for that
450
- # table. The metric is the related item.
342
+ # Adds one or more references to the `TimelineEvent`. A reference is
343
+ # an Amazon Web Services resource involved or associated with the
344
+ # incident. To specify a reference, enter its Amazon Resource Name
345
+ # (ARN). You can also specify a related item associated with a
346
+ # resource. For example, to specify an Amazon DynamoDB (DynamoDB)
347
+ # table as a resource, use the table's ARN. You can also specify an
348
+ # Amazon CloudWatch metric associated with the DynamoDB table as a
349
+ # related item.
451
350
  # @return [Array<Types::EventReference>]
452
351
  #
453
352
  # @!attribute [rw] event_time
@@ -455,13 +354,13 @@ module Aws::SSMIncidents
455
354
  # @return [Time]
456
355
  #
457
356
  # @!attribute [rw] event_type
458
- # The type of the event. You can create timeline events of type
459
- # `Custom Event`.
357
+ # The type of event. You can create timeline events of type `Custom
358
+ # Event`.
460
359
  # @return [String]
461
360
  #
462
361
  # @!attribute [rw] incident_record_arn
463
- # The Amazon Resource Name (ARN) of the incident record to which the
464
- # event will be added.
362
+ # The Amazon Resource Name (ARN) of the incident record that the
363
+ # action adds the incident to.
465
364
  # @return [String]
466
365
  #
467
366
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateTimelineEventInput AWS API Documentation
@@ -494,13 +393,6 @@ module Aws::SSMIncidents
494
393
  include Aws::Structure
495
394
  end
496
395
 
497
- # @note When making an API call, you may pass DeleteIncidentRecordInput
498
- # data as a hash:
499
- #
500
- # {
501
- # arn: "Arn", # required
502
- # }
503
- #
504
396
  # @!attribute [rw] arn
505
397
  # The Amazon Resource Name (ARN) of the incident record you are
506
398
  # deleting.
@@ -521,13 +413,6 @@ module Aws::SSMIncidents
521
413
  # Defines the information about the Amazon Web Services Region you're
522
414
  # deleting from your replication set.
523
415
  #
524
- # @note When making an API call, you may pass DeleteRegionAction
525
- # data as a hash:
526
- #
527
- # {
528
- # region_name: "RegionName", # required
529
- # }
530
- #
531
416
  # @!attribute [rw] region_name
532
417
  # The name of the Amazon Web Services Region you're deleting from the
533
418
  # replication set.
@@ -541,13 +426,6 @@ module Aws::SSMIncidents
541
426
  include Aws::Structure
542
427
  end
543
428
 
544
- # @note When making an API call, you may pass DeleteReplicationSetInput
545
- # data as a hash:
546
- #
547
- # {
548
- # arn: "Arn", # required
549
- # }
550
- #
551
429
  # @!attribute [rw] arn
552
430
  # The Amazon Resource Name (ARN) of the replication set you're
553
431
  # deleting.
@@ -565,14 +443,6 @@ module Aws::SSMIncidents
565
443
  #
566
444
  class DeleteReplicationSetOutput < Aws::EmptyStructure; end
567
445
 
568
- # @note When making an API call, you may pass DeleteResourcePolicyInput
569
- # data as a hash:
570
- #
571
- # {
572
- # policy_id: "PolicyId", # required
573
- # resource_arn: "Arn", # required
574
- # }
575
- #
576
446
  # @!attribute [rw] policy_id
577
447
  # The ID of the resource policy you're deleting.
578
448
  # @return [String]
@@ -595,13 +465,6 @@ module Aws::SSMIncidents
595
465
  #
596
466
  class DeleteResourcePolicyOutput < Aws::EmptyStructure; end
597
467
 
598
- # @note When making an API call, you may pass DeleteResponsePlanInput
599
- # data as a hash:
600
- #
601
- # {
602
- # arn: "Arn", # required
603
- # }
604
- #
605
468
  # @!attribute [rw] arn
606
469
  # The Amazon Resource Name (ARN) of the response plan.
607
470
  # @return [String]
@@ -618,17 +481,9 @@ module Aws::SSMIncidents
618
481
  #
619
482
  class DeleteResponsePlanOutput < Aws::EmptyStructure; end
620
483
 
621
- # @note When making an API call, you may pass DeleteTimelineEventInput
622
- # data as a hash:
623
- #
624
- # {
625
- # event_id: "UUID", # required
626
- # incident_record_arn: "Arn", # required
627
- # }
628
- #
629
484
  # @!attribute [rw] event_id
630
- # The ID of the event you are updating. You can find this by using
631
- # `ListTimelineEvents`.
485
+ # The ID of the event to update. You can use `ListTimelineEvents` to
486
+ # find an event's ID.
632
487
  # @return [String]
633
488
  #
634
489
  # @!attribute [rw] incident_record_arn
@@ -756,21 +611,6 @@ module Aws::SSMIncidents
756
611
 
757
612
  # Filter the selection by using a condition.
758
613
  #
759
- # @note When making an API call, you may pass Filter
760
- # data as a hash:
761
- #
762
- # {
763
- # condition: { # required
764
- # after: Time.now,
765
- # before: Time.now,
766
- # equals: {
767
- # integer_values: [1],
768
- # string_values: ["StringListMemberString"],
769
- # },
770
- # },
771
- # key: "FilterKeyString", # required
772
- # }
773
- #
774
614
  # @!attribute [rw] condition
775
615
  # The condition accepts before or after a specified time, equal to a
776
616
  # string, or equal to an integer.
@@ -789,13 +629,6 @@ module Aws::SSMIncidents
789
629
  include Aws::Structure
790
630
  end
791
631
 
792
- # @note When making an API call, you may pass GetIncidentRecordInput
793
- # data as a hash:
794
- #
795
- # {
796
- # arn: "Arn", # required
797
- # }
798
- #
799
632
  # @!attribute [rw] arn
800
633
  # The Amazon Resource Name (ARN) of the incident record.
801
634
  # @return [String]
@@ -820,13 +653,6 @@ module Aws::SSMIncidents
820
653
  include Aws::Structure
821
654
  end
822
655
 
823
- # @note When making an API call, you may pass GetReplicationSetInput
824
- # data as a hash:
825
- #
826
- # {
827
- # arn: "Arn", # required
828
- # }
829
- #
830
656
  # @!attribute [rw] arn
831
657
  # The Amazon Resource Name (ARN) of the replication set you want to
832
658
  # retrieve.
@@ -852,15 +678,6 @@ module Aws::SSMIncidents
852
678
  include Aws::Structure
853
679
  end
854
680
 
855
- # @note When making an API call, you may pass GetResourcePoliciesInput
856
- # data as a hash:
857
- #
858
- # {
859
- # max_results: 1,
860
- # next_token: "NextToken",
861
- # resource_arn: "Arn", # required
862
- # }
863
- #
864
681
  # @!attribute [rw] max_results
865
682
  # The maximum number of resource policies to display for each page of
866
683
  # results.
@@ -902,13 +719,6 @@ module Aws::SSMIncidents
902
719
  include Aws::Structure
903
720
  end
904
721
 
905
- # @note When making an API call, you may pass GetResponsePlanInput
906
- # data as a hash:
907
- #
908
- # {
909
- # arn: "Arn", # required
910
- # }
911
- #
912
722
  # @!attribute [rw] arn
913
723
  # The Amazon Resource Name (ARN) of the response plan.
914
724
  # @return [String]
@@ -972,14 +782,6 @@ module Aws::SSMIncidents
972
782
  include Aws::Structure
973
783
  end
974
784
 
975
- # @note When making an API call, you may pass GetTimelineEventInput
976
- # data as a hash:
977
- #
978
- # {
979
- # event_id: "UUID", # required
980
- # incident_record_arn: "Arn", # required
981
- # }
982
- #
983
785
  # @!attribute [rw] event_id
984
786
  # The ID of the event. You can get an event's ID when you create it,
985
787
  # or by using `ListTimelineEvents`.
@@ -1177,24 +979,6 @@ module Aws::SSMIncidents
1177
979
  # Basic details used in creating a response plan. The response plan is
1178
980
  # then used to create an incident record.
1179
981
  #
1180
- # @note When making an API call, you may pass IncidentTemplate
1181
- # data as a hash:
1182
- #
1183
- # {
1184
- # dedupe_string: "DedupeString",
1185
- # impact: 1, # required
1186
- # incident_tags: {
1187
- # "TagKey" => "TagValue",
1188
- # },
1189
- # notification_targets: [
1190
- # {
1191
- # sns_topic_arn: "Arn",
1192
- # },
1193
- # ],
1194
- # summary: "IncidentSummary",
1195
- # title: "IncidentTitle", # required
1196
- # }
1197
- #
1198
982
  # @!attribute [rw] dedupe_string
1199
983
  # Used to stop Incident Manager from creating multiple incident
1200
984
  # records for the same incident.
@@ -1278,23 +1062,6 @@ module Aws::SSMIncidents
1278
1062
 
1279
1063
  # Details and type of a related item.
1280
1064
  #
1281
- # @note When making an API call, you may pass ItemIdentifier
1282
- # data as a hash:
1283
- #
1284
- # {
1285
- # type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
1286
- # value: { # required
1287
- # arn: "Arn",
1288
- # metric_definition: "MetricDefinition",
1289
- # pager_duty_incident_detail: {
1290
- # auto_resolve: false,
1291
- # id: "PagerDutyIncidentDetailIdString", # required
1292
- # secret_id: "PagerDutyIncidentDetailSecretIdString",
1293
- # },
1294
- # url: "Url",
1295
- # },
1296
- # }
1297
- #
1298
1065
  # @!attribute [rw] type
1299
1066
  # The type of related item.
1300
1067
  # @return [String]
@@ -1356,30 +1123,9 @@ module Aws::SSMIncidents
1356
1123
  class Unknown < ItemValue; end
1357
1124
  end
1358
1125
 
1359
- # @note When making an API call, you may pass ListIncidentRecordsInput
1360
- # data as a hash:
1361
- #
1362
- # {
1363
- # filters: [
1364
- # {
1365
- # condition: { # required
1366
- # after: Time.now,
1367
- # before: Time.now,
1368
- # equals: {
1369
- # integer_values: [1],
1370
- # string_values: ["StringListMemberString"],
1371
- # },
1372
- # },
1373
- # key: "FilterKeyString", # required
1374
- # },
1375
- # ],
1376
- # max_results: 1,
1377
- # next_token: "NextToken",
1378
- # }
1379
- #
1380
1126
  # @!attribute [rw] filters
1381
- # Filters the list of incident records through which you are
1382
- # searching. You can filter on the following keys:
1127
+ # Filters the list of incident records you want to search through. You
1128
+ # can filter on the following keys:
1383
1129
  #
1384
1130
  # * `creationTime`
1385
1131
  #
@@ -1389,7 +1135,7 @@ module Aws::SSMIncidents
1389
1135
  #
1390
1136
  # * `createdBy`
1391
1137
  #
1392
- # Note the following when deciding how to use Filters:
1138
+ # Note the following when when you use Filters:
1393
1139
  #
1394
1140
  # * If you don't specify a Filter, the response includes all incident
1395
1141
  # records.
@@ -1436,15 +1182,6 @@ module Aws::SSMIncidents
1436
1182
  include Aws::Structure
1437
1183
  end
1438
1184
 
1439
- # @note When making an API call, you may pass ListRelatedItemsInput
1440
- # data as a hash:
1441
- #
1442
- # {
1443
- # incident_record_arn: "Arn", # required
1444
- # max_results: 1,
1445
- # next_token: "NextToken",
1446
- # }
1447
- #
1448
1185
  # @!attribute [rw] incident_record_arn
1449
1186
  # The Amazon Resource Name (ARN) of the incident record containing the
1450
1187
  # listed related items.
@@ -1485,14 +1222,6 @@ module Aws::SSMIncidents
1485
1222
  include Aws::Structure
1486
1223
  end
1487
1224
 
1488
- # @note When making an API call, you may pass ListReplicationSetsInput
1489
- # data as a hash:
1490
- #
1491
- # {
1492
- # max_results: 1,
1493
- # next_token: "NextToken",
1494
- # }
1495
- #
1496
1225
  # @!attribute [rw] max_results
1497
1226
  # The maximum number of results per page.
1498
1227
  # @return [Integer]
@@ -1527,14 +1256,6 @@ module Aws::SSMIncidents
1527
1256
  include Aws::Structure
1528
1257
  end
1529
1258
 
1530
- # @note When making an API call, you may pass ListResponsePlansInput
1531
- # data as a hash:
1532
- #
1533
- # {
1534
- # max_results: 1,
1535
- # next_token: "NextToken",
1536
- # }
1537
- #
1538
1259
  # @!attribute [rw] max_results
1539
1260
  # The maximum number of response plans per page.
1540
1261
  # @return [Integer]
@@ -1569,13 +1290,6 @@ module Aws::SSMIncidents
1569
1290
  include Aws::Structure
1570
1291
  end
1571
1292
 
1572
- # @note When making an API call, you may pass ListTagsForResourceRequest
1573
- # data as a hash:
1574
- #
1575
- # {
1576
- # resource_arn: "String", # required
1577
- # }
1578
- #
1579
1293
  # @!attribute [rw] resource_arn
1580
1294
  # The Amazon Resource Name (ARN) of the response plan.
1581
1295
  # @return [String]
@@ -1600,33 +1314,9 @@ module Aws::SSMIncidents
1600
1314
  include Aws::Structure
1601
1315
  end
1602
1316
 
1603
- # @note When making an API call, you may pass ListTimelineEventsInput
1604
- # data as a hash:
1605
- #
1606
- # {
1607
- # filters: [
1608
- # {
1609
- # condition: { # required
1610
- # after: Time.now,
1611
- # before: Time.now,
1612
- # equals: {
1613
- # integer_values: [1],
1614
- # string_values: ["StringListMemberString"],
1615
- # },
1616
- # },
1617
- # key: "FilterKeyString", # required
1618
- # },
1619
- # ],
1620
- # incident_record_arn: "Arn", # required
1621
- # max_results: 1,
1622
- # next_token: "NextToken",
1623
- # sort_by: "EVENT_TIME", # accepts EVENT_TIME
1624
- # sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
1625
- # }
1626
- #
1627
1317
  # @!attribute [rw] filters
1628
1318
  # Filters the timeline events based on the provided conditional
1629
- # values. You can filter timeline events using the following keys:
1319
+ # values. You can filter timeline events with the following keys:
1630
1320
  #
1631
1321
  # * `eventTime`
1632
1322
  #
@@ -1658,7 +1348,7 @@ module Aws::SSMIncidents
1658
1348
  # @return [String]
1659
1349
  #
1660
1350
  # @!attribute [rw] sort_by
1661
- # Sort by the specified key value pair.
1351
+ # Sort timeline events by the specified key value pair.
1662
1352
  # @return [String]
1663
1353
  #
1664
1354
  # @!attribute [rw] sort_order
@@ -1722,17 +1412,6 @@ module Aws::SSMIncidents
1722
1412
 
1723
1413
  # Details about the PagerDuty configuration for a response plan.
1724
1414
  #
1725
- # @note When making an API call, you may pass PagerDutyConfiguration
1726
- # data as a hash:
1727
- #
1728
- # {
1729
- # name: "PagerDutyConfigurationNameString", # required
1730
- # pager_duty_incident_configuration: { # required
1731
- # service_id: "PagerDutyIncidentConfigurationServiceIdString", # required
1732
- # },
1733
- # secret_id: "PagerDutyConfigurationSecretIdString", # required
1734
- # }
1735
- #
1736
1415
  # @!attribute [rw] name
1737
1416
  # The name of the PagerDuty configuration.
1738
1417
  # @return [String]
@@ -1761,13 +1440,6 @@ module Aws::SSMIncidents
1761
1440
  # Details about the PagerDuty service where the response plan creates an
1762
1441
  # incident.
1763
1442
  #
1764
- # @note When making an API call, you may pass PagerDutyIncidentConfiguration
1765
- # data as a hash:
1766
- #
1767
- # {
1768
- # service_id: "PagerDutyIncidentConfigurationServiceIdString", # required
1769
- # }
1770
- #
1771
1443
  # @!attribute [rw] service_id
1772
1444
  # The ID of the PagerDuty service that the response plan associates
1773
1445
  # with an incident when it launches.
@@ -1784,15 +1456,6 @@ module Aws::SSMIncidents
1784
1456
  # Details about the PagerDuty incident associated with an incident
1785
1457
  # created by an Incident Manager response plan.
1786
1458
  #
1787
- # @note When making an API call, you may pass PagerDutyIncidentDetail
1788
- # data as a hash:
1789
- #
1790
- # {
1791
- # auto_resolve: false,
1792
- # id: "PagerDutyIncidentDetailIdString", # required
1793
- # secret_id: "PagerDutyIncidentDetailSecretIdString",
1794
- # }
1795
- #
1796
1459
  # @!attribute [rw] auto_resolve
1797
1460
  # Indicates whether to resolve the PagerDuty incident when you resolve
1798
1461
  # the associated Incident Manager incident.
@@ -1819,14 +1482,6 @@ module Aws::SSMIncidents
1819
1482
  include Aws::Structure
1820
1483
  end
1821
1484
 
1822
- # @note When making an API call, you may pass PutResourcePolicyInput
1823
- # data as a hash:
1824
- #
1825
- # {
1826
- # policy: "Policy", # required
1827
- # resource_arn: "Arn", # required
1828
- # }
1829
- #
1830
1485
  # @!attribute [rw] policy
1831
1486
  # Details of the resource policy.
1832
1487
  # @return [String]
@@ -1893,13 +1548,6 @@ module Aws::SSMIncidents
1893
1548
  # The mapping between a Amazon Web Services Region and the key that's
1894
1549
  # used to encrypt the data.
1895
1550
  #
1896
- # @note When making an API call, you may pass RegionMapInputValue
1897
- # data as a hash:
1898
- #
1899
- # {
1900
- # sse_kms_key_id: "SseKmsKey",
1901
- # }
1902
- #
1903
1551
  # @!attribute [rw] sse_kms_key_id
1904
1552
  # The KMS key used to encrypt the data in your replication set.
1905
1553
  # @return [String]
@@ -1914,27 +1562,6 @@ module Aws::SSMIncidents
1914
1562
 
1915
1563
  # Resources that responders use to triage and mitigate the incident.
1916
1564
  #
1917
- # @note When making an API call, you may pass RelatedItem
1918
- # data as a hash:
1919
- #
1920
- # {
1921
- # generated_id: "GeneratedId",
1922
- # identifier: { # required
1923
- # type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
1924
- # value: { # required
1925
- # arn: "Arn",
1926
- # metric_definition: "MetricDefinition",
1927
- # pager_duty_incident_detail: {
1928
- # auto_resolve: false,
1929
- # id: "PagerDutyIncidentDetailIdString", # required
1930
- # secret_id: "PagerDutyIncidentDetailSecretIdString",
1931
- # },
1932
- # url: "Url",
1933
- # },
1934
- # },
1935
- # title: "RelatedItemTitleString",
1936
- # }
1937
- #
1938
1565
  # @!attribute [rw] generated_id
1939
1566
  # A unique ID for a `RelatedItem`.
1940
1567
  #
@@ -2151,24 +1778,6 @@ module Aws::SSMIncidents
2151
1778
  # Details about the Systems Manager automation document that will be
2152
1779
  # used as a runbook during an incident.
2153
1780
  #
2154
- # @note When making an API call, you may pass SsmAutomation
2155
- # data as a hash:
2156
- #
2157
- # {
2158
- # document_name: "SsmAutomationDocumentNameString", # required
2159
- # document_version: "SsmAutomationDocumentVersionString",
2160
- # dynamic_parameters: {
2161
- # "DynamicSsmParametersKeyString" => {
2162
- # variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
2163
- # },
2164
- # },
2165
- # parameters: {
2166
- # "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
2167
- # },
2168
- # role_arn: "RoleArn", # required
2169
- # target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
2170
- # }
2171
- #
2172
1781
  # @!attribute [rw] document_name
2173
1782
  # The automation document's name.
2174
1783
  # @return [String]
@@ -2210,41 +1819,6 @@ module Aws::SSMIncidents
2210
1819
  include Aws::Structure
2211
1820
  end
2212
1821
 
2213
- # @note When making an API call, you may pass StartIncidentInput
2214
- # data as a hash:
2215
- #
2216
- # {
2217
- # client_token: "ClientToken",
2218
- # impact: 1,
2219
- # related_items: [
2220
- # {
2221
- # generated_id: "GeneratedId",
2222
- # identifier: { # required
2223
- # type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
2224
- # value: { # required
2225
- # arn: "Arn",
2226
- # metric_definition: "MetricDefinition",
2227
- # pager_duty_incident_detail: {
2228
- # auto_resolve: false,
2229
- # id: "PagerDutyIncidentDetailIdString", # required
2230
- # secret_id: "PagerDutyIncidentDetailSecretIdString",
2231
- # },
2232
- # url: "Url",
2233
- # },
2234
- # },
2235
- # title: "RelatedItemTitleString",
2236
- # },
2237
- # ],
2238
- # response_plan_arn: "Arn", # required
2239
- # title: "IncidentTitle",
2240
- # trigger_details: {
2241
- # raw_data: "RawData",
2242
- # source: "IncidentSource", # required
2243
- # timestamp: Time.now, # required
2244
- # trigger_arn: "Arn",
2245
- # },
2246
- # }
2247
- #
2248
1822
  # @!attribute [rw] client_token
2249
1823
  # A token ensuring that the operation is called only once with the
2250
1824
  # specified details.
@@ -2277,8 +1851,8 @@ module Aws::SSMIncidents
2277
1851
  #
2278
1852
  # @!attribute [rw] related_items
2279
1853
  # Add related items to the incident for other responders to use.
2280
- # Related items are AWS resources, external links, or files uploaded
2281
- # to an Amazon S3 bucket.
1854
+ # Related items are Amazon Web Services resources, external links, or
1855
+ # files uploaded to an Amazon S3 bucket.
2282
1856
  # @return [Array<Types::RelatedItem>]
2283
1857
  #
2284
1858
  # @!attribute [rw] response_plan_arn
@@ -2321,16 +1895,6 @@ module Aws::SSMIncidents
2321
1895
  include Aws::Structure
2322
1896
  end
2323
1897
 
2324
- # @note When making an API call, you may pass TagResourceRequest
2325
- # data as a hash:
2326
- #
2327
- # {
2328
- # resource_arn: "String", # required
2329
- # tags: { # required
2330
- # "TagKey" => "TagValue",
2331
- # },
2332
- # }
2333
- #
2334
1898
  # @!attribute [rw] resource_arn
2335
1899
  # The Amazon Resource Name (ARN) of the response plan you're adding
2336
1900
  # the tags to.
@@ -2425,16 +1989,6 @@ module Aws::SSMIncidents
2425
1989
  # Details about what caused the incident to be created in Incident
2426
1990
  # Manager.
2427
1991
  #
2428
- # @note When making an API call, you may pass TriggerDetails
2429
- # data as a hash:
2430
- #
2431
- # {
2432
- # raw_data: "RawData",
2433
- # source: "IncidentSource", # required
2434
- # timestamp: Time.now, # required
2435
- # trigger_arn: "Arn",
2436
- # }
2437
- #
2438
1992
  # @!attribute [rw] raw_data
2439
1993
  # Raw data passed from either Amazon EventBridge, Amazon CloudWatch,
2440
1994
  # or Incident Manager when an incident is created.
@@ -2468,14 +2022,6 @@ module Aws::SSMIncidents
2468
2022
  include Aws::Structure
2469
2023
  end
2470
2024
 
2471
- # @note When making an API call, you may pass UntagResourceRequest
2472
- # data as a hash:
2473
- #
2474
- # {
2475
- # resource_arn: "String", # required
2476
- # tag_keys: ["TagKey"], # required
2477
- # }
2478
- #
2479
2025
  # @!attribute [rw] resource_arn
2480
2026
  # The Amazon Resource Name (ARN) of the response plan you're removing
2481
2027
  # a tag from.
@@ -2498,15 +2044,6 @@ module Aws::SSMIncidents
2498
2044
  #
2499
2045
  class UntagResourceResponse < Aws::EmptyStructure; end
2500
2046
 
2501
- # @note When making an API call, you may pass UpdateDeletionProtectionInput
2502
- # data as a hash:
2503
- #
2504
- # {
2505
- # arn: "Arn", # required
2506
- # client_token: "ClientToken",
2507
- # deletion_protected: false, # required
2508
- # }
2509
- #
2510
2047
  # @!attribute [rw] arn
2511
2048
  # The Amazon Resource Name (ARN) of the replication set to update.
2512
2049
  # @return [String]
@@ -2538,28 +2075,6 @@ module Aws::SSMIncidents
2538
2075
  #
2539
2076
  class UpdateDeletionProtectionOutput < Aws::EmptyStructure; end
2540
2077
 
2541
- # @note When making an API call, you may pass UpdateIncidentRecordInput
2542
- # data as a hash:
2543
- #
2544
- # {
2545
- # arn: "Arn", # required
2546
- # chat_channel: {
2547
- # chatbot_sns: ["SnsArn"],
2548
- # empty: {
2549
- # },
2550
- # },
2551
- # client_token: "ClientToken",
2552
- # impact: 1,
2553
- # notification_targets: [
2554
- # {
2555
- # sns_topic_arn: "Arn",
2556
- # },
2557
- # ],
2558
- # status: "OPEN", # accepts OPEN, RESOLVED
2559
- # summary: "IncidentSummary",
2560
- # title: "IncidentTitle",
2561
- # }
2562
- #
2563
2078
  # @!attribute [rw] arn
2564
2079
  # The Amazon Resource Name (ARN) of the incident record you are
2565
2080
  # updating.
@@ -2570,17 +2085,17 @@ module Aws::SSMIncidents
2570
2085
  # @return [Types::ChatChannel]
2571
2086
  #
2572
2087
  # @!attribute [rw] client_token
2573
- # A token that ensures that the operation is called only once with the
2574
- # specified details.
2088
+ # A token that ensures that a client calls the operation only once
2089
+ # with the specified details.
2575
2090
  #
2576
2091
  # **A suitable default value is auto-generated.** You should normally
2577
2092
  # not need to pass this option.
2578
2093
  # @return [String]
2579
2094
  #
2580
2095
  # @!attribute [rw] impact
2581
- # Defines the impact of the incident to customers and applications.
2582
- # Providing an impact overwrites the impact provided by the response
2583
- # plan.
2096
+ # Defines the impact of the incident to customers and applications. If
2097
+ # you provide an impact for an incident, it overwrites the impact
2098
+ # provided by the response plan.
2584
2099
  #
2585
2100
  # **Possible impacts:**
2586
2101
  #
@@ -2600,15 +2115,16 @@ module Aws::SSMIncidents
2600
2115
  # @return [Integer]
2601
2116
  #
2602
2117
  # @!attribute [rw] notification_targets
2603
- # The Amazon SNS targets that are notified when updates are made to an
2604
- # incident.
2118
+ # The Amazon SNS targets that Incident Manager notifies when a client
2119
+ # updates an incident.
2605
2120
  #
2606
2121
  # Using multiple SNS topics creates redundancy in the event that a
2607
2122
  # Region is down during the incident.
2608
2123
  # @return [Array<Types::NotificationTargetItem>]
2609
2124
  #
2610
2125
  # @!attribute [rw] status
2611
- # The status of the incident. An incident can be `Open` or `Resolved`.
2126
+ # The status of the incident. Possible statuses are `Open` or
2127
+ # `Resolved`.
2612
2128
  # @return [String]
2613
2129
  #
2614
2130
  # @!attribute [rw] summary
@@ -2638,61 +2154,22 @@ module Aws::SSMIncidents
2638
2154
  #
2639
2155
  class UpdateIncidentRecordOutput < Aws::EmptyStructure; end
2640
2156
 
2641
- # @note When making an API call, you may pass UpdateRelatedItemsInput
2642
- # data as a hash:
2643
- #
2644
- # {
2645
- # client_token: "ClientToken",
2646
- # incident_record_arn: "Arn", # required
2647
- # related_items_update: { # required
2648
- # item_to_add: {
2649
- # generated_id: "GeneratedId",
2650
- # identifier: { # required
2651
- # type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
2652
- # value: { # required
2653
- # arn: "Arn",
2654
- # metric_definition: "MetricDefinition",
2655
- # pager_duty_incident_detail: {
2656
- # auto_resolve: false,
2657
- # id: "PagerDutyIncidentDetailIdString", # required
2658
- # secret_id: "PagerDutyIncidentDetailSecretIdString",
2659
- # },
2660
- # url: "Url",
2661
- # },
2662
- # },
2663
- # title: "RelatedItemTitleString",
2664
- # },
2665
- # item_to_remove: {
2666
- # type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
2667
- # value: { # required
2668
- # arn: "Arn",
2669
- # metric_definition: "MetricDefinition",
2670
- # pager_duty_incident_detail: {
2671
- # auto_resolve: false,
2672
- # id: "PagerDutyIncidentDetailIdString", # required
2673
- # secret_id: "PagerDutyIncidentDetailSecretIdString",
2674
- # },
2675
- # url: "Url",
2676
- # },
2677
- # },
2678
- # },
2679
- # }
2680
- #
2681
2157
  # @!attribute [rw] client_token
2682
- # A token ensuring that the operation is called only once with the
2683
- # specified details.
2158
+ # A token that ensures that a client calls the operation only once
2159
+ # with the specified details.
2684
2160
  #
2685
2161
  # **A suitable default value is auto-generated.** You should normally
2686
2162
  # not need to pass this option.
2687
2163
  # @return [String]
2688
2164
  #
2689
2165
  # @!attribute [rw] incident_record_arn
2690
- # The Amazon Resource Name (ARN) of the incident record containing the
2691
- # related items you are updating.
2166
+ # The Amazon Resource Name (ARN) of the incident record that contains
2167
+ # the related items that you update.
2692
2168
  # @return [String]
2693
2169
  #
2694
2170
  # @!attribute [rw] related_items_update
2695
- # Details about the item you are adding or deleting.
2171
+ # Details about the item that you are add to, or delete from, an
2172
+ # incident.
2696
2173
  # @return [Types::RelatedItemsUpdate]
2697
2174
  #
2698
2175
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateRelatedItemsInput AWS API Documentation
@@ -2738,25 +2215,6 @@ module Aws::SSMIncidents
2738
2215
  class Unknown < UpdateReplicationSetAction; end
2739
2216
  end
2740
2217
 
2741
- # @note When making an API call, you may pass UpdateReplicationSetInput
2742
- # data as a hash:
2743
- #
2744
- # {
2745
- # actions: [ # required
2746
- # {
2747
- # add_region_action: {
2748
- # region_name: "RegionName", # required
2749
- # sse_kms_key_id: "SseKmsKey",
2750
- # },
2751
- # delete_region_action: {
2752
- # region_name: "RegionName", # required
2753
- # },
2754
- # },
2755
- # ],
2756
- # arn: "Arn", # required
2757
- # client_token: "ClientToken",
2758
- # }
2759
- #
2760
2218
  # @!attribute [rw] actions
2761
2219
  # An action to add or delete a Region.
2762
2220
  # @return [Array<Types::UpdateReplicationSetAction>]
@@ -2788,62 +2246,6 @@ module Aws::SSMIncidents
2788
2246
  #
2789
2247
  class UpdateReplicationSetOutput < Aws::EmptyStructure; end
2790
2248
 
2791
- # @note When making an API call, you may pass UpdateResponsePlanInput
2792
- # data as a hash:
2793
- #
2794
- # {
2795
- # actions: [
2796
- # {
2797
- # ssm_automation: {
2798
- # document_name: "SsmAutomationDocumentNameString", # required
2799
- # document_version: "SsmAutomationDocumentVersionString",
2800
- # dynamic_parameters: {
2801
- # "DynamicSsmParametersKeyString" => {
2802
- # variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
2803
- # },
2804
- # },
2805
- # parameters: {
2806
- # "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
2807
- # },
2808
- # role_arn: "RoleArn", # required
2809
- # target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
2810
- # },
2811
- # },
2812
- # ],
2813
- # arn: "Arn", # required
2814
- # chat_channel: {
2815
- # chatbot_sns: ["SnsArn"],
2816
- # empty: {
2817
- # },
2818
- # },
2819
- # client_token: "ClientToken",
2820
- # display_name: "ResponsePlanDisplayName",
2821
- # engagements: ["SsmContactsArn"],
2822
- # incident_template_dedupe_string: "DedupeString",
2823
- # incident_template_impact: 1,
2824
- # incident_template_notification_targets: [
2825
- # {
2826
- # sns_topic_arn: "Arn",
2827
- # },
2828
- # ],
2829
- # incident_template_summary: "IncidentSummary",
2830
- # incident_template_tags: {
2831
- # "TagKey" => "TagValue",
2832
- # },
2833
- # incident_template_title: "IncidentTitle",
2834
- # integrations: [
2835
- # {
2836
- # pager_duty_configuration: {
2837
- # name: "PagerDutyConfigurationNameString", # required
2838
- # pager_duty_incident_configuration: { # required
2839
- # service_id: "PagerDutyIncidentConfigurationServiceIdString", # required
2840
- # },
2841
- # secret_id: "PagerDutyConfigurationSecretIdString", # required
2842
- # },
2843
- # },
2844
- # ],
2845
- # }
2846
- #
2847
2249
  # @!attribute [rw] actions
2848
2250
  # The actions that this response plan takes at the beginning of an
2849
2251
  # incident.
@@ -2952,27 +2354,9 @@ module Aws::SSMIncidents
2952
2354
  #
2953
2355
  class UpdateResponsePlanOutput < Aws::EmptyStructure; end
2954
2356
 
2955
- # @note When making an API call, you may pass UpdateTimelineEventInput
2956
- # data as a hash:
2957
- #
2958
- # {
2959
- # client_token: "ClientToken",
2960
- # event_data: "EventData",
2961
- # event_id: "UUID", # required
2962
- # event_references: [
2963
- # {
2964
- # related_item_id: "GeneratedId",
2965
- # resource: "Arn",
2966
- # },
2967
- # ],
2968
- # event_time: Time.now,
2969
- # event_type: "TimelineEventType",
2970
- # incident_record_arn: "Arn", # required
2971
- # }
2972
- #
2973
2357
  # @!attribute [rw] client_token
2974
- # A token ensuring that the operation is called only once with the
2975
- # specified details.
2358
+ # A token that ensures that a client calls the operation only once
2359
+ # with the specified details.
2976
2360
  #
2977
2361
  # **A suitable default value is auto-generated.** You should normally
2978
2362
  # not need to pass this option.
@@ -2983,23 +2367,24 @@ module Aws::SSMIncidents
2983
2367
  # @return [String]
2984
2368
  #
2985
2369
  # @!attribute [rw] event_id
2986
- # The ID of the event you are updating. You can find this by using
2987
- # `ListTimelineEvents`.
2370
+ # The ID of the event to update. You can use `ListTimelineEvents` to
2371
+ # find an event's ID.
2988
2372
  # @return [String]
2989
2373
  #
2990
2374
  # @!attribute [rw] event_references
2991
- # Updates all existing references in a `TimelineEvent`. A reference
2992
- # can be an Amazon Web Services resource involved in the incident or
2993
- # in some way associated with it. When you specify a reference, you
2994
- # enter the Amazon Resource Name (ARN) of the resource. You can also
2995
- # specify a related item. As an example, you could specify the ARN of
2996
- # an Amazon DynamoDB (DynamoDB) table. The table for this example is
2997
- # the resource. You could also specify a Amazon CloudWatch metric for
2998
- # that table. The metric is the related item.
2375
+ # Updates all existing references in a `TimelineEvent`. A reference is
2376
+ # an Amazon Web Services resource involved or associated with the
2377
+ # incident. To specify a reference, enter its Amazon Resource Name
2378
+ # (ARN). You can also specify a related item associated with that
2379
+ # resource. For example, to specify an Amazon DynamoDB (DynamoDB)
2380
+ # table as a resource, use its ARN. You can also specify an Amazon
2381
+ # CloudWatch metric associated with the DynamoDB table as a related
2382
+ # item.
2999
2383
  #
3000
2384
  # This update action overrides all existing references. If you want to
3001
2385
  # keep existing references, you must specify them in the call. If you
3002
- # don't, this action removes them and enters only new references.
2386
+ # don't, this action removes any existing references and enters only
2387
+ # new references.
3003
2388
  # @return [Array<Types::EventReference>]
3004
2389
  #
3005
2390
  # @!attribute [rw] event_time
@@ -3007,7 +2392,7 @@ module Aws::SSMIncidents
3007
2392
  # @return [Time]
3008
2393
  #
3009
2394
  # @!attribute [rw] event_type
3010
- # The type of the event. You can update events of type `Custom Event`.
2395
+ # The type of event. You can update events of type `Custom Event`.
3011
2396
  # @return [String]
3012
2397
  #
3013
2398
  # @!attribute [rw] incident_record_arn