aws-sdk-ssmincidents 1.17.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssmincidents/client.rb +71 -20
- data/lib/aws-sdk-ssmincidents/client_api.rb +19 -0
- data/lib/aws-sdk-ssmincidents/types.rb +126 -23
- data/lib/aws-sdk-ssmincidents.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f6b2ee80c3185adba475faa323cdcb7aad23956b8e8bed5c0df3618fc028c0c2
|
4
|
+
data.tar.gz: f6a3606e949f6714d562b103cb01827cae2a8bda0ded4a4cdc05d4818317cf3d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4b68cd0b5b91f49994327420859795ba8210ea29e8d5f0a00fbfa5bd35d70b310a69758c181b4d1258b9ab729eba46aaa698bcda3d8c065d39474755459beebd
|
7
|
+
data.tar.gz: 9ce6c014fb9b1f9370d6991cfe00dd21b9b46840974f5ffa71cd4ab2b6e3c2e852621fc231ab09dcac009dd436bd5fef09d68f5440e762bc94381fe3b30988f2
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.19.0 (2022-11-11)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - RelatedItems now have an ID field which can be used for referencing them else where. Introducing event references in TimelineEvent API and increasing maximum length of "eventData" to 12K characters.
|
8
|
+
|
9
|
+
1.18.0 (2022-11-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Adds support for tagging replication-set on creation.
|
13
|
+
|
4
14
|
1.17.0 (2022-10-25)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.19.0
|
@@ -372,7 +372,7 @@ module Aws::SSMIncidents
|
|
372
372
|
# Regions with the provided KMS key.
|
373
373
|
#
|
374
374
|
# @option params [String] :client_token
|
375
|
-
# A token
|
375
|
+
# A token that ensures that the operation is called only once with the
|
376
376
|
# specified details.
|
377
377
|
#
|
378
378
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -382,6 +382,9 @@ module Aws::SSMIncidents
|
|
382
382
|
# The Regions that Incident Manager replicates your data to. You can
|
383
383
|
# have up to three Regions in your replication set.
|
384
384
|
#
|
385
|
+
# @option params [Hash<String,String>] :tags
|
386
|
+
# A list of tags to add to the replication set.
|
387
|
+
#
|
385
388
|
# @return [Types::CreateReplicationSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
386
389
|
#
|
387
390
|
# * {Types::CreateReplicationSetOutput#arn #arn} => String
|
@@ -395,6 +398,9 @@ module Aws::SSMIncidents
|
|
395
398
|
# sse_kms_key_id: "SseKmsKey",
|
396
399
|
# },
|
397
400
|
# },
|
401
|
+
# tags: {
|
402
|
+
# "TagKey" => "TagValue",
|
403
|
+
# },
|
398
404
|
# })
|
399
405
|
#
|
400
406
|
# @example Response structure
|
@@ -433,8 +439,8 @@ module Aws::SSMIncidents
|
|
433
439
|
# spaces.
|
434
440
|
#
|
435
441
|
# @option params [Array<String>] :engagements
|
436
|
-
# The
|
437
|
-
# during an incident.
|
442
|
+
# The Amazon Resource Name (ARN) for the contacts and escalation plans
|
443
|
+
# that the response plan engages during an incident.
|
438
444
|
#
|
439
445
|
# @option params [required, Types::IncidentTemplate] :incident_template
|
440
446
|
# Details used to create an incident when using this response plan.
|
@@ -527,6 +533,16 @@ module Aws::SSMIncidents
|
|
527
533
|
# @option params [required, String] :event_data
|
528
534
|
# A short description of the event.
|
529
535
|
#
|
536
|
+
# @option params [Array<Types::EventReference>] :event_references
|
537
|
+
# Adds one or more references to the `TimelineEvent`. A reference can be
|
538
|
+
# an Amazon Web Services resource involved in the incident or in some
|
539
|
+
# way associated with it. When you specify a reference, you enter the
|
540
|
+
# Amazon Resource Name (ARN) of the resource. You can also specify a
|
541
|
+
# related item. As an example, you could specify the ARN of an Amazon
|
542
|
+
# DynamoDB (DynamoDB) table. The table for this example is the resource.
|
543
|
+
# You could also specify a Amazon CloudWatch metric for that table. The
|
544
|
+
# metric is the related item.
|
545
|
+
#
|
530
546
|
# @option params [required, Time,DateTime,Date,Integer,String] :event_time
|
531
547
|
# The time that the event occurred.
|
532
548
|
#
|
@@ -548,6 +564,12 @@ module Aws::SSMIncidents
|
|
548
564
|
# resp = client.create_timeline_event({
|
549
565
|
# client_token: "ClientToken",
|
550
566
|
# event_data: "EventData", # required
|
567
|
+
# event_references: [
|
568
|
+
# {
|
569
|
+
# related_item_id: "GeneratedId",
|
570
|
+
# resource: "Arn",
|
571
|
+
# },
|
572
|
+
# ],
|
551
573
|
# event_time: Time.now, # required
|
552
574
|
# event_type: "TimelineEventType", # required
|
553
575
|
# incident_record_arn: "Arn", # required
|
@@ -791,7 +813,7 @@ module Aws::SSMIncidents
|
|
791
813
|
# plan.
|
792
814
|
#
|
793
815
|
# @option params [Integer] :max_results
|
794
|
-
# The maximum number of resource policies to display
|
816
|
+
# The maximum number of resource policies to display for each page of
|
795
817
|
# results.
|
796
818
|
#
|
797
819
|
# @option params [String] :next_token
|
@@ -916,6 +938,9 @@ module Aws::SSMIncidents
|
|
916
938
|
#
|
917
939
|
# resp.event.event_data #=> String
|
918
940
|
# resp.event.event_id #=> String
|
941
|
+
# resp.event.event_references #=> Array
|
942
|
+
# resp.event.event_references[0].related_item_id #=> String
|
943
|
+
# resp.event.event_references[0].resource #=> String
|
919
944
|
# resp.event.event_time #=> Time
|
920
945
|
# resp.event.event_type #=> String
|
921
946
|
# resp.event.event_updated_time #=> Time
|
@@ -1045,6 +1070,7 @@ module Aws::SSMIncidents
|
|
1045
1070
|
#
|
1046
1071
|
# resp.next_token #=> String
|
1047
1072
|
# resp.related_items #=> Array
|
1073
|
+
# resp.related_items[0].generated_id #=> String
|
1048
1074
|
# resp.related_items[0].identifier.type #=> String, one of "ANALYSIS", "INCIDENT", "METRIC", "PARENT", "ATTACHMENT", "OTHER", "AUTOMATION", "INVOLVED_RESOURCE", "TASK"
|
1049
1075
|
# resp.related_items[0].identifier.value.arn #=> String
|
1050
1076
|
# resp.related_items[0].identifier.value.metric_definition #=> String
|
@@ -1237,6 +1263,9 @@ module Aws::SSMIncidents
|
|
1237
1263
|
#
|
1238
1264
|
# resp.event_summaries #=> Array
|
1239
1265
|
# resp.event_summaries[0].event_id #=> String
|
1266
|
+
# resp.event_summaries[0].event_references #=> Array
|
1267
|
+
# resp.event_summaries[0].event_references[0].related_item_id #=> String
|
1268
|
+
# resp.event_summaries[0].event_references[0].resource #=> String
|
1240
1269
|
# resp.event_summaries[0].event_time #=> Time
|
1241
1270
|
# resp.event_summaries[0].event_type #=> String
|
1242
1271
|
# resp.event_summaries[0].event_updated_time #=> Time
|
@@ -1255,17 +1284,17 @@ module Aws::SSMIncidents
|
|
1255
1284
|
# Adds a resource policy to the specified response plan. The resource
|
1256
1285
|
# policy is used to share the response plan using Resource Access
|
1257
1286
|
# Manager (RAM). For more information about cross-account sharing, see
|
1258
|
-
# [
|
1287
|
+
# [Cross-Region and cross-account incident management][1].
|
1259
1288
|
#
|
1260
1289
|
#
|
1261
1290
|
#
|
1262
|
-
# [1]: https://docs.aws.amazon.com/incident-manager/latest/userguide/
|
1291
|
+
# [1]: https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-cross-account-cross-region.html
|
1263
1292
|
#
|
1264
1293
|
# @option params [required, String] :policy
|
1265
1294
|
# Details of the resource policy.
|
1266
1295
|
#
|
1267
1296
|
# @option params [required, String] :resource_arn
|
1268
|
-
# The Amazon Resource Name (ARN) of the response plan
|
1297
|
+
# The Amazon Resource Name (ARN) of the response plan to add the
|
1269
1298
|
# resource policy to.
|
1270
1299
|
#
|
1271
1300
|
# @return [Types::PutResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1351,6 +1380,7 @@ module Aws::SSMIncidents
|
|
1351
1380
|
# impact: 1,
|
1352
1381
|
# related_items: [
|
1353
1382
|
# {
|
1383
|
+
# generated_id: "GeneratedId",
|
1354
1384
|
# identifier: { # required
|
1355
1385
|
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
1356
1386
|
# value: { # required
|
@@ -1392,7 +1422,7 @@ module Aws::SSMIncidents
|
|
1392
1422
|
# tags to.
|
1393
1423
|
#
|
1394
1424
|
# @option params [required, Hash<String,String>] :tags
|
1395
|
-
# A list of tags
|
1425
|
+
# A list of tags to add to the response plan.
|
1396
1426
|
#
|
1397
1427
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1398
1428
|
#
|
@@ -1421,7 +1451,7 @@ module Aws::SSMIncidents
|
|
1421
1451
|
# tag from.
|
1422
1452
|
#
|
1423
1453
|
# @option params [required, Array<String>] :tag_keys
|
1424
|
-
# The name of the tag
|
1454
|
+
# The name of the tag to remove from the response plan.
|
1425
1455
|
#
|
1426
1456
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1427
1457
|
#
|
@@ -1445,18 +1475,17 @@ module Aws::SSMIncidents
|
|
1445
1475
|
# final Region in a replication set.
|
1446
1476
|
#
|
1447
1477
|
# @option params [required, String] :arn
|
1448
|
-
# The Amazon Resource Name (ARN) of the replication set
|
1449
|
-
# updating.
|
1478
|
+
# The Amazon Resource Name (ARN) of the replication set to update.
|
1450
1479
|
#
|
1451
1480
|
# @option params [String] :client_token
|
1452
|
-
# A token
|
1481
|
+
# A token that ensures that the operation is called only once with the
|
1453
1482
|
# specified details.
|
1454
1483
|
#
|
1455
1484
|
# **A suitable default value is auto-generated.** You should normally
|
1456
1485
|
# not need to pass this option.**
|
1457
1486
|
#
|
1458
1487
|
# @option params [required, Boolean] :deletion_protected
|
1459
|
-
#
|
1488
|
+
# Specifies if deletion protection is turned on or off in your account.
|
1460
1489
|
#
|
1461
1490
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1462
1491
|
#
|
@@ -1595,6 +1624,7 @@ module Aws::SSMIncidents
|
|
1595
1624
|
# incident_record_arn: "Arn", # required
|
1596
1625
|
# related_items_update: { # required
|
1597
1626
|
# item_to_add: {
|
1627
|
+
# generated_id: "GeneratedId",
|
1598
1628
|
# identifier: { # required
|
1599
1629
|
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
1600
1630
|
# value: { # required
|
@@ -1635,7 +1665,7 @@ module Aws::SSMIncidents
|
|
1635
1665
|
# updating.
|
1636
1666
|
#
|
1637
1667
|
# @option params [String] :client_token
|
1638
|
-
# A token
|
1668
|
+
# A token that ensures that the operation is called only once with the
|
1639
1669
|
# specified details.
|
1640
1670
|
#
|
1641
1671
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1697,8 +1727,8 @@ module Aws::SSMIncidents
|
|
1697
1727
|
# contain spaces.
|
1698
1728
|
#
|
1699
1729
|
# @option params [Array<String>] :engagements
|
1700
|
-
# The
|
1701
|
-
#
|
1730
|
+
# The Amazon Resource Name (ARN) for the contacts and escalation plans
|
1731
|
+
# that the response plan engages during an incident.
|
1702
1732
|
#
|
1703
1733
|
# @option params [String] :incident_template_dedupe_string
|
1704
1734
|
# The string Incident Manager uses to prevent duplicate incidents from
|
@@ -1729,9 +1759,10 @@ module Aws::SSMIncidents
|
|
1729
1759
|
# happened, what's currently happening, and next steps.
|
1730
1760
|
#
|
1731
1761
|
# @option params [Hash<String,String>] :incident_template_tags
|
1732
|
-
# Tags to
|
1733
|
-
#
|
1734
|
-
#
|
1762
|
+
# Tags to assign to the template. When the `StartIncident` API action is
|
1763
|
+
# called, Incident Manager assigns the tags specified in the template to
|
1764
|
+
# the incident. To call this action, you must also have permission to
|
1765
|
+
# call the `TagResource` API action for the incident record resource.
|
1735
1766
|
#
|
1736
1767
|
# @option params [String] :incident_template_title
|
1737
1768
|
# The short format name of the incident. The title can't contain
|
@@ -1809,6 +1840,20 @@ module Aws::SSMIncidents
|
|
1809
1840
|
# The ID of the event you are updating. You can find this by using
|
1810
1841
|
# `ListTimelineEvents`.
|
1811
1842
|
#
|
1843
|
+
# @option params [Array<Types::EventReference>] :event_references
|
1844
|
+
# Updates all existing references in a `TimelineEvent`. A reference can
|
1845
|
+
# be an Amazon Web Services resource involved in the incident or in some
|
1846
|
+
# way associated with it. When you specify a reference, you enter the
|
1847
|
+
# Amazon Resource Name (ARN) of the resource. You can also specify a
|
1848
|
+
# related item. As an example, you could specify the ARN of an Amazon
|
1849
|
+
# DynamoDB (DynamoDB) table. The table for this example is the resource.
|
1850
|
+
# You could also specify a Amazon CloudWatch metric for that table. The
|
1851
|
+
# metric is the related item.
|
1852
|
+
#
|
1853
|
+
# This update action overrides all existing references. If you want to
|
1854
|
+
# keep existing references, you must specify them in the call. If you
|
1855
|
+
# don't, this action removes them and enters only new references.
|
1856
|
+
#
|
1812
1857
|
# @option params [Time,DateTime,Date,Integer,String] :event_time
|
1813
1858
|
# The time that the event occurred.
|
1814
1859
|
#
|
@@ -1827,6 +1872,12 @@ module Aws::SSMIncidents
|
|
1827
1872
|
# client_token: "ClientToken",
|
1828
1873
|
# event_data: "EventData",
|
1829
1874
|
# event_id: "UUID", # required
|
1875
|
+
# event_references: [
|
1876
|
+
# {
|
1877
|
+
# related_item_id: "GeneratedId",
|
1878
|
+
# resource: "Arn",
|
1879
|
+
# },
|
1880
|
+
# ],
|
1830
1881
|
# event_time: Time.now,
|
1831
1882
|
# event_type: "TimelineEventType",
|
1832
1883
|
# incident_record_arn: "Arn", # required
|
@@ -1854,7 +1905,7 @@ module Aws::SSMIncidents
|
|
1854
1905
|
params: params,
|
1855
1906
|
config: config)
|
1856
1907
|
context[:gem_name] = 'aws-sdk-ssmincidents'
|
1857
|
-
context[:gem_version] = '1.
|
1908
|
+
context[:gem_version] = '1.19.0'
|
1858
1909
|
Seahorse::Client::Request.new(handlers, context)
|
1859
1910
|
end
|
1860
1911
|
|
@@ -51,12 +51,15 @@ module Aws::SSMIncidents
|
|
51
51
|
EmptyChatChannel = Shapes::StructureShape.new(name: 'EmptyChatChannel')
|
52
52
|
EngagementSet = Shapes::ListShape.new(name: 'EngagementSet')
|
53
53
|
EventData = Shapes::StringShape.new(name: 'EventData')
|
54
|
+
EventReference = Shapes::UnionShape.new(name: 'EventReference')
|
55
|
+
EventReferenceList = Shapes::ListShape.new(name: 'EventReferenceList')
|
54
56
|
EventSummary = Shapes::StructureShape.new(name: 'EventSummary')
|
55
57
|
EventSummaryList = Shapes::ListShape.new(name: 'EventSummaryList')
|
56
58
|
ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
|
57
59
|
Filter = Shapes::StructureShape.new(name: 'Filter')
|
58
60
|
FilterKeyString = Shapes::StringShape.new(name: 'FilterKeyString')
|
59
61
|
FilterList = Shapes::ListShape.new(name: 'FilterList')
|
62
|
+
GeneratedId = Shapes::StringShape.new(name: 'GeneratedId')
|
60
63
|
GetIncidentRecordInput = Shapes::StructureShape.new(name: 'GetIncidentRecordInput')
|
61
64
|
GetIncidentRecordOutput = Shapes::StructureShape.new(name: 'GetIncidentRecordOutput')
|
62
65
|
GetReplicationSetInput = Shapes::StructureShape.new(name: 'GetReplicationSetInput')
|
@@ -240,6 +243,7 @@ module Aws::SSMIncidents
|
|
240
243
|
|
241
244
|
CreateReplicationSetInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
242
245
|
CreateReplicationSetInput.add_member(:regions, Shapes::ShapeRef.new(shape: RegionMapInput, required: true, location_name: "regions"))
|
246
|
+
CreateReplicationSetInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
|
243
247
|
CreateReplicationSetInput.struct_class = Types::CreateReplicationSetInput
|
244
248
|
|
245
249
|
CreateReplicationSetOutput.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "arn"))
|
@@ -260,6 +264,7 @@ module Aws::SSMIncidents
|
|
260
264
|
|
261
265
|
CreateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
262
266
|
CreateTimelineEventInput.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, required: true, location_name: "eventData"))
|
267
|
+
CreateTimelineEventInput.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
|
263
268
|
CreateTimelineEventInput.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
|
264
269
|
CreateTimelineEventInput.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
|
265
270
|
CreateTimelineEventInput.add_member(:incident_record_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "incidentRecordArn"))
|
@@ -312,7 +317,18 @@ module Aws::SSMIncidents
|
|
312
317
|
|
313
318
|
EngagementSet.member = Shapes::ShapeRef.new(shape: SsmContactsArn)
|
314
319
|
|
320
|
+
EventReference.add_member(:related_item_id, Shapes::ShapeRef.new(shape: GeneratedId, location_name: "relatedItemId"))
|
321
|
+
EventReference.add_member(:resource, Shapes::ShapeRef.new(shape: Arn, location_name: "resource"))
|
322
|
+
EventReference.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
323
|
+
EventReference.add_member_subclass(:related_item_id, Types::EventReference::RelatedItemId)
|
324
|
+
EventReference.add_member_subclass(:resource, Types::EventReference::Resource)
|
325
|
+
EventReference.add_member_subclass(:unknown, Types::EventReference::Unknown)
|
326
|
+
EventReference.struct_class = Types::EventReference
|
327
|
+
|
328
|
+
EventReferenceList.member = Shapes::ShapeRef.new(shape: EventReference)
|
329
|
+
|
315
330
|
EventSummary.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
|
331
|
+
EventSummary.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
|
316
332
|
EventSummary.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
|
317
333
|
EventSummary.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
|
318
334
|
EventSummary.add_member(:event_updated_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventUpdatedTime"))
|
@@ -509,6 +525,7 @@ module Aws::SSMIncidents
|
|
509
525
|
RegionMapInputValue.add_member(:sse_kms_key_id, Shapes::ShapeRef.new(shape: SseKmsKey, location_name: "sseKmsKeyId"))
|
510
526
|
RegionMapInputValue.struct_class = Types::RegionMapInputValue
|
511
527
|
|
528
|
+
RelatedItem.add_member(:generated_id, Shapes::ShapeRef.new(shape: GeneratedId, location_name: "generatedId"))
|
512
529
|
RelatedItem.add_member(:identifier, Shapes::ShapeRef.new(shape: ItemIdentifier, required: true, location_name: "identifier"))
|
513
530
|
RelatedItem.add_member(:title, Shapes::ShapeRef.new(shape: RelatedItemTitleString, location_name: "title"))
|
514
531
|
RelatedItem.struct_class = Types::RelatedItem
|
@@ -608,6 +625,7 @@ module Aws::SSMIncidents
|
|
608
625
|
|
609
626
|
TimelineEvent.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, required: true, location_name: "eventData"))
|
610
627
|
TimelineEvent.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
|
628
|
+
TimelineEvent.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
|
611
629
|
TimelineEvent.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
|
612
630
|
TimelineEvent.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
|
613
631
|
TimelineEvent.add_member(:event_updated_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventUpdatedTime"))
|
@@ -688,6 +706,7 @@ module Aws::SSMIncidents
|
|
688
706
|
UpdateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
689
707
|
UpdateTimelineEventInput.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, location_name: "eventData"))
|
690
708
|
UpdateTimelineEventInput.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
|
709
|
+
UpdateTimelineEventInput.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
|
691
710
|
UpdateTimelineEventInput.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "eventTime"))
|
692
711
|
UpdateTimelineEventInput.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, location_name: "eventType"))
|
693
712
|
UpdateTimelineEventInput.add_member(:incident_record_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "incidentRecordArn"))
|
@@ -233,10 +233,13 @@ module Aws::SSMIncidents
|
|
233
233
|
# sse_kms_key_id: "SseKmsKey",
|
234
234
|
# },
|
235
235
|
# },
|
236
|
+
# tags: {
|
237
|
+
# "TagKey" => "TagValue",
|
238
|
+
# },
|
236
239
|
# }
|
237
240
|
#
|
238
241
|
# @!attribute [rw] client_token
|
239
|
-
# A token
|
242
|
+
# A token that ensures that the operation is called only once with the
|
240
243
|
# specified details.
|
241
244
|
#
|
242
245
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -248,11 +251,16 @@ module Aws::SSMIncidents
|
|
248
251
|
# have up to three Regions in your replication set.
|
249
252
|
# @return [Hash<String,Types::RegionMapInputValue>]
|
250
253
|
#
|
254
|
+
# @!attribute [rw] tags
|
255
|
+
# A list of tags to add to the replication set.
|
256
|
+
# @return [Hash<String,String>]
|
257
|
+
#
|
251
258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateReplicationSetInput AWS API Documentation
|
252
259
|
#
|
253
260
|
class CreateReplicationSetInput < Struct.new(
|
254
261
|
:client_token,
|
255
|
-
:regions
|
262
|
+
:regions,
|
263
|
+
:tags)
|
256
264
|
SENSITIVE = []
|
257
265
|
include Aws::Structure
|
258
266
|
end
|
@@ -342,8 +350,8 @@ module Aws::SSMIncidents
|
|
342
350
|
# @return [String]
|
343
351
|
#
|
344
352
|
# @!attribute [rw] engagements
|
345
|
-
# The
|
346
|
-
# during an incident.
|
353
|
+
# The Amazon Resource Name (ARN) for the contacts and escalation plans
|
354
|
+
# that the response plan engages during an incident.
|
347
355
|
# @return [Array<String>]
|
348
356
|
#
|
349
357
|
# @!attribute [rw] incident_template
|
@@ -391,6 +399,12 @@ module Aws::SSMIncidents
|
|
391
399
|
# {
|
392
400
|
# client_token: "ClientToken",
|
393
401
|
# event_data: "EventData", # required
|
402
|
+
# event_references: [
|
403
|
+
# {
|
404
|
+
# related_item_id: "GeneratedId",
|
405
|
+
# resource: "Arn",
|
406
|
+
# },
|
407
|
+
# ],
|
394
408
|
# event_time: Time.now, # required
|
395
409
|
# event_type: "TimelineEventType", # required
|
396
410
|
# incident_record_arn: "Arn", # required
|
@@ -408,6 +422,17 @@ module Aws::SSMIncidents
|
|
408
422
|
# A short description of the event.
|
409
423
|
# @return [String]
|
410
424
|
#
|
425
|
+
# @!attribute [rw] event_references
|
426
|
+
# Adds one or more references to the `TimelineEvent`. A reference can
|
427
|
+
# be an Amazon Web Services resource involved in the incident or in
|
428
|
+
# some way associated with it. When you specify a reference, you enter
|
429
|
+
# the Amazon Resource Name (ARN) of the resource. You can also specify
|
430
|
+
# a related item. As an example, you could specify the ARN of an
|
431
|
+
# Amazon DynamoDB (DynamoDB) table. The table for this example is the
|
432
|
+
# resource. You could also specify a Amazon CloudWatch metric for that
|
433
|
+
# table. The metric is the related item.
|
434
|
+
# @return [Array<Types::EventReference>]
|
435
|
+
#
|
411
436
|
# @!attribute [rw] event_time
|
412
437
|
# The time that the event occurred.
|
413
438
|
# @return [Time]
|
@@ -427,6 +452,7 @@ module Aws::SSMIncidents
|
|
427
452
|
class CreateTimelineEventInput < Struct.new(
|
428
453
|
:client_token,
|
429
454
|
:event_data,
|
455
|
+
:event_references,
|
430
456
|
:event_time,
|
431
457
|
:event_type,
|
432
458
|
:incident_record_arn)
|
@@ -639,12 +665,48 @@ module Aws::SSMIncidents
|
|
639
665
|
#
|
640
666
|
class EmptyChatChannel < Aws::EmptyStructure; end
|
641
667
|
|
668
|
+
# An item referenced in a `TimelineEvent` that is involved in or somehow
|
669
|
+
# associated with an incident. You can specify an Amazon Resource Name
|
670
|
+
# (ARN) for an Amazon Web Services resource or a `RelatedItem` ID.
|
671
|
+
#
|
672
|
+
# @note EventReference is a union - when making an API calls you must set exactly one of the members.
|
673
|
+
#
|
674
|
+
# @note EventReference is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EventReference corresponding to the set member.
|
675
|
+
#
|
676
|
+
# @!attribute [rw] related_item_id
|
677
|
+
# The ID of a `RelatedItem` referenced in a `TimelineEvent`.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] resource
|
681
|
+
# The Amazon Resource Name (ARN) of an Amazon Web Services resource
|
682
|
+
# referenced in a `TimelineEvent`.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/EventReference AWS API Documentation
|
686
|
+
#
|
687
|
+
class EventReference < Struct.new(
|
688
|
+
:related_item_id,
|
689
|
+
:resource,
|
690
|
+
:unknown)
|
691
|
+
SENSITIVE = []
|
692
|
+
include Aws::Structure
|
693
|
+
include Aws::Structure::Union
|
694
|
+
|
695
|
+
class RelatedItemId < EventReference; end
|
696
|
+
class Resource < EventReference; end
|
697
|
+
class Unknown < EventReference; end
|
698
|
+
end
|
699
|
+
|
642
700
|
# Details about a timeline event during an incident.
|
643
701
|
#
|
644
702
|
# @!attribute [rw] event_id
|
645
703
|
# The timeline event ID.
|
646
704
|
# @return [String]
|
647
705
|
#
|
706
|
+
# @!attribute [rw] event_references
|
707
|
+
# A list of references in a `TimelineEvent`.
|
708
|
+
# @return [Array<Types::EventReference>]
|
709
|
+
#
|
648
710
|
# @!attribute [rw] event_time
|
649
711
|
# The time that the event occurred.
|
650
712
|
# @return [Time]
|
@@ -666,6 +728,7 @@ module Aws::SSMIncidents
|
|
666
728
|
#
|
667
729
|
class EventSummary < Struct.new(
|
668
730
|
:event_id,
|
731
|
+
:event_references,
|
669
732
|
:event_time,
|
670
733
|
:event_type,
|
671
734
|
:event_updated_time,
|
@@ -782,7 +845,7 @@ module Aws::SSMIncidents
|
|
782
845
|
# }
|
783
846
|
#
|
784
847
|
# @!attribute [rw] max_results
|
785
|
-
# The maximum number of resource policies to display
|
848
|
+
# The maximum number of resource policies to display for each page of
|
786
849
|
# results.
|
787
850
|
# @return [Integer]
|
788
851
|
#
|
@@ -859,8 +922,8 @@ module Aws::SSMIncidents
|
|
859
922
|
# @return [String]
|
860
923
|
#
|
861
924
|
# @!attribute [rw] engagements
|
862
|
-
# The
|
863
|
-
# during an incident.
|
925
|
+
# The Amazon Resource Name (ARN) for the contacts and escalation plans
|
926
|
+
# that the response plan engages during an incident.
|
864
927
|
# @return [Array<String>]
|
865
928
|
#
|
866
929
|
# @!attribute [rw] incident_template
|
@@ -1119,8 +1182,9 @@ module Aws::SSMIncidents
|
|
1119
1182
|
# @return [Integer]
|
1120
1183
|
#
|
1121
1184
|
# @!attribute [rw] incident_tags
|
1122
|
-
# Tags to
|
1123
|
-
#
|
1185
|
+
# Tags to assign to the template. When the `StartIncident` API action
|
1186
|
+
# is called, Incident Manager assigns the tags specified in the
|
1187
|
+
# template to the incident.
|
1124
1188
|
# @return [Hash<String,String>]
|
1125
1189
|
#
|
1126
1190
|
# @!attribute [rw] notification_targets
|
@@ -1609,8 +1673,8 @@ module Aws::SSMIncidents
|
|
1609
1673
|
# @return [String]
|
1610
1674
|
#
|
1611
1675
|
# @!attribute [rw] resource_arn
|
1612
|
-
# The Amazon Resource Name (ARN) of the response plan
|
1613
|
-
#
|
1676
|
+
# The Amazon Resource Name (ARN) of the response plan to add the
|
1677
|
+
# resource policy to.
|
1614
1678
|
# @return [String]
|
1615
1679
|
#
|
1616
1680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/PutResourcePolicyInput AWS API Documentation
|
@@ -1695,6 +1759,7 @@ module Aws::SSMIncidents
|
|
1695
1759
|
# data as a hash:
|
1696
1760
|
#
|
1697
1761
|
# {
|
1762
|
+
# generated_id: "GeneratedId",
|
1698
1763
|
# identifier: { # required
|
1699
1764
|
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
1700
1765
|
# value: { # required
|
@@ -1706,6 +1771,13 @@ module Aws::SSMIncidents
|
|
1706
1771
|
# title: "RelatedItemTitleString",
|
1707
1772
|
# }
|
1708
1773
|
#
|
1774
|
+
# @!attribute [rw] generated_id
|
1775
|
+
# A unique ID for a `RelatedItem`.
|
1776
|
+
#
|
1777
|
+
# Don't specify this parameter when you add a `RelatedItem` by using
|
1778
|
+
# the UpdateRelatedItems API action.
|
1779
|
+
# @return [String]
|
1780
|
+
#
|
1709
1781
|
# @!attribute [rw] identifier
|
1710
1782
|
# Details about the related item.
|
1711
1783
|
# @return [Types::ItemIdentifier]
|
@@ -1717,6 +1789,7 @@ module Aws::SSMIncidents
|
|
1717
1789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RelatedItem AWS API Documentation
|
1718
1790
|
#
|
1719
1791
|
class RelatedItem < Struct.new(
|
1792
|
+
:generated_id,
|
1720
1793
|
:identifier,
|
1721
1794
|
:title)
|
1722
1795
|
SENSITIVE = []
|
@@ -1981,6 +2054,7 @@ module Aws::SSMIncidents
|
|
1981
2054
|
# impact: 1,
|
1982
2055
|
# related_items: [
|
1983
2056
|
# {
|
2057
|
+
# generated_id: "GeneratedId",
|
1984
2058
|
# identifier: { # required
|
1985
2059
|
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
1986
2060
|
# value: { # required
|
@@ -2094,7 +2168,7 @@ module Aws::SSMIncidents
|
|
2094
2168
|
# @return [String]
|
2095
2169
|
#
|
2096
2170
|
# @!attribute [rw] tags
|
2097
|
-
# A list of tags
|
2171
|
+
# A list of tags to add to the response plan.
|
2098
2172
|
# @return [Hash<String,String>]
|
2099
2173
|
#
|
2100
2174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/TagResourceRequest AWS API Documentation
|
@@ -2143,6 +2217,10 @@ module Aws::SSMIncidents
|
|
2143
2217
|
# The ID of the timeline event.
|
2144
2218
|
# @return [String]
|
2145
2219
|
#
|
2220
|
+
# @!attribute [rw] event_references
|
2221
|
+
# A list of references in a `TimelineEvent`.
|
2222
|
+
# @return [Array<Types::EventReference>]
|
2223
|
+
#
|
2146
2224
|
# @!attribute [rw] event_time
|
2147
2225
|
# The time that the event occurred.
|
2148
2226
|
# @return [Time]
|
@@ -2166,6 +2244,7 @@ module Aws::SSMIncidents
|
|
2166
2244
|
class TimelineEvent < Struct.new(
|
2167
2245
|
:event_data,
|
2168
2246
|
:event_id,
|
2247
|
+
:event_references,
|
2169
2248
|
:event_time,
|
2170
2249
|
:event_type,
|
2171
2250
|
:event_updated_time,
|
@@ -2234,7 +2313,7 @@ module Aws::SSMIncidents
|
|
2234
2313
|
# @return [String]
|
2235
2314
|
#
|
2236
2315
|
# @!attribute [rw] tag_keys
|
2237
|
-
# The name of the tag
|
2316
|
+
# The name of the tag to remove from the response plan.
|
2238
2317
|
# @return [Array<String>]
|
2239
2318
|
#
|
2240
2319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UntagResourceRequest AWS API Documentation
|
@@ -2260,12 +2339,11 @@ module Aws::SSMIncidents
|
|
2260
2339
|
# }
|
2261
2340
|
#
|
2262
2341
|
# @!attribute [rw] arn
|
2263
|
-
# The Amazon Resource Name (ARN) of the replication set
|
2264
|
-
# updating.
|
2342
|
+
# The Amazon Resource Name (ARN) of the replication set to update.
|
2265
2343
|
# @return [String]
|
2266
2344
|
#
|
2267
2345
|
# @!attribute [rw] client_token
|
2268
|
-
# A token
|
2346
|
+
# A token that ensures that the operation is called only once with the
|
2269
2347
|
# specified details.
|
2270
2348
|
#
|
2271
2349
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2273,7 +2351,7 @@ module Aws::SSMIncidents
|
|
2273
2351
|
# @return [String]
|
2274
2352
|
#
|
2275
2353
|
# @!attribute [rw] deletion_protected
|
2276
|
-
#
|
2354
|
+
# Specifies if deletion protection is turned on or off in your
|
2277
2355
|
# account.
|
2278
2356
|
# @return [Boolean]
|
2279
2357
|
#
|
@@ -2399,6 +2477,7 @@ module Aws::SSMIncidents
|
|
2399
2477
|
# incident_record_arn: "Arn", # required
|
2400
2478
|
# related_items_update: { # required
|
2401
2479
|
# item_to_add: {
|
2480
|
+
# generated_id: "GeneratedId",
|
2402
2481
|
# identifier: { # required
|
2403
2482
|
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
|
2404
2483
|
# value: { # required
|
@@ -2509,7 +2588,7 @@ module Aws::SSMIncidents
|
|
2509
2588
|
# @return [String]
|
2510
2589
|
#
|
2511
2590
|
# @!attribute [rw] client_token
|
2512
|
-
# A token
|
2591
|
+
# A token that ensures that the operation is called only once with the
|
2513
2592
|
# specified details.
|
2514
2593
|
#
|
2515
2594
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2605,8 +2684,8 @@ module Aws::SSMIncidents
|
|
2605
2684
|
# @return [String]
|
2606
2685
|
#
|
2607
2686
|
# @!attribute [rw] engagements
|
2608
|
-
# The
|
2609
|
-
# the
|
2687
|
+
# The Amazon Resource Name (ARN) for the contacts and escalation plans
|
2688
|
+
# that the response plan engages during an incident.
|
2610
2689
|
# @return [Array<String>]
|
2611
2690
|
#
|
2612
2691
|
# @!attribute [rw] incident_template_dedupe_string
|
@@ -2642,9 +2721,11 @@ module Aws::SSMIncidents
|
|
2642
2721
|
# @return [String]
|
2643
2722
|
#
|
2644
2723
|
# @!attribute [rw] incident_template_tags
|
2645
|
-
# Tags to
|
2646
|
-
#
|
2647
|
-
# the
|
2724
|
+
# Tags to assign to the template. When the `StartIncident` API action
|
2725
|
+
# is called, Incident Manager assigns the tags specified in the
|
2726
|
+
# template to the incident. To call this action, you must also have
|
2727
|
+
# permission to call the `TagResource` API action for the incident
|
2728
|
+
# record resource.
|
2648
2729
|
# @return [Hash<String,String>]
|
2649
2730
|
#
|
2650
2731
|
# @!attribute [rw] incident_template_title
|
@@ -2682,6 +2763,12 @@ module Aws::SSMIncidents
|
|
2682
2763
|
# client_token: "ClientToken",
|
2683
2764
|
# event_data: "EventData",
|
2684
2765
|
# event_id: "UUID", # required
|
2766
|
+
# event_references: [
|
2767
|
+
# {
|
2768
|
+
# related_item_id: "GeneratedId",
|
2769
|
+
# resource: "Arn",
|
2770
|
+
# },
|
2771
|
+
# ],
|
2685
2772
|
# event_time: Time.now,
|
2686
2773
|
# event_type: "TimelineEventType",
|
2687
2774
|
# incident_record_arn: "Arn", # required
|
@@ -2704,6 +2791,21 @@ module Aws::SSMIncidents
|
|
2704
2791
|
# `ListTimelineEvents`.
|
2705
2792
|
# @return [String]
|
2706
2793
|
#
|
2794
|
+
# @!attribute [rw] event_references
|
2795
|
+
# Updates all existing references in a `TimelineEvent`. A reference
|
2796
|
+
# can be an Amazon Web Services resource involved in the incident or
|
2797
|
+
# in some way associated with it. When you specify a reference, you
|
2798
|
+
# enter the Amazon Resource Name (ARN) of the resource. You can also
|
2799
|
+
# specify a related item. As an example, you could specify the ARN of
|
2800
|
+
# an Amazon DynamoDB (DynamoDB) table. The table for this example is
|
2801
|
+
# the resource. You could also specify a Amazon CloudWatch metric for
|
2802
|
+
# that table. The metric is the related item.
|
2803
|
+
#
|
2804
|
+
# This update action overrides all existing references. If you want to
|
2805
|
+
# keep existing references, you must specify them in the call. If you
|
2806
|
+
# don't, this action removes them and enters only new references.
|
2807
|
+
# @return [Array<Types::EventReference>]
|
2808
|
+
#
|
2707
2809
|
# @!attribute [rw] event_time
|
2708
2810
|
# The time that the event occurred.
|
2709
2811
|
# @return [Time]
|
@@ -2723,6 +2825,7 @@ module Aws::SSMIncidents
|
|
2723
2825
|
:client_token,
|
2724
2826
|
:event_data,
|
2725
2827
|
:event_id,
|
2828
|
+
:event_references,
|
2726
2829
|
:event_time,
|
2727
2830
|
:event_type,
|
2728
2831
|
:incident_record_arn)
|
data/lib/aws-sdk-ssmincidents.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-ssmincidents
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.19.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-11-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|