aws-sdk-ssm 1.99.0 → 1.100.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 +545 -31
- data/lib/aws-sdk-ssm/client_api.rb +257 -0
- data/lib/aws-sdk-ssm/errors.rb +16 -0
- data/lib/aws-sdk-ssm/types.rb +1068 -59
- 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}
|
@@ -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,7 +1214,7 @@ 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
|
#
|
@@ -1289,6 +1355,40 @@ module Aws::SSM
|
|
1289
1355
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html
|
1290
1356
|
# @return [String]
|
1291
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
|
+
#
|
1292
1392
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecutionMetadata AWS API Documentation
|
1293
1393
|
#
|
1294
1394
|
class AutomationExecutionMetadata < Struct.new(
|
@@ -1313,7 +1413,13 @@ module Aws::SSM
|
|
1313
1413
|
:max_concurrency,
|
1314
1414
|
:max_errors,
|
1315
1415
|
:target,
|
1316
|
-
:automation_type
|
1416
|
+
:automation_type,
|
1417
|
+
:automation_subtype,
|
1418
|
+
:scheduled_time,
|
1419
|
+
:runbooks,
|
1420
|
+
:ops_item_id,
|
1421
|
+
:association_id,
|
1422
|
+
:change_request_name)
|
1317
1423
|
SENSITIVE = []
|
1318
1424
|
include Aws::Structure
|
1319
1425
|
end
|
@@ -2434,6 +2540,15 @@ module Aws::SSM
|
|
2434
2540
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2435
2541
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2436
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
|
+
# ],
|
2437
2552
|
# },
|
2438
2553
|
# ],
|
2439
2554
|
# }
|
@@ -2484,6 +2599,15 @@ module Aws::SSM
|
|
2484
2599
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2485
2600
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2486
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
|
+
# ],
|
2487
2611
|
# }
|
2488
2612
|
#
|
2489
2613
|
# @!attribute [rw] name
|
@@ -2603,6 +2727,11 @@ module Aws::SSM
|
|
2603
2727
|
# supported for rate expressions.
|
2604
2728
|
# @return [Boolean]
|
2605
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
|
+
#
|
2606
2735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationBatchRequestEntry AWS API Documentation
|
2607
2736
|
#
|
2608
2737
|
class CreateAssociationBatchRequestEntry < Struct.new(
|
@@ -2619,7 +2748,8 @@ module Aws::SSM
|
|
2619
2748
|
:max_concurrency,
|
2620
2749
|
:compliance_severity,
|
2621
2750
|
:sync_compliance,
|
2622
|
-
:apply_only_at_cron_interval
|
2751
|
+
:apply_only_at_cron_interval,
|
2752
|
+
:target_locations)
|
2623
2753
|
SENSITIVE = []
|
2624
2754
|
include Aws::Structure
|
2625
2755
|
end
|
@@ -2672,6 +2802,15 @@ module Aws::SSM
|
|
2672
2802
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2673
2803
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2674
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
|
+
# ],
|
2675
2814
|
# }
|
2676
2815
|
#
|
2677
2816
|
# @!attribute [rw] name
|
@@ -2812,6 +2951,12 @@ module Aws::SSM
|
|
2812
2951
|
# supported for rate expressions.
|
2813
2952
|
# @return [Boolean]
|
2814
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
|
+
#
|
2815
2960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationRequest AWS API Documentation
|
2816
2961
|
#
|
2817
2962
|
class CreateAssociationRequest < Struct.new(
|
@@ -2828,7 +2973,8 @@ module Aws::SSM
|
|
2828
2973
|
:max_concurrency,
|
2829
2974
|
:compliance_severity,
|
2830
2975
|
:sync_compliance,
|
2831
|
-
:apply_only_at_cron_interval
|
2976
|
+
:apply_only_at_cron_interval,
|
2977
|
+
:target_locations)
|
2832
2978
|
SENSITIVE = []
|
2833
2979
|
include Aws::Structure
|
2834
2980
|
end
|
@@ -2865,7 +3011,7 @@ module Aws::SSM
|
|
2865
3011
|
# ],
|
2866
3012
|
# name: "DocumentName", # required
|
2867
3013
|
# version_name: "DocumentVersionName",
|
2868
|
-
# 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
|
2869
3015
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
2870
3016
|
# target_type: "TargetType",
|
2871
3017
|
# tags: [
|
@@ -3060,8 +3206,8 @@ module Aws::SSM
|
|
3060
3206
|
# @!attribute [rw] schedule_timezone
|
3061
3207
|
# The time zone that the scheduled maintenance window executions are
|
3062
3208
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
3063
|
-
# example: "America/Los\_Angeles", "
|
3064
|
-
#
|
3209
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
3210
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
3065
3211
|
# website.
|
3066
3212
|
#
|
3067
3213
|
#
|
@@ -3076,7 +3222,7 @@ module Aws::SSM
|
|
3076
3222
|
# For example, the following cron expression schedules a maintenance
|
3077
3223
|
# window to run on the third Tuesday of every month at 11:30 PM.
|
3078
3224
|
#
|
3079
|
-
# `cron(
|
3225
|
+
# `cron(30 23 ? * TUE#3 *)`
|
3080
3226
|
#
|
3081
3227
|
# If the schedule offset is `2`, the maintenance window won't run
|
3082
3228
|
# until two days later.
|
@@ -3165,6 +3311,7 @@ module Aws::SSM
|
|
3165
3311
|
#
|
3166
3312
|
# {
|
3167
3313
|
# description: "OpsItemDescription", # required
|
3314
|
+
# ops_item_type: "OpsItemType",
|
3168
3315
|
# operational_data: {
|
3169
3316
|
# "OpsItemDataKey" => {
|
3170
3317
|
# value: "OpsItemDataValueString",
|
@@ -3192,12 +3339,21 @@ module Aws::SSM
|
|
3192
3339
|
# ],
|
3193
3340
|
# category: "OpsItemCategory",
|
3194
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,
|
3195
3346
|
# }
|
3196
3347
|
#
|
3197
3348
|
# @!attribute [rw] description
|
3198
3349
|
# Information about the OpsItem.
|
3199
3350
|
# @return [String]
|
3200
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
|
+
#
|
3201
3357
|
# @!attribute [rw] operational_data
|
3202
3358
|
# Operational data is custom data that provides useful reference
|
3203
3359
|
# details about the OpsItem. For example, you can specify log files,
|
@@ -3287,10 +3443,33 @@ module Aws::SSM
|
|
3287
3443
|
# Specify a severity to assign to an OpsItem.
|
3288
3444
|
# @return [String]
|
3289
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
|
+
#
|
3290
3468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItemRequest AWS API Documentation
|
3291
3469
|
#
|
3292
3470
|
class CreateOpsItemRequest < Struct.new(
|
3293
3471
|
:description,
|
3472
|
+
:ops_item_type,
|
3294
3473
|
:operational_data,
|
3295
3474
|
:notifications,
|
3296
3475
|
:priority,
|
@@ -3299,7 +3478,11 @@ module Aws::SSM
|
|
3299
3478
|
:title,
|
3300
3479
|
:tags,
|
3301
3480
|
:category,
|
3302
|
-
:severity
|
3481
|
+
:severity,
|
3482
|
+
:actual_start_time,
|
3483
|
+
:actual_end_time,
|
3484
|
+
:planned_start_time,
|
3485
|
+
:planned_end_time)
|
3303
3486
|
SENSITIVE = []
|
3304
3487
|
include Aws::Structure
|
3305
3488
|
end
|
@@ -3329,11 +3512,11 @@ module Aws::SSM
|
|
3329
3512
|
# }
|
3330
3513
|
#
|
3331
3514
|
# @!attribute [rw] resource_id
|
3332
|
-
# A resource ID for a new
|
3515
|
+
# A resource ID for a new Application Manager application.
|
3333
3516
|
# @return [String]
|
3334
3517
|
#
|
3335
3518
|
# @!attribute [rw] metadata
|
3336
|
-
# Metadata for a new
|
3519
|
+
# Metadata for a new Application Manager application.
|
3337
3520
|
# @return [Hash<String,Types::MetadataValue>]
|
3338
3521
|
#
|
3339
3522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsMetadataRequest AWS API Documentation
|
@@ -4453,7 +4636,7 @@ module Aws::SSM
|
|
4453
4636
|
# {
|
4454
4637
|
# filters: [
|
4455
4638
|
# {
|
4456
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup
|
4639
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
|
4457
4640
|
# values: ["AutomationExecutionFilterValue"], # required
|
4458
4641
|
# },
|
4459
4642
|
# ],
|
@@ -5764,7 +5947,7 @@ module Aws::SSM
|
|
5764
5947
|
# {
|
5765
5948
|
# ops_item_filters: [
|
5766
5949
|
# {
|
5767
|
-
# 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
|
5768
5951
|
# values: ["OpsItemFilterValue"], # required
|
5769
5952
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
5770
5953
|
# },
|
@@ -6448,6 +6631,27 @@ module Aws::SSM
|
|
6448
6631
|
# `ApplicationConfigurationSchema` document.
|
6449
6632
|
# @return [Array<Types::DocumentRequires>]
|
6450
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
|
+
#
|
6451
6655
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentDescription AWS API Documentation
|
6452
6656
|
#
|
6453
6657
|
class DocumentDescription < Struct.new(
|
@@ -6472,7 +6676,12 @@ module Aws::SSM
|
|
6472
6676
|
:target_type,
|
6473
6677
|
:tags,
|
6474
6678
|
:attachments_information,
|
6475
|
-
:requires
|
6679
|
+
:requires,
|
6680
|
+
:author,
|
6681
|
+
:review_information,
|
6682
|
+
:approved_version,
|
6683
|
+
:pending_review_version,
|
6684
|
+
:review_status)
|
6476
6685
|
SENSITIVE = []
|
6477
6686
|
include Aws::Structure
|
6478
6687
|
end
|
@@ -6561,6 +6770,14 @@ module Aws::SSM
|
|
6561
6770
|
# `ApplicationConfigurationSchema` document.
|
6562
6771
|
# @return [Array<Types::DocumentRequires>]
|
6563
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
|
+
#
|
6564
6781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentIdentifier AWS API Documentation
|
6565
6782
|
#
|
6566
6783
|
class DocumentIdentifier < Struct.new(
|
@@ -6574,7 +6791,9 @@ module Aws::SSM
|
|
6574
6791
|
:document_format,
|
6575
6792
|
:target_type,
|
6576
6793
|
:tags,
|
6577
|
-
:requires
|
6794
|
+
:requires,
|
6795
|
+
:review_status,
|
6796
|
+
:author)
|
6578
6797
|
SENSITIVE = []
|
6579
6798
|
include Aws::Structure
|
6580
6799
|
end
|
@@ -6695,6 +6914,20 @@ module Aws::SSM
|
|
6695
6914
|
include Aws::Structure
|
6696
6915
|
end
|
6697
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
|
+
|
6698
6931
|
# Parameters specified in a System Manager document that run on the
|
6699
6932
|
# server when the command is run.
|
6700
6933
|
#
|
@@ -6772,6 +7005,114 @@ module Aws::SSM
|
|
6772
7005
|
include Aws::Structure
|
6773
7006
|
end
|
6774
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
|
+
|
6775
7116
|
# Version information about the document.
|
6776
7117
|
#
|
6777
7118
|
# @!attribute [rw] name
|
@@ -6812,6 +7153,11 @@ module Aws::SSM
|
|
6812
7153
|
# exist. Verify that the URL of the S3 bucket is correct."
|
6813
7154
|
# @return [String]
|
6814
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
|
+
#
|
6815
7161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentVersionInfo AWS API Documentation
|
6816
7162
|
#
|
6817
7163
|
class DocumentVersionInfo < Struct.new(
|
@@ -6822,7 +7168,8 @@ module Aws::SSM
|
|
6822
7168
|
:is_default_version,
|
6823
7169
|
:document_format,
|
6824
7170
|
:status,
|
6825
|
-
:status_information
|
7171
|
+
:status_information,
|
7172
|
+
:review_status)
|
6826
7173
|
SENSITIVE = []
|
6827
7174
|
include Aws::Structure
|
6828
7175
|
end
|
@@ -7527,6 +7874,19 @@ module Aws::SSM
|
|
7527
7874
|
# locations, sizes, and so on.
|
7528
7875
|
# @return [Array<Types::AttachmentContent>]
|
7529
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
|
+
#
|
7530
7890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocumentResult AWS API Documentation
|
7531
7891
|
#
|
7532
7892
|
class GetDocumentResult < Struct.new(
|
@@ -7539,7 +7899,8 @@ module Aws::SSM
|
|
7539
7899
|
:document_type,
|
7540
7900
|
:document_format,
|
7541
7901
|
:requires,
|
7542
|
-
:attachments_content
|
7902
|
+
:attachments_content,
|
7903
|
+
:review_status)
|
7543
7904
|
SENSITIVE = []
|
7544
7905
|
include Aws::Structure
|
7545
7906
|
end
|
@@ -8039,8 +8400,8 @@ module Aws::SSM
|
|
8039
8400
|
# @!attribute [rw] schedule_timezone
|
8040
8401
|
# The time zone that the scheduled maintenance window executions are
|
8041
8402
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
8042
|
-
# example: "America/Los\_Angeles", "
|
8043
|
-
#
|
8403
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
8404
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
8044
8405
|
# website.
|
8045
8406
|
#
|
8046
8407
|
#
|
@@ -8301,11 +8662,11 @@ module Aws::SSM
|
|
8301
8662
|
end
|
8302
8663
|
|
8303
8664
|
# @!attribute [rw] resource_id
|
8304
|
-
# The resource ID of the
|
8665
|
+
# The resource ID of the Application Manager application.
|
8305
8666
|
# @return [String]
|
8306
8667
|
#
|
8307
8668
|
# @!attribute [rw] metadata
|
8308
|
-
# OpsMetadata for an
|
8669
|
+
# OpsMetadata for an Application Manager application.
|
8309
8670
|
# @return [Hash<String,Types::MetadataValue>]
|
8310
8671
|
#
|
8311
8672
|
# @!attribute [rw] next_token
|
@@ -9107,7 +9468,8 @@ module Aws::SSM
|
|
9107
9468
|
# @return [String]
|
9108
9469
|
#
|
9109
9470
|
# @!attribute [rw] last_ping_date_time
|
9110
|
-
# The date and time when agent last pinged Systems Manager
|
9471
|
+
# The date and time when the agent last pinged the Systems Manager
|
9472
|
+
# service.
|
9111
9473
|
# @return [Time]
|
9112
9474
|
#
|
9113
9475
|
# @!attribute [rw] agent_version
|
@@ -11073,6 +11435,88 @@ module Aws::SSM
|
|
11073
11435
|
include Aws::Structure
|
11074
11436
|
end
|
11075
11437
|
|
11438
|
+
# @note When making an API call, you may pass ListDocumentMetadataHistoryRequest
|
11439
|
+
# data as a hash:
|
11440
|
+
#
|
11441
|
+
# {
|
11442
|
+
# name: "DocumentName", # required
|
11443
|
+
# document_version: "DocumentVersion",
|
11444
|
+
# metadata: "DocumentReviews", # required, accepts DocumentReviews
|
11445
|
+
# next_token: "NextToken",
|
11446
|
+
# max_results: 1,
|
11447
|
+
# }
|
11448
|
+
#
|
11449
|
+
# @!attribute [rw] name
|
11450
|
+
# The name of the document.
|
11451
|
+
# @return [String]
|
11452
|
+
#
|
11453
|
+
# @!attribute [rw] document_version
|
11454
|
+
# The version of the document.
|
11455
|
+
# @return [String]
|
11456
|
+
#
|
11457
|
+
# @!attribute [rw] metadata
|
11458
|
+
# The type of data for which details are being requested. Currently,
|
11459
|
+
# the only supported value is `DocumentReviews`.
|
11460
|
+
# @return [String]
|
11461
|
+
#
|
11462
|
+
# @!attribute [rw] next_token
|
11463
|
+
# The token for the next set of items to return. (You received this
|
11464
|
+
# token from a previous call.)
|
11465
|
+
# @return [String]
|
11466
|
+
#
|
11467
|
+
# @!attribute [rw] max_results
|
11468
|
+
# The maximum number of items to return for this call. The call also
|
11469
|
+
# returns a token that you can specify in a subsequent call to get the
|
11470
|
+
# next set of results.
|
11471
|
+
# @return [Integer]
|
11472
|
+
#
|
11473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistoryRequest AWS API Documentation
|
11474
|
+
#
|
11475
|
+
class ListDocumentMetadataHistoryRequest < Struct.new(
|
11476
|
+
:name,
|
11477
|
+
:document_version,
|
11478
|
+
:metadata,
|
11479
|
+
:next_token,
|
11480
|
+
:max_results)
|
11481
|
+
SENSITIVE = []
|
11482
|
+
include Aws::Structure
|
11483
|
+
end
|
11484
|
+
|
11485
|
+
# @!attribute [rw] name
|
11486
|
+
# The name of the document.
|
11487
|
+
# @return [String]
|
11488
|
+
#
|
11489
|
+
# @!attribute [rw] document_version
|
11490
|
+
# The version of the document.
|
11491
|
+
# @return [String]
|
11492
|
+
#
|
11493
|
+
# @!attribute [rw] author
|
11494
|
+
# The user ID of the person in the organization who requested the
|
11495
|
+
# document review.
|
11496
|
+
# @return [String]
|
11497
|
+
#
|
11498
|
+
# @!attribute [rw] metadata
|
11499
|
+
# Information about the response to the document approval request.
|
11500
|
+
# @return [Types::DocumentMetadataResponseInfo]
|
11501
|
+
#
|
11502
|
+
# @!attribute [rw] next_token
|
11503
|
+
# The maximum number of items to return for this call. The call also
|
11504
|
+
# returns a token that you can specify in a subsequent call to get the
|
11505
|
+
# next set of results.
|
11506
|
+
# @return [String]
|
11507
|
+
#
|
11508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistoryResponse AWS API Documentation
|
11509
|
+
#
|
11510
|
+
class ListDocumentMetadataHistoryResponse < Struct.new(
|
11511
|
+
:name,
|
11512
|
+
:document_version,
|
11513
|
+
:author,
|
11514
|
+
:metadata,
|
11515
|
+
:next_token)
|
11516
|
+
SENSITIVE = []
|
11517
|
+
include Aws::Structure
|
11518
|
+
end
|
11519
|
+
|
11076
11520
|
# @note When making an API call, you may pass ListDocumentVersionsRequest
|
11077
11521
|
# data as a hash:
|
11078
11522
|
#
|
@@ -11293,24 +11737,25 @@ module Aws::SSM
|
|
11293
11737
|
include Aws::Structure
|
11294
11738
|
end
|
11295
11739
|
|
11296
|
-
# @note When making an API call, you may pass
|
11740
|
+
# @note When making an API call, you may pass ListOpsItemEventsRequest
|
11297
11741
|
# data as a hash:
|
11298
11742
|
#
|
11299
11743
|
# {
|
11300
11744
|
# filters: [
|
11301
11745
|
# {
|
11302
|
-
# key: "
|
11303
|
-
# values: ["
|
11746
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
11747
|
+
# values: ["OpsItemEventFilterValue"], # required
|
11748
|
+
# operator: "Equal", # required, accepts Equal
|
11304
11749
|
# },
|
11305
11750
|
# ],
|
11306
11751
|
# max_results: 1,
|
11307
|
-
# next_token: "
|
11752
|
+
# next_token: "String",
|
11308
11753
|
# }
|
11309
11754
|
#
|
11310
11755
|
# @!attribute [rw] filters
|
11311
|
-
# One or more filters
|
11312
|
-
#
|
11313
|
-
# @return [Array<Types::
|
11756
|
+
# One or more OpsItem filters. Use a filter to return a more specific
|
11757
|
+
# list of results.
|
11758
|
+
# @return [Array<Types::OpsItemEventFilter>]
|
11314
11759
|
#
|
11315
11760
|
# @!attribute [rw] max_results
|
11316
11761
|
# The maximum number of items to return for this call. The call also
|
@@ -11323,9 +11768,9 @@ module Aws::SSM
|
|
11323
11768
|
# results.
|
11324
11769
|
# @return [String]
|
11325
11770
|
#
|
11326
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/
|
11771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEventsRequest AWS API Documentation
|
11327
11772
|
#
|
11328
|
-
class
|
11773
|
+
class ListOpsItemEventsRequest < Struct.new(
|
11329
11774
|
:filters,
|
11330
11775
|
:max_results,
|
11331
11776
|
:next_token)
|
@@ -11333,8 +11778,66 @@ module Aws::SSM
|
|
11333
11778
|
include Aws::Structure
|
11334
11779
|
end
|
11335
11780
|
|
11336
|
-
# @!attribute [rw]
|
11337
|
-
#
|
11781
|
+
# @!attribute [rw] next_token
|
11782
|
+
# The token for the next set of items to return. Use this token to get
|
11783
|
+
# the next set of results.
|
11784
|
+
# @return [String]
|
11785
|
+
#
|
11786
|
+
# @!attribute [rw] summaries
|
11787
|
+
# A list of event information for the specified OpsItems.
|
11788
|
+
# @return [Array<Types::OpsItemEventSummary>]
|
11789
|
+
#
|
11790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEventsResponse AWS API Documentation
|
11791
|
+
#
|
11792
|
+
class ListOpsItemEventsResponse < Struct.new(
|
11793
|
+
:next_token,
|
11794
|
+
:summaries)
|
11795
|
+
SENSITIVE = []
|
11796
|
+
include Aws::Structure
|
11797
|
+
end
|
11798
|
+
|
11799
|
+
# @note When making an API call, you may pass ListOpsMetadataRequest
|
11800
|
+
# data as a hash:
|
11801
|
+
#
|
11802
|
+
# {
|
11803
|
+
# filters: [
|
11804
|
+
# {
|
11805
|
+
# key: "OpsMetadataFilterKey", # required
|
11806
|
+
# values: ["OpsMetadataFilterValue"], # required
|
11807
|
+
# },
|
11808
|
+
# ],
|
11809
|
+
# max_results: 1,
|
11810
|
+
# next_token: "NextToken",
|
11811
|
+
# }
|
11812
|
+
#
|
11813
|
+
# @!attribute [rw] filters
|
11814
|
+
# One or more filters to limit the number of OpsMetadata objects
|
11815
|
+
# returned by the call.
|
11816
|
+
# @return [Array<Types::OpsMetadataFilter>]
|
11817
|
+
#
|
11818
|
+
# @!attribute [rw] max_results
|
11819
|
+
# The maximum number of items to return for this call. The call also
|
11820
|
+
# returns a token that you can specify in a subsequent call to get the
|
11821
|
+
# next set of results.
|
11822
|
+
# @return [Integer]
|
11823
|
+
#
|
11824
|
+
# @!attribute [rw] next_token
|
11825
|
+
# A token to start the list. Use this token to get the next set of
|
11826
|
+
# results.
|
11827
|
+
# @return [String]
|
11828
|
+
#
|
11829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsMetadataRequest AWS API Documentation
|
11830
|
+
#
|
11831
|
+
class ListOpsMetadataRequest < Struct.new(
|
11832
|
+
:filters,
|
11833
|
+
:max_results,
|
11834
|
+
:next_token)
|
11835
|
+
SENSITIVE = []
|
11836
|
+
include Aws::Structure
|
11837
|
+
end
|
11838
|
+
|
11839
|
+
# @!attribute [rw] ops_metadata_list
|
11840
|
+
# Returns a list of OpsMetadata objects.
|
11338
11841
|
# @return [Array<Types::OpsMetadata>]
|
11339
11842
|
#
|
11340
11843
|
# @!attribute [rw] next_token
|
@@ -12394,7 +12897,7 @@ module Aws::SSM
|
|
12394
12897
|
include Aws::Structure
|
12395
12898
|
end
|
12396
12899
|
|
12397
|
-
# Metadata to assign to an
|
12900
|
+
# Metadata to assign to an Application Manager application.
|
12398
12901
|
#
|
12399
12902
|
# @note When making an API call, you may pass MetadataValue
|
12400
12903
|
# data as a hash:
|
@@ -12404,7 +12907,7 @@ module Aws::SSM
|
|
12404
12907
|
# }
|
12405
12908
|
#
|
12406
12909
|
# @!attribute [rw] value
|
12407
|
-
# Metadata value to assign to an
|
12910
|
+
# Metadata value to assign to an Application Manager application.
|
12408
12911
|
# @return [String]
|
12409
12912
|
#
|
12410
12913
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MetadataValue AWS API Documentation
|
@@ -12701,6 +13204,11 @@ module Aws::SSM
|
|
12701
13204
|
# The ARN of the AWS account that created the OpsItem.
|
12702
13205
|
# @return [String]
|
12703
13206
|
#
|
13207
|
+
# @!attribute [rw] ops_item_type
|
13208
|
+
# The type of OpsItem. Currently, the only valid values are
|
13209
|
+
# `/aws/changerequest` and `/aws/issue`.
|
13210
|
+
# @return [String]
|
13211
|
+
#
|
12704
13212
|
# @!attribute [rw] created_time
|
12705
13213
|
# The date and time the OpsItem was created.
|
12706
13214
|
# @return [Time]
|
@@ -12802,10 +13310,33 @@ module Aws::SSM
|
|
12802
13310
|
# The severity of the OpsItem. Severity options range from 1 to 4.
|
12803
13311
|
# @return [String]
|
12804
13312
|
#
|
13313
|
+
# @!attribute [rw] actual_start_time
|
13314
|
+
# The time a runbook workflow started. Currently reported only for the
|
13315
|
+
# OpsItem type `/aws/changerequest`.
|
13316
|
+
# @return [Time]
|
13317
|
+
#
|
13318
|
+
# @!attribute [rw] actual_end_time
|
13319
|
+
# The time a runbook workflow ended. Currently reported only for the
|
13320
|
+
# OpsItem type `/aws/changerequest`.
|
13321
|
+
# @return [Time]
|
13322
|
+
#
|
13323
|
+
# @!attribute [rw] planned_start_time
|
13324
|
+
# The time specified in a change request for a runbook workflow to
|
13325
|
+
# start. Currently supported only for the OpsItem type
|
13326
|
+
# `/aws/changerequest`.
|
13327
|
+
# @return [Time]
|
13328
|
+
#
|
13329
|
+
# @!attribute [rw] planned_end_time
|
13330
|
+
# The time specified in a change request for a runbook workflow to
|
13331
|
+
# end. Currently supported only for the OpsItem type
|
13332
|
+
# `/aws/changerequest`.
|
13333
|
+
# @return [Time]
|
13334
|
+
#
|
12805
13335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItem AWS API Documentation
|
12806
13336
|
#
|
12807
13337
|
class OpsItem < Struct.new(
|
12808
13338
|
:created_by,
|
13339
|
+
:ops_item_type,
|
12809
13340
|
:created_time,
|
12810
13341
|
:description,
|
12811
13342
|
:last_modified_by,
|
@@ -12820,7 +13351,11 @@ module Aws::SSM
|
|
12820
13351
|
:source,
|
12821
13352
|
:operational_data,
|
12822
13353
|
:category,
|
12823
|
-
:severity
|
13354
|
+
:severity,
|
13355
|
+
:actual_start_time,
|
13356
|
+
:actual_end_time,
|
13357
|
+
:planned_start_time,
|
13358
|
+
:planned_end_time)
|
12824
13359
|
SENSITIVE = []
|
12825
13360
|
include Aws::Structure
|
12826
13361
|
end
|
@@ -12871,13 +13406,95 @@ module Aws::SSM
|
|
12871
13406
|
include Aws::Structure
|
12872
13407
|
end
|
12873
13408
|
|
13409
|
+
# Describes a filter for a specific list of OpsItem events. You can
|
13410
|
+
# filter event information by using tags. You specify tags by using a
|
13411
|
+
# key-value pair mapping.
|
13412
|
+
#
|
13413
|
+
# @note When making an API call, you may pass OpsItemEventFilter
|
13414
|
+
# data as a hash:
|
13415
|
+
#
|
13416
|
+
# {
|
13417
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
13418
|
+
# values: ["OpsItemEventFilterValue"], # required
|
13419
|
+
# operator: "Equal", # required, accepts Equal
|
13420
|
+
# }
|
13421
|
+
#
|
13422
|
+
# @!attribute [rw] key
|
13423
|
+
# The name of the filter key. Currently, the only supported value is
|
13424
|
+
# `OpsItemId`.
|
13425
|
+
# @return [String]
|
13426
|
+
#
|
13427
|
+
# @!attribute [rw] values
|
13428
|
+
# The values for the filter, consisting of one or more OpsItem IDs.
|
13429
|
+
# @return [Array<String>]
|
13430
|
+
#
|
13431
|
+
# @!attribute [rw] operator
|
13432
|
+
# The operator used by the filter call. Currently, the only supported
|
13433
|
+
# value is `Equal`.
|
13434
|
+
# @return [String]
|
13435
|
+
#
|
13436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemEventFilter AWS API Documentation
|
13437
|
+
#
|
13438
|
+
class OpsItemEventFilter < Struct.new(
|
13439
|
+
:key,
|
13440
|
+
:values,
|
13441
|
+
:operator)
|
13442
|
+
SENSITIVE = []
|
13443
|
+
include Aws::Structure
|
13444
|
+
end
|
13445
|
+
|
13446
|
+
# Summary information about an OpsItem event.
|
13447
|
+
#
|
13448
|
+
# @!attribute [rw] ops_item_id
|
13449
|
+
# The ID of the OpsItem.
|
13450
|
+
# @return [String]
|
13451
|
+
#
|
13452
|
+
# @!attribute [rw] event_id
|
13453
|
+
# The ID of the OpsItem event.
|
13454
|
+
# @return [String]
|
13455
|
+
#
|
13456
|
+
# @!attribute [rw] source
|
13457
|
+
# The source of the OpsItem event.
|
13458
|
+
# @return [String]
|
13459
|
+
#
|
13460
|
+
# @!attribute [rw] detail_type
|
13461
|
+
# The type of information provided as a detail.
|
13462
|
+
# @return [String]
|
13463
|
+
#
|
13464
|
+
# @!attribute [rw] detail
|
13465
|
+
# Specific information about the OpsItem event.
|
13466
|
+
# @return [String]
|
13467
|
+
#
|
13468
|
+
# @!attribute [rw] created_by
|
13469
|
+
# Information about the user or resource that created the OpsItem
|
13470
|
+
# event.
|
13471
|
+
# @return [Types::OpsItemIdentity]
|
13472
|
+
#
|
13473
|
+
# @!attribute [rw] created_time
|
13474
|
+
# The date and time the OpsItem event was created.
|
13475
|
+
# @return [Time]
|
13476
|
+
#
|
13477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemEventSummary AWS API Documentation
|
13478
|
+
#
|
13479
|
+
class OpsItemEventSummary < Struct.new(
|
13480
|
+
:ops_item_id,
|
13481
|
+
:event_id,
|
13482
|
+
:source,
|
13483
|
+
:detail_type,
|
13484
|
+
:detail,
|
13485
|
+
:created_by,
|
13486
|
+
:created_time)
|
13487
|
+
SENSITIVE = []
|
13488
|
+
include Aws::Structure
|
13489
|
+
end
|
13490
|
+
|
12874
13491
|
# Describes an OpsItem filter.
|
12875
13492
|
#
|
12876
13493
|
# @note When making an API call, you may pass OpsItemFilter
|
12877
13494
|
# data as a hash:
|
12878
13495
|
#
|
12879
13496
|
# {
|
12880
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity
|
13497
|
+
# 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
13498
|
# values: ["OpsItemFilterValue"], # required
|
12882
13499
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
12883
13500
|
# }
|
@@ -12904,6 +13521,21 @@ module Aws::SSM
|
|
12904
13521
|
include Aws::Structure
|
12905
13522
|
end
|
12906
13523
|
|
13524
|
+
# Information about the user or resource that created an OpsItem event.
|
13525
|
+
#
|
13526
|
+
# @!attribute [rw] arn
|
13527
|
+
# The Amazon Resource Name (ARN) of the IAM entity that created the
|
13528
|
+
# OpsItem event.
|
13529
|
+
# @return [String]
|
13530
|
+
#
|
13531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemIdentity AWS API Documentation
|
13532
|
+
#
|
13533
|
+
class OpsItemIdentity < Struct.new(
|
13534
|
+
:arn)
|
13535
|
+
SENSITIVE = []
|
13536
|
+
include Aws::Structure
|
13537
|
+
end
|
13538
|
+
|
12907
13539
|
# A specified parameter argument isn't valid. Verify the available
|
12908
13540
|
# arguments and try again.
|
12909
13541
|
#
|
@@ -13044,6 +13676,33 @@ module Aws::SSM
|
|
13044
13676
|
# A list of OpsItems by severity.
|
13045
13677
|
# @return [String]
|
13046
13678
|
#
|
13679
|
+
# @!attribute [rw] ops_item_type
|
13680
|
+
# The type of OpsItem. Currently, the only valid values are
|
13681
|
+
# `/aws/changerequest` and `/aws/issue`.
|
13682
|
+
# @return [String]
|
13683
|
+
#
|
13684
|
+
# @!attribute [rw] actual_start_time
|
13685
|
+
# The time a runbook workflow started. Currently reported only for the
|
13686
|
+
# OpsItem type `/aws/changerequest`.
|
13687
|
+
# @return [Time]
|
13688
|
+
#
|
13689
|
+
# @!attribute [rw] actual_end_time
|
13690
|
+
# The time a runbook workflow ended. Currently reported only for the
|
13691
|
+
# OpsItem type `/aws/changerequest`.
|
13692
|
+
# @return [Time]
|
13693
|
+
#
|
13694
|
+
# @!attribute [rw] planned_start_time
|
13695
|
+
# The time specified in a change request for a runbook workflow to
|
13696
|
+
# start. Currently supported only for the OpsItem type
|
13697
|
+
# `/aws/changerequest`.
|
13698
|
+
# @return [Time]
|
13699
|
+
#
|
13700
|
+
# @!attribute [rw] planned_end_time
|
13701
|
+
# The time specified in a change request for a runbook workflow to
|
13702
|
+
# end. Currently supported only for the OpsItem type
|
13703
|
+
# `/aws/changerequest`.
|
13704
|
+
# @return [Time]
|
13705
|
+
#
|
13047
13706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemSummary AWS API Documentation
|
13048
13707
|
#
|
13049
13708
|
class OpsItemSummary < Struct.new(
|
@@ -13058,15 +13717,20 @@ module Aws::SSM
|
|
13058
13717
|
:title,
|
13059
13718
|
:operational_data,
|
13060
13719
|
:category,
|
13061
|
-
:severity
|
13720
|
+
:severity,
|
13721
|
+
:ops_item_type,
|
13722
|
+
:actual_start_time,
|
13723
|
+
:actual_end_time,
|
13724
|
+
:planned_start_time,
|
13725
|
+
:planned_end_time)
|
13062
13726
|
SENSITIVE = []
|
13063
13727
|
include Aws::Structure
|
13064
13728
|
end
|
13065
13729
|
|
13066
|
-
# Operational metadata for an application in
|
13730
|
+
# Operational metadata for an application in Application Manager.
|
13067
13731
|
#
|
13068
13732
|
# @!attribute [rw] resource_id
|
13069
|
-
# The ID of the
|
13733
|
+
# The ID of the Application Manager application.
|
13070
13734
|
# @return [String]
|
13071
13735
|
#
|
13072
13736
|
# @!attribute [rw] ops_metadata_arn
|
@@ -13151,7 +13815,7 @@ module Aws::SSM
|
|
13151
13815
|
end
|
13152
13816
|
|
13153
13817
|
# The OpsMetadata object exceeds the maximum number of OpsMetadata keys
|
13154
|
-
# that you can assign to an application in
|
13818
|
+
# that you can assign to an application in Application Manager.
|
13155
13819
|
#
|
13156
13820
|
# @!attribute [rw] message
|
13157
13821
|
# @return [String]
|
@@ -13165,8 +13829,8 @@ module Aws::SSM
|
|
13165
13829
|
end
|
13166
13830
|
|
13167
13831
|
# Your account reached the maximum number of OpsMetadata objects allowed
|
13168
|
-
# by
|
13169
|
-
# more OpsMetadata object and try again.
|
13832
|
+
# by Application Manager. The maximum is 200 OpsMetadata objects. Delete
|
13833
|
+
# one or more OpsMetadata object and try again.
|
13170
13834
|
#
|
13171
13835
|
# @!attribute [rw] message
|
13172
13836
|
# @return [String]
|
@@ -15044,7 +15708,7 @@ module Aws::SSM
|
|
15044
15708
|
#
|
15045
15709
|
# Specify maintenance window targets using the following format:
|
15046
15710
|
#
|
15047
|
-
# `Key=WindowTargetIds
|
15711
|
+
# `Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>`
|
15048
15712
|
# @return [Array<Types::Target>]
|
15049
15713
|
#
|
15050
15714
|
# @!attribute [rw] task_arn
|
@@ -15874,6 +16538,126 @@ module Aws::SSM
|
|
15874
16538
|
include Aws::Structure
|
15875
16539
|
end
|
15876
16540
|
|
16541
|
+
# Information about the result of a document review request.
|
16542
|
+
#
|
16543
|
+
# @!attribute [rw] reviewed_time
|
16544
|
+
# The time that the reviewer took action on the document review
|
16545
|
+
# request.
|
16546
|
+
# @return [Time]
|
16547
|
+
#
|
16548
|
+
# @!attribute [rw] status
|
16549
|
+
# The current status of the document review request.
|
16550
|
+
# @return [String]
|
16551
|
+
#
|
16552
|
+
# @!attribute [rw] reviewer
|
16553
|
+
# The reviewer assigned to take action on the document review request.
|
16554
|
+
# @return [String]
|
16555
|
+
#
|
16556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ReviewInformation AWS API Documentation
|
16557
|
+
#
|
16558
|
+
class ReviewInformation < Struct.new(
|
16559
|
+
:reviewed_time,
|
16560
|
+
:status,
|
16561
|
+
:reviewer)
|
16562
|
+
SENSITIVE = []
|
16563
|
+
include Aws::Structure
|
16564
|
+
end
|
16565
|
+
|
16566
|
+
# Information about an Automation runbook (Automation document) used in
|
16567
|
+
# a runbook workflow in Change Manager.
|
16568
|
+
#
|
16569
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
16570
|
+
# until all required approvals for the change request have been
|
16571
|
+
# received.
|
16572
|
+
#
|
16573
|
+
# </note>
|
16574
|
+
#
|
16575
|
+
# @note When making an API call, you may pass Runbook
|
16576
|
+
# data as a hash:
|
16577
|
+
#
|
16578
|
+
# {
|
16579
|
+
# document_name: "DocumentARN", # required
|
16580
|
+
# document_version: "DocumentVersion",
|
16581
|
+
# parameters: {
|
16582
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
16583
|
+
# },
|
16584
|
+
# target_parameter_name: "AutomationParameterKey",
|
16585
|
+
# targets: [
|
16586
|
+
# {
|
16587
|
+
# key: "TargetKey",
|
16588
|
+
# values: ["TargetValue"],
|
16589
|
+
# },
|
16590
|
+
# ],
|
16591
|
+
# max_concurrency: "MaxConcurrency",
|
16592
|
+
# max_errors: "MaxErrors",
|
16593
|
+
# target_locations: [
|
16594
|
+
# {
|
16595
|
+
# accounts: ["Account"],
|
16596
|
+
# regions: ["Region"],
|
16597
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
16598
|
+
# target_location_max_errors: "MaxErrors",
|
16599
|
+
# execution_role_name: "ExecutionRoleName",
|
16600
|
+
# },
|
16601
|
+
# ],
|
16602
|
+
# }
|
16603
|
+
#
|
16604
|
+
# @!attribute [rw] document_name
|
16605
|
+
# The name of the Automation runbook (Automation document) used in a
|
16606
|
+
# runbook workflow.
|
16607
|
+
# @return [String]
|
16608
|
+
#
|
16609
|
+
# @!attribute [rw] document_version
|
16610
|
+
# The version of the Automation runbook (Automation document) used in
|
16611
|
+
# a runbook workflow.
|
16612
|
+
# @return [String]
|
16613
|
+
#
|
16614
|
+
# @!attribute [rw] parameters
|
16615
|
+
# The key-value map of execution parameters, which were supplied when
|
16616
|
+
# calling `StartChangeRequestExecution`.
|
16617
|
+
# @return [Hash<String,Array<String>>]
|
16618
|
+
#
|
16619
|
+
# @!attribute [rw] target_parameter_name
|
16620
|
+
# The name of the parameter used as the target resource for the
|
16621
|
+
# rate-controlled runbook workflow. Required if you specify `Targets`.
|
16622
|
+
# @return [String]
|
16623
|
+
#
|
16624
|
+
# @!attribute [rw] targets
|
16625
|
+
# A key-value mapping to target resources that the Runbook operation
|
16626
|
+
# performs tasks on. Required if you specify `TargetParameterName`.
|
16627
|
+
# @return [Array<Types::Target>]
|
16628
|
+
#
|
16629
|
+
# @!attribute [rw] max_concurrency
|
16630
|
+
# The `MaxConcurrency` value specified by the user when the operation
|
16631
|
+
# started, indicating the maximum number of resources that the runbook
|
16632
|
+
# operation can run on at the same time.
|
16633
|
+
# @return [String]
|
16634
|
+
#
|
16635
|
+
# @!attribute [rw] max_errors
|
16636
|
+
# The `MaxErrors` value specified by the user when the execution
|
16637
|
+
# started, indicating the maximum number of errors that can occur
|
16638
|
+
# during the operation before the updates are stopped or rolled back.
|
16639
|
+
# @return [String]
|
16640
|
+
#
|
16641
|
+
# @!attribute [rw] target_locations
|
16642
|
+
# Information about the AWS Regions and accounts targeted by the
|
16643
|
+
# current Runbook operation.
|
16644
|
+
# @return [Array<Types::TargetLocation>]
|
16645
|
+
#
|
16646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Runbook AWS API Documentation
|
16647
|
+
#
|
16648
|
+
class Runbook < Struct.new(
|
16649
|
+
:document_name,
|
16650
|
+
:document_version,
|
16651
|
+
:parameters,
|
16652
|
+
:target_parameter_name,
|
16653
|
+
:targets,
|
16654
|
+
:max_concurrency,
|
16655
|
+
:max_errors,
|
16656
|
+
:target_locations)
|
16657
|
+
SENSITIVE = []
|
16658
|
+
include Aws::Structure
|
16659
|
+
end
|
16660
|
+
|
15877
16661
|
# An S3 bucket where you want to store the results of this request.
|
15878
16662
|
#
|
15879
16663
|
# @note When making an API call, you may pass S3OutputLocation
|
@@ -16683,6 +17467,141 @@ module Aws::SSM
|
|
16683
17467
|
include Aws::Structure
|
16684
17468
|
end
|
16685
17469
|
|
17470
|
+
# @note When making an API call, you may pass StartChangeRequestExecutionRequest
|
17471
|
+
# data as a hash:
|
17472
|
+
#
|
17473
|
+
# {
|
17474
|
+
# scheduled_time: Time.now,
|
17475
|
+
# document_name: "DocumentARN", # required
|
17476
|
+
# document_version: "DocumentVersion",
|
17477
|
+
# parameters: {
|
17478
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
17479
|
+
# },
|
17480
|
+
# change_request_name: "ChangeRequestName",
|
17481
|
+
# client_token: "IdempotencyToken",
|
17482
|
+
# runbooks: [ # required
|
17483
|
+
# {
|
17484
|
+
# document_name: "DocumentARN", # required
|
17485
|
+
# document_version: "DocumentVersion",
|
17486
|
+
# parameters: {
|
17487
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
17488
|
+
# },
|
17489
|
+
# target_parameter_name: "AutomationParameterKey",
|
17490
|
+
# targets: [
|
17491
|
+
# {
|
17492
|
+
# key: "TargetKey",
|
17493
|
+
# values: ["TargetValue"],
|
17494
|
+
# },
|
17495
|
+
# ],
|
17496
|
+
# max_concurrency: "MaxConcurrency",
|
17497
|
+
# max_errors: "MaxErrors",
|
17498
|
+
# target_locations: [
|
17499
|
+
# {
|
17500
|
+
# accounts: ["Account"],
|
17501
|
+
# regions: ["Region"],
|
17502
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
17503
|
+
# target_location_max_errors: "MaxErrors",
|
17504
|
+
# execution_role_name: "ExecutionRoleName",
|
17505
|
+
# },
|
17506
|
+
# ],
|
17507
|
+
# },
|
17508
|
+
# ],
|
17509
|
+
# tags: [
|
17510
|
+
# {
|
17511
|
+
# key: "TagKey", # required
|
17512
|
+
# value: "TagValue", # required
|
17513
|
+
# },
|
17514
|
+
# ],
|
17515
|
+
# }
|
17516
|
+
#
|
17517
|
+
# @!attribute [rw] scheduled_time
|
17518
|
+
# The date and time specified in the change request to run the
|
17519
|
+
# Automation runbooks.
|
17520
|
+
#
|
17521
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
17522
|
+
# run until all required approvals for the change request have been
|
17523
|
+
# received.
|
17524
|
+
#
|
17525
|
+
# </note>
|
17526
|
+
# @return [Time]
|
17527
|
+
#
|
17528
|
+
# @!attribute [rw] document_name
|
17529
|
+
# The name of the change template document to run during the runbook
|
17530
|
+
# workflow.
|
17531
|
+
# @return [String]
|
17532
|
+
#
|
17533
|
+
# @!attribute [rw] document_version
|
17534
|
+
# The version of the change template document to run during the
|
17535
|
+
# runbook workflow.
|
17536
|
+
# @return [String]
|
17537
|
+
#
|
17538
|
+
# @!attribute [rw] parameters
|
17539
|
+
# A key-value map of parameters that match the declared parameters in
|
17540
|
+
# the change template document.
|
17541
|
+
# @return [Hash<String,Array<String>>]
|
17542
|
+
#
|
17543
|
+
# @!attribute [rw] change_request_name
|
17544
|
+
# The name of the change request associated with the runbook workflow
|
17545
|
+
# to be run.
|
17546
|
+
# @return [String]
|
17547
|
+
#
|
17548
|
+
# @!attribute [rw] client_token
|
17549
|
+
# The user-provided idempotency token. The token must be unique, is
|
17550
|
+
# case insensitive, enforces the UUID format, and can't be reused.
|
17551
|
+
# @return [String]
|
17552
|
+
#
|
17553
|
+
# @!attribute [rw] runbooks
|
17554
|
+
# Information about the Automation runbooks (Automation documents)
|
17555
|
+
# that are run during the runbook workflow.
|
17556
|
+
#
|
17557
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't
|
17558
|
+
# run until all required approvals for the change request have been
|
17559
|
+
# received.
|
17560
|
+
#
|
17561
|
+
# </note>
|
17562
|
+
# @return [Array<Types::Runbook>]
|
17563
|
+
#
|
17564
|
+
# @!attribute [rw] tags
|
17565
|
+
# Optional metadata that you assign to a resource. You can specify a
|
17566
|
+
# maximum of five tags for a change request. Tags enable you to
|
17567
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
17568
|
+
# or environment. For example, you might want to tag a change request
|
17569
|
+
# to identify an environment or target AWS Region. In this case, you
|
17570
|
+
# could specify the following key-value pairs:
|
17571
|
+
#
|
17572
|
+
# * `Key=Environment,Value=Production`
|
17573
|
+
#
|
17574
|
+
# * `Key=Region,Value=us-east-2`
|
17575
|
+
# @return [Array<Types::Tag>]
|
17576
|
+
#
|
17577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionRequest AWS API Documentation
|
17578
|
+
#
|
17579
|
+
class StartChangeRequestExecutionRequest < Struct.new(
|
17580
|
+
:scheduled_time,
|
17581
|
+
:document_name,
|
17582
|
+
:document_version,
|
17583
|
+
:parameters,
|
17584
|
+
:change_request_name,
|
17585
|
+
:client_token,
|
17586
|
+
:runbooks,
|
17587
|
+
:tags)
|
17588
|
+
SENSITIVE = []
|
17589
|
+
include Aws::Structure
|
17590
|
+
end
|
17591
|
+
|
17592
|
+
# @!attribute [rw] automation_execution_id
|
17593
|
+
# The unique ID of a runbook workflow operation. (A runbook workflow
|
17594
|
+
# is a type of Automation operation.)
|
17595
|
+
# @return [String]
|
17596
|
+
#
|
17597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionResult AWS API Documentation
|
17598
|
+
#
|
17599
|
+
class StartChangeRequestExecutionResult < Struct.new(
|
17600
|
+
:automation_execution_id)
|
17601
|
+
SENSITIVE = []
|
17602
|
+
include Aws::Structure
|
17603
|
+
end
|
17604
|
+
|
16686
17605
|
# @note When making an API call, you may pass StartSessionRequest
|
16687
17606
|
# data as a hash:
|
16688
17607
|
#
|
@@ -17130,7 +18049,7 @@ module Aws::SSM
|
|
17130
18049
|
#
|
17131
18050
|
# @!attribute [rw] target_location_max_concurrency
|
17132
18051
|
# The maximum number of AWS accounts and AWS regions allowed to run
|
17133
|
-
# the Automation concurrently
|
18052
|
+
# the Automation concurrently.
|
17134
18053
|
# @return [String]
|
17135
18054
|
#
|
17136
18055
|
# @!attribute [rw] target_location_max_errors
|
@@ -17141,7 +18060,8 @@ module Aws::SSM
|
|
17141
18060
|
#
|
17142
18061
|
# @!attribute [rw] execution_role_name
|
17143
18062
|
# The Automation execution role used by the currently running
|
17144
|
-
# Automation.
|
18063
|
+
# Automation. If not specified, the default value is
|
18064
|
+
# `AWS-SystemsManager-AutomationExecutionRole`.
|
17145
18065
|
# @return [String]
|
17146
18066
|
#
|
17147
18067
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/TargetLocation AWS API Documentation
|
@@ -17386,6 +18306,15 @@ module Aws::SSM
|
|
17386
18306
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
17387
18307
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
17388
18308
|
# apply_only_at_cron_interval: false,
|
18309
|
+
# target_locations: [
|
18310
|
+
# {
|
18311
|
+
# accounts: ["Account"],
|
18312
|
+
# regions: ["Region"],
|
18313
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
18314
|
+
# target_location_max_errors: "MaxErrors",
|
18315
|
+
# execution_role_name: "ExecutionRoleName",
|
18316
|
+
# },
|
18317
|
+
# ],
|
17389
18318
|
# }
|
17390
18319
|
#
|
17391
18320
|
# @!attribute [rw] association_id
|
@@ -17521,6 +18450,12 @@ module Aws::SSM
|
|
17521
18450
|
# the interval specified.
|
17522
18451
|
# @return [Boolean]
|
17523
18452
|
#
|
18453
|
+
# @!attribute [rw] target_locations
|
18454
|
+
# A location is a combination of AWS Regions and AWS accounts where
|
18455
|
+
# you want to run the association. Use this action to update an
|
18456
|
+
# association in multiple Regions and multiple accounts.
|
18457
|
+
# @return [Array<Types::TargetLocation>]
|
18458
|
+
#
|
17524
18459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationRequest AWS API Documentation
|
17525
18460
|
#
|
17526
18461
|
class UpdateAssociationRequest < Struct.new(
|
@@ -17538,7 +18473,8 @@ module Aws::SSM
|
|
17538
18473
|
:max_concurrency,
|
17539
18474
|
:compliance_severity,
|
17540
18475
|
:sync_compliance,
|
17541
|
-
:apply_only_at_cron_interval
|
18476
|
+
:apply_only_at_cron_interval,
|
18477
|
+
:target_locations)
|
17542
18478
|
SENSITIVE = []
|
17543
18479
|
include Aws::Structure
|
17544
18480
|
end
|
@@ -17643,6 +18579,49 @@ module Aws::SSM
|
|
17643
18579
|
include Aws::Structure
|
17644
18580
|
end
|
17645
18581
|
|
18582
|
+
# @note When making an API call, you may pass UpdateDocumentMetadataRequest
|
18583
|
+
# data as a hash:
|
18584
|
+
#
|
18585
|
+
# {
|
18586
|
+
# name: "DocumentName", # required
|
18587
|
+
# document_version: "DocumentVersion",
|
18588
|
+
# document_reviews: { # required
|
18589
|
+
# action: "SendForReview", # required, accepts SendForReview, UpdateReview, Approve, Reject
|
18590
|
+
# comment: [
|
18591
|
+
# {
|
18592
|
+
# type: "Comment", # accepts Comment
|
18593
|
+
# content: "DocumentReviewComment",
|
18594
|
+
# },
|
18595
|
+
# ],
|
18596
|
+
# },
|
18597
|
+
# }
|
18598
|
+
#
|
18599
|
+
# @!attribute [rw] name
|
18600
|
+
# The name of the document for which a version is to be updated.
|
18601
|
+
# @return [String]
|
18602
|
+
#
|
18603
|
+
# @!attribute [rw] document_version
|
18604
|
+
# The version of a document to update.
|
18605
|
+
# @return [String]
|
18606
|
+
#
|
18607
|
+
# @!attribute [rw] document_reviews
|
18608
|
+
# The document review details to update.
|
18609
|
+
# @return [Types::DocumentReviews]
|
18610
|
+
#
|
18611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataRequest AWS API Documentation
|
18612
|
+
#
|
18613
|
+
class UpdateDocumentMetadataRequest < Struct.new(
|
18614
|
+
:name,
|
18615
|
+
:document_version,
|
18616
|
+
:document_reviews)
|
18617
|
+
SENSITIVE = []
|
18618
|
+
include Aws::Structure
|
18619
|
+
end
|
18620
|
+
|
18621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataResponse AWS API Documentation
|
18622
|
+
#
|
18623
|
+
class UpdateDocumentMetadataResponse < Aws::EmptyStructure; end
|
18624
|
+
|
17646
18625
|
# @note When making an API call, you may pass UpdateDocumentRequest
|
17647
18626
|
# data as a hash:
|
17648
18627
|
#
|
@@ -17759,8 +18738,8 @@ module Aws::SSM
|
|
17759
18738
|
# @!attribute [rw] start_date
|
17760
18739
|
# The time zone that the scheduled maintenance window executions are
|
17761
18740
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17762
|
-
# example: "America/Los\_Angeles", "
|
17763
|
-
#
|
18741
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18742
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17764
18743
|
# website.
|
17765
18744
|
#
|
17766
18745
|
#
|
@@ -17783,8 +18762,8 @@ module Aws::SSM
|
|
17783
18762
|
# @!attribute [rw] schedule_timezone
|
17784
18763
|
# The time zone that the scheduled maintenance window executions are
|
17785
18764
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17786
|
-
# example: "America/Los\_Angeles", "
|
17787
|
-
#
|
18765
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18766
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17788
18767
|
# website.
|
17789
18768
|
#
|
17790
18769
|
#
|
@@ -17799,7 +18778,7 @@ module Aws::SSM
|
|
17799
18778
|
# For example, the following cron expression schedules a maintenance
|
17800
18779
|
# window to run the third Tuesday of every month at 11:30 PM.
|
17801
18780
|
#
|
17802
|
-
# `cron(
|
18781
|
+
# `cron(30 23 ? * TUE#3 *)`
|
17803
18782
|
#
|
17804
18783
|
# If the schedule offset is `2`, the maintenance window won't run
|
17805
18784
|
# until two days later.
|
@@ -17881,8 +18860,8 @@ module Aws::SSM
|
|
17881
18860
|
# @!attribute [rw] schedule_timezone
|
17882
18861
|
# The time zone that the scheduled maintenance window executions are
|
17883
18862
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
17884
|
-
# example: "America/Los\_Angeles", "
|
17885
|
-
#
|
18863
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
18864
|
+
# more information, see the [Time Zone Database][1] on the IANA
|
17886
18865
|
# website.
|
17887
18866
|
#
|
17888
18867
|
#
|
@@ -18390,11 +19369,15 @@ module Aws::SSM
|
|
18390
19369
|
# ops_item_id: "String", # required
|
18391
19370
|
# },
|
18392
19371
|
# ],
|
18393
|
-
# status: "Open", # accepts Open, InProgress, Resolved
|
19372
|
+
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
|
18394
19373
|
# ops_item_id: "OpsItemId", # required
|
18395
19374
|
# title: "OpsItemTitle",
|
18396
19375
|
# category: "OpsItemCategory",
|
18397
19376
|
# severity: "OpsItemSeverity",
|
19377
|
+
# actual_start_time: Time.now,
|
19378
|
+
# actual_end_time: Time.now,
|
19379
|
+
# planned_start_time: Time.now,
|
19380
|
+
# planned_end_time: Time.now,
|
18398
19381
|
# }
|
18399
19382
|
#
|
18400
19383
|
# @!attribute [rw] description
|
@@ -18484,6 +19467,28 @@ module Aws::SSM
|
|
18484
19467
|
# Specify a new severity for an OpsItem.
|
18485
19468
|
# @return [String]
|
18486
19469
|
#
|
19470
|
+
# @!attribute [rw] actual_start_time
|
19471
|
+
# The time a runbook workflow started. Currently reported only for the
|
19472
|
+
# OpsItem type `/aws/changerequest`.
|
19473
|
+
# @return [Time]
|
19474
|
+
#
|
19475
|
+
# @!attribute [rw] actual_end_time
|
19476
|
+
# The time a runbook workflow ended. Currently reported only for the
|
19477
|
+
# OpsItem type `/aws/changerequest`.
|
19478
|
+
# @return [Time]
|
19479
|
+
#
|
19480
|
+
# @!attribute [rw] planned_start_time
|
19481
|
+
# The time specified in a change request for a runbook workflow to
|
19482
|
+
# start. Currently supported only for the OpsItem type
|
19483
|
+
# `/aws/changerequest`.
|
19484
|
+
# @return [Time]
|
19485
|
+
#
|
19486
|
+
# @!attribute [rw] planned_end_time
|
19487
|
+
# The time specified in a change request for a runbook workflow to
|
19488
|
+
# end. Currently supported only for the OpsItem type
|
19489
|
+
# `/aws/changerequest`.
|
19490
|
+
# @return [Time]
|
19491
|
+
#
|
18487
19492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItemRequest AWS API Documentation
|
18488
19493
|
#
|
18489
19494
|
class UpdateOpsItemRequest < Struct.new(
|
@@ -18497,7 +19502,11 @@ module Aws::SSM
|
|
18497
19502
|
:ops_item_id,
|
18498
19503
|
:title,
|
18499
19504
|
:category,
|
18500
|
-
:severity
|
19505
|
+
:severity,
|
19506
|
+
:actual_start_time,
|
19507
|
+
:actual_end_time,
|
19508
|
+
:planned_start_time,
|
19509
|
+
:planned_end_time)
|
18501
19510
|
SENSITIVE = []
|
18502
19511
|
include Aws::Structure
|
18503
19512
|
end
|