aws-sdk-ssm 1.47.0 → 1.48.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 +171 -143
- data/lib/aws-sdk-ssm/types.rb +318 -261
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dceb020203cae9d2150185c3157e87dc14f7d30c
|
4
|
+
data.tar.gz: f37b6a5d233a5e03f24083b8175cb77d339b520e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bff4aa694a4cff4efc4cf2f451ff699f7bf722c719fe9149842953997dcff53fd4b885bbb1a483e552288079adf2109116343b4d698606558e8fd6c9a0e348bb
|
7
|
+
data.tar.gz: 25620f4b6afeb2ed6f971ccaef6495f11ccd9b3aec281d1d0511d2bbaed425f5f06f50dc365abdf8bdae81da9ccad4727a15f50a08928f76d9369d12383cc405
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -262,7 +262,7 @@ module Aws::SSM
|
|
262
262
|
|
263
263
|
# Adds or overwrites one or more tags for the specified resource. Tags
|
264
264
|
# are metadata that you can assign to your documents, managed instances,
|
265
|
-
#
|
265
|
+
# maintenance windows, Parameter Store parameters, and patch baselines.
|
266
266
|
# Tags enable you to categorize your resources in different ways, for
|
267
267
|
# example, by purpose, owner, or environment. Each tag consists of a key
|
268
268
|
# and an optional value, both of which you define. For example, you
|
@@ -291,9 +291,8 @@ module Aws::SSM
|
|
291
291
|
# Specifies the type of resource you are tagging.
|
292
292
|
#
|
293
293
|
# <note markdown="1"> The ManagedInstance type for this API action is for on-premises
|
294
|
-
# managed instances. You must specify the
|
295
|
-
#
|
296
|
-
# mi-1a2b3c4d5e6f.
|
294
|
+
# managed instances. You must specify the name of the managed instance
|
295
|
+
# in the following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
|
297
296
|
#
|
298
297
|
# </note>
|
299
298
|
#
|
@@ -311,9 +310,8 @@ module Aws::SSM
|
|
311
310
|
# For the Document and Parameter values, use the name of the resource.
|
312
311
|
#
|
313
312
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
314
|
-
# managed instances. You must specify the
|
315
|
-
#
|
316
|
-
# mi-1a2b3c4d5e6f.
|
313
|
+
# managed instances. You must specify the name of the managed instance
|
314
|
+
# in the following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
|
317
315
|
#
|
318
316
|
# </note>
|
319
317
|
#
|
@@ -378,12 +376,12 @@ module Aws::SSM
|
|
378
376
|
req.send_request(options)
|
379
377
|
end
|
380
378
|
|
381
|
-
# Stops a
|
379
|
+
# Stops a maintenance window execution that is already in progress and
|
382
380
|
# cancels any tasks in the window that have not already starting
|
383
381
|
# running. (Tasks already in progress will continue to completion.)
|
384
382
|
#
|
385
383
|
# @option params [required, String] :window_execution_id
|
386
|
-
# The ID of the
|
384
|
+
# The ID of the maintenance window execution to stop.
|
387
385
|
#
|
388
386
|
# @return [Types::CancelMaintenanceWindowExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
389
387
|
#
|
@@ -412,7 +410,7 @@ module Aws::SSM
|
|
412
410
|
# so that you can manage these resources using Run Command. An
|
413
411
|
# on-premises server or virtual machine that has been registered with
|
414
412
|
# EC2 is called a managed instance. For more information about
|
415
|
-
# activations, see [Setting Up Systems Manager
|
413
|
+
# activations, see [Setting Up AWS Systems Manager for Hybrid
|
416
414
|
# Environments][1].
|
417
415
|
#
|
418
416
|
#
|
@@ -934,33 +932,33 @@ module Aws::SSM
|
|
934
932
|
req.send_request(options)
|
935
933
|
end
|
936
934
|
|
937
|
-
# Creates a new
|
935
|
+
# Creates a new maintenance window.
|
938
936
|
#
|
939
937
|
# @option params [required, String] :name
|
940
|
-
# The name of the
|
938
|
+
# The name of the maintenance window.
|
941
939
|
#
|
942
940
|
# @option params [String] :description
|
943
|
-
# An optional description for the
|
944
|
-
# specifying a description to help you organize your
|
945
|
-
#
|
941
|
+
# An optional description for the maintenance window. We recommend
|
942
|
+
# specifying a description to help you organize your maintenance
|
943
|
+
# windows.
|
946
944
|
#
|
947
945
|
# @option params [String] :start_date
|
948
946
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
949
|
-
#
|
950
|
-
# activation of the
|
947
|
+
# maintenance window to become active. StartDate allows you to delay
|
948
|
+
# activation of the maintenance window until the specified future date.
|
951
949
|
#
|
952
950
|
# @option params [String] :end_date
|
953
951
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
954
|
-
#
|
955
|
-
# date and time in the future when the
|
952
|
+
# maintenance window to become inactive. EndDate allows you to set a
|
953
|
+
# date and time in the future when the maintenance window will no longer
|
956
954
|
# run.
|
957
955
|
#
|
958
956
|
# @option params [required, String] :schedule
|
959
|
-
# The schedule of the
|
957
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
960
958
|
# expression.
|
961
959
|
#
|
962
960
|
# @option params [String] :schedule_timezone
|
963
|
-
# The time zone that the scheduled
|
961
|
+
# The time zone that the scheduled maintenance window executions are
|
964
962
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
965
963
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul". For
|
966
964
|
# more information, see the [Time Zone Database][1] on the IANA website.
|
@@ -970,21 +968,21 @@ module Aws::SSM
|
|
970
968
|
# [1]: https://www.iana.org/time-zones
|
971
969
|
#
|
972
970
|
# @option params [required, Integer] :duration
|
973
|
-
# The duration of the
|
971
|
+
# The duration of the maintenance window in hours.
|
974
972
|
#
|
975
973
|
# @option params [required, Integer] :cutoff
|
976
|
-
# The number of hours before the end of the
|
974
|
+
# The number of hours before the end of the maintenance window that
|
977
975
|
# Systems Manager stops scheduling new tasks for execution.
|
978
976
|
#
|
979
977
|
# @option params [required, Boolean] :allow_unassociated_targets
|
980
|
-
# Enables a
|
978
|
+
# Enables a maintenance window task to run on managed instances, even if
|
981
979
|
# you have not registered those instances as targets. If enabled, then
|
982
980
|
# you must specify the unregistered instances (by instance ID) when you
|
983
|
-
# register a task with the
|
981
|
+
# register a task with the maintenance window.
|
984
982
|
#
|
985
983
|
# If you don't enable this option, then you must specify
|
986
984
|
# previously-registered targets when you register a task with the
|
987
|
-
#
|
985
|
+
# maintenance window.
|
988
986
|
#
|
989
987
|
# @option params [String] :client_token
|
990
988
|
# User-provided idempotency token.
|
@@ -995,7 +993,7 @@ module Aws::SSM
|
|
995
993
|
# @option params [Array<Types::Tag>] :tags
|
996
994
|
# Optional metadata that you assign to a resource. Tags enable you to
|
997
995
|
# categorize a resource in different ways, such as by purpose, owner, or
|
998
|
-
# environment. For example, you might want to tag a
|
996
|
+
# environment. For example, you might want to tag a maintenance window
|
999
997
|
# to identify the type of tasks it will run, the types of targets, and
|
1000
998
|
# the environment it will run in. In this case, you could specify the
|
1001
999
|
# following key name/value pairs:
|
@@ -1006,7 +1004,7 @@ module Aws::SSM
|
|
1006
1004
|
#
|
1007
1005
|
# * `Key=Environment,Value=Production`
|
1008
1006
|
#
|
1009
|
-
# <note markdown="1"> To add tags to an existing
|
1007
|
+
# <note markdown="1"> To add tags to an existing maintenance window, use the
|
1010
1008
|
# AddTagsToResource action.
|
1011
1009
|
#
|
1012
1010
|
# </note>
|
@@ -1375,7 +1373,7 @@ module Aws::SSM
|
|
1375
1373
|
# DisableSchema: If you choose this option, the system ignores all
|
1376
1374
|
# inventory data for the specified version, and any earlier versions. To
|
1377
1375
|
# enable this schema again, you must call the `PutInventory` action for
|
1378
|
-
# a version greater than the
|
1376
|
+
# a version greater than the disabled version.
|
1379
1377
|
#
|
1380
1378
|
# DeleteSchema: This option deletes the specified custom type from the
|
1381
1379
|
# Inventory service. You can recreate the schema later, if you want.
|
@@ -1428,10 +1426,10 @@ module Aws::SSM
|
|
1428
1426
|
req.send_request(options)
|
1429
1427
|
end
|
1430
1428
|
|
1431
|
-
# Deletes a
|
1429
|
+
# Deletes a maintenance window.
|
1432
1430
|
#
|
1433
1431
|
# @option params [required, String] :window_id
|
1434
|
-
# The ID of the
|
1432
|
+
# The ID of the maintenance window to delete.
|
1435
1433
|
#
|
1436
1434
|
# @return [Types::DeleteMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1437
1435
|
#
|
@@ -1625,10 +1623,10 @@ module Aws::SSM
|
|
1625
1623
|
req.send_request(options)
|
1626
1624
|
end
|
1627
1625
|
|
1628
|
-
# Removes a target from a
|
1626
|
+
# Removes a target from a maintenance window.
|
1629
1627
|
#
|
1630
1628
|
# @option params [required, String] :window_id
|
1631
|
-
# The ID of the
|
1629
|
+
# The ID of the maintenance window the target should be removed from.
|
1632
1630
|
#
|
1633
1631
|
# @option params [required, String] :window_target_id
|
1634
1632
|
# The ID of the target definition to remove.
|
@@ -1636,7 +1634,7 @@ module Aws::SSM
|
|
1636
1634
|
# @option params [Boolean] :safe
|
1637
1635
|
# The system checks if the target is being referenced by a task. If the
|
1638
1636
|
# target is being referenced, the system returns an error and does not
|
1639
|
-
# deregister the target from the
|
1637
|
+
# deregister the target from the maintenance window.
|
1640
1638
|
#
|
1641
1639
|
# @return [Types::DeregisterTargetFromMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1642
1640
|
#
|
@@ -1665,13 +1663,13 @@ module Aws::SSM
|
|
1665
1663
|
req.send_request(options)
|
1666
1664
|
end
|
1667
1665
|
|
1668
|
-
# Removes a task from a
|
1666
|
+
# Removes a task from a maintenance window.
|
1669
1667
|
#
|
1670
1668
|
# @option params [required, String] :window_id
|
1671
|
-
# The ID of the
|
1669
|
+
# The ID of the maintenance window the task should be removed from.
|
1672
1670
|
#
|
1673
1671
|
# @option params [required, String] :window_task_id
|
1674
|
-
# The ID of the task to remove from the
|
1672
|
+
# The ID of the task to remove from the maintenance window.
|
1675
1673
|
#
|
1676
1674
|
# @return [Types::DeregisterTaskFromMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1677
1675
|
#
|
@@ -2818,13 +2816,13 @@ module Aws::SSM
|
|
2818
2816
|
end
|
2819
2817
|
|
2820
2818
|
# Retrieves the individual task executions (one per target) for a
|
2821
|
-
# particular task run as part of a
|
2819
|
+
# particular task run as part of a maintenance window execution.
|
2822
2820
|
#
|
2823
2821
|
# @option params [required, String] :window_execution_id
|
2824
|
-
# The ID of the
|
2822
|
+
# The ID of the maintenance window execution the task is part of.
|
2825
2823
|
#
|
2826
2824
|
# @option params [required, String] :task_id
|
2827
|
-
# The ID of the specific task in the
|
2825
|
+
# The ID of the specific task in the maintenance window task that should
|
2828
2826
|
# be retrieved.
|
2829
2827
|
#
|
2830
2828
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
@@ -2887,11 +2885,11 @@ module Aws::SSM
|
|
2887
2885
|
req.send_request(options)
|
2888
2886
|
end
|
2889
2887
|
|
2890
|
-
# For a given
|
2888
|
+
# For a given maintenance window execution, lists the tasks that were
|
2891
2889
|
# run.
|
2892
2890
|
#
|
2893
2891
|
# @option params [required, String] :window_execution_id
|
2894
|
-
# The ID of the
|
2892
|
+
# The ID of the maintenance window execution whose task executions
|
2895
2893
|
# should be retrieved.
|
2896
2894
|
#
|
2897
2895
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
@@ -2949,13 +2947,13 @@ module Aws::SSM
|
|
2949
2947
|
req.send_request(options)
|
2950
2948
|
end
|
2951
2949
|
|
2952
|
-
# Lists the executions of a
|
2953
|
-
# information about when the
|
2950
|
+
# Lists the executions of a maintenance window. This includes
|
2951
|
+
# information about when the maintenance window was scheduled to be
|
2954
2952
|
# active, and information about tasks registered and run with the
|
2955
|
-
#
|
2953
|
+
# maintenance window.
|
2956
2954
|
#
|
2957
2955
|
# @option params [required, String] :window_id
|
2958
|
-
# The ID of the
|
2956
|
+
# The ID of the maintenance window whose executions should be retrieved.
|
2959
2957
|
#
|
2960
2958
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
2961
2959
|
# Each entry in the array is a structure containing:
|
@@ -3015,11 +3013,11 @@ module Aws::SSM
|
|
3015
3013
|
req.send_request(options)
|
3016
3014
|
end
|
3017
3015
|
|
3018
|
-
# Retrieves information about upcoming executions of a
|
3019
|
-
#
|
3016
|
+
# Retrieves information about upcoming executions of a maintenance
|
3017
|
+
# window.
|
3020
3018
|
#
|
3021
3019
|
# @option params [String] :window_id
|
3022
|
-
# The ID of the
|
3020
|
+
# The ID of the maintenance window to retrieve information about.
|
3023
3021
|
#
|
3024
3022
|
# @option params [Array<Types::Target>] :targets
|
3025
3023
|
# The instance ID or key/value pair to retrieve information about.
|
@@ -3030,7 +3028,7 @@ module Aws::SSM
|
|
3030
3028
|
#
|
3031
3029
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3032
3030
|
# Filters used to limit the range of results. For example, you can limit
|
3033
|
-
#
|
3031
|
+
# maintenance window executions to only those scheduled before or after
|
3034
3032
|
# a certain date and time.
|
3035
3033
|
#
|
3036
3034
|
# @option params [Integer] :max_results
|
@@ -3085,10 +3083,10 @@ module Aws::SSM
|
|
3085
3083
|
req.send_request(options)
|
3086
3084
|
end
|
3087
3085
|
|
3088
|
-
# Lists the targets registered with the
|
3086
|
+
# Lists the targets registered with the maintenance window.
|
3089
3087
|
#
|
3090
3088
|
# @option params [required, String] :window_id
|
3091
|
-
# The ID of the
|
3089
|
+
# The ID of the maintenance window whose targets should be retrieved.
|
3092
3090
|
#
|
3093
3091
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3094
3092
|
# Optional filters that can be used to narrow down the scope of the
|
@@ -3147,10 +3145,10 @@ module Aws::SSM
|
|
3147
3145
|
req.send_request(options)
|
3148
3146
|
end
|
3149
3147
|
|
3150
|
-
# Lists the tasks in a
|
3148
|
+
# Lists the tasks in a maintenance window.
|
3151
3149
|
#
|
3152
3150
|
# @option params [required, String] :window_id
|
3153
|
-
# The ID of the
|
3151
|
+
# The ID of the maintenance window whose tasks should be retrieved.
|
3154
3152
|
#
|
3155
3153
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3156
3154
|
# Optional filters used to narrow down the scope of the returned tasks.
|
@@ -3219,11 +3217,11 @@ module Aws::SSM
|
|
3219
3217
|
req.send_request(options)
|
3220
3218
|
end
|
3221
3219
|
|
3222
|
-
# Retrieves the
|
3220
|
+
# Retrieves the maintenance windows in an AWS account.
|
3223
3221
|
#
|
3224
3222
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3225
3223
|
# Optional filters used to narrow down the scope of the returned
|
3226
|
-
#
|
3224
|
+
# maintenance windows. Supported filter keys are **Name** and
|
3227
3225
|
# **Enabled**.
|
3228
3226
|
#
|
3229
3227
|
# @option params [Integer] :max_results
|
@@ -3278,7 +3276,7 @@ module Aws::SSM
|
|
3278
3276
|
req.send_request(options)
|
3279
3277
|
end
|
3280
3278
|
|
3281
|
-
# Retrieves information about the
|
3279
|
+
# Retrieves information about the maintenance window targets or tasks
|
3282
3280
|
# that an instance is associated with.
|
3283
3281
|
#
|
3284
3282
|
# @option params [required, Array<Types::Target>] :targets
|
@@ -4226,10 +4224,11 @@ module Aws::SSM
|
|
4226
4224
|
req.send_request(options)
|
4227
4225
|
end
|
4228
4226
|
|
4229
|
-
# Retrieves a
|
4227
|
+
# Retrieves a maintenance window.
|
4230
4228
|
#
|
4231
4229
|
# @option params [required, String] :window_id
|
4232
|
-
# The ID of the
|
4230
|
+
# The ID of the maintenance window for which you want to retrieve
|
4231
|
+
# information.
|
4233
4232
|
#
|
4234
4233
|
# @return [Types::GetMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4235
4234
|
#
|
@@ -4280,11 +4279,11 @@ module Aws::SSM
|
|
4280
4279
|
req.send_request(options)
|
4281
4280
|
end
|
4282
4281
|
|
4283
|
-
# Retrieves details about a specific task run as part of a
|
4284
|
-
#
|
4282
|
+
# Retrieves details about a specific task run as part of a maintenance
|
4283
|
+
# window execution.
|
4285
4284
|
#
|
4286
4285
|
# @option params [required, String] :window_execution_id
|
4287
|
-
# The ID of the
|
4286
|
+
# The ID of the maintenance window execution that includes the task.
|
4288
4287
|
#
|
4289
4288
|
# @return [Types::GetMaintenanceWindowExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4290
4289
|
#
|
@@ -4321,13 +4320,13 @@ module Aws::SSM
|
|
4321
4320
|
end
|
4322
4321
|
|
4323
4322
|
# Retrieves the details about a specific task run as part of a
|
4324
|
-
#
|
4323
|
+
# maintenance window execution.
|
4325
4324
|
#
|
4326
4325
|
# @option params [required, String] :window_execution_id
|
4327
|
-
# The ID of the
|
4326
|
+
# The ID of the maintenance window execution that includes the task.
|
4328
4327
|
#
|
4329
4328
|
# @option params [required, String] :task_id
|
4330
|
-
# The ID of the specific task execution in the
|
4329
|
+
# The ID of the specific task execution in the maintenance window task
|
4331
4330
|
# that should be retrieved.
|
4332
4331
|
#
|
4333
4332
|
# @return [Types::GetMaintenanceWindowExecutionTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4382,15 +4381,15 @@ module Aws::SSM
|
|
4382
4381
|
end
|
4383
4382
|
|
4384
4383
|
# Retrieves a task invocation. A task invocation is a specific task
|
4385
|
-
# running on a specific target.
|
4384
|
+
# running on a specific target. maintenance windows report status for
|
4386
4385
|
# all invocations.
|
4387
4386
|
#
|
4388
4387
|
# @option params [required, String] :window_execution_id
|
4389
|
-
# The ID of the
|
4388
|
+
# The ID of the maintenance window execution for which the task is a
|
4390
4389
|
# part.
|
4391
4390
|
#
|
4392
4391
|
# @option params [required, String] :task_id
|
4393
|
-
# The ID of the specific task in the
|
4392
|
+
# The ID of the specific task in the maintenance window task that should
|
4394
4393
|
# be retrieved.
|
4395
4394
|
#
|
4396
4395
|
# @option params [required, String] :invocation_id
|
@@ -4443,13 +4442,13 @@ module Aws::SSM
|
|
4443
4442
|
req.send_request(options)
|
4444
4443
|
end
|
4445
4444
|
|
4446
|
-
# Lists the tasks in a
|
4445
|
+
# Lists the tasks in a maintenance window.
|
4447
4446
|
#
|
4448
4447
|
# @option params [required, String] :window_id
|
4449
|
-
# The
|
4448
|
+
# The maintenance window ID that includes the task to retrieve.
|
4450
4449
|
#
|
4451
4450
|
# @option params [required, String] :window_task_id
|
4452
|
-
# The
|
4451
|
+
# The maintenance window task ID to retrieve.
|
4453
4452
|
#
|
4454
4453
|
# @return [Types::GetMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4455
4454
|
#
|
@@ -6284,31 +6283,45 @@ module Aws::SSM
|
|
6284
6283
|
req.send_request(options)
|
6285
6284
|
end
|
6286
6285
|
|
6287
|
-
# Registers a target with a
|
6286
|
+
# Registers a target with a maintenance window.
|
6288
6287
|
#
|
6289
6288
|
# @option params [required, String] :window_id
|
6290
|
-
# The ID of the
|
6289
|
+
# The ID of the maintenance window the target should be registered with.
|
6291
6290
|
#
|
6292
6291
|
# @option params [required, String] :resource_type
|
6293
|
-
# The type of target being registered with the
|
6292
|
+
# The type of target being registered with the maintenance window.
|
6294
6293
|
#
|
6295
6294
|
# @option params [required, Array<Types::Target>] :targets
|
6296
|
-
# The targets
|
6295
|
+
# The targets to register with the maintenance window. In other words,
|
6296
|
+
# the instances to run commands on when the maintenance window runs.
|
6297
6297
|
#
|
6298
|
-
#
|
6298
|
+
# You can specify targets using either instance IDs or tags that have
|
6299
|
+
# been applied to instances.
|
6299
6300
|
#
|
6300
|
-
#
|
6301
|
+
# **Example 1**\: Specify instance IDs
|
6302
|
+
#
|
6303
|
+
# `Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 `
|
6304
|
+
#
|
6305
|
+
# **Example 2**\: Use tag key-pairs applied to instances
|
6306
|
+
#
|
6307
|
+
# `Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 `
|
6301
6308
|
#
|
6302
|
-
#
|
6309
|
+
# **Example 3**\: Use tag-keys applied to instances
|
6303
6310
|
#
|
6304
|
-
# `Key=tag
|
6311
|
+
# `Key=tag-key,Values=my-tag-key-1,my-tag-key-2 `
|
6305
6312
|
#
|
6306
|
-
#
|
6313
|
+
# For more information about these examples formats, including the best
|
6314
|
+
# use case for each one, see [Examples: Register Targets with a
|
6315
|
+
# Maintenance Window][1] in the *AWS Systems Manager User Guide*.
|
6316
|
+
#
|
6317
|
+
#
|
6318
|
+
#
|
6319
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
|
6307
6320
|
#
|
6308
6321
|
# @option params [String] :owner_information
|
6309
6322
|
# User-provided value that will be included in any CloudWatch events
|
6310
|
-
# raised while running tasks for these targets in this
|
6311
|
-
#
|
6323
|
+
# raised while running tasks for these targets in this maintenance
|
6324
|
+
# window.
|
6312
6325
|
#
|
6313
6326
|
# @option params [String] :name
|
6314
6327
|
# An optional name for the target.
|
@@ -6356,19 +6369,19 @@ module Aws::SSM
|
|
6356
6369
|
req.send_request(options)
|
6357
6370
|
end
|
6358
6371
|
|
6359
|
-
# Adds a new task to a
|
6372
|
+
# Adds a new task to a maintenance window.
|
6360
6373
|
#
|
6361
6374
|
# @option params [required, String] :window_id
|
6362
|
-
# The ID of the
|
6375
|
+
# The ID of the maintenance window the task should be added to.
|
6363
6376
|
#
|
6364
6377
|
# @option params [required, Array<Types::Target>] :targets
|
6365
|
-
# The targets (either instances or
|
6378
|
+
# The targets (either instances or maintenance window targets).
|
6366
6379
|
#
|
6367
6380
|
# Specify instances using the following format:
|
6368
6381
|
#
|
6369
6382
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
6370
6383
|
#
|
6371
|
-
# Specify
|
6384
|
+
# Specify maintenance window targets using the following format:
|
6372
6385
|
#
|
6373
6386
|
# `Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>`
|
6374
6387
|
#
|
@@ -6376,18 +6389,19 @@ module Aws::SSM
|
|
6376
6389
|
# The ARN of the task to run.
|
6377
6390
|
#
|
6378
6391
|
# @option params [String] :service_role_arn
|
6379
|
-
# The
|
6380
|
-
#
|
6381
|
-
#
|
6382
|
-
# your account's service-linked role for Systems Manager by default. If
|
6392
|
+
# The ARN of the IAM service role for Systems Manager to assume when
|
6393
|
+
# running a maintenance window task. If you do not specify a service
|
6394
|
+
# role ARN, Systems Manager uses your account's service-linked role. If
|
6383
6395
|
# no service-linked role for Systems Manager exists in your account, it
|
6384
|
-
#
|
6385
|
-
#
|
6396
|
+
# is created when you run `RegisterTaskWithMaintenanceWindow`.
|
6397
|
+
#
|
6398
|
+
# For more information, see the following topics in the in the *AWS
|
6399
|
+
# Systems Manager User Guide*\:
|
6386
6400
|
#
|
6387
|
-
#
|
6388
|
-
#
|
6389
|
-
#
|
6390
|
-
#
|
6401
|
+
# * [Service-Linked Role Permissions for Systems Manager][1]
|
6402
|
+
#
|
6403
|
+
# * [Should I Use a Service-Linked Role or a Custom Service Role to Run
|
6404
|
+
# Maintenance Window Tasks? ][2]
|
6391
6405
|
#
|
6392
6406
|
#
|
6393
6407
|
#
|
@@ -6403,8 +6417,8 @@ module Aws::SSM
|
|
6403
6417
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass to
|
6404
6418
|
# a task when it runs, instead use the `Parameters` option in the
|
6405
6419
|
# `TaskInvocationParameters` structure. For information about how
|
6406
|
-
# Systems Manager handles these options for the supported
|
6407
|
-
#
|
6420
|
+
# Systems Manager handles these options for the supported maintenance
|
6421
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
6408
6422
|
#
|
6409
6423
|
# </note>
|
6410
6424
|
#
|
@@ -6414,8 +6428,8 @@ module Aws::SSM
|
|
6414
6428
|
# empty.
|
6415
6429
|
#
|
6416
6430
|
# @option params [Integer] :priority
|
6417
|
-
# The priority of the task in the
|
6418
|
-
# number the higher the priority. Tasks in a
|
6431
|
+
# The priority of the task in the maintenance window, the lower the
|
6432
|
+
# number the higher the priority. Tasks in a maintenance window are
|
6419
6433
|
# scheduled in priority order with tasks that have the same priority
|
6420
6434
|
# scheduled in parallel.
|
6421
6435
|
#
|
@@ -6434,7 +6448,7 @@ module Aws::SSM
|
|
6434
6448
|
# logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
|
6435
6449
|
# options in the `TaskInvocationParameters` structure. For information
|
6436
6450
|
# about how Systems Manager handles these options for the supported
|
6437
|
-
#
|
6451
|
+
# maintenance window task types, see
|
6438
6452
|
# MaintenanceWindowTaskInvocationParameters.
|
6439
6453
|
#
|
6440
6454
|
# </note>
|
@@ -6539,9 +6553,8 @@ module Aws::SSM
|
|
6539
6553
|
# The type of resource of which you want to remove a tag.
|
6540
6554
|
#
|
6541
6555
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
6542
|
-
# managed instances. You must specify the
|
6543
|
-
#
|
6544
|
-
# mi-1a2b3c4d5e6f.
|
6556
|
+
# managed instances. You must specify the name of the managed instance
|
6557
|
+
# in the following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
|
6545
6558
|
#
|
6546
6559
|
# </note>
|
6547
6560
|
#
|
@@ -6558,9 +6571,8 @@ module Aws::SSM
|
|
6558
6571
|
# For the Document and Parameter values, use the name of the resource.
|
6559
6572
|
#
|
6560
6573
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
6561
|
-
# managed instances. You must specify the
|
6562
|
-
#
|
6563
|
-
# mi-1a2b3c4d5e6f.
|
6574
|
+
# managed instances. You must specify the name of the managed instance
|
6575
|
+
# in the following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
|
6564
6576
|
#
|
6565
6577
|
# </note>
|
6566
6578
|
#
|
@@ -6683,13 +6695,27 @@ module Aws::SSM
|
|
6683
6695
|
# want to send the signal to.
|
6684
6696
|
#
|
6685
6697
|
# @option params [required, String] :signal_type
|
6686
|
-
# The type of signal
|
6687
|
-
# and Reject
|
6698
|
+
# The type of signal to send to an Automation execution.
|
6688
6699
|
#
|
6689
6700
|
# @option params [Hash<String,Array>] :payload
|
6690
6701
|
# The data sent with the signal. The data schema depends on the type of
|
6691
6702
|
# signal used in the request.
|
6692
6703
|
#
|
6704
|
+
# For `Approve` and `Reject` signal types, the payload is an optional
|
6705
|
+
# comment that you can send with the signal type. For example:
|
6706
|
+
#
|
6707
|
+
# `Comment="Looks good"`
|
6708
|
+
#
|
6709
|
+
# For `StartStep` and `Resume` signal types, you must send the name of
|
6710
|
+
# the Automation step to start or resume as the payload. For example:
|
6711
|
+
#
|
6712
|
+
# `StepName="step1"`
|
6713
|
+
#
|
6714
|
+
# For the `StopStep` signal type, you must send the step execution ID as
|
6715
|
+
# the payload. For example:
|
6716
|
+
#
|
6717
|
+
# `StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"`
|
6718
|
+
#
|
6693
6719
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6694
6720
|
#
|
6695
6721
|
# @example Request syntax with placeholder values
|
@@ -6817,7 +6843,9 @@ module Aws::SSM
|
|
6817
6843
|
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
|
6818
6844
|
#
|
6819
6845
|
# @option params [String] :service_role_arn
|
6820
|
-
# The IAM role
|
6846
|
+
# The ARN of the IAM service role to use to publish Amazon Simple
|
6847
|
+
# Notification Service (Amazon SNS) notifications for Run Command
|
6848
|
+
# commands.
|
6821
6849
|
#
|
6822
6850
|
# @option params [Types::NotificationConfig] :notification_config
|
6823
6851
|
# Configurations for sending notifications.
|
@@ -7545,20 +7573,20 @@ module Aws::SSM
|
|
7545
7573
|
req.send_request(options)
|
7546
7574
|
end
|
7547
7575
|
|
7548
|
-
# Updates an existing
|
7576
|
+
# Updates an existing maintenance window. Only specified parameters are
|
7549
7577
|
# modified.
|
7550
7578
|
#
|
7551
7579
|
# @option params [required, String] :window_id
|
7552
|
-
# The ID of the
|
7580
|
+
# The ID of the maintenance window to update.
|
7553
7581
|
#
|
7554
7582
|
# @option params [String] :name
|
7555
|
-
# The name of the
|
7583
|
+
# The name of the maintenance window.
|
7556
7584
|
#
|
7557
7585
|
# @option params [String] :description
|
7558
7586
|
# An optional description for the update request.
|
7559
7587
|
#
|
7560
7588
|
# @option params [String] :start_date
|
7561
|
-
# The time zone that the scheduled
|
7589
|
+
# The time zone that the scheduled maintenance window executions are
|
7562
7590
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
7563
7591
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul". For
|
7564
7592
|
# more information, see the [Time Zone Database][1] on the IANA website.
|
@@ -7569,16 +7597,16 @@ module Aws::SSM
|
|
7569
7597
|
#
|
7570
7598
|
# @option params [String] :end_date
|
7571
7599
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
7572
|
-
#
|
7573
|
-
# date and time in the future when the
|
7600
|
+
# maintenance window to become inactive. EndDate allows you to set a
|
7601
|
+
# date and time in the future when the maintenance window will no longer
|
7574
7602
|
# run.
|
7575
7603
|
#
|
7576
7604
|
# @option params [String] :schedule
|
7577
|
-
# The schedule of the
|
7605
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
7578
7606
|
# expression.
|
7579
7607
|
#
|
7580
7608
|
# @option params [String] :schedule_timezone
|
7581
|
-
# The time zone that the scheduled
|
7609
|
+
# The time zone that the scheduled maintenance window executions are
|
7582
7610
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
7583
7611
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul". For
|
7584
7612
|
# more information, see the [Time Zone Database][1] on the IANA website.
|
@@ -7588,18 +7616,18 @@ module Aws::SSM
|
|
7588
7616
|
# [1]: https://www.iana.org/time-zones
|
7589
7617
|
#
|
7590
7618
|
# @option params [Integer] :duration
|
7591
|
-
# The duration of the
|
7619
|
+
# The duration of the maintenance window in hours.
|
7592
7620
|
#
|
7593
7621
|
# @option params [Integer] :cutoff
|
7594
|
-
# The number of hours before the end of the
|
7622
|
+
# The number of hours before the end of the maintenance window that
|
7595
7623
|
# Systems Manager stops scheduling new tasks for execution.
|
7596
7624
|
#
|
7597
7625
|
# @option params [Boolean] :allow_unassociated_targets
|
7598
|
-
# Whether targets must be registered with the
|
7626
|
+
# Whether targets must be registered with the maintenance window before
|
7599
7627
|
# tasks can be defined for those targets.
|
7600
7628
|
#
|
7601
7629
|
# @option params [Boolean] :enabled
|
7602
|
-
# Whether the
|
7630
|
+
# Whether the maintenance window is enabled.
|
7603
7631
|
#
|
7604
7632
|
# @option params [Boolean] :replace
|
7605
7633
|
# If True, then all fields that are required by the
|
@@ -7660,7 +7688,7 @@ module Aws::SSM
|
|
7660
7688
|
req.send_request(options)
|
7661
7689
|
end
|
7662
7690
|
|
7663
|
-
# Modifies the target of an existing
|
7691
|
+
# Modifies the target of an existing maintenance window. You can't
|
7664
7692
|
# change the target type, but you can change the following:
|
7665
7693
|
#
|
7666
7694
|
# The target from being an ID target to a Tag target, or a Tag target to
|
@@ -7679,7 +7707,7 @@ module Aws::SSM
|
|
7679
7707
|
# If a parameter is null, then the corresponding field is not modified.
|
7680
7708
|
#
|
7681
7709
|
# @option params [required, String] :window_id
|
7682
|
-
# The
|
7710
|
+
# The maintenance window ID with which to modify the target.
|
7683
7711
|
#
|
7684
7712
|
# @option params [required, String] :window_target_id
|
7685
7713
|
# The target ID to modify.
|
@@ -7689,8 +7717,8 @@ module Aws::SSM
|
|
7689
7717
|
#
|
7690
7718
|
# @option params [String] :owner_information
|
7691
7719
|
# User-provided value that will be included in any CloudWatch events
|
7692
|
-
# raised while running tasks for these targets in this
|
7693
|
-
#
|
7720
|
+
# raised while running tasks for these targets in this maintenance
|
7721
|
+
# window.
|
7694
7722
|
#
|
7695
7723
|
# @option params [String] :name
|
7696
7724
|
# A name for the update.
|
@@ -7750,7 +7778,7 @@ module Aws::SSM
|
|
7750
7778
|
req.send_request(options)
|
7751
7779
|
end
|
7752
7780
|
|
7753
|
-
# Modifies a task assigned to a
|
7781
|
+
# Modifies a task assigned to a maintenance window. You can't change
|
7754
7782
|
# the task type, but you can change the following values:
|
7755
7783
|
#
|
7756
7784
|
# * TaskARN. For example, you can change a RUN\_COMMAND task from
|
@@ -7772,7 +7800,7 @@ module Aws::SSM
|
|
7772
7800
|
# request. Optional fields that aren't specified are set to null.
|
7773
7801
|
#
|
7774
7802
|
# @option params [required, String] :window_id
|
7775
|
-
# The
|
7803
|
+
# The maintenance window ID that contains the task to modify.
|
7776
7804
|
#
|
7777
7805
|
# @option params [required, String] :window_task_id
|
7778
7806
|
# The task ID to modify.
|
@@ -7786,19 +7814,19 @@ module Aws::SSM
|
|
7786
7814
|
# The task ARN to modify.
|
7787
7815
|
#
|
7788
7816
|
# @option params [String] :service_role_arn
|
7789
|
-
# The IAM service role
|
7790
|
-
#
|
7791
|
-
#
|
7792
|
-
# If you do not specify a service role ARN, Systems Manager will use
|
7793
|
-
# your account's service-linked role for Systems Manager by default. If
|
7817
|
+
# The ARN of the IAM service role for Systems Manager to assume when
|
7818
|
+
# running a maintenance window task. If you do not specify a service
|
7819
|
+
# role ARN, Systems Manager uses your account's service-linked role. If
|
7794
7820
|
# no service-linked role for Systems Manager exists in your account, it
|
7795
|
-
#
|
7796
|
-
#
|
7821
|
+
# is created when you run `RegisterTaskWithMaintenanceWindow`.
|
7822
|
+
#
|
7823
|
+
# For more information, see the following topics in the in the *AWS
|
7824
|
+
# Systems Manager User Guide*\:
|
7825
|
+
#
|
7826
|
+
# * [Service-Linked Role Permissions for Systems Manager][1]
|
7797
7827
|
#
|
7798
|
-
#
|
7799
|
-
#
|
7800
|
-
# Service Role to Run Maintenance Window Tasks? ][2] in the *AWS Systems
|
7801
|
-
# Manager User Guide*.
|
7828
|
+
# * [Should I Use a Service-Linked Role or a Custom Service Role to Run
|
7829
|
+
# Maintenance Window Tasks? ][2]
|
7802
7830
|
#
|
7803
7831
|
#
|
7804
7832
|
#
|
@@ -7811,8 +7839,8 @@ module Aws::SSM
|
|
7811
7839
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass to
|
7812
7840
|
# a task when it runs, instead use the `Parameters` option in the
|
7813
7841
|
# `TaskInvocationParameters` structure. For information about how
|
7814
|
-
# Systems Manager handles these options for the supported
|
7815
|
-
#
|
7842
|
+
# Systems Manager handles these options for the supported maintenance
|
7843
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
7816
7844
|
#
|
7817
7845
|
# </note>
|
7818
7846
|
#
|
@@ -7849,7 +7877,7 @@ module Aws::SSM
|
|
7849
7877
|
# logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
|
7850
7878
|
# options in the `TaskInvocationParameters` structure. For information
|
7851
7879
|
# about how Systems Manager handles these options for the supported
|
7852
|
-
#
|
7880
|
+
# maintenance window task types, see
|
7853
7881
|
# MaintenanceWindowTaskInvocationParameters.
|
7854
7882
|
#
|
7855
7883
|
# </note>
|
@@ -8270,7 +8298,7 @@ module Aws::SSM
|
|
8270
8298
|
params: params,
|
8271
8299
|
config: config)
|
8272
8300
|
context[:gem_name] = 'aws-sdk-ssm'
|
8273
|
-
context[:gem_version] = '1.
|
8301
|
+
context[:gem_version] = '1.48.0'
|
8274
8302
|
Seahorse::Client::Request.new(handlers, context)
|
8275
8303
|
end
|
8276
8304
|
|