aws-sdk-ssm 1.41.0 → 1.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +92 -45
- data/lib/aws-sdk-ssm/types.rb +134 -139
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: afe91de135611a58025d7594d760865ef535c4dc
|
4
|
+
data.tar.gz: 9d55f960860e1ea8615d20aa6994f9a0efb4d95c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b72e21506d19c1debe54e9194f8a93bac5d42065c83ccc76a9936fdfcb65a288d1d11bbe41591db127404d26cfb886593a92ef22b02d9f46c56d1051926d8346
|
7
|
+
data.tar.gz: 39f6fe758b873266e638f7ef80d4d32665de027b3716ca00462ee5cfd5d5c8c632b0f8a3111a87308a459ce96ffe0d79d53f004aed7b82d6be8e0f822a7ca84e
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -209,6 +209,49 @@ module Aws::SSM
|
|
209
209
|
# When `true`, request parameters are validated before
|
210
210
|
# sending the request.
|
211
211
|
#
|
212
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
213
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
214
|
+
#
|
215
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
216
|
+
# seconds to wait when opening a HTTP session before rasing a
|
217
|
+
# `Timeout::Error`.
|
218
|
+
#
|
219
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
220
|
+
# number of seconds to wait for response data. This value can
|
221
|
+
# safely be set
|
222
|
+
# per-request on the session yeidled by {#session_for}.
|
223
|
+
#
|
224
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
225
|
+
# seconds a connection is allowed to sit idble before it is
|
226
|
+
# considered stale. Stale connections are closed and removed
|
227
|
+
# from the pool before making a request.
|
228
|
+
#
|
229
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
230
|
+
# seconds to wait for a 100-continue response before sending the
|
231
|
+
# request body. This option has no effect unless the request has
|
232
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
233
|
+
# disables this behaviour. This value can safely be set per
|
234
|
+
# request on the session yeidled by {#session_for}.
|
235
|
+
#
|
236
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
237
|
+
# HTTP debug output will be sent to the `:logger`.
|
238
|
+
#
|
239
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
240
|
+
# SSL peer certificates are verified when establishing a
|
241
|
+
# connection.
|
242
|
+
#
|
243
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
244
|
+
# certificate authority bundle file that should be used when
|
245
|
+
# verifying peer certificates. If you do not pass
|
246
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
247
|
+
# will be used if available.
|
248
|
+
#
|
249
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
250
|
+
# directory that contains the unbundled SSL certificate
|
251
|
+
# authority files for verifying peer certificates. If you do
|
252
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
253
|
+
# system default will be used if available.
|
254
|
+
#
|
212
255
|
def initialize(*args)
|
213
256
|
super
|
214
257
|
end
|
@@ -473,8 +516,8 @@ module Aws::SSM
|
|
473
516
|
#
|
474
517
|
# @option params [required, String] :name
|
475
518
|
# The name of the SSM document that contains the configuration
|
476
|
-
# information for the instance. You can specify Command
|
477
|
-
#
|
519
|
+
# information for the instance. You can specify Command or Automation
|
520
|
+
# documents.
|
478
521
|
#
|
479
522
|
# You can specify AWS-predefined documents, documents you created, or a
|
480
523
|
# document that is shared with you from another account.
|
@@ -545,8 +588,8 @@ module Aws::SSM
|
|
545
588
|
# of the target set, for example 10%. The default value is 100%, which
|
546
589
|
# means all targets run the association at the same time.
|
547
590
|
#
|
548
|
-
# If a new instance starts and attempts to
|
549
|
-
# Systems Manager is
|
591
|
+
# If a new instance starts and attempts to run an association while
|
592
|
+
# Systems Manager is running MaxConcurrency associations, the
|
550
593
|
# association is allowed to run. During the next association interval,
|
551
594
|
# the new instance will process its association within the limit
|
552
595
|
# specified for MaxConcurrency.
|
@@ -932,10 +975,10 @@ module Aws::SSM
|
|
932
975
|
# Systems Manager stops scheduling new tasks for execution.
|
933
976
|
#
|
934
977
|
# @option params [required, Boolean] :allow_unassociated_targets
|
935
|
-
# Enables a Maintenance Window task to
|
936
|
-
#
|
937
|
-
#
|
938
|
-
#
|
978
|
+
# Enables a Maintenance Window task to run on managed instances, even if
|
979
|
+
# you have not registered those instances as targets. If enabled, then
|
980
|
+
# you must specify the unregistered instances (by instance ID) when you
|
981
|
+
# register a task with the Maintenance Window
|
939
982
|
#
|
940
983
|
# If you don't enable this option, then you must specify
|
941
984
|
# previously-registered targets when you register a task with the
|
@@ -2771,7 +2814,7 @@ module Aws::SSM
|
|
2771
2814
|
end
|
2772
2815
|
|
2773
2816
|
# Retrieves the individual task executions (one per target) for a
|
2774
|
-
# particular task
|
2817
|
+
# particular task run as part of a Maintenance Window execution.
|
2775
2818
|
#
|
2776
2819
|
# @option params [required, String] :window_execution_id
|
2777
2820
|
# The ID of the Maintenance Window execution the task is part of.
|
@@ -2841,7 +2884,7 @@ module Aws::SSM
|
|
2841
2884
|
end
|
2842
2885
|
|
2843
2886
|
# For a given Maintenance Window execution, lists the tasks that were
|
2844
|
-
#
|
2887
|
+
# run.
|
2845
2888
|
#
|
2846
2889
|
# @option params [required, String] :window_execution_id
|
2847
2890
|
# The ID of the Maintenance Window execution whose task executions
|
@@ -4136,8 +4179,8 @@ module Aws::SSM
|
|
4136
4179
|
req.send_request(options)
|
4137
4180
|
end
|
4138
4181
|
|
4139
|
-
# Retrieves details about a specific task
|
4140
|
-
#
|
4182
|
+
# Retrieves details about a specific task run as part of a Maintenance
|
4183
|
+
# Window execution.
|
4141
4184
|
#
|
4142
4185
|
# @option params [required, String] :window_execution_id
|
4143
4186
|
# The ID of the Maintenance Window execution that includes the task.
|
@@ -4176,7 +4219,7 @@ module Aws::SSM
|
|
4176
4219
|
req.send_request(options)
|
4177
4220
|
end
|
4178
4221
|
|
4179
|
-
# Retrieves the details about a specific task
|
4222
|
+
# Retrieves the details about a specific task run as part of a
|
4180
4223
|
# Maintenance Window execution.
|
4181
4224
|
#
|
4182
4225
|
# @option params [required, String] :window_execution_id
|
@@ -4238,7 +4281,7 @@ module Aws::SSM
|
|
4238
4281
|
end
|
4239
4282
|
|
4240
4283
|
# Retrieves a task invocation. A task invocation is a specific task
|
4241
|
-
#
|
4284
|
+
# running on a specific target. Maintenance Windows report status for
|
4242
4285
|
# all invocations.
|
4243
4286
|
#
|
4244
4287
|
# @option params [required, String] :window_execution_id
|
@@ -4561,10 +4604,11 @@ module Aws::SSM
|
|
4561
4604
|
# Retrieve all parameters within a hierarchy.
|
4562
4605
|
#
|
4563
4606
|
# If a user has access to a path, then the user can access all levels of
|
4564
|
-
# that path. For example, if a user has permission to access path
|
4565
|
-
# then the user can also access
|
4566
|
-
# denied access in IAM for parameter /
|
4567
|
-
# GetParametersByPath API action recursively and view
|
4607
|
+
# that path. For example, if a user has permission to access path `/a`,
|
4608
|
+
# then the user can also access `/a/b`. Even if a user has explicitly
|
4609
|
+
# been denied access in IAM for parameter `/a/b`, they can still call
|
4610
|
+
# the GetParametersByPath API action recursively for `/a` and view
|
4611
|
+
# `/a/b`.
|
4568
4612
|
#
|
4569
4613
|
# @option params [Array<Types::ParameterStringFilter>] :parameter_filters
|
4570
4614
|
# Filters to limit the request results.
|
@@ -4987,7 +5031,7 @@ module Aws::SSM
|
|
4987
5031
|
|
4988
5032
|
# An invocation is copy of a command sent to a specific instance. A
|
4989
5033
|
# command can apply to one or more instances. A command invocation
|
4990
|
-
# applies to one instance. For example, if a user
|
5034
|
+
# applies to one instance. For example, if a user runs SendCommand
|
4991
5035
|
# against three instances, then a command invocation is created for each
|
4992
5036
|
# requested instance ID. ListCommandInvocations provide status about
|
4993
5037
|
# command execution.
|
@@ -6159,7 +6203,7 @@ module Aws::SSM
|
|
6159
6203
|
# `Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>`
|
6160
6204
|
#
|
6161
6205
|
# @option params [required, String] :task_arn
|
6162
|
-
# The ARN of the task to
|
6206
|
+
# The ARN of the task to run.
|
6163
6207
|
#
|
6164
6208
|
# @option params [String] :service_role_arn
|
6165
6209
|
# The role to assume when running the Maintenance Window task.
|
@@ -6184,7 +6228,7 @@ module Aws::SSM
|
|
6184
6228
|
# The type of task being registered.
|
6185
6229
|
#
|
6186
6230
|
# @option params [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>] :task_parameters
|
6187
|
-
# The parameters that should be passed to the task when it is
|
6231
|
+
# The parameters that should be passed to the task when it is run.
|
6188
6232
|
#
|
6189
6233
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass to
|
6190
6234
|
# a task when it runs, instead use the `Parameters` option in the
|
@@ -6497,10 +6541,10 @@ module Aws::SSM
|
|
6497
6541
|
req.send_request(options)
|
6498
6542
|
end
|
6499
6543
|
|
6500
|
-
#
|
6544
|
+
# Runs commands on one or more managed instances.
|
6501
6545
|
#
|
6502
6546
|
# @option params [Array<String>] :instance_ids
|
6503
|
-
# The instance IDs where the command should
|
6547
|
+
# The instance IDs where the command should run. You can specify a
|
6504
6548
|
# maximum of 50 IDs. If you prefer not to list individual instance IDs,
|
6505
6549
|
# you can instead send commands to a fleet of instances using the
|
6506
6550
|
# Targets parameter, which accepts EC2 tags. For more information about
|
@@ -6523,15 +6567,15 @@ module Aws::SSM
|
|
6523
6567
|
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
6524
6568
|
#
|
6525
6569
|
# @option params [required, String] :document_name
|
6526
|
-
# Required. The name of the Systems Manager document to
|
6527
|
-
#
|
6570
|
+
# Required. The name of the Systems Manager document to run. This can be
|
6571
|
+
# a public document or a custom document.
|
6528
6572
|
#
|
6529
6573
|
# @option params [String] :document_version
|
6530
6574
|
# The SSM document version to use in the request. You can specify
|
6531
|
-
# $DEFAULT, $LATEST, or a specific version number. If you
|
6532
|
-
#
|
6533
|
-
#
|
6534
|
-
#
|
6575
|
+
# $DEFAULT, $LATEST, or a specific version number. If you run commands
|
6576
|
+
# by using the AWS CLI, then you must escape the first two options by
|
6577
|
+
# using a backslash. If you specify a version number, then you don't
|
6578
|
+
# need to use the backslash. For example:
|
6535
6579
|
#
|
6536
6580
|
# --document-version "\\$DEFAULT"
|
6537
6581
|
#
|
@@ -6556,7 +6600,7 @@ module Aws::SSM
|
|
6556
6600
|
#
|
6557
6601
|
# @option params [Integer] :timeout_seconds
|
6558
6602
|
# If this time is reached and the command has not already started
|
6559
|
-
#
|
6603
|
+
# running, it will not run.
|
6560
6604
|
#
|
6561
6605
|
# @option params [String] :comment
|
6562
6606
|
# User-specified information about the command, such as a brief
|
@@ -6564,7 +6608,7 @@ module Aws::SSM
|
|
6564
6608
|
#
|
6565
6609
|
# @option params [Hash<String,Array>] :parameters
|
6566
6610
|
# The required and optional parameters specified in the document being
|
6567
|
-
#
|
6611
|
+
# run.
|
6568
6612
|
#
|
6569
6613
|
# @option params [String] :output_s3_region
|
6570
6614
|
# (Deprecated) You can no longer specify this parameter. The system
|
@@ -6580,8 +6624,8 @@ module Aws::SSM
|
|
6580
6624
|
# should be stored.
|
6581
6625
|
#
|
6582
6626
|
# @option params [String] :max_concurrency
|
6583
|
-
# (Optional) The maximum number of instances that are allowed to
|
6584
|
-
#
|
6627
|
+
# (Optional) The maximum number of instances that are allowed to run the
|
6628
|
+
# command at the same time. You can specify a number such as 10 or a
|
6585
6629
|
# percentage such as 10%. The default value is 50. For more information
|
6586
6630
|
# about how to use MaxConcurrency, see [Using Concurrency Controls][1]
|
6587
6631
|
# in the *AWS Systems Manager User Guide*.
|
@@ -6697,11 +6741,11 @@ module Aws::SSM
|
|
6697
6741
|
req.send_request(options)
|
6698
6742
|
end
|
6699
6743
|
|
6700
|
-
# Use this API action to
|
6744
|
+
# Use this API action to run an association immediately and only one
|
6701
6745
|
# time. This action can be helpful when troubleshooting associations.
|
6702
6746
|
#
|
6703
6747
|
# @option params [required, Array<String>] :association_ids
|
6704
|
-
# The association IDs that you want to
|
6748
|
+
# The association IDs that you want to run immediately and only one
|
6705
6749
|
# time.
|
6706
6750
|
#
|
6707
6751
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -6778,10 +6822,10 @@ module Aws::SSM
|
|
6778
6822
|
#
|
6779
6823
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
6780
6824
|
# A location is a combination of AWS Regions and/or AWS accounts where
|
6781
|
-
# you want to
|
6782
|
-
#
|
6783
|
-
#
|
6784
|
-
#
|
6825
|
+
# you want to run the Automation. Use this action to start an Automation
|
6826
|
+
# in multiple Regions and multiple accounts. For more information, see
|
6827
|
+
# [Executing Automations in Multiple AWS Regions and Accounts][1] in the
|
6828
|
+
# *AWS Systems Manager User Guide*.
|
6785
6829
|
#
|
6786
6830
|
#
|
6787
6831
|
#
|
@@ -6897,7 +6941,7 @@ module Aws::SSM
|
|
6897
6941
|
req.send_request(options)
|
6898
6942
|
end
|
6899
6943
|
|
6900
|
-
# Stop an Automation that is currently
|
6944
|
+
# Stop an Automation that is currently running.
|
6901
6945
|
#
|
6902
6946
|
# @option params [required, String] :automation_execution_id
|
6903
6947
|
# The execution ID of the Automation to stop.
|
@@ -6958,6 +7002,9 @@ module Aws::SSM
|
|
6958
7002
|
# version, the document version, schedule, parameters, and Amazon S3
|
6959
7003
|
# output.
|
6960
7004
|
#
|
7005
|
+
# When you update an association, the association immediately runs
|
7006
|
+
# against the specified targets.
|
7007
|
+
#
|
6961
7008
|
# @option params [required, String] :association_id
|
6962
7009
|
# The ID of the association you want to update.
|
6963
7010
|
#
|
@@ -6979,8 +7026,8 @@ module Aws::SSM
|
|
6979
7026
|
#
|
6980
7027
|
# @option params [String] :name
|
6981
7028
|
# The name of the SSM document that contains the configuration
|
6982
|
-
# information for the instance. You can specify Command
|
6983
|
-
#
|
7029
|
+
# information for the instance. You can specify Command or Automation
|
7030
|
+
# documents.
|
6984
7031
|
#
|
6985
7032
|
# You can specify AWS-predefined documents, documents you created, or a
|
6986
7033
|
# document that is shared with you from another account.
|
@@ -7039,8 +7086,8 @@ module Aws::SSM
|
|
7039
7086
|
# of the target set, for example 10%. The default value is 100%, which
|
7040
7087
|
# means all targets run the association at the same time.
|
7041
7088
|
#
|
7042
|
-
# If a new instance starts and attempts to
|
7043
|
-
# Systems Manager is
|
7089
|
+
# If a new instance starts and attempts to run an association while
|
7090
|
+
# Systems Manager is running MaxConcurrency associations, the
|
7044
7091
|
# association is allowed to run. During the next association interval,
|
7045
7092
|
# the new instance will process its association within the limit
|
7046
7093
|
# specified for MaxConcurrency.
|
@@ -8053,7 +8100,7 @@ module Aws::SSM
|
|
8053
8100
|
params: params,
|
8054
8101
|
config: config)
|
8055
8102
|
context[:gem_name] = 'aws-sdk-ssm'
|
8056
|
-
context[:gem_version] = '1.
|
8103
|
+
context[:gem_version] = '1.42.0'
|
8057
8104
|
Seahorse::Client::Request.new(handlers, context)
|
8058
8105
|
end
|
8059
8106
|
|
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -300,8 +300,8 @@ module Aws::SSM
|
|
300
300
|
# of the target set, for example 10%. The default value is 100%, which
|
301
301
|
# means all targets run the association at the same time.
|
302
302
|
#
|
303
|
-
# If a new instance starts and attempts to
|
304
|
-
#
|
303
|
+
# If a new instance starts and attempts to run an association while
|
304
|
+
# Systems Manager is running MaxConcurrency associations, the
|
305
305
|
# association is allowed to run. During the next association interval,
|
306
306
|
# the new instance will process its association within the limit
|
307
307
|
# specified for MaxConcurrency.
|
@@ -664,8 +664,8 @@ module Aws::SSM
|
|
664
664
|
# of the target set, for example 10%. The default value is 100%, which
|
665
665
|
# means all targets run the association at the same time.
|
666
666
|
#
|
667
|
-
# If a new instance starts and attempts to
|
668
|
-
#
|
667
|
+
# If a new instance starts and attempts to run an association while
|
668
|
+
# Systems Manager is running MaxConcurrency associations, the
|
669
669
|
# association is allowed to run. During the next association interval,
|
670
670
|
# the new instance will process its association within the limit
|
671
671
|
# specified for MaxConcurrency.
|
@@ -800,7 +800,7 @@ module Aws::SSM
|
|
800
800
|
# @!attribute [rw] step_executions
|
801
801
|
# A list of details about the current state of all steps that comprise
|
802
802
|
# an execution. An Automation document contains a list of steps that
|
803
|
-
# are
|
803
|
+
# are run in order.
|
804
804
|
# @return [Array<Types::StepExecution>]
|
805
805
|
#
|
806
806
|
# @!attribute [rw] step_executions_truncated
|
@@ -833,16 +833,15 @@ module Aws::SSM
|
|
833
833
|
# @return [String]
|
834
834
|
#
|
835
835
|
# @!attribute [rw] executed_by
|
836
|
-
# The Amazon Resource Name (ARN) of the user who
|
837
|
-
# automation.
|
836
|
+
# The Amazon Resource Name (ARN) of the user who ran the automation.
|
838
837
|
# @return [String]
|
839
838
|
#
|
840
839
|
# @!attribute [rw] current_step_name
|
841
|
-
# The name of the currently
|
840
|
+
# The name of the step that is currently running.
|
842
841
|
# @return [String]
|
843
842
|
#
|
844
843
|
# @!attribute [rw] current_action
|
845
|
-
# The action of the currently
|
844
|
+
# The action of the step that is currently running.
|
846
845
|
# @return [String]
|
847
846
|
#
|
848
847
|
# @!attribute [rw] target_parameter_name
|
@@ -878,7 +877,7 @@ module Aws::SSM
|
|
878
877
|
#
|
879
878
|
# @!attribute [rw] target_locations
|
880
879
|
# The combination of AWS Regions and/or AWS accounts where you want to
|
881
|
-
#
|
880
|
+
# run the Automation.
|
882
881
|
# @return [Array<Types::TargetLocation>]
|
883
882
|
#
|
884
883
|
# @!attribute [rw] progress_counters
|
@@ -976,7 +975,7 @@ module Aws::SSM
|
|
976
975
|
# @return [Time]
|
977
976
|
#
|
978
977
|
# @!attribute [rw] executed_by
|
979
|
-
# The IAM role ARN of the user who
|
978
|
+
# The IAM role ARN of the user who ran the Automation.
|
980
979
|
# @return [String]
|
981
980
|
#
|
982
981
|
# @!attribute [rw] log_file
|
@@ -996,11 +995,11 @@ module Aws::SSM
|
|
996
995
|
# @return [String]
|
997
996
|
#
|
998
997
|
# @!attribute [rw] current_step_name
|
999
|
-
# The name of the currently
|
998
|
+
# The name of the step that is currently running.
|
1000
999
|
# @return [String]
|
1001
1000
|
#
|
1002
1001
|
# @!attribute [rw] current_action
|
1003
|
-
# The action of the currently
|
1002
|
+
# The action of the step that is currently running.
|
1004
1003
|
# @return [String]
|
1005
1004
|
#
|
1006
1005
|
# @!attribute [rw] failure_message
|
@@ -1040,10 +1039,10 @@ module Aws::SSM
|
|
1040
1039
|
#
|
1041
1040
|
# @!attribute [rw] automation_type
|
1042
1041
|
# Use this filter with DescribeAutomationExecutions. Specify either
|
1043
|
-
# Local or CrossAccount. CrossAccount is an Automation that
|
1044
|
-
#
|
1045
|
-
# [
|
1046
|
-
#
|
1042
|
+
# Local or CrossAccount. CrossAccount is an Automation that runs in
|
1043
|
+
# multiple AWS Regions and accounts. For more information, see
|
1044
|
+
# [Executing Automations in Multiple AWS Regions and Accounts][1] in
|
1045
|
+
# the *AWS Systems Manager User Guide*.
|
1047
1046
|
#
|
1048
1047
|
#
|
1049
1048
|
#
|
@@ -1190,13 +1189,13 @@ module Aws::SSM
|
|
1190
1189
|
#
|
1191
1190
|
# @!attribute [rw] expires_after
|
1192
1191
|
# If this time is reached and the command has not already started
|
1193
|
-
#
|
1194
|
-
#
|
1192
|
+
# running, it will not run. Calculated based on the ExpiresAfter user
|
1193
|
+
# input provided as part of the SendCommand API.
|
1195
1194
|
# @return [Time]
|
1196
1195
|
#
|
1197
1196
|
# @!attribute [rw] parameters
|
1198
|
-
# The parameter values to be inserted in the document when
|
1199
|
-
#
|
1197
|
+
# The parameter values to be inserted in the document when running the
|
1198
|
+
# command.
|
1200
1199
|
# @return [Hash<String,Array<String>>]
|
1201
1200
|
#
|
1202
1201
|
# @!attribute [rw] instance_ids
|
@@ -1231,8 +1230,8 @@ module Aws::SSM
|
|
1231
1230
|
# * In Progress: The command has been sent to at least one instance
|
1232
1231
|
# but has not reached a final state on all instances.
|
1233
1232
|
#
|
1234
|
-
# * Success: The command successfully
|
1235
|
-
#
|
1233
|
+
# * Success: The command successfully ran on all invocations. This is
|
1234
|
+
# a terminal state.
|
1236
1235
|
#
|
1237
1236
|
# * Delivery Timed Out: The value of MaxErrors or more command
|
1238
1237
|
# invocations shows a status of Delivery Timed Out. This is a
|
@@ -1255,8 +1254,8 @@ module Aws::SSM
|
|
1255
1254
|
#
|
1256
1255
|
# * Rate Exceeded: The number of instances targeted by the command
|
1257
1256
|
# exceeded the account limit for pending invocations. The system has
|
1258
|
-
# canceled the command before
|
1259
|
-
#
|
1257
|
+
# canceled the command before running it on any instance. This is a
|
1258
|
+
# terminal state.
|
1260
1259
|
#
|
1261
1260
|
#
|
1262
1261
|
#
|
@@ -1281,12 +1280,12 @@ module Aws::SSM
|
|
1281
1280
|
# @return [String]
|
1282
1281
|
#
|
1283
1282
|
# @!attribute [rw] max_concurrency
|
1284
|
-
# The maximum number of instances that are allowed to
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1283
|
+
# The maximum number of instances that are allowed to run the command
|
1284
|
+
# at the same time. You can specify a number of instances, such as 10,
|
1285
|
+
# or a percentage of instances, such as 10%. The default value is 50.
|
1286
|
+
# For more information about how to use MaxConcurrency, see [Running
|
1287
|
+
# Commands Using Systems Manager Run Command][1] in the *AWS Systems
|
1288
|
+
# Manager User Guide*.
|
1290
1289
|
#
|
1291
1290
|
#
|
1292
1291
|
#
|
@@ -1298,7 +1297,7 @@ module Aws::SSM
|
|
1298
1297
|
# the command to additional targets. You can specify a number of
|
1299
1298
|
# errors, such as 10, or a percentage or errors, such as 10%. The
|
1300
1299
|
# default value is 0. For more information about how to use MaxErrors,
|
1301
|
-
# see [
|
1300
|
+
# see [Running Commands Using Systems Manager Run Command][1] in the
|
1302
1301
|
# *AWS Systems Manager User Guide*.
|
1303
1302
|
#
|
1304
1303
|
#
|
@@ -1437,10 +1436,10 @@ module Aws::SSM
|
|
1437
1436
|
|
1438
1437
|
# An invocation is copy of a command sent to a specific instance. A
|
1439
1438
|
# command can apply to one or more instances. A command invocation
|
1440
|
-
# applies to one instance. For example, if a user
|
1439
|
+
# applies to one instance. For example, if a user runs SendCommand
|
1441
1440
|
# against three instances, then a command invocation is created for each
|
1442
1441
|
# requested instance ID. A command invocation returns status and detail
|
1443
|
-
# information about a command you
|
1442
|
+
# information about a command you ran.
|
1444
1443
|
#
|
1445
1444
|
# @!attribute [rw] command_id
|
1446
1445
|
# The command against which this invocation was requested.
|
@@ -1602,7 +1601,7 @@ module Aws::SSM
|
|
1602
1601
|
# @return [String]
|
1603
1602
|
#
|
1604
1603
|
# @!attribute [rw] status
|
1605
|
-
# The status of this plugin. You can
|
1604
|
+
# The status of this plugin. You can run a document with multiple
|
1606
1605
|
# plugins.
|
1607
1606
|
# @return [String]
|
1608
1607
|
#
|
@@ -1660,16 +1659,16 @@ module Aws::SSM
|
|
1660
1659
|
# @return [String]
|
1661
1660
|
#
|
1662
1661
|
# @!attribute [rw] response_code
|
1663
|
-
# A numeric response code generated after
|
1662
|
+
# A numeric response code generated after running the plugin.
|
1664
1663
|
# @return [Integer]
|
1665
1664
|
#
|
1666
1665
|
# @!attribute [rw] response_start_date_time
|
1667
|
-
# The time the plugin started
|
1666
|
+
# The time the plugin started running.
|
1668
1667
|
# @return [Time]
|
1669
1668
|
#
|
1670
1669
|
# @!attribute [rw] response_finish_date_time
|
1671
|
-
# The time the plugin stopped
|
1672
|
-
#
|
1670
|
+
# The time the plugin stopped running. Could stop prematurely if, for
|
1671
|
+
# example, a cancel command was sent.
|
1673
1672
|
# @return [Time]
|
1674
1673
|
#
|
1675
1674
|
# @!attribute [rw] output
|
@@ -2168,8 +2167,8 @@ module Aws::SSM
|
|
2168
2167
|
#
|
2169
2168
|
# @!attribute [rw] name
|
2170
2169
|
# The name of the SSM document that contains the configuration
|
2171
|
-
# information for the instance. You can specify Command
|
2172
|
-
#
|
2170
|
+
# information for the instance. You can specify Command or Automation
|
2171
|
+
# documents.
|
2173
2172
|
#
|
2174
2173
|
# You can specify AWS-predefined documents, documents you created, or
|
2175
2174
|
# a document that is shared with you from another account.
|
@@ -2249,8 +2248,8 @@ module Aws::SSM
|
|
2249
2248
|
# of the target set, for example 10%. The default value is 100%, which
|
2250
2249
|
# means all targets run the association at the same time.
|
2251
2250
|
#
|
2252
|
-
# If a new instance starts and attempts to
|
2253
|
-
#
|
2251
|
+
# If a new instance starts and attempts to run an association while
|
2252
|
+
# Systems Manager is running MaxConcurrency associations, the
|
2254
2253
|
# association is allowed to run. During the next association interval,
|
2255
2254
|
# the new instance will process its association within the limit
|
2256
2255
|
# specified for MaxConcurrency.
|
@@ -2327,8 +2326,8 @@ module Aws::SSM
|
|
2327
2326
|
#
|
2328
2327
|
# @!attribute [rw] name
|
2329
2328
|
# The name of the SSM document that contains the configuration
|
2330
|
-
# information for the instance. You can specify Command
|
2331
|
-
#
|
2329
|
+
# information for the instance. You can specify Command or Automation
|
2330
|
+
# documents.
|
2332
2331
|
#
|
2333
2332
|
# You can specify AWS-predefined documents, documents you created, or
|
2334
2333
|
# a document that is shared with you from another account.
|
@@ -2409,8 +2408,8 @@ module Aws::SSM
|
|
2409
2408
|
# of the target set, for example 10%. The default value is 100%, which
|
2410
2409
|
# means all targets run the association at the same time.
|
2411
2410
|
#
|
2412
|
-
# If a new instance starts and attempts to
|
2413
|
-
#
|
2411
|
+
# If a new instance starts and attempts to run an association while
|
2412
|
+
# Systems Manager is running MaxConcurrency associations, the
|
2414
2413
|
# association is allowed to run. During the next association interval,
|
2415
2414
|
# the new instance will process its association within the limit
|
2416
2415
|
# specified for MaxConcurrency.
|
@@ -2642,10 +2641,10 @@ module Aws::SSM
|
|
2642
2641
|
# @return [Integer]
|
2643
2642
|
#
|
2644
2643
|
# @!attribute [rw] allow_unassociated_targets
|
2645
|
-
# Enables a Maintenance Window task to
|
2646
|
-
#
|
2647
|
-
#
|
2648
|
-
#
|
2644
|
+
# Enables a Maintenance Window task to run on managed instances, even
|
2645
|
+
# if you have not registered those instances as targets. If enabled,
|
2646
|
+
# then you must specify the unregistered instances (by instance ID)
|
2647
|
+
# when you register a task with the Maintenance Window
|
2649
2648
|
#
|
2650
2649
|
# If you don't enable this option, then you must specify
|
2651
2650
|
# previously-registered targets when you register a task with the
|
@@ -5548,7 +5547,7 @@ module Aws::SSM
|
|
5548
5547
|
include Aws::Structure
|
5549
5548
|
end
|
5550
5549
|
|
5551
|
-
# Parameters specified in a System Manager document that
|
5550
|
+
# Parameters specified in a System Manager document that run on the
|
5552
5551
|
# server when the command is run.
|
5553
5552
|
#
|
5554
5553
|
# @!attribute [rw] name
|
@@ -5791,7 +5790,7 @@ module Aws::SSM
|
|
5791
5790
|
# @return [String]
|
5792
5791
|
#
|
5793
5792
|
# @!attribute [rw] document_name
|
5794
|
-
# The name of the document that was
|
5793
|
+
# The name of the document that was run. For example,
|
5795
5794
|
# AWS-RunShellScript.
|
5796
5795
|
# @return [String]
|
5797
5796
|
#
|
@@ -5806,12 +5805,12 @@ module Aws::SSM
|
|
5806
5805
|
#
|
5807
5806
|
# @!attribute [rw] response_code
|
5808
5807
|
# The error level response code for the plugin script. If the response
|
5809
|
-
# code is -1, then the command has not started
|
5808
|
+
# code is -1, then the command has not started running on the
|
5810
5809
|
# instance, or it was not received by the instance.
|
5811
5810
|
# @return [Integer]
|
5812
5811
|
#
|
5813
5812
|
# @!attribute [rw] execution_start_date_time
|
5814
|
-
# The date and time the plugin started
|
5813
|
+
# The date and time the plugin started running. Date and time are
|
5815
5814
|
# written in ISO 8601 format. For example, June 7, 2017 is represented
|
5816
5815
|
# as 2017-06-7. The following sample AWS CLI command uses the
|
5817
5816
|
# `InvokedBefore` filter.
|
@@ -5819,7 +5818,7 @@ module Aws::SSM
|
|
5819
5818
|
# `aws ssm list-commands --filters
|
5820
5819
|
# key=InvokedBefore,value=2017-06-07T00:00:00Z`
|
5821
5820
|
#
|
5822
|
-
# If the plugin has not started to
|
5821
|
+
# If the plugin has not started to run, the string is empty.
|
5823
5822
|
# @return [String]
|
5824
5823
|
#
|
5825
5824
|
# @!attribute [rw] execution_elapsed_time
|
@@ -5827,15 +5826,15 @@ module Aws::SSM
|
|
5827
5826
|
# @return [String]
|
5828
5827
|
#
|
5829
5828
|
# @!attribute [rw] execution_end_date_time
|
5830
|
-
# The date and time the plugin was finished
|
5831
|
-
#
|
5832
|
-
#
|
5833
|
-
#
|
5829
|
+
# The date and time the plugin was finished running. Date and time are
|
5830
|
+
# written in ISO 8601 format. For example, June 7, 2017 is represented
|
5831
|
+
# as 2017-06-7. The following sample AWS CLI command uses the
|
5832
|
+
# `InvokedAfter` filter.
|
5834
5833
|
#
|
5835
5834
|
# `aws ssm list-commands --filters
|
5836
5835
|
# key=InvokedAfter,value=2017-06-07T00:00:00Z`
|
5837
5836
|
#
|
5838
|
-
# If the plugin has not started to
|
5837
|
+
# If the plugin has not started to run, the string is empty.
|
5839
5838
|
# @return [String]
|
5840
5839
|
#
|
5841
5840
|
# @!attribute [rw] status
|
@@ -5862,8 +5861,8 @@ module Aws::SSM
|
|
5862
5861
|
# available because of network issues, the instance was stopped,
|
5863
5862
|
# etc. The system will try to deliver the command again.
|
5864
5863
|
#
|
5865
|
-
# * Success: The command or plugin was
|
5866
|
-
#
|
5864
|
+
# * Success: The command or plugin was run successfully. This is a
|
5865
|
+
# terminal state.
|
5867
5866
|
#
|
5868
5867
|
# * Delivery Timed Out: The command was not delivered to the instance
|
5869
5868
|
# before the delivery timeout expired. Delivery timeouts do not
|
@@ -5871,17 +5870,16 @@ module Aws::SSM
|
|
5871
5870
|
# contribute to whether the parent command status is Success or
|
5872
5871
|
# Incomplete. This is a terminal state.
|
5873
5872
|
#
|
5874
|
-
# * Execution Timed Out: The command started to
|
5875
|
-
#
|
5876
|
-
#
|
5877
|
-
#
|
5873
|
+
# * Execution Timed Out: The command started to run on the instance,
|
5874
|
+
# but the execution was not complete before the timeout expired.
|
5875
|
+
# Execution timeouts count against the MaxErrors limit of the parent
|
5876
|
+
# command. This is a terminal state.
|
5878
5877
|
#
|
5879
|
-
# * Failed: The command wasn't
|
5880
|
-
#
|
5881
|
-
#
|
5882
|
-
#
|
5883
|
-
#
|
5884
|
-
# terminal state.
|
5878
|
+
# * Failed: The command wasn't run successfully on the instance. For
|
5879
|
+
# a plugin, this indicates that the result code was not zero. For a
|
5880
|
+
# command invocation, this indicates that the result code for one or
|
5881
|
+
# more plugins was not zero. Invocation failures count against the
|
5882
|
+
# MaxErrors limit of the parent command. This is a terminal state.
|
5885
5883
|
#
|
5886
5884
|
# * Canceled: The command was terminated before it was completed. This
|
5887
5885
|
# is a terminal state.
|
@@ -5904,7 +5902,7 @@ module Aws::SSM
|
|
5904
5902
|
#
|
5905
5903
|
# @!attribute [rw] standard_output_content
|
5906
5904
|
# The first 24,000 characters written by the plugin to stdout. If the
|
5907
|
-
# command has not finished
|
5905
|
+
# command has not finished running, if ExecutionStatus is neither
|
5908
5906
|
# Succeeded nor Failed, then this string is empty.
|
5909
5907
|
# @return [String]
|
5910
5908
|
#
|
@@ -5916,12 +5914,12 @@ module Aws::SSM
|
|
5916
5914
|
#
|
5917
5915
|
# @!attribute [rw] standard_error_content
|
5918
5916
|
# The first 8,000 characters written by the plugin to stderr. If the
|
5919
|
-
# command has not finished
|
5917
|
+
# command has not finished running, then this string is empty.
|
5920
5918
|
# @return [String]
|
5921
5919
|
#
|
5922
5920
|
# @!attribute [rw] standard_error_url
|
5923
5921
|
# The URL for the complete text written by the plugin to stderr. If
|
5924
|
-
# the command has not finished
|
5922
|
+
# the command has not finished running, then this string is empty.
|
5925
5923
|
# @return [String]
|
5926
5924
|
#
|
5927
5925
|
# @!attribute [rw] cloud_watch_output_config
|
@@ -6371,11 +6369,11 @@ module Aws::SSM
|
|
6371
6369
|
# @return [String]
|
6372
6370
|
#
|
6373
6371
|
# @!attribute [rw] start_time
|
6374
|
-
# The time the Maintenance Window started
|
6372
|
+
# The time the Maintenance Window started running.
|
6375
6373
|
# @return [Time]
|
6376
6374
|
#
|
6377
6375
|
# @!attribute [rw] end_time
|
6378
|
-
# The time the Maintenance Window finished
|
6376
|
+
# The time the Maintenance Window finished running.
|
6379
6377
|
# @return [Time]
|
6380
6378
|
#
|
6381
6379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionResult AWS API Documentation
|
@@ -6444,7 +6442,7 @@ module Aws::SSM
|
|
6444
6442
|
# @return [String]
|
6445
6443
|
#
|
6446
6444
|
# @!attribute [rw] parameters
|
6447
|
-
# The parameters used at the time that the task
|
6445
|
+
# The parameters used at the time that the task ran.
|
6448
6446
|
# @return [String]
|
6449
6447
|
#
|
6450
6448
|
# @!attribute [rw] status
|
@@ -6457,11 +6455,11 @@ module Aws::SSM
|
|
6457
6455
|
# @return [String]
|
6458
6456
|
#
|
6459
6457
|
# @!attribute [rw] start_time
|
6460
|
-
# The time that the task started
|
6458
|
+
# The time that the task started running on the target.
|
6461
6459
|
# @return [Time]
|
6462
6460
|
#
|
6463
6461
|
# @!attribute [rw] end_time
|
6464
|
-
# The time that the task finished
|
6462
|
+
# The time that the task finished running on the target.
|
6465
6463
|
# @return [Time]
|
6466
6464
|
#
|
6467
6465
|
# @!attribute [rw] owner_information
|
@@ -6526,19 +6524,19 @@ module Aws::SSM
|
|
6526
6524
|
# @return [String]
|
6527
6525
|
#
|
6528
6526
|
# @!attribute [rw] task_arn
|
6529
|
-
# The ARN of the
|
6527
|
+
# The ARN of the task that ran.
|
6530
6528
|
# @return [String]
|
6531
6529
|
#
|
6532
6530
|
# @!attribute [rw] service_role
|
6533
|
-
# The role that was assumed when
|
6531
|
+
# The role that was assumed when running the task.
|
6534
6532
|
# @return [String]
|
6535
6533
|
#
|
6536
6534
|
# @!attribute [rw] type
|
6537
|
-
# The type of task
|
6535
|
+
# The type of task that was run.
|
6538
6536
|
# @return [String]
|
6539
6537
|
#
|
6540
6538
|
# @!attribute [rw] task_parameters
|
6541
|
-
# The parameters passed to the task when it was
|
6539
|
+
# The parameters passed to the task when it was run.
|
6542
6540
|
#
|
6543
6541
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
6544
6542
|
# to a task when it runs, instead use the `Parameters` option in the
|
@@ -6750,7 +6748,7 @@ module Aws::SSM
|
|
6750
6748
|
# @return [String]
|
6751
6749
|
#
|
6752
6750
|
# @!attribute [rw] targets
|
6753
|
-
# The targets where the task should
|
6751
|
+
# The targets where the task should run.
|
6754
6752
|
# @return [Array<Types::Target>]
|
6755
6753
|
#
|
6756
6754
|
# @!attribute [rw] task_arn
|
@@ -6766,11 +6764,11 @@ module Aws::SSM
|
|
6766
6764
|
# @return [String]
|
6767
6765
|
#
|
6768
6766
|
# @!attribute [rw] task_type
|
6769
|
-
# The type of task to
|
6767
|
+
# The type of task to run.
|
6770
6768
|
# @return [String]
|
6771
6769
|
#
|
6772
6770
|
# @!attribute [rw] task_parameters
|
6773
|
-
# The parameters to pass to the task when it
|
6771
|
+
# The parameters to pass to the task when it runs.
|
6774
6772
|
#
|
6775
6773
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
6776
6774
|
# to a task when it runs, instead use the `Parameters` option in the
|
@@ -6782,11 +6780,11 @@ module Aws::SSM
|
|
6782
6780
|
# @return [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>]
|
6783
6781
|
#
|
6784
6782
|
# @!attribute [rw] task_invocation_parameters
|
6785
|
-
# The parameters to pass to the task when it
|
6783
|
+
# The parameters to pass to the task when it runs.
|
6786
6784
|
# @return [Types::MaintenanceWindowTaskInvocationParameters]
|
6787
6785
|
#
|
6788
6786
|
# @!attribute [rw] priority
|
6789
|
-
# The priority of the task when it
|
6787
|
+
# The priority of the task when it runs. The lower the number, the
|
6790
6788
|
# higher the priority. Tasks that have the same priority are scheduled
|
6791
6789
|
# in parallel.
|
6792
6790
|
# @return [Integer]
|
@@ -6964,10 +6962,10 @@ module Aws::SSM
|
|
6964
6962
|
#
|
6965
6963
|
# If a user has access to a path, then the user can access all levels
|
6966
6964
|
# of that path. For example, if a user has permission to access path
|
6967
|
-
#
|
6968
|
-
# explicitly been denied access in IAM for parameter /
|
6969
|
-
# still call the GetParametersByPath API action recursively
|
6970
|
-
#
|
6965
|
+
# `/a`, then the user can also access `/a/b`. Even if a user has
|
6966
|
+
# explicitly been denied access in IAM for parameter `/a/b`, they can
|
6967
|
+
# still call the GetParametersByPath API action recursively for `/a`
|
6968
|
+
# and view `/a/b`.
|
6971
6969
|
# @return [Boolean]
|
6972
6970
|
#
|
6973
6971
|
# @!attribute [rw] parameter_filters
|
@@ -7364,7 +7362,7 @@ module Aws::SSM
|
|
7364
7362
|
# @return [String]
|
7365
7363
|
#
|
7366
7364
|
# @!attribute [rw] execution_date
|
7367
|
-
# The date the instance association
|
7365
|
+
# The date the instance association ran.
|
7368
7366
|
# @return [Time]
|
7369
7367
|
#
|
7370
7368
|
# @!attribute [rw] status
|
@@ -7486,7 +7484,7 @@ module Aws::SSM
|
|
7486
7484
|
# @return [String]
|
7487
7485
|
#
|
7488
7486
|
# @!attribute [rw] last_association_execution_date
|
7489
|
-
# The date the association was last
|
7487
|
+
# The date the association was last run.
|
7490
7488
|
# @return [Time]
|
7491
7489
|
#
|
7492
7490
|
# @!attribute [rw] last_successful_association_execution_date
|
@@ -9096,11 +9094,11 @@ module Aws::SSM
|
|
9096
9094
|
# @return [Time]
|
9097
9095
|
#
|
9098
9096
|
# @!attribute [rw] task_arn
|
9099
|
-
# The ARN of the
|
9097
|
+
# The ARN of the task that ran.
|
9100
9098
|
# @return [String]
|
9101
9099
|
#
|
9102
9100
|
# @!attribute [rw] task_type
|
9103
|
-
# The type of
|
9101
|
+
# The type of task that ran.
|
9104
9102
|
# @return [String]
|
9105
9103
|
#
|
9106
9104
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MaintenanceWindowExecutionTaskIdentity AWS API Documentation
|
@@ -9146,7 +9144,7 @@ module Aws::SSM
|
|
9146
9144
|
#
|
9147
9145
|
# @!attribute [rw] parameters
|
9148
9146
|
# The parameters that were provided for the invocation when it was
|
9149
|
-
#
|
9147
|
+
# run.
|
9150
9148
|
# @return [String]
|
9151
9149
|
#
|
9152
9150
|
# @!attribute [rw] status
|
@@ -9415,7 +9413,7 @@ module Aws::SSM
|
|
9415
9413
|
# }
|
9416
9414
|
#
|
9417
9415
|
# @!attribute [rw] comment
|
9418
|
-
# Information about the command(s) to
|
9416
|
+
# Information about the command(s) to run.
|
9419
9417
|
# @return [String]
|
9420
9418
|
#
|
9421
9419
|
# @!attribute [rw] document_hash
|
@@ -9450,7 +9448,7 @@ module Aws::SSM
|
|
9450
9448
|
#
|
9451
9449
|
# @!attribute [rw] timeout_seconds
|
9452
9450
|
# If this time is reached and the command has not already started
|
9453
|
-
#
|
9451
|
+
# running, it doesn't run.
|
9454
9452
|
# @return [Integer]
|
9455
9453
|
#
|
9456
9454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MaintenanceWindowRunCommandParameters AWS API Documentation
|
@@ -9593,8 +9591,7 @@ module Aws::SSM
|
|
9593
9591
|
# @return [Array<Types::Target>]
|
9594
9592
|
#
|
9595
9593
|
# @!attribute [rw] task_parameters
|
9596
|
-
# The parameters that should be passed to the task when it is
|
9597
|
-
# executed.
|
9594
|
+
# The parameters that should be passed to the task when it is run.
|
9598
9595
|
#
|
9599
9596
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
9600
9597
|
# to a task when it runs, instead use the `Parameters` option in the
|
@@ -9625,7 +9622,7 @@ module Aws::SSM
|
|
9625
9622
|
# @return [Types::LoggingInfo]
|
9626
9623
|
#
|
9627
9624
|
# @!attribute [rw] service_role_arn
|
9628
|
-
# The role that should be assumed when
|
9625
|
+
# The role that should be assumed when running the task.
|
9629
9626
|
# @return [String]
|
9630
9627
|
#
|
9631
9628
|
# @!attribute [rw] max_concurrency
|
@@ -10973,7 +10970,7 @@ module Aws::SSM
|
|
10973
10970
|
# for a multi-Region and multi-account Automation execution.
|
10974
10971
|
#
|
10975
10972
|
# @!attribute [rw] total_steps
|
10976
|
-
# The total number of steps
|
10973
|
+
# The total number of steps run in all specified AWS Regions and
|
10977
10974
|
# accounts for the current Automation execution.
|
10978
10975
|
# @return [Integer]
|
10979
10976
|
#
|
@@ -10984,8 +10981,8 @@ module Aws::SSM
|
|
10984
10981
|
# @return [Integer]
|
10985
10982
|
#
|
10986
10983
|
# @!attribute [rw] failed_steps
|
10987
|
-
# The total number of steps that failed to
|
10988
|
-
#
|
10984
|
+
# The total number of steps that failed to run in all specified AWS
|
10985
|
+
# Regions and accounts for the current Automation execution.
|
10989
10986
|
# @return [Integer]
|
10990
10987
|
#
|
10991
10988
|
# @!attribute [rw] cancelled_steps
|
@@ -11541,7 +11538,7 @@ module Aws::SSM
|
|
11541
11538
|
# @return [Array<Types::Target>]
|
11542
11539
|
#
|
11543
11540
|
# @!attribute [rw] task_arn
|
11544
|
-
# The ARN of the task to
|
11541
|
+
# The ARN of the task to run.
|
11545
11542
|
# @return [String]
|
11546
11543
|
#
|
11547
11544
|
# @!attribute [rw] service_role_arn
|
@@ -11570,8 +11567,7 @@ module Aws::SSM
|
|
11570
11567
|
# @return [String]
|
11571
11568
|
#
|
11572
11569
|
# @!attribute [rw] task_parameters
|
11573
|
-
# The parameters that should be passed to the task when it is
|
11574
|
-
# executed.
|
11570
|
+
# The parameters that should be passed to the task when it is run.
|
11575
11571
|
#
|
11576
11572
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
11577
11573
|
# to a task when it runs, instead use the `Parameters` option in the
|
@@ -12147,7 +12143,7 @@ module Aws::SSM
|
|
12147
12143
|
# }
|
12148
12144
|
#
|
12149
12145
|
# @!attribute [rw] instance_ids
|
12150
|
-
# The instance IDs where the command should
|
12146
|
+
# The instance IDs where the command should run. You can specify a
|
12151
12147
|
# maximum of 50 IDs. If you prefer not to list individual instance
|
12152
12148
|
# IDs, you can instead send commands to a fleet of instances using the
|
12153
12149
|
# Targets parameter, which accepts EC2 tags. For more information
|
@@ -12172,16 +12168,16 @@ module Aws::SSM
|
|
12172
12168
|
# @return [Array<Types::Target>]
|
12173
12169
|
#
|
12174
12170
|
# @!attribute [rw] document_name
|
12175
|
-
# Required. The name of the Systems Manager document to
|
12176
|
-
#
|
12171
|
+
# Required. The name of the Systems Manager document to run. This can
|
12172
|
+
# be a public document or a custom document.
|
12177
12173
|
# @return [String]
|
12178
12174
|
#
|
12179
12175
|
# @!attribute [rw] document_version
|
12180
12176
|
# The SSM document version to use in the request. You can specify
|
12181
|
-
# $DEFAULT, $LATEST, or a specific version number. If you
|
12182
|
-
#
|
12183
|
-
#
|
12184
|
-
#
|
12177
|
+
# $DEFAULT, $LATEST, or a specific version number. If you run commands
|
12178
|
+
# by using the AWS CLI, then you must escape the first two options by
|
12179
|
+
# using a backslash. If you specify a version number, then you don't
|
12180
|
+
# need to use the backslash. For example:
|
12185
12181
|
#
|
12186
12182
|
# --document-version "\\$DEFAULT"
|
12187
12183
|
#
|
@@ -12209,7 +12205,7 @@ module Aws::SSM
|
|
12209
12205
|
#
|
12210
12206
|
# @!attribute [rw] timeout_seconds
|
12211
12207
|
# If this time is reached and the command has not already started
|
12212
|
-
#
|
12208
|
+
# running, it will not run.
|
12213
12209
|
# @return [Integer]
|
12214
12210
|
#
|
12215
12211
|
# @!attribute [rw] comment
|
@@ -12219,7 +12215,7 @@ module Aws::SSM
|
|
12219
12215
|
#
|
12220
12216
|
# @!attribute [rw] parameters
|
12221
12217
|
# The required and optional parameters specified in the document being
|
12222
|
-
#
|
12218
|
+
# run.
|
12223
12219
|
# @return [Hash<String,Array<String>>]
|
12224
12220
|
#
|
12225
12221
|
# @!attribute [rw] output_s3_region
|
@@ -12239,9 +12235,9 @@ module Aws::SSM
|
|
12239
12235
|
# @return [String]
|
12240
12236
|
#
|
12241
12237
|
# @!attribute [rw] max_concurrency
|
12242
|
-
# (Optional) The maximum number of instances that are allowed to
|
12243
|
-
#
|
12244
|
-
#
|
12238
|
+
# (Optional) The maximum number of instances that are allowed to run
|
12239
|
+
# the command at the same time. You can specify a number such as 10 or
|
12240
|
+
# a percentage such as 10%. The default value is 50. For more
|
12245
12241
|
# information about how to use MaxConcurrency, see [Using Concurrency
|
12246
12242
|
# Controls][1] in the *AWS Systems Manager User Guide*.
|
12247
12243
|
#
|
@@ -12566,8 +12562,8 @@ module Aws::SSM
|
|
12566
12562
|
# }
|
12567
12563
|
#
|
12568
12564
|
# @!attribute [rw] association_ids
|
12569
|
-
# The association IDs that you want to
|
12570
|
-
#
|
12565
|
+
# The association IDs that you want to run immediately and only one
|
12566
|
+
# time.
|
12571
12567
|
# @return [Array<String>]
|
12572
12568
|
#
|
12573
12569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAssociationsOnceRequest AWS API Documentation
|
@@ -12682,10 +12678,10 @@ module Aws::SSM
|
|
12682
12678
|
#
|
12683
12679
|
# @!attribute [rw] target_locations
|
12684
12680
|
# A location is a combination of AWS Regions and/or AWS accounts where
|
12685
|
-
# you want to
|
12681
|
+
# you want to run the Automation. Use this action to start an
|
12686
12682
|
# Automation in multiple Regions and multiple accounts. For more
|
12687
|
-
# information, see [
|
12688
|
-
#
|
12683
|
+
# information, see [Executing Automations in Multiple AWS Regions and
|
12684
|
+
# Accounts][1] in the *AWS Systems Manager User Guide*.
|
12689
12685
|
#
|
12690
12686
|
#
|
12691
12687
|
#
|
@@ -12864,8 +12860,7 @@ module Aws::SSM
|
|
12864
12860
|
# @return [String]
|
12865
12861
|
#
|
12866
12862
|
# @!attribute [rw] overridden_parameters
|
12867
|
-
# A user-specified list of parameters to override when
|
12868
|
-
# step.
|
12863
|
+
# A user-specified list of parameters to override when running a step.
|
12869
12864
|
# @return [Hash<String,Array<String>>]
|
12870
12865
|
#
|
12871
12866
|
# @!attribute [rw] is_end
|
@@ -12885,8 +12880,8 @@ module Aws::SSM
|
|
12885
12880
|
# @!attribute [rw] valid_next_steps
|
12886
12881
|
# Strategies used when step fails, we support Continue and Abort.
|
12887
12882
|
# Abort will fail the automation when the step fails. Continue will
|
12888
|
-
# ignore the failure of current step and allow automation to
|
12889
|
-
#
|
12883
|
+
# ignore the failure of current step and allow automation to run the
|
12884
|
+
# next step. With conditional branching, we add step:stepName to
|
12890
12885
|
# support the automation to go to another specific step.
|
12891
12886
|
# @return [Array<String>]
|
12892
12887
|
#
|
@@ -13041,8 +13036,8 @@ module Aws::SSM
|
|
13041
13036
|
#
|
13042
13037
|
# @!attribute [rw] values
|
13043
13038
|
# User-defined criteria that maps to Key. For example, if you
|
13044
|
-
# specified tag:ServerRole, you could specify value:WebServer to
|
13045
|
-
#
|
13039
|
+
# specified tag:ServerRole, you could specify value:WebServer to run a
|
13040
|
+
# command on instances that include Amazon EC2 tags of
|
13046
13041
|
# ServerRole,WebServer. For more information about how to send
|
13047
13042
|
# commands that target instances using Key,Value parameters, see
|
13048
13043
|
# [Sending Commands to a Fleet][1] in the *AWS Systems Manager User
|
@@ -13090,12 +13085,12 @@ module Aws::SSM
|
|
13090
13085
|
#
|
13091
13086
|
# @!attribute [rw] target_location_max_errors
|
13092
13087
|
# The maxium number of errors allowed before the system stops queueing
|
13093
|
-
# additional Automation executions for the currently
|
13088
|
+
# additional Automation executions for the currently running
|
13094
13089
|
# Automation.
|
13095
13090
|
# @return [String]
|
13096
13091
|
#
|
13097
13092
|
# @!attribute [rw] execution_role_name
|
13098
|
-
# The Automation execution role used by the currently
|
13093
|
+
# The Automation execution role used by the currently running
|
13099
13094
|
# Automation.
|
13100
13095
|
# @return [String]
|
13101
13096
|
#
|
@@ -13197,8 +13192,8 @@ module Aws::SSM
|
|
13197
13192
|
#
|
13198
13193
|
# @!attribute [rw] name
|
13199
13194
|
# The name of the SSM document that contains the configuration
|
13200
|
-
# information for the instance. You can specify Command
|
13201
|
-
#
|
13195
|
+
# information for the instance. You can specify Command or Automation
|
13196
|
+
# documents.
|
13202
13197
|
#
|
13203
13198
|
# You can specify AWS-predefined documents, documents you created, or
|
13204
13199
|
# a document that is shared with you from another account.
|
@@ -13263,8 +13258,8 @@ module Aws::SSM
|
|
13263
13258
|
# of the target set, for example 10%. The default value is 100%, which
|
13264
13259
|
# means all targets run the association at the same time.
|
13265
13260
|
#
|
13266
|
-
# If a new instance starts and attempts to
|
13267
|
-
#
|
13261
|
+
# If a new instance starts and attempts to run an association while
|
13262
|
+
# Systems Manager is running MaxConcurrency associations, the
|
13268
13263
|
# association is allowed to run. During the next association interval,
|
13269
13264
|
# the new instance will process its association within the limit
|
13270
13265
|
# specified for MaxConcurrency.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-ssm
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.42.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-04-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|