aws-sdk-ssm 1.124.0 → 1.128.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm/client.rb +292 -246
- data/lib/aws-sdk-ssm/client_api.rb +13 -0
- data/lib/aws-sdk-ssm/types.rb +535 -483
- data/lib/aws-sdk-ssm.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -35,7 +35,7 @@ module Aws::SSM
|
|
35
35
|
# machines (VMs) with Amazon Web Services so that you can configure
|
36
36
|
# those servers or VMs using Run Command. A server or VM that has been
|
37
37
|
# registered with Amazon Web Services Systems Manager is called a
|
38
|
-
# managed
|
38
|
+
# managed node.
|
39
39
|
#
|
40
40
|
# @!attribute [rw] activation_id
|
41
41
|
# The ID created by Systems Manager when you submitted the activation.
|
@@ -46,27 +46,26 @@ module Aws::SSM
|
|
46
46
|
# @return [String]
|
47
47
|
#
|
48
48
|
# @!attribute [rw] default_instance_name
|
49
|
-
# A name for the managed
|
49
|
+
# A name for the managed node when it is created.
|
50
50
|
# @return [String]
|
51
51
|
#
|
52
52
|
# @!attribute [rw] iam_role
|
53
53
|
# The Identity and Access Management (IAM) role to assign to the
|
54
|
-
# managed
|
54
|
+
# managed node.
|
55
55
|
# @return [String]
|
56
56
|
#
|
57
57
|
# @!attribute [rw] registration_limit
|
58
|
-
# The maximum number of managed
|
58
|
+
# The maximum number of managed nodes that can be registered using
|
59
59
|
# this activation.
|
60
60
|
# @return [Integer]
|
61
61
|
#
|
62
62
|
# @!attribute [rw] registrations_count
|
63
|
-
# The number of managed
|
64
|
-
# activation.
|
63
|
+
# The number of managed nodes already registered with this activation.
|
65
64
|
# @return [Integer]
|
66
65
|
#
|
67
66
|
# @!attribute [rw] expiration_date
|
68
67
|
# The date when this activation can no longer be used to register
|
69
|
-
# managed
|
68
|
+
# managed nodes.
|
70
69
|
# @return [Time]
|
71
70
|
#
|
72
71
|
# @!attribute [rw] expired
|
@@ -116,9 +115,8 @@ module Aws::SSM
|
|
116
115
|
# Specifies the type of resource you are tagging.
|
117
116
|
#
|
118
117
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is for on-premises
|
119
|
-
# managed
|
120
|
-
#
|
121
|
-
# `mi-1a2b3c4d5e6f`.
|
118
|
+
# managed nodes. You must specify the name of the managed node in the
|
119
|
+
# following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.
|
122
120
|
#
|
123
121
|
# </note>
|
124
122
|
# @return [String]
|
@@ -147,9 +145,9 @@ module Aws::SSM
|
|
147
145
|
# `ManagedInstance`\: `mi-012345abcde`
|
148
146
|
#
|
149
147
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
150
|
-
# on-premises managed
|
151
|
-
#
|
152
|
-
#
|
148
|
+
# on-premises managed nodes. You must specify the name of the managed
|
149
|
+
# node in the following format: `mi-ID_number `. For example,
|
150
|
+
# `mi-1a2b3c4d5e6f`.
|
153
151
|
#
|
154
152
|
# </note>
|
155
153
|
# @return [String]
|
@@ -247,7 +245,7 @@ module Aws::SSM
|
|
247
245
|
include Aws::Structure
|
248
246
|
end
|
249
247
|
|
250
|
-
# You must disassociate a document from all
|
248
|
+
# You must disassociate a document from all managed nodes before you can
|
251
249
|
# delete it.
|
252
250
|
#
|
253
251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociatedInstances AWS API Documentation
|
@@ -255,14 +253,14 @@ module Aws::SSM
|
|
255
253
|
class AssociatedInstances < Aws::EmptyStructure; end
|
256
254
|
|
257
255
|
# Describes an association of a Amazon Web Services Systems Manager
|
258
|
-
# document (SSM document) and
|
256
|
+
# document (SSM document) and a managed node.
|
259
257
|
#
|
260
258
|
# @!attribute [rw] name
|
261
259
|
# The name of the SSM document.
|
262
260
|
# @return [String]
|
263
261
|
#
|
264
262
|
# @!attribute [rw] instance_id
|
265
|
-
# The
|
263
|
+
# The managed node ID.
|
266
264
|
# @return [String]
|
267
265
|
#
|
268
266
|
# @!attribute [rw] association_id
|
@@ -277,12 +275,20 @@ module Aws::SSM
|
|
277
275
|
#
|
278
276
|
# @!attribute [rw] document_version
|
279
277
|
# The version of the document used in the association.
|
278
|
+
#
|
279
|
+
# State Manager doesn't support running associations that use a new
|
280
|
+
# version of a document if that document is shared from another
|
281
|
+
# account. State Manager always runs the `default` version of a
|
282
|
+
# document if shared from another account, even though the Systems
|
283
|
+
# Manager console shows that a new version was processed. If you want
|
284
|
+
# to run an association using a new version of a document shared form
|
285
|
+
# another account, you must set the document version to `default`.
|
280
286
|
# @return [String]
|
281
287
|
#
|
282
288
|
# @!attribute [rw] targets
|
283
|
-
# The
|
284
|
-
# can target all
|
285
|
-
# specifying the `InstanceIds` key with a value of `*`.
|
289
|
+
# The managed nodes targeted by the request to create an association.
|
290
|
+
# You can target all managed nodes in an Amazon Web Services account
|
291
|
+
# by specifying the `InstanceIds` key with a value of `*`.
|
286
292
|
# @return [Array<Types::Target>]
|
287
293
|
#
|
288
294
|
# @!attribute [rw] last_execution_date
|
@@ -332,7 +338,7 @@ module Aws::SSM
|
|
332
338
|
# @return [String]
|
333
339
|
#
|
334
340
|
# @!attribute [rw] instance_id
|
335
|
-
# The
|
341
|
+
# The managed node ID.
|
336
342
|
# @return [String]
|
337
343
|
#
|
338
344
|
# @!attribute [rw] association_version
|
@@ -375,7 +381,7 @@ module Aws::SSM
|
|
375
381
|
# @return [String]
|
376
382
|
#
|
377
383
|
# @!attribute [rw] targets
|
378
|
-
# The
|
384
|
+
# The managed nodes targeted by the request.
|
379
385
|
# @return [Array<Types::Target>]
|
380
386
|
#
|
381
387
|
# @!attribute [rw] schedule_expression
|
@@ -408,7 +414,7 @@ module Aws::SSM
|
|
408
414
|
# for example, the system stops sending requests when the fourth error
|
409
415
|
# is received. If you specify 0, then the system stops sending
|
410
416
|
# requests after the first error is returned. If you run an
|
411
|
-
# association on 50
|
417
|
+
# association on 50 managed nodes and set `MaxError` to 10%, then the
|
412
418
|
# system stops sending the request when the sixth error is received.
|
413
419
|
#
|
414
420
|
# Executions that are already running an association when `MaxErrors`
|
@@ -424,10 +430,10 @@ module Aws::SSM
|
|
424
430
|
# of the target set, for example 10%. The default value is 100%, which
|
425
431
|
# means all targets run the association at the same time.
|
426
432
|
#
|
427
|
-
# If a new
|
428
|
-
# Systems Manager is running `MaxConcurrency` associations, the
|
433
|
+
# If a new managed node starts and attempts to run an association
|
434
|
+
# while Systems Manager is running `MaxConcurrency` associations, the
|
429
435
|
# association is allowed to run. During the next association interval,
|
430
|
-
# the new
|
436
|
+
# the new managed node will process its association within the limit
|
431
437
|
# specified for `MaxConcurrency`.
|
432
438
|
# @return [String]
|
433
439
|
#
|
@@ -632,12 +638,12 @@ module Aws::SSM
|
|
632
638
|
# @return [String]
|
633
639
|
#
|
634
640
|
# @!attribute [rw] resource_id
|
635
|
-
# The resource ID, for example, the
|
636
|
-
# ran.
|
641
|
+
# The resource ID, for example, the managed node ID where the
|
642
|
+
# association ran.
|
637
643
|
# @return [String]
|
638
644
|
#
|
639
645
|
# @!attribute [rw] resource_type
|
640
|
-
# The resource type, for example,
|
646
|
+
# The resource type, for example, EC2.
|
641
647
|
# @return [String]
|
642
648
|
#
|
643
649
|
# @!attribute [rw] status
|
@@ -749,9 +755,9 @@ module Aws::SSM
|
|
749
755
|
#
|
750
756
|
# @!attribute [rw] association_status_aggregated_count
|
751
757
|
# Returns the number of targets for the association status. For
|
752
|
-
# example, if you created an association with two
|
753
|
-
# of them was successful, this would return the count of
|
754
|
-
# status.
|
758
|
+
# example, if you created an association with two managed nodes, and
|
759
|
+
# one of them was successful, this would return the count of managed
|
760
|
+
# nodes by status.
|
755
761
|
# @return [Hash<String,Integer>]
|
756
762
|
#
|
757
763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationOverview AWS API Documentation
|
@@ -858,7 +864,7 @@ module Aws::SSM
|
|
858
864
|
# for example, the system stops sending requests when the fourth error
|
859
865
|
# is received. If you specify 0, then the system stops sending
|
860
866
|
# requests after the first error is returned. If you run an
|
861
|
-
# association on 50
|
867
|
+
# association on 50 managed nodes and set `MaxError` to 10%, then the
|
862
868
|
# system stops sending the request when the sixth error is received.
|
863
869
|
#
|
864
870
|
# Executions that are already running an association when `MaxErrors`
|
@@ -874,10 +880,10 @@ module Aws::SSM
|
|
874
880
|
# of the target set, for example 10%. The default value is 100%, which
|
875
881
|
# means all targets run the association at the same time.
|
876
882
|
#
|
877
|
-
# If a new
|
878
|
-
# Systems Manager is running `MaxConcurrency` associations, the
|
883
|
+
# If a new managed node starts and attempts to run an association
|
884
|
+
# while Systems Manager is running `MaxConcurrency` associations, the
|
879
885
|
# association is allowed to run. During the next association interval,
|
880
|
-
# the new
|
886
|
+
# the new managed node will process its association within the limit
|
881
887
|
# specified for `MaxConcurrency`.
|
882
888
|
# @return [String]
|
883
889
|
#
|
@@ -1650,14 +1656,14 @@ module Aws::SSM
|
|
1650
1656
|
#
|
1651
1657
|
# @!attribute [rw] approved_patches_enable_non_security
|
1652
1658
|
# Indicates whether the list of approved patches includes non-security
|
1653
|
-
# updates that should be applied to the
|
1654
|
-
# is `false`. Applies to Linux
|
1659
|
+
# updates that should be applied to the managed nodes. The default
|
1660
|
+
# value is `false`. Applies to Linux managed nodes only.
|
1655
1661
|
# @return [Boolean]
|
1656
1662
|
#
|
1657
1663
|
# @!attribute [rw] sources
|
1658
|
-
# Information about the patches to use to update the
|
1664
|
+
# Information about the patches to use to update the managed nodes,
|
1659
1665
|
# including target operating systems and source repositories. Applies
|
1660
|
-
# to Linux
|
1666
|
+
# to Linux managed nodes only.
|
1661
1667
|
# @return [Array<Types::PatchSource>]
|
1662
1668
|
#
|
1663
1669
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/BaselineOverride AWS API Documentation
|
@@ -1689,8 +1695,8 @@ module Aws::SSM
|
|
1689
1695
|
# @return [String]
|
1690
1696
|
#
|
1691
1697
|
# @!attribute [rw] instance_ids
|
1692
|
-
# (Optional) A list of
|
1693
|
-
# command. If not provided, the command is canceled on every
|
1698
|
+
# (Optional) A list of managed node IDs on which you want to cancel
|
1699
|
+
# the command. If not provided, the command is canceled on every node
|
1694
1700
|
# on which it was requested.
|
1695
1701
|
# @return [Array<String>]
|
1696
1702
|
#
|
@@ -1805,13 +1811,13 @@ module Aws::SSM
|
|
1805
1811
|
# @return [Hash<String,Array<String>>]
|
1806
1812
|
#
|
1807
1813
|
# @!attribute [rw] instance_ids
|
1808
|
-
# The
|
1814
|
+
# The managed node IDs against which this command was requested.
|
1809
1815
|
# @return [Array<String>]
|
1810
1816
|
#
|
1811
1817
|
# @!attribute [rw] targets
|
1812
|
-
# An array of search criteria that targets
|
1813
|
-
# combination that you specify. Targets is required if you
|
1814
|
-
# provide one or more
|
1818
|
+
# An array of search criteria that targets managed nodes using a
|
1819
|
+
# Key,Value combination that you specify. Targets is required if you
|
1820
|
+
# don't provide one or more managed node IDs in the call.
|
1815
1821
|
# @return [Array<Types::Target>]
|
1816
1822
|
#
|
1817
1823
|
# @!attribute [rw] requested_date_time
|
@@ -1831,10 +1837,10 @@ module Aws::SSM
|
|
1831
1837
|
# Services Systems Manager User Guide*. StatusDetails can be one of
|
1832
1838
|
# the following values:
|
1833
1839
|
#
|
1834
|
-
# * Pending: The command hasn't been sent to any
|
1840
|
+
# * Pending: The command hasn't been sent to any managed nodes.
|
1835
1841
|
#
|
1836
|
-
# * In Progress: The command has been sent to at least one
|
1837
|
-
# but hasn't reached a final state on all
|
1842
|
+
# * In Progress: The command has been sent to at least one managed
|
1843
|
+
# node but hasn't reached a final state on all managed nodes.
|
1838
1844
|
#
|
1839
1845
|
# * Success: The command successfully ran on all invocations. This is
|
1840
1846
|
# a terminal state.
|
@@ -1850,18 +1856,18 @@ module Aws::SSM
|
|
1850
1856
|
# * Failed: The value of MaxErrors or more command invocations shows a
|
1851
1857
|
# status of Failed. This is a terminal state.
|
1852
1858
|
#
|
1853
|
-
# * Incomplete: The command was attempted on all
|
1854
|
-
# more invocations doesn't have a value of Success but not
|
1855
|
-
# invocations failed for the status to be Failed. This is a
|
1856
|
-
# state.
|
1859
|
+
# * Incomplete: The command was attempted on all managed nodes and one
|
1860
|
+
# or more invocations doesn't have a value of Success but not
|
1861
|
+
# enough invocations failed for the status to be Failed. This is a
|
1862
|
+
# terminal state.
|
1857
1863
|
#
|
1858
|
-
# *
|
1859
|
-
# is a terminal state.
|
1864
|
+
# * Cancelled: The command was terminated before it was completed.
|
1865
|
+
# This is a terminal state.
|
1860
1866
|
#
|
1861
|
-
# * Rate Exceeded: The number of
|
1867
|
+
# * Rate Exceeded: The number of managed nodes targeted by the command
|
1862
1868
|
# exceeded the account limit for pending invocations. The system has
|
1863
|
-
# canceled the command before running it on any
|
1864
|
-
# terminal state.
|
1869
|
+
# canceled the command before running it on any managed node. This
|
1870
|
+
# is a terminal state.
|
1865
1871
|
#
|
1866
1872
|
#
|
1867
1873
|
#
|
@@ -1886,12 +1892,12 @@ module Aws::SSM
|
|
1886
1892
|
# @return [String]
|
1887
1893
|
#
|
1888
1894
|
# @!attribute [rw] max_concurrency
|
1889
|
-
# The maximum number of
|
1890
|
-
# at the same time. You can specify a number of
|
1891
|
-
# or a percentage of
|
1892
|
-
# For more information about how to use `MaxConcurrency`, see
|
1893
|
-
# commands using Systems Manager Run Command][1] in the
|
1894
|
-
# Services Systems Manager User Guide*.
|
1895
|
+
# The maximum number of managed nodes that are allowed to run the
|
1896
|
+
# command at the same time. You can specify a number of managed nodes,
|
1897
|
+
# such as 10, or a percentage of nodes, such as 10%. The default value
|
1898
|
+
# is 50. For more information about how to use `MaxConcurrency`, see
|
1899
|
+
# [Running commands using Systems Manager Run Command][1] in the
|
1900
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
1895
1901
|
#
|
1896
1902
|
#
|
1897
1903
|
#
|
@@ -1918,7 +1924,7 @@ module Aws::SSM
|
|
1918
1924
|
# @!attribute [rw] completed_count
|
1919
1925
|
# The number of targets for which the command invocation reached a
|
1920
1926
|
# terminal state. Terminal states include the following: Success,
|
1921
|
-
# Failed, Execution Timed Out, Delivery Timed Out,
|
1927
|
+
# Failed, Execution Timed Out, Delivery Timed Out, Cancelled,
|
1922
1928
|
# Terminated, or Undeliverable.
|
1923
1929
|
# @return [Integer]
|
1924
1930
|
#
|
@@ -1985,8 +1991,8 @@ module Aws::SSM
|
|
1985
1991
|
|
1986
1992
|
# Describes a command filter.
|
1987
1993
|
#
|
1988
|
-
# <note markdown="1">
|
1989
|
-
# because the command hasn't run on the
|
1994
|
+
# <note markdown="1"> A managed node ID can't be specified when a command status is
|
1995
|
+
# `Pending` because the command hasn't run on the node yet.
|
1990
1996
|
#
|
1991
1997
|
# </note>
|
1992
1998
|
#
|
@@ -2081,7 +2087,7 @@ module Aws::SSM
|
|
2081
2087
|
# Manager document (SSM document) for which you want to see command
|
2082
2088
|
# execution results. For example, specify `AWS-RunPatchBaseline` to
|
2083
2089
|
# see command executions that used this SSM document to perform
|
2084
|
-
# security patching operations on
|
2090
|
+
# security patching operations on managed nodes.
|
2085
2091
|
#
|
2086
2092
|
# * **ExecutionStage**\: Specify one of the following values
|
2087
2093
|
# (`ListCommands` operations only):
|
@@ -2102,23 +2108,23 @@ module Aws::SSM
|
|
2102
2108
|
include Aws::Structure
|
2103
2109
|
end
|
2104
2110
|
|
2105
|
-
# An invocation is copy of a command sent to a specific
|
2106
|
-
# command can apply to one or more
|
2107
|
-
# applies to one
|
2108
|
-
# against three
|
2109
|
-
# requested
|
2110
|
-
# information about a command you ran.
|
2111
|
+
# An invocation is a copy of a command sent to a specific managed node.
|
2112
|
+
# A command can apply to one or more managed nodes. A command invocation
|
2113
|
+
# applies to one managed node. For example, if a user runs `SendCommand`
|
2114
|
+
# against three managed nodes, then a command invocation is created for
|
2115
|
+
# each requested managed node ID. A command invocation returns status
|
2116
|
+
# and detail information about a command you ran.
|
2111
2117
|
#
|
2112
2118
|
# @!attribute [rw] command_id
|
2113
2119
|
# The command against which this invocation was requested.
|
2114
2120
|
# @return [String]
|
2115
2121
|
#
|
2116
2122
|
# @!attribute [rw] instance_id
|
2117
|
-
# The
|
2123
|
+
# The managed node ID in which this invocation was requested.
|
2118
2124
|
# @return [String]
|
2119
2125
|
#
|
2120
2126
|
# @!attribute [rw] instance_name
|
2121
|
-
# The fully qualified host name of the managed
|
2127
|
+
# The fully qualified host name of the managed node.
|
2122
2128
|
# @return [String]
|
2123
2129
|
#
|
2124
2130
|
# @!attribute [rw] comment
|
@@ -2135,7 +2141,7 @@ module Aws::SSM
|
|
2135
2141
|
# @return [String]
|
2136
2142
|
#
|
2137
2143
|
# @!attribute [rw] requested_date_time
|
2138
|
-
# The time and date the request was sent to this
|
2144
|
+
# The time and date the request was sent to this managed node.
|
2139
2145
|
# @return [Time]
|
2140
2146
|
#
|
2141
2147
|
# @!attribute [rw] status
|
@@ -2144,7 +2150,7 @@ module Aws::SSM
|
|
2144
2150
|
#
|
2145
2151
|
# @!attribute [rw] status_details
|
2146
2152
|
# A detailed status of the command execution for each invocation (each
|
2147
|
-
#
|
2153
|
+
# managed node targeted by the command). StatusDetails includes more
|
2148
2154
|
# information than Status because it includes states resulting from
|
2149
2155
|
# error and concurrency control parameters. StatusDetails can show
|
2150
2156
|
# different results than Status. For more information about these
|
@@ -2152,36 +2158,36 @@ module Aws::SSM
|
|
2152
2158
|
# Services Systems Manager User Guide*. StatusDetails can be one of
|
2153
2159
|
# the following values:
|
2154
2160
|
#
|
2155
|
-
# * Pending: The command hasn't been sent to the
|
2161
|
+
# * Pending: The command hasn't been sent to the managed node.
|
2156
2162
|
#
|
2157
|
-
# * In Progress: The command has been sent to the
|
2158
|
-
# reached a terminal state.
|
2163
|
+
# * In Progress: The command has been sent to the managed node but
|
2164
|
+
# hasn't reached a terminal state.
|
2159
2165
|
#
|
2160
2166
|
# * Success: The execution of the command or plugin was successfully
|
2161
2167
|
# completed. This is a terminal state.
|
2162
2168
|
#
|
2163
|
-
# * Delivery Timed Out: The command wasn't delivered to the
|
2164
|
-
# before the delivery timeout expired. Delivery timeouts don't
|
2169
|
+
# * Delivery Timed Out: The command wasn't delivered to the managed
|
2170
|
+
# node before the delivery timeout expired. Delivery timeouts don't
|
2165
2171
|
# count against the parent command's `MaxErrors` limit, but they do
|
2166
2172
|
# contribute to whether the parent command status is Success or
|
2167
2173
|
# Incomplete. This is a terminal state.
|
2168
2174
|
#
|
2169
|
-
# * Execution Timed Out: Command execution started on the
|
2170
|
-
# but the execution wasn't complete before the execution
|
2171
|
-
# expired. Execution timeouts count against the `MaxErrors`
|
2172
|
-
# the parent command. This is a terminal state.
|
2175
|
+
# * Execution Timed Out: Command execution started on the managed
|
2176
|
+
# node, but the execution wasn't complete before the execution
|
2177
|
+
# timeout expired. Execution timeouts count against the `MaxErrors`
|
2178
|
+
# limit of the parent command. This is a terminal state.
|
2173
2179
|
#
|
2174
|
-
# * Failed: The command wasn't successful on the
|
2180
|
+
# * Failed: The command wasn't successful on the managed node. For a
|
2175
2181
|
# plugin, this indicates that the result code wasn't zero. For a
|
2176
2182
|
# command invocation, this indicates that the result code for one or
|
2177
2183
|
# more plugins wasn't zero. Invocation failures count against the
|
2178
2184
|
# `MaxErrors` limit of the parent command. This is a terminal state.
|
2179
2185
|
#
|
2180
|
-
# *
|
2181
|
-
# is a terminal state.
|
2186
|
+
# * Cancelled: The command was terminated before it was completed.
|
2187
|
+
# This is a terminal state.
|
2182
2188
|
#
|
2183
|
-
# * Undeliverable: The command can't be delivered to the
|
2184
|
-
# The
|
2189
|
+
# * Undeliverable: The command can't be delivered to the managed
|
2190
|
+
# node. The managed node might not exist or might not be responding.
|
2185
2191
|
# Undeliverable invocations don't count against the parent
|
2186
2192
|
# command's MaxErrors limit and don't contribute to whether the
|
2187
2193
|
# parent command status is Success or Incomplete. This is a terminal
|
@@ -2224,12 +2230,12 @@ module Aws::SSM
|
|
2224
2230
|
# The Identity and Access Management (IAM) service role that Run
|
2225
2231
|
# Command, a capability of Amazon Web Services Systems Manager, uses
|
2226
2232
|
# to act on your behalf when sending notifications about command
|
2227
|
-
# status changes on a per
|
2233
|
+
# status changes on a per managed node basis.
|
2228
2234
|
# @return [String]
|
2229
2235
|
#
|
2230
2236
|
# @!attribute [rw] notification_config
|
2231
2237
|
# Configurations for sending notifications about command status
|
2232
|
-
# changes on a per
|
2238
|
+
# changes on a per managed node basis.
|
2233
2239
|
# @return [Types::NotificationConfig]
|
2234
2240
|
#
|
2235
2241
|
# @!attribute [rw] cloud_watch_output_config
|
@@ -2283,40 +2289,40 @@ module Aws::SSM
|
|
2283
2289
|
# Services Systems Manager User Guide*. StatusDetails can be one of
|
2284
2290
|
# the following values:
|
2285
2291
|
#
|
2286
|
-
# * Pending: The command hasn't been sent to the
|
2292
|
+
# * Pending: The command hasn't been sent to the managed node.
|
2287
2293
|
#
|
2288
|
-
# * In Progress: The command has been sent to the
|
2289
|
-
# reached a terminal state.
|
2294
|
+
# * In Progress: The command has been sent to the managed node but
|
2295
|
+
# hasn't reached a terminal state.
|
2290
2296
|
#
|
2291
2297
|
# * Success: The execution of the command or plugin was successfully
|
2292
2298
|
# completed. This is a terminal state.
|
2293
2299
|
#
|
2294
|
-
# * Delivery Timed Out: The command wasn't delivered to the
|
2295
|
-
# before the delivery timeout expired. Delivery timeouts don't
|
2300
|
+
# * Delivery Timed Out: The command wasn't delivered to the managed
|
2301
|
+
# node before the delivery timeout expired. Delivery timeouts don't
|
2296
2302
|
# count against the parent command's `MaxErrors` limit, but they do
|
2297
2303
|
# contribute to whether the parent command status is Success or
|
2298
2304
|
# Incomplete. This is a terminal state.
|
2299
2305
|
#
|
2300
|
-
# * Execution Timed Out: Command execution started on the
|
2301
|
-
# but the execution wasn't complete before the execution
|
2302
|
-
# expired. Execution timeouts count against the `MaxErrors`
|
2303
|
-
# the parent command. This is a terminal state.
|
2306
|
+
# * Execution Timed Out: Command execution started on the managed
|
2307
|
+
# node, but the execution wasn't complete before the execution
|
2308
|
+
# timeout expired. Execution timeouts count against the `MaxErrors`
|
2309
|
+
# limit of the parent command. This is a terminal state.
|
2304
2310
|
#
|
2305
|
-
# * Failed: The command wasn't successful on the
|
2311
|
+
# * Failed: The command wasn't successful on the managed node. For a
|
2306
2312
|
# plugin, this indicates that the result code wasn't zero. For a
|
2307
2313
|
# command invocation, this indicates that the result code for one or
|
2308
2314
|
# more plugins wasn't zero. Invocation failures count against the
|
2309
2315
|
# MaxErrors limit of the parent command. This is a terminal state.
|
2310
2316
|
#
|
2311
|
-
# *
|
2312
|
-
# is a terminal state.
|
2317
|
+
# * Cancelled: The command was terminated before it was completed.
|
2318
|
+
# This is a terminal state.
|
2313
2319
|
#
|
2314
|
-
# * Undeliverable: The command can't be delivered to the
|
2315
|
-
# The
|
2316
|
-
# Undeliverable invocations don't count against the
|
2317
|
-
# command's MaxErrors limit, and they don't contribute to
|
2318
|
-
# the parent command status is Success or Incomplete. This
|
2319
|
-
# terminal state.
|
2320
|
+
# * Undeliverable: The command can't be delivered to the managed
|
2321
|
+
# node. The managed node might not exist, or it might not be
|
2322
|
+
# responding. Undeliverable invocations don't count against the
|
2323
|
+
# parent command's MaxErrors limit, and they don't contribute to
|
2324
|
+
# whether the parent command status is Success or Incomplete. This
|
2325
|
+
# is a terminal state.
|
2320
2326
|
#
|
2321
2327
|
# * Terminated: The parent command exceeded its MaxErrors limit and
|
2322
2328
|
# subsequent command invocations were canceled by the system. This
|
@@ -2373,7 +2379,7 @@ module Aws::SSM
|
|
2373
2379
|
# `ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix` is the name of the S3
|
2374
2380
|
# prefix;
|
2375
2381
|
#
|
2376
|
-
# `i-02573cafcfEXAMPLE` is the
|
2382
|
+
# `i-02573cafcfEXAMPLE` is the managed node ID;
|
2377
2383
|
#
|
2378
2384
|
# `awsrunShellScript` is the name of the plugin.
|
2379
2385
|
# @return [String]
|
@@ -2390,7 +2396,7 @@ module Aws::SSM
|
|
2390
2396
|
# `ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix` is the name of the S3
|
2391
2397
|
# prefix;
|
2392
2398
|
#
|
2393
|
-
# `i-02573cafcfEXAMPLE` is the
|
2399
|
+
# `i-02573cafcfEXAMPLE` is the managed node ID;
|
2394
2400
|
#
|
2395
2401
|
# `awsrunShellScript` is the name of the plugin.
|
2396
2402
|
# @return [String]
|
@@ -2470,8 +2476,7 @@ module Aws::SSM
|
|
2470
2476
|
# @return [String]
|
2471
2477
|
#
|
2472
2478
|
# @!attribute [rw] resource_id
|
2473
|
-
# An ID for the resource. For a managed
|
2474
|
-
# ID.
|
2479
|
+
# An ID for the resource. For a managed node, this is the node ID.
|
2475
2480
|
# @return [String]
|
2476
2481
|
#
|
2477
2482
|
# @!attribute [rw] id
|
@@ -2702,8 +2707,8 @@ module Aws::SSM
|
|
2702
2707
|
# @return [String]
|
2703
2708
|
#
|
2704
2709
|
# @!attribute [rw] default_instance_name
|
2705
|
-
# The name of the registered, managed
|
2706
|
-
#
|
2710
|
+
# The name of the registered, managed node as it will appear in the
|
2711
|
+
# Amazon Web Services Systems Manager console or when you use the
|
2707
2712
|
# Amazon Web Services command line tools to list Systems Manager
|
2708
2713
|
# resources.
|
2709
2714
|
#
|
@@ -2712,7 +2717,7 @@ module Aws::SSM
|
|
2712
2717
|
#
|
2713
2718
|
# @!attribute [rw] iam_role
|
2714
2719
|
# The name of the Identity and Access Management (IAM) role that you
|
2715
|
-
# want to assign to the managed
|
2720
|
+
# want to assign to the managed node. This IAM role must provide
|
2716
2721
|
# AssumeRole permissions for the Amazon Web Services Systems Manager
|
2717
2722
|
# service principal `ssm.amazonaws.com`. For more information, see
|
2718
2723
|
# [Create an IAM service role for a hybrid environment][1] in the
|
@@ -2724,8 +2729,8 @@ module Aws::SSM
|
|
2724
2729
|
# @return [String]
|
2725
2730
|
#
|
2726
2731
|
# @!attribute [rw] registration_limit
|
2727
|
-
# Specify the maximum number of managed
|
2728
|
-
#
|
2732
|
+
# Specify the maximum number of managed nodes you want to register.
|
2733
|
+
# The default value is `1`.
|
2729
2734
|
# @return [Integer]
|
2730
2735
|
#
|
2731
2736
|
# @!attribute [rw] expiration_date
|
@@ -2753,13 +2758,13 @@ module Aws::SSM
|
|
2753
2758
|
# applied to the on-premises servers or VMs.
|
2754
2759
|
#
|
2755
2760
|
# You can't add tags to or delete tags from an existing activation.
|
2756
|
-
# You can tag your on-premises servers and VMs after
|
2757
|
-
# Systems Manager for the first time and are assigned
|
2758
|
-
#
|
2759
|
-
# Systems Manager console with an ID that is prefixed with
|
2760
|
-
# For information about how to add tags to your managed
|
2761
|
-
# AddTagsToResource. For information about how to remove
|
2762
|
-
# your managed
|
2761
|
+
# You can tag your on-premises servers, edge devices, and VMs after
|
2762
|
+
# they connect to Systems Manager for the first time and are assigned
|
2763
|
+
# a managed node ID. This means they are listed in the Amazon Web
|
2764
|
+
# Services Systems Manager console with an ID that is prefixed with
|
2765
|
+
# "mi-". For information about how to add tags to your managed
|
2766
|
+
# nodes, see AddTagsToResource. For information about how to remove
|
2767
|
+
# tags from your managed nodes, see RemoveTagsFromResource.
|
2763
2768
|
# @return [Array<Types::Tag>]
|
2764
2769
|
#
|
2765
2770
|
# @!attribute [rw] registration_metadata
|
@@ -2860,7 +2865,7 @@ module Aws::SSM
|
|
2860
2865
|
end
|
2861
2866
|
|
2862
2867
|
# Describes the association of a Amazon Web Services Systems Manager
|
2863
|
-
# document (SSM document) and
|
2868
|
+
# document (SSM document) and a managed node.
|
2864
2869
|
#
|
2865
2870
|
# @note When making an API call, you may pass CreateAssociationBatchRequestEntry
|
2866
2871
|
# data as a hash:
|
@@ -2907,8 +2912,8 @@ module Aws::SSM
|
|
2907
2912
|
#
|
2908
2913
|
# @!attribute [rw] name
|
2909
2914
|
# The name of the SSM document that contains the configuration
|
2910
|
-
# information for the
|
2911
|
-
# runbooks.
|
2915
|
+
# information for the managed node. You can specify Command or
|
2916
|
+
# Automation runbooks.
|
2912
2917
|
#
|
2913
2918
|
# You can specify Amazon Web Services-predefined documents, documents
|
2914
2919
|
# you created, or a document that is shared with you from another
|
@@ -2930,11 +2935,11 @@ module Aws::SSM
|
|
2930
2935
|
# @return [String]
|
2931
2936
|
#
|
2932
2937
|
# @!attribute [rw] instance_id
|
2933
|
-
# The
|
2938
|
+
# The managed node ID.
|
2934
2939
|
#
|
2935
|
-
# <note markdown="1"> `InstanceId` has been deprecated. To specify
|
2936
|
-
# association, use the `Targets` parameter. Requests that include
|
2937
|
-
# parameter `InstanceID` with Systems Manager documents (SSM
|
2940
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify a managed node ID for
|
2941
|
+
# an association, use the `Targets` parameter. Requests that include
|
2942
|
+
# the parameter `InstanceID` with Systems Manager documents (SSM
|
2938
2943
|
# documents) that use schema version 2.0 or later will fail. In
|
2939
2944
|
# addition, if you use the parameter `InstanceId`, you can't use the
|
2940
2945
|
# parameters `AssociationName`, `DocumentVersion`, `MaxErrors`,
|
@@ -2960,7 +2965,7 @@ module Aws::SSM
|
|
2960
2965
|
# @return [String]
|
2961
2966
|
#
|
2962
2967
|
# @!attribute [rw] targets
|
2963
|
-
# The
|
2968
|
+
# The managed nodes targeted by the request.
|
2964
2969
|
# @return [Array<Types::Target>]
|
2965
2970
|
#
|
2966
2971
|
# @!attribute [rw] schedule_expression
|
@@ -2984,7 +2989,7 @@ module Aws::SSM
|
|
2984
2989
|
# for example, the system stops sending requests when the fourth error
|
2985
2990
|
# is received. If you specify 0, then the system stops sending
|
2986
2991
|
# requests after the first error is returned. If you run an
|
2987
|
-
# association on 50
|
2992
|
+
# association on 50 managed nodes and set `MaxError` to 10%, then the
|
2988
2993
|
# system stops sending the request when the sixth error is received.
|
2989
2994
|
#
|
2990
2995
|
# Executions that are already running an association when `MaxErrors`
|
@@ -3000,10 +3005,10 @@ module Aws::SSM
|
|
3000
3005
|
# of the target set, for example 10%. The default value is 100%, which
|
3001
3006
|
# means all targets run the association at the same time.
|
3002
3007
|
#
|
3003
|
-
# If a new
|
3004
|
-
# Systems Manager is running `MaxConcurrency` associations, the
|
3008
|
+
# If a new managed node starts and attempts to run an association
|
3009
|
+
# while Systems Manager is running `MaxConcurrency` associations, the
|
3005
3010
|
# association is allowed to run. During the next association interval,
|
3006
|
-
# the new
|
3011
|
+
# the new managed node will process its association within the limit
|
3007
3012
|
# specified for `MaxConcurrency`.
|
3008
3013
|
# @return [String]
|
3009
3014
|
#
|
@@ -3137,7 +3142,7 @@ module Aws::SSM
|
|
3137
3142
|
#
|
3138
3143
|
# @!attribute [rw] name
|
3139
3144
|
# The name of the SSM Command document or Automation runbook that
|
3140
|
-
# contains the configuration information for the
|
3145
|
+
# contains the configuration information for the managed node.
|
3141
3146
|
#
|
3142
3147
|
# You can specify Amazon Web Services-predefined documents, documents
|
3143
3148
|
# you created, or a document that is shared with you from another
|
@@ -3161,14 +3166,22 @@ module Aws::SSM
|
|
3161
3166
|
# @!attribute [rw] document_version
|
3162
3167
|
# The document version you want to associate with the target(s). Can
|
3163
3168
|
# be a specific version or the default version.
|
3169
|
+
#
|
3170
|
+
# State Manager doesn't support running associations that use a new
|
3171
|
+
# version of a document if that document is shared from another
|
3172
|
+
# account. State Manager always runs the `default` version of a
|
3173
|
+
# document if shared from another account, even though the Systems
|
3174
|
+
# Manager console shows that a new version was processed. If you want
|
3175
|
+
# to run an association using a new version of a document shared form
|
3176
|
+
# another account, you must set the document version to `default`.
|
3164
3177
|
# @return [String]
|
3165
3178
|
#
|
3166
3179
|
# @!attribute [rw] instance_id
|
3167
|
-
# The
|
3180
|
+
# The managed node ID.
|
3168
3181
|
#
|
3169
|
-
# <note markdown="1"> `InstanceId` has been deprecated. To specify
|
3170
|
-
# association, use the `Targets` parameter. Requests that include
|
3171
|
-
# parameter `InstanceID` with Systems Manager documents (SSM
|
3182
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify a managed node ID for
|
3183
|
+
# an association, use the `Targets` parameter. Requests that include
|
3184
|
+
# the parameter `InstanceID` with Systems Manager documents (SSM
|
3172
3185
|
# documents) that use schema version 2.0 or later will fail. In
|
3173
3186
|
# addition, if you use the parameter `InstanceId`, you can't use the
|
3174
3187
|
# parameters `AssociationName`, `DocumentVersion`, `MaxErrors`,
|
@@ -3183,14 +3196,14 @@ module Aws::SSM
|
|
3183
3196
|
# @return [Hash<String,Array<String>>]
|
3184
3197
|
#
|
3185
3198
|
# @!attribute [rw] targets
|
3186
|
-
# The targets for the association. You can target
|
3187
|
-
# tags, Amazon Web Services resource groups, all
|
3188
|
-
# Amazon Web Services account, or individual
|
3189
|
-
# target all
|
3190
|
-
# the `InstanceIds` key with a value of `*`. For more
|
3191
|
-
# about choosing targets for an association, see [Using
|
3192
|
-
# rate controls with State Manager associations][1] in the
|
3193
|
-
# Services Systems Manager User Guide*.
|
3199
|
+
# The targets for the association. You can target managed nodes by
|
3200
|
+
# using tags, Amazon Web Services resource groups, all managed nodes
|
3201
|
+
# in an Amazon Web Services account, or individual managed node IDs.
|
3202
|
+
# You can target all managed nodes in an Amazon Web Services account
|
3203
|
+
# by specifying the `InstanceIds` key with a value of `*`. For more
|
3204
|
+
# information about choosing targets for an association, see [Using
|
3205
|
+
# targets and rate controls with State Manager associations][1] in the
|
3206
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
3194
3207
|
#
|
3195
3208
|
#
|
3196
3209
|
#
|
@@ -3226,7 +3239,7 @@ module Aws::SSM
|
|
3226
3239
|
# for example, the system stops sending requests when the fourth error
|
3227
3240
|
# is received. If you specify 0, then the system stops sending
|
3228
3241
|
# requests after the first error is returned. If you run an
|
3229
|
-
# association on 50
|
3242
|
+
# association on 50 managed nodes and set `MaxError` to 10%, then the
|
3230
3243
|
# system stops sending the request when the sixth error is received.
|
3231
3244
|
#
|
3232
3245
|
# Executions that are already running an association when `MaxErrors`
|
@@ -3242,10 +3255,10 @@ module Aws::SSM
|
|
3242
3255
|
# of the target set, for example 10%. The default value is 100%, which
|
3243
3256
|
# means all targets run the association at the same time.
|
3244
3257
|
#
|
3245
|
-
# If a new
|
3246
|
-
# Systems Manager is running `MaxConcurrency` associations, the
|
3258
|
+
# If a new managed node starts and attempts to run an association
|
3259
|
+
# while Systems Manager is running `MaxConcurrency` associations, the
|
3247
3260
|
# association is allowed to run. During the next association interval,
|
3248
|
-
# the new
|
3261
|
+
# the new managed node will process its association within the limit
|
3249
3262
|
# specified for `MaxConcurrency`.
|
3250
3263
|
# @return [String]
|
3251
3264
|
#
|
@@ -3589,10 +3602,10 @@ module Aws::SSM
|
|
3589
3602
|
# @return [Integer]
|
3590
3603
|
#
|
3591
3604
|
# @!attribute [rw] allow_unassociated_targets
|
3592
|
-
# Enables a maintenance window task to run on managed
|
3593
|
-
#
|
3594
|
-
#
|
3595
|
-
#
|
3605
|
+
# Enables a maintenance window task to run on managed nodes, even if
|
3606
|
+
# you haven't registered those nodes as targets. If enabled, then you
|
3607
|
+
# must specify the unregistered managed nodes (by node ID) when you
|
3608
|
+
# register a task with the maintenance window.
|
3596
3609
|
#
|
3597
3610
|
# If you don't enable this option, then you must specify
|
3598
3611
|
# previously-registered targets when you register a task with the
|
@@ -4006,8 +4019,8 @@ module Aws::SSM
|
|
4006
4019
|
#
|
4007
4020
|
# @!attribute [rw] approved_patches_enable_non_security
|
4008
4021
|
# Indicates whether the list of approved patches includes non-security
|
4009
|
-
# updates that should be applied to the
|
4010
|
-
# is `false`. Applies to Linux
|
4022
|
+
# updates that should be applied to the managed nodes. The default
|
4023
|
+
# value is `false`. Applies to Linux managed nodes only.
|
4011
4024
|
# @return [Boolean]
|
4012
4025
|
#
|
4013
4026
|
# @!attribute [rw] rejected_patches
|
@@ -4046,9 +4059,9 @@ module Aws::SSM
|
|
4046
4059
|
# @return [String]
|
4047
4060
|
#
|
4048
4061
|
# @!attribute [rw] sources
|
4049
|
-
# Information about the patches to use to update the
|
4062
|
+
# Information about the patches to use to update the managed nodes,
|
4050
4063
|
# including target operating systems and source repositories. Applies
|
4051
|
-
# to Linux
|
4064
|
+
# to Linux managed nodes only.
|
4052
4065
|
# @return [Array<Types::PatchSource>]
|
4053
4066
|
#
|
4054
4067
|
# @!attribute [rw] client_token
|
@@ -4231,11 +4244,11 @@ module Aws::SSM
|
|
4231
4244
|
# @return [String]
|
4232
4245
|
#
|
4233
4246
|
# @!attribute [rw] instance_id
|
4234
|
-
# The
|
4247
|
+
# The managed node ID.
|
4235
4248
|
#
|
4236
|
-
# <note markdown="1"> `InstanceId` has been deprecated. To specify
|
4237
|
-
# association, use the `Targets` parameter. Requests that include
|
4238
|
-
# parameter `InstanceID` with Systems Manager documents (SSM
|
4249
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify a managed node ID for
|
4250
|
+
# an association, use the `Targets` parameter. Requests that include
|
4251
|
+
# the parameter `InstanceID` with Systems Manager documents (SSM
|
4239
4252
|
# documents) that use schema version 2.0 or later will fail. In
|
4240
4253
|
# addition, if you use the parameter `InstanceId`, you can't use the
|
4241
4254
|
# parameters `AssociationName`, `DocumentVersion`, `MaxErrors`,
|
@@ -4581,8 +4594,8 @@ module Aws::SSM
|
|
4581
4594
|
# }
|
4582
4595
|
#
|
4583
4596
|
# @!attribute [rw] instance_id
|
4584
|
-
# The ID assigned to the managed
|
4585
|
-
#
|
4597
|
+
# The ID assigned to the managed node when you registered it using the
|
4598
|
+
# activation process.
|
4586
4599
|
# @return [String]
|
4587
4600
|
#
|
4588
4601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterManagedInstanceRequest AWS API Documentation
|
@@ -4980,7 +4993,7 @@ module Aws::SSM
|
|
4980
4993
|
# @return [String]
|
4981
4994
|
#
|
4982
4995
|
# @!attribute [rw] instance_id
|
4983
|
-
# The
|
4996
|
+
# The managed node ID.
|
4984
4997
|
# @return [String]
|
4985
4998
|
#
|
4986
4999
|
# @!attribute [rw] association_id
|
@@ -4990,8 +5003,8 @@ module Aws::SSM
|
|
4990
5003
|
# @!attribute [rw] association_version
|
4991
5004
|
# Specify the association version to retrieve. To view the latest
|
4992
5005
|
# version, either specify `$LATEST` for this parameter, or omit this
|
4993
|
-
# parameter. To view a list of all associations for
|
4994
|
-
# ListAssociations. To get a list of versions for a specific
|
5006
|
+
# parameter. To view a list of all associations for a managed node,
|
5007
|
+
# use ListAssociations. To get a list of versions for a specific
|
4995
5008
|
# association, use ListAssociationVersions.
|
4996
5009
|
# @return [String]
|
4997
5010
|
#
|
@@ -5169,7 +5182,7 @@ module Aws::SSM
|
|
5169
5182
|
#
|
5170
5183
|
# **Windows Server**
|
5171
5184
|
#
|
5172
|
-
# Supported keys for Windows Server
|
5185
|
+
# Supported keys for Windows Server managed node patches include the
|
5173
5186
|
# following:
|
5174
5187
|
#
|
5175
5188
|
# * <b> <code>PATCH_SET</code> </b>
|
@@ -5213,7 +5226,7 @@ module Aws::SSM
|
|
5213
5226
|
# Key=PRODUCT,Values=AmazonLinux2018.03
|
5214
5227
|
# Key=CVE_ID,Values=CVE-2018-3615`
|
5215
5228
|
#
|
5216
|
-
# Supported keys for Linux
|
5229
|
+
# Supported keys for Linux managed node patches include the following:
|
5217
5230
|
#
|
5218
5231
|
# * <b> <code>PRODUCT</code> </b>
|
5219
5232
|
#
|
@@ -5419,7 +5432,7 @@ module Aws::SSM
|
|
5419
5432
|
# }
|
5420
5433
|
#
|
5421
5434
|
# @!attribute [rw] instance_id
|
5422
|
-
# The
|
5435
|
+
# The managed node ID for which you want to view all associations.
|
5423
5436
|
# @return [String]
|
5424
5437
|
#
|
5425
5438
|
# @!attribute [rw] max_results
|
@@ -5444,7 +5457,7 @@ module Aws::SSM
|
|
5444
5457
|
end
|
5445
5458
|
|
5446
5459
|
# @!attribute [rw] associations
|
5447
|
-
# The associations for the requested
|
5460
|
+
# The associations for the requested managed node.
|
5448
5461
|
# @return [Array<Types::InstanceAssociation>]
|
5449
5462
|
#
|
5450
5463
|
# @!attribute [rw] next_token
|
@@ -5521,7 +5534,8 @@ module Aws::SSM
|
|
5521
5534
|
# }
|
5522
5535
|
#
|
5523
5536
|
# @!attribute [rw] instance_id
|
5524
|
-
# The
|
5537
|
+
# The managed node IDs for which you want association status
|
5538
|
+
# information.
|
5525
5539
|
# @return [String]
|
5526
5540
|
#
|
5527
5541
|
# @!attribute [rw] max_results
|
@@ -5586,8 +5600,8 @@ module Aws::SSM
|
|
5586
5600
|
# @!attribute [rw] instance_information_filter_list
|
5587
5601
|
# This is a legacy method. We recommend that you don't use this
|
5588
5602
|
# method. Instead, use the `Filters` data type. `Filters` enables you
|
5589
|
-
# to return
|
5590
|
-
# managed
|
5603
|
+
# to return node information by filtering based on tags applied to
|
5604
|
+
# managed nodes.
|
5591
5605
|
#
|
5592
5606
|
# <note markdown="1"> Attempting to use `InstanceInformationFilterList` and `Filters`
|
5593
5607
|
# leads to an exception error.
|
@@ -5597,8 +5611,8 @@ module Aws::SSM
|
|
5597
5611
|
#
|
5598
5612
|
# @!attribute [rw] filters
|
5599
5613
|
# One or more filters. Use a filter to return a more specific list of
|
5600
|
-
#
|
5601
|
-
# Use this `Filters` data type instead of
|
5614
|
+
# managed nodes. You can filter based on tags applied to EC2
|
5615
|
+
# instances. Use this `Filters` data type instead of
|
5602
5616
|
# `InstanceInformationFilterList`, which is deprecated.
|
5603
5617
|
# @return [Array<Types::InstanceInformationStringFilter>]
|
5604
5618
|
#
|
@@ -5625,7 +5639,7 @@ module Aws::SSM
|
|
5625
5639
|
end
|
5626
5640
|
|
5627
5641
|
# @!attribute [rw] instance_information_list
|
5628
|
-
# The
|
5642
|
+
# The managed node information list.
|
5629
5643
|
# @return [Array<Types::InstanceInformation>]
|
5630
5644
|
#
|
5631
5645
|
# @!attribute [rw] next_token
|
@@ -5695,7 +5709,7 @@ module Aws::SSM
|
|
5695
5709
|
end
|
5696
5710
|
|
5697
5711
|
# @!attribute [rw] instance_patch_states
|
5698
|
-
# The high-level patch state for the requested
|
5712
|
+
# The high-level patch state for the requested managed nodes.
|
5699
5713
|
# @return [Array<Types::InstancePatchState>]
|
5700
5714
|
#
|
5701
5715
|
# @!attribute [rw] next_token
|
@@ -5722,8 +5736,8 @@ module Aws::SSM
|
|
5722
5736
|
# }
|
5723
5737
|
#
|
5724
5738
|
# @!attribute [rw] instance_ids
|
5725
|
-
# The ID of the
|
5726
|
-
# retrieved.
|
5739
|
+
# The ID of the managed node for which patch state information should
|
5740
|
+
# be retrieved.
|
5727
5741
|
# @return [Array<String>]
|
5728
5742
|
#
|
5729
5743
|
# @!attribute [rw] next_token
|
@@ -5732,7 +5746,7 @@ module Aws::SSM
|
|
5732
5746
|
# @return [String]
|
5733
5747
|
#
|
5734
5748
|
# @!attribute [rw] max_results
|
5735
|
-
# The maximum number of
|
5749
|
+
# The maximum number of managed nodes to return (per page).
|
5736
5750
|
# @return [Integer]
|
5737
5751
|
#
|
5738
5752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStatesRequest AWS API Documentation
|
@@ -5746,7 +5760,7 @@ module Aws::SSM
|
|
5746
5760
|
end
|
5747
5761
|
|
5748
5762
|
# @!attribute [rw] instance_patch_states
|
5749
|
-
# The high-level patch state for the requested
|
5763
|
+
# The high-level patch state for the requested managed nodes.
|
5750
5764
|
# @return [Array<Types::InstancePatchState>]
|
5751
5765
|
#
|
5752
5766
|
# @!attribute [rw] next_token
|
@@ -5779,7 +5793,7 @@ module Aws::SSM
|
|
5779
5793
|
# }
|
5780
5794
|
#
|
5781
5795
|
# @!attribute [rw] instance_id
|
5782
|
-
# The ID of the
|
5796
|
+
# The ID of the managed node whose patch state information should be
|
5783
5797
|
# retrieved.
|
5784
5798
|
# @return [String]
|
5785
5799
|
#
|
@@ -6150,7 +6164,7 @@ module Aws::SSM
|
|
6150
6164
|
# @return [String]
|
6151
6165
|
#
|
6152
6166
|
# @!attribute [rw] targets
|
6153
|
-
# The
|
6167
|
+
# The managed node ID or key-value pair to retrieve information about.
|
6154
6168
|
# @return [Array<Types::Target>]
|
6155
6169
|
#
|
6156
6170
|
# @!attribute [rw] resource_type
|
@@ -6353,7 +6367,7 @@ module Aws::SSM
|
|
6353
6367
|
# }
|
6354
6368
|
#
|
6355
6369
|
# @!attribute [rw] targets
|
6356
|
-
# The
|
6370
|
+
# The managed node ID or key-value pair to retrieve information about.
|
6357
6371
|
# @return [Array<Types::Target>]
|
6358
6372
|
#
|
6359
6373
|
# @!attribute [rw] resource_type
|
@@ -6384,8 +6398,8 @@ module Aws::SSM
|
|
6384
6398
|
end
|
6385
6399
|
|
6386
6400
|
# @!attribute [rw] window_identities
|
6387
|
-
# Information about the maintenance window targets and tasks
|
6388
|
-
#
|
6401
|
+
# Information about the maintenance window targets and tasks a managed
|
6402
|
+
# node is associated with.
|
6389
6403
|
# @return [Array<Types::MaintenanceWindowIdentityForTarget>]
|
6390
6404
|
#
|
6391
6405
|
# @!attribute [rw] next_token
|
@@ -6738,27 +6752,27 @@ module Aws::SSM
|
|
6738
6752
|
end
|
6739
6753
|
|
6740
6754
|
# @!attribute [rw] instances
|
6741
|
-
# The number of
|
6755
|
+
# The number of managed nodes in the patch group.
|
6742
6756
|
# @return [Integer]
|
6743
6757
|
#
|
6744
6758
|
# @!attribute [rw] instances_with_installed_patches
|
6745
|
-
# The number of
|
6759
|
+
# The number of managed nodes with installed patches.
|
6746
6760
|
# @return [Integer]
|
6747
6761
|
#
|
6748
6762
|
# @!attribute [rw] instances_with_installed_other_patches
|
6749
|
-
# The number of
|
6750
|
-
# in the patch baseline.
|
6763
|
+
# The number of managed nodes with patches installed that aren't
|
6764
|
+
# defined in the patch baseline.
|
6751
6765
|
# @return [Integer]
|
6752
6766
|
#
|
6753
6767
|
# @!attribute [rw] instances_with_installed_pending_reboot_patches
|
6754
|
-
# The number of
|
6755
|
-
# haven't been rebooted after the patch installation. The status
|
6756
|
-
# these
|
6768
|
+
# The number of managed nodes with patches installed by Patch Manager
|
6769
|
+
# that haven't been rebooted after the patch installation. The status
|
6770
|
+
# of these managed nodes is `NON_COMPLIANT`.
|
6757
6771
|
# @return [Integer]
|
6758
6772
|
#
|
6759
6773
|
# @!attribute [rw] instances_with_installed_rejected_patches
|
6760
|
-
# The number of
|
6761
|
-
# a `RejectedPatches` list. Patches with a status of
|
6774
|
+
# The number of managed nodes with patches installed that are
|
6775
|
+
# specified in a `RejectedPatches` list. Patches with a status of
|
6762
6776
|
# `INSTALLED_REJECTED` were typically installed before they were added
|
6763
6777
|
# to a `RejectedPatches` list.
|
6764
6778
|
#
|
@@ -6770,45 +6784,46 @@ module Aws::SSM
|
|
6770
6784
|
# @return [Integer]
|
6771
6785
|
#
|
6772
6786
|
# @!attribute [rw] instances_with_missing_patches
|
6773
|
-
# The number of
|
6787
|
+
# The number of managed nodes with missing patches from the patch
|
6774
6788
|
# baseline.
|
6775
6789
|
# @return [Integer]
|
6776
6790
|
#
|
6777
6791
|
# @!attribute [rw] instances_with_failed_patches
|
6778
|
-
# The number of
|
6779
|
-
# failed to install.
|
6792
|
+
# The number of managed nodes with patches from the patch baseline
|
6793
|
+
# that failed to install.
|
6780
6794
|
# @return [Integer]
|
6781
6795
|
#
|
6782
6796
|
# @!attribute [rw] instances_with_not_applicable_patches
|
6783
|
-
# The number of
|
6797
|
+
# The number of managed nodes with patches that aren't applicable.
|
6784
6798
|
# @return [Integer]
|
6785
6799
|
#
|
6786
6800
|
# @!attribute [rw] instances_with_unreported_not_applicable_patches
|
6787
|
-
# The number of
|
6801
|
+
# The number of managed nodes with `NotApplicable` patches beyond the
|
6788
6802
|
# supported limit, which aren't reported by name to Inventory.
|
6789
6803
|
# Inventory is a capability of Amazon Web Services Systems Manager.
|
6790
6804
|
# @return [Integer]
|
6791
6805
|
#
|
6792
6806
|
# @!attribute [rw] instances_with_critical_non_compliant_patches
|
6793
|
-
# The number of
|
6807
|
+
# The number of managed nodes where patches that are specified as
|
6794
6808
|
# `Critical` for compliance reporting in the patch baseline aren't
|
6795
6809
|
# installed. These patches might be missing, have failed installation,
|
6796
|
-
# were rejected, or were installed but awaiting a required
|
6797
|
-
# reboot. The status of these
|
6810
|
+
# were rejected, or were installed but awaiting a required managed
|
6811
|
+
# node reboot. The status of these managed nodes is `NON_COMPLIANT`.
|
6798
6812
|
# @return [Integer]
|
6799
6813
|
#
|
6800
6814
|
# @!attribute [rw] instances_with_security_non_compliant_patches
|
6801
|
-
# The number of
|
6815
|
+
# The number of managed nodes where patches that are specified as
|
6802
6816
|
# `Security` in a patch advisory aren't installed. These patches
|
6803
6817
|
# might be missing, have failed installation, were rejected, or were
|
6804
|
-
# installed but awaiting a required
|
6805
|
-
# these
|
6818
|
+
# installed but awaiting a required managed node reboot. The status of
|
6819
|
+
# these managed nodes is `NON_COMPLIANT`.
|
6806
6820
|
# @return [Integer]
|
6807
6821
|
#
|
6808
6822
|
# @!attribute [rw] instances_with_other_non_compliant_patches
|
6809
|
-
# The number of
|
6810
|
-
# other than `Critical` or `Security` but aren't
|
6811
|
-
# patch baseline. The status of these
|
6823
|
+
# The number of managed nodes with patches installed that are
|
6824
|
+
# specified as other than `Critical` or `Security` but aren't
|
6825
|
+
# compliant with the patch baseline. The status of these managed nodes
|
6826
|
+
# is `NON_COMPLIANT`.
|
6812
6827
|
# @return [Integer]
|
6813
6828
|
#
|
6814
6829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroupStateResult AWS API Documentation
|
@@ -7101,7 +7116,7 @@ module Aws::SSM
|
|
7101
7116
|
include Aws::Structure
|
7102
7117
|
end
|
7103
7118
|
|
7104
|
-
# Describes
|
7119
|
+
# Describes an Amazon Web Services Systems Manager document (SSM
|
7105
7120
|
# document).
|
7106
7121
|
#
|
7107
7122
|
# @!attribute [rw] sha_1
|
@@ -7173,7 +7188,8 @@ module Aws::SSM
|
|
7173
7188
|
# @return [Array<Types::DocumentParameter>]
|
7174
7189
|
#
|
7175
7190
|
# @!attribute [rw] platform_types
|
7176
|
-
# The list of OS platforms compatible with this SSM
|
7191
|
+
# The list of operating system (OS) platforms compatible with this SSM
|
7192
|
+
# document.
|
7177
7193
|
# @return [Array<String>]
|
7178
7194
|
#
|
7179
7195
|
# @!attribute [rw] document_type
|
@@ -7243,6 +7259,15 @@ module Aws::SSM
|
|
7243
7259
|
# The current status of the review.
|
7244
7260
|
# @return [String]
|
7245
7261
|
#
|
7262
|
+
# @!attribute [rw] category
|
7263
|
+
# The classification of a document to help you identify and categorize
|
7264
|
+
# its use.
|
7265
|
+
# @return [Array<String>]
|
7266
|
+
#
|
7267
|
+
# @!attribute [rw] category_enum
|
7268
|
+
# The value that identifies a document's category.
|
7269
|
+
# @return [Array<String>]
|
7270
|
+
#
|
7246
7271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentDescription AWS API Documentation
|
7247
7272
|
#
|
7248
7273
|
class DocumentDescription < Struct.new(
|
@@ -7273,7 +7298,9 @@ module Aws::SSM
|
|
7273
7298
|
:review_information,
|
7274
7299
|
:approved_version,
|
7275
7300
|
:pending_review_version,
|
7276
|
-
:review_status
|
7301
|
+
:review_status,
|
7302
|
+
:category,
|
7303
|
+
:category_enum)
|
7277
7304
|
SENSITIVE = []
|
7278
7305
|
include Aws::Structure
|
7279
7306
|
end
|
@@ -7851,7 +7878,7 @@ module Aws::SSM
|
|
7851
7878
|
include Aws::Structure
|
7852
7879
|
end
|
7853
7880
|
|
7854
|
-
# You can't specify
|
7881
|
+
# You can't specify a managed node ID in more than one association.
|
7855
7882
|
#
|
7856
7883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DuplicateInstanceId AWS API Documentation
|
7857
7884
|
#
|
@@ -8068,10 +8095,11 @@ module Aws::SSM
|
|
8068
8095
|
# @return [String]
|
8069
8096
|
#
|
8070
8097
|
# @!attribute [rw] instance_id
|
8071
|
-
# (Required) The ID of the managed
|
8072
|
-
# managed
|
8073
|
-
# instance or
|
8074
|
-
# configured for Amazon Web Services Systems
|
8098
|
+
# (Required) The ID of the managed node targeted by the command. A
|
8099
|
+
# *managed node* can be an Amazon Elastic Compute Cloud (Amazon EC2)
|
8100
|
+
# instance, edge device, and on-premises server or VM in your hybrid
|
8101
|
+
# environment that is configured for Amazon Web Services Systems
|
8102
|
+
# Manager.
|
8075
8103
|
# @return [String]
|
8076
8104
|
#
|
8077
8105
|
# @!attribute [rw] plugin_name
|
@@ -8107,9 +8135,10 @@ module Aws::SSM
|
|
8107
8135
|
# @return [String]
|
8108
8136
|
#
|
8109
8137
|
# @!attribute [rw] instance_id
|
8110
|
-
# The ID of the managed
|
8111
|
-
#
|
8112
|
-
#
|
8138
|
+
# The ID of the managed node targeted by the command. A *managed node*
|
8139
|
+
# can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge
|
8140
|
+
# device, or on-premises server or VM in your hybrid environment that
|
8141
|
+
# is configured for Amazon Web Services Systems Manager.
|
8113
8142
|
# @return [String]
|
8114
8143
|
#
|
8115
8144
|
# @!attribute [rw] comment
|
@@ -8134,7 +8163,7 @@ module Aws::SSM
|
|
8134
8163
|
# @!attribute [rw] response_code
|
8135
8164
|
# The error level response code for the plugin script. If the response
|
8136
8165
|
# code is `-1`, then the command hasn't started running on the
|
8137
|
-
#
|
8166
|
+
# managed node, or it wasn't received by the node.
|
8138
8167
|
# @return [Integer]
|
8139
8168
|
#
|
8140
8169
|
# @!attribute [rw] execution_start_date_time
|
@@ -8180,42 +8209,43 @@ module Aws::SSM
|
|
8180
8209
|
# Systems Manager User Guide*. `StatusDetails` can be one of the
|
8181
8210
|
# following values:
|
8182
8211
|
#
|
8183
|
-
# * Pending: The command hasn't been sent to the
|
8212
|
+
# * Pending: The command hasn't been sent to the managed node.
|
8184
8213
|
#
|
8185
|
-
# * In Progress: The command has been sent to the
|
8186
|
-
# reached a terminal state.
|
8214
|
+
# * In Progress: The command has been sent to the managed node but
|
8215
|
+
# hasn't reached a terminal state.
|
8187
8216
|
#
|
8188
8217
|
# * Delayed: The system attempted to send the command to the target,
|
8189
|
-
# but the target wasn't available. The
|
8190
|
-
# available because of network issues, because the
|
8191
|
-
#
|
8192
|
-
#
|
8218
|
+
# but the target wasn't available. The managed node might not be
|
8219
|
+
# available because of network issues, because the node was stopped,
|
8220
|
+
# or for similar reasons. The system will try to send the command
|
8221
|
+
# again.
|
8193
8222
|
#
|
8194
8223
|
# * Success: The command or plugin ran successfully. This is a
|
8195
8224
|
# terminal state.
|
8196
8225
|
#
|
8197
|
-
# * Delivery Timed Out: The command wasn't delivered to the
|
8198
|
-
# before the delivery timeout expired. Delivery timeouts don't
|
8226
|
+
# * Delivery Timed Out: The command wasn't delivered to the managed
|
8227
|
+
# node before the delivery timeout expired. Delivery timeouts don't
|
8199
8228
|
# count against the parent command's `MaxErrors` limit, but they do
|
8200
8229
|
# contribute to whether the parent command status is Success or
|
8201
8230
|
# Incomplete. This is a terminal state.
|
8202
8231
|
#
|
8203
|
-
# * Execution Timed Out: The command started to run on the
|
8204
|
-
# but the execution wasn't complete before the timeout
|
8205
|
-
# Execution timeouts count against the `MaxErrors` limit of
|
8206
|
-
# parent command. This is a terminal state.
|
8232
|
+
# * Execution Timed Out: The command started to run on the managed
|
8233
|
+
# node, but the execution wasn't complete before the timeout
|
8234
|
+
# expired. Execution timeouts count against the `MaxErrors` limit of
|
8235
|
+
# the parent command. This is a terminal state.
|
8207
8236
|
#
|
8208
|
-
# * Failed: The command wasn't run successfully on the
|
8209
|
-
# a plugin, this indicates that the result code wasn't zero.
|
8210
|
-
# command invocation, this indicates that the result code for
|
8211
|
-
# more plugins wasn't zero. Invocation failures count
|
8212
|
-
# `MaxErrors` limit of the parent command. This is a
|
8237
|
+
# * Failed: The command wasn't run successfully on the managed node.
|
8238
|
+
# For a plugin, this indicates that the result code wasn't zero.
|
8239
|
+
# For a command invocation, this indicates that the result code for
|
8240
|
+
# one or more plugins wasn't zero. Invocation failures count
|
8241
|
+
# against the `MaxErrors` limit of the parent command. This is a
|
8242
|
+
# terminal state.
|
8213
8243
|
#
|
8214
|
-
# *
|
8215
|
-
# is a terminal state.
|
8244
|
+
# * Cancelled: The command was terminated before it was completed.
|
8245
|
+
# This is a terminal state.
|
8216
8246
|
#
|
8217
|
-
# * Undeliverable: The command can't be delivered to the
|
8218
|
-
# The
|
8247
|
+
# * Undeliverable: The command can't be delivered to the managed
|
8248
|
+
# node. The node might not exist or might not be responding.
|
8219
8249
|
# Undeliverable invocations don't count against the parent
|
8220
8250
|
# command's `MaxErrors` limit and don't contribute to whether the
|
8221
8251
|
# parent command status is Success or Incomplete. This is a terminal
|
@@ -8289,7 +8319,7 @@ module Aws::SSM
|
|
8289
8319
|
# }
|
8290
8320
|
#
|
8291
8321
|
# @!attribute [rw] target
|
8292
|
-
# The
|
8322
|
+
# The managed node ID.
|
8293
8323
|
# @return [String]
|
8294
8324
|
#
|
8295
8325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetConnectionStatusRequest AWS API Documentation
|
@@ -8301,11 +8331,11 @@ module Aws::SSM
|
|
8301
8331
|
end
|
8302
8332
|
|
8303
8333
|
# @!attribute [rw] target
|
8304
|
-
# The ID of the
|
8334
|
+
# The ID of the managed node to check connection status.
|
8305
8335
|
# @return [String]
|
8306
8336
|
#
|
8307
8337
|
# @!attribute [rw] status
|
8308
|
-
# The status of the connection to the
|
8338
|
+
# The status of the connection to the managed node. For example,
|
8309
8339
|
# 'Connected' or 'Not Connected'.
|
8310
8340
|
# @return [String]
|
8311
8341
|
#
|
@@ -8405,7 +8435,7 @@ module Aws::SSM
|
|
8405
8435
|
# }
|
8406
8436
|
#
|
8407
8437
|
# @!attribute [rw] instance_id
|
8408
|
-
# The ID of the
|
8438
|
+
# The ID of the managed node for which the appropriate patch snapshot
|
8409
8439
|
# should be retrieved.
|
8410
8440
|
# @return [String]
|
8411
8441
|
#
|
@@ -8429,7 +8459,7 @@ module Aws::SSM
|
|
8429
8459
|
end
|
8430
8460
|
|
8431
8461
|
# @!attribute [rw] instance_id
|
8432
|
-
# The
|
8462
|
+
# The managed node ID.
|
8433
8463
|
# @return [String]
|
8434
8464
|
#
|
8435
8465
|
# @!attribute [rw] snapshot_id
|
@@ -8443,7 +8473,7 @@ module Aws::SSM
|
|
8443
8473
|
#
|
8444
8474
|
# @!attribute [rw] product
|
8445
8475
|
# Returns the specific operating system (for example Windows Server
|
8446
|
-
# 2012 or Amazon Linux 2015.09) on the
|
8476
|
+
# 2012 or Amazon Linux 2015.09) on the managed node for the specified
|
8447
8477
|
# patch snapshot.
|
8448
8478
|
# @return [String]
|
8449
8479
|
#
|
@@ -8640,7 +8670,7 @@ module Aws::SSM
|
|
8640
8670
|
# Returns counts of inventory types based on one or more expressions.
|
8641
8671
|
# For example, if you aggregate by using an expression that uses the
|
8642
8672
|
# `AWS:InstanceInformation.PlatformType` type, you can see a count of
|
8643
|
-
# how many Windows and Linux
|
8673
|
+
# how many Windows and Linux managed nodes exist in your inventoried
|
8644
8674
|
# fleet.
|
8645
8675
|
# @return [Array<Types::InventoryAggregator>]
|
8646
8676
|
#
|
@@ -8672,8 +8702,8 @@ module Aws::SSM
|
|
8672
8702
|
end
|
8673
8703
|
|
8674
8704
|
# @!attribute [rw] entities
|
8675
|
-
# Collection of inventory entities such as a collection of
|
8676
|
-
# inventory.
|
8705
|
+
# Collection of inventory entities such as a collection of managed
|
8706
|
+
# node inventory.
|
8677
8707
|
# @return [Array<Types::InventoryResultEntity>]
|
8678
8708
|
#
|
8679
8709
|
# @!attribute [rw] next_token
|
@@ -9855,8 +9885,8 @@ module Aws::SSM
|
|
9855
9885
|
#
|
9856
9886
|
# @!attribute [rw] approved_patches_enable_non_security
|
9857
9887
|
# Indicates whether the list of approved patches includes non-security
|
9858
|
-
# updates that should be applied to the
|
9859
|
-
# is `false`. Applies to Linux
|
9888
|
+
# updates that should be applied to the managed nodes. The default
|
9889
|
+
# value is `false`. Applies to Linux managed nodes only.
|
9860
9890
|
# @return [Boolean]
|
9861
9891
|
#
|
9862
9892
|
# @!attribute [rw] rejected_patches
|
@@ -9887,9 +9917,9 @@ module Aws::SSM
|
|
9887
9917
|
# @return [String]
|
9888
9918
|
#
|
9889
9919
|
# @!attribute [rw] sources
|
9890
|
-
# Information about the patches to use to update the
|
9920
|
+
# Information about the patches to use to update the managed nodes,
|
9891
9921
|
# including target operating systems and source repositories. Applies
|
9892
|
-
# to Linux
|
9922
|
+
# to Linux managed nodes only.
|
9893
9923
|
# @return [Array<Types::PatchSource>]
|
9894
9924
|
#
|
9895
9925
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaselineResult AWS API Documentation
|
@@ -10045,7 +10075,7 @@ module Aws::SSM
|
|
10045
10075
|
# @return [String]
|
10046
10076
|
#
|
10047
10077
|
# @!attribute [rw] instance_association_status_aggregated_count
|
10048
|
-
# The number of associations for the
|
10078
|
+
# The number of associations for the managed node(s).
|
10049
10079
|
# @return [Hash<String,Integer>]
|
10050
10080
|
#
|
10051
10081
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InstanceAggregatedAssociationOverview AWS API Documentation
|
@@ -10057,22 +10087,22 @@ module Aws::SSM
|
|
10057
10087
|
include Aws::Structure
|
10058
10088
|
end
|
10059
10089
|
|
10060
|
-
# One or more association documents on the
|
10090
|
+
# One or more association documents on the managed node.
|
10061
10091
|
#
|
10062
10092
|
# @!attribute [rw] association_id
|
10063
10093
|
# The association ID.
|
10064
10094
|
# @return [String]
|
10065
10095
|
#
|
10066
10096
|
# @!attribute [rw] instance_id
|
10067
|
-
# The
|
10097
|
+
# The managed node ID.
|
10068
10098
|
# @return [String]
|
10069
10099
|
#
|
10070
10100
|
# @!attribute [rw] content
|
10071
|
-
# The content of the association document for the
|
10101
|
+
# The content of the association document for the managed node(s).
|
10072
10102
|
# @return [String]
|
10073
10103
|
#
|
10074
10104
|
# @!attribute [rw] association_version
|
10075
|
-
# Version information for the association on the
|
10105
|
+
# Version information for the association on the managed node.
|
10076
10106
|
# @return [String]
|
10077
10107
|
#
|
10078
10108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InstanceAssociation AWS API Documentation
|
@@ -10135,7 +10165,7 @@ module Aws::SSM
|
|
10135
10165
|
include Aws::Structure
|
10136
10166
|
end
|
10137
10167
|
|
10138
|
-
# Status information about the
|
10168
|
+
# Status information about the association.
|
10139
10169
|
#
|
10140
10170
|
# @!attribute [rw] association_id
|
10141
10171
|
# The association ID.
|
@@ -10150,23 +10180,23 @@ module Aws::SSM
|
|
10150
10180
|
# @return [String]
|
10151
10181
|
#
|
10152
10182
|
# @!attribute [rw] association_version
|
10153
|
-
# The version of the association applied to the
|
10183
|
+
# The version of the association applied to the managed node.
|
10154
10184
|
# @return [String]
|
10155
10185
|
#
|
10156
10186
|
# @!attribute [rw] instance_id
|
10157
|
-
# The
|
10187
|
+
# The managed node ID where the association was created.
|
10158
10188
|
# @return [String]
|
10159
10189
|
#
|
10160
10190
|
# @!attribute [rw] execution_date
|
10161
|
-
# The date the
|
10191
|
+
# The date the association ran.
|
10162
10192
|
# @return [Time]
|
10163
10193
|
#
|
10164
10194
|
# @!attribute [rw] status
|
10165
|
-
# Status information about the
|
10195
|
+
# Status information about the association.
|
10166
10196
|
# @return [String]
|
10167
10197
|
#
|
10168
10198
|
# @!attribute [rw] detailed_status
|
10169
|
-
# Detailed status information about the
|
10199
|
+
# Detailed status information about the association.
|
10170
10200
|
# @return [String]
|
10171
10201
|
#
|
10172
10202
|
# @!attribute [rw] execution_summary
|
@@ -10183,7 +10213,7 @@ module Aws::SSM
|
|
10183
10213
|
# @return [Types::InstanceAssociationOutputUrl]
|
10184
10214
|
#
|
10185
10215
|
# @!attribute [rw] association_name
|
10186
|
-
# The name of the association applied to the
|
10216
|
+
# The name of the association applied to the managed node.
|
10187
10217
|
# @return [String]
|
10188
10218
|
#
|
10189
10219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InstanceAssociationStatusInfo AWS API Documentation
|
@@ -10205,10 +10235,10 @@ module Aws::SSM
|
|
10205
10235
|
include Aws::Structure
|
10206
10236
|
end
|
10207
10237
|
|
10208
|
-
# Describes a filter for a specific list of
|
10238
|
+
# Describes a filter for a specific list of managed nodes.
|
10209
10239
|
#
|
10210
10240
|
# @!attribute [rw] instance_id
|
10211
|
-
# The
|
10241
|
+
# The managed node ID.
|
10212
10242
|
# @return [String]
|
10213
10243
|
#
|
10214
10244
|
# @!attribute [rw] ping_status
|
@@ -10225,15 +10255,15 @@ module Aws::SSM
|
|
10225
10255
|
# @return [Time]
|
10226
10256
|
#
|
10227
10257
|
# @!attribute [rw] agent_version
|
10228
|
-
# The version of SSM Agent running on your Linux
|
10258
|
+
# The version of SSM Agent running on your Linux managed node.
|
10229
10259
|
# @return [String]
|
10230
10260
|
#
|
10231
10261
|
# @!attribute [rw] is_latest_version
|
10232
10262
|
# Indicates whether the latest version of SSM Agent is running on your
|
10233
|
-
# Linux
|
10234
|
-
#
|
10235
|
-
#
|
10236
|
-
#
|
10263
|
+
# Linux managed node. This field doesn't indicate whether or not the
|
10264
|
+
# latest version is installed on Windows managed nodes, because some
|
10265
|
+
# older versions of Windows Server use the EC2Config service to
|
10266
|
+
# process Systems Manager requests.
|
10237
10267
|
# @return [Boolean]
|
10238
10268
|
#
|
10239
10269
|
# @!attribute [rw] platform_type
|
@@ -10241,11 +10271,12 @@ module Aws::SSM
|
|
10241
10271
|
# @return [String]
|
10242
10272
|
#
|
10243
10273
|
# @!attribute [rw] platform_name
|
10244
|
-
# The name of the operating system platform running on your
|
10274
|
+
# The name of the operating system platform running on your managed
|
10275
|
+
# node.
|
10245
10276
|
# @return [String]
|
10246
10277
|
#
|
10247
10278
|
# @!attribute [rw] platform_version
|
10248
|
-
# The version of the OS platform running on your
|
10279
|
+
# The version of the OS platform running on your managed node.
|
10249
10280
|
# @return [String]
|
10250
10281
|
#
|
10251
10282
|
# @!attribute [rw] activation_id
|
@@ -10255,8 +10286,8 @@ module Aws::SSM
|
|
10255
10286
|
#
|
10256
10287
|
# @!attribute [rw] iam_role
|
10257
10288
|
# The Identity and Access Management (IAM) role assigned to the
|
10258
|
-
# on-premises Systems Manager managed
|
10259
|
-
#
|
10289
|
+
# on-premises Systems Manager managed node. This call doesn't return
|
10290
|
+
# the IAM role for Amazon Elastic Compute Cloud (Amazon EC2)
|
10260
10291
|
# instances. To retrieve the IAM role for an EC2 instance, use the
|
10261
10292
|
# Amazon EC2 `DescribeInstances` operation. For information, see
|
10262
10293
|
# [DescribeInstances][1] in the *Amazon EC2 API Reference* or
|
@@ -10271,7 +10302,7 @@ module Aws::SSM
|
|
10271
10302
|
#
|
10272
10303
|
# @!attribute [rw] registration_date
|
10273
10304
|
# The date the server or VM was registered with Amazon Web Services as
|
10274
|
-
# a managed
|
10305
|
+
# a managed node.
|
10275
10306
|
# @return [Time]
|
10276
10307
|
#
|
10277
10308
|
# @!attribute [rw] resource_type
|
@@ -10280,14 +10311,14 @@ module Aws::SSM
|
|
10280
10311
|
# @return [String]
|
10281
10312
|
#
|
10282
10313
|
# @!attribute [rw] name
|
10283
|
-
# The name assigned to an on-premises server or virtual
|
10284
|
-
# when it is activated as a Systems Manager managed
|
10285
|
-
# is specified as the `DefaultInstanceName` property using
|
10286
|
-
# CreateActivation command. It is applied to the managed
|
10314
|
+
# The name assigned to an on-premises server, edge device, or virtual
|
10315
|
+
# machine (VM) when it is activated as a Systems Manager managed node.
|
10316
|
+
# The name is specified as the `DefaultInstanceName` property using
|
10317
|
+
# the CreateActivation command. It is applied to the managed node by
|
10287
10318
|
# specifying the Activation Code and Activation ID when you install
|
10288
|
-
# SSM Agent on the
|
10319
|
+
# SSM Agent on the node, as explained in [Install SSM Agent for a
|
10289
10320
|
# hybrid environment (Linux)][1] and [Install SSM Agent for a hybrid
|
10290
|
-
# environment (Windows)][2]. To retrieve the Name tag of an EC2
|
10321
|
+
# environment (Windows)][2]. To retrieve the `Name` tag of an EC2
|
10291
10322
|
# instance, use the Amazon EC2 `DescribeInstances` operation. For
|
10292
10323
|
# information, see [DescribeInstances][3] in the *Amazon EC2 API
|
10293
10324
|
# Reference* or [describe-instances][4] in the *Amazon Web Services
|
@@ -10302,11 +10333,11 @@ module Aws::SSM
|
|
10302
10333
|
# @return [String]
|
10303
10334
|
#
|
10304
10335
|
# @!attribute [rw] ip_address
|
10305
|
-
# The IP address of the managed
|
10336
|
+
# The IP address of the managed node.
|
10306
10337
|
# @return [String]
|
10307
10338
|
#
|
10308
10339
|
# @!attribute [rw] computer_name
|
10309
|
-
# The fully qualified host name of the managed
|
10340
|
+
# The fully qualified host name of the managed node.
|
10310
10341
|
# @return [String]
|
10311
10342
|
#
|
10312
10343
|
# @!attribute [rw] association_status
|
@@ -10325,6 +10356,16 @@ module Aws::SSM
|
|
10325
10356
|
# Information about the association.
|
10326
10357
|
# @return [Types::InstanceAggregatedAssociationOverview]
|
10327
10358
|
#
|
10359
|
+
# @!attribute [rw] source_id
|
10360
|
+
# The ID of the source resource. For IoT Greengrass devices,
|
10361
|
+
# `SourceId` is the Thing name.
|
10362
|
+
# @return [String]
|
10363
|
+
#
|
10364
|
+
# @!attribute [rw] source_type
|
10365
|
+
# The type of the source resource. For IoT Greengrass devices,
|
10366
|
+
# `SourceType` is `AWS::IoT::Thing`.
|
10367
|
+
# @return [String]
|
10368
|
+
#
|
10328
10369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InstanceInformation AWS API Documentation
|
10329
10370
|
#
|
10330
10371
|
class InstanceInformation < Struct.new(
|
@@ -10346,13 +10387,15 @@ module Aws::SSM
|
|
10346
10387
|
:association_status,
|
10347
10388
|
:last_association_execution_date,
|
10348
10389
|
:last_successful_association_execution_date,
|
10349
|
-
:association_overview
|
10390
|
+
:association_overview,
|
10391
|
+
:source_id,
|
10392
|
+
:source_type)
|
10350
10393
|
SENSITIVE = []
|
10351
10394
|
include Aws::Structure
|
10352
10395
|
end
|
10353
10396
|
|
10354
|
-
# Describes a filter for a specific list of
|
10355
|
-
#
|
10397
|
+
# Describes a filter for a specific list of managed nodes. You can
|
10398
|
+
# filter node information by using tags. You specify tags by using a
|
10356
10399
|
# key-value mapping.
|
10357
10400
|
#
|
10358
10401
|
# Use this operation instead of the
|
@@ -10385,8 +10428,7 @@ module Aws::SSM
|
|
10385
10428
|
include Aws::Structure
|
10386
10429
|
end
|
10387
10430
|
|
10388
|
-
# The filters to describe or get information about your managed
|
10389
|
-
# instances.
|
10431
|
+
# The filters to describe or get information about your managed nodes.
|
10390
10432
|
#
|
10391
10433
|
# @note When making an API call, you may pass InstanceInformationStringFilter
|
10392
10434
|
# data as a hash:
|
@@ -10397,7 +10439,7 @@ module Aws::SSM
|
|
10397
10439
|
# }
|
10398
10440
|
#
|
10399
10441
|
# @!attribute [rw] key
|
10400
|
-
# The filter key name to describe your
|
10442
|
+
# The filter key name to describe your managed nodes. For example:
|
10401
10443
|
#
|
10402
10444
|
# "InstanceIds"\|"AgentVersion"\|"PingStatus"\|"PlatformTypes"\|"ActivationIds"\|"IamRole"\|"ResourceType"\|"AssociationStatus"\|"Tag
|
10403
10445
|
# Key"
|
@@ -10421,22 +10463,22 @@ module Aws::SSM
|
|
10421
10463
|
include Aws::Structure
|
10422
10464
|
end
|
10423
10465
|
|
10424
|
-
# Defines the high-level patch compliance state for a managed
|
10466
|
+
# Defines the high-level patch compliance state for a managed node,
|
10425
10467
|
# providing information about the number of installed, missing, not
|
10426
10468
|
# applicable, and failed patches along with metadata about the operation
|
10427
|
-
# when this information was gathered for the
|
10469
|
+
# when this information was gathered for the managed node.
|
10428
10470
|
#
|
10429
10471
|
# @!attribute [rw] instance_id
|
10430
|
-
# The ID of the managed
|
10472
|
+
# The ID of the managed node the high-level patch compliance
|
10431
10473
|
# information was collected for.
|
10432
10474
|
# @return [String]
|
10433
10475
|
#
|
10434
10476
|
# @!attribute [rw] patch_group
|
10435
|
-
# The name of the patch group the managed
|
10477
|
+
# The name of the patch group the managed node belongs to.
|
10436
10478
|
# @return [String]
|
10437
10479
|
#
|
10438
10480
|
# @!attribute [rw] baseline_id
|
10439
|
-
# The ID of the patch baseline used to patch the
|
10481
|
+
# The ID of the patch baseline used to patch the managed node.
|
10440
10482
|
# @return [String]
|
10441
10483
|
#
|
10442
10484
|
# @!attribute [rw] snapshot_id
|
@@ -10467,22 +10509,22 @@ module Aws::SSM
|
|
10467
10509
|
#
|
10468
10510
|
# @!attribute [rw] installed_count
|
10469
10511
|
# The number of patches from the patch baseline that are installed on
|
10470
|
-
# the
|
10512
|
+
# the managed node.
|
10471
10513
|
# @return [Integer]
|
10472
10514
|
#
|
10473
10515
|
# @!attribute [rw] installed_other_count
|
10474
10516
|
# The number of patches not specified in the patch baseline that are
|
10475
|
-
# installed on the
|
10517
|
+
# installed on the managed node.
|
10476
10518
|
# @return [Integer]
|
10477
10519
|
#
|
10478
10520
|
# @!attribute [rw] installed_pending_reboot_count
|
10479
10521
|
# The number of patches installed by Patch Manager since the last time
|
10480
|
-
# the
|
10522
|
+
# the managed node was rebooted.
|
10481
10523
|
# @return [Integer]
|
10482
10524
|
#
|
10483
10525
|
# @!attribute [rw] installed_rejected_count
|
10484
|
-
# The number of patches installed on
|
10485
|
-
# a `RejectedPatches` list. Patches with a status of
|
10526
|
+
# The number of patches installed on a managed node that are specified
|
10527
|
+
# in a `RejectedPatches` list. Patches with a status of
|
10486
10528
|
# `InstalledRejected` were typically installed before they were added
|
10487
10529
|
# to a `RejectedPatches` list.
|
10488
10530
|
#
|
@@ -10495,7 +10537,7 @@ module Aws::SSM
|
|
10495
10537
|
#
|
10496
10538
|
# @!attribute [rw] missing_count
|
10497
10539
|
# The number of patches from the patch baseline that are applicable
|
10498
|
-
# for the
|
10540
|
+
# for the managed node but aren't currently installed.
|
10499
10541
|
# @return [Integer]
|
10500
10542
|
#
|
10501
10543
|
# @!attribute [rw] failed_count
|
@@ -10512,20 +10554,20 @@ module Aws::SSM
|
|
10512
10554
|
#
|
10513
10555
|
# @!attribute [rw] not_applicable_count
|
10514
10556
|
# The number of patches from the patch baseline that aren't
|
10515
|
-
# applicable for the
|
10516
|
-
#
|
10557
|
+
# applicable for the managed node and therefore aren't installed on
|
10558
|
+
# the node. This number may be truncated if the list of patch names is
|
10517
10559
|
# very large. The number of patches beyond this limit are reported in
|
10518
10560
|
# `UnreportedNotApplicableCount`.
|
10519
10561
|
# @return [Integer]
|
10520
10562
|
#
|
10521
10563
|
# @!attribute [rw] operation_start_time
|
10522
10564
|
# The time the most recent patching operation was started on the
|
10523
|
-
#
|
10565
|
+
# managed node.
|
10524
10566
|
# @return [Time]
|
10525
10567
|
#
|
10526
10568
|
# @!attribute [rw] operation_end_time
|
10527
|
-
# The time the most recent patching operation completed on the
|
10528
|
-
#
|
10569
|
+
# The time the most recent patching operation completed on the managed
|
10570
|
+
# node.
|
10529
10571
|
# @return [Time]
|
10530
10572
|
#
|
10531
10573
|
# @!attribute [rw] operation
|
@@ -10537,8 +10579,8 @@ module Aws::SSM
|
|
10537
10579
|
# @return [String]
|
10538
10580
|
#
|
10539
10581
|
# @!attribute [rw] last_no_reboot_install_operation_time
|
10540
|
-
# The time of the last attempt to patch the
|
10541
|
-
# specified as the reboot option.
|
10582
|
+
# The time of the last attempt to patch the managed node with
|
10583
|
+
# `NoReboot` specified as the reboot option.
|
10542
10584
|
# @return [Time]
|
10543
10585
|
#
|
10544
10586
|
# @!attribute [rw] reboot_option
|
@@ -10549,8 +10591,8 @@ module Aws::SSM
|
|
10549
10591
|
#
|
10550
10592
|
# </note>
|
10551
10593
|
#
|
10552
|
-
# * `RebootIfNeeded`\: Patch Manager tries to reboot the
|
10553
|
-
# it installed any patches, or if any patches are detected with a
|
10594
|
+
# * `RebootIfNeeded`\: Patch Manager tries to reboot the managed node
|
10595
|
+
# if it installed any patches, or if any patches are detected with a
|
10554
10596
|
# status of `InstalledPendingReboot`.
|
10555
10597
|
#
|
10556
10598
|
# * `NoReboot`\: Patch Manager attempts to install missing packages
|
@@ -10560,25 +10602,26 @@ module Aws::SSM
|
|
10560
10602
|
# @return [String]
|
10561
10603
|
#
|
10562
10604
|
# @!attribute [rw] critical_non_compliant_count
|
10563
|
-
# The number of
|
10605
|
+
# The number of managed nodes where patches that are specified as
|
10564
10606
|
# `Critical` for compliance reporting in the patch baseline aren't
|
10565
10607
|
# installed. These patches might be missing, have failed installation,
|
10566
|
-
# were rejected, or were installed but awaiting a required
|
10567
|
-
# reboot. The status of these
|
10608
|
+
# were rejected, or were installed but awaiting a required managed
|
10609
|
+
# node reboot. The status of these managed nodes is `NON_COMPLIANT`.
|
10568
10610
|
# @return [Integer]
|
10569
10611
|
#
|
10570
10612
|
# @!attribute [rw] security_non_compliant_count
|
10571
|
-
# The number of
|
10613
|
+
# The number of managed nodes where patches that are specified as
|
10572
10614
|
# `Security` in a patch advisory aren't installed. These patches
|
10573
10615
|
# might be missing, have failed installation, were rejected, or were
|
10574
|
-
# installed but awaiting a required
|
10575
|
-
# these
|
10616
|
+
# installed but awaiting a required managed node reboot. The status of
|
10617
|
+
# these managed nodes is `NON_COMPLIANT`.
|
10576
10618
|
# @return [Integer]
|
10577
10619
|
#
|
10578
10620
|
# @!attribute [rw] other_non_compliant_count
|
10579
|
-
# The number of
|
10580
|
-
# other than `Critical` or `Security` but aren't
|
10581
|
-
# patch baseline. The status of these
|
10621
|
+
# The number of managed nodes with patches installed that are
|
10622
|
+
# specified as other than `Critical` or `Security` but aren't
|
10623
|
+
# compliant with the patch baseline. The status of these managed nodes
|
10624
|
+
# is `NON_COMPLIANT`.
|
10582
10625
|
# @return [Integer]
|
10583
10626
|
#
|
10584
10627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InstancePatchState AWS API Documentation
|
@@ -10613,9 +10656,9 @@ module Aws::SSM
|
|
10613
10656
|
# Defines a filter used in DescribeInstancePatchStatesForPatchGroup to
|
10614
10657
|
# scope down the information returned by the API.
|
10615
10658
|
#
|
10616
|
-
# **Example**\: To filter for all
|
10617
|
-
# than three patches with a `FailedCount` status, use the following
|
10618
|
-
# the filter:
|
10659
|
+
# **Example**\: To filter for all managed nodes in a patch group having
|
10660
|
+
# more than three patches with a `FailedCount` status, use the following
|
10661
|
+
# for the filter:
|
10619
10662
|
#
|
10620
10663
|
# * Value for `Key`\: `FailedCount`
|
10621
10664
|
#
|
@@ -10980,7 +11023,7 @@ module Aws::SSM
|
|
10980
11023
|
|
10981
11024
|
# The following problems can cause this exception:
|
10982
11025
|
#
|
10983
|
-
# * You don't have permission to access the
|
11026
|
+
# * You don't have permission to access the managed node.
|
10984
11027
|
#
|
10985
11028
|
# * Amazon Web Services Systems Manager Agent(SSM Agent) isn't running.
|
10986
11029
|
# Verify that SSM Agent is running.
|
@@ -10988,7 +11031,7 @@ module Aws::SSM
|
|
10988
11031
|
# * SSM Agent isn't registered with the SSM endpoint. Try reinstalling
|
10989
11032
|
# SSM Agent.
|
10990
11033
|
#
|
10991
|
-
# * The
|
11034
|
+
# * The managed node isn't in valid state. Valid states are: `Running`,
|
10992
11035
|
# `Pending`, `Stopped`, and `Stopping`. Invalid states are:
|
10993
11036
|
# `Shutting-down` and `Terminated`.
|
10994
11037
|
#
|
@@ -11211,7 +11254,7 @@ module Aws::SSM
|
|
11211
11254
|
class InvalidResourceId < Aws::EmptyStructure; end
|
11212
11255
|
|
11213
11256
|
# The resource type isn't valid. For example, if you are attempting to
|
11214
|
-
# tag an instance, the instance must be a registered
|
11257
|
+
# tag an EC2 instance, the instance must be a registered managed node.
|
11215
11258
|
#
|
11216
11259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InvalidResourceType AWS API Documentation
|
11217
11260
|
#
|
@@ -11492,8 +11535,8 @@ module Aws::SSM
|
|
11492
11535
|
# @return [String]
|
11493
11536
|
#
|
11494
11537
|
# @!attribute [rw] values
|
11495
|
-
# Inventory filter values. Example: inventory filter where
|
11496
|
-
# IDs are specified as values
|
11538
|
+
# Inventory filter values. Example: inventory filter where managed
|
11539
|
+
# node IDs are specified as values
|
11497
11540
|
# `Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g,
|
11498
11541
|
# i-1a2b3c4d5e6,Type=Equal`.
|
11499
11542
|
# @return [Array<String>]
|
@@ -11560,7 +11603,7 @@ module Aws::SSM
|
|
11560
11603
|
include Aws::Structure
|
11561
11604
|
end
|
11562
11605
|
|
11563
|
-
# Information collected from managed
|
11606
|
+
# Information collected from managed nodes based on your inventory
|
11564
11607
|
# policy document
|
11565
11608
|
#
|
11566
11609
|
# @note When making an API call, you may pass InventoryItem
|
@@ -11687,9 +11730,9 @@ module Aws::SSM
|
|
11687
11730
|
# Inventory query results.
|
11688
11731
|
#
|
11689
11732
|
# @!attribute [rw] id
|
11690
|
-
# ID of the inventory result entity. For example, for managed
|
11691
|
-
# inventory the result will be the managed
|
11692
|
-
#
|
11733
|
+
# ID of the inventory result entity. For example, for managed node
|
11734
|
+
# inventory the result will be the managed node ID. For EC2 instance
|
11735
|
+
# inventory, the result will be the instance ID.
|
11693
11736
|
# @return [String]
|
11694
11737
|
#
|
11695
11738
|
# @!attribute [rw] data
|
@@ -11743,8 +11786,9 @@ module Aws::SSM
|
|
11743
11786
|
include Aws::Structure
|
11744
11787
|
end
|
11745
11788
|
|
11746
|
-
# The command ID and
|
11747
|
-
# invocations. Verify the command ID and the
|
11789
|
+
# The command ID and managed node ID you specified didn't match any
|
11790
|
+
# invocations. Verify the command ID and the managed node ID and try
|
11791
|
+
# again.
|
11748
11792
|
#
|
11749
11793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InvocationDoesNotExist AWS API Documentation
|
11750
11794
|
#
|
@@ -11913,7 +11957,7 @@ module Aws::SSM
|
|
11913
11957
|
#
|
11914
11958
|
# <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
|
11915
11959
|
# legacy associations created using the `InstanceID` attribute.
|
11916
|
-
# Associations targeting the
|
11960
|
+
# Associations targeting the managed node that are part of the Target
|
11917
11961
|
# Attributes `ResourceGroup` or `Tags` aren't returned.
|
11918
11962
|
#
|
11919
11963
|
# </note>
|
@@ -11980,7 +12024,8 @@ module Aws::SSM
|
|
11980
12024
|
# @return [String]
|
11981
12025
|
#
|
11982
12026
|
# @!attribute [rw] instance_id
|
11983
|
-
# (Optional) The command execution details for a specific
|
12027
|
+
# (Optional) The command execution details for a specific managed node
|
12028
|
+
# ID.
|
11984
12029
|
# @return [String]
|
11985
12030
|
#
|
11986
12031
|
# @!attribute [rw] max_results
|
@@ -12056,11 +12101,11 @@ module Aws::SSM
|
|
12056
12101
|
# @return [String]
|
12057
12102
|
#
|
12058
12103
|
# @!attribute [rw] instance_id
|
12059
|
-
# (Optional) Lists commands issued against this
|
12104
|
+
# (Optional) Lists commands issued against this managed node ID.
|
12060
12105
|
#
|
12061
|
-
# <note markdown="1"> You can't specify
|
12106
|
+
# <note markdown="1"> You can't specify a managed node ID in the same command that you
|
12062
12107
|
# specify `Status` = `Pending`. This is because the command hasn't
|
12063
|
-
# reached the
|
12108
|
+
# reached the managed node yet.
|
12064
12109
|
#
|
12065
12110
|
# </note>
|
12066
12111
|
# @return [String]
|
@@ -12480,7 +12525,7 @@ module Aws::SSM
|
|
12480
12525
|
# }
|
12481
12526
|
#
|
12482
12527
|
# @!attribute [rw] instance_id
|
12483
|
-
# The
|
12528
|
+
# The managed node ID for which you want inventory information.
|
12484
12529
|
# @return [String]
|
12485
12530
|
#
|
12486
12531
|
# @!attribute [rw] type_name
|
@@ -12520,21 +12565,21 @@ module Aws::SSM
|
|
12520
12565
|
# @return [String]
|
12521
12566
|
#
|
12522
12567
|
# @!attribute [rw] instance_id
|
12523
|
-
# The
|
12568
|
+
# The managed node ID targeted by the request to query inventory
|
12524
12569
|
# information.
|
12525
12570
|
# @return [String]
|
12526
12571
|
#
|
12527
12572
|
# @!attribute [rw] schema_version
|
12528
|
-
# The inventory schema version used by the
|
12573
|
+
# The inventory schema version used by the managed node(s).
|
12529
12574
|
# @return [String]
|
12530
12575
|
#
|
12531
12576
|
# @!attribute [rw] capture_time
|
12532
|
-
# The time that inventory information was collected for the
|
12533
|
-
#
|
12577
|
+
# The time that inventory information was collected for the managed
|
12578
|
+
# node(s).
|
12534
12579
|
# @return [String]
|
12535
12580
|
#
|
12536
12581
|
# @!attribute [rw] entries
|
12537
|
-
# A list of inventory items on the
|
12582
|
+
# A list of inventory items on the managed node(s).
|
12538
12583
|
# @return [Array<Hash<String,String>>]
|
12539
12584
|
#
|
12540
12585
|
# @!attribute [rw] next_token
|
@@ -12780,7 +12825,7 @@ module Aws::SSM
|
|
12780
12825
|
end
|
12781
12826
|
|
12782
12827
|
# @!attribute [rw] resource_compliance_summary_items
|
12783
|
-
# A summary count for specified or targeted managed
|
12828
|
+
# A summary count for specified or targeted managed nodes. Summary
|
12784
12829
|
# count includes information about compliant and non-compliant State
|
12785
12830
|
# Manager associations, patch status, or custom items according to the
|
12786
12831
|
# filter criteria that you specify.
|
@@ -12895,7 +12940,7 @@ module Aws::SSM
|
|
12895
12940
|
end
|
12896
12941
|
|
12897
12942
|
# Information about an Amazon Simple Storage Service (Amazon S3) bucket
|
12898
|
-
# to write
|
12943
|
+
# to write managed node-level logs to.
|
12899
12944
|
#
|
12900
12945
|
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
12901
12946
|
# Service (Amazon S3) bucket to contain logs, instead use the
|
@@ -13446,7 +13491,7 @@ module Aws::SSM
|
|
13446
13491
|
#
|
13447
13492
|
# @!attribute [rw] notification_config
|
13448
13493
|
# Configurations for sending notifications about command status
|
13449
|
-
# changes on a per-
|
13494
|
+
# changes on a per-managed node basis.
|
13450
13495
|
# @return [Types::NotificationConfig]
|
13451
13496
|
#
|
13452
13497
|
# @!attribute [rw] output_s3_bucket_name
|
@@ -13556,9 +13601,9 @@ module Aws::SSM
|
|
13556
13601
|
# @return [String]
|
13557
13602
|
#
|
13558
13603
|
# @!attribute [rw] targets
|
13559
|
-
# The targets, either
|
13604
|
+
# The targets, either managed nodes or tags.
|
13560
13605
|
#
|
13561
|
-
# Specify
|
13606
|
+
# Specify managed nodes using the following format:
|
13562
13607
|
#
|
13563
13608
|
# `Key=instanceids,Values=<instanceid1>,<instanceid2>`
|
13564
13609
|
#
|
@@ -13618,8 +13663,9 @@ module Aws::SSM
|
|
13618
13663
|
# @return [String]
|
13619
13664
|
#
|
13620
13665
|
# @!attribute [rw] targets
|
13621
|
-
# The targets (either
|
13622
|
-
# using
|
13666
|
+
# The targets (either managed nodes or tags). Managed nodes are
|
13667
|
+
# specified using
|
13668
|
+
# `Key=instanceids,Values=<instanceid1>,<instanceid2>`. Tags are
|
13623
13669
|
# specified using `Key=<tag name>,Values=<tag value>`.
|
13624
13670
|
# @return [Array<Types::Target>]
|
13625
13671
|
#
|
@@ -13943,9 +13989,9 @@ module Aws::SSM
|
|
13943
13989
|
# * `Command`\: Receive notification when the status of a command
|
13944
13990
|
# changes.
|
13945
13991
|
#
|
13946
|
-
# * `Invocation`\: For commands sent to multiple
|
13947
|
-
# notification on a per-
|
13948
|
-
# changes.
|
13992
|
+
# * `Invocation`\: For commands sent to multiple managed nodes,
|
13993
|
+
# receive notification on a per-node basis when the status of a
|
13994
|
+
# command changes.
|
13949
13995
|
# @return [String]
|
13950
13996
|
#
|
13951
13997
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/NotificationConfig AWS API Documentation
|
@@ -15504,45 +15550,45 @@ module Aws::SSM
|
|
15504
15550
|
#
|
15505
15551
|
# @!attribute [rw] advisory_ids
|
15506
15552
|
# The Advisory ID of the patch. For example, `RHSA-2020:3779`. Applies
|
15507
|
-
# to Linux-based
|
15553
|
+
# to Linux-based managed nodes only.
|
15508
15554
|
# @return [Array<String>]
|
15509
15555
|
#
|
15510
15556
|
# @!attribute [rw] bugzilla_ids
|
15511
15557
|
# The Bugzilla ID of the patch. For example, `1600646`. Applies to
|
15512
|
-
# Linux-based
|
15558
|
+
# Linux-based managed nodes only.
|
15513
15559
|
# @return [Array<String>]
|
15514
15560
|
#
|
15515
15561
|
# @!attribute [rw] cve_ids
|
15516
15562
|
# The Common Vulnerabilities and Exposures (CVE) ID of the patch. For
|
15517
|
-
# example, `CVE-2011-3192`. Applies to Linux-based
|
15563
|
+
# example, `CVE-2011-3192`. Applies to Linux-based managed nodes only.
|
15518
15564
|
# @return [Array<String>]
|
15519
15565
|
#
|
15520
15566
|
# @!attribute [rw] name
|
15521
|
-
# The name of the patch. Applies to Linux-based
|
15567
|
+
# The name of the patch. Applies to Linux-based managed nodes only.
|
15522
15568
|
# @return [String]
|
15523
15569
|
#
|
15524
15570
|
# @!attribute [rw] epoch
|
15525
15571
|
# The epoch of the patch. For example in
|
15526
15572
|
# `pkg-example-EE-20180914-2.2.amzn1.noarch`, the epoch value is
|
15527
|
-
# `20180914-2`. Applies to Linux-based
|
15573
|
+
# `20180914-2`. Applies to Linux-based managed nodes only.
|
15528
15574
|
# @return [Integer]
|
15529
15575
|
#
|
15530
15576
|
# @!attribute [rw] version
|
15531
15577
|
# The version number of the patch. For example, in
|
15532
15578
|
# `example-pkg-1.710.10-2.7.abcd.x86_64`, the version number is
|
15533
|
-
# indicated by `-1`. Applies to Linux-based
|
15579
|
+
# indicated by `-1`. Applies to Linux-based managed nodes only.
|
15534
15580
|
# @return [String]
|
15535
15581
|
#
|
15536
15582
|
# @!attribute [rw] release
|
15537
15583
|
# The particular release of a patch. For example, in
|
15538
15584
|
# `pkg-example-EE-20180914-2.2.amzn1.noarch`, the release is
|
15539
|
-
# `2.amaz1`. Applies to Linux-based
|
15585
|
+
# `2.amaz1`. Applies to Linux-based managed nodes only.
|
15540
15586
|
# @return [String]
|
15541
15587
|
#
|
15542
15588
|
# @!attribute [rw] arch
|
15543
15589
|
# The architecture of the patch. For example, in
|
15544
15590
|
# `example-pkg-0.710.10-2.7.abcd.x86_64`, the architecture is
|
15545
|
-
# indicated by `x86_64`. Applies to Linux-based
|
15591
|
+
# indicated by `x86_64`. Applies to Linux-based managed nodes only.
|
15546
15592
|
# @return [String]
|
15547
15593
|
#
|
15548
15594
|
# @!attribute [rw] severity
|
@@ -15554,7 +15600,7 @@ module Aws::SSM
|
|
15554
15600
|
# The source patch repository for the operating system and version,
|
15555
15601
|
# such as `trusty-security` for Ubuntu Server 14.04 LTE and
|
15556
15602
|
# `focal-security` for Ubuntu Server 20.04 LTE. Applies to Linux-based
|
15557
|
-
#
|
15603
|
+
# managed nodes only.
|
15558
15604
|
# @return [String]
|
15559
15605
|
#
|
15560
15606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Patch AWS API Documentation
|
@@ -15625,8 +15671,8 @@ module Aws::SSM
|
|
15625
15671
|
include Aws::Structure
|
15626
15672
|
end
|
15627
15673
|
|
15628
|
-
# Information about the state of a patch on a particular
|
15629
|
-
# relates to the patch baseline used to patch the
|
15674
|
+
# Information about the state of a patch on a particular managed node as
|
15675
|
+
# it relates to the patch baseline used to patch the node.
|
15630
15676
|
#
|
15631
15677
|
# @!attribute [rw] title
|
15632
15678
|
# The title of the patch.
|
@@ -15647,7 +15693,8 @@ module Aws::SSM
|
|
15647
15693
|
# @return [String]
|
15648
15694
|
#
|
15649
15695
|
# @!attribute [rw] state
|
15650
|
-
# The state of the patch on the
|
15696
|
+
# The state of the patch on the managed node, such as INSTALLED or
|
15697
|
+
# FAILED.
|
15651
15698
|
#
|
15652
15699
|
# For descriptions of each patch state, see [About patch
|
15653
15700
|
# compliance][1] in the *Amazon Web Services Systems Manager User
|
@@ -15659,7 +15706,7 @@ module Aws::SSM
|
|
15659
15706
|
# @return [String]
|
15660
15707
|
#
|
15661
15708
|
# @!attribute [rw] installed_time
|
15662
|
-
# The date/time the patch was installed on the
|
15709
|
+
# The date/time the patch was installed on the managed node. Not all
|
15663
15710
|
# operating systems provide this level of information.
|
15664
15711
|
# @return [Time]
|
15665
15712
|
#
|
@@ -15863,10 +15910,10 @@ module Aws::SSM
|
|
15863
15910
|
# @return [String]
|
15864
15911
|
#
|
15865
15912
|
# @!attribute [rw] enable_non_security
|
15866
|
-
# For
|
15913
|
+
# For managed nodes identified by the approval rule filters, enables a
|
15867
15914
|
# patch baseline to apply non-security updates available in the
|
15868
15915
|
# specified repository. The default value is `false`. Applies to Linux
|
15869
|
-
#
|
15916
|
+
# managed nodes only.
|
15870
15917
|
# @return [Boolean]
|
15871
15918
|
#
|
15872
15919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PatchRule AWS API Documentation
|
@@ -15917,9 +15964,9 @@ module Aws::SSM
|
|
15917
15964
|
include Aws::Structure
|
15918
15965
|
end
|
15919
15966
|
|
15920
|
-
# Information about the patches to use to update the
|
15967
|
+
# Information about the patches to use to update the managed nodes,
|
15921
15968
|
# including target operating systems and source repository. Applies to
|
15922
|
-
# Linux
|
15969
|
+
# Linux managed nodes only.
|
15923
15970
|
#
|
15924
15971
|
# @note When making an API call, you may pass PatchSource
|
15925
15972
|
# data as a hash:
|
@@ -16085,8 +16132,8 @@ module Aws::SSM
|
|
16085
16132
|
# }
|
16086
16133
|
#
|
16087
16134
|
# @!attribute [rw] resource_id
|
16088
|
-
# Specify an ID for this resource. For a managed
|
16089
|
-
#
|
16135
|
+
# Specify an ID for this resource. For a managed node, this is the
|
16136
|
+
# node ID.
|
16090
16137
|
# @return [String]
|
16091
16138
|
#
|
16092
16139
|
# @!attribute [rw] resource_type
|
@@ -16177,11 +16224,11 @@ module Aws::SSM
|
|
16177
16224
|
# }
|
16178
16225
|
#
|
16179
16226
|
# @!attribute [rw] instance_id
|
16180
|
-
# An
|
16227
|
+
# An managed node ID where you want to add or update inventory items.
|
16181
16228
|
# @return [String]
|
16182
16229
|
#
|
16183
16230
|
# @!attribute [rw] items
|
16184
|
-
# The inventory items that you want to add or update on
|
16231
|
+
# The inventory items that you want to add or update on managed nodes.
|
16185
16232
|
# @return [Array<Types::InventoryItem>]
|
16186
16233
|
#
|
16187
16234
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutInventoryRequest AWS API Documentation
|
@@ -16639,7 +16686,8 @@ module Aws::SSM
|
|
16639
16686
|
#
|
16640
16687
|
# @!attribute [rw] targets
|
16641
16688
|
# The targets to register with the maintenance window. In other words,
|
16642
|
-
# the
|
16689
|
+
# the managed nodes to run commands on when the maintenance window
|
16690
|
+
# runs.
|
16643
16691
|
#
|
16644
16692
|
# <note markdown="1"> If a single maintenance window task is registered with multiple
|
16645
16693
|
# targets, its task invocations occur sequentially and not in
|
@@ -16649,35 +16697,33 @@ module Aws::SSM
|
|
16649
16697
|
#
|
16650
16698
|
# </note>
|
16651
16699
|
#
|
16652
|
-
# You can specify targets using
|
16653
|
-
# tags that have been applied to
|
16700
|
+
# You can specify targets using managed node IDs, resource group
|
16701
|
+
# names, or tags that have been applied to managed nodes.
|
16654
16702
|
#
|
16655
|
-
# **Example 1**\: Specify
|
16703
|
+
# **Example 1**\: Specify managed node IDs
|
16656
16704
|
#
|
16657
|
-
# `Key=InstanceIds,Values
|
16705
|
+
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`
|
16658
16706
|
#
|
16659
|
-
# **Example 2**\: Use tag key-pairs applied to
|
16707
|
+
# **Example 2**\: Use tag key-pairs applied to managed nodes
|
16660
16708
|
#
|
16661
|
-
# `Key=tag
|
16709
|
+
# `Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`
|
16662
16710
|
#
|
16663
|
-
# **Example 3**\: Use tag-keys applied to
|
16711
|
+
# **Example 3**\: Use tag-keys applied to managed nodes
|
16664
16712
|
#
|
16665
|
-
# `Key=tag-key,Values
|
16713
|
+
# `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`
|
16666
16714
|
#
|
16667
16715
|
# **Example 4**\: Use resource group names
|
16668
16716
|
#
|
16669
|
-
# `Key=resource-groups:Name,Values
|
16717
|
+
# `Key=resource-groups:Name,Values=<resource-group-name>`
|
16670
16718
|
#
|
16671
16719
|
# **Example 5**\: Use filters for resource group types
|
16672
16720
|
#
|
16673
|
-
# `Key=resource-groups:ResourceTypeFilters,Values
|
16674
|
-
# `
|
16721
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`
|
16675
16722
|
#
|
16676
16723
|
# <note markdown="1"> For `Key=resource-groups:ResourceTypeFilters`, specify resource
|
16677
16724
|
# types in the following format
|
16678
16725
|
#
|
16679
|
-
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
|
16680
|
-
# `
|
16726
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC`
|
16681
16727
|
#
|
16682
16728
|
# </note>
|
16683
16729
|
#
|
@@ -16815,7 +16861,7 @@ module Aws::SSM
|
|
16815
16861
|
# @return [String]
|
16816
16862
|
#
|
16817
16863
|
# @!attribute [rw] targets
|
16818
|
-
# The targets (either
|
16864
|
+
# The targets (either managed nodes or maintenance window targets).
|
16819
16865
|
#
|
16820
16866
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
16821
16867
|
# Command-type tasks. Depending on the task, targets are optional for
|
@@ -16826,7 +16872,7 @@ module Aws::SSM
|
|
16826
16872
|
#
|
16827
16873
|
# </note>
|
16828
16874
|
#
|
16829
|
-
# Specify
|
16875
|
+
# Specify managed nodes using the following format:
|
16830
16876
|
#
|
16831
16877
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
16832
16878
|
#
|
@@ -16919,7 +16965,7 @@ module Aws::SSM
|
|
16919
16965
|
#
|
16920
16966
|
# @!attribute [rw] logging_info
|
16921
16967
|
# A structure containing information about an Amazon Simple Storage
|
16922
|
-
# Service (Amazon S3) bucket to write
|
16968
|
+
# Service (Amazon S3) bucket to write managed node-level logs to.
|
16923
16969
|
#
|
16924
16970
|
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple
|
16925
16971
|
# Storage Service (Amazon S3) bucket to contain logs, instead use the
|
@@ -17066,8 +17112,8 @@ module Aws::SSM
|
|
17066
17112
|
# The type of resource from which you want to remove a tag.
|
17067
17113
|
#
|
17068
17114
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
17069
|
-
# on-premises managed
|
17070
|
-
#
|
17115
|
+
# on-premises managed nodes. Specify the name of the managed node in
|
17116
|
+
# the following format: `mi-ID_number `. For example,
|
17071
17117
|
# `mi-1a2b3c4d5e6f`.
|
17072
17118
|
#
|
17073
17119
|
# </note>
|
@@ -17094,10 +17140,9 @@ module Aws::SSM
|
|
17094
17140
|
#
|
17095
17141
|
# For the Document and Parameter values, use the name of the resource.
|
17096
17142
|
#
|
17097
|
-
# <note markdown="1"> The ManagedInstance type for this API operation is only for
|
17098
|
-
# on-premises managed
|
17099
|
-
#
|
17100
|
-
# mi-1a2b3c4d5e6f.
|
17143
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
17144
|
+
# on-premises managed nodes. Specify the name of the managed node in
|
17145
|
+
# the following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
|
17101
17146
|
#
|
17102
17147
|
# </note>
|
17103
17148
|
# @return [String]
|
@@ -17753,13 +17798,13 @@ module Aws::SSM
|
|
17753
17798
|
#
|
17754
17799
|
# @!attribute [rw] token_value
|
17755
17800
|
# An encrypted token value containing session and caller information.
|
17756
|
-
# Used to authenticate the connection to the
|
17801
|
+
# Used to authenticate the connection to the managed node.
|
17757
17802
|
# @return [String]
|
17758
17803
|
#
|
17759
17804
|
# @!attribute [rw] stream_url
|
17760
|
-
# A URL back to SSM Agent on the
|
17761
|
-
# client uses to send commands and receive output from the
|
17762
|
-
# Format:
|
17805
|
+
# A URL back to SSM Agent on the managed node that the Session Manager
|
17806
|
+
# client uses to send commands and receive output from the managed
|
17807
|
+
# node. Format:
|
17763
17808
|
# `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`.
|
17764
17809
|
#
|
17765
17810
|
# **region** represents the Region identifier for an Amazon Web
|
@@ -18071,15 +18116,16 @@ module Aws::SSM
|
|
18071
18116
|
# }
|
18072
18117
|
#
|
18073
18118
|
# @!attribute [rw] instance_ids
|
18074
|
-
# The IDs of the
|
18075
|
-
#
|
18076
|
-
# of
|
18119
|
+
# The IDs of the managed nodes where the command should run.
|
18120
|
+
# Specifying managed node IDs is most useful when you are targeting a
|
18121
|
+
# limited number of managed nodes, though you can specify up to 50
|
18122
|
+
# IDs.
|
18077
18123
|
#
|
18078
|
-
# To target a larger number of
|
18079
|
-
# individual
|
18124
|
+
# To target a larger number of managed nodes, or if you prefer not to
|
18125
|
+
# list individual node IDs, we recommend using the `Targets` option
|
18080
18126
|
# instead. Using `Targets`, which accepts tag key-value pairs to
|
18081
|
-
# identify the
|
18082
|
-
# to tens, hundreds, or thousands of
|
18127
|
+
# identify the managed nodes to send commands to, you can a send
|
18128
|
+
# command to tens, hundreds, or thousands of nodes at once.
|
18083
18129
|
#
|
18084
18130
|
# For more information about how to use targets, see [Using targets
|
18085
18131
|
# and rate controls to send commands to a fleet][1] in the *Amazon Web
|
@@ -18091,15 +18137,15 @@ module Aws::SSM
|
|
18091
18137
|
# @return [Array<String>]
|
18092
18138
|
#
|
18093
18139
|
# @!attribute [rw] targets
|
18094
|
-
# An array of search criteria that targets
|
18140
|
+
# An array of search criteria that targets managed nodes using a
|
18095
18141
|
# `Key,Value` combination that you specify. Specifying targets is most
|
18096
|
-
# useful when you want to send a command to a large number of
|
18097
|
-
#
|
18098
|
-
#
|
18099
|
-
#
|
18142
|
+
# useful when you want to send a command to a large number of managed
|
18143
|
+
# nodes at once. Using `Targets`, which accepts tag key-value pairs to
|
18144
|
+
# identify managed nodes, you can send a command to tens, hundreds, or
|
18145
|
+
# thousands of nodes at once.
|
18100
18146
|
#
|
18101
|
-
# To send a command to a smaller number of
|
18102
|
-
# `InstanceIds` option instead.
|
18147
|
+
# To send a command to a smaller number of managed nodes, you can use
|
18148
|
+
# the `InstanceIds` option instead.
|
18103
18149
|
#
|
18104
18150
|
# For more information about how to use targets, see [Sending commands
|
18105
18151
|
# to a fleet][1] in the *Amazon Web Services Systems Manager User
|
@@ -18193,9 +18239,9 @@ module Aws::SSM
|
|
18193
18239
|
# @return [String]
|
18194
18240
|
#
|
18195
18241
|
# @!attribute [rw] max_concurrency
|
18196
|
-
# (Optional) The maximum number of
|
18197
|
-
# the command at the same time. You can specify a number such as
|
18198
|
-
# a percentage such as 10%. The default value is `50`. For more
|
18242
|
+
# (Optional) The maximum number of managed nodes that are allowed to
|
18243
|
+
# run the command at the same time. You can specify a number such as
|
18244
|
+
# 10 or a percentage such as 10%. The default value is `50`. For more
|
18199
18245
|
# information about how to use `MaxConcurrency`, see [Using
|
18200
18246
|
# concurrency controls][1] in the *Amazon Web Services Systems Manager
|
18201
18247
|
# User Guide*.
|
@@ -18355,14 +18401,14 @@ module Aws::SSM
|
|
18355
18401
|
include Aws::Structure
|
18356
18402
|
end
|
18357
18403
|
|
18358
|
-
# Information about a Session Manager connection to
|
18404
|
+
# Information about a Session Manager connection to a managed node.
|
18359
18405
|
#
|
18360
18406
|
# @!attribute [rw] session_id
|
18361
18407
|
# The ID of the session.
|
18362
18408
|
# @return [String]
|
18363
18409
|
#
|
18364
18410
|
# @!attribute [rw] target
|
18365
|
-
# The
|
18411
|
+
# The managed node that the Session Manager session connected to.
|
18366
18412
|
# @return [String]
|
18367
18413
|
#
|
18368
18414
|
# @!attribute [rw] status
|
@@ -18450,8 +18496,8 @@ module Aws::SSM
|
|
18450
18496
|
# example, specify 2018-08-29T00:00:00Z to see sessions that started
|
18451
18497
|
# before August 29, 2018.
|
18452
18498
|
#
|
18453
|
-
# * Target: Specify
|
18454
|
-
# made.
|
18499
|
+
# * Target: Specify a managed node to which session connections have
|
18500
|
+
# been made.
|
18455
18501
|
#
|
18456
18502
|
# * Owner: Specify an Amazon Web Services user account to see a list
|
18457
18503
|
# of sessions started by that user.
|
@@ -18503,7 +18549,7 @@ module Aws::SSM
|
|
18503
18549
|
include Aws::Structure
|
18504
18550
|
end
|
18505
18551
|
|
18506
|
-
# The number of managed
|
18552
|
+
# The number of managed nodes found for each patch severity level
|
18507
18553
|
# defined in the request filter.
|
18508
18554
|
#
|
18509
18555
|
# @!attribute [rw] critical_count
|
@@ -18938,7 +18984,7 @@ module Aws::SSM
|
|
18938
18984
|
# }
|
18939
18985
|
#
|
18940
18986
|
# @!attribute [rw] target
|
18941
|
-
# The
|
18987
|
+
# The managed node to connect to for the session.
|
18942
18988
|
# @return [String]
|
18943
18989
|
#
|
18944
18990
|
# @!attribute [rw] document_name
|
@@ -18946,7 +18992,7 @@ module Aws::SSM
|
|
18946
18992
|
# settings for the session. For example, `SSM-SessionManagerRunShell`.
|
18947
18993
|
# You can call the GetDocument API to verify the document exists
|
18948
18994
|
# before attempting to start a session. If no document name is
|
18949
|
-
# provided, a shell to the
|
18995
|
+
# provided, a shell to the managed node is launched by default.
|
18950
18996
|
# @return [String]
|
18951
18997
|
#
|
18952
18998
|
# @!attribute [rw] reason
|
@@ -18976,12 +19022,12 @@ module Aws::SSM
|
|
18976
19022
|
#
|
18977
19023
|
# @!attribute [rw] token_value
|
18978
19024
|
# An encrypted token value containing session and caller information.
|
18979
|
-
# Used to authenticate the connection to the
|
19025
|
+
# Used to authenticate the connection to the managed node.
|
18980
19026
|
# @return [String]
|
18981
19027
|
#
|
18982
19028
|
# @!attribute [rw] stream_url
|
18983
|
-
# A URL back to SSM Agent on the
|
18984
|
-
# client uses to send commands and receive output from the
|
19029
|
+
# A URL back to SSM Agent on the managed node that the Session Manager
|
19030
|
+
# client uses to send commands and receive output from the node.
|
18985
19031
|
# Format:
|
18986
19032
|
# `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`
|
18987
19033
|
#
|
@@ -19226,7 +19272,7 @@ module Aws::SSM
|
|
19226
19272
|
# enable you to categorize your resources in different ways, for
|
19227
19273
|
# example, by purpose, owner, or environment. In Amazon Web Services
|
19228
19274
|
# Systems Manager, you can apply tags to Systems Manager documents (SSM
|
19229
|
-
# documents), managed
|
19275
|
+
# documents), managed nodes, maintenance windows, parameters, patch
|
19230
19276
|
# baselines, OpsItems, and OpsMetadata.
|
19231
19277
|
#
|
19232
19278
|
# @note When making an API call, you may pass Tag
|
@@ -19254,8 +19300,8 @@ module Aws::SSM
|
|
19254
19300
|
include Aws::Structure
|
19255
19301
|
end
|
19256
19302
|
|
19257
|
-
# An array of search criteria that targets
|
19258
|
-
# pair that you specify.
|
19303
|
+
# An array of search criteria that targets managed nodes using a
|
19304
|
+
# key-value pair that you specify.
|
19259
19305
|
#
|
19260
19306
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
19261
19307
|
# Command-type tasks. Depending on the task, targets are optional for
|
@@ -19268,21 +19314,20 @@ module Aws::SSM
|
|
19268
19314
|
#
|
19269
19315
|
# Supported formats include the following.
|
19270
19316
|
#
|
19271
|
-
# * `Key=InstanceIds,Values
|
19317
|
+
# * `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`
|
19272
19318
|
#
|
19273
|
-
# * `Key=tag
|
19319
|
+
# * `Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`
|
19274
19320
|
#
|
19275
|
-
# * `Key=tag-key,Values
|
19321
|
+
# * `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`
|
19276
19322
|
#
|
19277
19323
|
# * **Run Command and Maintenance window targets only**\:
|
19278
|
-
# `Key=resource-groups:Name,Values
|
19324
|
+
# `Key=resource-groups:Name,Values=<resource-group-name>`
|
19279
19325
|
#
|
19280
19326
|
# * **Maintenance window targets only**\:
|
19281
|
-
# `Key=resource-groups:ResourceTypeFilters,Values
|
19282
|
-
# `
|
19327
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`
|
19283
19328
|
#
|
19284
19329
|
# * **Automation targets only**\:
|
19285
|
-
# `Key=ResourceGroup;Values
|
19330
|
+
# `Key=ResourceGroup;Values=<resource-group-name>`
|
19286
19331
|
#
|
19287
19332
|
# For example:
|
19288
19333
|
#
|
@@ -19300,8 +19345,7 @@ module Aws::SSM
|
|
19300
19345
|
# window.
|
19301
19346
|
#
|
19302
19347
|
# * **Maintenance window targets only**\:
|
19303
|
-
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
|
19304
|
-
# `
|
19348
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC`
|
19305
19349
|
#
|
19306
19350
|
# This example demonstrates how to target only Amazon Elastic Compute
|
19307
19351
|
# Cloud (Amazon EC2) instances and VPCs in your maintenance window.
|
@@ -19310,14 +19354,14 @@ module Aws::SSM
|
|
19310
19354
|
# `Key=ResourceGroup,Values=MyResourceGroup`
|
19311
19355
|
#
|
19312
19356
|
# * **State Manager association targets only**\:
|
19313
|
-
# `Key=InstanceIds,Values
|
19357
|
+
# `Key=InstanceIds,Values=*`
|
19314
19358
|
#
|
19315
19359
|
# This example demonstrates how to target all managed instances in the
|
19316
19360
|
# Amazon Web Services Region where the association was created.
|
19317
19361
|
#
|
19318
|
-
# For more information about how to send commands that target
|
19319
|
-
# using `Key,Value` parameters, see [Targeting multiple
|
19320
|
-
# the *Amazon Web Services Systems Manager User Guide*.
|
19362
|
+
# For more information about how to send commands that target managed
|
19363
|
+
# nodes using `Key,Value` parameters, see [Targeting multiple
|
19364
|
+
# instances][2] in the *Amazon Web Services Systems Manager User Guide*.
|
19321
19365
|
#
|
19322
19366
|
#
|
19323
19367
|
#
|
@@ -19333,7 +19377,7 @@ module Aws::SSM
|
|
19333
19377
|
# }
|
19334
19378
|
#
|
19335
19379
|
# @!attribute [rw] key
|
19336
|
-
# User-defined criteria for sending commands that target
|
19380
|
+
# User-defined criteria for sending commands that target managed nodes
|
19337
19381
|
# that meet the criteria.
|
19338
19382
|
# @return [String]
|
19339
19383
|
#
|
@@ -19424,12 +19468,12 @@ module Aws::SSM
|
|
19424
19468
|
include Aws::Structure
|
19425
19469
|
end
|
19426
19470
|
|
19427
|
-
# The specified target
|
19428
|
-
# for use with Session Manager. For more information, see
|
19429
|
-
# started with Session Manager][1] in the *Amazon Web Services
|
19430
|
-
# Manager User Guide*. This error is also returned if you
|
19431
|
-
# start a session on
|
19432
|
-
# or Region
|
19471
|
+
# The specified target managed node for the session isn't fully
|
19472
|
+
# configured for use with Session Manager. For more information, see
|
19473
|
+
# [Getting started with Session Manager][1] in the *Amazon Web Services
|
19474
|
+
# Systems Manager User Guide*. This error is also returned if you
|
19475
|
+
# attempt to start a session on a managed node that is located in a
|
19476
|
+
# different account or Region
|
19433
19477
|
#
|
19434
19478
|
#
|
19435
19479
|
#
|
@@ -19658,9 +19702,9 @@ module Aws::SSM
|
|
19658
19702
|
include Aws::Structure
|
19659
19703
|
end
|
19660
19704
|
|
19661
|
-
# The document doesn't support the platform type of the given
|
19662
|
-
# ID(s). For example, you sent an document for a Windows
|
19663
|
-
# Linux
|
19705
|
+
# The document doesn't support the platform type of the given managed
|
19706
|
+
# node ID(s). For example, you sent an document for a Windows managed
|
19707
|
+
# node to a Linux node.
|
19664
19708
|
#
|
19665
19709
|
# @!attribute [rw] message
|
19666
19710
|
# @return [String]
|
@@ -19730,6 +19774,14 @@ module Aws::SSM
|
|
19730
19774
|
#
|
19731
19775
|
# @!attribute [rw] document_version
|
19732
19776
|
# The document version you want update for the association.
|
19777
|
+
#
|
19778
|
+
# State Manager doesn't support running associations that use a new
|
19779
|
+
# version of a document if that document is shared from another
|
19780
|
+
# account. State Manager always runs the `default` version of a
|
19781
|
+
# document if shared from another account, even though the Systems
|
19782
|
+
# Manager console shows that a new version was processed. If you want
|
19783
|
+
# to run an association using a new version of a document shared form
|
19784
|
+
# another account, you must set the document version to `default`.
|
19733
19785
|
# @return [String]
|
19734
19786
|
#
|
19735
19787
|
# @!attribute [rw] schedule_expression
|
@@ -19743,7 +19795,7 @@ module Aws::SSM
|
|
19743
19795
|
#
|
19744
19796
|
# @!attribute [rw] name
|
19745
19797
|
# The name of the SSM Command document or Automation runbook that
|
19746
|
-
# contains the configuration information for the
|
19798
|
+
# contains the configuration information for the managed node.
|
19747
19799
|
#
|
19748
19800
|
# You can specify Amazon Web Services-predefined documents, documents
|
19749
19801
|
# you created, or a document that is shared with you from another
|
@@ -19794,7 +19846,7 @@ module Aws::SSM
|
|
19794
19846
|
# for example, the system stops sending requests when the fourth error
|
19795
19847
|
# is received. If you specify 0, then the system stops sending
|
19796
19848
|
# requests after the first error is returned. If you run an
|
19797
|
-
# association on 50
|
19849
|
+
# association on 50 managed nodes and set `MaxError` to 10%, then the
|
19798
19850
|
# system stops sending the request when the sixth error is received.
|
19799
19851
|
#
|
19800
19852
|
# Executions that are already running an association when `MaxErrors`
|
@@ -19810,10 +19862,10 @@ module Aws::SSM
|
|
19810
19862
|
# of the target set, for example 10%. The default value is 100%, which
|
19811
19863
|
# means all targets run the association at the same time.
|
19812
19864
|
#
|
19813
|
-
# If a new
|
19814
|
-
# Systems Manager is running `MaxConcurrency` associations, the
|
19865
|
+
# If a new managed node starts and attempts to run an association
|
19866
|
+
# while Systems Manager is running `MaxConcurrency` associations, the
|
19815
19867
|
# association is allowed to run. During the next association interval,
|
19816
|
-
# the new
|
19868
|
+
# the new managed node will process its association within the limit
|
19817
19869
|
# specified for `MaxConcurrency`.
|
19818
19870
|
# @return [String]
|
19819
19871
|
#
|
@@ -19927,7 +19979,7 @@ module Aws::SSM
|
|
19927
19979
|
# @return [String]
|
19928
19980
|
#
|
19929
19981
|
# @!attribute [rw] instance_id
|
19930
|
-
# The
|
19982
|
+
# The managed node ID.
|
19931
19983
|
# @return [String]
|
19932
19984
|
#
|
19933
19985
|
# @!attribute [rw] association_status
|
@@ -20524,8 +20576,8 @@ module Aws::SSM
|
|
20524
20576
|
# @return [String]
|
20525
20577
|
#
|
20526
20578
|
# @!attribute [rw] targets
|
20527
|
-
# The targets (either
|
20528
|
-
# specified using the format
|
20579
|
+
# The targets (either managed nodes or tags) to modify. Managed nodes
|
20580
|
+
# are specified using the format
|
20529
20581
|
# `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are
|
20530
20582
|
# specified using the format ` Key=tag_name,Values=tag_value`.
|
20531
20583
|
#
|
@@ -20820,7 +20872,7 @@ module Aws::SSM
|
|
20820
20872
|
# }
|
20821
20873
|
#
|
20822
20874
|
# @!attribute [rw] instance_id
|
20823
|
-
# The ID of the managed
|
20875
|
+
# The ID of the managed node where you want to update the role.
|
20824
20876
|
# @return [String]
|
20825
20877
|
#
|
20826
20878
|
# @!attribute [rw] iam_role
|
@@ -21142,8 +21194,8 @@ module Aws::SSM
|
|
21142
21194
|
#
|
21143
21195
|
# @!attribute [rw] approved_patches_enable_non_security
|
21144
21196
|
# Indicates whether the list of approved patches includes non-security
|
21145
|
-
# updates that should be applied to the
|
21146
|
-
# is `false`. Applies to Linux
|
21197
|
+
# updates that should be applied to the managed nodes. The default
|
21198
|
+
# value is `false`. Applies to Linux managed nodes only.
|
21147
21199
|
# @return [Boolean]
|
21148
21200
|
#
|
21149
21201
|
# @!attribute [rw] rejected_patches
|
@@ -21182,9 +21234,9 @@ module Aws::SSM
|
|
21182
21234
|
# @return [String]
|
21183
21235
|
#
|
21184
21236
|
# @!attribute [rw] sources
|
21185
|
-
# Information about the patches to use to update the
|
21237
|
+
# Information about the patches to use to update the managed nodes,
|
21186
21238
|
# including target operating systems and source repositories. Applies
|
21187
|
-
# to Linux
|
21239
|
+
# to Linux managed nodes only.
|
21188
21240
|
# @return [Array<Types::PatchSource>]
|
21189
21241
|
#
|
21190
21242
|
# @!attribute [rw] replace
|
@@ -21243,8 +21295,8 @@ module Aws::SSM
|
|
21243
21295
|
#
|
21244
21296
|
# @!attribute [rw] approved_patches_enable_non_security
|
21245
21297
|
# Indicates whether the list of approved patches includes non-security
|
21246
|
-
# updates that should be applied to the
|
21247
|
-
# is `false`. Applies to Linux
|
21298
|
+
# updates that should be applied to the managed nodes. The default
|
21299
|
+
# value is `false`. Applies to Linux managed nodes only.
|
21248
21300
|
# @return [Boolean]
|
21249
21301
|
#
|
21250
21302
|
# @!attribute [rw] rejected_patches
|
@@ -21271,9 +21323,9 @@ module Aws::SSM
|
|
21271
21323
|
# @return [String]
|
21272
21324
|
#
|
21273
21325
|
# @!attribute [rw] sources
|
21274
|
-
# Information about the patches to use to update the
|
21326
|
+
# Information about the patches to use to update the managed nodes,
|
21275
21327
|
# including target operating systems and source repositories. Applies
|
21276
|
-
# to Linux
|
21328
|
+
# to Linux managed nodes only.
|
21277
21329
|
# @return [Array<Types::PatchSource>]
|
21278
21330
|
#
|
21279
21331
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdatePatchBaselineResult AWS API Documentation
|