aws-sdk-ssm 1.84.0 → 1.90.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 -2
- data/lib/aws-sdk-ssm/client.rb +325 -36
- data/lib/aws-sdk-ssm/client_api.rb +209 -5
- data/lib/aws-sdk-ssm/types.rb +215 -67
- 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: 04eb7d85ea64907942223a314bf4d304381e22f49f463d4cba4bc1e01d2e1af6
|
4
|
+
data.tar.gz: b1c2a2018b09349722f4f6d4caf88931ba4f41e2ee878fb55ca1ce9a1c5fd848
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0febe002a68776edb07a60eaeb99862f01015be7f3c15d24635e13cc5b20174a062bbbd1981540d98d848427e5879bb28b9f319dc53d62be7f59b97c658af41d
|
7
|
+
data.tar.gz: 7a0e4ec42741757293467f7b18c464d4abd800567b1c7ba8acad41322c6ca08868157ad4bc5c88de5ffb22ef9983f57640119c5cf6c358da924f3f375810e405
|
data/lib/aws-sdk-ssm.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -14,6 +15,7 @@ require_relative 'aws-sdk-ssm/types'
|
|
14
15
|
require_relative 'aws-sdk-ssm/client_api'
|
15
16
|
require_relative 'aws-sdk-ssm/client'
|
16
17
|
require_relative 'aws-sdk-ssm/errors'
|
18
|
+
require_relative 'aws-sdk-ssm/waiters'
|
17
19
|
require_relative 'aws-sdk-ssm/resource'
|
18
20
|
require_relative 'aws-sdk-ssm/customizations'
|
19
21
|
|
@@ -44,9 +46,9 @@ require_relative 'aws-sdk-ssm/customizations'
|
|
44
46
|
#
|
45
47
|
# See {Errors} for more information.
|
46
48
|
#
|
47
|
-
#
|
49
|
+
# @!group service
|
48
50
|
module Aws::SSM
|
49
51
|
|
50
|
-
GEM_VERSION = '1.
|
52
|
+
GEM_VERSION = '1.90.0'
|
51
53
|
|
52
54
|
end
|
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::SSM
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::SSM
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -1771,13 +1786,13 @@ module Aws::SSM
|
|
1771
1786
|
req.send_request(options)
|
1772
1787
|
end
|
1773
1788
|
|
1774
|
-
# Delete a custom inventory type
|
1789
|
+
# Delete a custom inventory type or the data associated with a custom
|
1775
1790
|
# Inventory type. Deleting a custom inventory type is also referred to
|
1776
1791
|
# as deleting a custom inventory schema.
|
1777
1792
|
#
|
1778
1793
|
# @option params [required, String] :type_name
|
1779
1794
|
# The name of the custom inventory type for which you want to delete
|
1780
|
-
# either all previously collected data
|
1795
|
+
# either all previously collected data or the inventory type itself.
|
1781
1796
|
#
|
1782
1797
|
# @option params [String] :schema_delete_option
|
1783
1798
|
# Use the `SchemaDeleteOption` to delete a custom inventory type
|
@@ -1818,7 +1833,7 @@ module Aws::SSM
|
|
1818
1833
|
# type_name: "InventoryItemTypeName", # required
|
1819
1834
|
# schema_delete_option: "DisableSchema", # accepts DisableSchema, DeleteSchema
|
1820
1835
|
# dry_run: false,
|
1821
|
-
# client_token: "
|
1836
|
+
# client_token: "UUID",
|
1822
1837
|
# })
|
1823
1838
|
#
|
1824
1839
|
# @example Response structure
|
@@ -2295,6 +2310,8 @@ module Aws::SSM
|
|
2295
2310
|
# * {Types::DescribeAssociationExecutionTargetsResult#association_execution_targets #association_execution_targets} => Array<Types::AssociationExecutionTarget>
|
2296
2311
|
# * {Types::DescribeAssociationExecutionTargetsResult#next_token #next_token} => String
|
2297
2312
|
#
|
2313
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2314
|
+
#
|
2298
2315
|
# @example Request syntax with placeholder values
|
2299
2316
|
#
|
2300
2317
|
# resp = client.describe_association_execution_targets({
|
@@ -2365,6 +2382,8 @@ module Aws::SSM
|
|
2365
2382
|
# * {Types::DescribeAssociationExecutionsResult#association_executions #association_executions} => Array<Types::AssociationExecution>
|
2366
2383
|
# * {Types::DescribeAssociationExecutionsResult#next_token #next_token} => String
|
2367
2384
|
#
|
2385
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2386
|
+
#
|
2368
2387
|
# @example Request syntax with placeholder values
|
2369
2388
|
#
|
2370
2389
|
# resp = client.describe_association_executions({
|
@@ -2422,6 +2441,8 @@ module Aws::SSM
|
|
2422
2441
|
# * {Types::DescribeAutomationExecutionsResult#automation_execution_metadata_list #automation_execution_metadata_list} => Array<Types::AutomationExecutionMetadata>
|
2423
2442
|
# * {Types::DescribeAutomationExecutionsResult#next_token #next_token} => String
|
2424
2443
|
#
|
2444
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2445
|
+
#
|
2425
2446
|
# @example Request syntax with placeholder values
|
2426
2447
|
#
|
2427
2448
|
# resp = client.describe_automation_executions({
|
@@ -2510,6 +2531,8 @@ module Aws::SSM
|
|
2510
2531
|
# * {Types::DescribeAutomationStepExecutionsResult#step_executions #step_executions} => Array<Types::StepExecution>
|
2511
2532
|
# * {Types::DescribeAutomationStepExecutionsResult#next_token #next_token} => String
|
2512
2533
|
#
|
2534
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2535
|
+
#
|
2513
2536
|
# @example Request syntax with placeholder values
|
2514
2537
|
#
|
2515
2538
|
# resp = client.describe_automation_step_executions({
|
@@ -2597,6 +2620,8 @@ module Aws::SSM
|
|
2597
2620
|
# * {Types::DescribeAvailablePatchesResult#patches #patches} => Array<Types::Patch>
|
2598
2621
|
# * {Types::DescribeAvailablePatchesResult#next_token #next_token} => String
|
2599
2622
|
#
|
2623
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2624
|
+
#
|
2600
2625
|
# @example Request syntax with placeholder values
|
2601
2626
|
#
|
2602
2627
|
# resp = client.describe_available_patches({
|
@@ -2767,6 +2792,8 @@ module Aws::SSM
|
|
2767
2792
|
# * {Types::DescribeEffectiveInstanceAssociationsResult#associations #associations} => Array<Types::InstanceAssociation>
|
2768
2793
|
# * {Types::DescribeEffectiveInstanceAssociationsResult#next_token #next_token} => String
|
2769
2794
|
#
|
2795
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2796
|
+
#
|
2770
2797
|
# @example Request syntax with placeholder values
|
2771
2798
|
#
|
2772
2799
|
# resp = client.describe_effective_instance_associations({
|
@@ -2812,6 +2839,8 @@ module Aws::SSM
|
|
2812
2839
|
# * {Types::DescribeEffectivePatchesForPatchBaselineResult#effective_patches #effective_patches} => Array<Types::EffectivePatch>
|
2813
2840
|
# * {Types::DescribeEffectivePatchesForPatchBaselineResult#next_token #next_token} => String
|
2814
2841
|
#
|
2842
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2843
|
+
#
|
2815
2844
|
# @example Request syntax with placeholder values
|
2816
2845
|
#
|
2817
2846
|
# resp = client.describe_effective_patches_for_patch_baseline({
|
@@ -2869,6 +2898,8 @@ module Aws::SSM
|
|
2869
2898
|
# * {Types::DescribeInstanceAssociationsStatusResult#instance_association_status_infos #instance_association_status_infos} => Array<Types::InstanceAssociationStatusInfo>
|
2870
2899
|
# * {Types::DescribeInstanceAssociationsStatusResult#next_token #next_token} => String
|
2871
2900
|
#
|
2901
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2902
|
+
#
|
2872
2903
|
# @example Request syntax with placeholder values
|
2873
2904
|
#
|
2874
2905
|
# resp = client.describe_instance_associations_status({
|
@@ -3023,6 +3054,8 @@ module Aws::SSM
|
|
3023
3054
|
# * {Types::DescribeInstancePatchStatesResult#instance_patch_states #instance_patch_states} => Array<Types::InstancePatchState>
|
3024
3055
|
# * {Types::DescribeInstancePatchStatesResult#next_token #next_token} => String
|
3025
3056
|
#
|
3057
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3058
|
+
#
|
3026
3059
|
# @example Request syntax with placeholder values
|
3027
3060
|
#
|
3028
3061
|
# resp = client.describe_instance_patch_states({
|
@@ -3092,6 +3125,8 @@ module Aws::SSM
|
|
3092
3125
|
# * {Types::DescribeInstancePatchStatesForPatchGroupResult#instance_patch_states #instance_patch_states} => Array<Types::InstancePatchState>
|
3093
3126
|
# * {Types::DescribeInstancePatchStatesForPatchGroupResult#next_token #next_token} => String
|
3094
3127
|
#
|
3128
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3129
|
+
#
|
3095
3130
|
# @example Request syntax with placeholder values
|
3096
3131
|
#
|
3097
3132
|
# resp = client.describe_instance_patch_states_for_patch_group({
|
@@ -3165,6 +3200,8 @@ module Aws::SSM
|
|
3165
3200
|
# * {Types::DescribeInstancePatchesResult#patches #patches} => Array<Types::PatchComplianceData>
|
3166
3201
|
# * {Types::DescribeInstancePatchesResult#next_token #next_token} => String
|
3167
3202
|
#
|
3203
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3204
|
+
#
|
3168
3205
|
# @example Request syntax with placeholder values
|
3169
3206
|
#
|
3170
3207
|
# resp = client.describe_instance_patches({
|
@@ -3219,10 +3256,12 @@ module Aws::SSM
|
|
3219
3256
|
# * {Types::DescribeInventoryDeletionsResult#inventory_deletions #inventory_deletions} => Array<Types::InventoryDeletionStatusItem>
|
3220
3257
|
# * {Types::DescribeInventoryDeletionsResult#next_token #next_token} => String
|
3221
3258
|
#
|
3259
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3260
|
+
#
|
3222
3261
|
# @example Request syntax with placeholder values
|
3223
3262
|
#
|
3224
3263
|
# resp = client.describe_inventory_deletions({
|
3225
|
-
# deletion_id: "
|
3264
|
+
# deletion_id: "UUID",
|
3226
3265
|
# next_token: "NextToken",
|
3227
3266
|
# max_results: 1,
|
3228
3267
|
# })
|
@@ -3282,6 +3321,8 @@ module Aws::SSM
|
|
3282
3321
|
# * {Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult#window_execution_task_invocation_identities #window_execution_task_invocation_identities} => Array<Types::MaintenanceWindowExecutionTaskInvocationIdentity>
|
3283
3322
|
# * {Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult#next_token #next_token} => String
|
3284
3323
|
#
|
3324
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3325
|
+
#
|
3285
3326
|
# @example Request syntax with placeholder values
|
3286
3327
|
#
|
3287
3328
|
# resp = client.describe_maintenance_window_execution_task_invocations({
|
@@ -3349,6 +3390,8 @@ module Aws::SSM
|
|
3349
3390
|
# * {Types::DescribeMaintenanceWindowExecutionTasksResult#window_execution_task_identities #window_execution_task_identities} => Array<Types::MaintenanceWindowExecutionTaskIdentity>
|
3350
3391
|
# * {Types::DescribeMaintenanceWindowExecutionTasksResult#next_token #next_token} => String
|
3351
3392
|
#
|
3393
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3394
|
+
#
|
3352
3395
|
# @example Request syntax with placeholder values
|
3353
3396
|
#
|
3354
3397
|
# resp = client.describe_maintenance_window_execution_tasks({
|
@@ -3417,6 +3460,8 @@ module Aws::SSM
|
|
3417
3460
|
# * {Types::DescribeMaintenanceWindowExecutionsResult#window_executions #window_executions} => Array<Types::MaintenanceWindowExecution>
|
3418
3461
|
# * {Types::DescribeMaintenanceWindowExecutionsResult#next_token #next_token} => String
|
3419
3462
|
#
|
3463
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3464
|
+
#
|
3420
3465
|
# @example Request syntax with placeholder values
|
3421
3466
|
#
|
3422
3467
|
# resp = client.describe_maintenance_window_executions({
|
@@ -3483,6 +3528,8 @@ module Aws::SSM
|
|
3483
3528
|
# * {Types::DescribeMaintenanceWindowScheduleResult#scheduled_window_executions #scheduled_window_executions} => Array<Types::ScheduledWindowExecution>
|
3484
3529
|
# * {Types::DescribeMaintenanceWindowScheduleResult#next_token #next_token} => String
|
3485
3530
|
#
|
3531
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3532
|
+
#
|
3486
3533
|
# @example Request syntax with placeholder values
|
3487
3534
|
#
|
3488
3535
|
# resp = client.describe_maintenance_window_schedule({
|
@@ -3545,6 +3592,8 @@ module Aws::SSM
|
|
3545
3592
|
# * {Types::DescribeMaintenanceWindowTargetsResult#targets #targets} => Array<Types::MaintenanceWindowTarget>
|
3546
3593
|
# * {Types::DescribeMaintenanceWindowTargetsResult#next_token #next_token} => String
|
3547
3594
|
#
|
3595
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3596
|
+
#
|
3548
3597
|
# @example Request syntax with placeholder values
|
3549
3598
|
#
|
3550
3599
|
# resp = client.describe_maintenance_window_targets({
|
@@ -3607,6 +3656,8 @@ module Aws::SSM
|
|
3607
3656
|
# * {Types::DescribeMaintenanceWindowTasksResult#tasks #tasks} => Array<Types::MaintenanceWindowTask>
|
3608
3657
|
# * {Types::DescribeMaintenanceWindowTasksResult#next_token #next_token} => String
|
3609
3658
|
#
|
3659
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3660
|
+
#
|
3610
3661
|
# @example Request syntax with placeholder values
|
3611
3662
|
#
|
3612
3663
|
# resp = client.describe_maintenance_window_tasks({
|
@@ -3676,6 +3727,8 @@ module Aws::SSM
|
|
3676
3727
|
# * {Types::DescribeMaintenanceWindowsResult#window_identities #window_identities} => Array<Types::MaintenanceWindowIdentity>
|
3677
3728
|
# * {Types::DescribeMaintenanceWindowsResult#next_token #next_token} => String
|
3678
3729
|
#
|
3730
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3731
|
+
#
|
3679
3732
|
# @example Request syntax with placeholder values
|
3680
3733
|
#
|
3681
3734
|
# resp = client.describe_maintenance_windows({
|
@@ -3739,6 +3792,8 @@ module Aws::SSM
|
|
3739
3792
|
# * {Types::DescribeMaintenanceWindowsForTargetResult#window_identities #window_identities} => Array<Types::MaintenanceWindowIdentityForTarget>
|
3740
3793
|
# * {Types::DescribeMaintenanceWindowsForTargetResult#next_token #next_token} => String
|
3741
3794
|
#
|
3795
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3796
|
+
#
|
3742
3797
|
# @example Request syntax with placeholder values
|
3743
3798
|
#
|
3744
3799
|
# resp = client.describe_maintenance_windows_for_target({
|
@@ -3858,6 +3913,8 @@ module Aws::SSM
|
|
3858
3913
|
# * {Types::DescribeOpsItemsResponse#next_token #next_token} => String
|
3859
3914
|
# * {Types::DescribeOpsItemsResponse#ops_item_summaries #ops_item_summaries} => Array<Types::OpsItemSummary>
|
3860
3915
|
#
|
3916
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3917
|
+
#
|
3861
3918
|
# @example Request syntax with placeholder values
|
3862
3919
|
#
|
3863
3920
|
# resp = client.describe_ops_items({
|
@@ -4005,6 +4062,8 @@ module Aws::SSM
|
|
4005
4062
|
# * {Types::DescribePatchBaselinesResult#baseline_identities #baseline_identities} => Array<Types::PatchBaselineIdentity>
|
4006
4063
|
# * {Types::DescribePatchBaselinesResult#next_token #next_token} => String
|
4007
4064
|
#
|
4065
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4066
|
+
#
|
4008
4067
|
# @example Request syntax with placeholder values
|
4009
4068
|
#
|
4010
4069
|
# resp = client.describe_patch_baselines({
|
@@ -4091,6 +4150,22 @@ module Aws::SSM
|
|
4091
4150
|
# One or more filters. Use a filter to return a more specific list of
|
4092
4151
|
# results.
|
4093
4152
|
#
|
4153
|
+
# For `DescribePatchGroups`,valid filter keys include the following:
|
4154
|
+
#
|
4155
|
+
# * `NAME_PREFIX`\: The name of the patch group. Wildcards (*) are
|
4156
|
+
# accepted.
|
4157
|
+
#
|
4158
|
+
# * `OPERATING_SYSTEM`\: The supported operating system type to return
|
4159
|
+
# results for. For valid operating system values, see
|
4160
|
+
# GetDefaultPatchBaselineRequest$OperatingSystem in
|
4161
|
+
# CreatePatchBaseline.
|
4162
|
+
#
|
4163
|
+
# Examples:
|
4164
|
+
#
|
4165
|
+
# * `--filters Key=NAME_PREFIX,Values=MyPatchGroup*`
|
4166
|
+
#
|
4167
|
+
# * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
|
4168
|
+
#
|
4094
4169
|
# @option params [String] :next_token
|
4095
4170
|
# The token for the next set of items to return. (You received this
|
4096
4171
|
# token from a previous call.)
|
@@ -4100,6 +4175,8 @@ module Aws::SSM
|
|
4100
4175
|
# * {Types::DescribePatchGroupsResult#mappings #mappings} => Array<Types::PatchGroupPatchBaselineMapping>
|
4101
4176
|
# * {Types::DescribePatchGroupsResult#next_token #next_token} => String
|
4102
4177
|
#
|
4178
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4179
|
+
#
|
4103
4180
|
# @example Request syntax with placeholder values
|
4104
4181
|
#
|
4105
4182
|
# resp = client.describe_patch_groups({
|
@@ -4143,11 +4220,6 @@ module Aws::SSM
|
|
4143
4220
|
# The following section lists the properties that can be used in filters
|
4144
4221
|
# for each major operating system type:
|
4145
4222
|
#
|
4146
|
-
# WINDOWS
|
4147
|
-
#
|
4148
|
-
# : Valid properties: PRODUCT, PRODUCT\_FAMILY, CLASSIFICATION,
|
4149
|
-
# MSRC\_SEVERITY
|
4150
|
-
#
|
4151
4223
|
# AMAZON\_LINUX
|
4152
4224
|
#
|
4153
4225
|
# : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
|
@@ -4156,10 +4228,18 @@ module Aws::SSM
|
|
4156
4228
|
#
|
4157
4229
|
# : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
|
4158
4230
|
#
|
4159
|
-
#
|
4231
|
+
# CENTOS
|
4232
|
+
#
|
4233
|
+
# : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
|
4234
|
+
#
|
4235
|
+
# DEBIAN
|
4160
4236
|
#
|
4161
4237
|
# : Valid properties: PRODUCT, PRIORITY
|
4162
4238
|
#
|
4239
|
+
# ORACLE\_LINUX
|
4240
|
+
#
|
4241
|
+
# : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
|
4242
|
+
#
|
4163
4243
|
# REDHAT\_ENTERPRISE\_LINUX
|
4164
4244
|
#
|
4165
4245
|
# : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
|
@@ -4168,9 +4248,14 @@ module Aws::SSM
|
|
4168
4248
|
#
|
4169
4249
|
# : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
|
4170
4250
|
#
|
4171
|
-
#
|
4251
|
+
# UBUNTU
|
4172
4252
|
#
|
4173
|
-
# : Valid properties: PRODUCT,
|
4253
|
+
# : Valid properties: PRODUCT, PRIORITY
|
4254
|
+
#
|
4255
|
+
# WINDOWS
|
4256
|
+
#
|
4257
|
+
# : Valid properties: PRODUCT, PRODUCT\_FAMILY, CLASSIFICATION,
|
4258
|
+
# MSRC\_SEVERITY
|
4174
4259
|
#
|
4175
4260
|
# @option params [required, String] :operating_system
|
4176
4261
|
# The operating system type for which to list patches.
|
@@ -4197,6 +4282,8 @@ module Aws::SSM
|
|
4197
4282
|
# * {Types::DescribePatchPropertiesResult#properties #properties} => Array<Hash<String,String>>
|
4198
4283
|
# * {Types::DescribePatchPropertiesResult#next_token #next_token} => String
|
4199
4284
|
#
|
4285
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4286
|
+
#
|
4200
4287
|
# @example Request syntax with placeholder values
|
4201
4288
|
#
|
4202
4289
|
# resp = client.describe_patch_properties({
|
@@ -4248,6 +4335,8 @@ module Aws::SSM
|
|
4248
4335
|
# * {Types::DescribeSessionsResponse#sessions #sessions} => Array<Types::Session>
|
4249
4336
|
# * {Types::DescribeSessionsResponse#next_token #next_token} => String
|
4250
4337
|
#
|
4338
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4339
|
+
#
|
4251
4340
|
# @example Request syntax with placeholder values
|
4252
4341
|
#
|
4253
4342
|
# resp = client.describe_sessions({
|
@@ -4410,6 +4499,12 @@ module Aws::SSM
|
|
4410
4499
|
# next time that the Change Calendar state will transition. If you do
|
4411
4500
|
# not specify a time, `GetCalendarState` assumes the current time.
|
4412
4501
|
# Change Calendar entries have two possible states: `OPEN` or `CLOSED`.
|
4502
|
+
#
|
4503
|
+
# If you specify more than one calendar in a request, the command
|
4504
|
+
# returns the status of `OPEN` only if all calendars in the request are
|
4505
|
+
# open. If one or more calendars in the request are closed, the status
|
4506
|
+
# returned is `CLOSED`.
|
4507
|
+
#
|
4413
4508
|
# For more information about Systems Manager Change Calendar, see [AWS
|
4414
4509
|
# Systems Manager Change Calendar][1] in the *AWS Systems Manager User
|
4415
4510
|
# Guide*.
|
@@ -4476,6 +4571,9 @@ module Aws::SSM
|
|
4476
4571
|
# If the document contains only one plugin, the name can be omitted and
|
4477
4572
|
# the details will be returned.
|
4478
4573
|
#
|
4574
|
+
# Plugin names are also referred to as step names in Systems Manager
|
4575
|
+
# documents.
|
4576
|
+
#
|
4479
4577
|
# @return [Types::GetCommandInvocationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4480
4578
|
#
|
4481
4579
|
# * {Types::GetCommandInvocationResult#command_id #command_id} => String
|
@@ -4525,6 +4623,11 @@ module Aws::SSM
|
|
4525
4623
|
# resp.cloud_watch_output_config.cloud_watch_log_group_name #=> String
|
4526
4624
|
# resp.cloud_watch_output_config.cloud_watch_output_enabled #=> Boolean
|
4527
4625
|
#
|
4626
|
+
#
|
4627
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
4628
|
+
#
|
4629
|
+
# * command_executed
|
4630
|
+
#
|
4528
4631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocation AWS API Documentation
|
4529
4632
|
#
|
4530
4633
|
# @overload get_command_invocation(params = {})
|
@@ -4739,6 +4842,8 @@ module Aws::SSM
|
|
4739
4842
|
# * {Types::GetInventoryResult#entities #entities} => Array<Types::InventoryResultEntity>
|
4740
4843
|
# * {Types::GetInventoryResult#next_token #next_token} => String
|
4741
4844
|
#
|
4845
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4846
|
+
#
|
4742
4847
|
# @example Request syntax with placeholder values
|
4743
4848
|
#
|
4744
4849
|
# resp = client.get_inventory({
|
@@ -4830,6 +4935,8 @@ module Aws::SSM
|
|
4830
4935
|
# * {Types::GetInventorySchemaResult#schemas #schemas} => Array<Types::InventoryItemSchema>
|
4831
4936
|
# * {Types::GetInventorySchemaResult#next_token #next_token} => String
|
4832
4937
|
#
|
4938
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4939
|
+
#
|
4833
4940
|
# @example Request syntax with placeholder values
|
4834
4941
|
#
|
4835
4942
|
# resp = client.get_inventory_schema({
|
@@ -5258,6 +5365,8 @@ module Aws::SSM
|
|
5258
5365
|
# * {Types::GetOpsSummaryResult#entities #entities} => Array<Types::OpsEntity>
|
5259
5366
|
# * {Types::GetOpsSummaryResult#next_token #next_token} => String
|
5260
5367
|
#
|
5368
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5369
|
+
#
|
5261
5370
|
# @example Request syntax with placeholder values
|
5262
5371
|
#
|
5263
5372
|
# resp = client.get_ops_summary({
|
@@ -5505,6 +5614,14 @@ module Aws::SSM
|
|
5505
5614
|
# @option params [Array<Types::ParameterStringFilter>] :parameter_filters
|
5506
5615
|
# Filters to limit the request results.
|
5507
5616
|
#
|
5617
|
+
# <note markdown="1"> For `GetParametersByPath`, the following filter `Key` names are
|
5618
|
+
# supported: `Type`, `KeyId`, `Label`, and `DataType`.
|
5619
|
+
#
|
5620
|
+
# The following `Key` values are not supported for
|
5621
|
+
# `GetParametersByPath`\: `tag`, `Name`, `Path`, and `Tier`.
|
5622
|
+
#
|
5623
|
+
# </note>
|
5624
|
+
#
|
5508
5625
|
# @option params [Boolean] :with_decryption
|
5509
5626
|
# Retrieve all parameters in a hierarchy with their value decrypted.
|
5510
5627
|
#
|
@@ -5820,6 +5937,8 @@ module Aws::SSM
|
|
5820
5937
|
# * {Types::ListAssociationVersionsResult#association_versions #association_versions} => Array<Types::AssociationVersionInfo>
|
5821
5938
|
# * {Types::ListAssociationVersionsResult#next_token #next_token} => String
|
5822
5939
|
#
|
5940
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5941
|
+
#
|
5823
5942
|
# @example Request syntax with placeholder values
|
5824
5943
|
#
|
5825
5944
|
# resp = client.list_association_versions({
|
@@ -6038,6 +6157,12 @@ module Aws::SSM
|
|
6038
6157
|
# @option params [String] :instance_id
|
6039
6158
|
# (Optional) Lists commands issued against this instance ID.
|
6040
6159
|
#
|
6160
|
+
# <note markdown="1"> You can't specify an instance ID in the same command that you specify
|
6161
|
+
# `Status` = `Pending`. This is because the command has not reached the
|
6162
|
+
# instance yet.
|
6163
|
+
#
|
6164
|
+
# </note>
|
6165
|
+
#
|
6041
6166
|
# @option params [Integer] :max_results
|
6042
6167
|
# (Optional) The maximum number of items to return for this call. The
|
6043
6168
|
# call also returns a token that you can specify in a subsequent call to
|
@@ -6152,6 +6277,8 @@ module Aws::SSM
|
|
6152
6277
|
# * {Types::ListComplianceItemsResult#compliance_items #compliance_items} => Array<Types::ComplianceItem>
|
6153
6278
|
# * {Types::ListComplianceItemsResult#next_token #next_token} => String
|
6154
6279
|
#
|
6280
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6281
|
+
#
|
6155
6282
|
# @example Request syntax with placeholder values
|
6156
6283
|
#
|
6157
6284
|
# resp = client.list_compliance_items({
|
@@ -6217,6 +6344,8 @@ module Aws::SSM
|
|
6217
6344
|
# * {Types::ListComplianceSummariesResult#compliance_summary_items #compliance_summary_items} => Array<Types::ComplianceSummaryItem>
|
6218
6345
|
# * {Types::ListComplianceSummariesResult#next_token #next_token} => String
|
6219
6346
|
#
|
6347
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6348
|
+
#
|
6220
6349
|
# @example Request syntax with placeholder values
|
6221
6350
|
#
|
6222
6351
|
# resp = client.list_compliance_summaries({
|
@@ -6280,6 +6409,8 @@ module Aws::SSM
|
|
6280
6409
|
# * {Types::ListDocumentVersionsResult#document_versions #document_versions} => Array<Types::DocumentVersionInfo>
|
6281
6410
|
# * {Types::ListDocumentVersionsResult#next_token #next_token} => String
|
6282
6411
|
#
|
6412
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6413
|
+
#
|
6283
6414
|
# @example Request syntax with placeholder values
|
6284
6415
|
#
|
6285
6416
|
# resp = client.list_document_versions({
|
@@ -6480,6 +6611,8 @@ module Aws::SSM
|
|
6480
6611
|
# * {Types::ListResourceComplianceSummariesResult#resource_compliance_summary_items #resource_compliance_summary_items} => Array<Types::ResourceComplianceSummaryItem>
|
6481
6612
|
# * {Types::ListResourceComplianceSummariesResult#next_token #next_token} => String
|
6482
6613
|
#
|
6614
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6615
|
+
#
|
6483
6616
|
# @example Request syntax with placeholder values
|
6484
6617
|
#
|
6485
6618
|
# resp = client.list_resource_compliance_summaries({
|
@@ -6563,6 +6696,8 @@ module Aws::SSM
|
|
6563
6696
|
# * {Types::ListResourceDataSyncResult#resource_data_sync_items #resource_data_sync_items} => Array<Types::ResourceDataSyncItem>
|
6564
6697
|
# * {Types::ListResourceDataSyncResult#next_token #next_token} => String
|
6565
6698
|
#
|
6699
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6700
|
+
#
|
6566
6701
|
# @example Request syntax with placeholder values
|
6567
6702
|
#
|
6568
6703
|
# resp = client.list_resource_data_sync({
|
@@ -6919,6 +7054,12 @@ module Aws::SSM
|
|
6919
7054
|
# parameters have a value limit of 4 KB. Advanced parameters have a
|
6920
7055
|
# value limit of 8 KB.
|
6921
7056
|
#
|
7057
|
+
# <note markdown="1"> Parameters can't be referenced or nested in the values of other
|
7058
|
+
# parameters. You can't include `\{\{\}\}` or
|
7059
|
+
# `\{\{ssm:parameter-name\}\}` in a parameter value.
|
7060
|
+
#
|
7061
|
+
# </note>
|
7062
|
+
#
|
6922
7063
|
# @option params [String] :type
|
6923
7064
|
# The type of parameter that you want to add to the system.
|
6924
7065
|
#
|
@@ -7699,23 +7840,37 @@ module Aws::SSM
|
|
7699
7840
|
# Runs commands on one or more managed instances.
|
7700
7841
|
#
|
7701
7842
|
# @option params [Array<String>] :instance_ids
|
7702
|
-
# The
|
7703
|
-
#
|
7704
|
-
# you can
|
7705
|
-
#
|
7706
|
-
#
|
7707
|
-
#
|
7843
|
+
# The IDs of the instances where the command should run. Specifying
|
7844
|
+
# instance IDs is most useful when you are targeting a limited number of
|
7845
|
+
# instances, though you can specify up to 50 IDs.
|
7846
|
+
#
|
7847
|
+
# To target a larger number of instances, or if you prefer not to list
|
7848
|
+
# individual instance IDs, we recommend using the `Targets` option
|
7849
|
+
# instead. Using `Targets`, which accepts tag key-value pairs to
|
7850
|
+
# identify the instances to send commands to, you can a send command to
|
7851
|
+
# tens, hundreds, or thousands of instances at once.
|
7852
|
+
#
|
7853
|
+
# For more information about how to use targets, see [Using targets and
|
7854
|
+
# rate controls to send commands to a fleet][1] in the *AWS Systems
|
7855
|
+
# Manager User Guide*.
|
7708
7856
|
#
|
7709
7857
|
#
|
7710
7858
|
#
|
7711
7859
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
7712
7860
|
#
|
7713
7861
|
# @option params [Array<Types::Target>] :targets
|
7714
|
-
#
|
7715
|
-
#
|
7716
|
-
#
|
7717
|
-
#
|
7718
|
-
#
|
7862
|
+
# An array of search criteria that targets instances using a `Key,Value`
|
7863
|
+
# combination that you specify. Specifying targets is most useful when
|
7864
|
+
# you want to send a command to a large number of instances at once.
|
7865
|
+
# Using `Targets`, which accepts tag key-value pairs to identify
|
7866
|
+
# instances, you can send a command to tens, hundreds, or thousands of
|
7867
|
+
# instances at once.
|
7868
|
+
#
|
7869
|
+
# To send a command to a smaller number of instances, you can use the
|
7870
|
+
# `InstanceIds` option instead.
|
7871
|
+
#
|
7872
|
+
# For more information about how to use targets, see [Sending commands
|
7873
|
+
# to a fleet][1] in the *AWS Systems Manager User Guide*.
|
7719
7874
|
#
|
7720
7875
|
#
|
7721
7876
|
#
|
@@ -8857,11 +9012,22 @@ module Aws::SSM
|
|
8857
9012
|
#
|
8858
9013
|
# * MaxErrors
|
8859
9014
|
#
|
8860
|
-
# If
|
8861
|
-
#
|
9015
|
+
# If the value for a parameter in `UpdateMaintenanceWindowTask` is null,
|
9016
|
+
# then the corresponding field is not modified. If you set `Replace` to
|
9017
|
+
# true, then all fields required by the
|
8862
9018
|
# RegisterTaskWithMaintenanceWindow action are required for this
|
8863
9019
|
# request. Optional fields that aren't specified are set to null.
|
8864
9020
|
#
|
9021
|
+
# When you update a maintenance window task that has options specified
|
9022
|
+
# in `TaskInvocationParameters`, you must provide again all the
|
9023
|
+
# `TaskInvocationParameters` values that you want to retain. The values
|
9024
|
+
# you do not specify again are removed. For example, suppose that when
|
9025
|
+
# you registered a Run Command task, you specified
|
9026
|
+
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
9027
|
+
# and `OutputS3BucketName`. If you update the maintenance window task
|
9028
|
+
# and specify only a different `OutputS3BucketName` value, the values
|
9029
|
+
# for `Comment` and `NotificationConfig` are removed.
|
9030
|
+
#
|
8865
9031
|
# @option params [required, String] :window_id
|
8866
9032
|
# The maintenance window ID that contains the task to modify.
|
8867
9033
|
#
|
@@ -8919,6 +9085,16 @@ module Aws::SSM
|
|
8919
9085
|
# only the fields that match the task type. All other fields should be
|
8920
9086
|
# empty.
|
8921
9087
|
#
|
9088
|
+
# When you update a maintenance window task that has options specified
|
9089
|
+
# in `TaskInvocationParameters`, you must provide again all the
|
9090
|
+
# `TaskInvocationParameters` values that you want to retain. The values
|
9091
|
+
# you do not specify again are removed. For example, suppose that when
|
9092
|
+
# you registered a Run Command task, you specified
|
9093
|
+
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
9094
|
+
# and `OutputS3BucketName`. If you update the maintenance window task
|
9095
|
+
# and specify only a different `OutputS3BucketName` value, the values
|
9096
|
+
# for `Comment` and `NotificationConfig` are removed.
|
9097
|
+
#
|
8922
9098
|
# @option params [Integer] :priority
|
8923
9099
|
# The new task priority to specify. The lower the number, the higher the
|
8924
9100
|
# priority. Tasks that have the same priority are scheduled in parallel.
|
@@ -8953,8 +9129,8 @@ module Aws::SSM
|
|
8953
9129
|
#
|
8954
9130
|
# @option params [Boolean] :replace
|
8955
9131
|
# If True, then all fields that are required by the
|
8956
|
-
#
|
8957
|
-
# request. Optional fields that are not specified are set to null.
|
9132
|
+
# RegisterTaskWithMaintenanceWindow action are also required for this
|
9133
|
+
# API request. Optional fields that are not specified are set to null.
|
8958
9134
|
#
|
8959
9135
|
# @return [Types::UpdateMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8960
9136
|
#
|
@@ -9579,14 +9755,127 @@ module Aws::SSM
|
|
9579
9755
|
params: params,
|
9580
9756
|
config: config)
|
9581
9757
|
context[:gem_name] = 'aws-sdk-ssm'
|
9582
|
-
context[:gem_version] = '1.
|
9758
|
+
context[:gem_version] = '1.90.0'
|
9583
9759
|
Seahorse::Client::Request.new(handlers, context)
|
9584
9760
|
end
|
9585
9761
|
|
9762
|
+
# Polls an API operation until a resource enters a desired state.
|
9763
|
+
#
|
9764
|
+
# ## Basic Usage
|
9765
|
+
#
|
9766
|
+
# A waiter will call an API operation until:
|
9767
|
+
#
|
9768
|
+
# * It is successful
|
9769
|
+
# * It enters a terminal state
|
9770
|
+
# * It makes the maximum number of attempts
|
9771
|
+
#
|
9772
|
+
# In between attempts, the waiter will sleep.
|
9773
|
+
#
|
9774
|
+
# # polls in a loop, sleeping between attempts
|
9775
|
+
# client.wait_until(waiter_name, params)
|
9776
|
+
#
|
9777
|
+
# ## Configuration
|
9778
|
+
#
|
9779
|
+
# You can configure the maximum number of polling attempts, and the
|
9780
|
+
# delay (in seconds) between each polling attempt. You can pass
|
9781
|
+
# configuration as the final arguments hash.
|
9782
|
+
#
|
9783
|
+
# # poll for ~25 seconds
|
9784
|
+
# client.wait_until(waiter_name, params, {
|
9785
|
+
# max_attempts: 5,
|
9786
|
+
# delay: 5,
|
9787
|
+
# })
|
9788
|
+
#
|
9789
|
+
# ## Callbacks
|
9790
|
+
#
|
9791
|
+
# You can be notified before each polling attempt and before each
|
9792
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
9793
|
+
# it will terminate the waiter.
|
9794
|
+
#
|
9795
|
+
# started_at = Time.now
|
9796
|
+
# client.wait_until(waiter_name, params, {
|
9797
|
+
#
|
9798
|
+
# # disable max attempts
|
9799
|
+
# max_attempts: nil,
|
9800
|
+
#
|
9801
|
+
# # poll for 1 hour, instead of a number of attempts
|
9802
|
+
# before_wait: -> (attempts, response) do
|
9803
|
+
# throw :failure if Time.now - started_at > 3600
|
9804
|
+
# end
|
9805
|
+
# })
|
9806
|
+
#
|
9807
|
+
# ## Handling Errors
|
9808
|
+
#
|
9809
|
+
# When a waiter is unsuccessful, it will raise an error.
|
9810
|
+
# All of the failure errors extend from
|
9811
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
9812
|
+
#
|
9813
|
+
# begin
|
9814
|
+
# client.wait_until(...)
|
9815
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
9816
|
+
# # resource did not enter the desired state in time
|
9817
|
+
# end
|
9818
|
+
#
|
9819
|
+
# ## Valid Waiters
|
9820
|
+
#
|
9821
|
+
# The following table lists the valid waiter names, the operations they call,
|
9822
|
+
# and the default `:delay` and `:max_attempts` values.
|
9823
|
+
#
|
9824
|
+
# | waiter_name | params | :delay | :max_attempts |
|
9825
|
+
# | ---------------- | ------------------------------- | -------- | ------------- |
|
9826
|
+
# | command_executed | {Client#get_command_invocation} | 5 | 20 |
|
9827
|
+
#
|
9828
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
9829
|
+
# because the waiter has entered a state that it will not transition
|
9830
|
+
# out of, preventing success.
|
9831
|
+
#
|
9832
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
9833
|
+
# maximum number of attempts have been made, and the waiter is not
|
9834
|
+
# yet successful.
|
9835
|
+
#
|
9836
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
9837
|
+
# while polling for a resource that is not expected.
|
9838
|
+
#
|
9839
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
9840
|
+
# for an unknown state.
|
9841
|
+
#
|
9842
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
9843
|
+
# @param [Symbol] waiter_name
|
9844
|
+
# @param [Hash] params ({})
|
9845
|
+
# @param [Hash] options ({})
|
9846
|
+
# @option options [Integer] :max_attempts
|
9847
|
+
# @option options [Integer] :delay
|
9848
|
+
# @option options [Proc] :before_attempt
|
9849
|
+
# @option options [Proc] :before_wait
|
9850
|
+
def wait_until(waiter_name, params = {}, options = {})
|
9851
|
+
w = waiter(waiter_name, options)
|
9852
|
+
yield(w.waiter) if block_given? # deprecated
|
9853
|
+
w.wait(params)
|
9854
|
+
end
|
9855
|
+
|
9586
9856
|
# @api private
|
9587
9857
|
# @deprecated
|
9588
9858
|
def waiter_names
|
9589
|
-
|
9859
|
+
waiters.keys
|
9860
|
+
end
|
9861
|
+
|
9862
|
+
private
|
9863
|
+
|
9864
|
+
# @param [Symbol] waiter_name
|
9865
|
+
# @param [Hash] options ({})
|
9866
|
+
def waiter(waiter_name, options = {})
|
9867
|
+
waiter_class = waiters[waiter_name]
|
9868
|
+
if waiter_class
|
9869
|
+
waiter_class.new(options.merge(client: self))
|
9870
|
+
else
|
9871
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
9872
|
+
end
|
9873
|
+
end
|
9874
|
+
|
9875
|
+
def waiters
|
9876
|
+
{
|
9877
|
+
command_executed: Waiters::CommandExecuted
|
9878
|
+
}
|
9590
9879
|
end
|
9591
9880
|
|
9592
9881
|
class << self
|