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