aws-sdk-ssm 1.81.1 → 1.86.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 +4 -1
- data/lib/aws-sdk-ssm/client.rb +294 -27
- data/lib/aws-sdk-ssm/client_api.rb +212 -0
- data/lib/aws-sdk-ssm/customizations.rb +1 -0
- data/lib/aws-sdk-ssm/errors.rb +2 -0
- data/lib/aws-sdk-ssm/resource.rb +2 -0
- data/lib/aws-sdk-ssm/types.rb +618 -29
- data/lib/aws-sdk-ssm/waiters.rb +156 -0
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 14e022796c1a6510c3cee97d6c83bed60a1aa1711775d90b1e3b08b49ec85522
|
4
|
+
data.tar.gz: 2e55b6b0c735d0fd7946702a3065bd1cbfbd51e2785090b547fdb83deccd90ce
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 220d1621a995c2febcba0f8b3a69c16440bec95ded413cfe186feb6cc092c746adcd3659ac972176bc9f0067f3d6cb891238a46eb5e075d693c67a14ecba638b
|
7
|
+
data.tar.gz: 799e8b7d4445f5e8f7eb44bf8d28c480af06fc7602e5587c2aa87a48daa4af515447375c3ba1bc738dfb6f371ebc069e5c140b31e5e8e48b77763ba5e346c7de
|
data/lib/aws-sdk-ssm.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -12,6 +14,7 @@ require_relative 'aws-sdk-ssm/types'
|
|
12
14
|
require_relative 'aws-sdk-ssm/client_api'
|
13
15
|
require_relative 'aws-sdk-ssm/client'
|
14
16
|
require_relative 'aws-sdk-ssm/errors'
|
17
|
+
require_relative 'aws-sdk-ssm/waiters'
|
15
18
|
require_relative 'aws-sdk-ssm/resource'
|
16
19
|
require_relative 'aws-sdk-ssm/customizations'
|
17
20
|
|
@@ -45,6 +48,6 @@ require_relative 'aws-sdk-ssm/customizations'
|
|
45
48
|
# @service
|
46
49
|
module Aws::SSM
|
47
50
|
|
48
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.86.0'
|
49
52
|
|
50
53
|
end
|
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -579,14 +581,19 @@ module Aws::SSM
|
|
579
581
|
req.send_request(options)
|
580
582
|
end
|
581
583
|
|
582
|
-
#
|
583
|
-
# instances
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
584
|
+
# A State Manager association defines the state that you want to
|
585
|
+
# maintain on your instances. For example, an association can specify
|
586
|
+
# that anti-virus software must be installed and running on your
|
587
|
+
# instances, or that certain ports must be closed. For static targets,
|
588
|
+
# the association specifies a schedule for when the configuration is
|
589
|
+
# reapplied. For dynamic targets, such as an AWS Resource Group or an
|
590
|
+
# AWS Autoscaling Group, State Manager applies the configuration when
|
591
|
+
# new instances are added to the group. The association also specifies
|
592
|
+
# actions to take when applying the configuration. For example, an
|
593
|
+
# association for anti-virus software might run once a day. If the
|
594
|
+
# software is not installed, then State Manager installs it. If the
|
595
|
+
# software is installed, but the service is not running, then the
|
596
|
+
# association might instruct State Manager to start the service.
|
590
597
|
#
|
591
598
|
# @option params [required, String] :name
|
592
599
|
# The name of the SSM document that contains the configuration
|
@@ -1145,6 +1152,18 @@ module Aws::SSM
|
|
1145
1152
|
#
|
1146
1153
|
# [1]: https://www.iana.org/time-zones
|
1147
1154
|
#
|
1155
|
+
# @option params [Integer] :schedule_offset
|
1156
|
+
# The number of days to wait after the date and time specified by a CRON
|
1157
|
+
# expression before running the maintenance window.
|
1158
|
+
#
|
1159
|
+
# For example, the following cron expression schedules a maintenance
|
1160
|
+
# window to run on the third Tuesday of every month at 11:30 PM.
|
1161
|
+
#
|
1162
|
+
# `cron(0 30 23 ? * TUE#3 *)`
|
1163
|
+
#
|
1164
|
+
# If the schedule offset is `2`, the maintenance window won't run until
|
1165
|
+
# two days later.
|
1166
|
+
#
|
1148
1167
|
# @option params [required, Integer] :duration
|
1149
1168
|
# The duration of the maintenance window in hours.
|
1150
1169
|
#
|
@@ -1200,6 +1219,7 @@ module Aws::SSM
|
|
1200
1219
|
# end_date: "MaintenanceWindowStringDateTime",
|
1201
1220
|
# schedule: "MaintenanceWindowSchedule", # required
|
1202
1221
|
# schedule_timezone: "MaintenanceWindowTimezone",
|
1222
|
+
# schedule_offset: 1,
|
1203
1223
|
# duration: 1, # required
|
1204
1224
|
# cutoff: 1, # required
|
1205
1225
|
# allow_unassociated_targets: false, # required
|
@@ -2275,6 +2295,8 @@ module Aws::SSM
|
|
2275
2295
|
# * {Types::DescribeAssociationExecutionTargetsResult#association_execution_targets #association_execution_targets} => Array<Types::AssociationExecutionTarget>
|
2276
2296
|
# * {Types::DescribeAssociationExecutionTargetsResult#next_token #next_token} => String
|
2277
2297
|
#
|
2298
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2299
|
+
#
|
2278
2300
|
# @example Request syntax with placeholder values
|
2279
2301
|
#
|
2280
2302
|
# resp = client.describe_association_execution_targets({
|
@@ -2345,6 +2367,8 @@ module Aws::SSM
|
|
2345
2367
|
# * {Types::DescribeAssociationExecutionsResult#association_executions #association_executions} => Array<Types::AssociationExecution>
|
2346
2368
|
# * {Types::DescribeAssociationExecutionsResult#next_token #next_token} => String
|
2347
2369
|
#
|
2370
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2371
|
+
#
|
2348
2372
|
# @example Request syntax with placeholder values
|
2349
2373
|
#
|
2350
2374
|
# resp = client.describe_association_executions({
|
@@ -2402,6 +2426,8 @@ module Aws::SSM
|
|
2402
2426
|
# * {Types::DescribeAutomationExecutionsResult#automation_execution_metadata_list #automation_execution_metadata_list} => Array<Types::AutomationExecutionMetadata>
|
2403
2427
|
# * {Types::DescribeAutomationExecutionsResult#next_token #next_token} => String
|
2404
2428
|
#
|
2429
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2430
|
+
#
|
2405
2431
|
# @example Request syntax with placeholder values
|
2406
2432
|
#
|
2407
2433
|
# resp = client.describe_automation_executions({
|
@@ -2490,6 +2516,8 @@ module Aws::SSM
|
|
2490
2516
|
# * {Types::DescribeAutomationStepExecutionsResult#step_executions #step_executions} => Array<Types::StepExecution>
|
2491
2517
|
# * {Types::DescribeAutomationStepExecutionsResult#next_token #next_token} => String
|
2492
2518
|
#
|
2519
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2520
|
+
#
|
2493
2521
|
# @example Request syntax with placeholder values
|
2494
2522
|
#
|
2495
2523
|
# resp = client.describe_automation_step_executions({
|
@@ -2577,6 +2605,8 @@ module Aws::SSM
|
|
2577
2605
|
# * {Types::DescribeAvailablePatchesResult#patches #patches} => Array<Types::Patch>
|
2578
2606
|
# * {Types::DescribeAvailablePatchesResult#next_token #next_token} => String
|
2579
2607
|
#
|
2608
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2609
|
+
#
|
2580
2610
|
# @example Request syntax with placeholder values
|
2581
2611
|
#
|
2582
2612
|
# resp = client.describe_available_patches({
|
@@ -2747,6 +2777,8 @@ module Aws::SSM
|
|
2747
2777
|
# * {Types::DescribeEffectiveInstanceAssociationsResult#associations #associations} => Array<Types::InstanceAssociation>
|
2748
2778
|
# * {Types::DescribeEffectiveInstanceAssociationsResult#next_token #next_token} => String
|
2749
2779
|
#
|
2780
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2781
|
+
#
|
2750
2782
|
# @example Request syntax with placeholder values
|
2751
2783
|
#
|
2752
2784
|
# resp = client.describe_effective_instance_associations({
|
@@ -2792,6 +2824,8 @@ module Aws::SSM
|
|
2792
2824
|
# * {Types::DescribeEffectivePatchesForPatchBaselineResult#effective_patches #effective_patches} => Array<Types::EffectivePatch>
|
2793
2825
|
# * {Types::DescribeEffectivePatchesForPatchBaselineResult#next_token #next_token} => String
|
2794
2826
|
#
|
2827
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2828
|
+
#
|
2795
2829
|
# @example Request syntax with placeholder values
|
2796
2830
|
#
|
2797
2831
|
# resp = client.describe_effective_patches_for_patch_baseline({
|
@@ -2849,6 +2883,8 @@ module Aws::SSM
|
|
2849
2883
|
# * {Types::DescribeInstanceAssociationsStatusResult#instance_association_status_infos #instance_association_status_infos} => Array<Types::InstanceAssociationStatusInfo>
|
2850
2884
|
# * {Types::DescribeInstanceAssociationsStatusResult#next_token #next_token} => String
|
2851
2885
|
#
|
2886
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2887
|
+
#
|
2852
2888
|
# @example Request syntax with placeholder values
|
2853
2889
|
#
|
2854
2890
|
# resp = client.describe_instance_associations_status({
|
@@ -3003,6 +3039,8 @@ module Aws::SSM
|
|
3003
3039
|
# * {Types::DescribeInstancePatchStatesResult#instance_patch_states #instance_patch_states} => Array<Types::InstancePatchState>
|
3004
3040
|
# * {Types::DescribeInstancePatchStatesResult#next_token #next_token} => String
|
3005
3041
|
#
|
3042
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3043
|
+
#
|
3006
3044
|
# @example Request syntax with placeholder values
|
3007
3045
|
#
|
3008
3046
|
# resp = client.describe_instance_patch_states({
|
@@ -3072,6 +3110,8 @@ module Aws::SSM
|
|
3072
3110
|
# * {Types::DescribeInstancePatchStatesForPatchGroupResult#instance_patch_states #instance_patch_states} => Array<Types::InstancePatchState>
|
3073
3111
|
# * {Types::DescribeInstancePatchStatesForPatchGroupResult#next_token #next_token} => String
|
3074
3112
|
#
|
3113
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3114
|
+
#
|
3075
3115
|
# @example Request syntax with placeholder values
|
3076
3116
|
#
|
3077
3117
|
# resp = client.describe_instance_patch_states_for_patch_group({
|
@@ -3145,6 +3185,8 @@ module Aws::SSM
|
|
3145
3185
|
# * {Types::DescribeInstancePatchesResult#patches #patches} => Array<Types::PatchComplianceData>
|
3146
3186
|
# * {Types::DescribeInstancePatchesResult#next_token #next_token} => String
|
3147
3187
|
#
|
3188
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3189
|
+
#
|
3148
3190
|
# @example Request syntax with placeholder values
|
3149
3191
|
#
|
3150
3192
|
# resp = client.describe_instance_patches({
|
@@ -3199,6 +3241,8 @@ module Aws::SSM
|
|
3199
3241
|
# * {Types::DescribeInventoryDeletionsResult#inventory_deletions #inventory_deletions} => Array<Types::InventoryDeletionStatusItem>
|
3200
3242
|
# * {Types::DescribeInventoryDeletionsResult#next_token #next_token} => String
|
3201
3243
|
#
|
3244
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3245
|
+
#
|
3202
3246
|
# @example Request syntax with placeholder values
|
3203
3247
|
#
|
3204
3248
|
# resp = client.describe_inventory_deletions({
|
@@ -3262,6 +3306,8 @@ module Aws::SSM
|
|
3262
3306
|
# * {Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult#window_execution_task_invocation_identities #window_execution_task_invocation_identities} => Array<Types::MaintenanceWindowExecutionTaskInvocationIdentity>
|
3263
3307
|
# * {Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult#next_token #next_token} => String
|
3264
3308
|
#
|
3309
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3310
|
+
#
|
3265
3311
|
# @example Request syntax with placeholder values
|
3266
3312
|
#
|
3267
3313
|
# resp = client.describe_maintenance_window_execution_task_invocations({
|
@@ -3329,6 +3375,8 @@ module Aws::SSM
|
|
3329
3375
|
# * {Types::DescribeMaintenanceWindowExecutionTasksResult#window_execution_task_identities #window_execution_task_identities} => Array<Types::MaintenanceWindowExecutionTaskIdentity>
|
3330
3376
|
# * {Types::DescribeMaintenanceWindowExecutionTasksResult#next_token #next_token} => String
|
3331
3377
|
#
|
3378
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3379
|
+
#
|
3332
3380
|
# @example Request syntax with placeholder values
|
3333
3381
|
#
|
3334
3382
|
# resp = client.describe_maintenance_window_execution_tasks({
|
@@ -3397,6 +3445,8 @@ module Aws::SSM
|
|
3397
3445
|
# * {Types::DescribeMaintenanceWindowExecutionsResult#window_executions #window_executions} => Array<Types::MaintenanceWindowExecution>
|
3398
3446
|
# * {Types::DescribeMaintenanceWindowExecutionsResult#next_token #next_token} => String
|
3399
3447
|
#
|
3448
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3449
|
+
#
|
3400
3450
|
# @example Request syntax with placeholder values
|
3401
3451
|
#
|
3402
3452
|
# resp = client.describe_maintenance_window_executions({
|
@@ -3463,6 +3513,8 @@ module Aws::SSM
|
|
3463
3513
|
# * {Types::DescribeMaintenanceWindowScheduleResult#scheduled_window_executions #scheduled_window_executions} => Array<Types::ScheduledWindowExecution>
|
3464
3514
|
# * {Types::DescribeMaintenanceWindowScheduleResult#next_token #next_token} => String
|
3465
3515
|
#
|
3516
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3517
|
+
#
|
3466
3518
|
# @example Request syntax with placeholder values
|
3467
3519
|
#
|
3468
3520
|
# resp = client.describe_maintenance_window_schedule({
|
@@ -3525,6 +3577,8 @@ module Aws::SSM
|
|
3525
3577
|
# * {Types::DescribeMaintenanceWindowTargetsResult#targets #targets} => Array<Types::MaintenanceWindowTarget>
|
3526
3578
|
# * {Types::DescribeMaintenanceWindowTargetsResult#next_token #next_token} => String
|
3527
3579
|
#
|
3580
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3581
|
+
#
|
3528
3582
|
# @example Request syntax with placeholder values
|
3529
3583
|
#
|
3530
3584
|
# resp = client.describe_maintenance_window_targets({
|
@@ -3587,6 +3641,8 @@ module Aws::SSM
|
|
3587
3641
|
# * {Types::DescribeMaintenanceWindowTasksResult#tasks #tasks} => Array<Types::MaintenanceWindowTask>
|
3588
3642
|
# * {Types::DescribeMaintenanceWindowTasksResult#next_token #next_token} => String
|
3589
3643
|
#
|
3644
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3645
|
+
#
|
3590
3646
|
# @example Request syntax with placeholder values
|
3591
3647
|
#
|
3592
3648
|
# resp = client.describe_maintenance_window_tasks({
|
@@ -3656,6 +3712,8 @@ module Aws::SSM
|
|
3656
3712
|
# * {Types::DescribeMaintenanceWindowsResult#window_identities #window_identities} => Array<Types::MaintenanceWindowIdentity>
|
3657
3713
|
# * {Types::DescribeMaintenanceWindowsResult#next_token #next_token} => String
|
3658
3714
|
#
|
3715
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3716
|
+
#
|
3659
3717
|
# @example Request syntax with placeholder values
|
3660
3718
|
#
|
3661
3719
|
# resp = client.describe_maintenance_windows({
|
@@ -3680,6 +3738,7 @@ module Aws::SSM
|
|
3680
3738
|
# resp.window_identities[0].cutoff #=> Integer
|
3681
3739
|
# resp.window_identities[0].schedule #=> String
|
3682
3740
|
# resp.window_identities[0].schedule_timezone #=> String
|
3741
|
+
# resp.window_identities[0].schedule_offset #=> Integer
|
3683
3742
|
# resp.window_identities[0].end_date #=> String
|
3684
3743
|
# resp.window_identities[0].start_date #=> String
|
3685
3744
|
# resp.window_identities[0].next_execution_time #=> String
|
@@ -3718,6 +3777,8 @@ module Aws::SSM
|
|
3718
3777
|
# * {Types::DescribeMaintenanceWindowsForTargetResult#window_identities #window_identities} => Array<Types::MaintenanceWindowIdentityForTarget>
|
3719
3778
|
# * {Types::DescribeMaintenanceWindowsForTargetResult#next_token #next_token} => String
|
3720
3779
|
#
|
3780
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3781
|
+
#
|
3721
3782
|
# @example Request syntax with placeholder values
|
3722
3783
|
#
|
3723
3784
|
# resp = client.describe_maintenance_windows_for_target({
|
@@ -3837,6 +3898,8 @@ module Aws::SSM
|
|
3837
3898
|
# * {Types::DescribeOpsItemsResponse#next_token #next_token} => String
|
3838
3899
|
# * {Types::DescribeOpsItemsResponse#ops_item_summaries #ops_item_summaries} => Array<Types::OpsItemSummary>
|
3839
3900
|
#
|
3901
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3902
|
+
#
|
3840
3903
|
# @example Request syntax with placeholder values
|
3841
3904
|
#
|
3842
3905
|
# resp = client.describe_ops_items({
|
@@ -3984,6 +4047,8 @@ module Aws::SSM
|
|
3984
4047
|
# * {Types::DescribePatchBaselinesResult#baseline_identities #baseline_identities} => Array<Types::PatchBaselineIdentity>
|
3985
4048
|
# * {Types::DescribePatchBaselinesResult#next_token #next_token} => String
|
3986
4049
|
#
|
4050
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4051
|
+
#
|
3987
4052
|
# @example Request syntax with placeholder values
|
3988
4053
|
#
|
3989
4054
|
# resp = client.describe_patch_baselines({
|
@@ -4070,6 +4135,22 @@ module Aws::SSM
|
|
4070
4135
|
# One or more filters. Use a filter to return a more specific list of
|
4071
4136
|
# results.
|
4072
4137
|
#
|
4138
|
+
# For `DescribePatchGroups`,valid filter keys include the following:
|
4139
|
+
#
|
4140
|
+
# * `NAME_PREFIX`\: The name of the patch group. Wildcards (*) are
|
4141
|
+
# accepted.
|
4142
|
+
#
|
4143
|
+
# * `OPERATING_SYSTEM`\: The supported operating system type to return
|
4144
|
+
# results for. For valid operating system values, see
|
4145
|
+
# GetDefaultPatchBaselineRequest$OperatingSystem in
|
4146
|
+
# CreatePatchBaseline.
|
4147
|
+
#
|
4148
|
+
# Examples:
|
4149
|
+
#
|
4150
|
+
# * `--filters Key=NAME_PREFIX,Values=MyPatchGroup*`
|
4151
|
+
#
|
4152
|
+
# * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
|
4153
|
+
#
|
4073
4154
|
# @option params [String] :next_token
|
4074
4155
|
# The token for the next set of items to return. (You received this
|
4075
4156
|
# token from a previous call.)
|
@@ -4079,6 +4160,8 @@ module Aws::SSM
|
|
4079
4160
|
# * {Types::DescribePatchGroupsResult#mappings #mappings} => Array<Types::PatchGroupPatchBaselineMapping>
|
4080
4161
|
# * {Types::DescribePatchGroupsResult#next_token #next_token} => String
|
4081
4162
|
#
|
4163
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4164
|
+
#
|
4082
4165
|
# @example Request syntax with placeholder values
|
4083
4166
|
#
|
4084
4167
|
# resp = client.describe_patch_groups({
|
@@ -4176,6 +4259,8 @@ module Aws::SSM
|
|
4176
4259
|
# * {Types::DescribePatchPropertiesResult#properties #properties} => Array<Hash<String,String>>
|
4177
4260
|
# * {Types::DescribePatchPropertiesResult#next_token #next_token} => String
|
4178
4261
|
#
|
4262
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4263
|
+
#
|
4179
4264
|
# @example Request syntax with placeholder values
|
4180
4265
|
#
|
4181
4266
|
# resp = client.describe_patch_properties({
|
@@ -4227,6 +4312,8 @@ module Aws::SSM
|
|
4227
4312
|
# * {Types::DescribeSessionsResponse#sessions #sessions} => Array<Types::Session>
|
4228
4313
|
# * {Types::DescribeSessionsResponse#next_token #next_token} => String
|
4229
4314
|
#
|
4315
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4316
|
+
#
|
4230
4317
|
# @example Request syntax with placeholder values
|
4231
4318
|
#
|
4232
4319
|
# resp = client.describe_sessions({
|
@@ -4455,6 +4542,9 @@ module Aws::SSM
|
|
4455
4542
|
# If the document contains only one plugin, the name can be omitted and
|
4456
4543
|
# the details will be returned.
|
4457
4544
|
#
|
4545
|
+
# Plugin names are also referred to as step names in Systems Manager
|
4546
|
+
# documents.
|
4547
|
+
#
|
4458
4548
|
# @return [Types::GetCommandInvocationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4459
4549
|
#
|
4460
4550
|
# * {Types::GetCommandInvocationResult#command_id #command_id} => String
|
@@ -4504,6 +4594,11 @@ module Aws::SSM
|
|
4504
4594
|
# resp.cloud_watch_output_config.cloud_watch_log_group_name #=> String
|
4505
4595
|
# resp.cloud_watch_output_config.cloud_watch_output_enabled #=> Boolean
|
4506
4596
|
#
|
4597
|
+
#
|
4598
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
4599
|
+
#
|
4600
|
+
# * command_executed
|
4601
|
+
#
|
4507
4602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocation AWS API Documentation
|
4508
4603
|
#
|
4509
4604
|
# @overload get_command_invocation(params = {})
|
@@ -4718,6 +4813,8 @@ module Aws::SSM
|
|
4718
4813
|
# * {Types::GetInventoryResult#entities #entities} => Array<Types::InventoryResultEntity>
|
4719
4814
|
# * {Types::GetInventoryResult#next_token #next_token} => String
|
4720
4815
|
#
|
4816
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4817
|
+
#
|
4721
4818
|
# @example Request syntax with placeholder values
|
4722
4819
|
#
|
4723
4820
|
# resp = client.get_inventory({
|
@@ -4809,6 +4906,8 @@ module Aws::SSM
|
|
4809
4906
|
# * {Types::GetInventorySchemaResult#schemas #schemas} => Array<Types::InventoryItemSchema>
|
4810
4907
|
# * {Types::GetInventorySchemaResult#next_token #next_token} => String
|
4811
4908
|
#
|
4909
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4910
|
+
#
|
4812
4911
|
# @example Request syntax with placeholder values
|
4813
4912
|
#
|
4814
4913
|
# resp = client.get_inventory_schema({
|
@@ -4854,6 +4953,7 @@ module Aws::SSM
|
|
4854
4953
|
# * {Types::GetMaintenanceWindowResult#end_date #end_date} => String
|
4855
4954
|
# * {Types::GetMaintenanceWindowResult#schedule #schedule} => String
|
4856
4955
|
# * {Types::GetMaintenanceWindowResult#schedule_timezone #schedule_timezone} => String
|
4956
|
+
# * {Types::GetMaintenanceWindowResult#schedule_offset #schedule_offset} => Integer
|
4857
4957
|
# * {Types::GetMaintenanceWindowResult#next_execution_time #next_execution_time} => String
|
4858
4958
|
# * {Types::GetMaintenanceWindowResult#duration #duration} => Integer
|
4859
4959
|
# * {Types::GetMaintenanceWindowResult#cutoff #cutoff} => Integer
|
@@ -4877,6 +4977,7 @@ module Aws::SSM
|
|
4877
4977
|
# resp.end_date #=> String
|
4878
4978
|
# resp.schedule #=> String
|
4879
4979
|
# resp.schedule_timezone #=> String
|
4980
|
+
# resp.schedule_offset #=> Integer
|
4880
4981
|
# resp.next_execution_time #=> String
|
4881
4982
|
# resp.duration #=> Integer
|
4882
4983
|
# resp.cutoff #=> Integer
|
@@ -5235,6 +5336,8 @@ module Aws::SSM
|
|
5235
5336
|
# * {Types::GetOpsSummaryResult#entities #entities} => Array<Types::OpsEntity>
|
5236
5337
|
# * {Types::GetOpsSummaryResult#next_token #next_token} => String
|
5237
5338
|
#
|
5339
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5340
|
+
#
|
5238
5341
|
# @example Request syntax with placeholder values
|
5239
5342
|
#
|
5240
5343
|
# resp = client.get_ops_summary({
|
@@ -5797,6 +5900,8 @@ module Aws::SSM
|
|
5797
5900
|
# * {Types::ListAssociationVersionsResult#association_versions #association_versions} => Array<Types::AssociationVersionInfo>
|
5798
5901
|
# * {Types::ListAssociationVersionsResult#next_token #next_token} => String
|
5799
5902
|
#
|
5903
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5904
|
+
#
|
5800
5905
|
# @example Request syntax with placeholder values
|
5801
5906
|
#
|
5802
5907
|
# resp = client.list_association_versions({
|
@@ -6015,6 +6120,12 @@ module Aws::SSM
|
|
6015
6120
|
# @option params [String] :instance_id
|
6016
6121
|
# (Optional) Lists commands issued against this instance ID.
|
6017
6122
|
#
|
6123
|
+
# <note markdown="1"> You can't specify an instance ID in the same command that you specify
|
6124
|
+
# `Status` = `Pending`. This is because the command has not reached the
|
6125
|
+
# instance yet.
|
6126
|
+
#
|
6127
|
+
# </note>
|
6128
|
+
#
|
6018
6129
|
# @option params [Integer] :max_results
|
6019
6130
|
# (Optional) The maximum number of items to return for this call. The
|
6020
6131
|
# call also returns a token that you can specify in a subsequent call to
|
@@ -6129,6 +6240,8 @@ module Aws::SSM
|
|
6129
6240
|
# * {Types::ListComplianceItemsResult#compliance_items #compliance_items} => Array<Types::ComplianceItem>
|
6130
6241
|
# * {Types::ListComplianceItemsResult#next_token #next_token} => String
|
6131
6242
|
#
|
6243
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6244
|
+
#
|
6132
6245
|
# @example Request syntax with placeholder values
|
6133
6246
|
#
|
6134
6247
|
# resp = client.list_compliance_items({
|
@@ -6194,6 +6307,8 @@ module Aws::SSM
|
|
6194
6307
|
# * {Types::ListComplianceSummariesResult#compliance_summary_items #compliance_summary_items} => Array<Types::ComplianceSummaryItem>
|
6195
6308
|
# * {Types::ListComplianceSummariesResult#next_token #next_token} => String
|
6196
6309
|
#
|
6310
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6311
|
+
#
|
6197
6312
|
# @example Request syntax with placeholder values
|
6198
6313
|
#
|
6199
6314
|
# resp = client.list_compliance_summaries({
|
@@ -6257,6 +6372,8 @@ module Aws::SSM
|
|
6257
6372
|
# * {Types::ListDocumentVersionsResult#document_versions #document_versions} => Array<Types::DocumentVersionInfo>
|
6258
6373
|
# * {Types::ListDocumentVersionsResult#next_token #next_token} => String
|
6259
6374
|
#
|
6375
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6376
|
+
#
|
6260
6377
|
# @example Request syntax with placeholder values
|
6261
6378
|
#
|
6262
6379
|
# resp = client.list_document_versions({
|
@@ -6457,6 +6574,8 @@ module Aws::SSM
|
|
6457
6574
|
# * {Types::ListResourceComplianceSummariesResult#resource_compliance_summary_items #resource_compliance_summary_items} => Array<Types::ResourceComplianceSummaryItem>
|
6458
6575
|
# * {Types::ListResourceComplianceSummariesResult#next_token #next_token} => String
|
6459
6576
|
#
|
6577
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6578
|
+
#
|
6460
6579
|
# @example Request syntax with placeholder values
|
6461
6580
|
#
|
6462
6581
|
# resp = client.list_resource_compliance_summaries({
|
@@ -6540,6 +6659,8 @@ module Aws::SSM
|
|
6540
6659
|
# * {Types::ListResourceDataSyncResult#resource_data_sync_items #resource_data_sync_items} => Array<Types::ResourceDataSyncItem>
|
6541
6660
|
# * {Types::ListResourceDataSyncResult#next_token #next_token} => String
|
6542
6661
|
#
|
6662
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6663
|
+
#
|
6543
6664
|
# @example Request syntax with placeholder values
|
6544
6665
|
#
|
6545
6666
|
# resp = client.list_resource_data_sync({
|
@@ -6899,15 +7020,18 @@ module Aws::SSM
|
|
6899
7020
|
# @option params [String] :type
|
6900
7021
|
# The type of parameter that you want to add to the system.
|
6901
7022
|
#
|
7023
|
+
# <note markdown="1"> `SecureString` is not currently supported for AWS CloudFormation
|
7024
|
+
# templates or in the China Regions.
|
7025
|
+
#
|
7026
|
+
# </note>
|
7027
|
+
#
|
6902
7028
|
# Items in a `StringList` must be separated by a comma (,). You can't
|
6903
7029
|
# use other punctuation or special character to escape items in the
|
6904
7030
|
# list. If you have a parameter value that requires a comma, then use
|
6905
7031
|
# the `String` data type.
|
6906
7032
|
#
|
6907
|
-
#
|
6908
|
-
#
|
6909
|
-
#
|
6910
|
-
# </note>
|
7033
|
+
# Specifying a parameter type is not required when updating a parameter.
|
7034
|
+
# You must specify a parameter type when creating a parameter.
|
6911
7035
|
#
|
6912
7036
|
# @option params [String] :key_id
|
6913
7037
|
# The KMS Key ID that you want to use to encrypt a parameter. Either the
|
@@ -7673,23 +7797,37 @@ module Aws::SSM
|
|
7673
7797
|
# Runs commands on one or more managed instances.
|
7674
7798
|
#
|
7675
7799
|
# @option params [Array<String>] :instance_ids
|
7676
|
-
# The
|
7677
|
-
#
|
7678
|
-
# you can
|
7679
|
-
#
|
7680
|
-
#
|
7681
|
-
#
|
7800
|
+
# The IDs of the instances where the command should run. Specifying
|
7801
|
+
# instance IDs is most useful when you are targeting a limited number of
|
7802
|
+
# instances, though you can specify up to 50 IDs.
|
7803
|
+
#
|
7804
|
+
# To target a larger number of instances, or if you prefer not to list
|
7805
|
+
# individual instance IDs, we recommend using the `Targets` option
|
7806
|
+
# instead. Using `Targets`, which accepts tag key-value pairs to
|
7807
|
+
# identify the instances to send commands to, you can a send command to
|
7808
|
+
# tens, hundreds, or thousands of instances at once.
|
7809
|
+
#
|
7810
|
+
# For more information about how to use targets, see [Using targets and
|
7811
|
+
# rate controls to send commands to a fleet][1] in the *AWS Systems
|
7812
|
+
# Manager User Guide*.
|
7682
7813
|
#
|
7683
7814
|
#
|
7684
7815
|
#
|
7685
7816
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
7686
7817
|
#
|
7687
7818
|
# @option params [Array<Types::Target>] :targets
|
7688
|
-
#
|
7689
|
-
#
|
7690
|
-
#
|
7691
|
-
#
|
7692
|
-
#
|
7819
|
+
# An array of search criteria that targets instances using a `Key,Value`
|
7820
|
+
# combination that you specify. Specifying targets is most useful when
|
7821
|
+
# you want to send a command to a large number of instances at once.
|
7822
|
+
# Using `Targets`, which accepts tag key-value pairs to identify
|
7823
|
+
# instances, you can send a command to tens, hundreds, or thousands of
|
7824
|
+
# instances at once.
|
7825
|
+
#
|
7826
|
+
# To send a command to a smaller number of instances, you can use the
|
7827
|
+
# `InstanceIds` option instead.
|
7828
|
+
#
|
7829
|
+
# For more information about how to use targets, see [Sending commands
|
7830
|
+
# to a fleet][1] in the *AWS Systems Manager User Guide*.
|
7693
7831
|
#
|
7694
7832
|
#
|
7695
7833
|
#
|
@@ -8062,8 +8200,9 @@ module Aws::SSM
|
|
8062
8200
|
# @option params [String] :document_name
|
8063
8201
|
# The name of the SSM document to define the parameters and plugin
|
8064
8202
|
# settings for the session. For example, `SSM-SessionManagerRunShell`.
|
8065
|
-
#
|
8066
|
-
#
|
8203
|
+
# You can call the GetDocument API to verify the document exists before
|
8204
|
+
# attempting to start a session. If no document name is provided, a
|
8205
|
+
# shell to the instance is launched by default.
|
8067
8206
|
#
|
8068
8207
|
# @option params [Hash<String,Array>] :parameters
|
8069
8208
|
# Reserved for future use.
|
@@ -8633,6 +8772,18 @@ module Aws::SSM
|
|
8633
8772
|
#
|
8634
8773
|
# [1]: https://www.iana.org/time-zones
|
8635
8774
|
#
|
8775
|
+
# @option params [Integer] :schedule_offset
|
8776
|
+
# The number of days to wait after the date and time specified by a CRON
|
8777
|
+
# expression before running the maintenance window.
|
8778
|
+
#
|
8779
|
+
# For example, the following cron expression schedules a maintenance
|
8780
|
+
# window to run the third Tuesday of every month at 11:30 PM.
|
8781
|
+
#
|
8782
|
+
# `cron(0 30 23 ? * TUE#3 *)`
|
8783
|
+
#
|
8784
|
+
# If the schedule offset is `2`, the maintenance window won't run until
|
8785
|
+
# two days later.
|
8786
|
+
#
|
8636
8787
|
# @option params [Integer] :duration
|
8637
8788
|
# The duration of the maintenance window in hours.
|
8638
8789
|
#
|
@@ -8661,6 +8812,7 @@ module Aws::SSM
|
|
8661
8812
|
# * {Types::UpdateMaintenanceWindowResult#end_date #end_date} => String
|
8662
8813
|
# * {Types::UpdateMaintenanceWindowResult#schedule #schedule} => String
|
8663
8814
|
# * {Types::UpdateMaintenanceWindowResult#schedule_timezone #schedule_timezone} => String
|
8815
|
+
# * {Types::UpdateMaintenanceWindowResult#schedule_offset #schedule_offset} => Integer
|
8664
8816
|
# * {Types::UpdateMaintenanceWindowResult#duration #duration} => Integer
|
8665
8817
|
# * {Types::UpdateMaintenanceWindowResult#cutoff #cutoff} => Integer
|
8666
8818
|
# * {Types::UpdateMaintenanceWindowResult#allow_unassociated_targets #allow_unassociated_targets} => Boolean
|
@@ -8676,6 +8828,7 @@ module Aws::SSM
|
|
8676
8828
|
# end_date: "MaintenanceWindowStringDateTime",
|
8677
8829
|
# schedule: "MaintenanceWindowSchedule",
|
8678
8830
|
# schedule_timezone: "MaintenanceWindowTimezone",
|
8831
|
+
# schedule_offset: 1,
|
8679
8832
|
# duration: 1,
|
8680
8833
|
# cutoff: 1,
|
8681
8834
|
# allow_unassociated_targets: false,
|
@@ -8692,6 +8845,7 @@ module Aws::SSM
|
|
8692
8845
|
# resp.end_date #=> String
|
8693
8846
|
# resp.schedule #=> String
|
8694
8847
|
# resp.schedule_timezone #=> String
|
8848
|
+
# resp.schedule_offset #=> Integer
|
8695
8849
|
# resp.duration #=> Integer
|
8696
8850
|
# resp.cutoff #=> Integer
|
8697
8851
|
# resp.allow_unassociated_targets #=> Boolean
|
@@ -9537,14 +9691,127 @@ module Aws::SSM
|
|
9537
9691
|
params: params,
|
9538
9692
|
config: config)
|
9539
9693
|
context[:gem_name] = 'aws-sdk-ssm'
|
9540
|
-
context[:gem_version] = '1.
|
9694
|
+
context[:gem_version] = '1.86.0'
|
9541
9695
|
Seahorse::Client::Request.new(handlers, context)
|
9542
9696
|
end
|
9543
9697
|
|
9698
|
+
# Polls an API operation until a resource enters a desired state.
|
9699
|
+
#
|
9700
|
+
# ## Basic Usage
|
9701
|
+
#
|
9702
|
+
# A waiter will call an API operation until:
|
9703
|
+
#
|
9704
|
+
# * It is successful
|
9705
|
+
# * It enters a terminal state
|
9706
|
+
# * It makes the maximum number of attempts
|
9707
|
+
#
|
9708
|
+
# In between attempts, the waiter will sleep.
|
9709
|
+
#
|
9710
|
+
# # polls in a loop, sleeping between attempts
|
9711
|
+
# client.wait_until(waiter_name, params)
|
9712
|
+
#
|
9713
|
+
# ## Configuration
|
9714
|
+
#
|
9715
|
+
# You can configure the maximum number of polling attempts, and the
|
9716
|
+
# delay (in seconds) between each polling attempt. You can pass
|
9717
|
+
# configuration as the final arguments hash.
|
9718
|
+
#
|
9719
|
+
# # poll for ~25 seconds
|
9720
|
+
# client.wait_until(waiter_name, params, {
|
9721
|
+
# max_attempts: 5,
|
9722
|
+
# delay: 5,
|
9723
|
+
# })
|
9724
|
+
#
|
9725
|
+
# ## Callbacks
|
9726
|
+
#
|
9727
|
+
# You can be notified before each polling attempt and before each
|
9728
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
9729
|
+
# it will terminate the waiter.
|
9730
|
+
#
|
9731
|
+
# started_at = Time.now
|
9732
|
+
# client.wait_until(waiter_name, params, {
|
9733
|
+
#
|
9734
|
+
# # disable max attempts
|
9735
|
+
# max_attempts: nil,
|
9736
|
+
#
|
9737
|
+
# # poll for 1 hour, instead of a number of attempts
|
9738
|
+
# before_wait: -> (attempts, response) do
|
9739
|
+
# throw :failure if Time.now - started_at > 3600
|
9740
|
+
# end
|
9741
|
+
# })
|
9742
|
+
#
|
9743
|
+
# ## Handling Errors
|
9744
|
+
#
|
9745
|
+
# When a waiter is unsuccessful, it will raise an error.
|
9746
|
+
# All of the failure errors extend from
|
9747
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
9748
|
+
#
|
9749
|
+
# begin
|
9750
|
+
# client.wait_until(...)
|
9751
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
9752
|
+
# # resource did not enter the desired state in time
|
9753
|
+
# end
|
9754
|
+
#
|
9755
|
+
# ## Valid Waiters
|
9756
|
+
#
|
9757
|
+
# The following table lists the valid waiter names, the operations they call,
|
9758
|
+
# and the default `:delay` and `:max_attempts` values.
|
9759
|
+
#
|
9760
|
+
# | waiter_name | params | :delay | :max_attempts |
|
9761
|
+
# | ---------------- | ------------------------------- | -------- | ------------- |
|
9762
|
+
# | command_executed | {Client#get_command_invocation} | 5 | 20 |
|
9763
|
+
#
|
9764
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
9765
|
+
# because the waiter has entered a state that it will not transition
|
9766
|
+
# out of, preventing success.
|
9767
|
+
#
|
9768
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
9769
|
+
# maximum number of attempts have been made, and the waiter is not
|
9770
|
+
# yet successful.
|
9771
|
+
#
|
9772
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
9773
|
+
# while polling for a resource that is not expected.
|
9774
|
+
#
|
9775
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
9776
|
+
# for an unknown state.
|
9777
|
+
#
|
9778
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
9779
|
+
# @param [Symbol] waiter_name
|
9780
|
+
# @param [Hash] params ({})
|
9781
|
+
# @param [Hash] options ({})
|
9782
|
+
# @option options [Integer] :max_attempts
|
9783
|
+
# @option options [Integer] :delay
|
9784
|
+
# @option options [Proc] :before_attempt
|
9785
|
+
# @option options [Proc] :before_wait
|
9786
|
+
def wait_until(waiter_name, params = {}, options = {})
|
9787
|
+
w = waiter(waiter_name, options)
|
9788
|
+
yield(w.waiter) if block_given? # deprecated
|
9789
|
+
w.wait(params)
|
9790
|
+
end
|
9791
|
+
|
9544
9792
|
# @api private
|
9545
9793
|
# @deprecated
|
9546
9794
|
def waiter_names
|
9547
|
-
|
9795
|
+
waiters.keys
|
9796
|
+
end
|
9797
|
+
|
9798
|
+
private
|
9799
|
+
|
9800
|
+
# @param [Symbol] waiter_name
|
9801
|
+
# @param [Hash] options ({})
|
9802
|
+
def waiter(waiter_name, options = {})
|
9803
|
+
waiter_class = waiters[waiter_name]
|
9804
|
+
if waiter_class
|
9805
|
+
waiter_class.new(options.merge(client: self))
|
9806
|
+
else
|
9807
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
9808
|
+
end
|
9809
|
+
end
|
9810
|
+
|
9811
|
+
def waiters
|
9812
|
+
{
|
9813
|
+
command_executed: Waiters::CommandExecuted
|
9814
|
+
}
|
9548
9815
|
end
|
9549
9816
|
|
9550
9817
|
class << self
|