aws-sdk-ssm 1.99.0 → 1.104.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +680 -45
- data/lib/aws-sdk-ssm/client_api.rb +266 -3
- data/lib/aws-sdk-ssm/errors.rb +16 -0
- data/lib/aws-sdk-ssm/types.rb +1241 -100
- metadata +4 -4
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}
|
@@ -243,6 +244,21 @@ module Aws::SSM
|
|
243
244
|
end
|
244
245
|
end
|
245
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
|
+
|
246
262
|
class AutomationDefinitionNotFoundException < ServiceError
|
247
263
|
|
248
264
|
# @param [Seahorse::Client::RequestContext] context
|
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -388,6 +388,11 @@ module Aws::SSM
|
|
388
388
|
# supported for rate expressions.
|
389
389
|
# @return [Boolean]
|
390
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
|
+
#
|
391
396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationDescription AWS API Documentation
|
392
397
|
#
|
393
398
|
class AssociationDescription < Struct.new(
|
@@ -412,7 +417,8 @@ module Aws::SSM
|
|
412
417
|
:max_concurrency,
|
413
418
|
:compliance_severity,
|
414
419
|
:sync_compliance,
|
415
|
-
:apply_only_at_cron_interval
|
420
|
+
:apply_only_at_cron_interval,
|
421
|
+
:target_locations)
|
416
422
|
SENSITIVE = []
|
417
423
|
include Aws::Structure
|
418
424
|
end
|
@@ -819,6 +825,11 @@ module Aws::SSM
|
|
819
825
|
# supported for rate expressions.
|
820
826
|
# @return [Boolean]
|
821
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
|
+
#
|
822
833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationVersionInfo AWS API Documentation
|
823
834
|
#
|
824
835
|
class AssociationVersionInfo < Struct.new(
|
@@ -836,7 +847,8 @@ module Aws::SSM
|
|
836
847
|
:max_concurrency,
|
837
848
|
:compliance_severity,
|
838
849
|
:sync_compliance,
|
839
|
-
:apply_only_at_cron_interval
|
850
|
+
:apply_only_at_cron_interval,
|
851
|
+
:target_locations)
|
840
852
|
SENSITIVE = []
|
841
853
|
include Aws::Structure
|
842
854
|
end
|
@@ -967,6 +979,20 @@ module Aws::SSM
|
|
967
979
|
include Aws::Structure
|
968
980
|
end
|
969
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
|
+
|
970
996
|
# An Automation document with the specified name could not be found.
|
971
997
|
#
|
972
998
|
# @!attribute [rw] message
|
@@ -1109,6 +1135,40 @@ module Aws::SSM
|
|
1109
1135
|
# for a multi-Region and multi-account Automation execution.
|
1110
1136
|
# @return [Types::ProgressCounters]
|
1111
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
|
+
#
|
1112
1172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecution AWS API Documentation
|
1113
1173
|
#
|
1114
1174
|
class AutomationExecution < Struct.new(
|
@@ -1136,7 +1196,13 @@ module Aws::SSM
|
|
1136
1196
|
:max_errors,
|
1137
1197
|
:target,
|
1138
1198
|
:target_locations,
|
1139
|
-
:progress_counters
|
1199
|
+
:progress_counters,
|
1200
|
+
:automation_subtype,
|
1201
|
+
:scheduled_time,
|
1202
|
+
:runbooks,
|
1203
|
+
:ops_item_id,
|
1204
|
+
:association_id,
|
1205
|
+
:change_request_name)
|
1140
1206
|
SENSITIVE = []
|
1141
1207
|
include Aws::Structure
|
1142
1208
|
end
|
@@ -1148,15 +1214,12 @@ module Aws::SSM
|
|
1148
1214
|
# data as a hash:
|
1149
1215
|
#
|
1150
1216
|
# {
|
1151
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup
|
1217
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
|
1152
1218
|
# values: ["AutomationExecutionFilterValue"], # required
|
1153
1219
|
# }
|
1154
1220
|
#
|
1155
1221
|
# @!attribute [rw] key
|
1156
|
-
# One or more keys to limit the results.
|
1157
|
-
# following: DocumentNamePrefix, ExecutionStatus, ExecutionId,
|
1158
|
-
# ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter,
|
1159
|
-
# TargetResourceGroup.
|
1222
|
+
# One or more keys to limit the results.
|
1160
1223
|
# @return [String]
|
1161
1224
|
#
|
1162
1225
|
# @!attribute [rw] values
|
@@ -1289,6 +1352,40 @@ module Aws::SSM
|
|
1289
1352
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html
|
1290
1353
|
# @return [String]
|
1291
1354
|
#
|
1355
|
+
# @!attribute [rw] automation_subtype
|
1356
|
+
# The subtype of the Automation operation. Currently, the only
|
1357
|
+
# supported value is `ChangeRequest`.
|
1358
|
+
# @return [String]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] scheduled_time
|
1361
|
+
# The date and time the Automation operation is scheduled to start.
|
1362
|
+
# @return [Time]
|
1363
|
+
#
|
1364
|
+
# @!attribute [rw] runbooks
|
1365
|
+
# Information about the Automation runbooks (Automation documents)
|
1366
|
+
# that are run during a runbook workflow in Change Manager.
|
1367
|
+
#
|
1368
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
1369
|
+
# run until all required approvals for the change request have been
|
1370
|
+
# received.
|
1371
|
+
#
|
1372
|
+
# </note>
|
1373
|
+
# @return [Array<Types::Runbook>]
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] ops_item_id
|
1376
|
+
# The ID of an OpsItem that is created to represent a Change Manager
|
1377
|
+
# change request.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] association_id
|
1381
|
+
# The ID of a State Manager association used in the Automation
|
1382
|
+
# operation.
|
1383
|
+
# @return [String]
|
1384
|
+
#
|
1385
|
+
# @!attribute [rw] change_request_name
|
1386
|
+
# The name of the Change Manager change request.
|
1387
|
+
# @return [String]
|
1388
|
+
#
|
1292
1389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecutionMetadata AWS API Documentation
|
1293
1390
|
#
|
1294
1391
|
class AutomationExecutionMetadata < Struct.new(
|
@@ -1313,7 +1410,13 @@ module Aws::SSM
|
|
1313
1410
|
:max_concurrency,
|
1314
1411
|
:max_errors,
|
1315
1412
|
:target,
|
1316
|
-
:automation_type
|
1413
|
+
:automation_type,
|
1414
|
+
:automation_subtype,
|
1415
|
+
:scheduled_time,
|
1416
|
+
:runbooks,
|
1417
|
+
:ops_item_id,
|
1418
|
+
:association_id,
|
1419
|
+
:change_request_name)
|
1317
1420
|
SENSITIVE = []
|
1318
1421
|
include Aws::Structure
|
1319
1422
|
end
|
@@ -2434,6 +2537,15 @@ module Aws::SSM
|
|
2434
2537
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2435
2538
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2436
2539
|
# apply_only_at_cron_interval: false,
|
2540
|
+
# target_locations: [
|
2541
|
+
# {
|
2542
|
+
# accounts: ["Account"],
|
2543
|
+
# regions: ["Region"],
|
2544
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
2545
|
+
# target_location_max_errors: "MaxErrors",
|
2546
|
+
# execution_role_name: "ExecutionRoleName",
|
2547
|
+
# },
|
2548
|
+
# ],
|
2437
2549
|
# },
|
2438
2550
|
# ],
|
2439
2551
|
# }
|
@@ -2484,6 +2596,15 @@ module Aws::SSM
|
|
2484
2596
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2485
2597
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2486
2598
|
# apply_only_at_cron_interval: false,
|
2599
|
+
# target_locations: [
|
2600
|
+
# {
|
2601
|
+
# accounts: ["Account"],
|
2602
|
+
# regions: ["Region"],
|
2603
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
2604
|
+
# target_location_max_errors: "MaxErrors",
|
2605
|
+
# execution_role_name: "ExecutionRoleName",
|
2606
|
+
# },
|
2607
|
+
# ],
|
2487
2608
|
# }
|
2488
2609
|
#
|
2489
2610
|
# @!attribute [rw] name
|
@@ -2603,6 +2724,11 @@ module Aws::SSM
|
|
2603
2724
|
# supported for rate expressions.
|
2604
2725
|
# @return [Boolean]
|
2605
2726
|
#
|
2727
|
+
# @!attribute [rw] target_locations
|
2728
|
+
# Use this action to create an association in multiple Regions and
|
2729
|
+
# multiple accounts.
|
2730
|
+
# @return [Array<Types::TargetLocation>]
|
2731
|
+
#
|
2606
2732
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationBatchRequestEntry AWS API Documentation
|
2607
2733
|
#
|
2608
2734
|
class CreateAssociationBatchRequestEntry < Struct.new(
|
@@ -2619,7 +2745,8 @@ module Aws::SSM
|
|
2619
2745
|
:max_concurrency,
|
2620
2746
|
:compliance_severity,
|
2621
2747
|
:sync_compliance,
|
2622
|
-
:apply_only_at_cron_interval
|
2748
|
+
:apply_only_at_cron_interval,
|
2749
|
+
:target_locations)
|
2623
2750
|
SENSITIVE = []
|
2624
2751
|
include Aws::Structure
|
2625
2752
|
end
|
@@ -2672,6 +2799,15 @@ module Aws::SSM
|
|
2672
2799
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2673
2800
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2674
2801
|
# apply_only_at_cron_interval: false,
|
2802
|
+
# target_locations: [
|
2803
|
+
# {
|
2804
|
+
# accounts: ["Account"],
|
2805
|
+
# regions: ["Region"],
|
2806
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
2807
|
+
# target_location_max_errors: "MaxErrors",
|
2808
|
+
# execution_role_name: "ExecutionRoleName",
|
2809
|
+
# },
|
2810
|
+
# ],
|
2675
2811
|
# }
|
2676
2812
|
#
|
2677
2813
|
# @!attribute [rw] name
|
@@ -2812,6 +2948,12 @@ module Aws::SSM
|
|
2812
2948
|
# supported for rate expressions.
|
2813
2949
|
# @return [Boolean]
|
2814
2950
|
#
|
2951
|
+
# @!attribute [rw] target_locations
|
2952
|
+
# A location is a combination of AWS Regions and AWS accounts where
|
2953
|
+
# you want to run the association. Use this action to create an
|
2954
|
+
# association in multiple Regions and multiple accounts.
|
2955
|
+
# @return [Array<Types::TargetLocation>]
|
2956
|
+
#
|
2815
2957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationRequest AWS API Documentation
|
2816
2958
|
#
|
2817
2959
|
class CreateAssociationRequest < Struct.new(
|
@@ -2828,7 +2970,8 @@ module Aws::SSM
|
|
2828
2970
|
:max_concurrency,
|
2829
2971
|
:compliance_severity,
|
2830
2972
|
:sync_compliance,
|
2831
|
-
:apply_only_at_cron_interval
|
2973
|
+
:apply_only_at_cron_interval,
|
2974
|
+
:target_locations)
|
2832
2975
|
SENSITIVE = []
|
2833
2976
|
include Aws::Structure
|
2834
2977
|
end
|
@@ -2865,7 +3008,7 @@ module Aws::SSM
|
|
2865
3008
|
# ],
|
2866
3009
|
# name: "DocumentName", # required
|
2867
3010
|
# version_name: "DocumentVersionName",
|
2868
|
-
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar
|
3011
|
+
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate
|
2869
3012
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
2870
3013
|
# target_type: "TargetType",
|
2871
3014
|
# tags: [
|
@@ -3060,8 +3203,8 @@ module Aws::SSM
|
|
3060
3203
|
# @!attribute [rw] schedule_timezone
|
3061
3204
|
# The time zone that the scheduled maintenance window executions are
|
3062
3205
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
3063
|
-
# example: "America/Los\_Angeles", "
|
3064
|
-
#
|
3206
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
3207
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
3065
3208
|
# website.
|
3066
3209
|
#
|
3067
3210
|
#
|
@@ -3076,7 +3219,7 @@ module Aws::SSM
|
|
3076
3219
|
# For example, the following cron expression schedules a maintenance
|
3077
3220
|
# window to run on the third Tuesday of every month at 11:30 PM.
|
3078
3221
|
#
|
3079
|
-
# `cron(
|
3222
|
+
# `cron(30 23 ? * TUE#3 *)`
|
3080
3223
|
#
|
3081
3224
|
# If the schedule offset is `2`, the maintenance window won't run
|
3082
3225
|
# until two days later.
|
@@ -3165,6 +3308,7 @@ module Aws::SSM
|
|
3165
3308
|
#
|
3166
3309
|
# {
|
3167
3310
|
# description: "OpsItemDescription", # required
|
3311
|
+
# ops_item_type: "OpsItemType",
|
3168
3312
|
# operational_data: {
|
3169
3313
|
# "OpsItemDataKey" => {
|
3170
3314
|
# value: "OpsItemDataValueString",
|
@@ -3192,12 +3336,21 @@ module Aws::SSM
|
|
3192
3336
|
# ],
|
3193
3337
|
# category: "OpsItemCategory",
|
3194
3338
|
# severity: "OpsItemSeverity",
|
3339
|
+
# actual_start_time: Time.now,
|
3340
|
+
# actual_end_time: Time.now,
|
3341
|
+
# planned_start_time: Time.now,
|
3342
|
+
# planned_end_time: Time.now,
|
3195
3343
|
# }
|
3196
3344
|
#
|
3197
3345
|
# @!attribute [rw] description
|
3198
3346
|
# Information about the OpsItem.
|
3199
3347
|
# @return [String]
|
3200
3348
|
#
|
3349
|
+
# @!attribute [rw] ops_item_type
|
3350
|
+
# The type of OpsItem to create. Currently, the only valid values are
|
3351
|
+
# `/aws/changerequest` and `/aws/issue`.
|
3352
|
+
# @return [String]
|
3353
|
+
#
|
3201
3354
|
# @!attribute [rw] operational_data
|
3202
3355
|
# Operational data is custom data that provides useful reference
|
3203
3356
|
# details about the OpsItem. For example, you can specify log files,
|
@@ -3287,10 +3440,33 @@ module Aws::SSM
|
|
3287
3440
|
# Specify a severity to assign to an OpsItem.
|
3288
3441
|
# @return [String]
|
3289
3442
|
#
|
3443
|
+
# @!attribute [rw] actual_start_time
|
3444
|
+
# The time a runbook workflow started. Currently reported only for the
|
3445
|
+
# OpsItem type `/aws/changerequest`.
|
3446
|
+
# @return [Time]
|
3447
|
+
#
|
3448
|
+
# @!attribute [rw] actual_end_time
|
3449
|
+
# The time a runbook workflow ended. Currently reported only for the
|
3450
|
+
# OpsItem type `/aws/changerequest`.
|
3451
|
+
# @return [Time]
|
3452
|
+
#
|
3453
|
+
# @!attribute [rw] planned_start_time
|
3454
|
+
# The time specified in a change request for a runbook workflow to
|
3455
|
+
# start. Currently supported only for the OpsItem type
|
3456
|
+
# `/aws/changerequest`.
|
3457
|
+
# @return [Time]
|
3458
|
+
#
|
3459
|
+
# @!attribute [rw] planned_end_time
|
3460
|
+
# The time specified in a change request for a runbook workflow to
|
3461
|
+
# end. Currently supported only for the OpsItem type
|
3462
|
+
# `/aws/changerequest`.
|
3463
|
+
# @return [Time]
|
3464
|
+
#
|
3290
3465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItemRequest AWS API Documentation
|
3291
3466
|
#
|
3292
3467
|
class CreateOpsItemRequest < Struct.new(
|
3293
3468
|
:description,
|
3469
|
+
:ops_item_type,
|
3294
3470
|
:operational_data,
|
3295
3471
|
:notifications,
|
3296
3472
|
:priority,
|
@@ -3299,7 +3475,11 @@ module Aws::SSM
|
|
3299
3475
|
:title,
|
3300
3476
|
:tags,
|
3301
3477
|
:category,
|
3302
|
-
:severity
|
3478
|
+
:severity,
|
3479
|
+
:actual_start_time,
|
3480
|
+
:actual_end_time,
|
3481
|
+
:planned_start_time,
|
3482
|
+
:planned_end_time)
|
3303
3483
|
SENSITIVE = []
|
3304
3484
|
include Aws::Structure
|
3305
3485
|
end
|
@@ -3329,11 +3509,11 @@ module Aws::SSM
|
|
3329
3509
|
# }
|
3330
3510
|
#
|
3331
3511
|
# @!attribute [rw] resource_id
|
3332
|
-
# A resource ID for a new
|
3512
|
+
# A resource ID for a new Application Manager application.
|
3333
3513
|
# @return [String]
|
3334
3514
|
#
|
3335
3515
|
# @!attribute [rw] metadata
|
3336
|
-
# Metadata for a new
|
3516
|
+
# Metadata for a new Application Manager application.
|
3337
3517
|
# @return [Hash<String,Types::MetadataValue>]
|
3338
3518
|
#
|
3339
3519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsMetadataRequest AWS API Documentation
|
@@ -4453,7 +4633,7 @@ module Aws::SSM
|
|
4453
4633
|
# {
|
4454
4634
|
# filters: [
|
4455
4635
|
# {
|
4456
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup
|
4636
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
|
4457
4637
|
# values: ["AutomationExecutionFilterValue"], # required
|
4458
4638
|
# },
|
4459
4639
|
# ],
|
@@ -4639,6 +4819,8 @@ module Aws::SSM
|
|
4639
4819
|
# {
|
4640
4820
|
# name: "DocumentName", # required
|
4641
4821
|
# permission_type: "Share", # required, accepts Share
|
4822
|
+
# max_results: 1,
|
4823
|
+
# next_token: "NextToken",
|
4642
4824
|
# }
|
4643
4825
|
#
|
4644
4826
|
# @!attribute [rw] name
|
@@ -4650,11 +4832,24 @@ module Aws::SSM
|
|
4650
4832
|
# *Share*.
|
4651
4833
|
# @return [String]
|
4652
4834
|
#
|
4835
|
+
# @!attribute [rw] max_results
|
4836
|
+
# The maximum number of items to return for this call. The call also
|
4837
|
+
# returns a token that you can specify in a subsequent call to get the
|
4838
|
+
# next set of results.
|
4839
|
+
# @return [Integer]
|
4840
|
+
#
|
4841
|
+
# @!attribute [rw] next_token
|
4842
|
+
# The token for the next set of items to return. (You received this
|
4843
|
+
# token from a previous call.)
|
4844
|
+
# @return [String]
|
4845
|
+
#
|
4653
4846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocumentPermissionRequest AWS API Documentation
|
4654
4847
|
#
|
4655
4848
|
class DescribeDocumentPermissionRequest < Struct.new(
|
4656
4849
|
:name,
|
4657
|
-
:permission_type
|
4850
|
+
:permission_type,
|
4851
|
+
:max_results,
|
4852
|
+
:next_token)
|
4658
4853
|
SENSITIVE = []
|
4659
4854
|
include Aws::Structure
|
4660
4855
|
end
|
@@ -4669,11 +4864,17 @@ module Aws::SSM
|
|
4669
4864
|
# version shared with each account.
|
4670
4865
|
# @return [Array<Types::AccountSharingInfo>]
|
4671
4866
|
#
|
4867
|
+
# @!attribute [rw] next_token
|
4868
|
+
# The token for the next set of items to return. Use this token to get
|
4869
|
+
# the next set of results.
|
4870
|
+
# @return [String]
|
4871
|
+
#
|
4672
4872
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocumentPermissionResponse AWS API Documentation
|
4673
4873
|
#
|
4674
4874
|
class DescribeDocumentPermissionResponse < Struct.new(
|
4675
4875
|
:account_ids,
|
4676
|
-
:account_sharing_info_list
|
4876
|
+
:account_sharing_info_list,
|
4877
|
+
:next_token)
|
4677
4878
|
SENSITIVE = []
|
4678
4879
|
include Aws::Structure
|
4679
4880
|
end
|
@@ -5764,7 +5965,7 @@ module Aws::SSM
|
|
5764
5965
|
# {
|
5765
5966
|
# ops_item_filters: [
|
5766
5967
|
# {
|
5767
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity
|
5968
|
+
# 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
|
5768
5969
|
# values: ["OpsItemFilterValue"], # required
|
5769
5970
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
5770
5971
|
# },
|
@@ -6448,6 +6649,27 @@ module Aws::SSM
|
|
6448
6649
|
# `ApplicationConfigurationSchema` document.
|
6449
6650
|
# @return [Array<Types::DocumentRequires>]
|
6450
6651
|
#
|
6652
|
+
# @!attribute [rw] author
|
6653
|
+
# The user in your organization who created the document.
|
6654
|
+
# @return [String]
|
6655
|
+
#
|
6656
|
+
# @!attribute [rw] review_information
|
6657
|
+
# Details about the review of a document.
|
6658
|
+
# @return [Array<Types::ReviewInformation>]
|
6659
|
+
#
|
6660
|
+
# @!attribute [rw] approved_version
|
6661
|
+
# The version of the document currently approved for use in the
|
6662
|
+
# organization.
|
6663
|
+
# @return [String]
|
6664
|
+
#
|
6665
|
+
# @!attribute [rw] pending_review_version
|
6666
|
+
# The version of the document that is currently under review.
|
6667
|
+
# @return [String]
|
6668
|
+
#
|
6669
|
+
# @!attribute [rw] review_status
|
6670
|
+
# The current status of the review.
|
6671
|
+
# @return [String]
|
6672
|
+
#
|
6451
6673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentDescription AWS API Documentation
|
6452
6674
|
#
|
6453
6675
|
class DocumentDescription < Struct.new(
|
@@ -6472,7 +6694,12 @@ module Aws::SSM
|
|
6472
6694
|
:target_type,
|
6473
6695
|
:tags,
|
6474
6696
|
:attachments_information,
|
6475
|
-
:requires
|
6697
|
+
:requires,
|
6698
|
+
:author,
|
6699
|
+
:review_information,
|
6700
|
+
:approved_version,
|
6701
|
+
:pending_review_version,
|
6702
|
+
:review_status)
|
6476
6703
|
SENSITIVE = []
|
6477
6704
|
include Aws::Structure
|
6478
6705
|
end
|
@@ -6561,6 +6788,14 @@ module Aws::SSM
|
|
6561
6788
|
# `ApplicationConfigurationSchema` document.
|
6562
6789
|
# @return [Array<Types::DocumentRequires>]
|
6563
6790
|
#
|
6791
|
+
# @!attribute [rw] review_status
|
6792
|
+
# The current status of a document review.
|
6793
|
+
# @return [String]
|
6794
|
+
#
|
6795
|
+
# @!attribute [rw] author
|
6796
|
+
# The user in your organization who created the document.
|
6797
|
+
# @return [String]
|
6798
|
+
#
|
6564
6799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentIdentifier AWS API Documentation
|
6565
6800
|
#
|
6566
6801
|
class DocumentIdentifier < Struct.new(
|
@@ -6574,7 +6809,9 @@ module Aws::SSM
|
|
6574
6809
|
:document_format,
|
6575
6810
|
:target_type,
|
6576
6811
|
:tags,
|
6577
|
-
:requires
|
6812
|
+
:requires,
|
6813
|
+
:review_status,
|
6814
|
+
:author)
|
6578
6815
|
SENSITIVE = []
|
6579
6816
|
include Aws::Structure
|
6580
6817
|
end
|
@@ -6695,6 +6932,20 @@ module Aws::SSM
|
|
6695
6932
|
include Aws::Structure
|
6696
6933
|
end
|
6697
6934
|
|
6935
|
+
# Details about the response to a document review request.
|
6936
|
+
#
|
6937
|
+
# @!attribute [rw] reviewer_response
|
6938
|
+
# Details about a reviewer's response to a document review request.
|
6939
|
+
# @return [Array<Types::DocumentReviewerResponseSource>]
|
6940
|
+
#
|
6941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentMetadataResponseInfo AWS API Documentation
|
6942
|
+
#
|
6943
|
+
class DocumentMetadataResponseInfo < Struct.new(
|
6944
|
+
:reviewer_response)
|
6945
|
+
SENSITIVE = []
|
6946
|
+
include Aws::Structure
|
6947
|
+
end
|
6948
|
+
|
6698
6949
|
# Parameters specified in a System Manager document that run on the
|
6699
6950
|
# server when the command is run.
|
6700
6951
|
#
|
@@ -6772,6 +7023,114 @@ module Aws::SSM
|
|
6772
7023
|
include Aws::Structure
|
6773
7024
|
end
|
6774
7025
|
|
7026
|
+
# Information about comments added to a document review request.
|
7027
|
+
#
|
7028
|
+
# @note When making an API call, you may pass DocumentReviewCommentSource
|
7029
|
+
# data as a hash:
|
7030
|
+
#
|
7031
|
+
# {
|
7032
|
+
# type: "Comment", # accepts Comment
|
7033
|
+
# content: "DocumentReviewComment",
|
7034
|
+
# }
|
7035
|
+
#
|
7036
|
+
# @!attribute [rw] type
|
7037
|
+
# The type of information added to a review request. Currently, only
|
7038
|
+
# the value `Comment` is supported.
|
7039
|
+
# @return [String]
|
7040
|
+
#
|
7041
|
+
# @!attribute [rw] content
|
7042
|
+
# The content of a comment entered by a user who requests a review of
|
7043
|
+
# a new document version, or who reviews the new version.
|
7044
|
+
# @return [String]
|
7045
|
+
#
|
7046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentReviewCommentSource AWS API Documentation
|
7047
|
+
#
|
7048
|
+
class DocumentReviewCommentSource < Struct.new(
|
7049
|
+
:type,
|
7050
|
+
:content)
|
7051
|
+
SENSITIVE = []
|
7052
|
+
include Aws::Structure
|
7053
|
+
end
|
7054
|
+
|
7055
|
+
# Information about a reviewer's response to a document review request.
|
7056
|
+
#
|
7057
|
+
# @!attribute [rw] create_time
|
7058
|
+
# The date and time that a reviewer entered a response to a document
|
7059
|
+
# review request.
|
7060
|
+
# @return [Time]
|
7061
|
+
#
|
7062
|
+
# @!attribute [rw] updated_time
|
7063
|
+
# The date and time that a reviewer last updated a response to a
|
7064
|
+
# document review request.
|
7065
|
+
# @return [Time]
|
7066
|
+
#
|
7067
|
+
# @!attribute [rw] review_status
|
7068
|
+
# The current review status of a new custom SSM document created by a
|
7069
|
+
# member of your organization, or of the latest version of an existing
|
7070
|
+
# SSM document.
|
7071
|
+
#
|
7072
|
+
# Only one version of a document can be in the APPROVED state at a
|
7073
|
+
# time. When a new version is approved, the status of the previous
|
7074
|
+
# version changes to REJECTED.
|
7075
|
+
#
|
7076
|
+
# Only one version of a document can be in review, or PENDING, at a
|
7077
|
+
# time.
|
7078
|
+
# @return [String]
|
7079
|
+
#
|
7080
|
+
# @!attribute [rw] comment
|
7081
|
+
# The comment entered by a reviewer as part of their document review
|
7082
|
+
# response.
|
7083
|
+
# @return [Array<Types::DocumentReviewCommentSource>]
|
7084
|
+
#
|
7085
|
+
# @!attribute [rw] reviewer
|
7086
|
+
# The user in your organization assigned to review a document request.
|
7087
|
+
# @return [String]
|
7088
|
+
#
|
7089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentReviewerResponseSource AWS API Documentation
|
7090
|
+
#
|
7091
|
+
class DocumentReviewerResponseSource < Struct.new(
|
7092
|
+
:create_time,
|
7093
|
+
:updated_time,
|
7094
|
+
:review_status,
|
7095
|
+
:comment,
|
7096
|
+
:reviewer)
|
7097
|
+
SENSITIVE = []
|
7098
|
+
include Aws::Structure
|
7099
|
+
end
|
7100
|
+
|
7101
|
+
# Information about a document approval review.
|
7102
|
+
#
|
7103
|
+
# @note When making an API call, you may pass DocumentReviews
|
7104
|
+
# data as a hash:
|
7105
|
+
#
|
7106
|
+
# {
|
7107
|
+
# action: "SendForReview", # required, accepts SendForReview, UpdateReview, Approve, Reject
|
7108
|
+
# comment: [
|
7109
|
+
# {
|
7110
|
+
# type: "Comment", # accepts Comment
|
7111
|
+
# content: "DocumentReviewComment",
|
7112
|
+
# },
|
7113
|
+
# ],
|
7114
|
+
# }
|
7115
|
+
#
|
7116
|
+
# @!attribute [rw] action
|
7117
|
+
# The action to take on a document approval review request.
|
7118
|
+
# @return [String]
|
7119
|
+
#
|
7120
|
+
# @!attribute [rw] comment
|
7121
|
+
# A comment entered by a user in your organization about the document
|
7122
|
+
# review request.
|
7123
|
+
# @return [Array<Types::DocumentReviewCommentSource>]
|
7124
|
+
#
|
7125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentReviews AWS API Documentation
|
7126
|
+
#
|
7127
|
+
class DocumentReviews < Struct.new(
|
7128
|
+
:action,
|
7129
|
+
:comment)
|
7130
|
+
SENSITIVE = []
|
7131
|
+
include Aws::Structure
|
7132
|
+
end
|
7133
|
+
|
6775
7134
|
# Version information about the document.
|
6776
7135
|
#
|
6777
7136
|
# @!attribute [rw] name
|
@@ -6812,6 +7171,11 @@ module Aws::SSM
|
|
6812
7171
|
# exist. Verify that the URL of the S3 bucket is correct."
|
6813
7172
|
# @return [String]
|
6814
7173
|
#
|
7174
|
+
# @!attribute [rw] review_status
|
7175
|
+
# The current status of the approval review for the latest version of
|
7176
|
+
# the document.
|
7177
|
+
# @return [String]
|
7178
|
+
#
|
6815
7179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentVersionInfo AWS API Documentation
|
6816
7180
|
#
|
6817
7181
|
class DocumentVersionInfo < Struct.new(
|
@@ -6822,7 +7186,8 @@ module Aws::SSM
|
|
6822
7186
|
:is_default_version,
|
6823
7187
|
:document_format,
|
6824
7188
|
:status,
|
6825
|
-
:status_information
|
7189
|
+
:status_information,
|
7190
|
+
:review_status)
|
6826
7191
|
SENSITIVE = []
|
6827
7192
|
include Aws::Structure
|
6828
7193
|
end
|
@@ -7527,6 +7892,19 @@ module Aws::SSM
|
|
7527
7892
|
# locations, sizes, and so on.
|
7528
7893
|
# @return [Array<Types::AttachmentContent>]
|
7529
7894
|
#
|
7895
|
+
# @!attribute [rw] review_status
|
7896
|
+
# The current review status of a new custom Systems Manager document
|
7897
|
+
# (SSM document) created by a member of your organization, or of the
|
7898
|
+
# latest version of an existing SSM document.
|
7899
|
+
#
|
7900
|
+
# Only one version of an SSM document can be in the APPROVED state at
|
7901
|
+
# a time. When a new version is approved, the status of the previous
|
7902
|
+
# version changes to REJECTED.
|
7903
|
+
#
|
7904
|
+
# Only one version of an SSM document can be in review, or PENDING, at
|
7905
|
+
# a time.
|
7906
|
+
# @return [String]
|
7907
|
+
#
|
7530
7908
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocumentResult AWS API Documentation
|
7531
7909
|
#
|
7532
7910
|
class GetDocumentResult < Struct.new(
|
@@ -7539,7 +7917,8 @@ module Aws::SSM
|
|
7539
7917
|
:document_type,
|
7540
7918
|
:document_format,
|
7541
7919
|
:requires,
|
7542
|
-
:attachments_content
|
7920
|
+
:attachments_content,
|
7921
|
+
:review_status)
|
7543
7922
|
SENSITIVE = []
|
7544
7923
|
include Aws::Structure
|
7545
7924
|
end
|
@@ -8039,8 +8418,8 @@ module Aws::SSM
|
|
8039
8418
|
# @!attribute [rw] schedule_timezone
|
8040
8419
|
# The time zone that the scheduled maintenance window executions are
|
8041
8420
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
8042
|
-
# example: "America/Los\_Angeles", "
|
8043
|
-
#
|
8421
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
8422
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
8044
8423
|
# website.
|
8045
8424
|
#
|
8046
8425
|
#
|
@@ -8186,11 +8565,27 @@ module Aws::SSM
|
|
8186
8565
|
#
|
8187
8566
|
# @!attribute [rw] max_concurrency
|
8188
8567
|
# The maximum number of targets allowed to run this task in parallel.
|
8568
|
+
#
|
8569
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
8570
|
+
# supply a value for this option. Instead, the system inserts a
|
8571
|
+
# placeholder value of `1`, which may be reported in the response to
|
8572
|
+
# this command. This value does not affect the running of your task
|
8573
|
+
# and can be ignored.
|
8574
|
+
#
|
8575
|
+
# </note>
|
8189
8576
|
# @return [String]
|
8190
8577
|
#
|
8191
8578
|
# @!attribute [rw] max_errors
|
8192
8579
|
# The maximum number of errors allowed before the task stops being
|
8193
8580
|
# scheduled.
|
8581
|
+
#
|
8582
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
8583
|
+
# supply a value for this option. Instead, the system inserts a
|
8584
|
+
# placeholder value of `1`, which may be reported in the response to
|
8585
|
+
# this command. This value does not affect the running of your task
|
8586
|
+
# and can be ignored.
|
8587
|
+
#
|
8588
|
+
# </note>
|
8194
8589
|
# @return [String]
|
8195
8590
|
#
|
8196
8591
|
# @!attribute [rw] logging_info
|
@@ -8301,11 +8696,11 @@ module Aws::SSM
|
|
8301
8696
|
end
|
8302
8697
|
|
8303
8698
|
# @!attribute [rw] resource_id
|
8304
|
-
# The resource ID of the
|
8699
|
+
# The resource ID of the Application Manager application.
|
8305
8700
|
# @return [String]
|
8306
8701
|
#
|
8307
8702
|
# @!attribute [rw] metadata
|
8308
|
-
# OpsMetadata for an
|
8703
|
+
# OpsMetadata for an Application Manager application.
|
8309
8704
|
# @return [Hash<String,Types::MetadataValue>]
|
8310
8705
|
#
|
8311
8706
|
# @!attribute [rw] next_token
|
@@ -8540,9 +8935,11 @@ module Aws::SSM
|
|
8540
8935
|
#
|
8541
8936
|
# @!attribute [rw] path
|
8542
8937
|
# The hierarchy for the parameter. Hierarchies start with a forward
|
8543
|
-
# slash (/)
|
8544
|
-
#
|
8545
|
-
# hierarchy
|
8938
|
+
# slash (/). The hierachy is the parameter name except the last part
|
8939
|
+
# of the parameter. For the API call to succeeed, the last part of the
|
8940
|
+
# parameter name cannot be in the path. A parameter name hierarchy can
|
8941
|
+
# have a maximum of 15 levels. Here is an example of a hierarchy:
|
8942
|
+
# `/Finance/Prod/IAD/WinServ2016/license33 `
|
8546
8943
|
# @return [String]
|
8547
8944
|
#
|
8548
8945
|
# @!attribute [rw] recursive
|
@@ -9107,7 +9504,8 @@ module Aws::SSM
|
|
9107
9504
|
# @return [String]
|
9108
9505
|
#
|
9109
9506
|
# @!attribute [rw] last_ping_date_time
|
9110
|
-
# The date and time when agent last pinged Systems Manager
|
9507
|
+
# The date and time when the agent last pinged the Systems Manager
|
9508
|
+
# service.
|
9111
9509
|
# @return [Time]
|
9112
9510
|
#
|
9113
9511
|
# @!attribute [rw] agent_version
|
@@ -11073,56 +11471,138 @@ module Aws::SSM
|
|
11073
11471
|
include Aws::Structure
|
11074
11472
|
end
|
11075
11473
|
|
11076
|
-
# @note When making an API call, you may pass
|
11474
|
+
# @note When making an API call, you may pass ListDocumentMetadataHistoryRequest
|
11077
11475
|
# data as a hash:
|
11078
11476
|
#
|
11079
11477
|
# {
|
11080
|
-
# name: "
|
11081
|
-
#
|
11478
|
+
# name: "DocumentName", # required
|
11479
|
+
# document_version: "DocumentVersion",
|
11480
|
+
# metadata: "DocumentReviews", # required, accepts DocumentReviews
|
11082
11481
|
# next_token: "NextToken",
|
11482
|
+
# max_results: 1,
|
11083
11483
|
# }
|
11084
11484
|
#
|
11085
11485
|
# @!attribute [rw] name
|
11086
|
-
# The name of the document.
|
11087
|
-
# (ARN).
|
11486
|
+
# The name of the document.
|
11088
11487
|
# @return [String]
|
11089
11488
|
#
|
11090
|
-
# @!attribute [rw]
|
11091
|
-
# The
|
11092
|
-
#
|
11093
|
-
#
|
11094
|
-
#
|
11489
|
+
# @!attribute [rw] document_version
|
11490
|
+
# The version of the document.
|
11491
|
+
# @return [String]
|
11492
|
+
#
|
11493
|
+
# @!attribute [rw] metadata
|
11494
|
+
# The type of data for which details are being requested. Currently,
|
11495
|
+
# the only supported value is `DocumentReviews`.
|
11496
|
+
# @return [String]
|
11095
11497
|
#
|
11096
11498
|
# @!attribute [rw] next_token
|
11097
11499
|
# The token for the next set of items to return. (You received this
|
11098
11500
|
# token from a previous call.)
|
11099
11501
|
# @return [String]
|
11100
11502
|
#
|
11101
|
-
#
|
11503
|
+
# @!attribute [rw] max_results
|
11504
|
+
# The maximum number of items to return for this call. The call also
|
11505
|
+
# returns a token that you can specify in a subsequent call to get the
|
11506
|
+
# next set of results.
|
11507
|
+
# @return [Integer]
|
11102
11508
|
#
|
11103
|
-
|
11509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistoryRequest AWS API Documentation
|
11510
|
+
#
|
11511
|
+
class ListDocumentMetadataHistoryRequest < Struct.new(
|
11104
11512
|
:name,
|
11105
|
-
:
|
11106
|
-
:
|
11513
|
+
:document_version,
|
11514
|
+
:metadata,
|
11515
|
+
:next_token,
|
11516
|
+
:max_results)
|
11107
11517
|
SENSITIVE = []
|
11108
11518
|
include Aws::Structure
|
11109
11519
|
end
|
11110
11520
|
|
11111
|
-
# @!attribute [rw]
|
11112
|
-
# The document
|
11113
|
-
# @return [
|
11521
|
+
# @!attribute [rw] name
|
11522
|
+
# The name of the document.
|
11523
|
+
# @return [String]
|
11114
11524
|
#
|
11115
|
-
# @!attribute [rw]
|
11116
|
-
# The
|
11117
|
-
# no additional items to return, the string is empty.
|
11525
|
+
# @!attribute [rw] document_version
|
11526
|
+
# The version of the document.
|
11118
11527
|
# @return [String]
|
11119
11528
|
#
|
11120
|
-
#
|
11529
|
+
# @!attribute [rw] author
|
11530
|
+
# The user ID of the person in the organization who requested the
|
11531
|
+
# document review.
|
11532
|
+
# @return [String]
|
11121
11533
|
#
|
11122
|
-
|
11123
|
-
|
11124
|
-
|
11125
|
-
|
11534
|
+
# @!attribute [rw] metadata
|
11535
|
+
# Information about the response to the document approval request.
|
11536
|
+
# @return [Types::DocumentMetadataResponseInfo]
|
11537
|
+
#
|
11538
|
+
# @!attribute [rw] next_token
|
11539
|
+
# The maximum number of items to return for this call. The call also
|
11540
|
+
# returns a token that you can specify in a subsequent call to get the
|
11541
|
+
# next set of results.
|
11542
|
+
# @return [String]
|
11543
|
+
#
|
11544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistoryResponse AWS API Documentation
|
11545
|
+
#
|
11546
|
+
class ListDocumentMetadataHistoryResponse < Struct.new(
|
11547
|
+
:name,
|
11548
|
+
:document_version,
|
11549
|
+
:author,
|
11550
|
+
:metadata,
|
11551
|
+
:next_token)
|
11552
|
+
SENSITIVE = []
|
11553
|
+
include Aws::Structure
|
11554
|
+
end
|
11555
|
+
|
11556
|
+
# @note When making an API call, you may pass ListDocumentVersionsRequest
|
11557
|
+
# data as a hash:
|
11558
|
+
#
|
11559
|
+
# {
|
11560
|
+
# name: "DocumentARN", # required
|
11561
|
+
# max_results: 1,
|
11562
|
+
# next_token: "NextToken",
|
11563
|
+
# }
|
11564
|
+
#
|
11565
|
+
# @!attribute [rw] name
|
11566
|
+
# The name of the document. You can specify an Amazon Resource Name
|
11567
|
+
# (ARN).
|
11568
|
+
# @return [String]
|
11569
|
+
#
|
11570
|
+
# @!attribute [rw] max_results
|
11571
|
+
# The maximum number of items to return for this call. The call also
|
11572
|
+
# returns a token that you can specify in a subsequent call to get the
|
11573
|
+
# next set of results.
|
11574
|
+
# @return [Integer]
|
11575
|
+
#
|
11576
|
+
# @!attribute [rw] next_token
|
11577
|
+
# The token for the next set of items to return. (You received this
|
11578
|
+
# token from a previous call.)
|
11579
|
+
# @return [String]
|
11580
|
+
#
|
11581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentVersionsRequest AWS API Documentation
|
11582
|
+
#
|
11583
|
+
class ListDocumentVersionsRequest < Struct.new(
|
11584
|
+
:name,
|
11585
|
+
:max_results,
|
11586
|
+
:next_token)
|
11587
|
+
SENSITIVE = []
|
11588
|
+
include Aws::Structure
|
11589
|
+
end
|
11590
|
+
|
11591
|
+
# @!attribute [rw] document_versions
|
11592
|
+
# The document versions.
|
11593
|
+
# @return [Array<Types::DocumentVersionInfo>]
|
11594
|
+
#
|
11595
|
+
# @!attribute [rw] next_token
|
11596
|
+
# The token to use when requesting the next set of items. If there are
|
11597
|
+
# no additional items to return, the string is empty.
|
11598
|
+
# @return [String]
|
11599
|
+
#
|
11600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentVersionsResult AWS API Documentation
|
11601
|
+
#
|
11602
|
+
class ListDocumentVersionsResult < Struct.new(
|
11603
|
+
:document_versions,
|
11604
|
+
:next_token)
|
11605
|
+
SENSITIVE = []
|
11126
11606
|
include Aws::Structure
|
11127
11607
|
end
|
11128
11608
|
|
@@ -11151,13 +11631,19 @@ module Aws::SSM
|
|
11151
11631
|
# @return [Array<Types::DocumentFilter>]
|
11152
11632
|
#
|
11153
11633
|
# @!attribute [rw] filters
|
11154
|
-
# One or more DocumentKeyValuesFilter objects. Use a filter to
|
11155
|
-
# a more specific list of results. For keys, you can specify
|
11156
|
-
# more key-value pair tags that have been applied to a
|
11157
|
-
# valid keys include `Owner`, `Name`, `PlatformTypes`,
|
11158
|
-
# and `TargetType`. For example, to return documents
|
11159
|
-
# `Key=Owner,Values=Self`. To specify a custom key-value
|
11160
|
-
# format `Key=tag:tagName,Values=valueName`.
|
11634
|
+
# One or more `DocumentKeyValuesFilter` objects. Use a filter to
|
11635
|
+
# return a more specific list of results. For keys, you can specify
|
11636
|
+
# one or more key-value pair tags that have been applied to a
|
11637
|
+
# document. Other valid keys include `Owner`, `Name`, `PlatformTypes`,
|
11638
|
+
# `DocumentType`, and `TargetType`. For example, to return documents
|
11639
|
+
# you own use `Key=Owner,Values=Self`. To specify a custom key-value
|
11640
|
+
# pair, use the format `Key=tag:tagName,Values=valueName`.
|
11641
|
+
#
|
11642
|
+
# <note markdown="1"> This API action only supports filtering documents by using a single
|
11643
|
+
# tag key and one or more tag values. For example:
|
11644
|
+
# `Key=tag:tagName,Values=valueName1,valueName2`
|
11645
|
+
#
|
11646
|
+
# </note>
|
11161
11647
|
# @return [Array<Types::DocumentKeyValuesFilter>]
|
11162
11648
|
#
|
11163
11649
|
# @!attribute [rw] max_results
|
@@ -11293,6 +11779,65 @@ module Aws::SSM
|
|
11293
11779
|
include Aws::Structure
|
11294
11780
|
end
|
11295
11781
|
|
11782
|
+
# @note When making an API call, you may pass ListOpsItemEventsRequest
|
11783
|
+
# data as a hash:
|
11784
|
+
#
|
11785
|
+
# {
|
11786
|
+
# filters: [
|
11787
|
+
# {
|
11788
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
11789
|
+
# values: ["OpsItemEventFilterValue"], # required
|
11790
|
+
# operator: "Equal", # required, accepts Equal
|
11791
|
+
# },
|
11792
|
+
# ],
|
11793
|
+
# max_results: 1,
|
11794
|
+
# next_token: "String",
|
11795
|
+
# }
|
11796
|
+
#
|
11797
|
+
# @!attribute [rw] filters
|
11798
|
+
# One or more OpsItem filters. Use a filter to return a more specific
|
11799
|
+
# list of results.
|
11800
|
+
# @return [Array<Types::OpsItemEventFilter>]
|
11801
|
+
#
|
11802
|
+
# @!attribute [rw] max_results
|
11803
|
+
# The maximum number of items to return for this call. The call also
|
11804
|
+
# returns a token that you can specify in a subsequent call to get the
|
11805
|
+
# next set of results.
|
11806
|
+
# @return [Integer]
|
11807
|
+
#
|
11808
|
+
# @!attribute [rw] next_token
|
11809
|
+
# A token to start the list. Use this token to get the next set of
|
11810
|
+
# results.
|
11811
|
+
# @return [String]
|
11812
|
+
#
|
11813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEventsRequest AWS API Documentation
|
11814
|
+
#
|
11815
|
+
class ListOpsItemEventsRequest < Struct.new(
|
11816
|
+
:filters,
|
11817
|
+
:max_results,
|
11818
|
+
:next_token)
|
11819
|
+
SENSITIVE = []
|
11820
|
+
include Aws::Structure
|
11821
|
+
end
|
11822
|
+
|
11823
|
+
# @!attribute [rw] next_token
|
11824
|
+
# The token for the next set of items to return. Use this token to get
|
11825
|
+
# the next set of results.
|
11826
|
+
# @return [String]
|
11827
|
+
#
|
11828
|
+
# @!attribute [rw] summaries
|
11829
|
+
# A list of event information for the specified OpsItems.
|
11830
|
+
# @return [Array<Types::OpsItemEventSummary>]
|
11831
|
+
#
|
11832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEventsResponse AWS API Documentation
|
11833
|
+
#
|
11834
|
+
class ListOpsItemEventsResponse < Struct.new(
|
11835
|
+
:next_token,
|
11836
|
+
:summaries)
|
11837
|
+
SENSITIVE = []
|
11838
|
+
include Aws::Structure
|
11839
|
+
end
|
11840
|
+
|
11296
11841
|
# @note When making an API call, you may pass ListOpsMetadataRequest
|
11297
11842
|
# data as a hash:
|
11298
11843
|
#
|
@@ -12394,7 +12939,7 @@ module Aws::SSM
|
|
12394
12939
|
include Aws::Structure
|
12395
12940
|
end
|
12396
12941
|
|
12397
|
-
# Metadata to assign to an
|
12942
|
+
# Metadata to assign to an Application Manager application.
|
12398
12943
|
#
|
12399
12944
|
# @note When making an API call, you may pass MetadataValue
|
12400
12945
|
# data as a hash:
|
@@ -12404,7 +12949,7 @@ module Aws::SSM
|
|
12404
12949
|
# }
|
12405
12950
|
#
|
12406
12951
|
# @!attribute [rw] value
|
12407
|
-
# Metadata value to assign to an
|
12952
|
+
# Metadata value to assign to an Application Manager application.
|
12408
12953
|
# @return [String]
|
12409
12954
|
#
|
12410
12955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MetadataValue AWS API Documentation
|
@@ -12701,6 +13246,11 @@ module Aws::SSM
|
|
12701
13246
|
# The ARN of the AWS account that created the OpsItem.
|
12702
13247
|
# @return [String]
|
12703
13248
|
#
|
13249
|
+
# @!attribute [rw] ops_item_type
|
13250
|
+
# The type of OpsItem. Currently, the only valid values are
|
13251
|
+
# `/aws/changerequest` and `/aws/issue`.
|
13252
|
+
# @return [String]
|
13253
|
+
#
|
12704
13254
|
# @!attribute [rw] created_time
|
12705
13255
|
# The date and time the OpsItem was created.
|
12706
13256
|
# @return [Time]
|
@@ -12802,10 +13352,33 @@ module Aws::SSM
|
|
12802
13352
|
# The severity of the OpsItem. Severity options range from 1 to 4.
|
12803
13353
|
# @return [String]
|
12804
13354
|
#
|
13355
|
+
# @!attribute [rw] actual_start_time
|
13356
|
+
# The time a runbook workflow started. Currently reported only for the
|
13357
|
+
# OpsItem type `/aws/changerequest`.
|
13358
|
+
# @return [Time]
|
13359
|
+
#
|
13360
|
+
# @!attribute [rw] actual_end_time
|
13361
|
+
# The time a runbook workflow ended. Currently reported only for the
|
13362
|
+
# OpsItem type `/aws/changerequest`.
|
13363
|
+
# @return [Time]
|
13364
|
+
#
|
13365
|
+
# @!attribute [rw] planned_start_time
|
13366
|
+
# The time specified in a change request for a runbook workflow to
|
13367
|
+
# start. Currently supported only for the OpsItem type
|
13368
|
+
# `/aws/changerequest`.
|
13369
|
+
# @return [Time]
|
13370
|
+
#
|
13371
|
+
# @!attribute [rw] planned_end_time
|
13372
|
+
# The time specified in a change request for a runbook workflow to
|
13373
|
+
# end. Currently supported only for the OpsItem type
|
13374
|
+
# `/aws/changerequest`.
|
13375
|
+
# @return [Time]
|
13376
|
+
#
|
12805
13377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItem AWS API Documentation
|
12806
13378
|
#
|
12807
13379
|
class OpsItem < Struct.new(
|
12808
13380
|
:created_by,
|
13381
|
+
:ops_item_type,
|
12809
13382
|
:created_time,
|
12810
13383
|
:description,
|
12811
13384
|
:last_modified_by,
|
@@ -12820,7 +13393,11 @@ module Aws::SSM
|
|
12820
13393
|
:source,
|
12821
13394
|
:operational_data,
|
12822
13395
|
:category,
|
12823
|
-
:severity
|
13396
|
+
:severity,
|
13397
|
+
:actual_start_time,
|
13398
|
+
:actual_end_time,
|
13399
|
+
:planned_start_time,
|
13400
|
+
:planned_end_time)
|
12824
13401
|
SENSITIVE = []
|
12825
13402
|
include Aws::Structure
|
12826
13403
|
end
|
@@ -12871,13 +13448,95 @@ module Aws::SSM
|
|
12871
13448
|
include Aws::Structure
|
12872
13449
|
end
|
12873
13450
|
|
13451
|
+
# Describes a filter for a specific list of OpsItem events. You can
|
13452
|
+
# filter event information by using tags. You specify tags by using a
|
13453
|
+
# key-value pair mapping.
|
13454
|
+
#
|
13455
|
+
# @note When making an API call, you may pass OpsItemEventFilter
|
13456
|
+
# data as a hash:
|
13457
|
+
#
|
13458
|
+
# {
|
13459
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
13460
|
+
# values: ["OpsItemEventFilterValue"], # required
|
13461
|
+
# operator: "Equal", # required, accepts Equal
|
13462
|
+
# }
|
13463
|
+
#
|
13464
|
+
# @!attribute [rw] key
|
13465
|
+
# The name of the filter key. Currently, the only supported value is
|
13466
|
+
# `OpsItemId`.
|
13467
|
+
# @return [String]
|
13468
|
+
#
|
13469
|
+
# @!attribute [rw] values
|
13470
|
+
# The values for the filter, consisting of one or more OpsItem IDs.
|
13471
|
+
# @return [Array<String>]
|
13472
|
+
#
|
13473
|
+
# @!attribute [rw] operator
|
13474
|
+
# The operator used by the filter call. Currently, the only supported
|
13475
|
+
# value is `Equal`.
|
13476
|
+
# @return [String]
|
13477
|
+
#
|
13478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemEventFilter AWS API Documentation
|
13479
|
+
#
|
13480
|
+
class OpsItemEventFilter < Struct.new(
|
13481
|
+
:key,
|
13482
|
+
:values,
|
13483
|
+
:operator)
|
13484
|
+
SENSITIVE = []
|
13485
|
+
include Aws::Structure
|
13486
|
+
end
|
13487
|
+
|
13488
|
+
# Summary information about an OpsItem event.
|
13489
|
+
#
|
13490
|
+
# @!attribute [rw] ops_item_id
|
13491
|
+
# The ID of the OpsItem.
|
13492
|
+
# @return [String]
|
13493
|
+
#
|
13494
|
+
# @!attribute [rw] event_id
|
13495
|
+
# The ID of the OpsItem event.
|
13496
|
+
# @return [String]
|
13497
|
+
#
|
13498
|
+
# @!attribute [rw] source
|
13499
|
+
# The source of the OpsItem event.
|
13500
|
+
# @return [String]
|
13501
|
+
#
|
13502
|
+
# @!attribute [rw] detail_type
|
13503
|
+
# The type of information provided as a detail.
|
13504
|
+
# @return [String]
|
13505
|
+
#
|
13506
|
+
# @!attribute [rw] detail
|
13507
|
+
# Specific information about the OpsItem event.
|
13508
|
+
# @return [String]
|
13509
|
+
#
|
13510
|
+
# @!attribute [rw] created_by
|
13511
|
+
# Information about the user or resource that created the OpsItem
|
13512
|
+
# event.
|
13513
|
+
# @return [Types::OpsItemIdentity]
|
13514
|
+
#
|
13515
|
+
# @!attribute [rw] created_time
|
13516
|
+
# The date and time the OpsItem event was created.
|
13517
|
+
# @return [Time]
|
13518
|
+
#
|
13519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemEventSummary AWS API Documentation
|
13520
|
+
#
|
13521
|
+
class OpsItemEventSummary < Struct.new(
|
13522
|
+
:ops_item_id,
|
13523
|
+
:event_id,
|
13524
|
+
:source,
|
13525
|
+
:detail_type,
|
13526
|
+
:detail,
|
13527
|
+
:created_by,
|
13528
|
+
:created_time)
|
13529
|
+
SENSITIVE = []
|
13530
|
+
include Aws::Structure
|
13531
|
+
end
|
13532
|
+
|
12874
13533
|
# Describes an OpsItem filter.
|
12875
13534
|
#
|
12876
13535
|
# @note When making an API call, you may pass OpsItemFilter
|
12877
13536
|
# data as a hash:
|
12878
13537
|
#
|
12879
13538
|
# {
|
12880
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity
|
13539
|
+
# 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
|
12881
13540
|
# values: ["OpsItemFilterValue"], # required
|
12882
13541
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
12883
13542
|
# }
|
@@ -12904,6 +13563,21 @@ module Aws::SSM
|
|
12904
13563
|
include Aws::Structure
|
12905
13564
|
end
|
12906
13565
|
|
13566
|
+
# Information about the user or resource that created an OpsItem event.
|
13567
|
+
#
|
13568
|
+
# @!attribute [rw] arn
|
13569
|
+
# The Amazon Resource Name (ARN) of the IAM entity that created the
|
13570
|
+
# OpsItem event.
|
13571
|
+
# @return [String]
|
13572
|
+
#
|
13573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemIdentity AWS API Documentation
|
13574
|
+
#
|
13575
|
+
class OpsItemIdentity < Struct.new(
|
13576
|
+
:arn)
|
13577
|
+
SENSITIVE = []
|
13578
|
+
include Aws::Structure
|
13579
|
+
end
|
13580
|
+
|
12907
13581
|
# A specified parameter argument isn't valid. Verify the available
|
12908
13582
|
# arguments and try again.
|
12909
13583
|
#
|
@@ -13044,6 +13718,33 @@ module Aws::SSM
|
|
13044
13718
|
# A list of OpsItems by severity.
|
13045
13719
|
# @return [String]
|
13046
13720
|
#
|
13721
|
+
# @!attribute [rw] ops_item_type
|
13722
|
+
# The type of OpsItem. Currently, the only valid values are
|
13723
|
+
# `/aws/changerequest` and `/aws/issue`.
|
13724
|
+
# @return [String]
|
13725
|
+
#
|
13726
|
+
# @!attribute [rw] actual_start_time
|
13727
|
+
# The time a runbook workflow started. Currently reported only for the
|
13728
|
+
# OpsItem type `/aws/changerequest`.
|
13729
|
+
# @return [Time]
|
13730
|
+
#
|
13731
|
+
# @!attribute [rw] actual_end_time
|
13732
|
+
# The time a runbook workflow ended. Currently reported only for the
|
13733
|
+
# OpsItem type `/aws/changerequest`.
|
13734
|
+
# @return [Time]
|
13735
|
+
#
|
13736
|
+
# @!attribute [rw] planned_start_time
|
13737
|
+
# The time specified in a change request for a runbook workflow to
|
13738
|
+
# start. Currently supported only for the OpsItem type
|
13739
|
+
# `/aws/changerequest`.
|
13740
|
+
# @return [Time]
|
13741
|
+
#
|
13742
|
+
# @!attribute [rw] planned_end_time
|
13743
|
+
# The time specified in a change request for a runbook workflow to
|
13744
|
+
# end. Currently supported only for the OpsItem type
|
13745
|
+
# `/aws/changerequest`.
|
13746
|
+
# @return [Time]
|
13747
|
+
#
|
13047
13748
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemSummary AWS API Documentation
|
13048
13749
|
#
|
13049
13750
|
class OpsItemSummary < Struct.new(
|
@@ -13058,15 +13759,20 @@ module Aws::SSM
|
|
13058
13759
|
:title,
|
13059
13760
|
:operational_data,
|
13060
13761
|
:category,
|
13061
|
-
:severity
|
13762
|
+
:severity,
|
13763
|
+
:ops_item_type,
|
13764
|
+
:actual_start_time,
|
13765
|
+
:actual_end_time,
|
13766
|
+
:planned_start_time,
|
13767
|
+
:planned_end_time)
|
13062
13768
|
SENSITIVE = []
|
13063
13769
|
include Aws::Structure
|
13064
13770
|
end
|
13065
13771
|
|
13066
|
-
# Operational metadata for an application in
|
13772
|
+
# Operational metadata for an application in Application Manager.
|
13067
13773
|
#
|
13068
13774
|
# @!attribute [rw] resource_id
|
13069
|
-
# The ID of the
|
13775
|
+
# The ID of the Application Manager application.
|
13070
13776
|
# @return [String]
|
13071
13777
|
#
|
13072
13778
|
# @!attribute [rw] ops_metadata_arn
|
@@ -13151,7 +13857,7 @@ module Aws::SSM
|
|
13151
13857
|
end
|
13152
13858
|
|
13153
13859
|
# The OpsMetadata object exceeds the maximum number of OpsMetadata keys
|
13154
|
-
# that you can assign to an application in
|
13860
|
+
# that you can assign to an application in Application Manager.
|
13155
13861
|
#
|
13156
13862
|
# @!attribute [rw] message
|
13157
13863
|
# @return [String]
|
@@ -13165,8 +13871,8 @@ module Aws::SSM
|
|
13165
13871
|
end
|
13166
13872
|
|
13167
13873
|
# Your account reached the maximum number of OpsMetadata objects allowed
|
13168
|
-
# by
|
13169
|
-
# more OpsMetadata object and try again.
|
13874
|
+
# by Application Manager. The maximum is 200 OpsMetadata objects. Delete
|
13875
|
+
# one or more OpsMetadata object and try again.
|
13170
13876
|
#
|
13171
13877
|
# @!attribute [rw] message
|
13172
13878
|
# @return [String]
|
@@ -14197,11 +14903,20 @@ module Aws::SSM
|
|
14197
14903
|
#
|
14198
14904
|
# `[main]`
|
14199
14905
|
#
|
14200
|
-
# `
|
14906
|
+
# `name=MyCustomRepository`
|
14907
|
+
#
|
14908
|
+
# `baseurl=https://my-custom-repository`
|
14909
|
+
#
|
14910
|
+
# `enabled=1`
|
14911
|
+
#
|
14912
|
+
# <note markdown="1"> For information about other options available for your yum
|
14913
|
+
# repository configuration, see [dnf.conf(5)][1].
|
14914
|
+
#
|
14915
|
+
# </note>
|
14201
14916
|
#
|
14202
|
-
# `keepcache=0`
|
14203
14917
|
#
|
14204
|
-
#
|
14918
|
+
#
|
14919
|
+
# [1]: https://man7.org/linux/man-pages/man5/dnf.conf.5.html
|
14205
14920
|
# @return [String]
|
14206
14921
|
#
|
14207
14922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PatchSource AWS API Documentation
|
@@ -14965,7 +15680,7 @@ module Aws::SSM
|
|
14965
15680
|
#
|
14966
15681
|
# {
|
14967
15682
|
# window_id: "MaintenanceWindowId", # required
|
14968
|
-
# targets: [
|
15683
|
+
# targets: [
|
14969
15684
|
# {
|
14970
15685
|
# key: "TargetKey",
|
14971
15686
|
# values: ["TargetValue"],
|
@@ -15019,8 +15734,8 @@ module Aws::SSM
|
|
15019
15734
|
# },
|
15020
15735
|
# },
|
15021
15736
|
# priority: 1,
|
15022
|
-
# max_concurrency: "MaxConcurrency",
|
15023
|
-
# max_errors: "MaxErrors",
|
15737
|
+
# max_concurrency: "MaxConcurrency",
|
15738
|
+
# max_errors: "MaxErrors",
|
15024
15739
|
# logging_info: {
|
15025
15740
|
# s3_bucket_name: "S3BucketName", # required
|
15026
15741
|
# s3_key_prefix: "S3KeyPrefix",
|
@@ -15038,13 +15753,26 @@ module Aws::SSM
|
|
15038
15753
|
# @!attribute [rw] targets
|
15039
15754
|
# The targets (either instances or maintenance window targets).
|
15040
15755
|
#
|
15756
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
15757
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
15758
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
15759
|
+
# Step Functions). For more information about running tasks that do
|
15760
|
+
# not specify targets, see [Registering maintenance window tasks
|
15761
|
+
# without targets][1] in the *AWS Systems Manager User Guide*.
|
15762
|
+
#
|
15763
|
+
# </note>
|
15764
|
+
#
|
15041
15765
|
# Specify instances using the following format:
|
15042
15766
|
#
|
15043
15767
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
15044
15768
|
#
|
15045
15769
|
# Specify maintenance window targets using the following format:
|
15046
15770
|
#
|
15047
|
-
# `Key=WindowTargetIds
|
15771
|
+
# `Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>`
|
15772
|
+
#
|
15773
|
+
#
|
15774
|
+
#
|
15775
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
15048
15776
|
# @return [Array<Types::Target>]
|
15049
15777
|
#
|
15050
15778
|
# @!attribute [rw] task_arn
|
@@ -15104,11 +15832,25 @@ module Aws::SSM
|
|
15104
15832
|
#
|
15105
15833
|
# @!attribute [rw] max_concurrency
|
15106
15834
|
# The maximum number of targets this task can be run for in parallel.
|
15835
|
+
#
|
15836
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
15837
|
+
# supply a value for this option. Instead, the system inserts a
|
15838
|
+
# placeholder value of `1`. This value does not affect the running of
|
15839
|
+
# your task.
|
15840
|
+
#
|
15841
|
+
# </note>
|
15107
15842
|
# @return [String]
|
15108
15843
|
#
|
15109
15844
|
# @!attribute [rw] max_errors
|
15110
15845
|
# The maximum number of errors allowed before this task stops being
|
15111
15846
|
# scheduled.
|
15847
|
+
#
|
15848
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
15849
|
+
# supply a value for this option. Instead, the system inserts a
|
15850
|
+
# placeholder value of `1`. This value does not affect the running of
|
15851
|
+
# your task.
|
15852
|
+
#
|
15853
|
+
# </note>
|
15112
15854
|
# @return [String]
|
15113
15855
|
#
|
15114
15856
|
# @!attribute [rw] logging_info
|
@@ -15874,6 +16616,126 @@ module Aws::SSM
|
|
15874
16616
|
include Aws::Structure
|
15875
16617
|
end
|
15876
16618
|
|
16619
|
+
# Information about the result of a document review request.
|
16620
|
+
#
|
16621
|
+
# @!attribute [rw] reviewed_time
|
16622
|
+
# The time that the reviewer took action on the document review
|
16623
|
+
# request.
|
16624
|
+
# @return [Time]
|
16625
|
+
#
|
16626
|
+
# @!attribute [rw] status
|
16627
|
+
# The current status of the document review request.
|
16628
|
+
# @return [String]
|
16629
|
+
#
|
16630
|
+
# @!attribute [rw] reviewer
|
16631
|
+
# The reviewer assigned to take action on the document review request.
|
16632
|
+
# @return [String]
|
16633
|
+
#
|
16634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ReviewInformation AWS API Documentation
|
16635
|
+
#
|
16636
|
+
class ReviewInformation < Struct.new(
|
16637
|
+
:reviewed_time,
|
16638
|
+
:status,
|
16639
|
+
:reviewer)
|
16640
|
+
SENSITIVE = []
|
16641
|
+
include Aws::Structure
|
16642
|
+
end
|
16643
|
+
|
16644
|
+
# Information about an Automation runbook (Automation document) used in
|
16645
|
+
# a runbook workflow in Change Manager.
|
16646
|
+
#
|
16647
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
16648
|
+
# until all required approvals for the change request have been
|
16649
|
+
# received.
|
16650
|
+
#
|
16651
|
+
# </note>
|
16652
|
+
#
|
16653
|
+
# @note When making an API call, you may pass Runbook
|
16654
|
+
# data as a hash:
|
16655
|
+
#
|
16656
|
+
# {
|
16657
|
+
# document_name: "DocumentARN", # required
|
16658
|
+
# document_version: "DocumentVersion",
|
16659
|
+
# parameters: {
|
16660
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
16661
|
+
# },
|
16662
|
+
# target_parameter_name: "AutomationParameterKey",
|
16663
|
+
# targets: [
|
16664
|
+
# {
|
16665
|
+
# key: "TargetKey",
|
16666
|
+
# values: ["TargetValue"],
|
16667
|
+
# },
|
16668
|
+
# ],
|
16669
|
+
# max_concurrency: "MaxConcurrency",
|
16670
|
+
# max_errors: "MaxErrors",
|
16671
|
+
# target_locations: [
|
16672
|
+
# {
|
16673
|
+
# accounts: ["Account"],
|
16674
|
+
# regions: ["Region"],
|
16675
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
16676
|
+
# target_location_max_errors: "MaxErrors",
|
16677
|
+
# execution_role_name: "ExecutionRoleName",
|
16678
|
+
# },
|
16679
|
+
# ],
|
16680
|
+
# }
|
16681
|
+
#
|
16682
|
+
# @!attribute [rw] document_name
|
16683
|
+
# The name of the Automation runbook (Automation document) used in a
|
16684
|
+
# runbook workflow.
|
16685
|
+
# @return [String]
|
16686
|
+
#
|
16687
|
+
# @!attribute [rw] document_version
|
16688
|
+
# The version of the Automation runbook (Automation document) used in
|
16689
|
+
# a runbook workflow.
|
16690
|
+
# @return [String]
|
16691
|
+
#
|
16692
|
+
# @!attribute [rw] parameters
|
16693
|
+
# The key-value map of execution parameters, which were supplied when
|
16694
|
+
# calling `StartChangeRequestExecution`.
|
16695
|
+
# @return [Hash<String,Array<String>>]
|
16696
|
+
#
|
16697
|
+
# @!attribute [rw] target_parameter_name
|
16698
|
+
# The name of the parameter used as the target resource for the
|
16699
|
+
# rate-controlled runbook workflow. Required if you specify `Targets`.
|
16700
|
+
# @return [String]
|
16701
|
+
#
|
16702
|
+
# @!attribute [rw] targets
|
16703
|
+
# A key-value mapping to target resources that the Runbook operation
|
16704
|
+
# performs tasks on. Required if you specify `TargetParameterName`.
|
16705
|
+
# @return [Array<Types::Target>]
|
16706
|
+
#
|
16707
|
+
# @!attribute [rw] max_concurrency
|
16708
|
+
# The `MaxConcurrency` value specified by the user when the operation
|
16709
|
+
# started, indicating the maximum number of resources that the runbook
|
16710
|
+
# operation can run on at the same time.
|
16711
|
+
# @return [String]
|
16712
|
+
#
|
16713
|
+
# @!attribute [rw] max_errors
|
16714
|
+
# The `MaxErrors` value specified by the user when the execution
|
16715
|
+
# started, indicating the maximum number of errors that can occur
|
16716
|
+
# during the operation before the updates are stopped or rolled back.
|
16717
|
+
# @return [String]
|
16718
|
+
#
|
16719
|
+
# @!attribute [rw] target_locations
|
16720
|
+
# Information about the AWS Regions and accounts targeted by the
|
16721
|
+
# current Runbook operation.
|
16722
|
+
# @return [Array<Types::TargetLocation>]
|
16723
|
+
#
|
16724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Runbook AWS API Documentation
|
16725
|
+
#
|
16726
|
+
class Runbook < Struct.new(
|
16727
|
+
:document_name,
|
16728
|
+
:document_version,
|
16729
|
+
:parameters,
|
16730
|
+
:target_parameter_name,
|
16731
|
+
:targets,
|
16732
|
+
:max_concurrency,
|
16733
|
+
:max_errors,
|
16734
|
+
:target_locations)
|
16735
|
+
SENSITIVE = []
|
16736
|
+
include Aws::Structure
|
16737
|
+
end
|
16738
|
+
|
15877
16739
|
# An S3 bucket where you want to store the results of this request.
|
15878
16740
|
#
|
15879
16741
|
# @note When making an API call, you may pass S3OutputLocation
|
@@ -16081,8 +16943,15 @@ module Aws::SSM
|
|
16081
16943
|
# @return [Array<Types::Target>]
|
16082
16944
|
#
|
16083
16945
|
# @!attribute [rw] document_name
|
16084
|
-
#
|
16085
|
-
#
|
16946
|
+
# The name of the Systems Manager document to run. This can be a
|
16947
|
+
# public document or a custom document. To run a shared document
|
16948
|
+
# belonging to another account, specify the document ARN. For more
|
16949
|
+
# information about how to use shared documents, see [Using shared SSM
|
16950
|
+
# documents][1] in the *AWS Systems Manager User Guide*.
|
16951
|
+
#
|
16952
|
+
#
|
16953
|
+
#
|
16954
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
16086
16955
|
# @return [String]
|
16087
16956
|
#
|
16088
16957
|
# @!attribute [rw] document_version
|
@@ -16560,7 +17429,15 @@ module Aws::SSM
|
|
16560
17429
|
# }
|
16561
17430
|
#
|
16562
17431
|
# @!attribute [rw] document_name
|
16563
|
-
# The name of the
|
17432
|
+
# The name of the Systems Manager document to run. This can be a
|
17433
|
+
# public document or a custom document. To run a shared document
|
17434
|
+
# belonging to another account, specify the document ARN. For more
|
17435
|
+
# information about how to use shared documents, see [Using shared SSM
|
17436
|
+
# documents][1] in the *AWS Systems Manager User Guide*.
|
17437
|
+
#
|
17438
|
+
#
|
17439
|
+
#
|
17440
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
16564
17441
|
# @return [String]
|
16565
17442
|
#
|
16566
17443
|
# @!attribute [rw] document_version
|
@@ -16683,6 +17560,141 @@ module Aws::SSM
|
|
16683
17560
|
include Aws::Structure
|
16684
17561
|
end
|
16685
17562
|
|
17563
|
+
# @note When making an API call, you may pass StartChangeRequestExecutionRequest
|
17564
|
+
# data as a hash:
|
17565
|
+
#
|
17566
|
+
# {
|
17567
|
+
# scheduled_time: Time.now,
|
17568
|
+
# document_name: "DocumentARN", # required
|
17569
|
+
# document_version: "DocumentVersion",
|
17570
|
+
# parameters: {
|
17571
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
17572
|
+
# },
|
17573
|
+
# change_request_name: "ChangeRequestName",
|
17574
|
+
# client_token: "IdempotencyToken",
|
17575
|
+
# runbooks: [ # required
|
17576
|
+
# {
|
17577
|
+
# document_name: "DocumentARN", # required
|
17578
|
+
# document_version: "DocumentVersion",
|
17579
|
+
# parameters: {
|
17580
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
17581
|
+
# },
|
17582
|
+
# target_parameter_name: "AutomationParameterKey",
|
17583
|
+
# targets: [
|
17584
|
+
# {
|
17585
|
+
# key: "TargetKey",
|
17586
|
+
# values: ["TargetValue"],
|
17587
|
+
# },
|
17588
|
+
# ],
|
17589
|
+
# max_concurrency: "MaxConcurrency",
|
17590
|
+
# max_errors: "MaxErrors",
|
17591
|
+
# target_locations: [
|
17592
|
+
# {
|
17593
|
+
# accounts: ["Account"],
|
17594
|
+
# regions: ["Region"],
|
17595
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
17596
|
+
# target_location_max_errors: "MaxErrors",
|
17597
|
+
# execution_role_name: "ExecutionRoleName",
|
17598
|
+
# },
|
17599
|
+
# ],
|
17600
|
+
# },
|
17601
|
+
# ],
|
17602
|
+
# tags: [
|
17603
|
+
# {
|
17604
|
+
# key: "TagKey", # required
|
17605
|
+
# value: "TagValue", # required
|
17606
|
+
# },
|
17607
|
+
# ],
|
17608
|
+
# }
|
17609
|
+
#
|
17610
|
+
# @!attribute [rw] scheduled_time
|
17611
|
+
# The date and time specified in the change request to run the
|
17612
|
+
# Automation runbooks.
|
17613
|
+
#
|
17614
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
17615
|
+
# run until all required approvals for the change request have been
|
17616
|
+
# received.
|
17617
|
+
#
|
17618
|
+
# </note>
|
17619
|
+
# @return [Time]
|
17620
|
+
#
|
17621
|
+
# @!attribute [rw] document_name
|
17622
|
+
# The name of the change template document to run during the runbook
|
17623
|
+
# workflow.
|
17624
|
+
# @return [String]
|
17625
|
+
#
|
17626
|
+
# @!attribute [rw] document_version
|
17627
|
+
# The version of the change template document to run during the
|
17628
|
+
# runbook workflow.
|
17629
|
+
# @return [String]
|
17630
|
+
#
|
17631
|
+
# @!attribute [rw] parameters
|
17632
|
+
# A key-value map of parameters that match the declared parameters in
|
17633
|
+
# the change template document.
|
17634
|
+
# @return [Hash<String,Array<String>>]
|
17635
|
+
#
|
17636
|
+
# @!attribute [rw] change_request_name
|
17637
|
+
# The name of the change request associated with the runbook workflow
|
17638
|
+
# to be run.
|
17639
|
+
# @return [String]
|
17640
|
+
#
|
17641
|
+
# @!attribute [rw] client_token
|
17642
|
+
# The user-provided idempotency token. The token must be unique, is
|
17643
|
+
# case insensitive, enforces the UUID format, and can't be reused.
|
17644
|
+
# @return [String]
|
17645
|
+
#
|
17646
|
+
# @!attribute [rw] runbooks
|
17647
|
+
# Information about the Automation runbooks (Automation documents)
|
17648
|
+
# that are run during the runbook workflow.
|
17649
|
+
#
|
17650
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
17651
|
+
# run until all required approvals for the change request have been
|
17652
|
+
# received.
|
17653
|
+
#
|
17654
|
+
# </note>
|
17655
|
+
# @return [Array<Types::Runbook>]
|
17656
|
+
#
|
17657
|
+
# @!attribute [rw] tags
|
17658
|
+
# Optional metadata that you assign to a resource. You can specify a
|
17659
|
+
# maximum of five tags for a change request. Tags enable you to
|
17660
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
17661
|
+
# or environment. For example, you might want to tag a change request
|
17662
|
+
# to identify an environment or target AWS Region. In this case, you
|
17663
|
+
# could specify the following key-value pairs:
|
17664
|
+
#
|
17665
|
+
# * `Key=Environment,Value=Production`
|
17666
|
+
#
|
17667
|
+
# * `Key=Region,Value=us-east-2`
|
17668
|
+
# @return [Array<Types::Tag>]
|
17669
|
+
#
|
17670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionRequest AWS API Documentation
|
17671
|
+
#
|
17672
|
+
class StartChangeRequestExecutionRequest < Struct.new(
|
17673
|
+
:scheduled_time,
|
17674
|
+
:document_name,
|
17675
|
+
:document_version,
|
17676
|
+
:parameters,
|
17677
|
+
:change_request_name,
|
17678
|
+
:client_token,
|
17679
|
+
:runbooks,
|
17680
|
+
:tags)
|
17681
|
+
SENSITIVE = []
|
17682
|
+
include Aws::Structure
|
17683
|
+
end
|
17684
|
+
|
17685
|
+
# @!attribute [rw] automation_execution_id
|
17686
|
+
# The unique ID of a runbook workflow operation. (A runbook workflow
|
17687
|
+
# is a type of Automation operation.)
|
17688
|
+
# @return [String]
|
17689
|
+
#
|
17690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionResult AWS API Documentation
|
17691
|
+
#
|
17692
|
+
class StartChangeRequestExecutionResult < Struct.new(
|
17693
|
+
:automation_execution_id)
|
17694
|
+
SENSITIVE = []
|
17695
|
+
include Aws::Structure
|
17696
|
+
end
|
17697
|
+
|
16686
17698
|
# @note When making an API call, you may pass StartSessionRequest
|
16687
17699
|
# data as a hash:
|
16688
17700
|
#
|
@@ -17005,6 +18017,15 @@ module Aws::SSM
|
|
17005
18017
|
# An array of search criteria that targets instances using a Key,Value
|
17006
18018
|
# combination that you specify.
|
17007
18019
|
#
|
18020
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
18021
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
18022
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
18023
|
+
# Step Functions). For more information about running tasks that do not
|
18024
|
+
# specify targets, see [Registering maintenance window tasks without
|
18025
|
+
# targets][1] in the *AWS Systems Manager User Guide*.
|
18026
|
+
#
|
18027
|
+
# </note>
|
18028
|
+
#
|
17008
18029
|
# Supported formats include the following.
|
17009
18030
|
#
|
17010
18031
|
# * `Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 `
|
@@ -17055,12 +18076,13 @@ module Aws::SSM
|
|
17055
18076
|
# AWS Region where the association was created.
|
17056
18077
|
#
|
17057
18078
|
# For more information about how to send commands that target instances
|
17058
|
-
# using `Key,Value` parameters, see [Targeting multiple instances][
|
18079
|
+
# using `Key,Value` parameters, see [Targeting multiple instances][2] in
|
17059
18080
|
# the *AWS Systems Manager User Guide*.
|
17060
18081
|
#
|
17061
18082
|
#
|
17062
18083
|
#
|
17063
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
18084
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
18085
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting
|
17064
18086
|
#
|
17065
18087
|
# @note When making an API call, you may pass Target
|
17066
18088
|
# data as a hash:
|
@@ -17130,7 +18152,7 @@ module Aws::SSM
|
|
17130
18152
|
#
|
17131
18153
|
# @!attribute [rw] target_location_max_concurrency
|
17132
18154
|
# The maximum number of AWS accounts and AWS regions allowed to run
|
17133
|
-
# the Automation concurrently
|
18155
|
+
# the Automation concurrently.
|
17134
18156
|
# @return [String]
|
17135
18157
|
#
|
17136
18158
|
# @!attribute [rw] target_location_max_errors
|
@@ -17141,7 +18163,8 @@ module Aws::SSM
|
|
17141
18163
|
#
|
17142
18164
|
# @!attribute [rw] execution_role_name
|
17143
18165
|
# The Automation execution role used by the currently running
|
17144
|
-
# Automation.
|
18166
|
+
# Automation. If not specified, the default value is
|
18167
|
+
# `AWS-SystemsManager-AutomationExecutionRole`.
|
17145
18168
|
# @return [String]
|
17146
18169
|
#
|
17147
18170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/TargetLocation AWS API Documentation
|
@@ -17386,6 +18409,15 @@ module Aws::SSM
|
|
17386
18409
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
17387
18410
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
17388
18411
|
# apply_only_at_cron_interval: false,
|
18412
|
+
# target_locations: [
|
18413
|
+
# {
|
18414
|
+
# accounts: ["Account"],
|
18415
|
+
# regions: ["Region"],
|
18416
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
18417
|
+
# target_location_max_errors: "MaxErrors",
|
18418
|
+
# execution_role_name: "ExecutionRoleName",
|
18419
|
+
# },
|
18420
|
+
# ],
|
17389
18421
|
# }
|
17390
18422
|
#
|
17391
18423
|
# @!attribute [rw] association_id
|
@@ -17521,6 +18553,12 @@ module Aws::SSM
|
|
17521
18553
|
# the interval specified.
|
17522
18554
|
# @return [Boolean]
|
17523
18555
|
#
|
18556
|
+
# @!attribute [rw] target_locations
|
18557
|
+
# A location is a combination of AWS Regions and AWS accounts where
|
18558
|
+
# you want to run the association. Use this action to update an
|
18559
|
+
# association in multiple Regions and multiple accounts.
|
18560
|
+
# @return [Array<Types::TargetLocation>]
|
18561
|
+
#
|
17524
18562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationRequest AWS API Documentation
|
17525
18563
|
#
|
17526
18564
|
class UpdateAssociationRequest < Struct.new(
|
@@ -17538,7 +18576,8 @@ module Aws::SSM
|
|
17538
18576
|
:max_concurrency,
|
17539
18577
|
:compliance_severity,
|
17540
18578
|
:sync_compliance,
|
17541
|
-
:apply_only_at_cron_interval
|
18579
|
+
:apply_only_at_cron_interval,
|
18580
|
+
:target_locations)
|
17542
18581
|
SENSITIVE = []
|
17543
18582
|
include Aws::Structure
|
17544
18583
|
end
|
@@ -17643,6 +18682,49 @@ module Aws::SSM
|
|
17643
18682
|
include Aws::Structure
|
17644
18683
|
end
|
17645
18684
|
|
18685
|
+
# @note When making an API call, you may pass UpdateDocumentMetadataRequest
|
18686
|
+
# data as a hash:
|
18687
|
+
#
|
18688
|
+
# {
|
18689
|
+
# name: "DocumentName", # required
|
18690
|
+
# document_version: "DocumentVersion",
|
18691
|
+
# document_reviews: { # required
|
18692
|
+
# action: "SendForReview", # required, accepts SendForReview, UpdateReview, Approve, Reject
|
18693
|
+
# comment: [
|
18694
|
+
# {
|
18695
|
+
# type: "Comment", # accepts Comment
|
18696
|
+
# content: "DocumentReviewComment",
|
18697
|
+
# },
|
18698
|
+
# ],
|
18699
|
+
# },
|
18700
|
+
# }
|
18701
|
+
#
|
18702
|
+
# @!attribute [rw] name
|
18703
|
+
# The name of the document for which a version is to be updated.
|
18704
|
+
# @return [String]
|
18705
|
+
#
|
18706
|
+
# @!attribute [rw] document_version
|
18707
|
+
# The version of a document to update.
|
18708
|
+
# @return [String]
|
18709
|
+
#
|
18710
|
+
# @!attribute [rw] document_reviews
|
18711
|
+
# The document review details to update.
|
18712
|
+
# @return [Types::DocumentReviews]
|
18713
|
+
#
|
18714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataRequest AWS API Documentation
|
18715
|
+
#
|
18716
|
+
class UpdateDocumentMetadataRequest < Struct.new(
|
18717
|
+
:name,
|
18718
|
+
:document_version,
|
18719
|
+
:document_reviews)
|
18720
|
+
SENSITIVE = []
|
18721
|
+
include Aws::Structure
|
18722
|
+
end
|
18723
|
+
|
18724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataResponse AWS API Documentation
|
18725
|
+
#
|
18726
|
+
class UpdateDocumentMetadataResponse < Aws::EmptyStructure; end
|
18727
|
+
|
17646
18728
|
# @note When making an API call, you may pass UpdateDocumentRequest
|
17647
18729
|
# data as a hash:
|
17648
18730
|
#
|
@@ -17759,8 +18841,8 @@ module Aws::SSM
|
|
17759
18841
|
# @!attribute [rw] start_date
|
17760
18842
|
# The time zone that the scheduled maintenance window executions are
|
17761
18843
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17762
|
-
# example: "America/Los\_Angeles", "
|
17763
|
-
#
|
18844
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18845
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17764
18846
|
# website.
|
17765
18847
|
#
|
17766
18848
|
#
|
@@ -17783,8 +18865,8 @@ module Aws::SSM
|
|
17783
18865
|
# @!attribute [rw] schedule_timezone
|
17784
18866
|
# The time zone that the scheduled maintenance window executions are
|
17785
18867
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17786
|
-
# example: "America/Los\_Angeles", "
|
17787
|
-
#
|
18868
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18869
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17788
18870
|
# website.
|
17789
18871
|
#
|
17790
18872
|
#
|
@@ -17799,7 +18881,7 @@ module Aws::SSM
|
|
17799
18881
|
# For example, the following cron expression schedules a maintenance
|
17800
18882
|
# window to run the third Tuesday of every month at 11:30 PM.
|
17801
18883
|
#
|
17802
|
-
# `cron(
|
18884
|
+
# `cron(30 23 ? * TUE#3 *)`
|
17803
18885
|
#
|
17804
18886
|
# If the schedule offset is `2`, the maintenance window won't run
|
17805
18887
|
# until two days later.
|
@@ -17881,8 +18963,8 @@ module Aws::SSM
|
|
17881
18963
|
# @!attribute [rw] schedule_timezone
|
17882
18964
|
# The time zone that the scheduled maintenance window executions are
|
17883
18965
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17884
|
-
# example: "America/Los\_Angeles", "
|
17885
|
-
#
|
18966
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18967
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17886
18968
|
# website.
|
17887
18969
|
#
|
17888
18970
|
#
|
@@ -18117,6 +19199,19 @@ module Aws::SSM
|
|
18117
19199
|
# The targets (either instances or tags) to modify. Instances are
|
18118
19200
|
# specified using Key=instanceids,Values=instanceID\_1,instanceID\_2.
|
18119
19201
|
# Tags are specified using Key=tag\_name,Values=tag\_value.
|
19202
|
+
#
|
19203
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
19204
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
19205
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
19206
|
+
# Step Functions). For more information about running tasks that do
|
19207
|
+
# not specify targets, see [Registering maintenance window tasks
|
19208
|
+
# without targets][1] in the *AWS Systems Manager User Guide*.
|
19209
|
+
#
|
19210
|
+
# </note>
|
19211
|
+
#
|
19212
|
+
#
|
19213
|
+
#
|
19214
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
18120
19215
|
# @return [Array<Types::Target>]
|
18121
19216
|
#
|
18122
19217
|
# @!attribute [rw] task_arn
|
@@ -18191,12 +19286,28 @@ module Aws::SSM
|
|
18191
19286
|
# The new `MaxConcurrency` value you want to specify. `MaxConcurrency`
|
18192
19287
|
# is the number of targets that are allowed to run this task in
|
18193
19288
|
# parallel.
|
19289
|
+
#
|
19290
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
19291
|
+
# supply a value for this option. Instead, the system inserts a
|
19292
|
+
# placeholder value of `1`, which may be reported in the response to
|
19293
|
+
# this command. This value does not affect the running of your task
|
19294
|
+
# and can be ignored.
|
19295
|
+
#
|
19296
|
+
# </note>
|
18194
19297
|
# @return [String]
|
18195
19298
|
#
|
18196
19299
|
# @!attribute [rw] max_errors
|
18197
19300
|
# The new `MaxErrors` value to specify. `MaxErrors` is the maximum
|
18198
19301
|
# number of errors that are allowed before the task stops being
|
18199
19302
|
# scheduled.
|
19303
|
+
#
|
19304
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
19305
|
+
# supply a value for this option. Instead, the system inserts a
|
19306
|
+
# placeholder value of `1`, which may be reported in the response to
|
19307
|
+
# this command. This value does not affect the running of your task
|
19308
|
+
# and can be ignored.
|
19309
|
+
#
|
19310
|
+
# </note>
|
18200
19311
|
# @return [String]
|
18201
19312
|
#
|
18202
19313
|
# @!attribute [rw] logging_info
|
@@ -18390,11 +19501,15 @@ module Aws::SSM
|
|
18390
19501
|
# ops_item_id: "String", # required
|
18391
19502
|
# },
|
18392
19503
|
# ],
|
18393
|
-
# status: "Open", # accepts Open, InProgress, Resolved
|
19504
|
+
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
|
18394
19505
|
# ops_item_id: "OpsItemId", # required
|
18395
19506
|
# title: "OpsItemTitle",
|
18396
19507
|
# category: "OpsItemCategory",
|
18397
19508
|
# severity: "OpsItemSeverity",
|
19509
|
+
# actual_start_time: Time.now,
|
19510
|
+
# actual_end_time: Time.now,
|
19511
|
+
# planned_start_time: Time.now,
|
19512
|
+
# planned_end_time: Time.now,
|
18398
19513
|
# }
|
18399
19514
|
#
|
18400
19515
|
# @!attribute [rw] description
|
@@ -18484,6 +19599,28 @@ module Aws::SSM
|
|
18484
19599
|
# Specify a new severity for an OpsItem.
|
18485
19600
|
# @return [String]
|
18486
19601
|
#
|
19602
|
+
# @!attribute [rw] actual_start_time
|
19603
|
+
# The time a runbook workflow started. Currently reported only for the
|
19604
|
+
# OpsItem type `/aws/changerequest`.
|
19605
|
+
# @return [Time]
|
19606
|
+
#
|
19607
|
+
# @!attribute [rw] actual_end_time
|
19608
|
+
# The time a runbook workflow ended. Currently reported only for the
|
19609
|
+
# OpsItem type `/aws/changerequest`.
|
19610
|
+
# @return [Time]
|
19611
|
+
#
|
19612
|
+
# @!attribute [rw] planned_start_time
|
19613
|
+
# The time specified in a change request for a runbook workflow to
|
19614
|
+
# start. Currently supported only for the OpsItem type
|
19615
|
+
# `/aws/changerequest`.
|
19616
|
+
# @return [Time]
|
19617
|
+
#
|
19618
|
+
# @!attribute [rw] planned_end_time
|
19619
|
+
# The time specified in a change request for a runbook workflow to
|
19620
|
+
# end. Currently supported only for the OpsItem type
|
19621
|
+
# `/aws/changerequest`.
|
19622
|
+
# @return [Time]
|
19623
|
+
#
|
18487
19624
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItemRequest AWS API Documentation
|
18488
19625
|
#
|
18489
19626
|
class UpdateOpsItemRequest < Struct.new(
|
@@ -18497,7 +19634,11 @@ module Aws::SSM
|
|
18497
19634
|
:ops_item_id,
|
18498
19635
|
:title,
|
18499
19636
|
:category,
|
18500
|
-
:severity
|
19637
|
+
:severity,
|
19638
|
+
:actual_start_time,
|
19639
|
+
:actual_end_time,
|
19640
|
+
:planned_start_time,
|
19641
|
+
:planned_end_time)
|
18501
19642
|
SENSITIVE = []
|
18502
19643
|
include Aws::Structure
|
18503
19644
|
end
|