aws-sdk-ssm 1.175.0 → 1.182.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/CHANGELOG.md +35 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm/client.rb +245 -44
- data/lib/aws-sdk-ssm/client_api.rb +14 -0
- data/lib/aws-sdk-ssm/endpoints.rb +140 -560
- data/lib/aws-sdk-ssm/plugins/endpoints.rb +18 -6
- data/lib/aws-sdk-ssm/types.rb +188 -102
- data/lib/aws-sdk-ssm.rb +16 -12
- data/sig/client.rbs +59 -6
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +8 -0
- metadata +4 -4
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -32,11 +32,10 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
|
32
32
|
require 'aws-sdk-core/plugins/request_compression.rb'
|
33
33
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
34
34
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry.rb'
|
35
36
|
require 'aws-sdk-core/plugins/sign.rb'
|
36
37
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
37
38
|
|
38
|
-
Aws::Plugins::GlobalConfiguration.add_identifier(:ssm)
|
39
|
-
|
40
39
|
module Aws::SSM
|
41
40
|
# An API client for SSM. To construct a client, you need to configure a `:region` and `:credentials`.
|
42
41
|
#
|
@@ -83,6 +82,7 @@ module Aws::SSM
|
|
83
82
|
add_plugin(Aws::Plugins::RequestCompression)
|
84
83
|
add_plugin(Aws::Plugins::DefaultsMode)
|
85
84
|
add_plugin(Aws::Plugins::RecursionDetection)
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
86
86
|
add_plugin(Aws::Plugins::Sign)
|
87
87
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
88
88
|
add_plugin(Aws::SSM::Plugins::Endpoints)
|
@@ -128,13 +128,15 @@ module Aws::SSM
|
|
128
128
|
# locations will be searched for credentials:
|
129
129
|
#
|
130
130
|
# * `Aws.config[:credentials]`
|
131
|
-
# * The `:access_key_id`, `:secret_access_key`,
|
132
|
-
#
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
|
+
# `:account_id` options.
|
133
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
134
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
133
135
|
# * `~/.aws/credentials`
|
134
136
|
# * `~/.aws/config`
|
135
137
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
136
138
|
# are very aggressive. Construct and pass an instance of
|
137
|
-
# `Aws::
|
139
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
138
140
|
# enable retries and extended timeouts. Instance profile credential
|
139
141
|
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
140
142
|
# to true.
|
@@ -153,6 +155,8 @@ module Aws::SSM
|
|
153
155
|
#
|
154
156
|
# @option options [String] :access_key_id
|
155
157
|
#
|
158
|
+
# @option options [String] :account_id
|
159
|
+
#
|
156
160
|
# @option options [Boolean] :active_endpoint_cache (false)
|
157
161
|
# When set to `true`, a thread polling for endpoints will be running in
|
158
162
|
# the background every 60 secs (default). Defaults to `false`.
|
@@ -337,6 +341,16 @@ module Aws::SSM
|
|
337
341
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
338
342
|
# requests are made, and retries are disabled.
|
339
343
|
#
|
344
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
345
|
+
# Allows you to provide a telemetry provider, which is used to
|
346
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
347
|
+
# will not record or emit any telemetry data. The SDK supports the
|
348
|
+
# following telemetry providers:
|
349
|
+
#
|
350
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
351
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
352
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
353
|
+
#
|
340
354
|
# @option options [Aws::TokenProvider] :token_provider
|
341
355
|
# A Bearer Token Provider. This can be an instance of any one of the
|
342
356
|
# following classes:
|
@@ -364,7 +378,9 @@ module Aws::SSM
|
|
364
378
|
# sending the request.
|
365
379
|
#
|
366
380
|
# @option options [Aws::SSM::EndpointProvider] :endpoint_provider
|
367
|
-
# The endpoint provider used to resolve endpoints. Any object that responds to
|
381
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
382
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
383
|
+
# `Aws::SSM::EndpointParameters`.
|
368
384
|
#
|
369
385
|
# @option options [Float] :http_continue_timeout (1)
|
370
386
|
# The number of seconds to wait for a 100-continue response before sending the
|
@@ -420,6 +436,12 @@ module Aws::SSM
|
|
420
436
|
# @option options [String] :ssl_ca_store
|
421
437
|
# Sets the X509::Store to verify peer certificate.
|
422
438
|
#
|
439
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
440
|
+
# Sets a client certificate when creating http connections.
|
441
|
+
#
|
442
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
443
|
+
# Sets a client key when creating http connections.
|
444
|
+
#
|
423
445
|
# @option options [Float] :ssl_timeout
|
424
446
|
# Sets the SSL timeout in seconds
|
425
447
|
#
|
@@ -660,9 +682,9 @@ module Aws::SSM
|
|
660
682
|
# capabilities. You use the activation code and ID when installing SSM
|
661
683
|
# Agent on machines in your hybrid environment. For more information
|
662
684
|
# about requirements for managing on-premises machines using Systems
|
663
|
-
# Manager, see [
|
664
|
-
#
|
665
|
-
#
|
685
|
+
# Manager, see [Using Amazon Web Services Systems Manager in hybrid and
|
686
|
+
# multicloud environments][1] in the *Amazon Web Services Systems
|
687
|
+
# Manager User Guide*.
|
666
688
|
#
|
667
689
|
# <note markdown="1"> Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and
|
668
690
|
# on-premises servers and VMs that are configured for Systems Manager
|
@@ -672,7 +694,7 @@ module Aws::SSM
|
|
672
694
|
#
|
673
695
|
#
|
674
696
|
#
|
675
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-
|
697
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html
|
676
698
|
#
|
677
699
|
# @option params [String] :description
|
678
700
|
# A user-defined description of the resource that you want to register
|
@@ -692,9 +714,9 @@ module Aws::SSM
|
|
692
714
|
# want to assign to the managed node. This IAM role must provide
|
693
715
|
# AssumeRole permissions for the Amazon Web Services Systems Manager
|
694
716
|
# service principal `ssm.amazonaws.com`. For more information, see
|
695
|
-
# [Create
|
696
|
-
#
|
697
|
-
# Guide*.
|
717
|
+
# [Create the IAM service role required for Systems Manager in a hybrid
|
718
|
+
# and multicloud environments][1] in the *Amazon Web Services Systems
|
719
|
+
# Manager User Guide*.
|
698
720
|
#
|
699
721
|
# <note markdown="1"> You can't specify an IAM service-linked role for this parameter. You
|
700
722
|
# must create a unique role.
|
@@ -703,7 +725,7 @@ module Aws::SSM
|
|
703
725
|
#
|
704
726
|
#
|
705
727
|
#
|
706
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
728
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-service-role.html
|
707
729
|
#
|
708
730
|
# @option params [Integer] :registration_limit
|
709
731
|
# Specify the maximum number of managed nodes you want to register. The
|
@@ -711,7 +733,7 @@ module Aws::SSM
|
|
711
733
|
#
|
712
734
|
# @option params [Time,DateTime,Date,Integer,String] :expiration_date
|
713
735
|
# The date by which this activation request should expire, in timestamp
|
714
|
-
# format, such as "
|
736
|
+
# format, such as "2024-07-07T00:00:00". You can specify a date up to
|
715
737
|
# 30 days in advance. If you don't provide an expiration date, the
|
716
738
|
# activation code expires in 24 hours.
|
717
739
|
#
|
@@ -858,9 +880,10 @@ module Aws::SSM
|
|
858
880
|
# Amazon Web Services account, or individual managed node IDs. You can
|
859
881
|
# target all managed nodes in an Amazon Web Services account by
|
860
882
|
# specifying the `InstanceIds` key with a value of `*`. For more
|
861
|
-
# information about choosing targets for an association, see
|
862
|
-
# targets and rate controls in State Manager
|
863
|
-
# *Amazon Web Services Systems Manager User
|
883
|
+
# information about choosing targets for an association, see
|
884
|
+
# [Understanding targets and rate controls in State Manager
|
885
|
+
# associations][1] in the *Amazon Web Services Systems Manager User
|
886
|
+
# Guide*.
|
864
887
|
#
|
865
888
|
#
|
866
889
|
#
|
@@ -1054,6 +1077,16 @@ module Aws::SSM
|
|
1054
1077
|
# },
|
1055
1078
|
# ],
|
1056
1079
|
# },
|
1080
|
+
# include_child_organization_units: false,
|
1081
|
+
# exclude_accounts: ["ExcludeAccount"],
|
1082
|
+
# targets: [
|
1083
|
+
# {
|
1084
|
+
# key: "TargetKey",
|
1085
|
+
# values: ["TargetValue"],
|
1086
|
+
# },
|
1087
|
+
# ],
|
1088
|
+
# targets_max_concurrency: "MaxConcurrency",
|
1089
|
+
# targets_max_errors: "MaxErrors",
|
1057
1090
|
# },
|
1058
1091
|
# ],
|
1059
1092
|
# schedule_offset: 1,
|
@@ -1129,6 +1162,15 @@ module Aws::SSM
|
|
1129
1162
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
1130
1163
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
1131
1164
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
1165
|
+
# resp.association_description.target_locations[0].include_child_organization_units #=> Boolean
|
1166
|
+
# resp.association_description.target_locations[0].exclude_accounts #=> Array
|
1167
|
+
# resp.association_description.target_locations[0].exclude_accounts[0] #=> String
|
1168
|
+
# resp.association_description.target_locations[0].targets #=> Array
|
1169
|
+
# resp.association_description.target_locations[0].targets[0].key #=> String
|
1170
|
+
# resp.association_description.target_locations[0].targets[0].values #=> Array
|
1171
|
+
# resp.association_description.target_locations[0].targets[0].values[0] #=> String
|
1172
|
+
# resp.association_description.target_locations[0].targets_max_concurrency #=> String
|
1173
|
+
# resp.association_description.target_locations[0].targets_max_errors #=> String
|
1132
1174
|
# resp.association_description.schedule_offset #=> Integer
|
1133
1175
|
# resp.association_description.duration #=> Integer
|
1134
1176
|
# resp.association_description.target_maps #=> Array
|
@@ -1219,6 +1261,16 @@ module Aws::SSM
|
|
1219
1261
|
# },
|
1220
1262
|
# ],
|
1221
1263
|
# },
|
1264
|
+
# include_child_organization_units: false,
|
1265
|
+
# exclude_accounts: ["ExcludeAccount"],
|
1266
|
+
# targets: [
|
1267
|
+
# {
|
1268
|
+
# key: "TargetKey",
|
1269
|
+
# values: ["TargetValue"],
|
1270
|
+
# },
|
1271
|
+
# ],
|
1272
|
+
# targets_max_concurrency: "MaxConcurrency",
|
1273
|
+
# targets_max_errors: "MaxErrors",
|
1222
1274
|
# },
|
1223
1275
|
# ],
|
1224
1276
|
# schedule_offset: 1,
|
@@ -1291,6 +1343,15 @@ module Aws::SSM
|
|
1291
1343
|
# resp.successful[0].target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
1292
1344
|
# resp.successful[0].target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
1293
1345
|
# resp.successful[0].target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
1346
|
+
# resp.successful[0].target_locations[0].include_child_organization_units #=> Boolean
|
1347
|
+
# resp.successful[0].target_locations[0].exclude_accounts #=> Array
|
1348
|
+
# resp.successful[0].target_locations[0].exclude_accounts[0] #=> String
|
1349
|
+
# resp.successful[0].target_locations[0].targets #=> Array
|
1350
|
+
# resp.successful[0].target_locations[0].targets[0].key #=> String
|
1351
|
+
# resp.successful[0].target_locations[0].targets[0].values #=> Array
|
1352
|
+
# resp.successful[0].target_locations[0].targets[0].values[0] #=> String
|
1353
|
+
# resp.successful[0].target_locations[0].targets_max_concurrency #=> String
|
1354
|
+
# resp.successful[0].target_locations[0].targets_max_errors #=> String
|
1294
1355
|
# resp.successful[0].schedule_offset #=> Integer
|
1295
1356
|
# resp.successful[0].duration #=> Integer
|
1296
1357
|
# resp.successful[0].target_maps #=> Array
|
@@ -1338,6 +1399,15 @@ module Aws::SSM
|
|
1338
1399
|
# resp.failed[0].entry.target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
1339
1400
|
# resp.failed[0].entry.target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
1340
1401
|
# resp.failed[0].entry.target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
1402
|
+
# resp.failed[0].entry.target_locations[0].include_child_organization_units #=> Boolean
|
1403
|
+
# resp.failed[0].entry.target_locations[0].exclude_accounts #=> Array
|
1404
|
+
# resp.failed[0].entry.target_locations[0].exclude_accounts[0] #=> String
|
1405
|
+
# resp.failed[0].entry.target_locations[0].targets #=> Array
|
1406
|
+
# resp.failed[0].entry.target_locations[0].targets[0].key #=> String
|
1407
|
+
# resp.failed[0].entry.target_locations[0].targets[0].values #=> Array
|
1408
|
+
# resp.failed[0].entry.target_locations[0].targets[0].values[0] #=> String
|
1409
|
+
# resp.failed[0].entry.target_locations[0].targets_max_concurrency #=> String
|
1410
|
+
# resp.failed[0].entry.target_locations[0].targets_max_errors #=> String
|
1341
1411
|
# resp.failed[0].entry.schedule_offset #=> Integer
|
1342
1412
|
# resp.failed[0].entry.duration #=> Integer
|
1343
1413
|
# resp.failed[0].entry.target_maps #=> Array
|
@@ -1368,7 +1438,7 @@ module Aws::SSM
|
|
1368
1438
|
#
|
1369
1439
|
#
|
1370
1440
|
#
|
1371
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
1441
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/documents.html
|
1372
1442
|
#
|
1373
1443
|
# @option params [required, String] :content
|
1374
1444
|
# The content for the new SSM document in JSON or YAML format. The
|
@@ -2003,7 +2073,7 @@ module Aws::SSM
|
|
2003
2073
|
# A list of explicitly approved patches for the baseline.
|
2004
2074
|
#
|
2005
2075
|
# For information about accepted formats for lists of approved patches
|
2006
|
-
# and rejected patches, see [
|
2076
|
+
# and rejected patches, see [Package name formats for approved and
|
2007
2077
|
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
2008
2078
|
# User Guide*.
|
2009
2079
|
#
|
@@ -2025,7 +2095,7 @@ module Aws::SSM
|
|
2025
2095
|
# A list of explicitly rejected patches for the baseline.
|
2026
2096
|
#
|
2027
2097
|
# For information about accepted formats for lists of approved patches
|
2028
|
-
# and rejected patches, see [
|
2098
|
+
# and rejected patches, see [Package name formats for approved and
|
2029
2099
|
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
2030
2100
|
# User Guide*.
|
2031
2101
|
#
|
@@ -2168,7 +2238,7 @@ module Aws::SSM
|
|
2168
2238
|
# You can configure Systems Manager Inventory to use the
|
2169
2239
|
# `SyncToDestination` type to synchronize Inventory data from multiple
|
2170
2240
|
# Amazon Web Services Regions to a single Amazon Simple Storage Service
|
2171
|
-
# (Amazon S3) bucket. For more information, see [
|
2241
|
+
# (Amazon S3) bucket. For more information, see [Creatinga a resource
|
2172
2242
|
# data sync for Inventory][1] in the *Amazon Web Services Systems
|
2173
2243
|
# Manager User Guide*.
|
2174
2244
|
#
|
@@ -2196,7 +2266,7 @@ module Aws::SSM
|
|
2196
2266
|
#
|
2197
2267
|
#
|
2198
2268
|
#
|
2199
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
2269
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-create-resource-data-sync.html
|
2200
2270
|
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html
|
2201
2271
|
#
|
2202
2272
|
# @option params [required, String] :sync_name
|
@@ -3004,6 +3074,15 @@ module Aws::SSM
|
|
3004
3074
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
3005
3075
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
3006
3076
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
3077
|
+
# resp.association_description.target_locations[0].include_child_organization_units #=> Boolean
|
3078
|
+
# resp.association_description.target_locations[0].exclude_accounts #=> Array
|
3079
|
+
# resp.association_description.target_locations[0].exclude_accounts[0] #=> String
|
3080
|
+
# resp.association_description.target_locations[0].targets #=> Array
|
3081
|
+
# resp.association_description.target_locations[0].targets[0].key #=> String
|
3082
|
+
# resp.association_description.target_locations[0].targets[0].values #=> Array
|
3083
|
+
# resp.association_description.target_locations[0].targets[0].values[0] #=> String
|
3084
|
+
# resp.association_description.target_locations[0].targets_max_concurrency #=> String
|
3085
|
+
# resp.association_description.target_locations[0].targets_max_errors #=> String
|
3007
3086
|
# resp.association_description.schedule_offset #=> Integer
|
3008
3087
|
# resp.association_description.duration #=> Integer
|
3009
3088
|
# resp.association_description.target_maps #=> Array
|
@@ -3252,6 +3331,7 @@ module Aws::SSM
|
|
3252
3331
|
# resp.automation_execution_metadata_list[0].triggered_alarms #=> Array
|
3253
3332
|
# resp.automation_execution_metadata_list[0].triggered_alarms[0].name #=> String
|
3254
3333
|
# resp.automation_execution_metadata_list[0].triggered_alarms[0].state #=> String, one of "UNKNOWN", "ALARM"
|
3334
|
+
# resp.automation_execution_metadata_list[0].target_locations_url #=> String
|
3255
3335
|
# resp.automation_execution_metadata_list[0].automation_subtype #=> String, one of "ChangeRequest"
|
3256
3336
|
# resp.automation_execution_metadata_list[0].scheduled_time #=> Time
|
3257
3337
|
# resp.automation_execution_metadata_list[0].runbooks #=> Array
|
@@ -3282,6 +3362,15 @@ module Aws::SSM
|
|
3282
3362
|
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
3283
3363
|
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
3284
3364
|
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
3365
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].include_child_organization_units #=> Boolean
|
3366
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].exclude_accounts #=> Array
|
3367
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].exclude_accounts[0] #=> String
|
3368
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].targets #=> Array
|
3369
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].targets[0].key #=> String
|
3370
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].targets[0].values #=> Array
|
3371
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].targets[0].values[0] #=> String
|
3372
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].targets_max_concurrency #=> String
|
3373
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].targets_max_errors #=> String
|
3285
3374
|
# resp.automation_execution_metadata_list[0].ops_item_id #=> String
|
3286
3375
|
# resp.automation_execution_metadata_list[0].association_id #=> String
|
3287
3376
|
# resp.automation_execution_metadata_list[0].change_request_name #=> String
|
@@ -3389,6 +3478,15 @@ module Aws::SSM
|
|
3389
3478
|
# resp.step_executions[0].target_location.target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
3390
3479
|
# resp.step_executions[0].target_location.target_location_alarm_configuration.alarms #=> Array
|
3391
3480
|
# resp.step_executions[0].target_location.target_location_alarm_configuration.alarms[0].name #=> String
|
3481
|
+
# resp.step_executions[0].target_location.include_child_organization_units #=> Boolean
|
3482
|
+
# resp.step_executions[0].target_location.exclude_accounts #=> Array
|
3483
|
+
# resp.step_executions[0].target_location.exclude_accounts[0] #=> String
|
3484
|
+
# resp.step_executions[0].target_location.targets #=> Array
|
3485
|
+
# resp.step_executions[0].target_location.targets[0].key #=> String
|
3486
|
+
# resp.step_executions[0].target_location.targets[0].values #=> Array
|
3487
|
+
# resp.step_executions[0].target_location.targets[0].values[0] #=> String
|
3488
|
+
# resp.step_executions[0].target_location.targets_max_concurrency #=> String
|
3489
|
+
# resp.step_executions[0].target_location.targets_max_errors #=> String
|
3392
3490
|
# resp.step_executions[0].triggered_alarms #=> Array
|
3393
3491
|
# resp.step_executions[0].triggered_alarms[0].name #=> String
|
3394
3492
|
# resp.step_executions[0].triggered_alarms[0].state #=> String, one of "UNKNOWN", "ALARM"
|
@@ -4173,9 +4271,8 @@ module Aws::SSM
|
|
4173
4271
|
# Sample values: `Installed` \| `InstalledOther` \|
|
4174
4272
|
# `InstalledPendingReboot`
|
4175
4273
|
#
|
4176
|
-
# For lists of all `State` values, see [
|
4177
|
-
#
|
4178
|
-
# Guide*.
|
4274
|
+
# For lists of all `State` values, see [Patch compliance state
|
4275
|
+
# values][1] in the *Amazon Web Services Systems Manager User Guide*.
|
4179
4276
|
#
|
4180
4277
|
#
|
4181
4278
|
#
|
@@ -4533,7 +4630,7 @@ module Aws::SSM
|
|
4533
4630
|
#
|
4534
4631
|
# * Values. An array of strings, each between 1 and 256 characters.
|
4535
4632
|
# Supported values are date/time strings in a valid ISO 8601 date/time
|
4536
|
-
# format, such as `
|
4633
|
+
# format, such as `2024-11-04T05:00:00Z`.
|
4537
4634
|
#
|
4538
4635
|
# @option params [Integer] :max_results
|
4539
4636
|
# The maximum number of items to return for this call. The call also
|
@@ -5641,6 +5738,15 @@ module Aws::SSM
|
|
5641
5738
|
# resp.automation_execution.step_executions[0].target_location.target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
5642
5739
|
# resp.automation_execution.step_executions[0].target_location.target_location_alarm_configuration.alarms #=> Array
|
5643
5740
|
# resp.automation_execution.step_executions[0].target_location.target_location_alarm_configuration.alarms[0].name #=> String
|
5741
|
+
# resp.automation_execution.step_executions[0].target_location.include_child_organization_units #=> Boolean
|
5742
|
+
# resp.automation_execution.step_executions[0].target_location.exclude_accounts #=> Array
|
5743
|
+
# resp.automation_execution.step_executions[0].target_location.exclude_accounts[0] #=> String
|
5744
|
+
# resp.automation_execution.step_executions[0].target_location.targets #=> Array
|
5745
|
+
# resp.automation_execution.step_executions[0].target_location.targets[0].key #=> String
|
5746
|
+
# resp.automation_execution.step_executions[0].target_location.targets[0].values #=> Array
|
5747
|
+
# resp.automation_execution.step_executions[0].target_location.targets[0].values[0] #=> String
|
5748
|
+
# resp.automation_execution.step_executions[0].target_location.targets_max_concurrency #=> String
|
5749
|
+
# resp.automation_execution.step_executions[0].target_location.targets_max_errors #=> String
|
5644
5750
|
# resp.automation_execution.step_executions[0].triggered_alarms #=> Array
|
5645
5751
|
# resp.automation_execution.step_executions[0].triggered_alarms[0].name #=> String
|
5646
5752
|
# resp.automation_execution.step_executions[0].triggered_alarms[0].state #=> String, one of "UNKNOWN", "ALARM"
|
@@ -5688,6 +5794,15 @@ module Aws::SSM
|
|
5688
5794
|
# resp.automation_execution.target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
5689
5795
|
# resp.automation_execution.target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
5690
5796
|
# resp.automation_execution.target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
5797
|
+
# resp.automation_execution.target_locations[0].include_child_organization_units #=> Boolean
|
5798
|
+
# resp.automation_execution.target_locations[0].exclude_accounts #=> Array
|
5799
|
+
# resp.automation_execution.target_locations[0].exclude_accounts[0] #=> String
|
5800
|
+
# resp.automation_execution.target_locations[0].targets #=> Array
|
5801
|
+
# resp.automation_execution.target_locations[0].targets[0].key #=> String
|
5802
|
+
# resp.automation_execution.target_locations[0].targets[0].values #=> Array
|
5803
|
+
# resp.automation_execution.target_locations[0].targets[0].values[0] #=> String
|
5804
|
+
# resp.automation_execution.target_locations[0].targets_max_concurrency #=> String
|
5805
|
+
# resp.automation_execution.target_locations[0].targets_max_errors #=> String
|
5691
5806
|
# resp.automation_execution.progress_counters.total_steps #=> Integer
|
5692
5807
|
# resp.automation_execution.progress_counters.success_steps #=> Integer
|
5693
5808
|
# resp.automation_execution.progress_counters.failed_steps #=> Integer
|
@@ -5699,6 +5814,7 @@ module Aws::SSM
|
|
5699
5814
|
# resp.automation_execution.triggered_alarms #=> Array
|
5700
5815
|
# resp.automation_execution.triggered_alarms[0].name #=> String
|
5701
5816
|
# resp.automation_execution.triggered_alarms[0].state #=> String, one of "UNKNOWN", "ALARM"
|
5817
|
+
# resp.automation_execution.target_locations_url #=> String
|
5702
5818
|
# resp.automation_execution.automation_subtype #=> String, one of "ChangeRequest"
|
5703
5819
|
# resp.automation_execution.scheduled_time #=> Time
|
5704
5820
|
# resp.automation_execution.runbooks #=> Array
|
@@ -5729,6 +5845,15 @@ module Aws::SSM
|
|
5729
5845
|
# resp.automation_execution.runbooks[0].target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
5730
5846
|
# resp.automation_execution.runbooks[0].target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
5731
5847
|
# resp.automation_execution.runbooks[0].target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
5848
|
+
# resp.automation_execution.runbooks[0].target_locations[0].include_child_organization_units #=> Boolean
|
5849
|
+
# resp.automation_execution.runbooks[0].target_locations[0].exclude_accounts #=> Array
|
5850
|
+
# resp.automation_execution.runbooks[0].target_locations[0].exclude_accounts[0] #=> String
|
5851
|
+
# resp.automation_execution.runbooks[0].target_locations[0].targets #=> Array
|
5852
|
+
# resp.automation_execution.runbooks[0].target_locations[0].targets[0].key #=> String
|
5853
|
+
# resp.automation_execution.runbooks[0].target_locations[0].targets[0].values #=> Array
|
5854
|
+
# resp.automation_execution.runbooks[0].target_locations[0].targets[0].values[0] #=> String
|
5855
|
+
# resp.automation_execution.runbooks[0].target_locations[0].targets_max_concurrency #=> String
|
5856
|
+
# resp.automation_execution.runbooks[0].target_locations[0].targets_max_errors #=> String
|
5732
5857
|
# resp.automation_execution.ops_item_id #=> String
|
5733
5858
|
# resp.automation_execution.association_id #=> String
|
5734
5859
|
# resp.automation_execution.change_request_name #=> String
|
@@ -6876,7 +7001,7 @@ module Aws::SSM
|
|
6876
7001
|
#
|
6877
7002
|
#
|
6878
7003
|
#
|
6879
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
7004
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html
|
6880
7005
|
#
|
6881
7006
|
# @option params [Boolean] :with_decryption
|
6882
7007
|
# Return decrypted values for secure string parameters. This flag is
|
@@ -7536,6 +7661,15 @@ module Aws::SSM
|
|
7536
7661
|
# resp.association_versions[0].target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
7537
7662
|
# resp.association_versions[0].target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
7538
7663
|
# resp.association_versions[0].target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
7664
|
+
# resp.association_versions[0].target_locations[0].include_child_organization_units #=> Boolean
|
7665
|
+
# resp.association_versions[0].target_locations[0].exclude_accounts #=> Array
|
7666
|
+
# resp.association_versions[0].target_locations[0].exclude_accounts[0] #=> String
|
7667
|
+
# resp.association_versions[0].target_locations[0].targets #=> Array
|
7668
|
+
# resp.association_versions[0].target_locations[0].targets[0].key #=> String
|
7669
|
+
# resp.association_versions[0].target_locations[0].targets[0].values #=> Array
|
7670
|
+
# resp.association_versions[0].target_locations[0].targets[0].values[0] #=> String
|
7671
|
+
# resp.association_versions[0].target_locations[0].targets_max_concurrency #=> String
|
7672
|
+
# resp.association_versions[0].target_locations[0].targets_max_errors #=> String
|
7539
7673
|
# resp.association_versions[0].schedule_offset #=> Integer
|
7540
7674
|
# resp.association_versions[0].duration #=> Integer
|
7541
7675
|
# resp.association_versions[0].target_maps #=> Array
|
@@ -9482,7 +9616,7 @@ module Aws::SSM
|
|
9482
9616
|
# creating a custom policy and custom service role for running your
|
9483
9617
|
# maintenance window tasks. The policy can be crafted to provide only
|
9484
9618
|
# the permissions needed for your particular maintenance window tasks.
|
9485
|
-
# For more information, see [Setting up
|
9619
|
+
# For more information, see [Setting up Maintenance Windows][1] in the
|
9486
9620
|
# in the *Amazon Web Services Systems Manager User Guide*.
|
9487
9621
|
#
|
9488
9622
|
#
|
@@ -10236,6 +10370,9 @@ module Aws::SSM
|
|
10236
10370
|
# A key-value mapping to target resources. Required if you specify
|
10237
10371
|
# TargetParameterName.
|
10238
10372
|
#
|
10373
|
+
# If both this parameter and the `TargetLocation:Targets` parameter are
|
10374
|
+
# supplied, `TargetLocation:Targets` takes precedence.
|
10375
|
+
#
|
10239
10376
|
# @option params [Array<Hash>] :target_maps
|
10240
10377
|
# A key-value mapping of document parameters to target resources. Both
|
10241
10378
|
# Targets and TargetMaps can't be specified together.
|
@@ -10245,6 +10382,9 @@ module Aws::SSM
|
|
10245
10382
|
# You can specify a number, such as 10, or a percentage, such as 10%.
|
10246
10383
|
# The default value is `10`.
|
10247
10384
|
#
|
10385
|
+
# If both this parameter and the `TargetLocation:TargetsMaxConcurrency`
|
10386
|
+
# are supplied, `TargetLocation:TargetsMaxConcurrency` takes precedence.
|
10387
|
+
#
|
10248
10388
|
# @option params [String] :max_errors
|
10249
10389
|
# The number of errors that are allowed before the system stops running
|
10250
10390
|
# the automation on additional targets. You can specify either an
|
@@ -10263,14 +10403,17 @@ module Aws::SSM
|
|
10263
10403
|
# max-errors failed executions, set max-concurrency to 1 so the
|
10264
10404
|
# executions proceed one at a time.
|
10265
10405
|
#
|
10406
|
+
# If this parameter and the `TargetLocation:TargetsMaxErrors` parameter
|
10407
|
+
# are both supplied, `TargetLocation:TargetsMaxErrors` takes precedence.
|
10408
|
+
#
|
10266
10409
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
10267
10410
|
# A location is a combination of Amazon Web Services Regions and/or
|
10268
10411
|
# Amazon Web Services accounts where you want to run the automation. Use
|
10269
10412
|
# this operation to start an automation in multiple Amazon Web Services
|
10270
10413
|
# Regions and multiple Amazon Web Services accounts. For more
|
10271
|
-
# information, see [Running
|
10272
|
-
#
|
10273
|
-
#
|
10414
|
+
# information, see [Running automations in multiple Amazon Web Services
|
10415
|
+
# Regions and accounts][1] in the *Amazon Web Services Systems Manager
|
10416
|
+
# User Guide*.
|
10274
10417
|
#
|
10275
10418
|
#
|
10276
10419
|
#
|
@@ -10296,6 +10439,11 @@ module Aws::SSM
|
|
10296
10439
|
# @option params [Types::AlarmConfiguration] :alarm_configuration
|
10297
10440
|
# The CloudWatch alarm you want to apply to your automation.
|
10298
10441
|
#
|
10442
|
+
# @option params [String] :target_locations_url
|
10443
|
+
# Specify a publicly accessible URL for a file that contains the
|
10444
|
+
# `TargetLocations` body. Currently, only files in presigned Amazon S3
|
10445
|
+
# buckets are supported.
|
10446
|
+
#
|
10299
10447
|
# @return [Types::StartAutomationExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10300
10448
|
#
|
10301
10449
|
# * {Types::StartAutomationExecutionResult#automation_execution_id #automation_execution_id} => String
|
@@ -10339,6 +10487,16 @@ module Aws::SSM
|
|
10339
10487
|
# },
|
10340
10488
|
# ],
|
10341
10489
|
# },
|
10490
|
+
# include_child_organization_units: false,
|
10491
|
+
# exclude_accounts: ["ExcludeAccount"],
|
10492
|
+
# targets: [
|
10493
|
+
# {
|
10494
|
+
# key: "TargetKey",
|
10495
|
+
# values: ["TargetValue"],
|
10496
|
+
# },
|
10497
|
+
# ],
|
10498
|
+
# targets_max_concurrency: "MaxConcurrency",
|
10499
|
+
# targets_max_errors: "MaxErrors",
|
10342
10500
|
# },
|
10343
10501
|
# ],
|
10344
10502
|
# tags: [
|
@@ -10355,6 +10513,7 @@ module Aws::SSM
|
|
10355
10513
|
# },
|
10356
10514
|
# ],
|
10357
10515
|
# },
|
10516
|
+
# target_locations_url: "TargetLocationsURL",
|
10358
10517
|
# })
|
10359
10518
|
#
|
10360
10519
|
# @example Response structure
|
@@ -10504,6 +10663,16 @@ module Aws::SSM
|
|
10504
10663
|
# },
|
10505
10664
|
# ],
|
10506
10665
|
# },
|
10666
|
+
# include_child_organization_units: false,
|
10667
|
+
# exclude_accounts: ["ExcludeAccount"],
|
10668
|
+
# targets: [
|
10669
|
+
# {
|
10670
|
+
# key: "TargetKey",
|
10671
|
+
# values: ["TargetValue"],
|
10672
|
+
# },
|
10673
|
+
# ],
|
10674
|
+
# targets_max_concurrency: "MaxConcurrency",
|
10675
|
+
# targets_max_errors: "MaxErrors",
|
10507
10676
|
# },
|
10508
10677
|
# ],
|
10509
10678
|
# },
|
@@ -10987,6 +11156,16 @@ module Aws::SSM
|
|
10987
11156
|
# },
|
10988
11157
|
# ],
|
10989
11158
|
# },
|
11159
|
+
# include_child_organization_units: false,
|
11160
|
+
# exclude_accounts: ["ExcludeAccount"],
|
11161
|
+
# targets: [
|
11162
|
+
# {
|
11163
|
+
# key: "TargetKey",
|
11164
|
+
# values: ["TargetValue"],
|
11165
|
+
# },
|
11166
|
+
# ],
|
11167
|
+
# targets_max_concurrency: "MaxConcurrency",
|
11168
|
+
# targets_max_errors: "MaxErrors",
|
10990
11169
|
# },
|
10991
11170
|
# ],
|
10992
11171
|
# schedule_offset: 1,
|
@@ -11056,6 +11235,15 @@ module Aws::SSM
|
|
11056
11235
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
11057
11236
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
11058
11237
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
11238
|
+
# resp.association_description.target_locations[0].include_child_organization_units #=> Boolean
|
11239
|
+
# resp.association_description.target_locations[0].exclude_accounts #=> Array
|
11240
|
+
# resp.association_description.target_locations[0].exclude_accounts[0] #=> String
|
11241
|
+
# resp.association_description.target_locations[0].targets #=> Array
|
11242
|
+
# resp.association_description.target_locations[0].targets[0].key #=> String
|
11243
|
+
# resp.association_description.target_locations[0].targets[0].values #=> Array
|
11244
|
+
# resp.association_description.target_locations[0].targets[0].values[0] #=> String
|
11245
|
+
# resp.association_description.target_locations[0].targets_max_concurrency #=> String
|
11246
|
+
# resp.association_description.target_locations[0].targets_max_errors #=> String
|
11059
11247
|
# resp.association_description.schedule_offset #=> Integer
|
11060
11248
|
# resp.association_description.duration #=> Integer
|
11061
11249
|
# resp.association_description.target_maps #=> Array
|
@@ -11162,6 +11350,15 @@ module Aws::SSM
|
|
11162
11350
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.ignore_poll_alarm_failure #=> Boolean
|
11163
11351
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms #=> Array
|
11164
11352
|
# resp.association_description.target_locations[0].target_location_alarm_configuration.alarms[0].name #=> String
|
11353
|
+
# resp.association_description.target_locations[0].include_child_organization_units #=> Boolean
|
11354
|
+
# resp.association_description.target_locations[0].exclude_accounts #=> Array
|
11355
|
+
# resp.association_description.target_locations[0].exclude_accounts[0] #=> String
|
11356
|
+
# resp.association_description.target_locations[0].targets #=> Array
|
11357
|
+
# resp.association_description.target_locations[0].targets[0].key #=> String
|
11358
|
+
# resp.association_description.target_locations[0].targets[0].values #=> Array
|
11359
|
+
# resp.association_description.target_locations[0].targets[0].values[0] #=> String
|
11360
|
+
# resp.association_description.target_locations[0].targets_max_concurrency #=> String
|
11361
|
+
# resp.association_description.target_locations[0].targets_max_errors #=> String
|
11165
11362
|
# resp.association_description.schedule_offset #=> Integer
|
11166
11363
|
# resp.association_description.duration #=> Integer
|
11167
11364
|
# resp.association_description.target_maps #=> Array
|
@@ -11710,7 +11907,7 @@ module Aws::SSM
|
|
11710
11907
|
# creating a custom policy and custom service role for running your
|
11711
11908
|
# maintenance window tasks. The policy can be crafted to provide only
|
11712
11909
|
# the permissions needed for your particular maintenance window tasks.
|
11713
|
-
# For more information, see [Setting up
|
11910
|
+
# For more information, see [Setting up Maintenance Windows][1] in the
|
11714
11911
|
# in the *Amazon Web Services Systems Manager User Guide*.
|
11715
11912
|
#
|
11716
11913
|
#
|
@@ -12014,9 +12211,9 @@ module Aws::SSM
|
|
12014
12211
|
# want to assign to the managed node. This IAM role must provide
|
12015
12212
|
# AssumeRole permissions for the Amazon Web Services Systems Manager
|
12016
12213
|
# service principal `ssm.amazonaws.com`. For more information, see
|
12017
|
-
# [Create
|
12018
|
-
#
|
12019
|
-
# Guide*.
|
12214
|
+
# [Create the IAM service role required for Systems Manager in hybrid
|
12215
|
+
# and multicloud environments][1] in the *Amazon Web Services Systems
|
12216
|
+
# Manager User Guide*.
|
12020
12217
|
#
|
12021
12218
|
# <note markdown="1"> You can't specify an IAM service-linked role for this parameter. You
|
12022
12219
|
# must create a unique role.
|
@@ -12025,7 +12222,7 @@ module Aws::SSM
|
|
12025
12222
|
#
|
12026
12223
|
#
|
12027
12224
|
#
|
12028
|
-
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/
|
12225
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-service-role.html
|
12029
12226
|
#
|
12030
12227
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12031
12228
|
#
|
@@ -12116,9 +12313,8 @@ module Aws::SSM
|
|
12116
12313
|
# impacted resource.
|
12117
12314
|
#
|
12118
12315
|
# @option params [String] :status
|
12119
|
-
# The OpsItem status.
|
12120
|
-
#
|
12121
|
-
# the *Amazon Web Services Systems Manager User Guide*.
|
12316
|
+
# The OpsItem status. For more information, see [Editing OpsItem
|
12317
|
+
# details][1] in the *Amazon Web Services Systems Manager User Guide*.
|
12122
12318
|
#
|
12123
12319
|
#
|
12124
12320
|
#
|
@@ -12267,7 +12463,7 @@ module Aws::SSM
|
|
12267
12463
|
# A list of explicitly approved patches for the baseline.
|
12268
12464
|
#
|
12269
12465
|
# For information about accepted formats for lists of approved patches
|
12270
|
-
# and rejected patches, see [
|
12466
|
+
# and rejected patches, see [Package name formats for approved and
|
12271
12467
|
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
12272
12468
|
# User Guide*.
|
12273
12469
|
#
|
@@ -12287,7 +12483,7 @@ module Aws::SSM
|
|
12287
12483
|
# A list of explicitly rejected patches for the baseline.
|
12288
12484
|
#
|
12289
12485
|
# For information about accepted formats for lists of approved patches
|
12290
|
-
# and rejected patches, see [
|
12486
|
+
# and rejected patches, see [Package name formats for approved and
|
12291
12487
|
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
12292
12488
|
# User Guide*.
|
12293
12489
|
#
|
@@ -12597,14 +12793,19 @@ module Aws::SSM
|
|
12597
12793
|
# @api private
|
12598
12794
|
def build_request(operation_name, params = {})
|
12599
12795
|
handlers = @handlers.for(operation_name)
|
12796
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
12797
|
+
Aws::Telemetry.module_to_tracer_name('Aws::SSM')
|
12798
|
+
)
|
12600
12799
|
context = Seahorse::Client::RequestContext.new(
|
12601
12800
|
operation_name: operation_name,
|
12602
12801
|
operation: config.api.operation(operation_name),
|
12603
12802
|
client: self,
|
12604
12803
|
params: params,
|
12605
|
-
config: config
|
12804
|
+
config: config,
|
12805
|
+
tracer: tracer
|
12806
|
+
)
|
12606
12807
|
context[:gem_name] = 'aws-sdk-ssm'
|
12607
|
-
context[:gem_version] = '1.
|
12808
|
+
context[:gem_version] = '1.182.0'
|
12608
12809
|
Seahorse::Client::Request.new(handlers, context)
|
12609
12810
|
end
|
12610
12811
|
|