aws-sdk-ssmincidents 1.2.0 → 1.6.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssmincidents/client.rb +92 -65
- data/lib/aws-sdk-ssmincidents/client_api.rb +4 -2
- data/lib/aws-sdk-ssmincidents/errors.rb +5 -0
- data/lib/aws-sdk-ssmincidents/types.rb +155 -110
- data/lib/aws-sdk-ssmincidents.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9d269770f161e42e699c421ba075b3dd9e06d8304926a537d5caaf2b2ce3bae5
|
4
|
+
data.tar.gz: eb4a0514478a7ccf1b9c37e8174a84bfc58769ba9ccb5cb541a05a0db4dc2070
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e065ccf0b033620e3bbf3c95d5caa6b0370055a76c5d89999ca2fb46ef38d5ff0449fa80334a5b0682b96e7bba926f7bb13f8527ecdccaa17aee2b086d80a055
|
7
|
+
data.tar.gz: eb3dac1ee5cb522d19762b65c7e1ba7f93db70ccca48d6db2ff856f6a5e9591f226eee622499b2286321cc884a6030477e23d312a6a77a5d90a20d9d576a415d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.6.0 (2021-10-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Updating documentation, adding new field to ConflictException to indicate earliest retry timestamp for some operations, increase maximum length of nextToken fields
|
8
|
+
|
9
|
+
1.5.0 (2021-10-18)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.4.0 (2021-09-01)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.3.0 (2021-08-04)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Documentation updates for Incident Manager.
|
23
|
+
|
4
24
|
1.2.0 (2021-07-30)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.6.0
|
@@ -331,7 +331,7 @@ module Aws::SSMIncidents
|
|
331
331
|
# Regions with the provided KMS key.
|
332
332
|
#
|
333
333
|
# @option params [String] :client_token
|
334
|
-
# A token ensuring that the
|
334
|
+
# A token ensuring that the operation is called only once with the
|
335
335
|
# specified details.
|
336
336
|
#
|
337
337
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -378,11 +378,10 @@ module Aws::SSMIncidents
|
|
378
378
|
# incident.
|
379
379
|
#
|
380
380
|
# @option params [Types::ChatChannel] :chat_channel
|
381
|
-
# The
|
382
|
-
# incident.
|
381
|
+
# The Chatbot chat channel used for collaboration during an incident.
|
383
382
|
#
|
384
383
|
# @option params [String] :client_token
|
385
|
-
# A token ensuring that the
|
384
|
+
# A token ensuring that the operation is called only once with the
|
386
385
|
# specified details.
|
387
386
|
#
|
388
387
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -469,7 +468,7 @@ module Aws::SSMIncidents
|
|
469
468
|
# timeline events to mark important events that are automatically
|
470
469
|
# detected by Incident Manager.
|
471
470
|
#
|
472
|
-
# @option params [
|
471
|
+
# @option params [String] :client_token
|
473
472
|
# A token ensuring that the action is called only once with the
|
474
473
|
# specified details.
|
475
474
|
#
|
@@ -477,7 +476,8 @@ module Aws::SSMIncidents
|
|
477
476
|
# not need to pass this option.**
|
478
477
|
#
|
479
478
|
# @option params [required, String] :event_data
|
480
|
-
# A short description of the event.
|
479
|
+
# A short description of the event as a valid JSON string. There is no
|
480
|
+
# other schema imposed.
|
481
481
|
#
|
482
482
|
# @option params [required, Time,DateTime,Date,Integer,String] :event_time
|
483
483
|
# The time that the event occurred.
|
@@ -487,8 +487,8 @@ module Aws::SSMIncidents
|
|
487
487
|
# Event`.
|
488
488
|
#
|
489
489
|
# @option params [required, String] :incident_record_arn
|
490
|
-
# The Amazon Resource Name (ARN) of the incident record
|
491
|
-
#
|
490
|
+
# The Amazon Resource Name (ARN) of the incident record to which the
|
491
|
+
# event will be added.
|
492
492
|
#
|
493
493
|
# @return [Types::CreateTimelineEventOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
494
494
|
#
|
@@ -498,7 +498,7 @@ module Aws::SSMIncidents
|
|
498
498
|
# @example Request syntax with placeholder values
|
499
499
|
#
|
500
500
|
# resp = client.create_timeline_event({
|
501
|
-
# client_token: "ClientToken",
|
501
|
+
# client_token: "ClientToken",
|
502
502
|
# event_data: "EventData", # required
|
503
503
|
# event_time: Time.now, # required
|
504
504
|
# event_type: "TimelineEventType", # required
|
@@ -566,8 +566,8 @@ module Aws::SSMIncidents
|
|
566
566
|
req.send_request(options)
|
567
567
|
end
|
568
568
|
|
569
|
-
# Deletes the resource policy that
|
570
|
-
#
|
569
|
+
# Deletes the resource policy that Resource Access Manager uses to share
|
570
|
+
# your Incident Manager resource.
|
571
571
|
#
|
572
572
|
# @option params [required, String] :policy_id
|
573
573
|
# The ID of the resource policy you're deleting.
|
@@ -625,8 +625,8 @@ module Aws::SSMIncidents
|
|
625
625
|
# `ListTimelineEvents`.
|
626
626
|
#
|
627
627
|
# @option params [required, String] :incident_record_arn
|
628
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
629
|
-
#
|
628
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
629
|
+
# timeline event.
|
630
630
|
#
|
631
631
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
632
632
|
#
|
@@ -646,7 +646,7 @@ module Aws::SSMIncidents
|
|
646
646
|
req.send_request(options)
|
647
647
|
end
|
648
648
|
|
649
|
-
# Returns the details
|
649
|
+
# Returns the details for the specified incident record.
|
650
650
|
#
|
651
651
|
# @option params [required, String] :arn
|
652
652
|
# The Amazon Resource Name (ARN) of the incident record.
|
@@ -711,6 +711,7 @@ module Aws::SSMIncidents
|
|
711
711
|
#
|
712
712
|
# @example Response structure
|
713
713
|
#
|
714
|
+
# resp.replication_set.arn #=> String
|
714
715
|
# resp.replication_set.created_by #=> String
|
715
716
|
# resp.replication_set.created_time #=> Time
|
716
717
|
# resp.replication_set.deletion_protected #=> Boolean
|
@@ -841,12 +842,12 @@ module Aws::SSMIncidents
|
|
841
842
|
# Retrieves a timeline event based on its ID and incident record.
|
842
843
|
#
|
843
844
|
# @option params [required, String] :event_id
|
844
|
-
# The ID of the event. You can get an event's ID when you create it or
|
845
|
+
# The ID of the event. You can get an event's ID when you create it, or
|
845
846
|
# by using `ListTimelineEvents`.
|
846
847
|
#
|
847
848
|
# @option params [required, String] :incident_record_arn
|
848
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
849
|
-
#
|
849
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
850
|
+
# timeline event.
|
850
851
|
#
|
851
852
|
# @return [Types::GetTimelineEventOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
852
853
|
#
|
@@ -882,8 +883,8 @@ module Aws::SSMIncidents
|
|
882
883
|
# want to update.
|
883
884
|
#
|
884
885
|
# @option params [Array<Types::Filter>] :filters
|
885
|
-
#
|
886
|
-
# filter on the following keys:
|
886
|
+
# Filters the list of incident records through which you are searching.
|
887
|
+
# You can filter on the following keys:
|
887
888
|
#
|
888
889
|
# * `creationTime`
|
889
890
|
#
|
@@ -893,6 +894,17 @@ module Aws::SSMIncidents
|
|
893
894
|
#
|
894
895
|
# * `createdBy`
|
895
896
|
#
|
897
|
+
# Note the following when deciding how to use Filters:
|
898
|
+
#
|
899
|
+
# * If you don't specify a Filter, the response includes all incident
|
900
|
+
# records.
|
901
|
+
#
|
902
|
+
# * If you specify more than one filter in a single request, the
|
903
|
+
# response returns incident records that match all filters.
|
904
|
+
#
|
905
|
+
# * If you specify a filter with more than one value, the response
|
906
|
+
# returns incident records that match any of the values provided.
|
907
|
+
#
|
896
908
|
# @option params [Integer] :max_results
|
897
909
|
# The maximum number of results per page.
|
898
910
|
#
|
@@ -953,8 +965,8 @@ module Aws::SSMIncidents
|
|
953
965
|
# List all related items for an incident record.
|
954
966
|
#
|
955
967
|
# @option params [required, String] :incident_record_arn
|
956
|
-
# The Amazon Resource Name (ARN) of the incident record
|
957
|
-
#
|
968
|
+
# The Amazon Resource Name (ARN) of the incident record containing the
|
969
|
+
# listed related items.
|
958
970
|
#
|
959
971
|
# @option params [Integer] :max_results
|
960
972
|
# The maximum number of related items per page.
|
@@ -1101,7 +1113,7 @@ module Aws::SSMIncidents
|
|
1101
1113
|
req.send_request(options)
|
1102
1114
|
end
|
1103
1115
|
|
1104
|
-
# Lists timeline events
|
1116
|
+
# Lists timeline events for the specified incident record.
|
1105
1117
|
#
|
1106
1118
|
# @option params [Array<Types::Filter>] :filters
|
1107
1119
|
# Filters the timeline events based on the provided conditional values.
|
@@ -1111,9 +1123,20 @@ module Aws::SSMIncidents
|
|
1111
1123
|
#
|
1112
1124
|
# * `eventType`
|
1113
1125
|
#
|
1126
|
+
# Note the following when deciding how to use Filters:
|
1127
|
+
#
|
1128
|
+
# * If you don't specify a Filter, the response includes all timeline
|
1129
|
+
# events.
|
1130
|
+
#
|
1131
|
+
# * If you specify more than one filter in a single request, the
|
1132
|
+
# response returns timeline events that match all filters.
|
1133
|
+
#
|
1134
|
+
# * If you specify a filter with more than one value, the response
|
1135
|
+
# returns timeline events that match any of the values provided.
|
1136
|
+
#
|
1114
1137
|
# @option params [required, String] :incident_record_arn
|
1115
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
1116
|
-
#
|
1138
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
1139
|
+
# timeline event.
|
1117
1140
|
#
|
1118
1141
|
# @option params [Integer] :max_results
|
1119
1142
|
# The maximum number of results per page.
|
@@ -1214,7 +1237,7 @@ module Aws::SSMIncidents
|
|
1214
1237
|
# or manually.
|
1215
1238
|
#
|
1216
1239
|
# @option params [String] :client_token
|
1217
|
-
# A token ensuring that the
|
1240
|
+
# A token ensuring that the operation is called only once with the
|
1218
1241
|
# specified details.
|
1219
1242
|
#
|
1220
1243
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1243,13 +1266,13 @@ module Aws::SSMIncidents
|
|
1243
1266
|
#
|
1244
1267
|
# @option params [Array<Types::RelatedItem>] :related_items
|
1245
1268
|
# Add related items to the incident for other responders to use. Related
|
1246
|
-
# items are AWS resources, external links, or files uploaded to an
|
1247
|
-
# bucket.
|
1269
|
+
# items are AWS resources, external links, or files uploaded to an
|
1270
|
+
# Amazon S3 bucket.
|
1248
1271
|
#
|
1249
1272
|
# @option params [required, String] :response_plan_arn
|
1250
1273
|
# The Amazon Resource Name (ARN) of the response plan that pre-defines
|
1251
|
-
# summary, chat channels, SNS topics, runbooks, title, and impact
|
1252
|
-
# incident.
|
1274
|
+
# summary, chat channels, Amazon SNS topics, runbooks, title, and impact
|
1275
|
+
# of the incident.
|
1253
1276
|
#
|
1254
1277
|
# @option params [String] :title
|
1255
1278
|
# Provide a title for the incident. Providing a title overwrites the
|
@@ -1367,7 +1390,7 @@ module Aws::SSMIncidents
|
|
1367
1390
|
# updating.
|
1368
1391
|
#
|
1369
1392
|
# @option params [String] :client_token
|
1370
|
-
# A token ensuring that the
|
1393
|
+
# A token ensuring that the operation is called only once with the
|
1371
1394
|
# specified details.
|
1372
1395
|
#
|
1373
1396
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1395,8 +1418,8 @@ module Aws::SSMIncidents
|
|
1395
1418
|
req.send_request(options)
|
1396
1419
|
end
|
1397
1420
|
|
1398
|
-
# Update the details of an incident record. You can use this
|
1399
|
-
# update an incident record from the defined chat channel. For more
|
1421
|
+
# Update the details of an incident record. You can use this operation
|
1422
|
+
# to update an incident record from the defined chat channel. For more
|
1400
1423
|
# information about using actions in chat channels, see [Interacting
|
1401
1424
|
# through chat][1].
|
1402
1425
|
#
|
@@ -1409,23 +1432,24 @@ module Aws::SSMIncidents
|
|
1409
1432
|
# updating.
|
1410
1433
|
#
|
1411
1434
|
# @option params [Types::ChatChannel] :chat_channel
|
1412
|
-
# The
|
1435
|
+
# The Chatbot chat channel where responders can collaborate.
|
1413
1436
|
#
|
1414
1437
|
# @option params [String] :client_token
|
1415
|
-
# A token
|
1438
|
+
# A token that ensures that the operation is called only once with the
|
1416
1439
|
# specified details.
|
1417
1440
|
#
|
1418
1441
|
# **A suitable default value is auto-generated.** You should normally
|
1419
1442
|
# not need to pass this option.**
|
1420
1443
|
#
|
1421
1444
|
# @option params [Integer] :impact
|
1422
|
-
# Defines the impact to customers and applications.
|
1423
|
-
# overwrites the impact provided by the response
|
1445
|
+
# Defines the impact of the incident to customers and applications.
|
1446
|
+
# Providing an impact overwrites the impact provided by the response
|
1447
|
+
# plan.
|
1424
1448
|
#
|
1425
1449
|
# **Possible impacts:**
|
1426
1450
|
#
|
1427
|
-
# * `1` - Critical impact,
|
1428
|
-
#
|
1451
|
+
# * `1` - Critical impact, full application failure that impacts many to
|
1452
|
+
# all customers.
|
1429
1453
|
#
|
1430
1454
|
# * `2` - High impact, partial application failure with impact to many
|
1431
1455
|
# customers.
|
@@ -1433,28 +1457,26 @@ module Aws::SSMIncidents
|
|
1433
1457
|
# * `3` - Medium impact, the application is providing reduced service to
|
1434
1458
|
# customers.
|
1435
1459
|
#
|
1436
|
-
# * `4` - Low impact, customer
|
1437
|
-
# yet.
|
1460
|
+
# * `4` - Low impact, customer aren't impacted by the problem yet.
|
1438
1461
|
#
|
1439
1462
|
# * `5` - No impact, customers aren't currently impacted but urgent
|
1440
1463
|
# action is needed to avoid impact.
|
1441
1464
|
#
|
1442
1465
|
# @option params [Array<Types::NotificationTargetItem>] :notification_targets
|
1443
|
-
# The SNS targets that
|
1444
|
-
#
|
1445
|
-
# through the chat channel using the SNS topics.
|
1466
|
+
# The Amazon SNS targets that are notified when updates are made to an
|
1467
|
+
# incident.
|
1446
1468
|
#
|
1447
|
-
# Using multiple SNS topics creates redundancy in the
|
1448
|
-
# is down during the incident.
|
1469
|
+
# Using multiple SNS topics creates redundancy in the event that a
|
1470
|
+
# Region is down during the incident.
|
1449
1471
|
#
|
1450
1472
|
# @option params [String] :status
|
1451
1473
|
# The status of the incident. An incident can be `Open` or `Resolved`.
|
1452
1474
|
#
|
1453
1475
|
# @option params [String] :summary
|
1454
|
-
#
|
1476
|
+
# A longer description of what occurred during the incident.
|
1455
1477
|
#
|
1456
1478
|
# @option params [String] :title
|
1457
|
-
#
|
1479
|
+
# A brief description of the incident.
|
1458
1480
|
#
|
1459
1481
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1460
1482
|
#
|
@@ -1492,15 +1514,15 @@ module Aws::SSMIncidents
|
|
1492
1514
|
# record.
|
1493
1515
|
#
|
1494
1516
|
# @option params [String] :client_token
|
1495
|
-
# A token ensuring that the
|
1517
|
+
# A token ensuring that the operation is called only once with the
|
1496
1518
|
# specified details.
|
1497
1519
|
#
|
1498
1520
|
# **A suitable default value is auto-generated.** You should normally
|
1499
1521
|
# not need to pass this option.**
|
1500
1522
|
#
|
1501
1523
|
# @option params [required, String] :incident_record_arn
|
1502
|
-
# The Amazon Resource Name (ARN) of the incident record
|
1503
|
-
# related items
|
1524
|
+
# The Amazon Resource Name (ARN) of the incident record containing the
|
1525
|
+
# related items you are updating.
|
1504
1526
|
#
|
1505
1527
|
# @option params [required, Types::RelatedItemsUpdate] :related_items_update
|
1506
1528
|
# Details about the item you are adding or deleting.
|
@@ -1554,7 +1576,7 @@ module Aws::SSMIncidents
|
|
1554
1576
|
# updating.
|
1555
1577
|
#
|
1556
1578
|
# @option params [String] :client_token
|
1557
|
-
# A token ensuring that the
|
1579
|
+
# A token ensuring that the operation is called only once with the
|
1558
1580
|
# specified details.
|
1559
1581
|
#
|
1560
1582
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1599,25 +1621,29 @@ module Aws::SSMIncidents
|
|
1599
1621
|
# The Amazon Resource Name (ARN) of the response plan.
|
1600
1622
|
#
|
1601
1623
|
# @option params [Types::ChatChannel] :chat_channel
|
1602
|
-
# The
|
1603
|
-
#
|
1624
|
+
# The Chatbot chat channel used for collaboration during an incident.
|
1625
|
+
#
|
1626
|
+
# Use the empty structure to remove the chat channel from the response
|
1627
|
+
# plan.
|
1604
1628
|
#
|
1605
1629
|
# @option params [String] :client_token
|
1606
|
-
# A token ensuring that the
|
1630
|
+
# A token ensuring that the operation is called only once with the
|
1607
1631
|
# specified details.
|
1608
1632
|
#
|
1609
1633
|
# **A suitable default value is auto-generated.** You should normally
|
1610
1634
|
# not need to pass this option.**
|
1611
1635
|
#
|
1612
1636
|
# @option params [String] :display_name
|
1613
|
-
# The long format name of the response plan.
|
1637
|
+
# The long format name of the response plan. The display name can't
|
1638
|
+
# contain spaces.
|
1614
1639
|
#
|
1615
1640
|
# @option params [Array<String>] :engagements
|
1616
1641
|
# The contacts and escalation plans that Incident Manager engages at the
|
1617
1642
|
# start of the incident.
|
1618
1643
|
#
|
1619
1644
|
# @option params [String] :incident_template_dedupe_string
|
1620
|
-
#
|
1645
|
+
# The string Incident Manager uses to prevent duplicate incidents from
|
1646
|
+
# being created by the same incident in the same account.
|
1621
1647
|
#
|
1622
1648
|
# @option params [Integer] :incident_template_impact
|
1623
1649
|
# Defines the impact to the customers. Providing an impact overwrites
|
@@ -1636,15 +1662,16 @@ module Aws::SSMIncidents
|
|
1636
1662
|
# * `1` - No impact
|
1637
1663
|
#
|
1638
1664
|
# @option params [Array<Types::NotificationTargetItem>] :incident_template_notification_targets
|
1639
|
-
# The SNS targets that
|
1640
|
-
#
|
1665
|
+
# The Amazon SNS targets that are notified when updates are made to an
|
1666
|
+
# incident.
|
1641
1667
|
#
|
1642
1668
|
# @option params [String] :incident_template_summary
|
1643
1669
|
# A brief summary of the incident. This typically contains what has
|
1644
1670
|
# happened, what's currently happening, and next steps.
|
1645
1671
|
#
|
1646
1672
|
# @option params [String] :incident_template_title
|
1647
|
-
# The short format name of the incident.
|
1673
|
+
# The short format name of the incident. The title can't contain
|
1674
|
+
# spaces.
|
1648
1675
|
#
|
1649
1676
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1650
1677
|
#
|
@@ -1696,8 +1723,8 @@ module Aws::SSMIncidents
|
|
1696
1723
|
# Updates a timeline event. You can update events of type `Custom
|
1697
1724
|
# Event`.
|
1698
1725
|
#
|
1699
|
-
# @option params [
|
1700
|
-
# A token ensuring that the
|
1726
|
+
# @option params [String] :client_token
|
1727
|
+
# A token ensuring that the operation is called only once with the
|
1701
1728
|
# specified details.
|
1702
1729
|
#
|
1703
1730
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1717,15 +1744,15 @@ module Aws::SSMIncidents
|
|
1717
1744
|
# The type of the event. You can update events of type `Custom Event`.
|
1718
1745
|
#
|
1719
1746
|
# @option params [required, String] :incident_record_arn
|
1720
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
1721
|
-
#
|
1747
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
1748
|
+
# timeline event.
|
1722
1749
|
#
|
1723
1750
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1724
1751
|
#
|
1725
1752
|
# @example Request syntax with placeholder values
|
1726
1753
|
#
|
1727
1754
|
# resp = client.update_timeline_event({
|
1728
|
-
# client_token: "ClientToken",
|
1755
|
+
# client_token: "ClientToken",
|
1729
1756
|
# event_data: "EventData",
|
1730
1757
|
# event_id: "UUID", # required
|
1731
1758
|
# event_time: Time.now,
|
@@ -1755,7 +1782,7 @@ module Aws::SSMIncidents
|
|
1755
1782
|
params: params,
|
1756
1783
|
config: config)
|
1757
1784
|
context[:gem_name] = 'aws-sdk-ssmincidents'
|
1758
|
-
context[:gem_version] = '1.
|
1785
|
+
context[:gem_version] = '1.6.0'
|
1759
1786
|
Seahorse::Client::Request.new(handlers, context)
|
1760
1787
|
end
|
1761
1788
|
|
@@ -229,6 +229,7 @@ module Aws::SSMIncidents
|
|
229
229
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, required: true, location_name: "message"))
|
230
230
|
ConflictException.add_member(:resource_identifier, Shapes::ShapeRef.new(shape: String, location_name: "resourceIdentifier"))
|
231
231
|
ConflictException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "resourceType"))
|
232
|
+
ConflictException.add_member(:retry_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "retryAfter"))
|
232
233
|
ConflictException.struct_class = Types::ConflictException
|
233
234
|
|
234
235
|
CreateReplicationSetInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
@@ -251,7 +252,7 @@ module Aws::SSMIncidents
|
|
251
252
|
CreateResponsePlanOutput.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "arn"))
|
252
253
|
CreateResponsePlanOutput.struct_class = Types::CreateResponsePlanOutput
|
253
254
|
|
254
|
-
CreateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken,
|
255
|
+
CreateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
255
256
|
CreateTimelineEventInput.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, required: true, location_name: "eventData"))
|
256
257
|
CreateTimelineEventInput.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
|
257
258
|
CreateTimelineEventInput.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
|
@@ -506,6 +507,7 @@ module Aws::SSMIncidents
|
|
506
507
|
RelatedItemsUpdate.add_member_subclass(:unknown, Types::RelatedItemsUpdate::Unknown)
|
507
508
|
RelatedItemsUpdate.struct_class = Types::RelatedItemsUpdate
|
508
509
|
|
510
|
+
ReplicationSet.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "arn"))
|
509
511
|
ReplicationSet.add_member(:created_by, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "createdBy"))
|
510
512
|
ReplicationSet.add_member(:created_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdTime"))
|
511
513
|
ReplicationSet.add_member(:deletion_protected, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "deletionProtected"))
|
@@ -662,7 +664,7 @@ module Aws::SSMIncidents
|
|
662
664
|
|
663
665
|
UpdateResponsePlanOutput.struct_class = Types::UpdateResponsePlanOutput
|
664
666
|
|
665
|
-
UpdateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken,
|
667
|
+
UpdateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
666
668
|
UpdateTimelineEventInput.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, location_name: "eventData"))
|
667
669
|
UpdateTimelineEventInput.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
|
668
670
|
UpdateTimelineEventInput.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "eventTime"))
|
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::SSMIncidents
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# You don't have sufficient access to perform this
|
13
|
+
# You don't have sufficient access to perform this operation.
|
14
14
|
#
|
15
15
|
# @!attribute [rw] message
|
16
16
|
# @return [String]
|
@@ -48,7 +48,8 @@ module Aws::SSMIncidents
|
|
48
48
|
class Unknown < Action; end
|
49
49
|
end
|
50
50
|
|
51
|
-
# Defines the Region and KMS key to add to the
|
51
|
+
# Defines the Amazon Web Services Region and KMS key to add to the
|
52
|
+
# replication set.
|
52
53
|
#
|
53
54
|
# @note When making an API call, you may pass AddRegionAction
|
54
55
|
# data as a hash:
|
@@ -59,7 +60,7 @@ module Aws::SSMIncidents
|
|
59
60
|
# }
|
60
61
|
#
|
61
62
|
# @!attribute [rw] region_name
|
62
|
-
# The Region name to add to the replication set.
|
63
|
+
# The Amazon Web Services Region name to add to the replication set.
|
63
64
|
# @return [String]
|
64
65
|
#
|
65
66
|
# @!attribute [rw] sse_kms_key_id
|
@@ -124,17 +125,16 @@ module Aws::SSMIncidents
|
|
124
125
|
class Unknown < AutomationExecution; end
|
125
126
|
end
|
126
127
|
|
127
|
-
# The
|
128
|
-
# incident.
|
128
|
+
# The Chatbot chat channel used for collaboration during an incident.
|
129
129
|
#
|
130
130
|
# @note ChatChannel is a union - when making an API calls you must set exactly one of the members.
|
131
131
|
#
|
132
132
|
# @note ChatChannel is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ChatChannel corresponding to the set member.
|
133
133
|
#
|
134
134
|
# @!attribute [rw] chatbot_sns
|
135
|
-
# The SNS targets that
|
136
|
-
# updates to an incident. You can also make updates to the incident
|
137
|
-
# through the chat channel by using the SNS topics.
|
135
|
+
# The Amazon SNS targets that Chatbot uses to notify the chat channel
|
136
|
+
# of updates to an incident. You can also make updates to the incident
|
137
|
+
# through the chat channel by using the Amazon SNS topics.
|
138
138
|
# @return [Array<String>]
|
139
139
|
#
|
140
140
|
# @!attribute [rw] empty
|
@@ -207,12 +207,18 @@ module Aws::SSMIncidents
|
|
207
207
|
# The resource type
|
208
208
|
# @return [String]
|
209
209
|
#
|
210
|
+
# @!attribute [rw] retry_after
|
211
|
+
# If present in the output, the operation can be retried after this
|
212
|
+
# time
|
213
|
+
# @return [Time]
|
214
|
+
#
|
210
215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ConflictException AWS API Documentation
|
211
216
|
#
|
212
217
|
class ConflictException < Struct.new(
|
213
218
|
:message,
|
214
219
|
:resource_identifier,
|
215
|
-
:resource_type
|
220
|
+
:resource_type,
|
221
|
+
:retry_after)
|
216
222
|
SENSITIVE = []
|
217
223
|
include Aws::Structure
|
218
224
|
end
|
@@ -230,7 +236,7 @@ module Aws::SSMIncidents
|
|
230
236
|
# }
|
231
237
|
#
|
232
238
|
# @!attribute [rw] client_token
|
233
|
-
# A token ensuring that the
|
239
|
+
# A token ensuring that the operation is called only once with the
|
234
240
|
# specified details.
|
235
241
|
#
|
236
242
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -311,12 +317,11 @@ module Aws::SSMIncidents
|
|
311
317
|
# @return [Array<Types::Action>]
|
312
318
|
#
|
313
319
|
# @!attribute [rw] chat_channel
|
314
|
-
# The
|
315
|
-
# incident.
|
320
|
+
# The Chatbot chat channel used for collaboration during an incident.
|
316
321
|
# @return [Types::ChatChannel]
|
317
322
|
#
|
318
323
|
# @!attribute [rw] client_token
|
319
|
-
# A token ensuring that the
|
324
|
+
# A token ensuring that the operation is called only once with the
|
320
325
|
# specified details.
|
321
326
|
#
|
322
327
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -376,7 +381,7 @@ module Aws::SSMIncidents
|
|
376
381
|
# data as a hash:
|
377
382
|
#
|
378
383
|
# {
|
379
|
-
# client_token: "ClientToken",
|
384
|
+
# client_token: "ClientToken",
|
380
385
|
# event_data: "EventData", # required
|
381
386
|
# event_time: Time.now, # required
|
382
387
|
# event_type: "TimelineEventType", # required
|
@@ -392,7 +397,8 @@ module Aws::SSMIncidents
|
|
392
397
|
# @return [String]
|
393
398
|
#
|
394
399
|
# @!attribute [rw] event_data
|
395
|
-
# A short description of the event.
|
400
|
+
# A short description of the event as a valid JSON string. There is no
|
401
|
+
# other schema imposed.
|
396
402
|
# @return [String]
|
397
403
|
#
|
398
404
|
# @!attribute [rw] event_time
|
@@ -405,8 +411,8 @@ module Aws::SSMIncidents
|
|
405
411
|
# @return [String]
|
406
412
|
#
|
407
413
|
# @!attribute [rw] incident_record_arn
|
408
|
-
# The Amazon Resource Name (ARN) of the incident record
|
409
|
-
#
|
414
|
+
# The Amazon Resource Name (ARN) of the incident record to which the
|
415
|
+
# event will be added.
|
410
416
|
# @return [String]
|
411
417
|
#
|
412
418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateTimelineEventInput AWS API Documentation
|
@@ -462,8 +468,8 @@ module Aws::SSMIncidents
|
|
462
468
|
#
|
463
469
|
class DeleteIncidentRecordOutput < Aws::EmptyStructure; end
|
464
470
|
|
465
|
-
# Defines the information about the Region you're
|
466
|
-
# replication set.
|
471
|
+
# Defines the information about the Amazon Web Services Region you're
|
472
|
+
# deleting from your replication set.
|
467
473
|
#
|
468
474
|
# @note When making an API call, you may pass DeleteRegionAction
|
469
475
|
# data as a hash:
|
@@ -473,7 +479,8 @@ module Aws::SSMIncidents
|
|
473
479
|
# }
|
474
480
|
#
|
475
481
|
# @!attribute [rw] region_name
|
476
|
-
# The name of the Region you're deleting from the
|
482
|
+
# The name of the Amazon Web Services Region you're deleting from the
|
483
|
+
# replication set.
|
477
484
|
# @return [String]
|
478
485
|
#
|
479
486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteRegionAction AWS API Documentation
|
@@ -575,8 +582,8 @@ module Aws::SSMIncidents
|
|
575
582
|
# @return [String]
|
576
583
|
#
|
577
584
|
# @!attribute [rw] incident_record_arn
|
578
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
579
|
-
#
|
585
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
586
|
+
# timeline event.
|
580
587
|
# @return [String]
|
581
588
|
#
|
582
589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteTimelineEventInput AWS API Documentation
|
@@ -691,7 +698,7 @@ module Aws::SSMIncidents
|
|
691
698
|
end
|
692
699
|
|
693
700
|
# @!attribute [rw] incident_record
|
694
|
-
# Details structure of the incident record.
|
701
|
+
# Details the structure of the incident record.
|
695
702
|
# @return [Types::IncidentRecord]
|
696
703
|
#
|
697
704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetIncidentRecordOutput AWS API Documentation
|
@@ -813,8 +820,7 @@ module Aws::SSMIncidents
|
|
813
820
|
# @return [String]
|
814
821
|
#
|
815
822
|
# @!attribute [rw] chat_channel
|
816
|
-
# The
|
817
|
-
# incident.
|
823
|
+
# The Chatbot chat channel used for collaboration during an incident.
|
818
824
|
# @return [Types::ChatChannel]
|
819
825
|
#
|
820
826
|
# @!attribute [rw] display_name
|
@@ -831,7 +837,8 @@ module Aws::SSMIncidents
|
|
831
837
|
# @return [Types::IncidentTemplate]
|
832
838
|
#
|
833
839
|
# @!attribute [rw] name
|
834
|
-
# The short format name of the response plan.
|
840
|
+
# The short format name of the response plan. The name can't contain
|
841
|
+
# spaces.
|
835
842
|
# @return [String]
|
836
843
|
#
|
837
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetResponsePlanOutput AWS API Documentation
|
@@ -857,13 +864,13 @@ module Aws::SSMIncidents
|
|
857
864
|
# }
|
858
865
|
#
|
859
866
|
# @!attribute [rw] event_id
|
860
|
-
# The ID of the event. You can get an event's ID when you create it
|
867
|
+
# The ID of the event. You can get an event's ID when you create it,
|
861
868
|
# or by using `ListTimelineEvents`.
|
862
869
|
# @return [String]
|
863
870
|
#
|
864
871
|
# @!attribute [rw] incident_record_arn
|
865
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
866
|
-
# event
|
872
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
873
|
+
# timeline event.
|
867
874
|
# @return [String]
|
868
875
|
#
|
869
876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetTimelineEventInput AWS API Documentation
|
@@ -908,7 +915,7 @@ module Aws::SSMIncidents
|
|
908
915
|
#
|
909
916
|
# @!attribute [rw] dedupe_string
|
910
917
|
# The string Incident Manager uses to prevent duplicate incidents from
|
911
|
-
# being created by the same incident.
|
918
|
+
# being created by the same incident in the same account.
|
912
919
|
# @return [String]
|
913
920
|
#
|
914
921
|
# @!attribute [rw] impact
|
@@ -928,8 +935,8 @@ module Aws::SSMIncidents
|
|
928
935
|
# @return [Time]
|
929
936
|
#
|
930
937
|
# @!attribute [rw] notification_targets
|
931
|
-
# The SNS targets that
|
932
|
-
#
|
938
|
+
# The Amazon SNS targets that are notified when updates are made to an
|
939
|
+
# incident.
|
933
940
|
# @return [Array<Types::NotificationTargetItem>]
|
934
941
|
#
|
935
942
|
# @!attribute [rw] resolved_time
|
@@ -943,7 +950,7 @@ module Aws::SSMIncidents
|
|
943
950
|
#
|
944
951
|
# @!attribute [rw] summary
|
945
952
|
# The summary of the incident. The summary is a brief synopsis of what
|
946
|
-
# occurred, what
|
953
|
+
# occurred, what's currently happening, and context of the incident.
|
947
954
|
# @return [String]
|
948
955
|
#
|
949
956
|
# @!attribute [rw] title
|
@@ -971,7 +978,8 @@ module Aws::SSMIncidents
|
|
971
978
|
include Aws::Structure
|
972
979
|
end
|
973
980
|
|
974
|
-
# Details about
|
981
|
+
# Details about what created the incident record and when it was
|
982
|
+
# created.
|
975
983
|
#
|
976
984
|
# @!attribute [rw] created_by
|
977
985
|
# The principal that started the incident.
|
@@ -987,8 +995,8 @@ module Aws::SSMIncidents
|
|
987
995
|
#
|
988
996
|
# @!attribute [rw] source
|
989
997
|
# The service that started the incident. This can be manually created
|
990
|
-
# from Incident Manager, automatically created using an
|
991
|
-
# alarm, or Amazon EventBridge event.
|
998
|
+
# from Incident Manager, automatically created using an Amazon
|
999
|
+
# CloudWatch alarm, or Amazon EventBridge event.
|
992
1000
|
# @return [String]
|
993
1001
|
#
|
994
1002
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/IncidentRecordSource AWS API Documentation
|
@@ -1075,9 +1083,8 @@ module Aws::SSMIncidents
|
|
1075
1083
|
# @return [Integer]
|
1076
1084
|
#
|
1077
1085
|
# @!attribute [rw] notification_targets
|
1078
|
-
# The SNS targets that
|
1079
|
-
#
|
1080
|
-
# through the chat channel using the SNS topics.
|
1086
|
+
# The Amazon SNS targets that are notified when updates are made to an
|
1087
|
+
# incident.
|
1081
1088
|
# @return [Array<Types::NotificationTargetItem>]
|
1082
1089
|
#
|
1083
1090
|
# @!attribute [rw] summary
|
@@ -1171,12 +1178,12 @@ module Aws::SSMIncidents
|
|
1171
1178
|
# @return [String]
|
1172
1179
|
#
|
1173
1180
|
# @!attribute [rw] metric_definition
|
1174
|
-
# The metric definition, if the related item is a metric in
|
1181
|
+
# The metric definition, if the related item is a metric in Amazon
|
1175
1182
|
# CloudWatch.
|
1176
1183
|
# @return [String]
|
1177
1184
|
#
|
1178
1185
|
# @!attribute [rw] url
|
1179
|
-
# The URL, if the related item is a non-
|
1186
|
+
# The URL, if the related item is a non-Amazon Web Services resource.
|
1180
1187
|
# @return [String]
|
1181
1188
|
#
|
1182
1189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ItemValue AWS API Documentation
|
@@ -1218,8 +1225,8 @@ module Aws::SSMIncidents
|
|
1218
1225
|
# }
|
1219
1226
|
#
|
1220
1227
|
# @!attribute [rw] filters
|
1221
|
-
#
|
1222
|
-
# can filter on the following keys:
|
1228
|
+
# Filters the list of incident records through which you are
|
1229
|
+
# searching. You can filter on the following keys:
|
1223
1230
|
#
|
1224
1231
|
# * `creationTime`
|
1225
1232
|
#
|
@@ -1228,6 +1235,17 @@ module Aws::SSMIncidents
|
|
1228
1235
|
# * `status`
|
1229
1236
|
#
|
1230
1237
|
# * `createdBy`
|
1238
|
+
#
|
1239
|
+
# Note the following when deciding how to use Filters:
|
1240
|
+
#
|
1241
|
+
# * If you don't specify a Filter, the response includes all incident
|
1242
|
+
# records.
|
1243
|
+
#
|
1244
|
+
# * If you specify more than one filter in a single request, the
|
1245
|
+
# response returns incident records that match all filters.
|
1246
|
+
#
|
1247
|
+
# * If you specify a filter with more than one value, the response
|
1248
|
+
# returns incident records that match any of the values provided.
|
1231
1249
|
# @return [Array<Types::Filter>]
|
1232
1250
|
#
|
1233
1251
|
# @!attribute [rw] max_results
|
@@ -1275,8 +1293,8 @@ module Aws::SSMIncidents
|
|
1275
1293
|
# }
|
1276
1294
|
#
|
1277
1295
|
# @!attribute [rw] incident_record_arn
|
1278
|
-
# The Amazon Resource Name (ARN) of the incident record
|
1279
|
-
#
|
1296
|
+
# The Amazon Resource Name (ARN) of the incident record containing the
|
1297
|
+
# listed related items.
|
1280
1298
|
# @return [String]
|
1281
1299
|
#
|
1282
1300
|
# @!attribute [rw] max_results
|
@@ -1460,11 +1478,22 @@ module Aws::SSMIncidents
|
|
1460
1478
|
# * `eventTime`
|
1461
1479
|
#
|
1462
1480
|
# * `eventType`
|
1481
|
+
#
|
1482
|
+
# Note the following when deciding how to use Filters:
|
1483
|
+
#
|
1484
|
+
# * If you don't specify a Filter, the response includes all timeline
|
1485
|
+
# events.
|
1486
|
+
#
|
1487
|
+
# * If you specify more than one filter in a single request, the
|
1488
|
+
# response returns timeline events that match all filters.
|
1489
|
+
#
|
1490
|
+
# * If you specify a filter with more than one value, the response
|
1491
|
+
# returns timeline events that match any of the values provided.
|
1463
1492
|
# @return [Array<Types::Filter>]
|
1464
1493
|
#
|
1465
1494
|
# @!attribute [rw] incident_record_arn
|
1466
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
1467
|
-
#
|
1495
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
1496
|
+
# timeline event.
|
1468
1497
|
# @return [String]
|
1469
1498
|
#
|
1470
1499
|
# @!attribute [rw] max_results
|
@@ -1514,8 +1543,8 @@ module Aws::SSMIncidents
|
|
1514
1543
|
include Aws::Structure
|
1515
1544
|
end
|
1516
1545
|
|
1517
|
-
# The SNS
|
1518
|
-
#
|
1546
|
+
# The SNS targets that are notified when updates are made to an
|
1547
|
+
# incident.
|
1519
1548
|
#
|
1520
1549
|
# @note NotificationTargetItem is a union - when making an API calls you must set exactly one of the members.
|
1521
1550
|
#
|
@@ -1576,22 +1605,26 @@ module Aws::SSMIncidents
|
|
1576
1605
|
include Aws::Structure
|
1577
1606
|
end
|
1578
1607
|
|
1579
|
-
# Information about a Region in your replication
|
1608
|
+
# Information about a Amazon Web Services Region in your replication
|
1609
|
+
# set.
|
1580
1610
|
#
|
1581
1611
|
# @!attribute [rw] sse_kms_key_id
|
1582
|
-
# The ID of the KMS key used to encrypt the data in this
|
1612
|
+
# The ID of the KMS key used to encrypt the data in this Amazon Web
|
1613
|
+
# Services Region.
|
1583
1614
|
# @return [String]
|
1584
1615
|
#
|
1585
1616
|
# @!attribute [rw] status
|
1586
|
-
# The status of the Region in the replication set.
|
1617
|
+
# The status of the Amazon Web Services Region in the replication set.
|
1587
1618
|
# @return [String]
|
1588
1619
|
#
|
1589
1620
|
# @!attribute [rw] status_message
|
1590
|
-
# Information displayed about the status of the
|
1621
|
+
# Information displayed about the status of the Amazon Web Services
|
1622
|
+
# Region.
|
1591
1623
|
# @return [String]
|
1592
1624
|
#
|
1593
1625
|
# @!attribute [rw] status_update_date_time
|
1594
|
-
# The most recent date and time that
|
1626
|
+
# The most recent date and time that Incident Manager updated the
|
1627
|
+
# Amazon Web Services Region's status.
|
1595
1628
|
# @return [Time]
|
1596
1629
|
#
|
1597
1630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RegionInfo AWS API Documentation
|
@@ -1605,8 +1638,8 @@ module Aws::SSMIncidents
|
|
1605
1638
|
include Aws::Structure
|
1606
1639
|
end
|
1607
1640
|
|
1608
|
-
# The mapping between a Region and the key that's
|
1609
|
-
# data.
|
1641
|
+
# The mapping between a Amazon Web Services Region and the key that's
|
1642
|
+
# used to encrypt the data.
|
1610
1643
|
#
|
1611
1644
|
# @note When making an API call, you may pass RegionMapInputValue
|
1612
1645
|
# data as a hash:
|
@@ -1688,8 +1721,12 @@ module Aws::SSMIncidents
|
|
1688
1721
|
class Unknown < RelatedItemsUpdate; end
|
1689
1722
|
end
|
1690
1723
|
|
1691
|
-
# The set of
|
1692
|
-
# to and the KMS key used to encrypt the data.
|
1724
|
+
# The set of Amazon Web Services Region that your Incident Manager data
|
1725
|
+
# will be replicated to and the KMS key used to encrypt the data.
|
1726
|
+
#
|
1727
|
+
# @!attribute [rw] arn
|
1728
|
+
# The Amazon Resource Name (ARN) of the replication set.
|
1729
|
+
# @return [String]
|
1693
1730
|
#
|
1694
1731
|
# @!attribute [rw] created_by
|
1695
1732
|
# Details about who created the replication set.
|
@@ -1702,7 +1739,7 @@ module Aws::SSMIncidents
|
|
1702
1739
|
# @!attribute [rw] deletion_protected
|
1703
1740
|
# Determines if the replication set deletion protection is enabled or
|
1704
1741
|
# not. If deletion protection is enabled, you can't delete the last
|
1705
|
-
# Region in the replication set.
|
1742
|
+
# Amazon Web Services Region in the replication set.
|
1706
1743
|
# @return [Boolean]
|
1707
1744
|
#
|
1708
1745
|
# @!attribute [rw] last_modified_by
|
@@ -1714,8 +1751,8 @@ module Aws::SSMIncidents
|
|
1714
1751
|
# @return [Time]
|
1715
1752
|
#
|
1716
1753
|
# @!attribute [rw] region_map
|
1717
|
-
# The map between each Region in your replication
|
1718
|
-
# that
|
1754
|
+
# The map between each Amazon Web Services Region in your replication
|
1755
|
+
# set and the KMS key that's used to encrypt the data in that Region.
|
1719
1756
|
# @return [Hash<String,Types::RegionInfo>]
|
1720
1757
|
#
|
1721
1758
|
# @!attribute [rw] status
|
@@ -1726,6 +1763,7 @@ module Aws::SSMIncidents
|
|
1726
1763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ReplicationSet AWS API Documentation
|
1727
1764
|
#
|
1728
1765
|
class ReplicationSet < Struct.new(
|
1766
|
+
:arn,
|
1729
1767
|
:created_by,
|
1730
1768
|
:created_time,
|
1731
1769
|
:deletion_protected,
|
@@ -1737,7 +1775,7 @@ module Aws::SSMIncidents
|
|
1737
1775
|
include Aws::Structure
|
1738
1776
|
end
|
1739
1777
|
|
1740
|
-
# Request references a resource which
|
1778
|
+
# Request references a resource which doesn't exist.
|
1741
1779
|
#
|
1742
1780
|
# @!attribute [rw] message
|
1743
1781
|
# @return [String]
|
@@ -1772,7 +1810,8 @@ module Aws::SSMIncidents
|
|
1772
1810
|
# @return [String]
|
1773
1811
|
#
|
1774
1812
|
# @!attribute [rw] ram_resource_share_region
|
1775
|
-
# The Region that policy allows resources to be
|
1813
|
+
# The Amazon Web Services Region that policy allows resources to be
|
1814
|
+
# used in.
|
1776
1815
|
# @return [String]
|
1777
1816
|
#
|
1778
1817
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ResourcePolicy AWS API Documentation
|
@@ -1924,7 +1963,7 @@ module Aws::SSMIncidents
|
|
1924
1963
|
# }
|
1925
1964
|
#
|
1926
1965
|
# @!attribute [rw] client_token
|
1927
|
-
# A token ensuring that the
|
1966
|
+
# A token ensuring that the operation is called only once with the
|
1928
1967
|
# specified details.
|
1929
1968
|
#
|
1930
1969
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1956,13 +1995,13 @@ module Aws::SSMIncidents
|
|
1956
1995
|
# @!attribute [rw] related_items
|
1957
1996
|
# Add related items to the incident for other responders to use.
|
1958
1997
|
# Related items are AWS resources, external links, or files uploaded
|
1959
|
-
# to an S3 bucket.
|
1998
|
+
# to an Amazon S3 bucket.
|
1960
1999
|
# @return [Array<Types::RelatedItem>]
|
1961
2000
|
#
|
1962
2001
|
# @!attribute [rw] response_plan_arn
|
1963
2002
|
# The Amazon Resource Name (ARN) of the response plan that pre-defines
|
1964
|
-
# summary, chat channels, SNS topics, runbooks, title, and
|
1965
|
-
# the incident.
|
2003
|
+
# summary, chat channels, Amazon SNS topics, runbooks, title, and
|
2004
|
+
# impact of the incident.
|
1966
2005
|
# @return [String]
|
1967
2006
|
#
|
1968
2007
|
# @!attribute [rw] title
|
@@ -2109,16 +2148,16 @@ module Aws::SSMIncidents
|
|
2109
2148
|
# }
|
2110
2149
|
#
|
2111
2150
|
# @!attribute [rw] raw_data
|
2112
|
-
# Raw data passed from either EventBridge, CloudWatch,
|
2113
|
-
# Manager when an incident is created.
|
2151
|
+
# Raw data passed from either Amazon EventBridge, Amazon CloudWatch,
|
2152
|
+
# or Incident Manager when an incident is created.
|
2114
2153
|
# @return [String]
|
2115
2154
|
#
|
2116
2155
|
# @!attribute [rw] source
|
2117
2156
|
# Identifies the service that sourced the event. All events sourced
|
2118
|
-
# from within
|
2119
|
-
# have any value here, as long as it
|
2120
|
-
# recommend the use of Java
|
2121
|
-
# strings.
|
2157
|
+
# from within Amazon Web Services begin with "`aws.`"
|
2158
|
+
# Customer-generated events can have any value here, as long as it
|
2159
|
+
# doesn't begin with "`aws.`" We recommend the use of Java
|
2160
|
+
# package-name style reverse domain-name strings.
|
2122
2161
|
# @return [String]
|
2123
2162
|
#
|
2124
2163
|
# @!attribute [rw] timestamp
|
@@ -2126,7 +2165,8 @@ module Aws::SSMIncidents
|
|
2126
2165
|
# @return [Time]
|
2127
2166
|
#
|
2128
2167
|
# @!attribute [rw] trigger_arn
|
2129
|
-
# The ARN of the source that detected the
|
2168
|
+
# The Amazon Resource Name (ARN) of the source that detected the
|
2169
|
+
# incident.
|
2130
2170
|
# @return [String]
|
2131
2171
|
#
|
2132
2172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/TriggerDetails AWS API Documentation
|
@@ -2185,7 +2225,7 @@ module Aws::SSMIncidents
|
|
2185
2225
|
# @return [String]
|
2186
2226
|
#
|
2187
2227
|
# @!attribute [rw] client_token
|
2188
|
-
# A token ensuring that the
|
2228
|
+
# A token ensuring that the operation is called only once with the
|
2189
2229
|
# specified details.
|
2190
2230
|
#
|
2191
2231
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2239,11 +2279,11 @@ module Aws::SSMIncidents
|
|
2239
2279
|
# @return [String]
|
2240
2280
|
#
|
2241
2281
|
# @!attribute [rw] chat_channel
|
2242
|
-
# The
|
2282
|
+
# The Chatbot chat channel where responders can collaborate.
|
2243
2283
|
# @return [Types::ChatChannel]
|
2244
2284
|
#
|
2245
2285
|
# @!attribute [rw] client_token
|
2246
|
-
# A token
|
2286
|
+
# A token that ensures that the operation is called only once with the
|
2247
2287
|
# specified details.
|
2248
2288
|
#
|
2249
2289
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2251,13 +2291,14 @@ module Aws::SSMIncidents
|
|
2251
2291
|
# @return [String]
|
2252
2292
|
#
|
2253
2293
|
# @!attribute [rw] impact
|
2254
|
-
# Defines the impact to customers and applications.
|
2255
|
-
# impact overwrites the impact provided by the response
|
2294
|
+
# Defines the impact of the incident to customers and applications.
|
2295
|
+
# Providing an impact overwrites the impact provided by the response
|
2296
|
+
# plan.
|
2256
2297
|
#
|
2257
2298
|
# **Possible impacts:**
|
2258
2299
|
#
|
2259
|
-
# * `1` - Critical impact,
|
2260
|
-
#
|
2300
|
+
# * `1` - Critical impact, full application failure that impacts many
|
2301
|
+
# to all customers.
|
2261
2302
|
#
|
2262
2303
|
# * `2` - High impact, partial application failure with impact to many
|
2263
2304
|
# customers.
|
@@ -2265,19 +2306,17 @@ module Aws::SSMIncidents
|
|
2265
2306
|
# * `3` - Medium impact, the application is providing reduced service
|
2266
2307
|
# to customers.
|
2267
2308
|
#
|
2268
|
-
# * `4` - Low impact, customer
|
2269
|
-
# yet.
|
2309
|
+
# * `4` - Low impact, customer aren't impacted by the problem yet.
|
2270
2310
|
#
|
2271
2311
|
# * `5` - No impact, customers aren't currently impacted but urgent
|
2272
2312
|
# action is needed to avoid impact.
|
2273
2313
|
# @return [Integer]
|
2274
2314
|
#
|
2275
2315
|
# @!attribute [rw] notification_targets
|
2276
|
-
# The SNS targets that
|
2277
|
-
#
|
2278
|
-
# through the chat channel using the SNS topics.
|
2316
|
+
# The Amazon SNS targets that are notified when updates are made to an
|
2317
|
+
# incident.
|
2279
2318
|
#
|
2280
|
-
# Using multiple SNS topics creates redundancy in the
|
2319
|
+
# Using multiple SNS topics creates redundancy in the event that a
|
2281
2320
|
# Region is down during the incident.
|
2282
2321
|
# @return [Array<Types::NotificationTargetItem>]
|
2283
2322
|
#
|
@@ -2286,11 +2325,11 @@ module Aws::SSMIncidents
|
|
2286
2325
|
# @return [String]
|
2287
2326
|
#
|
2288
2327
|
# @!attribute [rw] summary
|
2289
|
-
#
|
2328
|
+
# A longer description of what occurred during the incident.
|
2290
2329
|
# @return [String]
|
2291
2330
|
#
|
2292
2331
|
# @!attribute [rw] title
|
2293
|
-
#
|
2332
|
+
# A brief description of the incident.
|
2294
2333
|
# @return [String]
|
2295
2334
|
#
|
2296
2335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateIncidentRecordInput AWS API Documentation
|
@@ -2342,7 +2381,7 @@ module Aws::SSMIncidents
|
|
2342
2381
|
# }
|
2343
2382
|
#
|
2344
2383
|
# @!attribute [rw] client_token
|
2345
|
-
# A token ensuring that the
|
2384
|
+
# A token ensuring that the operation is called only once with the
|
2346
2385
|
# specified details.
|
2347
2386
|
#
|
2348
2387
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2350,8 +2389,8 @@ module Aws::SSMIncidents
|
|
2350
2389
|
# @return [String]
|
2351
2390
|
#
|
2352
2391
|
# @!attribute [rw] incident_record_arn
|
2353
|
-
# The Amazon Resource Name (ARN) of the incident record
|
2354
|
-
#
|
2392
|
+
# The Amazon Resource Name (ARN) of the incident record containing the
|
2393
|
+
# related items you are updating.
|
2355
2394
|
# @return [String]
|
2356
2395
|
#
|
2357
2396
|
# @!attribute [rw] related_items_update
|
@@ -2377,12 +2416,13 @@ module Aws::SSMIncidents
|
|
2377
2416
|
# @note UpdateReplicationSetAction is a union - when making an API calls you must set exactly one of the members.
|
2378
2417
|
#
|
2379
2418
|
# @!attribute [rw] add_region_action
|
2380
|
-
# Details about the Region that you're adding to
|
2419
|
+
# Details about the Amazon Web Services Region that you're adding to
|
2420
|
+
# the replication set.
|
2381
2421
|
# @return [Types::AddRegionAction]
|
2382
2422
|
#
|
2383
2423
|
# @!attribute [rw] delete_region_action
|
2384
|
-
# Details about the Region that you're deleting
|
2385
|
-
# set.
|
2424
|
+
# Details about the Amazon Web Services Region that you're deleting
|
2425
|
+
# to the replication set.
|
2386
2426
|
# @return [Types::DeleteRegionAction]
|
2387
2427
|
#
|
2388
2428
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateReplicationSetAction AWS API Documentation
|
@@ -2429,7 +2469,7 @@ module Aws::SSMIncidents
|
|
2429
2469
|
# @return [String]
|
2430
2470
|
#
|
2431
2471
|
# @!attribute [rw] client_token
|
2432
|
-
# A token ensuring that the
|
2472
|
+
# A token ensuring that the operation is called only once with the
|
2433
2473
|
# specified details.
|
2434
2474
|
#
|
2435
2475
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2497,12 +2537,14 @@ module Aws::SSMIncidents
|
|
2497
2537
|
# @return [String]
|
2498
2538
|
#
|
2499
2539
|
# @!attribute [rw] chat_channel
|
2500
|
-
# The
|
2501
|
-
#
|
2540
|
+
# The Chatbot chat channel used for collaboration during an incident.
|
2541
|
+
#
|
2542
|
+
# Use the empty structure to remove the chat channel from the response
|
2543
|
+
# plan.
|
2502
2544
|
# @return [Types::ChatChannel]
|
2503
2545
|
#
|
2504
2546
|
# @!attribute [rw] client_token
|
2505
|
-
# A token ensuring that the
|
2547
|
+
# A token ensuring that the operation is called only once with the
|
2506
2548
|
# specified details.
|
2507
2549
|
#
|
2508
2550
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2510,7 +2552,8 @@ module Aws::SSMIncidents
|
|
2510
2552
|
# @return [String]
|
2511
2553
|
#
|
2512
2554
|
# @!attribute [rw] display_name
|
2513
|
-
# The long format name of the response plan.
|
2555
|
+
# The long format name of the response plan. The display name can't
|
2556
|
+
# contain spaces.
|
2514
2557
|
# @return [String]
|
2515
2558
|
#
|
2516
2559
|
# @!attribute [rw] engagements
|
@@ -2519,7 +2562,8 @@ module Aws::SSMIncidents
|
|
2519
2562
|
# @return [Array<String>]
|
2520
2563
|
#
|
2521
2564
|
# @!attribute [rw] incident_template_dedupe_string
|
2522
|
-
#
|
2565
|
+
# The string Incident Manager uses to prevent duplicate incidents from
|
2566
|
+
# being created by the same incident in the same account.
|
2523
2567
|
# @return [String]
|
2524
2568
|
#
|
2525
2569
|
# @!attribute [rw] incident_template_impact
|
@@ -2540,8 +2584,8 @@ module Aws::SSMIncidents
|
|
2540
2584
|
# @return [Integer]
|
2541
2585
|
#
|
2542
2586
|
# @!attribute [rw] incident_template_notification_targets
|
2543
|
-
# The SNS targets that
|
2544
|
-
#
|
2587
|
+
# The Amazon SNS targets that are notified when updates are made to an
|
2588
|
+
# incident.
|
2545
2589
|
# @return [Array<Types::NotificationTargetItem>]
|
2546
2590
|
#
|
2547
2591
|
# @!attribute [rw] incident_template_summary
|
@@ -2550,7 +2594,8 @@ module Aws::SSMIncidents
|
|
2550
2594
|
# @return [String]
|
2551
2595
|
#
|
2552
2596
|
# @!attribute [rw] incident_template_title
|
2553
|
-
# The short format name of the incident.
|
2597
|
+
# The short format name of the incident. The title can't contain
|
2598
|
+
# spaces.
|
2554
2599
|
# @return [String]
|
2555
2600
|
#
|
2556
2601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateResponsePlanInput AWS API Documentation
|
@@ -2579,7 +2624,7 @@ module Aws::SSMIncidents
|
|
2579
2624
|
# data as a hash:
|
2580
2625
|
#
|
2581
2626
|
# {
|
2582
|
-
# client_token: "ClientToken",
|
2627
|
+
# client_token: "ClientToken",
|
2583
2628
|
# event_data: "EventData",
|
2584
2629
|
# event_id: "UUID", # required
|
2585
2630
|
# event_time: Time.now,
|
@@ -2588,7 +2633,7 @@ module Aws::SSMIncidents
|
|
2588
2633
|
# }
|
2589
2634
|
#
|
2590
2635
|
# @!attribute [rw] client_token
|
2591
|
-
# A token ensuring that the
|
2636
|
+
# A token ensuring that the operation is called only once with the
|
2592
2637
|
# specified details.
|
2593
2638
|
#
|
2594
2639
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2613,8 +2658,8 @@ module Aws::SSMIncidents
|
|
2613
2658
|
# @return [String]
|
2614
2659
|
#
|
2615
2660
|
# @!attribute [rw] incident_record_arn
|
2616
|
-
# The Amazon Resource Name (ARN) of the incident that the
|
2617
|
-
# event
|
2661
|
+
# The Amazon Resource Name (ARN) of the incident that includes the
|
2662
|
+
# timeline event.
|
2618
2663
|
# @return [String]
|
2619
2664
|
#
|
2620
2665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateTimelineEventInput AWS API Documentation
|
@@ -2634,8 +2679,8 @@ module Aws::SSMIncidents
|
|
2634
2679
|
#
|
2635
2680
|
class UpdateTimelineEventOutput < Aws::EmptyStructure; end
|
2636
2681
|
|
2637
|
-
# The input fails to satisfy the constraints specified by an
|
2638
|
-
# service.
|
2682
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
2683
|
+
# Services service.
|
2639
2684
|
#
|
2640
2685
|
# @!attribute [rw] message
|
2641
2686
|
# @return [String]
|
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.6.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: 2021-
|
11
|
+
date: 2021-10-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.121.2
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.121.2
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
77
77
|
requirements:
|
78
78
|
- - ">="
|
79
79
|
- !ruby/object:Gem::Version
|
80
|
-
version: '
|
80
|
+
version: '2.3'
|
81
81
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
82
82
|
requirements:
|
83
83
|
- - ">="
|