aws-sdk-ssm 1.96.0 → 1.101.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/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +846 -43
- data/lib/aws-sdk-ssm/client_api.rb +432 -3
- data/lib/aws-sdk-ssm/errors.rb +112 -0
- data/lib/aws-sdk-ssm/types.rb +1584 -93
- metadata +2 -2
data/lib/aws-sdk-ssm/errors.rb
CHANGED
@@ -34,6 +34,7 @@ module Aws::SSM
|
|
34
34
|
# * {AssociationExecutionDoesNotExist}
|
35
35
|
# * {AssociationLimitExceeded}
|
36
36
|
# * {AssociationVersionLimitExceeded}
|
37
|
+
# * {AutomationDefinitionNotApprovedException}
|
37
38
|
# * {AutomationDefinitionNotFoundException}
|
38
39
|
# * {AutomationDefinitionVersionNotFoundException}
|
39
40
|
# * {AutomationExecutionLimitExceededException}
|
@@ -110,6 +111,12 @@ module Aws::SSM
|
|
110
111
|
# * {OpsItemInvalidParameterException}
|
111
112
|
# * {OpsItemLimitExceededException}
|
112
113
|
# * {OpsItemNotFoundException}
|
114
|
+
# * {OpsMetadataAlreadyExistsException}
|
115
|
+
# * {OpsMetadataInvalidArgumentException}
|
116
|
+
# * {OpsMetadataKeyLimitExceededException}
|
117
|
+
# * {OpsMetadataLimitExceededException}
|
118
|
+
# * {OpsMetadataNotFoundException}
|
119
|
+
# * {OpsMetadataTooManyUpdatesException}
|
113
120
|
# * {ParameterAlreadyExists}
|
114
121
|
# * {ParameterLimitExceeded}
|
115
122
|
# * {ParameterMaxVersionLimitExceeded}
|
@@ -237,6 +244,21 @@ module Aws::SSM
|
|
237
244
|
end
|
238
245
|
end
|
239
246
|
|
247
|
+
class AutomationDefinitionNotApprovedException < ServiceError
|
248
|
+
|
249
|
+
# @param [Seahorse::Client::RequestContext] context
|
250
|
+
# @param [String] message
|
251
|
+
# @param [Aws::SSM::Types::AutomationDefinitionNotApprovedException] data
|
252
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
253
|
+
super(context, message, data)
|
254
|
+
end
|
255
|
+
|
256
|
+
# @return [String]
|
257
|
+
def message
|
258
|
+
@message || @data[:message]
|
259
|
+
end
|
260
|
+
end
|
261
|
+
|
240
262
|
class AutomationDefinitionNotFoundException < ServiceError
|
241
263
|
|
242
264
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -1372,6 +1394,96 @@ module Aws::SSM
|
|
1372
1394
|
end
|
1373
1395
|
end
|
1374
1396
|
|
1397
|
+
class OpsMetadataAlreadyExistsException < ServiceError
|
1398
|
+
|
1399
|
+
# @param [Seahorse::Client::RequestContext] context
|
1400
|
+
# @param [String] message
|
1401
|
+
# @param [Aws::SSM::Types::OpsMetadataAlreadyExistsException] data
|
1402
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
1403
|
+
super(context, message, data)
|
1404
|
+
end
|
1405
|
+
|
1406
|
+
# @return [String]
|
1407
|
+
def message
|
1408
|
+
@message || @data[:message]
|
1409
|
+
end
|
1410
|
+
end
|
1411
|
+
|
1412
|
+
class OpsMetadataInvalidArgumentException < ServiceError
|
1413
|
+
|
1414
|
+
# @param [Seahorse::Client::RequestContext] context
|
1415
|
+
# @param [String] message
|
1416
|
+
# @param [Aws::SSM::Types::OpsMetadataInvalidArgumentException] data
|
1417
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
1418
|
+
super(context, message, data)
|
1419
|
+
end
|
1420
|
+
|
1421
|
+
# @return [String]
|
1422
|
+
def message
|
1423
|
+
@message || @data[:message]
|
1424
|
+
end
|
1425
|
+
end
|
1426
|
+
|
1427
|
+
class OpsMetadataKeyLimitExceededException < ServiceError
|
1428
|
+
|
1429
|
+
# @param [Seahorse::Client::RequestContext] context
|
1430
|
+
# @param [String] message
|
1431
|
+
# @param [Aws::SSM::Types::OpsMetadataKeyLimitExceededException] data
|
1432
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
1433
|
+
super(context, message, data)
|
1434
|
+
end
|
1435
|
+
|
1436
|
+
# @return [String]
|
1437
|
+
def message
|
1438
|
+
@message || @data[:message]
|
1439
|
+
end
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
class OpsMetadataLimitExceededException < ServiceError
|
1443
|
+
|
1444
|
+
# @param [Seahorse::Client::RequestContext] context
|
1445
|
+
# @param [String] message
|
1446
|
+
# @param [Aws::SSM::Types::OpsMetadataLimitExceededException] data
|
1447
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
1448
|
+
super(context, message, data)
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
# @return [String]
|
1452
|
+
def message
|
1453
|
+
@message || @data[:message]
|
1454
|
+
end
|
1455
|
+
end
|
1456
|
+
|
1457
|
+
class OpsMetadataNotFoundException < ServiceError
|
1458
|
+
|
1459
|
+
# @param [Seahorse::Client::RequestContext] context
|
1460
|
+
# @param [String] message
|
1461
|
+
# @param [Aws::SSM::Types::OpsMetadataNotFoundException] data
|
1462
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
1463
|
+
super(context, message, data)
|
1464
|
+
end
|
1465
|
+
|
1466
|
+
# @return [String]
|
1467
|
+
def message
|
1468
|
+
@message || @data[:message]
|
1469
|
+
end
|
1470
|
+
end
|
1471
|
+
|
1472
|
+
class OpsMetadataTooManyUpdatesException < ServiceError
|
1473
|
+
|
1474
|
+
# @param [Seahorse::Client::RequestContext] context
|
1475
|
+
# @param [String] message
|
1476
|
+
# @param [Aws::SSM::Types::OpsMetadataTooManyUpdatesException] data
|
1477
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
1478
|
+
super(context, message, data)
|
1479
|
+
end
|
1480
|
+
|
1481
|
+
# @return [String]
|
1482
|
+
def message
|
1483
|
+
@message || @data[:message]
|
1484
|
+
end
|
1485
|
+
end
|
1486
|
+
|
1375
1487
|
class ParameterAlreadyExists < ServiceError
|
1376
1488
|
|
1377
1489
|
# @param [Seahorse::Client::RequestContext] context
|
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -384,9 +384,15 @@ module Aws::SSM
|
|
384
384
|
# By default, when you create a new associations, the system runs it
|
385
385
|
# immediately after it is created and then according to the schedule
|
386
386
|
# you specified. Specify this option if you don't want an association
|
387
|
-
# to run immediately after you create it.
|
387
|
+
# to run immediately after you create it. This parameter is not
|
388
|
+
# supported for rate expressions.
|
388
389
|
# @return [Boolean]
|
389
390
|
#
|
391
|
+
# @!attribute [rw] target_locations
|
392
|
+
# The combination of AWS Regions and AWS accounts where you want to
|
393
|
+
# run the association.
|
394
|
+
# @return [Array<Types::TargetLocation>]
|
395
|
+
#
|
390
396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationDescription AWS API Documentation
|
391
397
|
#
|
392
398
|
class AssociationDescription < Struct.new(
|
@@ -411,7 +417,8 @@ module Aws::SSM
|
|
411
417
|
:max_concurrency,
|
412
418
|
:compliance_severity,
|
413
419
|
:sync_compliance,
|
414
|
-
:apply_only_at_cron_interval
|
420
|
+
:apply_only_at_cron_interval,
|
421
|
+
:target_locations)
|
415
422
|
SENSITIVE = []
|
416
423
|
include Aws::Structure
|
417
424
|
end
|
@@ -814,9 +821,15 @@ module Aws::SSM
|
|
814
821
|
# By default, when you create a new associations, the system runs it
|
815
822
|
# immediately after it is created and then according to the schedule
|
816
823
|
# you specified. Specify this option if you don't want an association
|
817
|
-
# to run immediately after you create it.
|
824
|
+
# to run immediately after you create it. This parameter is not
|
825
|
+
# supported for rate expressions.
|
818
826
|
# @return [Boolean]
|
819
827
|
#
|
828
|
+
# @!attribute [rw] target_locations
|
829
|
+
# The combination of AWS Regions and AWS accounts where you wanted to
|
830
|
+
# run the association when this association version was created.
|
831
|
+
# @return [Array<Types::TargetLocation>]
|
832
|
+
#
|
820
833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationVersionInfo AWS API Documentation
|
821
834
|
#
|
822
835
|
class AssociationVersionInfo < Struct.new(
|
@@ -834,7 +847,8 @@ module Aws::SSM
|
|
834
847
|
:max_concurrency,
|
835
848
|
:compliance_severity,
|
836
849
|
:sync_compliance,
|
837
|
-
:apply_only_at_cron_interval
|
850
|
+
:apply_only_at_cron_interval,
|
851
|
+
:target_locations)
|
838
852
|
SENSITIVE = []
|
839
853
|
include Aws::Structure
|
840
854
|
end
|
@@ -965,6 +979,20 @@ module Aws::SSM
|
|
965
979
|
include Aws::Structure
|
966
980
|
end
|
967
981
|
|
982
|
+
# Indicates that the Change Manager change template used in the change
|
983
|
+
# request was rejected or is still in a pending state.
|
984
|
+
#
|
985
|
+
# @!attribute [rw] message
|
986
|
+
# @return [String]
|
987
|
+
#
|
988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationDefinitionNotApprovedException AWS API Documentation
|
989
|
+
#
|
990
|
+
class AutomationDefinitionNotApprovedException < Struct.new(
|
991
|
+
:message)
|
992
|
+
SENSITIVE = []
|
993
|
+
include Aws::Structure
|
994
|
+
end
|
995
|
+
|
968
996
|
# An Automation document with the specified name could not be found.
|
969
997
|
#
|
970
998
|
# @!attribute [rw] message
|
@@ -1107,6 +1135,40 @@ module Aws::SSM
|
|
1107
1135
|
# for a multi-Region and multi-account Automation execution.
|
1108
1136
|
# @return [Types::ProgressCounters]
|
1109
1137
|
#
|
1138
|
+
# @!attribute [rw] automation_subtype
|
1139
|
+
# The subtype of the Automation operation. Currently, the only
|
1140
|
+
# supported value is `ChangeRequest`.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] scheduled_time
|
1144
|
+
# The date and time the Automation operation is scheduled to start.
|
1145
|
+
# @return [Time]
|
1146
|
+
#
|
1147
|
+
# @!attribute [rw] runbooks
|
1148
|
+
# Information about the Automation runbooks (Automation documents)
|
1149
|
+
# that are run as part of a runbook workflow.
|
1150
|
+
#
|
1151
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
1152
|
+
# run until all required approvals for the change request have been
|
1153
|
+
# received.
|
1154
|
+
#
|
1155
|
+
# </note>
|
1156
|
+
# @return [Array<Types::Runbook>]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] ops_item_id
|
1159
|
+
# The ID of an OpsItem that is created to represent a Change Manager
|
1160
|
+
# change request.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] association_id
|
1164
|
+
# The ID of a State Manager association used in the Automation
|
1165
|
+
# operation.
|
1166
|
+
# @return [String]
|
1167
|
+
#
|
1168
|
+
# @!attribute [rw] change_request_name
|
1169
|
+
# The name of the Change Manager change request.
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1110
1172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecution AWS API Documentation
|
1111
1173
|
#
|
1112
1174
|
class AutomationExecution < Struct.new(
|
@@ -1134,7 +1196,13 @@ module Aws::SSM
|
|
1134
1196
|
:max_errors,
|
1135
1197
|
:target,
|
1136
1198
|
:target_locations,
|
1137
|
-
:progress_counters
|
1199
|
+
:progress_counters,
|
1200
|
+
:automation_subtype,
|
1201
|
+
:scheduled_time,
|
1202
|
+
:runbooks,
|
1203
|
+
:ops_item_id,
|
1204
|
+
:association_id,
|
1205
|
+
:change_request_name)
|
1138
1206
|
SENSITIVE = []
|
1139
1207
|
include Aws::Structure
|
1140
1208
|
end
|
@@ -1146,7 +1214,7 @@ module Aws::SSM
|
|
1146
1214
|
# data as a hash:
|
1147
1215
|
#
|
1148
1216
|
# {
|
1149
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey
|
1217
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
|
1150
1218
|
# values: ["AutomationExecutionFilterValue"], # required
|
1151
1219
|
# }
|
1152
1220
|
#
|
@@ -1287,6 +1355,40 @@ module Aws::SSM
|
|
1287
1355
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html
|
1288
1356
|
# @return [String]
|
1289
1357
|
#
|
1358
|
+
# @!attribute [rw] automation_subtype
|
1359
|
+
# The subtype of the Automation operation. Currently, the only
|
1360
|
+
# supported value is `ChangeRequest`.
|
1361
|
+
# @return [String]
|
1362
|
+
#
|
1363
|
+
# @!attribute [rw] scheduled_time
|
1364
|
+
# The date and time the Automation operation is scheduled to start.
|
1365
|
+
# @return [Time]
|
1366
|
+
#
|
1367
|
+
# @!attribute [rw] runbooks
|
1368
|
+
# Information about the Automation runbooks (Automation documents)
|
1369
|
+
# that are run during a runbook workflow in Change Manager.
|
1370
|
+
#
|
1371
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
1372
|
+
# run until all required approvals for the change request have been
|
1373
|
+
# received.
|
1374
|
+
#
|
1375
|
+
# </note>
|
1376
|
+
# @return [Array<Types::Runbook>]
|
1377
|
+
#
|
1378
|
+
# @!attribute [rw] ops_item_id
|
1379
|
+
# The ID of an OpsItem that is created to represent a Change Manager
|
1380
|
+
# change request.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] association_id
|
1384
|
+
# The ID of a State Manager association used in the Automation
|
1385
|
+
# operation.
|
1386
|
+
# @return [String]
|
1387
|
+
#
|
1388
|
+
# @!attribute [rw] change_request_name
|
1389
|
+
# The name of the Change Manager change request.
|
1390
|
+
# @return [String]
|
1391
|
+
#
|
1290
1392
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecutionMetadata AWS API Documentation
|
1291
1393
|
#
|
1292
1394
|
class AutomationExecutionMetadata < Struct.new(
|
@@ -1311,7 +1413,13 @@ module Aws::SSM
|
|
1311
1413
|
:max_concurrency,
|
1312
1414
|
:max_errors,
|
1313
1415
|
:target,
|
1314
|
-
:automation_type
|
1416
|
+
:automation_type,
|
1417
|
+
:automation_subtype,
|
1418
|
+
:scheduled_time,
|
1419
|
+
:runbooks,
|
1420
|
+
:ops_item_id,
|
1421
|
+
:association_id,
|
1422
|
+
:change_request_name)
|
1315
1423
|
SENSITIVE = []
|
1316
1424
|
include Aws::Structure
|
1317
1425
|
end
|
@@ -2432,6 +2540,15 @@ module Aws::SSM
|
|
2432
2540
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2433
2541
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2434
2542
|
# apply_only_at_cron_interval: false,
|
2543
|
+
# target_locations: [
|
2544
|
+
# {
|
2545
|
+
# accounts: ["Account"],
|
2546
|
+
# regions: ["Region"],
|
2547
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
2548
|
+
# target_location_max_errors: "MaxErrors",
|
2549
|
+
# execution_role_name: "ExecutionRoleName",
|
2550
|
+
# },
|
2551
|
+
# ],
|
2435
2552
|
# },
|
2436
2553
|
# ],
|
2437
2554
|
# }
|
@@ -2482,6 +2599,15 @@ module Aws::SSM
|
|
2482
2599
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2483
2600
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2484
2601
|
# apply_only_at_cron_interval: false,
|
2602
|
+
# target_locations: [
|
2603
|
+
# {
|
2604
|
+
# accounts: ["Account"],
|
2605
|
+
# regions: ["Region"],
|
2606
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
2607
|
+
# target_location_max_errors: "MaxErrors",
|
2608
|
+
# execution_role_name: "ExecutionRoleName",
|
2609
|
+
# },
|
2610
|
+
# ],
|
2485
2611
|
# }
|
2486
2612
|
#
|
2487
2613
|
# @!attribute [rw] name
|
@@ -2597,9 +2723,15 @@ module Aws::SSM
|
|
2597
2723
|
# By default, when you create a new associations, the system runs it
|
2598
2724
|
# immediately after it is created and then according to the schedule
|
2599
2725
|
# you specified. Specify this option if you don't want an association
|
2600
|
-
# to run immediately after you create it.
|
2726
|
+
# to run immediately after you create it. This parameter is not
|
2727
|
+
# supported for rate expressions.
|
2601
2728
|
# @return [Boolean]
|
2602
2729
|
#
|
2730
|
+
# @!attribute [rw] target_locations
|
2731
|
+
# Use this action to create an association in multiple Regions and
|
2732
|
+
# multiple accounts.
|
2733
|
+
# @return [Array<Types::TargetLocation>]
|
2734
|
+
#
|
2603
2735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationBatchRequestEntry AWS API Documentation
|
2604
2736
|
#
|
2605
2737
|
class CreateAssociationBatchRequestEntry < Struct.new(
|
@@ -2616,7 +2748,8 @@ module Aws::SSM
|
|
2616
2748
|
:max_concurrency,
|
2617
2749
|
:compliance_severity,
|
2618
2750
|
:sync_compliance,
|
2619
|
-
:apply_only_at_cron_interval
|
2751
|
+
:apply_only_at_cron_interval,
|
2752
|
+
:target_locations)
|
2620
2753
|
SENSITIVE = []
|
2621
2754
|
include Aws::Structure
|
2622
2755
|
end
|
@@ -2669,6 +2802,15 @@ module Aws::SSM
|
|
2669
2802
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2670
2803
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2671
2804
|
# apply_only_at_cron_interval: false,
|
2805
|
+
# target_locations: [
|
2806
|
+
# {
|
2807
|
+
# accounts: ["Account"],
|
2808
|
+
# regions: ["Region"],
|
2809
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
2810
|
+
# target_location_max_errors: "MaxErrors",
|
2811
|
+
# execution_role_name: "ExecutionRoleName",
|
2812
|
+
# },
|
2813
|
+
# ],
|
2672
2814
|
# }
|
2673
2815
|
#
|
2674
2816
|
# @!attribute [rw] name
|
@@ -2805,9 +2947,16 @@ module Aws::SSM
|
|
2805
2947
|
# By default, when you create a new associations, the system runs it
|
2806
2948
|
# immediately after it is created and then according to the schedule
|
2807
2949
|
# you specified. Specify this option if you don't want an association
|
2808
|
-
# to run immediately after you create it.
|
2950
|
+
# to run immediately after you create it. This parameter is not
|
2951
|
+
# supported for rate expressions.
|
2809
2952
|
# @return [Boolean]
|
2810
2953
|
#
|
2954
|
+
# @!attribute [rw] target_locations
|
2955
|
+
# A location is a combination of AWS Regions and AWS accounts where
|
2956
|
+
# you want to run the association. Use this action to create an
|
2957
|
+
# association in multiple Regions and multiple accounts.
|
2958
|
+
# @return [Array<Types::TargetLocation>]
|
2959
|
+
#
|
2811
2960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationRequest AWS API Documentation
|
2812
2961
|
#
|
2813
2962
|
class CreateAssociationRequest < Struct.new(
|
@@ -2824,7 +2973,8 @@ module Aws::SSM
|
|
2824
2973
|
:max_concurrency,
|
2825
2974
|
:compliance_severity,
|
2826
2975
|
:sync_compliance,
|
2827
|
-
:apply_only_at_cron_interval
|
2976
|
+
:apply_only_at_cron_interval,
|
2977
|
+
:target_locations)
|
2828
2978
|
SENSITIVE = []
|
2829
2979
|
include Aws::Structure
|
2830
2980
|
end
|
@@ -2861,7 +3011,7 @@ module Aws::SSM
|
|
2861
3011
|
# ],
|
2862
3012
|
# name: "DocumentName", # required
|
2863
3013
|
# version_name: "DocumentVersionName",
|
2864
|
-
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar
|
3014
|
+
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate
|
2865
3015
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
2866
3016
|
# target_type: "TargetType",
|
2867
3017
|
# tags: [
|
@@ -3056,8 +3206,8 @@ module Aws::SSM
|
|
3056
3206
|
# @!attribute [rw] schedule_timezone
|
3057
3207
|
# The time zone that the scheduled maintenance window executions are
|
3058
3208
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
3059
|
-
# example: "America/Los\_Angeles", "
|
3060
|
-
#
|
3209
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
3210
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
3061
3211
|
# website.
|
3062
3212
|
#
|
3063
3213
|
#
|
@@ -3072,7 +3222,7 @@ module Aws::SSM
|
|
3072
3222
|
# For example, the following cron expression schedules a maintenance
|
3073
3223
|
# window to run on the third Tuesday of every month at 11:30 PM.
|
3074
3224
|
#
|
3075
|
-
# `cron(
|
3225
|
+
# `cron(30 23 ? * TUE#3 *)`
|
3076
3226
|
#
|
3077
3227
|
# If the schedule offset is `2`, the maintenance window won't run
|
3078
3228
|
# until two days later.
|
@@ -3161,6 +3311,7 @@ module Aws::SSM
|
|
3161
3311
|
#
|
3162
3312
|
# {
|
3163
3313
|
# description: "OpsItemDescription", # required
|
3314
|
+
# ops_item_type: "OpsItemType",
|
3164
3315
|
# operational_data: {
|
3165
3316
|
# "OpsItemDataKey" => {
|
3166
3317
|
# value: "OpsItemDataValueString",
|
@@ -3188,12 +3339,21 @@ module Aws::SSM
|
|
3188
3339
|
# ],
|
3189
3340
|
# category: "OpsItemCategory",
|
3190
3341
|
# severity: "OpsItemSeverity",
|
3342
|
+
# actual_start_time: Time.now,
|
3343
|
+
# actual_end_time: Time.now,
|
3344
|
+
# planned_start_time: Time.now,
|
3345
|
+
# planned_end_time: Time.now,
|
3191
3346
|
# }
|
3192
3347
|
#
|
3193
3348
|
# @!attribute [rw] description
|
3194
3349
|
# Information about the OpsItem.
|
3195
3350
|
# @return [String]
|
3196
3351
|
#
|
3352
|
+
# @!attribute [rw] ops_item_type
|
3353
|
+
# The type of OpsItem to create. Currently, the only valid values are
|
3354
|
+
# `/aws/changerequest` and `/aws/issue`.
|
3355
|
+
# @return [String]
|
3356
|
+
#
|
3197
3357
|
# @!attribute [rw] operational_data
|
3198
3358
|
# Operational data is custom data that provides useful reference
|
3199
3359
|
# details about the OpsItem. For example, you can specify log files,
|
@@ -3283,10 +3443,33 @@ module Aws::SSM
|
|
3283
3443
|
# Specify a severity to assign to an OpsItem.
|
3284
3444
|
# @return [String]
|
3285
3445
|
#
|
3446
|
+
# @!attribute [rw] actual_start_time
|
3447
|
+
# The time a runbook workflow started. Currently reported only for the
|
3448
|
+
# OpsItem type `/aws/changerequest`.
|
3449
|
+
# @return [Time]
|
3450
|
+
#
|
3451
|
+
# @!attribute [rw] actual_end_time
|
3452
|
+
# The time a runbook workflow ended. Currently reported only for the
|
3453
|
+
# OpsItem type `/aws/changerequest`.
|
3454
|
+
# @return [Time]
|
3455
|
+
#
|
3456
|
+
# @!attribute [rw] planned_start_time
|
3457
|
+
# The time specified in a change request for a runbook workflow to
|
3458
|
+
# start. Currently supported only for the OpsItem type
|
3459
|
+
# `/aws/changerequest`.
|
3460
|
+
# @return [Time]
|
3461
|
+
#
|
3462
|
+
# @!attribute [rw] planned_end_time
|
3463
|
+
# The time specified in a change request for a runbook workflow to
|
3464
|
+
# end. Currently supported only for the OpsItem type
|
3465
|
+
# `/aws/changerequest`.
|
3466
|
+
# @return [Time]
|
3467
|
+
#
|
3286
3468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItemRequest AWS API Documentation
|
3287
3469
|
#
|
3288
3470
|
class CreateOpsItemRequest < Struct.new(
|
3289
3471
|
:description,
|
3472
|
+
:ops_item_type,
|
3290
3473
|
:operational_data,
|
3291
3474
|
:notifications,
|
3292
3475
|
:priority,
|
@@ -3295,7 +3478,11 @@ module Aws::SSM
|
|
3295
3478
|
:title,
|
3296
3479
|
:tags,
|
3297
3480
|
:category,
|
3298
|
-
:severity
|
3481
|
+
:severity,
|
3482
|
+
:actual_start_time,
|
3483
|
+
:actual_end_time,
|
3484
|
+
:planned_start_time,
|
3485
|
+
:planned_end_time)
|
3299
3486
|
SENSITIVE = []
|
3300
3487
|
include Aws::Structure
|
3301
3488
|
end
|
@@ -3312,11 +3499,53 @@ module Aws::SSM
|
|
3312
3499
|
include Aws::Structure
|
3313
3500
|
end
|
3314
3501
|
|
3502
|
+
# @note When making an API call, you may pass CreateOpsMetadataRequest
|
3503
|
+
# data as a hash:
|
3504
|
+
#
|
3505
|
+
# {
|
3506
|
+
# resource_id: "OpsMetadataResourceId", # required
|
3507
|
+
# metadata: {
|
3508
|
+
# "MetadataKey" => {
|
3509
|
+
# value: "MetadataValueString",
|
3510
|
+
# },
|
3511
|
+
# },
|
3512
|
+
# }
|
3513
|
+
#
|
3514
|
+
# @!attribute [rw] resource_id
|
3515
|
+
# A resource ID for a new Application Manager application.
|
3516
|
+
# @return [String]
|
3517
|
+
#
|
3518
|
+
# @!attribute [rw] metadata
|
3519
|
+
# Metadata for a new Application Manager application.
|
3520
|
+
# @return [Hash<String,Types::MetadataValue>]
|
3521
|
+
#
|
3522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsMetadataRequest AWS API Documentation
|
3523
|
+
#
|
3524
|
+
class CreateOpsMetadataRequest < Struct.new(
|
3525
|
+
:resource_id,
|
3526
|
+
:metadata)
|
3527
|
+
SENSITIVE = []
|
3528
|
+
include Aws::Structure
|
3529
|
+
end
|
3530
|
+
|
3531
|
+
# @!attribute [rw] ops_metadata_arn
|
3532
|
+
# The Amazon Resource Name (ARN) of the OpsMetadata Object or blob
|
3533
|
+
# created by the call.
|
3534
|
+
# @return [String]
|
3535
|
+
#
|
3536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsMetadataResult AWS API Documentation
|
3537
|
+
#
|
3538
|
+
class CreateOpsMetadataResult < Struct.new(
|
3539
|
+
:ops_metadata_arn)
|
3540
|
+
SENSITIVE = []
|
3541
|
+
include Aws::Structure
|
3542
|
+
end
|
3543
|
+
|
3315
3544
|
# @note When making an API call, you may pass CreatePatchBaselineRequest
|
3316
3545
|
# data as a hash:
|
3317
3546
|
#
|
3318
3547
|
# {
|
3319
|
-
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
3548
|
+
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN, MACOS
|
3320
3549
|
# name: "BaselineName", # required
|
3321
3550
|
# global_filters: {
|
3322
3551
|
# patch_filters: [ # required
|
@@ -3813,6 +4042,29 @@ module Aws::SSM
|
|
3813
4042
|
include Aws::Structure
|
3814
4043
|
end
|
3815
4044
|
|
4045
|
+
# @note When making an API call, you may pass DeleteOpsMetadataRequest
|
4046
|
+
# data as a hash:
|
4047
|
+
#
|
4048
|
+
# {
|
4049
|
+
# ops_metadata_arn: "OpsMetadataArn", # required
|
4050
|
+
# }
|
4051
|
+
#
|
4052
|
+
# @!attribute [rw] ops_metadata_arn
|
4053
|
+
# The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
|
4054
|
+
# @return [String]
|
4055
|
+
#
|
4056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteOpsMetadataRequest AWS API Documentation
|
4057
|
+
#
|
4058
|
+
class DeleteOpsMetadataRequest < Struct.new(
|
4059
|
+
:ops_metadata_arn)
|
4060
|
+
SENSITIVE = []
|
4061
|
+
include Aws::Structure
|
4062
|
+
end
|
4063
|
+
|
4064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteOpsMetadataResult AWS API Documentation
|
4065
|
+
#
|
4066
|
+
class DeleteOpsMetadataResult < Aws::EmptyStructure; end
|
4067
|
+
|
3816
4068
|
# @note When making an API call, you may pass DeleteParameterRequest
|
3817
4069
|
# data as a hash:
|
3818
4070
|
#
|
@@ -4384,7 +4636,7 @@ module Aws::SSM
|
|
4384
4636
|
# {
|
4385
4637
|
# filters: [
|
4386
4638
|
# {
|
4387
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey
|
4639
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
|
4388
4640
|
# values: ["AutomationExecutionFilterValue"], # required
|
4389
4641
|
# },
|
4390
4642
|
# ],
|
@@ -5695,7 +5947,7 @@ module Aws::SSM
|
|
5695
5947
|
# {
|
5696
5948
|
# ops_item_filters: [
|
5697
5949
|
# {
|
5698
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity
|
5950
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup
|
5699
5951
|
# values: ["OpsItemFilterValue"], # required
|
5700
5952
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
5701
5953
|
# },
|
@@ -6100,7 +6352,7 @@ module Aws::SSM
|
|
6100
6352
|
# data as a hash:
|
6101
6353
|
#
|
6102
6354
|
# {
|
6103
|
-
# operating_system: "WINDOWS", # required, accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
6355
|
+
# operating_system: "WINDOWS", # required, accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN, MACOS
|
6104
6356
|
# property: "PRODUCT", # required, accepts PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY, PRIORITY, SEVERITY
|
6105
6357
|
# patch_set: "OS", # accepts OS, APPLICATION
|
6106
6358
|
# max_results: 1,
|
@@ -6117,8 +6369,8 @@ module Aws::SSM
|
|
6117
6369
|
#
|
6118
6370
|
# @!attribute [rw] patch_set
|
6119
6371
|
# Indicates whether to list patches for the Windows operating system
|
6120
|
-
# or for Microsoft applications. Not applicable for Linux
|
6121
|
-
# systems.
|
6372
|
+
# or for Microsoft applications. Not applicable for the Linux or macOS
|
6373
|
+
# operating systems.
|
6122
6374
|
# @return [String]
|
6123
6375
|
#
|
6124
6376
|
# @!attribute [rw] max_results
|
@@ -6172,7 +6424,7 @@ module Aws::SSM
|
|
6172
6424
|
# next_token: "NextToken",
|
6173
6425
|
# filters: [
|
6174
6426
|
# {
|
6175
|
-
# key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Target, Owner, Status
|
6427
|
+
# key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Target, Owner, Status, SessionId
|
6176
6428
|
# value: "SessionFilterValue", # required
|
6177
6429
|
# },
|
6178
6430
|
# ],
|
@@ -6379,6 +6631,27 @@ module Aws::SSM
|
|
6379
6631
|
# `ApplicationConfigurationSchema` document.
|
6380
6632
|
# @return [Array<Types::DocumentRequires>]
|
6381
6633
|
#
|
6634
|
+
# @!attribute [rw] author
|
6635
|
+
# The user in your organization who created the document.
|
6636
|
+
# @return [String]
|
6637
|
+
#
|
6638
|
+
# @!attribute [rw] review_information
|
6639
|
+
# Details about the review of a document.
|
6640
|
+
# @return [Array<Types::ReviewInformation>]
|
6641
|
+
#
|
6642
|
+
# @!attribute [rw] approved_version
|
6643
|
+
# The version of the document currently approved for use in the
|
6644
|
+
# organization.
|
6645
|
+
# @return [String]
|
6646
|
+
#
|
6647
|
+
# @!attribute [rw] pending_review_version
|
6648
|
+
# The version of the document that is currently under review.
|
6649
|
+
# @return [String]
|
6650
|
+
#
|
6651
|
+
# @!attribute [rw] review_status
|
6652
|
+
# The current status of the review.
|
6653
|
+
# @return [String]
|
6654
|
+
#
|
6382
6655
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentDescription AWS API Documentation
|
6383
6656
|
#
|
6384
6657
|
class DocumentDescription < Struct.new(
|
@@ -6403,7 +6676,12 @@ module Aws::SSM
|
|
6403
6676
|
:target_type,
|
6404
6677
|
:tags,
|
6405
6678
|
:attachments_information,
|
6406
|
-
:requires
|
6679
|
+
:requires,
|
6680
|
+
:author,
|
6681
|
+
:review_information,
|
6682
|
+
:approved_version,
|
6683
|
+
:pending_review_version,
|
6684
|
+
:review_status)
|
6407
6685
|
SENSITIVE = []
|
6408
6686
|
include Aws::Structure
|
6409
6687
|
end
|
@@ -6492,6 +6770,14 @@ module Aws::SSM
|
|
6492
6770
|
# `ApplicationConfigurationSchema` document.
|
6493
6771
|
# @return [Array<Types::DocumentRequires>]
|
6494
6772
|
#
|
6773
|
+
# @!attribute [rw] review_status
|
6774
|
+
# The current status of a document review.
|
6775
|
+
# @return [String]
|
6776
|
+
#
|
6777
|
+
# @!attribute [rw] author
|
6778
|
+
# The user in your organization who created the document.
|
6779
|
+
# @return [String]
|
6780
|
+
#
|
6495
6781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentIdentifier AWS API Documentation
|
6496
6782
|
#
|
6497
6783
|
class DocumentIdentifier < Struct.new(
|
@@ -6505,7 +6791,9 @@ module Aws::SSM
|
|
6505
6791
|
:document_format,
|
6506
6792
|
:target_type,
|
6507
6793
|
:tags,
|
6508
|
-
:requires
|
6794
|
+
:requires,
|
6795
|
+
:review_status,
|
6796
|
+
:author)
|
6509
6797
|
SENSITIVE = []
|
6510
6798
|
include Aws::Structure
|
6511
6799
|
end
|
@@ -6626,6 +6914,20 @@ module Aws::SSM
|
|
6626
6914
|
include Aws::Structure
|
6627
6915
|
end
|
6628
6916
|
|
6917
|
+
# Details about the response to a document review request.
|
6918
|
+
#
|
6919
|
+
# @!attribute [rw] reviewer_response
|
6920
|
+
# Details about a reviewer's response to a document review request.
|
6921
|
+
# @return [Array<Types::DocumentReviewerResponseSource>]
|
6922
|
+
#
|
6923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentMetadataResponseInfo AWS API Documentation
|
6924
|
+
#
|
6925
|
+
class DocumentMetadataResponseInfo < Struct.new(
|
6926
|
+
:reviewer_response)
|
6927
|
+
SENSITIVE = []
|
6928
|
+
include Aws::Structure
|
6929
|
+
end
|
6930
|
+
|
6629
6931
|
# Parameters specified in a System Manager document that run on the
|
6630
6932
|
# server when the command is run.
|
6631
6933
|
#
|
@@ -6703,6 +7005,114 @@ module Aws::SSM
|
|
6703
7005
|
include Aws::Structure
|
6704
7006
|
end
|
6705
7007
|
|
7008
|
+
# Information about comments added to a document review request.
|
7009
|
+
#
|
7010
|
+
# @note When making an API call, you may pass DocumentReviewCommentSource
|
7011
|
+
# data as a hash:
|
7012
|
+
#
|
7013
|
+
# {
|
7014
|
+
# type: "Comment", # accepts Comment
|
7015
|
+
# content: "DocumentReviewComment",
|
7016
|
+
# }
|
7017
|
+
#
|
7018
|
+
# @!attribute [rw] type
|
7019
|
+
# The type of information added to a review request. Currently, only
|
7020
|
+
# the value `Comment` is supported.
|
7021
|
+
# @return [String]
|
7022
|
+
#
|
7023
|
+
# @!attribute [rw] content
|
7024
|
+
# The content of a comment entered by a user who requests a review of
|
7025
|
+
# a new document version, or who reviews the new version.
|
7026
|
+
# @return [String]
|
7027
|
+
#
|
7028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentReviewCommentSource AWS API Documentation
|
7029
|
+
#
|
7030
|
+
class DocumentReviewCommentSource < Struct.new(
|
7031
|
+
:type,
|
7032
|
+
:content)
|
7033
|
+
SENSITIVE = []
|
7034
|
+
include Aws::Structure
|
7035
|
+
end
|
7036
|
+
|
7037
|
+
# Information about a reviewer's response to a document review request.
|
7038
|
+
#
|
7039
|
+
# @!attribute [rw] create_time
|
7040
|
+
# The date and time that a reviewer entered a response to a document
|
7041
|
+
# review request.
|
7042
|
+
# @return [Time]
|
7043
|
+
#
|
7044
|
+
# @!attribute [rw] updated_time
|
7045
|
+
# The date and time that a reviewer last updated a response to a
|
7046
|
+
# document review request.
|
7047
|
+
# @return [Time]
|
7048
|
+
#
|
7049
|
+
# @!attribute [rw] review_status
|
7050
|
+
# The current review status of a new custom SSM document created by a
|
7051
|
+
# member of your organization, or of the latest version of an existing
|
7052
|
+
# SSM document.
|
7053
|
+
#
|
7054
|
+
# Only one version of a document can be in the APPROVED state at a
|
7055
|
+
# time. When a new version is approved, the status of the previous
|
7056
|
+
# version changes to REJECTED.
|
7057
|
+
#
|
7058
|
+
# Only one version of a document can be in review, or PENDING, at a
|
7059
|
+
# time.
|
7060
|
+
# @return [String]
|
7061
|
+
#
|
7062
|
+
# @!attribute [rw] comment
|
7063
|
+
# The comment entered by a reviewer as part of their document review
|
7064
|
+
# response.
|
7065
|
+
# @return [Array<Types::DocumentReviewCommentSource>]
|
7066
|
+
#
|
7067
|
+
# @!attribute [rw] reviewer
|
7068
|
+
# The user in your organization assigned to review a document request.
|
7069
|
+
# @return [String]
|
7070
|
+
#
|
7071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentReviewerResponseSource AWS API Documentation
|
7072
|
+
#
|
7073
|
+
class DocumentReviewerResponseSource < Struct.new(
|
7074
|
+
:create_time,
|
7075
|
+
:updated_time,
|
7076
|
+
:review_status,
|
7077
|
+
:comment,
|
7078
|
+
:reviewer)
|
7079
|
+
SENSITIVE = []
|
7080
|
+
include Aws::Structure
|
7081
|
+
end
|
7082
|
+
|
7083
|
+
# Information about a document approval review.
|
7084
|
+
#
|
7085
|
+
# @note When making an API call, you may pass DocumentReviews
|
7086
|
+
# data as a hash:
|
7087
|
+
#
|
7088
|
+
# {
|
7089
|
+
# action: "SendForReview", # required, accepts SendForReview, UpdateReview, Approve, Reject
|
7090
|
+
# comment: [
|
7091
|
+
# {
|
7092
|
+
# type: "Comment", # accepts Comment
|
7093
|
+
# content: "DocumentReviewComment",
|
7094
|
+
# },
|
7095
|
+
# ],
|
7096
|
+
# }
|
7097
|
+
#
|
7098
|
+
# @!attribute [rw] action
|
7099
|
+
# The action to take on a document approval review request.
|
7100
|
+
# @return [String]
|
7101
|
+
#
|
7102
|
+
# @!attribute [rw] comment
|
7103
|
+
# A comment entered by a user in your organization about the document
|
7104
|
+
# review request.
|
7105
|
+
# @return [Array<Types::DocumentReviewCommentSource>]
|
7106
|
+
#
|
7107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentReviews AWS API Documentation
|
7108
|
+
#
|
7109
|
+
class DocumentReviews < Struct.new(
|
7110
|
+
:action,
|
7111
|
+
:comment)
|
7112
|
+
SENSITIVE = []
|
7113
|
+
include Aws::Structure
|
7114
|
+
end
|
7115
|
+
|
6706
7116
|
# Version information about the document.
|
6707
7117
|
#
|
6708
7118
|
# @!attribute [rw] name
|
@@ -6743,6 +7153,11 @@ module Aws::SSM
|
|
6743
7153
|
# exist. Verify that the URL of the S3 bucket is correct."
|
6744
7154
|
# @return [String]
|
6745
7155
|
#
|
7156
|
+
# @!attribute [rw] review_status
|
7157
|
+
# The current status of the approval review for the latest version of
|
7158
|
+
# the document.
|
7159
|
+
# @return [String]
|
7160
|
+
#
|
6746
7161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentVersionInfo AWS API Documentation
|
6747
7162
|
#
|
6748
7163
|
class DocumentVersionInfo < Struct.new(
|
@@ -6753,7 +7168,8 @@ module Aws::SSM
|
|
6753
7168
|
:is_default_version,
|
6754
7169
|
:document_format,
|
6755
7170
|
:status,
|
6756
|
-
:status_information
|
7171
|
+
:status_information,
|
7172
|
+
:review_status)
|
6757
7173
|
SENSITIVE = []
|
6758
7174
|
include Aws::Structure
|
6759
7175
|
end
|
@@ -7280,7 +7696,7 @@ module Aws::SSM
|
|
7280
7696
|
# data as a hash:
|
7281
7697
|
#
|
7282
7698
|
# {
|
7283
|
-
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
7699
|
+
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN, MACOS
|
7284
7700
|
# }
|
7285
7701
|
#
|
7286
7702
|
# @!attribute [rw] operating_system
|
@@ -7458,6 +7874,19 @@ module Aws::SSM
|
|
7458
7874
|
# locations, sizes, and so on.
|
7459
7875
|
# @return [Array<Types::AttachmentContent>]
|
7460
7876
|
#
|
7877
|
+
# @!attribute [rw] review_status
|
7878
|
+
# The current review status of a new custom Systems Manager document
|
7879
|
+
# (SSM document) created by a member of your organization, or of the
|
7880
|
+
# latest version of an existing SSM document.
|
7881
|
+
#
|
7882
|
+
# Only one version of an SSM document can be in the APPROVED state at
|
7883
|
+
# a time. When a new version is approved, the status of the previous
|
7884
|
+
# version changes to REJECTED.
|
7885
|
+
#
|
7886
|
+
# Only one version of an SSM document can be in review, or PENDING, at
|
7887
|
+
# a time.
|
7888
|
+
# @return [String]
|
7889
|
+
#
|
7461
7890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocumentResult AWS API Documentation
|
7462
7891
|
#
|
7463
7892
|
class GetDocumentResult < Struct.new(
|
@@ -7470,7 +7899,8 @@ module Aws::SSM
|
|
7470
7899
|
:document_type,
|
7471
7900
|
:document_format,
|
7472
7901
|
:requires,
|
7473
|
-
:attachments_content
|
7902
|
+
:attachments_content,
|
7903
|
+
:review_status)
|
7474
7904
|
SENSITIVE = []
|
7475
7905
|
include Aws::Structure
|
7476
7906
|
end
|
@@ -7970,8 +8400,8 @@ module Aws::SSM
|
|
7970
8400
|
# @!attribute [rw] schedule_timezone
|
7971
8401
|
# The time zone that the scheduled maintenance window executions are
|
7972
8402
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
7973
|
-
# example: "America/Los\_Angeles", "
|
7974
|
-
#
|
8403
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
8404
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
7975
8405
|
# website.
|
7976
8406
|
#
|
7977
8407
|
#
|
@@ -8117,11 +8547,27 @@ module Aws::SSM
|
|
8117
8547
|
#
|
8118
8548
|
# @!attribute [rw] max_concurrency
|
8119
8549
|
# The maximum number of targets allowed to run this task in parallel.
|
8550
|
+
#
|
8551
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
8552
|
+
# supply a value for this option. Instead, the system inserts a
|
8553
|
+
# placeholder value of `1`, which may be reported in the response to
|
8554
|
+
# this command. This value does not affect the running of your task
|
8555
|
+
# and can be ignored.
|
8556
|
+
#
|
8557
|
+
# </note>
|
8120
8558
|
# @return [String]
|
8121
8559
|
#
|
8122
8560
|
# @!attribute [rw] max_errors
|
8123
8561
|
# The maximum number of errors allowed before the task stops being
|
8124
8562
|
# scheduled.
|
8563
|
+
#
|
8564
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
8565
|
+
# supply a value for this option. Instead, the system inserts a
|
8566
|
+
# placeholder value of `1`, which may be reported in the response to
|
8567
|
+
# this command. This value does not affect the running of your task
|
8568
|
+
# and can be ignored.
|
8569
|
+
#
|
8570
|
+
# </note>
|
8125
8571
|
# @return [String]
|
8126
8572
|
#
|
8127
8573
|
# @!attribute [rw] logging_info
|
@@ -8197,43 +8643,100 @@ module Aws::SSM
|
|
8197
8643
|
include Aws::Structure
|
8198
8644
|
end
|
8199
8645
|
|
8200
|
-
# @note When making an API call, you may pass
|
8646
|
+
# @note When making an API call, you may pass GetOpsMetadataRequest
|
8201
8647
|
# data as a hash:
|
8202
8648
|
#
|
8203
8649
|
# {
|
8204
|
-
#
|
8205
|
-
#
|
8206
|
-
#
|
8207
|
-
#
|
8208
|
-
#
|
8209
|
-
#
|
8210
|
-
#
|
8211
|
-
#
|
8212
|
-
#
|
8213
|
-
#
|
8214
|
-
#
|
8215
|
-
#
|
8216
|
-
#
|
8217
|
-
#
|
8218
|
-
#
|
8219
|
-
#
|
8220
|
-
#
|
8221
|
-
#
|
8222
|
-
#
|
8223
|
-
#
|
8224
|
-
#
|
8225
|
-
#
|
8226
|
-
|
8227
|
-
|
8228
|
-
|
8229
|
-
|
8230
|
-
|
8231
|
-
|
8232
|
-
|
8233
|
-
|
8234
|
-
#
|
8235
|
-
#
|
8236
|
-
#
|
8650
|
+
# ops_metadata_arn: "OpsMetadataArn", # required
|
8651
|
+
# max_results: 1,
|
8652
|
+
# next_token: "NextToken",
|
8653
|
+
# }
|
8654
|
+
#
|
8655
|
+
# @!attribute [rw] ops_metadata_arn
|
8656
|
+
# The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
|
8657
|
+
# @return [String]
|
8658
|
+
#
|
8659
|
+
# @!attribute [rw] max_results
|
8660
|
+
# The maximum number of items to return for this call. The call also
|
8661
|
+
# returns a token that you can specify in a subsequent call to get the
|
8662
|
+
# next set of results.
|
8663
|
+
# @return [Integer]
|
8664
|
+
#
|
8665
|
+
# @!attribute [rw] next_token
|
8666
|
+
# A token to start the list. Use this token to get the next set of
|
8667
|
+
# results.
|
8668
|
+
# @return [String]
|
8669
|
+
#
|
8670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsMetadataRequest AWS API Documentation
|
8671
|
+
#
|
8672
|
+
class GetOpsMetadataRequest < Struct.new(
|
8673
|
+
:ops_metadata_arn,
|
8674
|
+
:max_results,
|
8675
|
+
:next_token)
|
8676
|
+
SENSITIVE = []
|
8677
|
+
include Aws::Structure
|
8678
|
+
end
|
8679
|
+
|
8680
|
+
# @!attribute [rw] resource_id
|
8681
|
+
# The resource ID of the Application Manager application.
|
8682
|
+
# @return [String]
|
8683
|
+
#
|
8684
|
+
# @!attribute [rw] metadata
|
8685
|
+
# OpsMetadata for an Application Manager application.
|
8686
|
+
# @return [Hash<String,Types::MetadataValue>]
|
8687
|
+
#
|
8688
|
+
# @!attribute [rw] next_token
|
8689
|
+
# The token for the next set of items to return. Use this token to get
|
8690
|
+
# the next set of results.
|
8691
|
+
# @return [String]
|
8692
|
+
#
|
8693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsMetadataResult AWS API Documentation
|
8694
|
+
#
|
8695
|
+
class GetOpsMetadataResult < Struct.new(
|
8696
|
+
:resource_id,
|
8697
|
+
:metadata,
|
8698
|
+
:next_token)
|
8699
|
+
SENSITIVE = []
|
8700
|
+
include Aws::Structure
|
8701
|
+
end
|
8702
|
+
|
8703
|
+
# @note When making an API call, you may pass GetOpsSummaryRequest
|
8704
|
+
# data as a hash:
|
8705
|
+
#
|
8706
|
+
# {
|
8707
|
+
# sync_name: "ResourceDataSyncName",
|
8708
|
+
# filters: [
|
8709
|
+
# {
|
8710
|
+
# key: "OpsFilterKey", # required
|
8711
|
+
# values: ["OpsFilterValue"], # required
|
8712
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
8713
|
+
# },
|
8714
|
+
# ],
|
8715
|
+
# aggregators: [
|
8716
|
+
# {
|
8717
|
+
# aggregator_type: "OpsAggregatorType",
|
8718
|
+
# type_name: "OpsDataTypeName",
|
8719
|
+
# attribute_name: "OpsDataAttributeName",
|
8720
|
+
# values: {
|
8721
|
+
# "OpsAggregatorValueKey" => "OpsAggregatorValue",
|
8722
|
+
# },
|
8723
|
+
# filters: [
|
8724
|
+
# {
|
8725
|
+
# key: "OpsFilterKey", # required
|
8726
|
+
# values: ["OpsFilterValue"], # required
|
8727
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
8728
|
+
# },
|
8729
|
+
# ],
|
8730
|
+
# aggregators: {
|
8731
|
+
# # recursive OpsAggregatorList
|
8732
|
+
# },
|
8733
|
+
# },
|
8734
|
+
# ],
|
8735
|
+
# result_attributes: [
|
8736
|
+
# {
|
8737
|
+
# type_name: "OpsDataTypeName", # required
|
8738
|
+
# },
|
8739
|
+
# ],
|
8237
8740
|
# next_token: "NextToken",
|
8238
8741
|
# max_results: 1,
|
8239
8742
|
# }
|
@@ -8538,7 +9041,7 @@ module Aws::SSM
|
|
8538
9041
|
#
|
8539
9042
|
# {
|
8540
9043
|
# patch_group: "PatchGroup", # required
|
8541
|
-
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
9044
|
+
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN, MACOS
|
8542
9045
|
# }
|
8543
9046
|
#
|
8544
9047
|
# @!attribute [rw] patch_group
|
@@ -8981,7 +9484,8 @@ module Aws::SSM
|
|
8981
9484
|
# @return [String]
|
8982
9485
|
#
|
8983
9486
|
# @!attribute [rw] last_ping_date_time
|
8984
|
-
# The date and time when agent last pinged Systems Manager
|
9487
|
+
# The date and time when the agent last pinged the Systems Manager
|
9488
|
+
# service.
|
8985
9489
|
# @return [Time]
|
8986
9490
|
#
|
8987
9491
|
# @!attribute [rw] agent_version
|
@@ -10947,6 +11451,88 @@ module Aws::SSM
|
|
10947
11451
|
include Aws::Structure
|
10948
11452
|
end
|
10949
11453
|
|
11454
|
+
# @note When making an API call, you may pass ListDocumentMetadataHistoryRequest
|
11455
|
+
# data as a hash:
|
11456
|
+
#
|
11457
|
+
# {
|
11458
|
+
# name: "DocumentName", # required
|
11459
|
+
# document_version: "DocumentVersion",
|
11460
|
+
# metadata: "DocumentReviews", # required, accepts DocumentReviews
|
11461
|
+
# next_token: "NextToken",
|
11462
|
+
# max_results: 1,
|
11463
|
+
# }
|
11464
|
+
#
|
11465
|
+
# @!attribute [rw] name
|
11466
|
+
# The name of the document.
|
11467
|
+
# @return [String]
|
11468
|
+
#
|
11469
|
+
# @!attribute [rw] document_version
|
11470
|
+
# The version of the document.
|
11471
|
+
# @return [String]
|
11472
|
+
#
|
11473
|
+
# @!attribute [rw] metadata
|
11474
|
+
# The type of data for which details are being requested. Currently,
|
11475
|
+
# the only supported value is `DocumentReviews`.
|
11476
|
+
# @return [String]
|
11477
|
+
#
|
11478
|
+
# @!attribute [rw] next_token
|
11479
|
+
# The token for the next set of items to return. (You received this
|
11480
|
+
# token from a previous call.)
|
11481
|
+
# @return [String]
|
11482
|
+
#
|
11483
|
+
# @!attribute [rw] max_results
|
11484
|
+
# The maximum number of items to return for this call. The call also
|
11485
|
+
# returns a token that you can specify in a subsequent call to get the
|
11486
|
+
# next set of results.
|
11487
|
+
# @return [Integer]
|
11488
|
+
#
|
11489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistoryRequest AWS API Documentation
|
11490
|
+
#
|
11491
|
+
class ListDocumentMetadataHistoryRequest < Struct.new(
|
11492
|
+
:name,
|
11493
|
+
:document_version,
|
11494
|
+
:metadata,
|
11495
|
+
:next_token,
|
11496
|
+
:max_results)
|
11497
|
+
SENSITIVE = []
|
11498
|
+
include Aws::Structure
|
11499
|
+
end
|
11500
|
+
|
11501
|
+
# @!attribute [rw] name
|
11502
|
+
# The name of the document.
|
11503
|
+
# @return [String]
|
11504
|
+
#
|
11505
|
+
# @!attribute [rw] document_version
|
11506
|
+
# The version of the document.
|
11507
|
+
# @return [String]
|
11508
|
+
#
|
11509
|
+
# @!attribute [rw] author
|
11510
|
+
# The user ID of the person in the organization who requested the
|
11511
|
+
# document review.
|
11512
|
+
# @return [String]
|
11513
|
+
#
|
11514
|
+
# @!attribute [rw] metadata
|
11515
|
+
# Information about the response to the document approval request.
|
11516
|
+
# @return [Types::DocumentMetadataResponseInfo]
|
11517
|
+
#
|
11518
|
+
# @!attribute [rw] next_token
|
11519
|
+
# The maximum number of items to return for this call. The call also
|
11520
|
+
# returns a token that you can specify in a subsequent call to get the
|
11521
|
+
# next set of results.
|
11522
|
+
# @return [String]
|
11523
|
+
#
|
11524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistoryResponse AWS API Documentation
|
11525
|
+
#
|
11526
|
+
class ListDocumentMetadataHistoryResponse < Struct.new(
|
11527
|
+
:name,
|
11528
|
+
:document_version,
|
11529
|
+
:author,
|
11530
|
+
:metadata,
|
11531
|
+
:next_token)
|
11532
|
+
SENSITIVE = []
|
11533
|
+
include Aws::Structure
|
11534
|
+
end
|
11535
|
+
|
10950
11536
|
# @note When making an API call, you may pass ListDocumentVersionsRequest
|
10951
11537
|
# data as a hash:
|
10952
11538
|
#
|
@@ -11167,6 +11753,123 @@ module Aws::SSM
|
|
11167
11753
|
include Aws::Structure
|
11168
11754
|
end
|
11169
11755
|
|
11756
|
+
# @note When making an API call, you may pass ListOpsItemEventsRequest
|
11757
|
+
# data as a hash:
|
11758
|
+
#
|
11759
|
+
# {
|
11760
|
+
# filters: [
|
11761
|
+
# {
|
11762
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
11763
|
+
# values: ["OpsItemEventFilterValue"], # required
|
11764
|
+
# operator: "Equal", # required, accepts Equal
|
11765
|
+
# },
|
11766
|
+
# ],
|
11767
|
+
# max_results: 1,
|
11768
|
+
# next_token: "String",
|
11769
|
+
# }
|
11770
|
+
#
|
11771
|
+
# @!attribute [rw] filters
|
11772
|
+
# One or more OpsItem filters. Use a filter to return a more specific
|
11773
|
+
# list of results.
|
11774
|
+
# @return [Array<Types::OpsItemEventFilter>]
|
11775
|
+
#
|
11776
|
+
# @!attribute [rw] max_results
|
11777
|
+
# The maximum number of items to return for this call. The call also
|
11778
|
+
# returns a token that you can specify in a subsequent call to get the
|
11779
|
+
# next set of results.
|
11780
|
+
# @return [Integer]
|
11781
|
+
#
|
11782
|
+
# @!attribute [rw] next_token
|
11783
|
+
# A token to start the list. Use this token to get the next set of
|
11784
|
+
# results.
|
11785
|
+
# @return [String]
|
11786
|
+
#
|
11787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEventsRequest AWS API Documentation
|
11788
|
+
#
|
11789
|
+
class ListOpsItemEventsRequest < Struct.new(
|
11790
|
+
:filters,
|
11791
|
+
:max_results,
|
11792
|
+
:next_token)
|
11793
|
+
SENSITIVE = []
|
11794
|
+
include Aws::Structure
|
11795
|
+
end
|
11796
|
+
|
11797
|
+
# @!attribute [rw] next_token
|
11798
|
+
# The token for the next set of items to return. Use this token to get
|
11799
|
+
# the next set of results.
|
11800
|
+
# @return [String]
|
11801
|
+
#
|
11802
|
+
# @!attribute [rw] summaries
|
11803
|
+
# A list of event information for the specified OpsItems.
|
11804
|
+
# @return [Array<Types::OpsItemEventSummary>]
|
11805
|
+
#
|
11806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEventsResponse AWS API Documentation
|
11807
|
+
#
|
11808
|
+
class ListOpsItemEventsResponse < Struct.new(
|
11809
|
+
:next_token,
|
11810
|
+
:summaries)
|
11811
|
+
SENSITIVE = []
|
11812
|
+
include Aws::Structure
|
11813
|
+
end
|
11814
|
+
|
11815
|
+
# @note When making an API call, you may pass ListOpsMetadataRequest
|
11816
|
+
# data as a hash:
|
11817
|
+
#
|
11818
|
+
# {
|
11819
|
+
# filters: [
|
11820
|
+
# {
|
11821
|
+
# key: "OpsMetadataFilterKey", # required
|
11822
|
+
# values: ["OpsMetadataFilterValue"], # required
|
11823
|
+
# },
|
11824
|
+
# ],
|
11825
|
+
# max_results: 1,
|
11826
|
+
# next_token: "NextToken",
|
11827
|
+
# }
|
11828
|
+
#
|
11829
|
+
# @!attribute [rw] filters
|
11830
|
+
# One or more filters to limit the number of OpsMetadata objects
|
11831
|
+
# returned by the call.
|
11832
|
+
# @return [Array<Types::OpsMetadataFilter>]
|
11833
|
+
#
|
11834
|
+
# @!attribute [rw] max_results
|
11835
|
+
# The maximum number of items to return for this call. The call also
|
11836
|
+
# returns a token that you can specify in a subsequent call to get the
|
11837
|
+
# next set of results.
|
11838
|
+
# @return [Integer]
|
11839
|
+
#
|
11840
|
+
# @!attribute [rw] next_token
|
11841
|
+
# A token to start the list. Use this token to get the next set of
|
11842
|
+
# results.
|
11843
|
+
# @return [String]
|
11844
|
+
#
|
11845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsMetadataRequest AWS API Documentation
|
11846
|
+
#
|
11847
|
+
class ListOpsMetadataRequest < Struct.new(
|
11848
|
+
:filters,
|
11849
|
+
:max_results,
|
11850
|
+
:next_token)
|
11851
|
+
SENSITIVE = []
|
11852
|
+
include Aws::Structure
|
11853
|
+
end
|
11854
|
+
|
11855
|
+
# @!attribute [rw] ops_metadata_list
|
11856
|
+
# Returns a list of OpsMetadata objects.
|
11857
|
+
# @return [Array<Types::OpsMetadata>]
|
11858
|
+
#
|
11859
|
+
# @!attribute [rw] next_token
|
11860
|
+
# The token for the next set of items to return. Use this token to get
|
11861
|
+
# the next set of results.
|
11862
|
+
# @return [String]
|
11863
|
+
#
|
11864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsMetadataResult AWS API Documentation
|
11865
|
+
#
|
11866
|
+
class ListOpsMetadataResult < Struct.new(
|
11867
|
+
:ops_metadata_list,
|
11868
|
+
:next_token)
|
11869
|
+
SENSITIVE = []
|
11870
|
+
include Aws::Structure
|
11871
|
+
end
|
11872
|
+
|
11170
11873
|
# @note When making an API call, you may pass ListResourceComplianceSummariesRequest
|
11171
11874
|
# data as a hash:
|
11172
11875
|
#
|
@@ -12210,6 +12913,27 @@ module Aws::SSM
|
|
12210
12913
|
include Aws::Structure
|
12211
12914
|
end
|
12212
12915
|
|
12916
|
+
# Metadata to assign to an Application Manager application.
|
12917
|
+
#
|
12918
|
+
# @note When making an API call, you may pass MetadataValue
|
12919
|
+
# data as a hash:
|
12920
|
+
#
|
12921
|
+
# {
|
12922
|
+
# value: "MetadataValueString",
|
12923
|
+
# }
|
12924
|
+
#
|
12925
|
+
# @!attribute [rw] value
|
12926
|
+
# Metadata value to assign to an Application Manager application.
|
12927
|
+
# @return [String]
|
12928
|
+
#
|
12929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MetadataValue AWS API Documentation
|
12930
|
+
#
|
12931
|
+
class MetadataValue < Struct.new(
|
12932
|
+
:value)
|
12933
|
+
SENSITIVE = []
|
12934
|
+
include Aws::Structure
|
12935
|
+
end
|
12936
|
+
|
12213
12937
|
# @note When making an API call, you may pass ModifyDocumentPermissionRequest
|
12214
12938
|
# data as a hash:
|
12215
12939
|
#
|
@@ -12496,6 +13220,11 @@ module Aws::SSM
|
|
12496
13220
|
# The ARN of the AWS account that created the OpsItem.
|
12497
13221
|
# @return [String]
|
12498
13222
|
#
|
13223
|
+
# @!attribute [rw] ops_item_type
|
13224
|
+
# The type of OpsItem. Currently, the only valid values are
|
13225
|
+
# `/aws/changerequest` and `/aws/issue`.
|
13226
|
+
# @return [String]
|
13227
|
+
#
|
12499
13228
|
# @!attribute [rw] created_time
|
12500
13229
|
# The date and time the OpsItem was created.
|
12501
13230
|
# @return [Time]
|
@@ -12597,10 +13326,33 @@ module Aws::SSM
|
|
12597
13326
|
# The severity of the OpsItem. Severity options range from 1 to 4.
|
12598
13327
|
# @return [String]
|
12599
13328
|
#
|
13329
|
+
# @!attribute [rw] actual_start_time
|
13330
|
+
# The time a runbook workflow started. Currently reported only for the
|
13331
|
+
# OpsItem type `/aws/changerequest`.
|
13332
|
+
# @return [Time]
|
13333
|
+
#
|
13334
|
+
# @!attribute [rw] actual_end_time
|
13335
|
+
# The time a runbook workflow ended. Currently reported only for the
|
13336
|
+
# OpsItem type `/aws/changerequest`.
|
13337
|
+
# @return [Time]
|
13338
|
+
#
|
13339
|
+
# @!attribute [rw] planned_start_time
|
13340
|
+
# The time specified in a change request for a runbook workflow to
|
13341
|
+
# start. Currently supported only for the OpsItem type
|
13342
|
+
# `/aws/changerequest`.
|
13343
|
+
# @return [Time]
|
13344
|
+
#
|
13345
|
+
# @!attribute [rw] planned_end_time
|
13346
|
+
# The time specified in a change request for a runbook workflow to
|
13347
|
+
# end. Currently supported only for the OpsItem type
|
13348
|
+
# `/aws/changerequest`.
|
13349
|
+
# @return [Time]
|
13350
|
+
#
|
12600
13351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItem AWS API Documentation
|
12601
13352
|
#
|
12602
13353
|
class OpsItem < Struct.new(
|
12603
13354
|
:created_by,
|
13355
|
+
:ops_item_type,
|
12604
13356
|
:created_time,
|
12605
13357
|
:description,
|
12606
13358
|
:last_modified_by,
|
@@ -12615,7 +13367,11 @@ module Aws::SSM
|
|
12615
13367
|
:source,
|
12616
13368
|
:operational_data,
|
12617
13369
|
:category,
|
12618
|
-
:severity
|
13370
|
+
:severity,
|
13371
|
+
:actual_start_time,
|
13372
|
+
:actual_end_time,
|
13373
|
+
:planned_start_time,
|
13374
|
+
:planned_end_time)
|
12619
13375
|
SENSITIVE = []
|
12620
13376
|
include Aws::Structure
|
12621
13377
|
end
|
@@ -12666,14 +13422,96 @@ module Aws::SSM
|
|
12666
13422
|
include Aws::Structure
|
12667
13423
|
end
|
12668
13424
|
|
12669
|
-
# Describes
|
13425
|
+
# Describes a filter for a specific list of OpsItem events. You can
|
13426
|
+
# filter event information by using tags. You specify tags by using a
|
13427
|
+
# key-value pair mapping.
|
12670
13428
|
#
|
12671
|
-
# @note When making an API call, you may pass
|
13429
|
+
# @note When making an API call, you may pass OpsItemEventFilter
|
12672
13430
|
# data as a hash:
|
12673
13431
|
#
|
12674
13432
|
# {
|
12675
|
-
# key: "
|
12676
|
-
# values: ["
|
13433
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
13434
|
+
# values: ["OpsItemEventFilterValue"], # required
|
13435
|
+
# operator: "Equal", # required, accepts Equal
|
13436
|
+
# }
|
13437
|
+
#
|
13438
|
+
# @!attribute [rw] key
|
13439
|
+
# The name of the filter key. Currently, the only supported value is
|
13440
|
+
# `OpsItemId`.
|
13441
|
+
# @return [String]
|
13442
|
+
#
|
13443
|
+
# @!attribute [rw] values
|
13444
|
+
# The values for the filter, consisting of one or more OpsItem IDs.
|
13445
|
+
# @return [Array<String>]
|
13446
|
+
#
|
13447
|
+
# @!attribute [rw] operator
|
13448
|
+
# The operator used by the filter call. Currently, the only supported
|
13449
|
+
# value is `Equal`.
|
13450
|
+
# @return [String]
|
13451
|
+
#
|
13452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemEventFilter AWS API Documentation
|
13453
|
+
#
|
13454
|
+
class OpsItemEventFilter < Struct.new(
|
13455
|
+
:key,
|
13456
|
+
:values,
|
13457
|
+
:operator)
|
13458
|
+
SENSITIVE = []
|
13459
|
+
include Aws::Structure
|
13460
|
+
end
|
13461
|
+
|
13462
|
+
# Summary information about an OpsItem event.
|
13463
|
+
#
|
13464
|
+
# @!attribute [rw] ops_item_id
|
13465
|
+
# The ID of the OpsItem.
|
13466
|
+
# @return [String]
|
13467
|
+
#
|
13468
|
+
# @!attribute [rw] event_id
|
13469
|
+
# The ID of the OpsItem event.
|
13470
|
+
# @return [String]
|
13471
|
+
#
|
13472
|
+
# @!attribute [rw] source
|
13473
|
+
# The source of the OpsItem event.
|
13474
|
+
# @return [String]
|
13475
|
+
#
|
13476
|
+
# @!attribute [rw] detail_type
|
13477
|
+
# The type of information provided as a detail.
|
13478
|
+
# @return [String]
|
13479
|
+
#
|
13480
|
+
# @!attribute [rw] detail
|
13481
|
+
# Specific information about the OpsItem event.
|
13482
|
+
# @return [String]
|
13483
|
+
#
|
13484
|
+
# @!attribute [rw] created_by
|
13485
|
+
# Information about the user or resource that created the OpsItem
|
13486
|
+
# event.
|
13487
|
+
# @return [Types::OpsItemIdentity]
|
13488
|
+
#
|
13489
|
+
# @!attribute [rw] created_time
|
13490
|
+
# The date and time the OpsItem event was created.
|
13491
|
+
# @return [Time]
|
13492
|
+
#
|
13493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemEventSummary AWS API Documentation
|
13494
|
+
#
|
13495
|
+
class OpsItemEventSummary < Struct.new(
|
13496
|
+
:ops_item_id,
|
13497
|
+
:event_id,
|
13498
|
+
:source,
|
13499
|
+
:detail_type,
|
13500
|
+
:detail,
|
13501
|
+
:created_by,
|
13502
|
+
:created_time)
|
13503
|
+
SENSITIVE = []
|
13504
|
+
include Aws::Structure
|
13505
|
+
end
|
13506
|
+
|
13507
|
+
# Describes an OpsItem filter.
|
13508
|
+
#
|
13509
|
+
# @note When making an API call, you may pass OpsItemFilter
|
13510
|
+
# data as a hash:
|
13511
|
+
#
|
13512
|
+
# {
|
13513
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup
|
13514
|
+
# values: ["OpsItemFilterValue"], # required
|
12677
13515
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
12678
13516
|
# }
|
12679
13517
|
#
|
@@ -12699,6 +13537,21 @@ module Aws::SSM
|
|
12699
13537
|
include Aws::Structure
|
12700
13538
|
end
|
12701
13539
|
|
13540
|
+
# Information about the user or resource that created an OpsItem event.
|
13541
|
+
#
|
13542
|
+
# @!attribute [rw] arn
|
13543
|
+
# The Amazon Resource Name (ARN) of the IAM entity that created the
|
13544
|
+
# OpsItem event.
|
13545
|
+
# @return [String]
|
13546
|
+
#
|
13547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemIdentity AWS API Documentation
|
13548
|
+
#
|
13549
|
+
class OpsItemIdentity < Struct.new(
|
13550
|
+
:arn)
|
13551
|
+
SENSITIVE = []
|
13552
|
+
include Aws::Structure
|
13553
|
+
end
|
13554
|
+
|
12702
13555
|
# A specified parameter argument isn't valid. Verify the available
|
12703
13556
|
# arguments and try again.
|
12704
13557
|
#
|
@@ -12839,6 +13692,33 @@ module Aws::SSM
|
|
12839
13692
|
# A list of OpsItems by severity.
|
12840
13693
|
# @return [String]
|
12841
13694
|
#
|
13695
|
+
# @!attribute [rw] ops_item_type
|
13696
|
+
# The type of OpsItem. Currently, the only valid values are
|
13697
|
+
# `/aws/changerequest` and `/aws/issue`.
|
13698
|
+
# @return [String]
|
13699
|
+
#
|
13700
|
+
# @!attribute [rw] actual_start_time
|
13701
|
+
# The time a runbook workflow started. Currently reported only for the
|
13702
|
+
# OpsItem type `/aws/changerequest`.
|
13703
|
+
# @return [Time]
|
13704
|
+
#
|
13705
|
+
# @!attribute [rw] actual_end_time
|
13706
|
+
# The time a runbook workflow ended. Currently reported only for the
|
13707
|
+
# OpsItem type `/aws/changerequest`.
|
13708
|
+
# @return [Time]
|
13709
|
+
#
|
13710
|
+
# @!attribute [rw] planned_start_time
|
13711
|
+
# The time specified in a change request for a runbook workflow to
|
13712
|
+
# start. Currently supported only for the OpsItem type
|
13713
|
+
# `/aws/changerequest`.
|
13714
|
+
# @return [Time]
|
13715
|
+
#
|
13716
|
+
# @!attribute [rw] planned_end_time
|
13717
|
+
# The time specified in a change request for a runbook workflow to
|
13718
|
+
# end. Currently supported only for the OpsItem type
|
13719
|
+
# `/aws/changerequest`.
|
13720
|
+
# @return [Time]
|
13721
|
+
#
|
12842
13722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemSummary AWS API Documentation
|
12843
13723
|
#
|
12844
13724
|
class OpsItemSummary < Struct.new(
|
@@ -12853,7 +13733,155 @@ module Aws::SSM
|
|
12853
13733
|
:title,
|
12854
13734
|
:operational_data,
|
12855
13735
|
:category,
|
12856
|
-
:severity
|
13736
|
+
:severity,
|
13737
|
+
:ops_item_type,
|
13738
|
+
:actual_start_time,
|
13739
|
+
:actual_end_time,
|
13740
|
+
:planned_start_time,
|
13741
|
+
:planned_end_time)
|
13742
|
+
SENSITIVE = []
|
13743
|
+
include Aws::Structure
|
13744
|
+
end
|
13745
|
+
|
13746
|
+
# Operational metadata for an application in Application Manager.
|
13747
|
+
#
|
13748
|
+
# @!attribute [rw] resource_id
|
13749
|
+
# The ID of the Application Manager application.
|
13750
|
+
# @return [String]
|
13751
|
+
#
|
13752
|
+
# @!attribute [rw] ops_metadata_arn
|
13753
|
+
# The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
|
13754
|
+
# @return [String]
|
13755
|
+
#
|
13756
|
+
# @!attribute [rw] last_modified_date
|
13757
|
+
# The date the OpsMetadata object was last updated.
|
13758
|
+
# @return [Time]
|
13759
|
+
#
|
13760
|
+
# @!attribute [rw] last_modified_user
|
13761
|
+
# The user name who last updated the OpsMetadata object.
|
13762
|
+
# @return [String]
|
13763
|
+
#
|
13764
|
+
# @!attribute [rw] creation_date
|
13765
|
+
# The date the OpsMetadata objects was created.
|
13766
|
+
# @return [Time]
|
13767
|
+
#
|
13768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadata AWS API Documentation
|
13769
|
+
#
|
13770
|
+
class OpsMetadata < Struct.new(
|
13771
|
+
:resource_id,
|
13772
|
+
:ops_metadata_arn,
|
13773
|
+
:last_modified_date,
|
13774
|
+
:last_modified_user,
|
13775
|
+
:creation_date)
|
13776
|
+
SENSITIVE = []
|
13777
|
+
include Aws::Structure
|
13778
|
+
end
|
13779
|
+
|
13780
|
+
# An OpsMetadata object already exists for the selected resource.
|
13781
|
+
#
|
13782
|
+
# @!attribute [rw] message
|
13783
|
+
# @return [String]
|
13784
|
+
#
|
13785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataAlreadyExistsException AWS API Documentation
|
13786
|
+
#
|
13787
|
+
class OpsMetadataAlreadyExistsException < Struct.new(
|
13788
|
+
:message)
|
13789
|
+
SENSITIVE = []
|
13790
|
+
include Aws::Structure
|
13791
|
+
end
|
13792
|
+
|
13793
|
+
# A filter to limit the number of OpsMetadata objects displayed.
|
13794
|
+
#
|
13795
|
+
# @note When making an API call, you may pass OpsMetadataFilter
|
13796
|
+
# data as a hash:
|
13797
|
+
#
|
13798
|
+
# {
|
13799
|
+
# key: "OpsMetadataFilterKey", # required
|
13800
|
+
# values: ["OpsMetadataFilterValue"], # required
|
13801
|
+
# }
|
13802
|
+
#
|
13803
|
+
# @!attribute [rw] key
|
13804
|
+
# A filter key.
|
13805
|
+
# @return [String]
|
13806
|
+
#
|
13807
|
+
# @!attribute [rw] values
|
13808
|
+
# A filter value.
|
13809
|
+
# @return [Array<String>]
|
13810
|
+
#
|
13811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataFilter AWS API Documentation
|
13812
|
+
#
|
13813
|
+
class OpsMetadataFilter < Struct.new(
|
13814
|
+
:key,
|
13815
|
+
:values)
|
13816
|
+
SENSITIVE = []
|
13817
|
+
include Aws::Structure
|
13818
|
+
end
|
13819
|
+
|
13820
|
+
# One of the arguments passed is invalid.
|
13821
|
+
#
|
13822
|
+
# @!attribute [rw] message
|
13823
|
+
# @return [String]
|
13824
|
+
#
|
13825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataInvalidArgumentException AWS API Documentation
|
13826
|
+
#
|
13827
|
+
class OpsMetadataInvalidArgumentException < Struct.new(
|
13828
|
+
:message)
|
13829
|
+
SENSITIVE = []
|
13830
|
+
include Aws::Structure
|
13831
|
+
end
|
13832
|
+
|
13833
|
+
# The OpsMetadata object exceeds the maximum number of OpsMetadata keys
|
13834
|
+
# that you can assign to an application in Application Manager.
|
13835
|
+
#
|
13836
|
+
# @!attribute [rw] message
|
13837
|
+
# @return [String]
|
13838
|
+
#
|
13839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataKeyLimitExceededException AWS API Documentation
|
13840
|
+
#
|
13841
|
+
class OpsMetadataKeyLimitExceededException < Struct.new(
|
13842
|
+
:message)
|
13843
|
+
SENSITIVE = []
|
13844
|
+
include Aws::Structure
|
13845
|
+
end
|
13846
|
+
|
13847
|
+
# Your account reached the maximum number of OpsMetadata objects allowed
|
13848
|
+
# by Application Manager. The maximum is 200 OpsMetadata objects. Delete
|
13849
|
+
# one or more OpsMetadata object and try again.
|
13850
|
+
#
|
13851
|
+
# @!attribute [rw] message
|
13852
|
+
# @return [String]
|
13853
|
+
#
|
13854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataLimitExceededException AWS API Documentation
|
13855
|
+
#
|
13856
|
+
class OpsMetadataLimitExceededException < Struct.new(
|
13857
|
+
:message)
|
13858
|
+
SENSITIVE = []
|
13859
|
+
include Aws::Structure
|
13860
|
+
end
|
13861
|
+
|
13862
|
+
# The OpsMetadata object does not exist.
|
13863
|
+
#
|
13864
|
+
# @!attribute [rw] message
|
13865
|
+
# @return [String]
|
13866
|
+
#
|
13867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataNotFoundException AWS API Documentation
|
13868
|
+
#
|
13869
|
+
class OpsMetadataNotFoundException < Struct.new(
|
13870
|
+
:message)
|
13871
|
+
SENSITIVE = []
|
13872
|
+
include Aws::Structure
|
13873
|
+
end
|
13874
|
+
|
13875
|
+
# The system is processing too many concurrent updates. Wait a few
|
13876
|
+
# moments and try again.
|
13877
|
+
#
|
13878
|
+
# @!attribute [rw] message
|
13879
|
+
# @return [String]
|
13880
|
+
#
|
13881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsMetadataTooManyUpdatesException AWS API Documentation
|
13882
|
+
#
|
13883
|
+
class OpsMetadataTooManyUpdatesException < Struct.new(
|
13884
|
+
:message)
|
12857
13885
|
SENSITIVE = []
|
12858
13886
|
include Aws::Structure
|
12859
13887
|
end
|
@@ -13433,7 +14461,7 @@ module Aws::SSM
|
|
13433
14461
|
#
|
13434
14462
|
# @!attribute [rw] cve_ids
|
13435
14463
|
# The Common Vulnerabilities and Exposures (CVE) ID of the patch. For
|
13436
|
-
# example, `CVE-
|
14464
|
+
# example, `CVE-2011-3192`. Applies to Linux-based instances only.
|
13437
14465
|
# @return [Array<String>]
|
13438
14466
|
#
|
13439
14467
|
# @!attribute [rw] name
|
@@ -14617,7 +15645,7 @@ module Aws::SSM
|
|
14617
15645
|
#
|
14618
15646
|
# {
|
14619
15647
|
# window_id: "MaintenanceWindowId", # required
|
14620
|
-
# targets: [
|
15648
|
+
# targets: [
|
14621
15649
|
# {
|
14622
15650
|
# key: "TargetKey",
|
14623
15651
|
# values: ["TargetValue"],
|
@@ -14671,8 +15699,8 @@ module Aws::SSM
|
|
14671
15699
|
# },
|
14672
15700
|
# },
|
14673
15701
|
# priority: 1,
|
14674
|
-
# max_concurrency: "MaxConcurrency",
|
14675
|
-
# max_errors: "MaxErrors",
|
15702
|
+
# max_concurrency: "MaxConcurrency",
|
15703
|
+
# max_errors: "MaxErrors",
|
14676
15704
|
# logging_info: {
|
14677
15705
|
# s3_bucket_name: "S3BucketName", # required
|
14678
15706
|
# s3_key_prefix: "S3KeyPrefix",
|
@@ -14690,13 +15718,26 @@ module Aws::SSM
|
|
14690
15718
|
# @!attribute [rw] targets
|
14691
15719
|
# The targets (either instances or maintenance window targets).
|
14692
15720
|
#
|
15721
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
15722
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
15723
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
15724
|
+
# Step Functions). For more information about running tasks that do
|
15725
|
+
# not specify targets, see see [Registering maintenance window tasks
|
15726
|
+
# without targets][1] in the *AWS Systems Manager User Guide*.
|
15727
|
+
#
|
15728
|
+
# </note>
|
15729
|
+
#
|
14693
15730
|
# Specify instances using the following format:
|
14694
15731
|
#
|
14695
15732
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
14696
15733
|
#
|
14697
15734
|
# Specify maintenance window targets using the following format:
|
14698
15735
|
#
|
14699
|
-
# `Key=WindowTargetIds
|
15736
|
+
# `Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>`
|
15737
|
+
#
|
15738
|
+
#
|
15739
|
+
#
|
15740
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
14700
15741
|
# @return [Array<Types::Target>]
|
14701
15742
|
#
|
14702
15743
|
# @!attribute [rw] task_arn
|
@@ -14756,11 +15797,25 @@ module Aws::SSM
|
|
14756
15797
|
#
|
14757
15798
|
# @!attribute [rw] max_concurrency
|
14758
15799
|
# The maximum number of targets this task can be run for in parallel.
|
15800
|
+
#
|
15801
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
15802
|
+
# supply a value for this option. Instead, the system inserts a
|
15803
|
+
# placeholder value of `1`. This value does not affect the running of
|
15804
|
+
# your task.
|
15805
|
+
#
|
15806
|
+
# </note>
|
14759
15807
|
# @return [String]
|
14760
15808
|
#
|
14761
15809
|
# @!attribute [rw] max_errors
|
14762
15810
|
# The maximum number of errors allowed before this task stops being
|
14763
15811
|
# scheduled.
|
15812
|
+
#
|
15813
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
15814
|
+
# supply a value for this option. Instead, the system inserts a
|
15815
|
+
# placeholder value of `1`. This value does not affect the running of
|
15816
|
+
# your task.
|
15817
|
+
#
|
15818
|
+
# </note>
|
14764
15819
|
# @return [String]
|
14765
15820
|
#
|
14766
15821
|
# @!attribute [rw] logging_info
|
@@ -15526,6 +16581,126 @@ module Aws::SSM
|
|
15526
16581
|
include Aws::Structure
|
15527
16582
|
end
|
15528
16583
|
|
16584
|
+
# Information about the result of a document review request.
|
16585
|
+
#
|
16586
|
+
# @!attribute [rw] reviewed_time
|
16587
|
+
# The time that the reviewer took action on the document review
|
16588
|
+
# request.
|
16589
|
+
# @return [Time]
|
16590
|
+
#
|
16591
|
+
# @!attribute [rw] status
|
16592
|
+
# The current status of the document review request.
|
16593
|
+
# @return [String]
|
16594
|
+
#
|
16595
|
+
# @!attribute [rw] reviewer
|
16596
|
+
# The reviewer assigned to take action on the document review request.
|
16597
|
+
# @return [String]
|
16598
|
+
#
|
16599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ReviewInformation AWS API Documentation
|
16600
|
+
#
|
16601
|
+
class ReviewInformation < Struct.new(
|
16602
|
+
:reviewed_time,
|
16603
|
+
:status,
|
16604
|
+
:reviewer)
|
16605
|
+
SENSITIVE = []
|
16606
|
+
include Aws::Structure
|
16607
|
+
end
|
16608
|
+
|
16609
|
+
# Information about an Automation runbook (Automation document) used in
|
16610
|
+
# a runbook workflow in Change Manager.
|
16611
|
+
#
|
16612
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
16613
|
+
# until all required approvals for the change request have been
|
16614
|
+
# received.
|
16615
|
+
#
|
16616
|
+
# </note>
|
16617
|
+
#
|
16618
|
+
# @note When making an API call, you may pass Runbook
|
16619
|
+
# data as a hash:
|
16620
|
+
#
|
16621
|
+
# {
|
16622
|
+
# document_name: "DocumentARN", # required
|
16623
|
+
# document_version: "DocumentVersion",
|
16624
|
+
# parameters: {
|
16625
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
16626
|
+
# },
|
16627
|
+
# target_parameter_name: "AutomationParameterKey",
|
16628
|
+
# targets: [
|
16629
|
+
# {
|
16630
|
+
# key: "TargetKey",
|
16631
|
+
# values: ["TargetValue"],
|
16632
|
+
# },
|
16633
|
+
# ],
|
16634
|
+
# max_concurrency: "MaxConcurrency",
|
16635
|
+
# max_errors: "MaxErrors",
|
16636
|
+
# target_locations: [
|
16637
|
+
# {
|
16638
|
+
# accounts: ["Account"],
|
16639
|
+
# regions: ["Region"],
|
16640
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
16641
|
+
# target_location_max_errors: "MaxErrors",
|
16642
|
+
# execution_role_name: "ExecutionRoleName",
|
16643
|
+
# },
|
16644
|
+
# ],
|
16645
|
+
# }
|
16646
|
+
#
|
16647
|
+
# @!attribute [rw] document_name
|
16648
|
+
# The name of the Automation runbook (Automation document) used in a
|
16649
|
+
# runbook workflow.
|
16650
|
+
# @return [String]
|
16651
|
+
#
|
16652
|
+
# @!attribute [rw] document_version
|
16653
|
+
# The version of the Automation runbook (Automation document) used in
|
16654
|
+
# a runbook workflow.
|
16655
|
+
# @return [String]
|
16656
|
+
#
|
16657
|
+
# @!attribute [rw] parameters
|
16658
|
+
# The key-value map of execution parameters, which were supplied when
|
16659
|
+
# calling `StartChangeRequestExecution`.
|
16660
|
+
# @return [Hash<String,Array<String>>]
|
16661
|
+
#
|
16662
|
+
# @!attribute [rw] target_parameter_name
|
16663
|
+
# The name of the parameter used as the target resource for the
|
16664
|
+
# rate-controlled runbook workflow. Required if you specify `Targets`.
|
16665
|
+
# @return [String]
|
16666
|
+
#
|
16667
|
+
# @!attribute [rw] targets
|
16668
|
+
# A key-value mapping to target resources that the Runbook operation
|
16669
|
+
# performs tasks on. Required if you specify `TargetParameterName`.
|
16670
|
+
# @return [Array<Types::Target>]
|
16671
|
+
#
|
16672
|
+
# @!attribute [rw] max_concurrency
|
16673
|
+
# The `MaxConcurrency` value specified by the user when the operation
|
16674
|
+
# started, indicating the maximum number of resources that the runbook
|
16675
|
+
# operation can run on at the same time.
|
16676
|
+
# @return [String]
|
16677
|
+
#
|
16678
|
+
# @!attribute [rw] max_errors
|
16679
|
+
# The `MaxErrors` value specified by the user when the execution
|
16680
|
+
# started, indicating the maximum number of errors that can occur
|
16681
|
+
# during the operation before the updates are stopped or rolled back.
|
16682
|
+
# @return [String]
|
16683
|
+
#
|
16684
|
+
# @!attribute [rw] target_locations
|
16685
|
+
# Information about the AWS Regions and accounts targeted by the
|
16686
|
+
# current Runbook operation.
|
16687
|
+
# @return [Array<Types::TargetLocation>]
|
16688
|
+
#
|
16689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Runbook AWS API Documentation
|
16690
|
+
#
|
16691
|
+
class Runbook < Struct.new(
|
16692
|
+
:document_name,
|
16693
|
+
:document_version,
|
16694
|
+
:parameters,
|
16695
|
+
:target_parameter_name,
|
16696
|
+
:targets,
|
16697
|
+
:max_concurrency,
|
16698
|
+
:max_errors,
|
16699
|
+
:target_locations)
|
16700
|
+
SENSITIVE = []
|
16701
|
+
include Aws::Structure
|
16702
|
+
end
|
16703
|
+
|
15529
16704
|
# An S3 bucket where you want to store the results of this request.
|
15530
16705
|
#
|
15531
16706
|
# @note When making an API call, you may pass S3OutputLocation
|
@@ -16021,7 +17196,7 @@ module Aws::SSM
|
|
16021
17196
|
# data as a hash:
|
16022
17197
|
#
|
16023
17198
|
# {
|
16024
|
-
# key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Target, Owner, Status
|
17199
|
+
# key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Target, Owner, Status, SessionId
|
16025
17200
|
# value: "SessionFilterValue", # required
|
16026
17201
|
# }
|
16027
17202
|
#
|
@@ -16060,6 +17235,9 @@ module Aws::SSM
|
|
16060
17235
|
# * Terminating
|
16061
17236
|
#
|
16062
17237
|
# * Failed
|
17238
|
+
#
|
17239
|
+
# * SessionId: Specify a session ID to return details about the
|
17240
|
+
# session.
|
16063
17241
|
# @return [String]
|
16064
17242
|
#
|
16065
17243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SessionFilter AWS API Documentation
|
@@ -16332,6 +17510,141 @@ module Aws::SSM
|
|
16332
17510
|
include Aws::Structure
|
16333
17511
|
end
|
16334
17512
|
|
17513
|
+
# @note When making an API call, you may pass StartChangeRequestExecutionRequest
|
17514
|
+
# data as a hash:
|
17515
|
+
#
|
17516
|
+
# {
|
17517
|
+
# scheduled_time: Time.now,
|
17518
|
+
# document_name: "DocumentARN", # required
|
17519
|
+
# document_version: "DocumentVersion",
|
17520
|
+
# parameters: {
|
17521
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
17522
|
+
# },
|
17523
|
+
# change_request_name: "ChangeRequestName",
|
17524
|
+
# client_token: "IdempotencyToken",
|
17525
|
+
# runbooks: [ # required
|
17526
|
+
# {
|
17527
|
+
# document_name: "DocumentARN", # required
|
17528
|
+
# document_version: "DocumentVersion",
|
17529
|
+
# parameters: {
|
17530
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
17531
|
+
# },
|
17532
|
+
# target_parameter_name: "AutomationParameterKey",
|
17533
|
+
# targets: [
|
17534
|
+
# {
|
17535
|
+
# key: "TargetKey",
|
17536
|
+
# values: ["TargetValue"],
|
17537
|
+
# },
|
17538
|
+
# ],
|
17539
|
+
# max_concurrency: "MaxConcurrency",
|
17540
|
+
# max_errors: "MaxErrors",
|
17541
|
+
# target_locations: [
|
17542
|
+
# {
|
17543
|
+
# accounts: ["Account"],
|
17544
|
+
# regions: ["Region"],
|
17545
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
17546
|
+
# target_location_max_errors: "MaxErrors",
|
17547
|
+
# execution_role_name: "ExecutionRoleName",
|
17548
|
+
# },
|
17549
|
+
# ],
|
17550
|
+
# },
|
17551
|
+
# ],
|
17552
|
+
# tags: [
|
17553
|
+
# {
|
17554
|
+
# key: "TagKey", # required
|
17555
|
+
# value: "TagValue", # required
|
17556
|
+
# },
|
17557
|
+
# ],
|
17558
|
+
# }
|
17559
|
+
#
|
17560
|
+
# @!attribute [rw] scheduled_time
|
17561
|
+
# The date and time specified in the change request to run the
|
17562
|
+
# Automation runbooks.
|
17563
|
+
#
|
17564
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
17565
|
+
# run until all required approvals for the change request have been
|
17566
|
+
# received.
|
17567
|
+
#
|
17568
|
+
# </note>
|
17569
|
+
# @return [Time]
|
17570
|
+
#
|
17571
|
+
# @!attribute [rw] document_name
|
17572
|
+
# The name of the change template document to run during the runbook
|
17573
|
+
# workflow.
|
17574
|
+
# @return [String]
|
17575
|
+
#
|
17576
|
+
# @!attribute [rw] document_version
|
17577
|
+
# The version of the change template document to run during the
|
17578
|
+
# runbook workflow.
|
17579
|
+
# @return [String]
|
17580
|
+
#
|
17581
|
+
# @!attribute [rw] parameters
|
17582
|
+
# A key-value map of parameters that match the declared parameters in
|
17583
|
+
# the change template document.
|
17584
|
+
# @return [Hash<String,Array<String>>]
|
17585
|
+
#
|
17586
|
+
# @!attribute [rw] change_request_name
|
17587
|
+
# The name of the change request associated with the runbook workflow
|
17588
|
+
# to be run.
|
17589
|
+
# @return [String]
|
17590
|
+
#
|
17591
|
+
# @!attribute [rw] client_token
|
17592
|
+
# The user-provided idempotency token. The token must be unique, is
|
17593
|
+
# case insensitive, enforces the UUID format, and can't be reused.
|
17594
|
+
# @return [String]
|
17595
|
+
#
|
17596
|
+
# @!attribute [rw] runbooks
|
17597
|
+
# Information about the Automation runbooks (Automation documents)
|
17598
|
+
# that are run during the runbook workflow.
|
17599
|
+
#
|
17600
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
17601
|
+
# run until all required approvals for the change request have been
|
17602
|
+
# received.
|
17603
|
+
#
|
17604
|
+
# </note>
|
17605
|
+
# @return [Array<Types::Runbook>]
|
17606
|
+
#
|
17607
|
+
# @!attribute [rw] tags
|
17608
|
+
# Optional metadata that you assign to a resource. You can specify a
|
17609
|
+
# maximum of five tags for a change request. Tags enable you to
|
17610
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
17611
|
+
# or environment. For example, you might want to tag a change request
|
17612
|
+
# to identify an environment or target AWS Region. In this case, you
|
17613
|
+
# could specify the following key-value pairs:
|
17614
|
+
#
|
17615
|
+
# * `Key=Environment,Value=Production`
|
17616
|
+
#
|
17617
|
+
# * `Key=Region,Value=us-east-2`
|
17618
|
+
# @return [Array<Types::Tag>]
|
17619
|
+
#
|
17620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionRequest AWS API Documentation
|
17621
|
+
#
|
17622
|
+
class StartChangeRequestExecutionRequest < Struct.new(
|
17623
|
+
:scheduled_time,
|
17624
|
+
:document_name,
|
17625
|
+
:document_version,
|
17626
|
+
:parameters,
|
17627
|
+
:change_request_name,
|
17628
|
+
:client_token,
|
17629
|
+
:runbooks,
|
17630
|
+
:tags)
|
17631
|
+
SENSITIVE = []
|
17632
|
+
include Aws::Structure
|
17633
|
+
end
|
17634
|
+
|
17635
|
+
# @!attribute [rw] automation_execution_id
|
17636
|
+
# The unique ID of a runbook workflow operation. (A runbook workflow
|
17637
|
+
# is a type of Automation operation.)
|
17638
|
+
# @return [String]
|
17639
|
+
#
|
17640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionResult AWS API Documentation
|
17641
|
+
#
|
17642
|
+
class StartChangeRequestExecutionResult < Struct.new(
|
17643
|
+
:automation_execution_id)
|
17644
|
+
SENSITIVE = []
|
17645
|
+
include Aws::Structure
|
17646
|
+
end
|
17647
|
+
|
16335
17648
|
# @note When making an API call, you may pass StartSessionRequest
|
16336
17649
|
# data as a hash:
|
16337
17650
|
#
|
@@ -16654,6 +17967,15 @@ module Aws::SSM
|
|
16654
17967
|
# An array of search criteria that targets instances using a Key,Value
|
16655
17968
|
# combination that you specify.
|
16656
17969
|
#
|
17970
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
17971
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
17972
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
17973
|
+
# Step Functions). For more information about running tasks that do not
|
17974
|
+
# specify targets, see see [Registering maintenance window tasks without
|
17975
|
+
# targets][1] in the *AWS Systems Manager User Guide*.
|
17976
|
+
#
|
17977
|
+
# </note>
|
17978
|
+
#
|
16657
17979
|
# Supported formats include the following.
|
16658
17980
|
#
|
16659
17981
|
# * `Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 `
|
@@ -16704,12 +18026,13 @@ module Aws::SSM
|
|
16704
18026
|
# AWS Region where the association was created.
|
16705
18027
|
#
|
16706
18028
|
# For more information about how to send commands that target instances
|
16707
|
-
# using `Key,Value` parameters, see [Targeting multiple instances][
|
18029
|
+
# using `Key,Value` parameters, see [Targeting multiple instances][2] in
|
16708
18030
|
# the *AWS Systems Manager User Guide*.
|
16709
18031
|
#
|
16710
18032
|
#
|
16711
18033
|
#
|
16712
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
18034
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
18035
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting
|
16713
18036
|
#
|
16714
18037
|
# @note When making an API call, you may pass Target
|
16715
18038
|
# data as a hash:
|
@@ -16779,7 +18102,7 @@ module Aws::SSM
|
|
16779
18102
|
#
|
16780
18103
|
# @!attribute [rw] target_location_max_concurrency
|
16781
18104
|
# The maximum number of AWS accounts and AWS regions allowed to run
|
16782
|
-
# the Automation concurrently
|
18105
|
+
# the Automation concurrently.
|
16783
18106
|
# @return [String]
|
16784
18107
|
#
|
16785
18108
|
# @!attribute [rw] target_location_max_errors
|
@@ -16790,7 +18113,8 @@ module Aws::SSM
|
|
16790
18113
|
#
|
16791
18114
|
# @!attribute [rw] execution_role_name
|
16792
18115
|
# The Automation execution role used by the currently running
|
16793
|
-
# Automation.
|
18116
|
+
# Automation. If not specified, the default value is
|
18117
|
+
# `AWS-SystemsManager-AutomationExecutionRole`.
|
16794
18118
|
# @return [String]
|
16795
18119
|
#
|
16796
18120
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/TargetLocation AWS API Documentation
|
@@ -17035,6 +18359,15 @@ module Aws::SSM
|
|
17035
18359
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
17036
18360
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
17037
18361
|
# apply_only_at_cron_interval: false,
|
18362
|
+
# target_locations: [
|
18363
|
+
# {
|
18364
|
+
# accounts: ["Account"],
|
18365
|
+
# regions: ["Region"],
|
18366
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
18367
|
+
# target_location_max_errors: "MaxErrors",
|
18368
|
+
# execution_role_name: "ExecutionRoleName",
|
18369
|
+
# },
|
18370
|
+
# ],
|
17038
18371
|
# }
|
17039
18372
|
#
|
17040
18373
|
# @!attribute [rw] association_id
|
@@ -17159,7 +18492,8 @@ module Aws::SSM
|
|
17159
18492
|
# By default, when you update an association, the system runs it
|
17160
18493
|
# immediately after it is updated and then according to the schedule
|
17161
18494
|
# you specified. Specify this option if you don't want an association
|
17162
|
-
# to run immediately after you update it.
|
18495
|
+
# to run immediately after you update it. This parameter is not
|
18496
|
+
# supported for rate expressions.
|
17163
18497
|
#
|
17164
18498
|
# Also, if you specified this option when you created the association,
|
17165
18499
|
# you can reset it. To do so, specify the
|
@@ -17169,6 +18503,12 @@ module Aws::SSM
|
|
17169
18503
|
# the interval specified.
|
17170
18504
|
# @return [Boolean]
|
17171
18505
|
#
|
18506
|
+
# @!attribute [rw] target_locations
|
18507
|
+
# A location is a combination of AWS Regions and AWS accounts where
|
18508
|
+
# you want to run the association. Use this action to update an
|
18509
|
+
# association in multiple Regions and multiple accounts.
|
18510
|
+
# @return [Array<Types::TargetLocation>]
|
18511
|
+
#
|
17172
18512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationRequest AWS API Documentation
|
17173
18513
|
#
|
17174
18514
|
class UpdateAssociationRequest < Struct.new(
|
@@ -17186,7 +18526,8 @@ module Aws::SSM
|
|
17186
18526
|
:max_concurrency,
|
17187
18527
|
:compliance_severity,
|
17188
18528
|
:sync_compliance,
|
17189
|
-
:apply_only_at_cron_interval
|
18529
|
+
:apply_only_at_cron_interval,
|
18530
|
+
:target_locations)
|
17190
18531
|
SENSITIVE = []
|
17191
18532
|
include Aws::Structure
|
17192
18533
|
end
|
@@ -17291,6 +18632,49 @@ module Aws::SSM
|
|
17291
18632
|
include Aws::Structure
|
17292
18633
|
end
|
17293
18634
|
|
18635
|
+
# @note When making an API call, you may pass UpdateDocumentMetadataRequest
|
18636
|
+
# data as a hash:
|
18637
|
+
#
|
18638
|
+
# {
|
18639
|
+
# name: "DocumentName", # required
|
18640
|
+
# document_version: "DocumentVersion",
|
18641
|
+
# document_reviews: { # required
|
18642
|
+
# action: "SendForReview", # required, accepts SendForReview, UpdateReview, Approve, Reject
|
18643
|
+
# comment: [
|
18644
|
+
# {
|
18645
|
+
# type: "Comment", # accepts Comment
|
18646
|
+
# content: "DocumentReviewComment",
|
18647
|
+
# },
|
18648
|
+
# ],
|
18649
|
+
# },
|
18650
|
+
# }
|
18651
|
+
#
|
18652
|
+
# @!attribute [rw] name
|
18653
|
+
# The name of the document for which a version is to be updated.
|
18654
|
+
# @return [String]
|
18655
|
+
#
|
18656
|
+
# @!attribute [rw] document_version
|
18657
|
+
# The version of a document to update.
|
18658
|
+
# @return [String]
|
18659
|
+
#
|
18660
|
+
# @!attribute [rw] document_reviews
|
18661
|
+
# The document review details to update.
|
18662
|
+
# @return [Types::DocumentReviews]
|
18663
|
+
#
|
18664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataRequest AWS API Documentation
|
18665
|
+
#
|
18666
|
+
class UpdateDocumentMetadataRequest < Struct.new(
|
18667
|
+
:name,
|
18668
|
+
:document_version,
|
18669
|
+
:document_reviews)
|
18670
|
+
SENSITIVE = []
|
18671
|
+
include Aws::Structure
|
18672
|
+
end
|
18673
|
+
|
18674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataResponse AWS API Documentation
|
18675
|
+
#
|
18676
|
+
class UpdateDocumentMetadataResponse < Aws::EmptyStructure; end
|
18677
|
+
|
17294
18678
|
# @note When making an API call, you may pass UpdateDocumentRequest
|
17295
18679
|
# data as a hash:
|
17296
18680
|
#
|
@@ -17407,8 +18791,8 @@ module Aws::SSM
|
|
17407
18791
|
# @!attribute [rw] start_date
|
17408
18792
|
# The time zone that the scheduled maintenance window executions are
|
17409
18793
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17410
|
-
# example: "America/Los\_Angeles", "
|
17411
|
-
#
|
18794
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18795
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17412
18796
|
# website.
|
17413
18797
|
#
|
17414
18798
|
#
|
@@ -17431,8 +18815,8 @@ module Aws::SSM
|
|
17431
18815
|
# @!attribute [rw] schedule_timezone
|
17432
18816
|
# The time zone that the scheduled maintenance window executions are
|
17433
18817
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17434
|
-
# example: "America/Los\_Angeles", "
|
17435
|
-
#
|
18818
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18819
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17436
18820
|
# website.
|
17437
18821
|
#
|
17438
18822
|
#
|
@@ -17447,7 +18831,7 @@ module Aws::SSM
|
|
17447
18831
|
# For example, the following cron expression schedules a maintenance
|
17448
18832
|
# window to run the third Tuesday of every month at 11:30 PM.
|
17449
18833
|
#
|
17450
|
-
# `cron(
|
18834
|
+
# `cron(30 23 ? * TUE#3 *)`
|
17451
18835
|
#
|
17452
18836
|
# If the schedule offset is `2`, the maintenance window won't run
|
17453
18837
|
# until two days later.
|
@@ -17529,8 +18913,8 @@ module Aws::SSM
|
|
17529
18913
|
# @!attribute [rw] schedule_timezone
|
17530
18914
|
# The time zone that the scheduled maintenance window executions are
|
17531
18915
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17532
|
-
# example: "America/Los\_Angeles", "
|
17533
|
-
#
|
18916
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18917
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17534
18918
|
# website.
|
17535
18919
|
#
|
17536
18920
|
#
|
@@ -17765,6 +19149,19 @@ module Aws::SSM
|
|
17765
19149
|
# The targets (either instances or tags) to modify. Instances are
|
17766
19150
|
# specified using Key=instanceids,Values=instanceID\_1,instanceID\_2.
|
17767
19151
|
# Tags are specified using Key=tag\_name,Values=tag\_value.
|
19152
|
+
#
|
19153
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
19154
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
19155
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
19156
|
+
# Step Functions). For more information about running tasks that do
|
19157
|
+
# not specify targets, see see [Registering maintenance window tasks
|
19158
|
+
# without targets][1] in the *AWS Systems Manager User Guide*.
|
19159
|
+
#
|
19160
|
+
# </note>
|
19161
|
+
#
|
19162
|
+
#
|
19163
|
+
#
|
19164
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
17768
19165
|
# @return [Array<Types::Target>]
|
17769
19166
|
#
|
17770
19167
|
# @!attribute [rw] task_arn
|
@@ -17839,12 +19236,28 @@ module Aws::SSM
|
|
17839
19236
|
# The new `MaxConcurrency` value you want to specify. `MaxConcurrency`
|
17840
19237
|
# is the number of targets that are allowed to run this task in
|
17841
19238
|
# parallel.
|
19239
|
+
#
|
19240
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
19241
|
+
# supply a value for this option. Instead, the system inserts a
|
19242
|
+
# placeholder value of `1`, which may be reported in the response to
|
19243
|
+
# this command. This value does not affect the running of your task
|
19244
|
+
# and can be ignored.
|
19245
|
+
#
|
19246
|
+
# </note>
|
17842
19247
|
# @return [String]
|
17843
19248
|
#
|
17844
19249
|
# @!attribute [rw] max_errors
|
17845
19250
|
# The new `MaxErrors` value to specify. `MaxErrors` is the maximum
|
17846
19251
|
# number of errors that are allowed before the task stops being
|
17847
19252
|
# scheduled.
|
19253
|
+
#
|
19254
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
19255
|
+
# supply a value for this option. Instead, the system inserts a
|
19256
|
+
# placeholder value of `1`, which may be reported in the response to
|
19257
|
+
# this command. This value does not affect the running of your task
|
19258
|
+
# and can be ignored.
|
19259
|
+
#
|
19260
|
+
# </note>
|
17848
19261
|
# @return [String]
|
17849
19262
|
#
|
17850
19263
|
# @!attribute [rw] logging_info
|
@@ -18038,11 +19451,15 @@ module Aws::SSM
|
|
18038
19451
|
# ops_item_id: "String", # required
|
18039
19452
|
# },
|
18040
19453
|
# ],
|
18041
|
-
# status: "Open", # accepts Open, InProgress, Resolved
|
19454
|
+
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
|
18042
19455
|
# ops_item_id: "OpsItemId", # required
|
18043
19456
|
# title: "OpsItemTitle",
|
18044
19457
|
# category: "OpsItemCategory",
|
18045
19458
|
# severity: "OpsItemSeverity",
|
19459
|
+
# actual_start_time: Time.now,
|
19460
|
+
# actual_end_time: Time.now,
|
19461
|
+
# planned_start_time: Time.now,
|
19462
|
+
# planned_end_time: Time.now,
|
18046
19463
|
# }
|
18047
19464
|
#
|
18048
19465
|
# @!attribute [rw] description
|
@@ -18132,6 +19549,28 @@ module Aws::SSM
|
|
18132
19549
|
# Specify a new severity for an OpsItem.
|
18133
19550
|
# @return [String]
|
18134
19551
|
#
|
19552
|
+
# @!attribute [rw] actual_start_time
|
19553
|
+
# The time a runbook workflow started. Currently reported only for the
|
19554
|
+
# OpsItem type `/aws/changerequest`.
|
19555
|
+
# @return [Time]
|
19556
|
+
#
|
19557
|
+
# @!attribute [rw] actual_end_time
|
19558
|
+
# The time a runbook workflow ended. Currently reported only for the
|
19559
|
+
# OpsItem type `/aws/changerequest`.
|
19560
|
+
# @return [Time]
|
19561
|
+
#
|
19562
|
+
# @!attribute [rw] planned_start_time
|
19563
|
+
# The time specified in a change request for a runbook workflow to
|
19564
|
+
# start. Currently supported only for the OpsItem type
|
19565
|
+
# `/aws/changerequest`.
|
19566
|
+
# @return [Time]
|
19567
|
+
#
|
19568
|
+
# @!attribute [rw] planned_end_time
|
19569
|
+
# The time specified in a change request for a runbook workflow to
|
19570
|
+
# end. Currently supported only for the OpsItem type
|
19571
|
+
# `/aws/changerequest`.
|
19572
|
+
# @return [Time]
|
19573
|
+
#
|
18135
19574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItemRequest AWS API Documentation
|
18136
19575
|
#
|
18137
19576
|
class UpdateOpsItemRequest < Struct.new(
|
@@ -18145,7 +19584,11 @@ module Aws::SSM
|
|
18145
19584
|
:ops_item_id,
|
18146
19585
|
:title,
|
18147
19586
|
:category,
|
18148
|
-
:severity
|
19587
|
+
:severity,
|
19588
|
+
:actual_start_time,
|
19589
|
+
:actual_end_time,
|
19590
|
+
:planned_start_time,
|
19591
|
+
:planned_end_time)
|
18149
19592
|
SENSITIVE = []
|
18150
19593
|
include Aws::Structure
|
18151
19594
|
end
|
@@ -18154,6 +19597,54 @@ module Aws::SSM
|
|
18154
19597
|
#
|
18155
19598
|
class UpdateOpsItemResponse < Aws::EmptyStructure; end
|
18156
19599
|
|
19600
|
+
# @note When making an API call, you may pass UpdateOpsMetadataRequest
|
19601
|
+
# data as a hash:
|
19602
|
+
#
|
19603
|
+
# {
|
19604
|
+
# ops_metadata_arn: "OpsMetadataArn", # required
|
19605
|
+
# metadata_to_update: {
|
19606
|
+
# "MetadataKey" => {
|
19607
|
+
# value: "MetadataValueString",
|
19608
|
+
# },
|
19609
|
+
# },
|
19610
|
+
# keys_to_delete: ["MetadataKey"],
|
19611
|
+
# }
|
19612
|
+
#
|
19613
|
+
# @!attribute [rw] ops_metadata_arn
|
19614
|
+
# The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
|
19615
|
+
# @return [String]
|
19616
|
+
#
|
19617
|
+
# @!attribute [rw] metadata_to_update
|
19618
|
+
# Metadata to add to an OpsMetadata object.
|
19619
|
+
# @return [Hash<String,Types::MetadataValue>]
|
19620
|
+
#
|
19621
|
+
# @!attribute [rw] keys_to_delete
|
19622
|
+
# The metadata keys to delete from the OpsMetadata object.
|
19623
|
+
# @return [Array<String>]
|
19624
|
+
#
|
19625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsMetadataRequest AWS API Documentation
|
19626
|
+
#
|
19627
|
+
class UpdateOpsMetadataRequest < Struct.new(
|
19628
|
+
:ops_metadata_arn,
|
19629
|
+
:metadata_to_update,
|
19630
|
+
:keys_to_delete)
|
19631
|
+
SENSITIVE = []
|
19632
|
+
include Aws::Structure
|
19633
|
+
end
|
19634
|
+
|
19635
|
+
# @!attribute [rw] ops_metadata_arn
|
19636
|
+
# The Amazon Resource Name (ARN) of the OpsMetadata Object that was
|
19637
|
+
# updated.
|
19638
|
+
# @return [String]
|
19639
|
+
#
|
19640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsMetadataResult AWS API Documentation
|
19641
|
+
#
|
19642
|
+
class UpdateOpsMetadataResult < Struct.new(
|
19643
|
+
:ops_metadata_arn)
|
19644
|
+
SENSITIVE = []
|
19645
|
+
include Aws::Structure
|
19646
|
+
end
|
19647
|
+
|
18157
19648
|
# @note When making an API call, you may pass UpdatePatchBaselineRequest
|
18158
19649
|
# data as a hash:
|
18159
19650
|
#
|