aws-sdk-ssm 1.122.0 → 1.126.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm/client.rb +262 -245
- data/lib/aws-sdk-ssm/client_api.rb +21 -0
- data/lib/aws-sdk-ssm/types.rb +567 -489
- data/lib/aws-sdk-ssm.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -119,7 +119,9 @@ module Aws::SSM
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -347,13 +349,13 @@ module Aws::SSM
|
|
347
349
|
# @!group API Operations
|
348
350
|
|
349
351
|
# Adds or overwrites one or more tags for the specified resource. Tags
|
350
|
-
# are metadata that you can assign to your documents, managed
|
352
|
+
# are metadata that you can assign to your documents, managed nodes,
|
351
353
|
# maintenance windows, Parameter Store parameters, and patch baselines.
|
352
354
|
# Tags enable you to categorize your resources in different ways, for
|
353
355
|
# example, by purpose, owner, or environment. Each tag consists of a key
|
354
356
|
# and an optional value, both of which you define. For example, you
|
355
|
-
# could define a set of tags for your account's managed
|
356
|
-
# helps you track each
|
357
|
+
# could define a set of tags for your account's managed nodes that
|
358
|
+
# helps you track each node's owner and stack level. For example:
|
357
359
|
#
|
358
360
|
# * `Key=Owner,Value=DbAdmin`
|
359
361
|
#
|
@@ -387,9 +389,8 @@ module Aws::SSM
|
|
387
389
|
# Specifies the type of resource you are tagging.
|
388
390
|
#
|
389
391
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is for on-premises
|
390
|
-
# managed
|
391
|
-
#
|
392
|
-
# `mi-1a2b3c4d5e6f`.
|
392
|
+
# managed nodes. You must specify the name of the managed node in the
|
393
|
+
# following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.
|
393
394
|
#
|
394
395
|
# </note>
|
395
396
|
#
|
@@ -416,9 +417,9 @@ module Aws::SSM
|
|
416
417
|
# `ManagedInstance`\: `mi-012345abcde`
|
417
418
|
#
|
418
419
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
419
|
-
# on-premises managed
|
420
|
-
#
|
421
|
-
#
|
420
|
+
# on-premises managed nodes. You must specify the name of the managed
|
421
|
+
# node in the following format: `mi-ID_number `. For example,
|
422
|
+
# `mi-1a2b3c4d5e6f`.
|
422
423
|
#
|
423
424
|
# </note>
|
424
425
|
#
|
@@ -511,8 +512,8 @@ module Aws::SSM
|
|
511
512
|
# The ID of the command you want to cancel.
|
512
513
|
#
|
513
514
|
# @option params [Array<String>] :instance_ids
|
514
|
-
# (Optional) A list of
|
515
|
-
# command. If not provided, the command is canceled on every
|
515
|
+
# (Optional) A list of managed node IDs on which you want to cancel the
|
516
|
+
# command. If not provided, the command is canceled on every node on
|
516
517
|
# which it was requested.
|
517
518
|
#
|
518
519
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -564,19 +565,19 @@ module Aws::SSM
|
|
564
565
|
end
|
565
566
|
|
566
567
|
# Generates an activation code and activation ID you can use to register
|
567
|
-
# your on-premises
|
568
|
-
# Services Systems Manager. Registering these machines with
|
569
|
-
# Manager makes it possible to manage them using Systems Manager
|
568
|
+
# your on-premises servers, edge devices, or virtual machine (VM) with
|
569
|
+
# Amazon Web Services Systems Manager. Registering these machines with
|
570
|
+
# Systems Manager makes it possible to manage them using Systems Manager
|
570
571
|
# capabilities. You use the activation code and ID when installing SSM
|
571
572
|
# Agent on machines in your hybrid environment. For more information
|
572
|
-
# about requirements for managing on-premises
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
573
|
+
# about requirements for managing on-premises machines using Systems
|
574
|
+
# Manager, see [Setting up Amazon Web Services Systems Manager for
|
575
|
+
# hybrid environments][1] in the *Amazon Web Services Systems Manager
|
576
|
+
# User Guide*.
|
576
577
|
#
|
577
|
-
# <note markdown="1">
|
578
|
-
#
|
579
|
-
#
|
578
|
+
# <note markdown="1"> Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and
|
579
|
+
# on-premises servers and VMs that are configured for Systems Manager
|
580
|
+
# are all called *managed nodes*.
|
580
581
|
#
|
581
582
|
# </note>
|
582
583
|
#
|
@@ -591,7 +592,7 @@ module Aws::SSM
|
|
591
592
|
# Don't enter personally identifiable information in this field.
|
592
593
|
#
|
593
594
|
# @option params [String] :default_instance_name
|
594
|
-
# The name of the registered, managed
|
595
|
+
# The name of the registered, managed node as it will appear in the
|
595
596
|
# Amazon Web Services Systems Manager console or when you use the Amazon
|
596
597
|
# Web Services command line tools to list Systems Manager resources.
|
597
598
|
#
|
@@ -599,7 +600,7 @@ module Aws::SSM
|
|
599
600
|
#
|
600
601
|
# @option params [required, String] :iam_role
|
601
602
|
# The name of the Identity and Access Management (IAM) role that you
|
602
|
-
# want to assign to the managed
|
603
|
+
# want to assign to the managed node. This IAM role must provide
|
603
604
|
# AssumeRole permissions for the Amazon Web Services Systems Manager
|
604
605
|
# service principal `ssm.amazonaws.com`. For more information, see
|
605
606
|
# [Create an IAM service role for a hybrid environment][1] in the
|
@@ -610,8 +611,8 @@ module Aws::SSM
|
|
610
611
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html
|
611
612
|
#
|
612
613
|
# @option params [Integer] :registration_limit
|
613
|
-
# Specify the maximum number of managed
|
614
|
-
#
|
614
|
+
# Specify the maximum number of managed nodes you want to register. The
|
615
|
+
# default value is `1`.
|
615
616
|
#
|
616
617
|
# @option params [Time,DateTime,Date,Integer,String] :expiration_date
|
617
618
|
# The date by which this activation request should expire, in timestamp
|
@@ -637,13 +638,16 @@ module Aws::SSM
|
|
637
638
|
# the on-premises servers or VMs.
|
638
639
|
#
|
639
640
|
# You can't add tags to or delete tags from an existing activation. You
|
640
|
-
# can tag your on-premises servers and VMs after they
|
641
|
-
# Manager for the first time and are assigned a
|
642
|
-
# This means they are listed in the Amazon Web Services
|
643
|
-
# console with an ID that is prefixed with "mi-". For
|
644
|
-
# about how to add tags to your managed
|
641
|
+
# can tag your on-premises servers, edge devices, and VMs after they
|
642
|
+
# connect to Systems Manager for the first time and are assigned a
|
643
|
+
# managed node ID. This means they are listed in the Amazon Web Services
|
644
|
+
# Systems Manager console with an ID that is prefixed with "mi-". For
|
645
|
+
# information about how to add tags to your managed nodes, see
|
645
646
|
# AddTagsToResource. For information about how to remove tags from your
|
646
|
-
# managed
|
647
|
+
# managed nodes, see RemoveTagsFromResource.
|
648
|
+
#
|
649
|
+
# @option params [Array<Types::RegistrationMetadataItem>] :registration_metadata
|
650
|
+
# Reserved for internal use.
|
647
651
|
#
|
648
652
|
# @return [Types::CreateActivationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
649
653
|
#
|
@@ -664,6 +668,12 @@ module Aws::SSM
|
|
664
668
|
# value: "TagValue", # required
|
665
669
|
# },
|
666
670
|
# ],
|
671
|
+
# registration_metadata: [
|
672
|
+
# {
|
673
|
+
# key: "RegistrationMetadataKey", # required
|
674
|
+
# value: "RegistrationMetadataValue", # required
|
675
|
+
# },
|
676
|
+
# ],
|
667
677
|
# })
|
668
678
|
#
|
669
679
|
# @example Response structure
|
@@ -681,16 +691,16 @@ module Aws::SSM
|
|
681
691
|
end
|
682
692
|
|
683
693
|
# A State Manager association defines the state that you want to
|
684
|
-
# maintain on your
|
685
|
-
# that anti-virus software must be installed and running on your
|
686
|
-
#
|
687
|
-
# the association specifies a schedule for when the
|
688
|
-
# reapplied. For dynamic targets, such as an Amazon Web
|
689
|
-
# resource group or an Amazon Web Services autoscaling group,
|
690
|
-
# Manager, a capability of Amazon Web Services Systems Manager
|
691
|
-
# the configuration when new
|
692
|
-
# association also specifies actions to take when applying
|
693
|
-
# configuration. For example, an association for anti-virus software
|
694
|
+
# maintain on your managed nodes. For example, an association can
|
695
|
+
# specify that anti-virus software must be installed and running on your
|
696
|
+
# managed nodes, or that certain ports must be closed. For static
|
697
|
+
# targets, the association specifies a schedule for when the
|
698
|
+
# configuration is reapplied. For dynamic targets, such as an Amazon Web
|
699
|
+
# Services resource group or an Amazon Web Services autoscaling group,
|
700
|
+
# State Manager, a capability of Amazon Web Services Systems Manager
|
701
|
+
# applies the configuration when new managed nodes are added to the
|
702
|
+
# group. The association also specifies actions to take when applying
|
703
|
+
# the configuration. For example, an association for anti-virus software
|
694
704
|
# might run once a day. If the software isn't installed, then State
|
695
705
|
# Manager installs it. If the software is installed, but the service
|
696
706
|
# isn't running, then the association might instruct State Manager to
|
@@ -698,7 +708,7 @@ module Aws::SSM
|
|
698
708
|
#
|
699
709
|
# @option params [required, String] :name
|
700
710
|
# The name of the SSM Command document or Automation runbook that
|
701
|
-
# contains the configuration information for the
|
711
|
+
# contains the configuration information for the managed node.
|
702
712
|
#
|
703
713
|
# You can specify Amazon Web Services-predefined documents, documents
|
704
714
|
# you created, or a document that is shared with you from another
|
@@ -723,9 +733,9 @@ module Aws::SSM
|
|
723
733
|
# a specific version or the default version.
|
724
734
|
#
|
725
735
|
# @option params [String] :instance_id
|
726
|
-
# The
|
736
|
+
# The managed node ID.
|
727
737
|
#
|
728
|
-
# <note markdown="1"> `InstanceId` has been deprecated. To specify
|
738
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify a managed node ID for an
|
729
739
|
# association, use the `Targets` parameter. Requests that include the
|
730
740
|
# parameter `InstanceID` with Systems Manager documents (SSM documents)
|
731
741
|
# that use schema version 2.0 or later will fail. In addition, if you
|
@@ -740,14 +750,14 @@ module Aws::SSM
|
|
740
750
|
# The parameters for the runtime configuration of the document.
|
741
751
|
#
|
742
752
|
# @option params [Array<Types::Target>] :targets
|
743
|
-
# The targets for the association. You can target
|
744
|
-
# tags, Amazon Web Services resource groups, all
|
745
|
-
# Web Services account, or individual
|
746
|
-
#
|
747
|
-
# `InstanceIds` key with a value of `*`. For more
|
748
|
-
# choosing targets for an association, see [Using
|
749
|
-
# controls with State Manager associations][1] in the
|
750
|
-
# Services Systems Manager User Guide*.
|
753
|
+
# The targets for the association. You can target managed nodes by using
|
754
|
+
# tags, Amazon Web Services resource groups, all managed nodes in an
|
755
|
+
# Amazon Web Services account, or individual managed node IDs. You can
|
756
|
+
# target all managed nodes in an Amazon Web Services account by
|
757
|
+
# specifying the `InstanceIds` key with a value of `*`. For more
|
758
|
+
# information about choosing targets for an association, see [Using
|
759
|
+
# targets and rate controls with State Manager associations][1] in the
|
760
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
751
761
|
#
|
752
762
|
#
|
753
763
|
#
|
@@ -777,9 +787,9 @@ module Aws::SSM
|
|
777
787
|
# of the target set, for example 10%. If you specify 3, for example, the
|
778
788
|
# system stops sending requests when the fourth error is received. If
|
779
789
|
# you specify 0, then the system stops sending requests after the first
|
780
|
-
# error is returned. If you run an association on 50
|
781
|
-
# `MaxError` to 10%, then the system stops sending the request when
|
782
|
-
# sixth error is received.
|
790
|
+
# error is returned. If you run an association on 50 managed nodes and
|
791
|
+
# set `MaxError` to 10%, then the system stops sending the request when
|
792
|
+
# the sixth error is received.
|
783
793
|
#
|
784
794
|
# Executions that are already running an association when `MaxErrors` is
|
785
795
|
# reached are allowed to complete, but some of these executions may fail
|
@@ -793,10 +803,10 @@ module Aws::SSM
|
|
793
803
|
# of the target set, for example 10%. The default value is 100%, which
|
794
804
|
# means all targets run the association at the same time.
|
795
805
|
#
|
796
|
-
# If a new
|
806
|
+
# If a new managed node starts and attempts to run an association while
|
797
807
|
# Systems Manager is running `MaxConcurrency` associations, the
|
798
808
|
# association is allowed to run. During the next association interval,
|
799
|
-
# the new
|
809
|
+
# the new managed node will process its association within the limit
|
800
810
|
# specified for `MaxConcurrency`.
|
801
811
|
#
|
802
812
|
# @option params [String] :compliance_severity
|
@@ -944,14 +954,14 @@ module Aws::SSM
|
|
944
954
|
end
|
945
955
|
|
946
956
|
# Associates the specified Amazon Web Services Systems Manager document
|
947
|
-
# (SSM document) with the specified
|
957
|
+
# (SSM document) with the specified managed nodes or targets.
|
948
958
|
#
|
949
|
-
# When you associate a document with one or more
|
950
|
-
#
|
951
|
-
#
|
952
|
-
#
|
959
|
+
# When you associate a document with one or more managed nodes using IDs
|
960
|
+
# or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running
|
961
|
+
# on the managed node processes the document and configures the node as
|
962
|
+
# specified.
|
953
963
|
#
|
954
|
-
# If you associate a document with
|
964
|
+
# If you associate a document with a managed node that already has an
|
955
965
|
# associated document, the system returns the AssociationAlreadyExists
|
956
966
|
# exception.
|
957
967
|
#
|
@@ -1103,7 +1113,7 @@ module Aws::SSM
|
|
1103
1113
|
|
1104
1114
|
# Creates a Amazon Web Services Systems Manager (SSM document). An SSM
|
1105
1115
|
# document defines the actions that Systems Manager performs on your
|
1106
|
-
# managed
|
1116
|
+
# managed nodes. For more information about SSM documents, including
|
1107
1117
|
# information about supported schemas, features, and syntax, see [Amazon
|
1108
1118
|
# Web Services Systems Manager Documents][1] in the *Amazon Web Services
|
1109
1119
|
# Systems Manager User Guide*.
|
@@ -1264,7 +1274,7 @@ module Aws::SSM
|
|
1264
1274
|
# resp.document_description.parameters[0].description #=> String
|
1265
1275
|
# resp.document_description.parameters[0].default_value #=> String
|
1266
1276
|
# resp.document_description.platform_types #=> Array
|
1267
|
-
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
1277
|
+
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
1268
1278
|
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
1269
1279
|
# resp.document_description.schema_version #=> String
|
1270
1280
|
# resp.document_description.latest_version #=> String
|
@@ -1363,10 +1373,10 @@ module Aws::SSM
|
|
1363
1373
|
# execution.
|
1364
1374
|
#
|
1365
1375
|
# @option params [required, Boolean] :allow_unassociated_targets
|
1366
|
-
# Enables a maintenance window task to run on managed
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
#
|
1376
|
+
# Enables a maintenance window task to run on managed nodes, even if you
|
1377
|
+
# haven't registered those nodes as targets. If enabled, then you must
|
1378
|
+
# specify the unregistered managed nodes (by node ID) when you register
|
1379
|
+
# a task with the maintenance window.
|
1370
1380
|
#
|
1371
1381
|
# If you don't enable this option, then you must specify
|
1372
1382
|
# previously-registered targets when you register a task with the
|
@@ -1707,8 +1717,8 @@ module Aws::SSM
|
|
1707
1717
|
#
|
1708
1718
|
# @option params [Boolean] :approved_patches_enable_non_security
|
1709
1719
|
# Indicates whether the list of approved patches includes non-security
|
1710
|
-
# updates that should be applied to the
|
1711
|
-
# `false`. Applies to Linux
|
1720
|
+
# updates that should be applied to the managed nodes. The default value
|
1721
|
+
# is `false`. Applies to Linux managed nodes only.
|
1712
1722
|
#
|
1713
1723
|
# @option params [Array<String>] :rejected_patches
|
1714
1724
|
# A list of explicitly rejected patches for the baseline.
|
@@ -1743,9 +1753,9 @@ module Aws::SSM
|
|
1743
1753
|
# A description of the patch baseline.
|
1744
1754
|
#
|
1745
1755
|
# @option params [Array<Types::PatchSource>] :sources
|
1746
|
-
# Information about the patches to use to update the
|
1756
|
+
# Information about the patches to use to update the managed nodes,
|
1747
1757
|
# including target operating systems and source repositories. Applies to
|
1748
|
-
# Linux
|
1758
|
+
# Linux managed nodes only.
|
1749
1759
|
#
|
1750
1760
|
# @option params [String] :client_token
|
1751
1761
|
# User-provided idempotency token.
|
@@ -1943,9 +1953,8 @@ module Aws::SSM
|
|
1943
1953
|
|
1944
1954
|
# Deletes an activation. You aren't required to delete an activation.
|
1945
1955
|
# If you delete an activation, you can no longer use it to register
|
1946
|
-
# additional managed
|
1947
|
-
#
|
1948
|
-
# instances.
|
1956
|
+
# additional managed nodes. Deleting an activation doesn't de-register
|
1957
|
+
# managed nodes. You must manually de-register managed nodes.
|
1949
1958
|
#
|
1950
1959
|
# @option params [required, String] :activation_id
|
1951
1960
|
# The ID of the activation that you want to delete.
|
@@ -1968,23 +1977,23 @@ module Aws::SSM
|
|
1968
1977
|
end
|
1969
1978
|
|
1970
1979
|
# Disassociates the specified Amazon Web Services Systems Manager
|
1971
|
-
# document (SSM document) from the specified
|
1972
|
-
# the association by using the `Targets` parameter, then you
|
1973
|
-
# the association by using the association ID.
|
1980
|
+
# document (SSM document) from the specified managed node. If you
|
1981
|
+
# created the association by using the `Targets` parameter, then you
|
1982
|
+
# must delete the association by using the association ID.
|
1974
1983
|
#
|
1975
|
-
# When you disassociate a document from
|
1976
|
-
# the configuration of the
|
1977
|
-
# of
|
1978
|
-
# new document with the desired configuration and associate it
|
1979
|
-
#
|
1984
|
+
# When you disassociate a document from a managed node, it doesn't
|
1985
|
+
# change the configuration of the node. To change the configuration
|
1986
|
+
# state of a managed node after you disassociate a document, you must
|
1987
|
+
# create a new document with the desired configuration and associate it
|
1988
|
+
# with the node.
|
1980
1989
|
#
|
1981
1990
|
# @option params [String] :name
|
1982
1991
|
# The name of the SSM document.
|
1983
1992
|
#
|
1984
1993
|
# @option params [String] :instance_id
|
1985
|
-
# The
|
1994
|
+
# The managed node ID.
|
1986
1995
|
#
|
1987
|
-
# <note markdown="1"> `InstanceId` has been deprecated. To specify
|
1996
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify a managed node ID for an
|
1988
1997
|
# association, use the `Targets` parameter. Requests that include the
|
1989
1998
|
# parameter `InstanceID` with Systems Manager documents (SSM documents)
|
1990
1999
|
# that use schema version 2.0 or later will fail. In addition, if you
|
@@ -2018,11 +2027,11 @@ module Aws::SSM
|
|
2018
2027
|
end
|
2019
2028
|
|
2020
2029
|
# Deletes the Amazon Web Services Systems Manager document (SSM
|
2021
|
-
# document) and all
|
2030
|
+
# document) and all managed node associations to the document.
|
2022
2031
|
#
|
2023
2032
|
# Before you delete the document, we recommend that you use
|
2024
|
-
# DeleteAssociation to disassociate all
|
2025
|
-
# with the document.
|
2033
|
+
# DeleteAssociation to disassociate all managed nodes that are
|
2034
|
+
# associated with the document.
|
2026
2035
|
#
|
2027
2036
|
# @option params [required, String] :name
|
2028
2037
|
# The name of the document.
|
@@ -2268,9 +2277,8 @@ module Aws::SSM
|
|
2268
2277
|
end
|
2269
2278
|
|
2270
2279
|
# Deletes a resource data sync configuration. After the configuration is
|
2271
|
-
# deleted, changes to data on managed
|
2272
|
-
#
|
2273
|
-
# data.
|
2280
|
+
# deleted, changes to data on managed nodes are no longer synced to or
|
2281
|
+
# from the target. Deleting a sync configuration doesn't delete data.
|
2274
2282
|
#
|
2275
2283
|
# @option params [required, String] :sync_name
|
2276
2284
|
# The name of the configuration to delete.
|
@@ -2297,13 +2305,13 @@ module Aws::SSM
|
|
2297
2305
|
end
|
2298
2306
|
|
2299
2307
|
# Removes the server or virtual machine from the list of registered
|
2300
|
-
# servers. You can reregister the
|
2301
|
-
#
|
2302
|
-
#
|
2308
|
+
# servers. You can reregister the node again at any time. If you don't
|
2309
|
+
# plan to use Run Command on the server, we suggest uninstalling SSM
|
2310
|
+
# Agent first.
|
2303
2311
|
#
|
2304
2312
|
# @option params [required, String] :instance_id
|
2305
|
-
# The ID assigned to the managed
|
2306
|
-
#
|
2313
|
+
# The ID assigned to the managed node when you registered it using the
|
2314
|
+
# activation process.
|
2307
2315
|
#
|
2308
2316
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2309
2317
|
#
|
@@ -2433,8 +2441,8 @@ module Aws::SSM
|
|
2433
2441
|
|
2434
2442
|
# Describes details about the activation, such as the date and time the
|
2435
2443
|
# activation was created, its expiration date, the Identity and Access
|
2436
|
-
# Management (IAM) role assigned to the
|
2437
|
-
# the number of
|
2444
|
+
# Management (IAM) role assigned to the managed nodes in the activation,
|
2445
|
+
# and the number of nodes registered by using this activation.
|
2438
2446
|
#
|
2439
2447
|
# @option params [Array<Types::DescribeActivationsFilter>] :filters
|
2440
2448
|
# A filter to view information about your activations.
|
@@ -2494,15 +2502,15 @@ module Aws::SSM
|
|
2494
2502
|
req.send_request(options)
|
2495
2503
|
end
|
2496
2504
|
|
2497
|
-
# Describes the association for the specified target or
|
2498
|
-
# created the association by using the `Targets` parameter, then you
|
2505
|
+
# Describes the association for the specified target or managed node. If
|
2506
|
+
# you created the association by using the `Targets` parameter, then you
|
2499
2507
|
# must retrieve the association by using the association ID.
|
2500
2508
|
#
|
2501
2509
|
# @option params [String] :name
|
2502
2510
|
# The name of the SSM document.
|
2503
2511
|
#
|
2504
2512
|
# @option params [String] :instance_id
|
2505
|
-
# The
|
2513
|
+
# The managed node ID.
|
2506
2514
|
#
|
2507
2515
|
# @option params [String] :association_id
|
2508
2516
|
# The association ID for which you want information.
|
@@ -2510,7 +2518,7 @@ module Aws::SSM
|
|
2510
2518
|
# @option params [String] :association_version
|
2511
2519
|
# Specify the association version to retrieve. To view the latest
|
2512
2520
|
# version, either specify `$LATEST` for this parameter, or omit this
|
2513
|
-
# parameter. To view a list of all associations for
|
2521
|
+
# parameter. To view a list of all associations for a managed node, use
|
2514
2522
|
# ListAssociations. To get a list of versions for a specific
|
2515
2523
|
# association, use ListAssociationVersions.
|
2516
2524
|
#
|
@@ -2943,7 +2951,7 @@ module Aws::SSM
|
|
2943
2951
|
#
|
2944
2952
|
# **Windows Server**
|
2945
2953
|
#
|
2946
|
-
# Supported keys for Windows Server
|
2954
|
+
# Supported keys for Windows Server managed node patches include the
|
2947
2955
|
# following:
|
2948
2956
|
#
|
2949
2957
|
# * <b> <code>PATCH_SET</code> </b>
|
@@ -2986,7 +2994,7 @@ module Aws::SSM
|
|
2986
2994
|
# `aws ssm describe-available-patches --filters
|
2987
2995
|
# Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615`
|
2988
2996
|
#
|
2989
|
-
# Supported keys for Linux
|
2997
|
+
# Supported keys for Linux managed node patches include the following:
|
2990
2998
|
#
|
2991
2999
|
# * <b> <code>PRODUCT</code> </b>
|
2992
3000
|
#
|
@@ -3146,7 +3154,7 @@ module Aws::SSM
|
|
3146
3154
|
# resp.document.parameters[0].description #=> String
|
3147
3155
|
# resp.document.parameters[0].default_value #=> String
|
3148
3156
|
# resp.document.platform_types #=> Array
|
3149
|
-
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux"
|
3157
|
+
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
3150
3158
|
# resp.document.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
3151
3159
|
# resp.document.schema_version #=> String
|
3152
3160
|
# resp.document.latest_version #=> String
|
@@ -3234,10 +3242,10 @@ module Aws::SSM
|
|
3234
3242
|
req.send_request(options)
|
3235
3243
|
end
|
3236
3244
|
|
3237
|
-
# All associations for the
|
3245
|
+
# All associations for the managed node(s).
|
3238
3246
|
#
|
3239
3247
|
# @option params [required, String] :instance_id
|
3240
|
-
# The
|
3248
|
+
# The managed node ID for which you want to view all associations.
|
3241
3249
|
#
|
3242
3250
|
# @option params [Integer] :max_results
|
3243
3251
|
# The maximum number of items to return for this call. The call also
|
@@ -3353,10 +3361,11 @@ module Aws::SSM
|
|
3353
3361
|
req.send_request(options)
|
3354
3362
|
end
|
3355
3363
|
|
3356
|
-
# The status of the associations for the
|
3364
|
+
# The status of the associations for the managed node(s).
|
3357
3365
|
#
|
3358
3366
|
# @option params [required, String] :instance_id
|
3359
|
-
# The
|
3367
|
+
# The managed node IDs for which you want association status
|
3368
|
+
# information.
|
3360
3369
|
#
|
3361
3370
|
# @option params [Integer] :max_results
|
3362
3371
|
# The maximum number of items to return for this call. The call also
|
@@ -3408,17 +3417,17 @@ module Aws::SSM
|
|
3408
3417
|
req.send_request(options)
|
3409
3418
|
end
|
3410
3419
|
|
3411
|
-
# Describes one or more of your
|
3412
|
-
# the operating system platform, the version of SSM Agent
|
3413
|
-
# the
|
3420
|
+
# Describes one or more of your managed nodes, including information
|
3421
|
+
# about the operating system platform, the version of SSM Agent
|
3422
|
+
# installed on the managed node, node status, and so on.
|
3414
3423
|
#
|
3415
|
-
# If you specify one or more
|
3416
|
-
# those
|
3417
|
-
# information for all your
|
3418
|
-
# isn't valid or
|
3424
|
+
# If you specify one or more managed node IDs, it returns information
|
3425
|
+
# for those managed nodes. If you don't specify node IDs, it returns
|
3426
|
+
# information for all your managed nodes. If you specify a node ID that
|
3427
|
+
# isn't valid or a node that you don't own, you receive an error.
|
3419
3428
|
#
|
3420
3429
|
# <note markdown="1"> The `IamRole` field for this API operation is the Identity and Access
|
3421
|
-
# Management (IAM) role assigned to on-premises
|
3430
|
+
# Management (IAM) role assigned to on-premises managed nodes. This call
|
3422
3431
|
# doesn't return the IAM role for EC2 instances.
|
3423
3432
|
#
|
3424
3433
|
# </note>
|
@@ -3426,8 +3435,7 @@ module Aws::SSM
|
|
3426
3435
|
# @option params [Array<Types::InstanceInformationFilter>] :instance_information_filter_list
|
3427
3436
|
# This is a legacy method. We recommend that you don't use this method.
|
3428
3437
|
# Instead, use the `Filters` data type. `Filters` enables you to return
|
3429
|
-
#
|
3430
|
-
# instances.
|
3438
|
+
# node information by filtering based on tags applied to managed nodes.
|
3431
3439
|
#
|
3432
3440
|
# <note markdown="1"> Attempting to use `InstanceInformationFilterList` and `Filters` leads
|
3433
3441
|
# to an exception error.
|
@@ -3436,9 +3444,9 @@ module Aws::SSM
|
|
3436
3444
|
#
|
3437
3445
|
# @option params [Array<Types::InstanceInformationStringFilter>] :filters
|
3438
3446
|
# One or more filters. Use a filter to return a more specific list of
|
3439
|
-
#
|
3440
|
-
# this `Filters` data type instead of
|
3441
|
-
# which is deprecated.
|
3447
|
+
# managed nodes. You can filter based on tags applied to EC2 instances.
|
3448
|
+
# Use this `Filters` data type instead of
|
3449
|
+
# `InstanceInformationFilterList`, which is deprecated.
|
3442
3450
|
#
|
3443
3451
|
# @option params [Integer] :max_results
|
3444
3452
|
# The maximum number of items to return for this call. The call also
|
@@ -3483,7 +3491,7 @@ module Aws::SSM
|
|
3483
3491
|
# resp.instance_information_list[0].last_ping_date_time #=> Time
|
3484
3492
|
# resp.instance_information_list[0].agent_version #=> String
|
3485
3493
|
# resp.instance_information_list[0].is_latest_version #=> Boolean
|
3486
|
-
# resp.instance_information_list[0].platform_type #=> String, one of "Windows", "Linux"
|
3494
|
+
# resp.instance_information_list[0].platform_type #=> String, one of "Windows", "Linux", "MacOS"
|
3487
3495
|
# resp.instance_information_list[0].platform_name #=> String
|
3488
3496
|
# resp.instance_information_list[0].platform_version #=> String
|
3489
3497
|
# resp.instance_information_list[0].activation_id #=> String
|
@@ -3499,6 +3507,8 @@ module Aws::SSM
|
|
3499
3507
|
# resp.instance_information_list[0].association_overview.detailed_status #=> String
|
3500
3508
|
# resp.instance_information_list[0].association_overview.instance_association_status_aggregated_count #=> Hash
|
3501
3509
|
# resp.instance_information_list[0].association_overview.instance_association_status_aggregated_count["StatusName"] #=> Integer
|
3510
|
+
# resp.instance_information_list[0].source_id #=> String
|
3511
|
+
# resp.instance_information_list[0].source_type #=> String, one of "AWS::EC2::Instance", "AWS::IoT::Thing", "AWS::SSM::ManagedInstance"
|
3502
3512
|
# resp.next_token #=> String
|
3503
3513
|
#
|
3504
3514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceInformation AWS API Documentation
|
@@ -3510,10 +3520,10 @@ module Aws::SSM
|
|
3510
3520
|
req.send_request(options)
|
3511
3521
|
end
|
3512
3522
|
|
3513
|
-
# Retrieves the high-level patch state of one or more
|
3523
|
+
# Retrieves the high-level patch state of one or more managed nodes.
|
3514
3524
|
#
|
3515
3525
|
# @option params [required, Array<String>] :instance_ids
|
3516
|
-
# The ID of the
|
3526
|
+
# The ID of the managed node for which patch state information should be
|
3517
3527
|
# retrieved.
|
3518
3528
|
#
|
3519
3529
|
# @option params [String] :next_token
|
@@ -3521,7 +3531,7 @@ module Aws::SSM
|
|
3521
3531
|
# token from a previous call.)
|
3522
3532
|
#
|
3523
3533
|
# @option params [Integer] :max_results
|
3524
|
-
# The maximum number of
|
3534
|
+
# The maximum number of managed nodes to return (per page).
|
3525
3535
|
#
|
3526
3536
|
# @return [Types::DescribeInstancePatchStatesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3527
3537
|
#
|
@@ -3574,7 +3584,7 @@ module Aws::SSM
|
|
3574
3584
|
req.send_request(options)
|
3575
3585
|
end
|
3576
3586
|
|
3577
|
-
# Retrieves the high-level patch state for the
|
3587
|
+
# Retrieves the high-level patch state for the managed nodes in the
|
3578
3588
|
# specified patch group.
|
3579
3589
|
#
|
3580
3590
|
# @option params [required, String] :patch_group
|
@@ -3655,12 +3665,12 @@ module Aws::SSM
|
|
3655
3665
|
req.send_request(options)
|
3656
3666
|
end
|
3657
3667
|
|
3658
|
-
# Retrieves information about the patches on the specified
|
3659
|
-
# their state relative to the patch baseline being used for the
|
3660
|
-
#
|
3668
|
+
# Retrieves information about the patches on the specified managed node
|
3669
|
+
# and their state relative to the patch baseline being used for the
|
3670
|
+
# node.
|
3661
3671
|
#
|
3662
3672
|
# @option params [required, String] :instance_id
|
3663
|
-
# The ID of the
|
3673
|
+
# The ID of the managed node whose patch state information should be
|
3664
3674
|
# retrieved.
|
3665
3675
|
#
|
3666
3676
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
@@ -4003,7 +4013,7 @@ module Aws::SSM
|
|
4003
4013
|
# The ID of the maintenance window to retrieve information about.
|
4004
4014
|
#
|
4005
4015
|
# @option params [Array<Types::Target>] :targets
|
4006
|
-
# The
|
4016
|
+
# The managed node ID or key-value pair to retrieve information about.
|
4007
4017
|
#
|
4008
4018
|
# @option params [String] :resource_type
|
4009
4019
|
# The type of resource you want to retrieve information about. For
|
@@ -4278,10 +4288,10 @@ module Aws::SSM
|
|
4278
4288
|
end
|
4279
4289
|
|
4280
4290
|
# Retrieves information about the maintenance window targets or tasks
|
4281
|
-
# that
|
4291
|
+
# that a managed node is associated with.
|
4282
4292
|
#
|
4283
4293
|
# @option params [required, Array<Types::Target>] :targets
|
4284
|
-
# The
|
4294
|
+
# The managed node ID or key-value pair to retrieve information about.
|
4285
4295
|
#
|
4286
4296
|
# @option params [required, String] :resource_type
|
4287
4297
|
# The type of resource you want to retrieve information about. For
|
@@ -4895,9 +4905,11 @@ module Aws::SSM
|
|
4895
4905
|
# resp.sessions[0].end_date #=> Time
|
4896
4906
|
# resp.sessions[0].document_name #=> String
|
4897
4907
|
# resp.sessions[0].owner #=> String
|
4908
|
+
# resp.sessions[0].reason #=> String
|
4898
4909
|
# resp.sessions[0].details #=> String
|
4899
4910
|
# resp.sessions[0].output_url.s3_output_url #=> String
|
4900
4911
|
# resp.sessions[0].output_url.cloud_watch_output_url #=> String
|
4912
|
+
# resp.sessions[0].max_session_duration #=> String
|
4901
4913
|
# resp.next_token #=> String
|
4902
4914
|
#
|
4903
4915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeSessions AWS API Documentation
|
@@ -5152,18 +5164,19 @@ module Aws::SSM
|
|
5152
5164
|
# or plugin.
|
5153
5165
|
#
|
5154
5166
|
# `GetCommandInvocation` only gives the execution status of a plugin in
|
5155
|
-
# a document. To get the command execution status on a specific
|
5156
|
-
#
|
5157
|
-
#
|
5167
|
+
# a document. To get the command execution status on a specific managed
|
5168
|
+
# node, use ListCommandInvocations. To get the command execution status
|
5169
|
+
# across managed nodes, use ListCommands.
|
5158
5170
|
#
|
5159
5171
|
# @option params [required, String] :command_id
|
5160
5172
|
# (Required) The parent command ID of the invocation plugin.
|
5161
5173
|
#
|
5162
5174
|
# @option params [required, String] :instance_id
|
5163
|
-
# (Required) The ID of the managed
|
5164
|
-
# managed
|
5165
|
-
# instance
|
5166
|
-
# for Amazon Web Services Systems
|
5175
|
+
# (Required) The ID of the managed node targeted by the command. A
|
5176
|
+
# *managed node* can be an Amazon Elastic Compute Cloud (Amazon EC2)
|
5177
|
+
# instance, edge device, and on-premises server or VM in your hybrid
|
5178
|
+
# environment that is configured for Amazon Web Services Systems
|
5179
|
+
# Manager.
|
5167
5180
|
#
|
5168
5181
|
# @option params [String] :plugin_name
|
5169
5182
|
# The name of the plugin for which you want detailed results. If the
|
@@ -5244,12 +5257,12 @@ module Aws::SSM
|
|
5244
5257
|
req.send_request(options)
|
5245
5258
|
end
|
5246
5259
|
|
5247
|
-
# Retrieves the Session Manager connection status for
|
5260
|
+
# Retrieves the Session Manager connection status for a managed node to
|
5248
5261
|
# determine whether it is running and ready to receive Session Manager
|
5249
5262
|
# connections.
|
5250
5263
|
#
|
5251
5264
|
# @option params [required, String] :target
|
5252
|
-
# The
|
5265
|
+
# The managed node ID.
|
5253
5266
|
#
|
5254
5267
|
# @return [Types::GetConnectionStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5255
5268
|
#
|
@@ -5312,7 +5325,7 @@ module Aws::SSM
|
|
5312
5325
|
req.send_request(options)
|
5313
5326
|
end
|
5314
5327
|
|
5315
|
-
# Retrieves the current snapshot for the patch baseline the
|
5328
|
+
# Retrieves the current snapshot for the patch baseline the managed node
|
5316
5329
|
# uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems
|
5317
5330
|
# Manager document (SSM document).
|
5318
5331
|
#
|
@@ -5321,7 +5334,7 @@ module Aws::SSM
|
|
5321
5334
|
# Services credentials and the operation fails. To avoid this, you can
|
5322
5335
|
# run the command in the Amazon Web Services Systems Manager console.
|
5323
5336
|
# Use Run Command, a capability of Amazon Web Services Systems Manager,
|
5324
|
-
# with an SSM document that enables you to target
|
5337
|
+
# with an SSM document that enables you to target a managed node with a
|
5325
5338
|
# script or command. For example, run the command using the
|
5326
5339
|
# `AWS-RunShellScript` document or the `AWS-RunPowerShellScript`
|
5327
5340
|
# document.
|
@@ -5329,8 +5342,8 @@ module Aws::SSM
|
|
5329
5342
|
# </note>
|
5330
5343
|
#
|
5331
5344
|
# @option params [required, String] :instance_id
|
5332
|
-
# The ID of the
|
5333
|
-
# be retrieved.
|
5345
|
+
# The ID of the managed node for which the appropriate patch snapshot
|
5346
|
+
# should be retrieved.
|
5334
5347
|
#
|
5335
5348
|
# @option params [required, String] :snapshot_id
|
5336
5349
|
# The snapshot ID provided by the user when running
|
@@ -5485,8 +5498,8 @@ module Aws::SSM
|
|
5485
5498
|
req.send_request(options)
|
5486
5499
|
end
|
5487
5500
|
|
5488
|
-
# Query inventory information. This includes
|
5489
|
-
# `Stopped` or `Terminated`.
|
5501
|
+
# Query inventory information. This includes managed node status, such
|
5502
|
+
# as `Stopped` or `Terminated`.
|
5490
5503
|
#
|
5491
5504
|
# @option params [Array<Types::InventoryFilter>] :filters
|
5492
5505
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -5496,7 +5509,8 @@ module Aws::SSM
|
|
5496
5509
|
# Returns counts of inventory types based on one or more expressions.
|
5497
5510
|
# For example, if you aggregate by using an expression that uses the
|
5498
5511
|
# `AWS:InstanceInformation.PlatformType` type, you can see a count of
|
5499
|
-
# how many Windows and Linux
|
5512
|
+
# how many Windows and Linux managed nodes exist in your inventoried
|
5513
|
+
# fleet.
|
5500
5514
|
#
|
5501
5515
|
# @option params [Array<Types::ResultAttribute>] :result_attributes
|
5502
5516
|
# The list of inventory item types to return.
|
@@ -6775,9 +6789,9 @@ module Aws::SSM
|
|
6775
6789
|
|
6776
6790
|
# Returns all State Manager associations in the current Amazon Web
|
6777
6791
|
# Services account and Amazon Web Services Region. You can limit the
|
6778
|
-
# results to a specific State Manager association document or
|
6779
|
-
# by specifying a filter. State Manager is a capability of Amazon
|
6780
|
-
# Services Systems Manager.
|
6792
|
+
# results to a specific State Manager association document or managed
|
6793
|
+
# node by specifying a filter. State Manager is a capability of Amazon
|
6794
|
+
# Web Services Systems Manager.
|
6781
6795
|
#
|
6782
6796
|
# @option params [Array<Types::AssociationFilter>] :association_filter_list
|
6783
6797
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -6785,7 +6799,7 @@ module Aws::SSM
|
|
6785
6799
|
#
|
6786
6800
|
# <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
|
6787
6801
|
# legacy associations created using the `InstanceID` attribute.
|
6788
|
-
# Associations targeting the
|
6802
|
+
# Associations targeting the managed node that are part of the Target
|
6789
6803
|
# Attributes `ResourceGroup` or `Tags` aren't returned.
|
6790
6804
|
#
|
6791
6805
|
# </note>
|
@@ -6849,18 +6863,19 @@ module Aws::SSM
|
|
6849
6863
|
req.send_request(options)
|
6850
6864
|
end
|
6851
6865
|
|
6852
|
-
# An invocation is copy of a command sent to a specific
|
6853
|
-
# command can apply to one or more
|
6854
|
-
# applies to one
|
6855
|
-
# against three
|
6856
|
-
# requested
|
6857
|
-
# command execution.
|
6866
|
+
# An invocation is copy of a command sent to a specific managed node. A
|
6867
|
+
# command can apply to one or more managed nodes. A command invocation
|
6868
|
+
# applies to one managed node. For example, if a user runs `SendCommand`
|
6869
|
+
# against three managed nodes, then a command invocation is created for
|
6870
|
+
# each requested managed node ID. `ListCommandInvocations` provide
|
6871
|
+
# status about command execution.
|
6858
6872
|
#
|
6859
6873
|
# @option params [String] :command_id
|
6860
6874
|
# (Optional) The invocations for a specific command ID.
|
6861
6875
|
#
|
6862
6876
|
# @option params [String] :instance_id
|
6863
|
-
# (Optional) The command execution details for a specific
|
6877
|
+
# (Optional) The command execution details for a specific managed node
|
6878
|
+
# ID.
|
6864
6879
|
#
|
6865
6880
|
# @option params [Integer] :max_results
|
6866
6881
|
# (Optional) The maximum number of items to return for this call. The
|
@@ -6955,11 +6970,11 @@ module Aws::SSM
|
|
6955
6970
|
# (Optional) If provided, lists only the specified command.
|
6956
6971
|
#
|
6957
6972
|
# @option params [String] :instance_id
|
6958
|
-
# (Optional) Lists commands issued against this
|
6973
|
+
# (Optional) Lists commands issued against this managed node ID.
|
6959
6974
|
#
|
6960
|
-
# <note markdown="1"> You can't specify
|
6961
|
-
# `Status` = `Pending`. This is because the command hasn't
|
6962
|
-
#
|
6975
|
+
# <note markdown="1"> You can't specify a managed node ID in the same command that you
|
6976
|
+
# specify `Status` = `Pending`. This is because the command hasn't
|
6977
|
+
# reached the managed node yet.
|
6963
6978
|
#
|
6964
6979
|
# </note>
|
6965
6980
|
#
|
@@ -7373,7 +7388,7 @@ module Aws::SSM
|
|
7373
7388
|
# resp.document_identifiers[0].owner #=> String
|
7374
7389
|
# resp.document_identifiers[0].version_name #=> String
|
7375
7390
|
# resp.document_identifiers[0].platform_types #=> Array
|
7376
|
-
# resp.document_identifiers[0].platform_types[0] #=> String, one of "Windows", "Linux"
|
7391
|
+
# resp.document_identifiers[0].platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
7377
7392
|
# resp.document_identifiers[0].document_version #=> String
|
7378
7393
|
# resp.document_identifiers[0].document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
7379
7394
|
# resp.document_identifiers[0].schema_version #=> String
|
@@ -7401,7 +7416,7 @@ module Aws::SSM
|
|
7401
7416
|
# A list of inventory items returned by the request.
|
7402
7417
|
#
|
7403
7418
|
# @option params [required, String] :instance_id
|
7404
|
-
# The
|
7419
|
+
# The managed node ID for which you want inventory information.
|
7405
7420
|
#
|
7406
7421
|
# @option params [required, String] :type_name
|
7407
7422
|
# The type of inventory item for which you want information.
|
@@ -7901,7 +7916,7 @@ module Aws::SSM
|
|
7901
7916
|
# * ExecutionType: Specify patch, association, or Custom:`string`.
|
7902
7917
|
#
|
7903
7918
|
# * ExecutionTime. The time the patch, association, or custom compliance
|
7904
|
-
# item was applied to the
|
7919
|
+
# item was applied to the managed node.
|
7905
7920
|
#
|
7906
7921
|
# * Id: The patch, association, or custom compliance ID.
|
7907
7922
|
#
|
@@ -7934,8 +7949,8 @@ module Aws::SSM
|
|
7934
7949
|
# following format: yyyy-MM-dd'T'HH:mm:ss'Z'
|
7935
7950
|
#
|
7936
7951
|
# @option params [required, String] :resource_id
|
7937
|
-
# Specify an ID for this resource. For a managed
|
7938
|
-
#
|
7952
|
+
# Specify an ID for this resource. For a managed node, this is the node
|
7953
|
+
# ID.
|
7939
7954
|
#
|
7940
7955
|
# @option params [required, String] :resource_type
|
7941
7956
|
# Specify the type of resource. `ManagedInstance` is currently the only
|
@@ -8013,15 +8028,15 @@ module Aws::SSM
|
|
8013
8028
|
req.send_request(options)
|
8014
8029
|
end
|
8015
8030
|
|
8016
|
-
# Bulk update custom inventory items on one more
|
8017
|
-
# adds an inventory item, if it doesn't already exist, or
|
8018
|
-
# inventory item, if it does exist.
|
8031
|
+
# Bulk update custom inventory items on one or more managed nodes. The
|
8032
|
+
# request adds an inventory item, if it doesn't already exist, or
|
8033
|
+
# updates an inventory item, if it does exist.
|
8019
8034
|
#
|
8020
8035
|
# @option params [required, String] :instance_id
|
8021
|
-
# An
|
8036
|
+
# An managed node ID where you want to add or update inventory items.
|
8022
8037
|
#
|
8023
8038
|
# @option params [required, Array<Types::InventoryItem>] :items
|
8024
|
-
# The inventory items that you want to add or update on
|
8039
|
+
# The inventory items that you want to add or update on managed nodes.
|
8025
8040
|
#
|
8026
8041
|
# @return [Types::PutInventoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8027
8042
|
#
|
@@ -8275,12 +8290,12 @@ module Aws::SSM
|
|
8275
8290
|
# *parameter* doesn't affect the expiration date and time. When the
|
8276
8291
|
# expiration time is reached, Parameter Store deletes the parameter.
|
8277
8292
|
#
|
8278
|
-
# ExpirationNotification: This policy
|
8293
|
+
# ExpirationNotification: This policy initiates an event in Amazon
|
8279
8294
|
# CloudWatch Events that notifies you about the expiration. By using
|
8280
8295
|
# this policy, you can receive notification before or after the
|
8281
8296
|
# expiration time is reached, in units of days or hours.
|
8282
8297
|
#
|
8283
|
-
# NoChangeNotification: This policy
|
8298
|
+
# NoChangeNotification: This policy initiates a CloudWatch Events event
|
8284
8299
|
# if a parameter hasn't been modified for a specified period of time.
|
8285
8300
|
# This policy type is useful when, for example, a secret needs to be
|
8286
8301
|
# changed within a period of time, but it hasn't been changed.
|
@@ -8434,7 +8449,7 @@ module Aws::SSM
|
|
8434
8449
|
#
|
8435
8450
|
# @option params [required, Array<Types::Target>] :targets
|
8436
8451
|
# The targets to register with the maintenance window. In other words,
|
8437
|
-
# the
|
8452
|
+
# the managed nodes to run commands on when the maintenance window runs.
|
8438
8453
|
#
|
8439
8454
|
# <note markdown="1"> If a single maintenance window task is registered with multiple
|
8440
8455
|
# targets, its task invocations occur sequentially and not in parallel.
|
@@ -8444,35 +8459,33 @@ module Aws::SSM
|
|
8444
8459
|
#
|
8445
8460
|
# </note>
|
8446
8461
|
#
|
8447
|
-
# You can specify targets using
|
8448
|
-
# tags that have been applied to
|
8462
|
+
# You can specify targets using managed node IDs, resource group names,
|
8463
|
+
# or tags that have been applied to managed nodes.
|
8449
8464
|
#
|
8450
|
-
# **Example 1**\: Specify
|
8465
|
+
# **Example 1**\: Specify managed node IDs
|
8451
8466
|
#
|
8452
|
-
# `Key=InstanceIds,Values
|
8467
|
+
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`
|
8453
8468
|
#
|
8454
|
-
# **Example 2**\: Use tag key-pairs applied to
|
8469
|
+
# **Example 2**\: Use tag key-pairs applied to managed nodes
|
8455
8470
|
#
|
8456
|
-
# `Key=tag
|
8471
|
+
# `Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`
|
8457
8472
|
#
|
8458
|
-
# **Example 3**\: Use tag-keys applied to
|
8473
|
+
# **Example 3**\: Use tag-keys applied to managed nodes
|
8459
8474
|
#
|
8460
|
-
# `Key=tag-key,Values
|
8475
|
+
# `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`
|
8461
8476
|
#
|
8462
8477
|
# **Example 4**\: Use resource group names
|
8463
8478
|
#
|
8464
|
-
# `Key=resource-groups:Name,Values
|
8479
|
+
# `Key=resource-groups:Name,Values=<resource-group-name>`
|
8465
8480
|
#
|
8466
8481
|
# **Example 5**\: Use filters for resource group types
|
8467
8482
|
#
|
8468
|
-
# `Key=resource-groups:ResourceTypeFilters,Values
|
8469
|
-
# `
|
8483
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`
|
8470
8484
|
#
|
8471
8485
|
# <note markdown="1"> For `Key=resource-groups:ResourceTypeFilters`, specify resource types
|
8472
8486
|
# in the following format
|
8473
8487
|
#
|
8474
|
-
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
|
8475
|
-
# `
|
8488
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC`
|
8476
8489
|
#
|
8477
8490
|
# </note>
|
8478
8491
|
#
|
@@ -8542,7 +8555,7 @@ module Aws::SSM
|
|
8542
8555
|
# The ID of the maintenance window the task should be added to.
|
8543
8556
|
#
|
8544
8557
|
# @option params [Array<Types::Target>] :targets
|
8545
|
-
# The targets (either
|
8558
|
+
# The targets (either managed nodes or maintenance window targets).
|
8546
8559
|
#
|
8547
8560
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
8548
8561
|
# Command-type tasks. Depending on the task, targets are optional for
|
@@ -8553,7 +8566,7 @@ module Aws::SSM
|
|
8553
8566
|
#
|
8554
8567
|
# </note>
|
8555
8568
|
#
|
8556
|
-
# Specify
|
8569
|
+
# Specify managed nodes using the following format:
|
8557
8570
|
#
|
8558
8571
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
8559
8572
|
#
|
@@ -8637,7 +8650,7 @@ module Aws::SSM
|
|
8637
8650
|
#
|
8638
8651
|
# @option params [Types::LoggingInfo] :logging_info
|
8639
8652
|
# A structure containing information about an Amazon Simple Storage
|
8640
|
-
# Service (Amazon S3) bucket to write
|
8653
|
+
# Service (Amazon S3) bucket to write managed node-level logs to.
|
8641
8654
|
#
|
8642
8655
|
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
8643
8656
|
# Service (Amazon S3) bucket to contain logs, instead use the
|
@@ -8776,9 +8789,8 @@ module Aws::SSM
|
|
8776
8789
|
# The type of resource from which you want to remove a tag.
|
8777
8790
|
#
|
8778
8791
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
8779
|
-
# on-premises managed
|
8780
|
-
#
|
8781
|
-
# `mi-1a2b3c4d5e6f`.
|
8792
|
+
# on-premises managed nodes. Specify the name of the managed node in the
|
8793
|
+
# following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.
|
8782
8794
|
#
|
8783
8795
|
# </note>
|
8784
8796
|
#
|
@@ -8802,10 +8814,9 @@ module Aws::SSM
|
|
8802
8814
|
#
|
8803
8815
|
# For the Document and Parameter values, use the name of the resource.
|
8804
8816
|
#
|
8805
|
-
# <note markdown="1"> The ManagedInstance type for this API operation is only for
|
8806
|
-
# on-premises managed
|
8807
|
-
#
|
8808
|
-
# mi-1a2b3c4d5e6f.
|
8817
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
8818
|
+
# on-premises managed nodes. Specify the name of the managed node in the
|
8819
|
+
# following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
|
8809
8820
|
#
|
8810
8821
|
# </note>
|
8811
8822
|
#
|
@@ -8895,7 +8906,7 @@ module Aws::SSM
|
|
8895
8906
|
req.send_request(options)
|
8896
8907
|
end
|
8897
8908
|
|
8898
|
-
# Reconnects a session to
|
8909
|
+
# Reconnects a session to a managed node after it has been disconnected.
|
8899
8910
|
# Connections can be resumed for disconnected sessions, but not
|
8900
8911
|
# terminated sessions.
|
8901
8912
|
#
|
@@ -8985,18 +8996,18 @@ module Aws::SSM
|
|
8985
8996
|
req.send_request(options)
|
8986
8997
|
end
|
8987
8998
|
|
8988
|
-
# Runs commands on one or more managed
|
8999
|
+
# Runs commands on one or more managed nodes.
|
8989
9000
|
#
|
8990
9001
|
# @option params [Array<String>] :instance_ids
|
8991
|
-
# The IDs of the
|
8992
|
-
#
|
8993
|
-
#
|
9002
|
+
# The IDs of the managed nodes where the command should run. Specifying
|
9003
|
+
# managed node IDs is most useful when you are targeting a limited
|
9004
|
+
# number of managed nodes, though you can specify up to 50 IDs.
|
8994
9005
|
#
|
8995
|
-
# To target a larger number of
|
8996
|
-
# individual
|
9006
|
+
# To target a larger number of managed nodes, or if you prefer not to
|
9007
|
+
# list individual node IDs, we recommend using the `Targets` option
|
8997
9008
|
# instead. Using `Targets`, which accepts tag key-value pairs to
|
8998
|
-
# identify the
|
8999
|
-
# tens, hundreds, or thousands of
|
9009
|
+
# identify the managed nodes to send commands to, you can a send command
|
9010
|
+
# to tens, hundreds, or thousands of nodes at once.
|
9000
9011
|
#
|
9001
9012
|
# For more information about how to use targets, see [Using targets and
|
9002
9013
|
# rate controls to send commands to a fleet][1] in the *Amazon Web
|
@@ -9007,15 +9018,15 @@ module Aws::SSM
|
|
9007
9018
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
9008
9019
|
#
|
9009
9020
|
# @option params [Array<Types::Target>] :targets
|
9010
|
-
# An array of search criteria that targets
|
9011
|
-
# combination that you specify. Specifying targets is most
|
9012
|
-
# you want to send a command to a large number of
|
9013
|
-
# Using `Targets`, which accepts tag key-value pairs to
|
9014
|
-
#
|
9015
|
-
#
|
9021
|
+
# An array of search criteria that targets managed nodes using a
|
9022
|
+
# `Key,Value` combination that you specify. Specifying targets is most
|
9023
|
+
# useful when you want to send a command to a large number of managed
|
9024
|
+
# nodes at once. Using `Targets`, which accepts tag key-value pairs to
|
9025
|
+
# identify managed nodes, you can send a command to tens, hundreds, or
|
9026
|
+
# thousands of nodes at once.
|
9016
9027
|
#
|
9017
|
-
# To send a command to a smaller number of
|
9018
|
-
# `InstanceIds` option instead.
|
9028
|
+
# To send a command to a smaller number of managed nodes, you can use
|
9029
|
+
# the `InstanceIds` option instead.
|
9019
9030
|
#
|
9020
9031
|
# For more information about how to use targets, see [Sending commands
|
9021
9032
|
# to a fleet][1] in the *Amazon Web Services Systems Manager User
|
@@ -9097,8 +9108,8 @@ module Aws::SSM
|
|
9097
9108
|
# should be stored.
|
9098
9109
|
#
|
9099
9110
|
# @option params [String] :max_concurrency
|
9100
|
-
# (Optional) The maximum number of
|
9101
|
-
# command at the same time. You can specify a number such as 10 or a
|
9111
|
+
# (Optional) The maximum number of managed nodes that are allowed to run
|
9112
|
+
# the command at the same time. You can specify a number such as 10 or a
|
9102
9113
|
# percentage such as 10%. The default value is `50`. For more
|
9103
9114
|
# information about how to use `MaxConcurrency`, see [Using concurrency
|
9104
9115
|
# controls][1] in the *Amazon Web Services Systems Manager User Guide*.
|
@@ -9542,7 +9553,7 @@ module Aws::SSM
|
|
9542
9553
|
req.send_request(options)
|
9543
9554
|
end
|
9544
9555
|
|
9545
|
-
# Initiates a connection to a target (for example,
|
9556
|
+
# Initiates a connection to a target (for example, a managed node) for a
|
9546
9557
|
# Session Manager session. Returns a URL and token that can be used to
|
9547
9558
|
# open a WebSocket connection for sending input and receiving outputs.
|
9548
9559
|
#
|
@@ -9563,14 +9574,19 @@ module Aws::SSM
|
|
9563
9574
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
|
9564
9575
|
#
|
9565
9576
|
# @option params [required, String] :target
|
9566
|
-
# The
|
9577
|
+
# The managed node to connect to for the session.
|
9567
9578
|
#
|
9568
9579
|
# @option params [String] :document_name
|
9569
9580
|
# The name of the SSM document to define the parameters and plugin
|
9570
9581
|
# settings for the session. For example, `SSM-SessionManagerRunShell`.
|
9571
9582
|
# You can call the GetDocument API to verify the document exists before
|
9572
9583
|
# attempting to start a session. If no document name is provided, a
|
9573
|
-
# shell to the
|
9584
|
+
# shell to the managed node is launched by default.
|
9585
|
+
#
|
9586
|
+
# @option params [String] :reason
|
9587
|
+
# The reason for connecting to the instance. This value is included in
|
9588
|
+
# the details for the Amazon CloudWatch Events event created when you
|
9589
|
+
# start the session.
|
9574
9590
|
#
|
9575
9591
|
# @option params [Hash<String,Array>] :parameters
|
9576
9592
|
# Reserved for future use.
|
@@ -9586,6 +9602,7 @@ module Aws::SSM
|
|
9586
9602
|
# resp = client.start_session({
|
9587
9603
|
# target: "SessionTarget", # required
|
9588
9604
|
# document_name: "DocumentARN",
|
9605
|
+
# reason: "SessionReason",
|
9589
9606
|
# parameters: {
|
9590
9607
|
# "SessionManagerParameterName" => ["SessionManagerParameterValue"],
|
9591
9608
|
# },
|
@@ -9634,7 +9651,7 @@ module Aws::SSM
|
|
9634
9651
|
end
|
9635
9652
|
|
9636
9653
|
# Permanently ends a session and closes the data connection between the
|
9637
|
-
# Session Manager client and SSM Agent on the
|
9654
|
+
# Session Manager client and SSM Agent on the managed node. A terminated
|
9638
9655
|
# session isn't be resumed.
|
9639
9656
|
#
|
9640
9657
|
# @option params [required, String] :session_id
|
@@ -9742,7 +9759,7 @@ module Aws::SSM
|
|
9742
9759
|
#
|
9743
9760
|
# @option params [String] :name
|
9744
9761
|
# The name of the SSM Command document or Automation runbook that
|
9745
|
-
# contains the configuration information for the
|
9762
|
+
# contains the configuration information for the managed node.
|
9746
9763
|
#
|
9747
9764
|
# You can specify Amazon Web Services-predefined documents, documents
|
9748
9765
|
# you created, or a document that is shared with you from another
|
@@ -9787,9 +9804,9 @@ module Aws::SSM
|
|
9787
9804
|
# of the target set, for example 10%. If you specify 3, for example, the
|
9788
9805
|
# system stops sending requests when the fourth error is received. If
|
9789
9806
|
# you specify 0, then the system stops sending requests after the first
|
9790
|
-
# error is returned. If you run an association on 50
|
9791
|
-
# `MaxError` to 10%, then the system stops sending the request when
|
9792
|
-
# sixth error is received.
|
9807
|
+
# error is returned. If you run an association on 50 managed nodes and
|
9808
|
+
# set `MaxError` to 10%, then the system stops sending the request when
|
9809
|
+
# the sixth error is received.
|
9793
9810
|
#
|
9794
9811
|
# Executions that are already running an association when `MaxErrors` is
|
9795
9812
|
# reached are allowed to complete, but some of these executions may fail
|
@@ -9803,10 +9820,10 @@ module Aws::SSM
|
|
9803
9820
|
# of the target set, for example 10%. The default value is 100%, which
|
9804
9821
|
# means all targets run the association at the same time.
|
9805
9822
|
#
|
9806
|
-
# If a new
|
9823
|
+
# If a new managed node starts and attempts to run an association while
|
9807
9824
|
# Systems Manager is running `MaxConcurrency` associations, the
|
9808
9825
|
# association is allowed to run. During the next association interval,
|
9809
|
-
# the new
|
9826
|
+
# the new managed node will process its association within the limit
|
9810
9827
|
# specified for `MaxConcurrency`.
|
9811
9828
|
#
|
9812
9829
|
# @option params [String] :compliance_severity
|
@@ -9963,7 +9980,7 @@ module Aws::SSM
|
|
9963
9980
|
end
|
9964
9981
|
|
9965
9982
|
# Updates the status of the Amazon Web Services Systems Manager document
|
9966
|
-
# (SSM document) associated with the specified
|
9983
|
+
# (SSM document) associated with the specified managed node.
|
9967
9984
|
#
|
9968
9985
|
# `UpdateAssociationStatus` is primarily used by the Amazon Web Services
|
9969
9986
|
# Systems Manager Agent (SSM Agent) to report status updates about your
|
@@ -9974,7 +9991,7 @@ module Aws::SSM
|
|
9974
9991
|
# The name of the SSM document.
|
9975
9992
|
#
|
9976
9993
|
# @option params [required, String] :instance_id
|
9977
|
-
# The
|
9994
|
+
# The managed node ID.
|
9978
9995
|
#
|
9979
9996
|
# @option params [required, Types::AssociationStatus] :association_status
|
9980
9997
|
# The association status.
|
@@ -10133,7 +10150,7 @@ module Aws::SSM
|
|
10133
10150
|
# resp.document_description.parameters[0].description #=> String
|
10134
10151
|
# resp.document_description.parameters[0].default_value #=> String
|
10135
10152
|
# resp.document_description.platform_types #=> Array
|
10136
|
-
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
10153
|
+
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
10137
10154
|
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
10138
10155
|
# resp.document_description.schema_version #=> String
|
10139
10156
|
# resp.document_description.latest_version #=> String
|
@@ -10529,8 +10546,8 @@ module Aws::SSM
|
|
10529
10546
|
# The task ID to modify.
|
10530
10547
|
#
|
10531
10548
|
# @option params [Array<Types::Target>] :targets
|
10532
|
-
# The targets (either
|
10533
|
-
# specified using the format
|
10549
|
+
# The targets (either managed nodes or tags) to modify. Managed nodes
|
10550
|
+
# are specified using the format
|
10534
10551
|
# `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified
|
10535
10552
|
# using the format ` Key=tag_name,Values=tag_value`.
|
10536
10553
|
#
|
@@ -10826,12 +10843,12 @@ module Aws::SSM
|
|
10826
10843
|
end
|
10827
10844
|
|
10828
10845
|
# Changes the Identity and Access Management (IAM) role that is assigned
|
10829
|
-
# to the on-premises
|
10830
|
-
# first assigned to these hybrid
|
10846
|
+
# to the on-premises server, edge device, or virtual machines (VM). IAM
|
10847
|
+
# roles are first assigned to these hybrid nodes during the activation
|
10831
10848
|
# process. For more information, see CreateActivation.
|
10832
10849
|
#
|
10833
10850
|
# @option params [required, String] :instance_id
|
10834
|
-
# The ID of the managed
|
10851
|
+
# The ID of the managed node where you want to update the role.
|
10835
10852
|
#
|
10836
10853
|
# @option params [required, String] :iam_role
|
10837
10854
|
# The IAM role you want to assign or change.
|
@@ -11086,8 +11103,8 @@ module Aws::SSM
|
|
11086
11103
|
#
|
11087
11104
|
# @option params [Boolean] :approved_patches_enable_non_security
|
11088
11105
|
# Indicates whether the list of approved patches includes non-security
|
11089
|
-
# updates that should be applied to the
|
11090
|
-
# `false`. Applies to Linux
|
11106
|
+
# updates that should be applied to the managed nodes. The default value
|
11107
|
+
# is `false`. Applies to Linux managed nodes only.
|
11091
11108
|
#
|
11092
11109
|
# @option params [Array<String>] :rejected_patches
|
11093
11110
|
# A list of explicitly rejected patches for the baseline.
|
@@ -11122,9 +11139,9 @@ module Aws::SSM
|
|
11122
11139
|
# A description of the patch baseline.
|
11123
11140
|
#
|
11124
11141
|
# @option params [Array<Types::PatchSource>] :sources
|
11125
|
-
# Information about the patches to use to update the
|
11142
|
+
# Information about the patches to use to update the managed nodes,
|
11126
11143
|
# including target operating systems and source repositories. Applies to
|
11127
|
-
# Linux
|
11144
|
+
# Linux managed nodes only.
|
11128
11145
|
#
|
11129
11146
|
# @option params [Boolean] :replace
|
11130
11147
|
# If True, then all fields that are required by the CreatePatchBaseline
|
@@ -11382,7 +11399,7 @@ module Aws::SSM
|
|
11382
11399
|
params: params,
|
11383
11400
|
config: config)
|
11384
11401
|
context[:gem_name] = 'aws-sdk-ssm'
|
11385
|
-
context[:gem_version] = '1.
|
11402
|
+
context[:gem_version] = '1.126.0'
|
11386
11403
|
Seahorse::Client::Request.new(handlers, context)
|
11387
11404
|
end
|
11388
11405
|
|