aws-sdk-ssm 1.124.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm/client.rb +240 -242
- data/lib/aws-sdk-ssm/client_api.rb +4 -0
- data/lib/aws-sdk-ssm/types.rb +487 -471
- 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,13 @@ 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.
|
647
646
|
#
|
648
647
|
# @option params [Array<Types::RegistrationMetadataItem>] :registration_metadata
|
649
648
|
# Reserved for internal use.
|
@@ -690,16 +689,16 @@ module Aws::SSM
|
|
690
689
|
end
|
691
690
|
|
692
691
|
# A State Manager association defines the state that you want to
|
693
|
-
# maintain on your
|
694
|
-
# that anti-virus software must be installed and running on your
|
695
|
-
#
|
696
|
-
# the association specifies a schedule for when the
|
697
|
-
# reapplied. For dynamic targets, such as an Amazon Web
|
698
|
-
# resource group or an Amazon Web Services autoscaling group,
|
699
|
-
# Manager, a capability of Amazon Web Services Systems Manager
|
700
|
-
# the configuration when new
|
701
|
-
# association also specifies actions to take when applying
|
702
|
-
# 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
|
703
702
|
# might run once a day. If the software isn't installed, then State
|
704
703
|
# Manager installs it. If the software is installed, but the service
|
705
704
|
# isn't running, then the association might instruct State Manager to
|
@@ -707,7 +706,7 @@ module Aws::SSM
|
|
707
706
|
#
|
708
707
|
# @option params [required, String] :name
|
709
708
|
# The name of the SSM Command document or Automation runbook that
|
710
|
-
# contains the configuration information for the
|
709
|
+
# contains the configuration information for the managed node.
|
711
710
|
#
|
712
711
|
# You can specify Amazon Web Services-predefined documents, documents
|
713
712
|
# you created, or a document that is shared with you from another
|
@@ -732,9 +731,9 @@ module Aws::SSM
|
|
732
731
|
# a specific version or the default version.
|
733
732
|
#
|
734
733
|
# @option params [String] :instance_id
|
735
|
-
# The
|
734
|
+
# The managed node ID.
|
736
735
|
#
|
737
|
-
# <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
|
738
737
|
# association, use the `Targets` parameter. Requests that include the
|
739
738
|
# parameter `InstanceID` with Systems Manager documents (SSM documents)
|
740
739
|
# that use schema version 2.0 or later will fail. In addition, if you
|
@@ -749,14 +748,14 @@ module Aws::SSM
|
|
749
748
|
# The parameters for the runtime configuration of the document.
|
750
749
|
#
|
751
750
|
# @option params [Array<Types::Target>] :targets
|
752
|
-
# The targets for the association. You can target
|
753
|
-
# tags, Amazon Web Services resource groups, all
|
754
|
-
# Web Services account, or individual
|
755
|
-
#
|
756
|
-
# `InstanceIds` key with a value of `*`. For more
|
757
|
-
# choosing targets for an association, see [Using
|
758
|
-
# controls with State Manager associations][1] in the
|
759
|
-
# 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*.
|
760
759
|
#
|
761
760
|
#
|
762
761
|
#
|
@@ -786,9 +785,9 @@ module Aws::SSM
|
|
786
785
|
# of the target set, for example 10%. If you specify 3, for example, the
|
787
786
|
# system stops sending requests when the fourth error is received. If
|
788
787
|
# you specify 0, then the system stops sending requests after the first
|
789
|
-
# error is returned. If you run an association on 50
|
790
|
-
# `MaxError` to 10%, then the system stops sending the request when
|
791
|
-
# 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.
|
792
791
|
#
|
793
792
|
# Executions that are already running an association when `MaxErrors` is
|
794
793
|
# reached are allowed to complete, but some of these executions may fail
|
@@ -802,10 +801,10 @@ module Aws::SSM
|
|
802
801
|
# of the target set, for example 10%. The default value is 100%, which
|
803
802
|
# means all targets run the association at the same time.
|
804
803
|
#
|
805
|
-
# If a new
|
804
|
+
# If a new managed node starts and attempts to run an association while
|
806
805
|
# Systems Manager is running `MaxConcurrency` associations, the
|
807
806
|
# association is allowed to run. During the next association interval,
|
808
|
-
# the new
|
807
|
+
# the new managed node will process its association within the limit
|
809
808
|
# specified for `MaxConcurrency`.
|
810
809
|
#
|
811
810
|
# @option params [String] :compliance_severity
|
@@ -953,14 +952,14 @@ module Aws::SSM
|
|
953
952
|
end
|
954
953
|
|
955
954
|
# Associates the specified Amazon Web Services Systems Manager document
|
956
|
-
# (SSM document) with the specified
|
955
|
+
# (SSM document) with the specified managed nodes or targets.
|
957
956
|
#
|
958
|
-
# When you associate a document with one or more
|
959
|
-
#
|
960
|
-
#
|
961
|
-
#
|
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.
|
962
961
|
#
|
963
|
-
# If you associate a document with
|
962
|
+
# If you associate a document with a managed node that already has an
|
964
963
|
# associated document, the system returns the AssociationAlreadyExists
|
965
964
|
# exception.
|
966
965
|
#
|
@@ -1112,7 +1111,7 @@ module Aws::SSM
|
|
1112
1111
|
|
1113
1112
|
# Creates a Amazon Web Services Systems Manager (SSM document). An SSM
|
1114
1113
|
# document defines the actions that Systems Manager performs on your
|
1115
|
-
# managed
|
1114
|
+
# managed nodes. For more information about SSM documents, including
|
1116
1115
|
# information about supported schemas, features, and syntax, see [Amazon
|
1117
1116
|
# Web Services Systems Manager Documents][1] in the *Amazon Web Services
|
1118
1117
|
# Systems Manager User Guide*.
|
@@ -1273,7 +1272,7 @@ module Aws::SSM
|
|
1273
1272
|
# resp.document_description.parameters[0].description #=> String
|
1274
1273
|
# resp.document_description.parameters[0].default_value #=> String
|
1275
1274
|
# resp.document_description.platform_types #=> Array
|
1276
|
-
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
1275
|
+
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
1277
1276
|
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
1278
1277
|
# resp.document_description.schema_version #=> String
|
1279
1278
|
# resp.document_description.latest_version #=> String
|
@@ -1372,10 +1371,10 @@ module Aws::SSM
|
|
1372
1371
|
# execution.
|
1373
1372
|
#
|
1374
1373
|
# @option params [required, Boolean] :allow_unassociated_targets
|
1375
|
-
# Enables a maintenance window task to run on managed
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
#
|
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.
|
1379
1378
|
#
|
1380
1379
|
# If you don't enable this option, then you must specify
|
1381
1380
|
# previously-registered targets when you register a task with the
|
@@ -1716,8 +1715,8 @@ module Aws::SSM
|
|
1716
1715
|
#
|
1717
1716
|
# @option params [Boolean] :approved_patches_enable_non_security
|
1718
1717
|
# Indicates whether the list of approved patches includes non-security
|
1719
|
-
# updates that should be applied to the
|
1720
|
-
# `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.
|
1721
1720
|
#
|
1722
1721
|
# @option params [Array<String>] :rejected_patches
|
1723
1722
|
# A list of explicitly rejected patches for the baseline.
|
@@ -1752,9 +1751,9 @@ module Aws::SSM
|
|
1752
1751
|
# A description of the patch baseline.
|
1753
1752
|
#
|
1754
1753
|
# @option params [Array<Types::PatchSource>] :sources
|
1755
|
-
# Information about the patches to use to update the
|
1754
|
+
# Information about the patches to use to update the managed nodes,
|
1756
1755
|
# including target operating systems and source repositories. Applies to
|
1757
|
-
# Linux
|
1756
|
+
# Linux managed nodes only.
|
1758
1757
|
#
|
1759
1758
|
# @option params [String] :client_token
|
1760
1759
|
# User-provided idempotency token.
|
@@ -1952,9 +1951,8 @@ module Aws::SSM
|
|
1952
1951
|
|
1953
1952
|
# Deletes an activation. You aren't required to delete an activation.
|
1954
1953
|
# If you delete an activation, you can no longer use it to register
|
1955
|
-
# additional managed
|
1956
|
-
#
|
1957
|
-
# instances.
|
1954
|
+
# additional managed nodes. Deleting an activation doesn't de-register
|
1955
|
+
# managed nodes. You must manually de-register managed nodes.
|
1958
1956
|
#
|
1959
1957
|
# @option params [required, String] :activation_id
|
1960
1958
|
# The ID of the activation that you want to delete.
|
@@ -1977,23 +1975,23 @@ module Aws::SSM
|
|
1977
1975
|
end
|
1978
1976
|
|
1979
1977
|
# Disassociates the specified Amazon Web Services Systems Manager
|
1980
|
-
# document (SSM document) from the specified
|
1981
|
-
# the association by using the `Targets` parameter, then you
|
1982
|
-
# 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.
|
1983
1981
|
#
|
1984
|
-
# When you disassociate a document from
|
1985
|
-
# the configuration of the
|
1986
|
-
# of
|
1987
|
-
# new document with the desired configuration and associate it
|
1988
|
-
#
|
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.
|
1989
1987
|
#
|
1990
1988
|
# @option params [String] :name
|
1991
1989
|
# The name of the SSM document.
|
1992
1990
|
#
|
1993
1991
|
# @option params [String] :instance_id
|
1994
|
-
# The
|
1992
|
+
# The managed node ID.
|
1995
1993
|
#
|
1996
|
-
# <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
|
1997
1995
|
# association, use the `Targets` parameter. Requests that include the
|
1998
1996
|
# parameter `InstanceID` with Systems Manager documents (SSM documents)
|
1999
1997
|
# that use schema version 2.0 or later will fail. In addition, if you
|
@@ -2027,11 +2025,11 @@ module Aws::SSM
|
|
2027
2025
|
end
|
2028
2026
|
|
2029
2027
|
# Deletes the Amazon Web Services Systems Manager document (SSM
|
2030
|
-
# document) and all
|
2028
|
+
# document) and all managed node associations to the document.
|
2031
2029
|
#
|
2032
2030
|
# Before you delete the document, we recommend that you use
|
2033
|
-
# DeleteAssociation to disassociate all
|
2034
|
-
# with the document.
|
2031
|
+
# DeleteAssociation to disassociate all managed nodes that are
|
2032
|
+
# associated with the document.
|
2035
2033
|
#
|
2036
2034
|
# @option params [required, String] :name
|
2037
2035
|
# The name of the document.
|
@@ -2277,9 +2275,8 @@ module Aws::SSM
|
|
2277
2275
|
end
|
2278
2276
|
|
2279
2277
|
# Deletes a resource data sync configuration. After the configuration is
|
2280
|
-
# deleted, changes to data on managed
|
2281
|
-
#
|
2282
|
-
# 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.
|
2283
2280
|
#
|
2284
2281
|
# @option params [required, String] :sync_name
|
2285
2282
|
# The name of the configuration to delete.
|
@@ -2306,13 +2303,13 @@ module Aws::SSM
|
|
2306
2303
|
end
|
2307
2304
|
|
2308
2305
|
# Removes the server or virtual machine from the list of registered
|
2309
|
-
# servers. You can reregister the
|
2310
|
-
#
|
2311
|
-
#
|
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.
|
2312
2309
|
#
|
2313
2310
|
# @option params [required, String] :instance_id
|
2314
|
-
# The ID assigned to the managed
|
2315
|
-
#
|
2311
|
+
# The ID assigned to the managed node when you registered it using the
|
2312
|
+
# activation process.
|
2316
2313
|
#
|
2317
2314
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2318
2315
|
#
|
@@ -2442,8 +2439,8 @@ module Aws::SSM
|
|
2442
2439
|
|
2443
2440
|
# Describes details about the activation, such as the date and time the
|
2444
2441
|
# activation was created, its expiration date, the Identity and Access
|
2445
|
-
# Management (IAM) role assigned to the
|
2446
|
-
# 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.
|
2447
2444
|
#
|
2448
2445
|
# @option params [Array<Types::DescribeActivationsFilter>] :filters
|
2449
2446
|
# A filter to view information about your activations.
|
@@ -2503,15 +2500,15 @@ module Aws::SSM
|
|
2503
2500
|
req.send_request(options)
|
2504
2501
|
end
|
2505
2502
|
|
2506
|
-
# Describes the association for the specified target or
|
2507
|
-
# 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
|
2508
2505
|
# must retrieve the association by using the association ID.
|
2509
2506
|
#
|
2510
2507
|
# @option params [String] :name
|
2511
2508
|
# The name of the SSM document.
|
2512
2509
|
#
|
2513
2510
|
# @option params [String] :instance_id
|
2514
|
-
# The
|
2511
|
+
# The managed node ID.
|
2515
2512
|
#
|
2516
2513
|
# @option params [String] :association_id
|
2517
2514
|
# The association ID for which you want information.
|
@@ -2519,7 +2516,7 @@ module Aws::SSM
|
|
2519
2516
|
# @option params [String] :association_version
|
2520
2517
|
# Specify the association version to retrieve. To view the latest
|
2521
2518
|
# version, either specify `$LATEST` for this parameter, or omit this
|
2522
|
-
# parameter. To view a list of all associations for
|
2519
|
+
# parameter. To view a list of all associations for a managed node, use
|
2523
2520
|
# ListAssociations. To get a list of versions for a specific
|
2524
2521
|
# association, use ListAssociationVersions.
|
2525
2522
|
#
|
@@ -2952,7 +2949,7 @@ module Aws::SSM
|
|
2952
2949
|
#
|
2953
2950
|
# **Windows Server**
|
2954
2951
|
#
|
2955
|
-
# Supported keys for Windows Server
|
2952
|
+
# Supported keys for Windows Server managed node patches include the
|
2956
2953
|
# following:
|
2957
2954
|
#
|
2958
2955
|
# * <b> <code>PATCH_SET</code> </b>
|
@@ -2995,7 +2992,7 @@ module Aws::SSM
|
|
2995
2992
|
# `aws ssm describe-available-patches --filters
|
2996
2993
|
# Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615`
|
2997
2994
|
#
|
2998
|
-
# Supported keys for Linux
|
2995
|
+
# Supported keys for Linux managed node patches include the following:
|
2999
2996
|
#
|
3000
2997
|
# * <b> <code>PRODUCT</code> </b>
|
3001
2998
|
#
|
@@ -3155,7 +3152,7 @@ module Aws::SSM
|
|
3155
3152
|
# resp.document.parameters[0].description #=> String
|
3156
3153
|
# resp.document.parameters[0].default_value #=> String
|
3157
3154
|
# resp.document.platform_types #=> Array
|
3158
|
-
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux"
|
3155
|
+
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
3159
3156
|
# resp.document.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
3160
3157
|
# resp.document.schema_version #=> String
|
3161
3158
|
# resp.document.latest_version #=> String
|
@@ -3243,10 +3240,10 @@ module Aws::SSM
|
|
3243
3240
|
req.send_request(options)
|
3244
3241
|
end
|
3245
3242
|
|
3246
|
-
# All associations for the
|
3243
|
+
# All associations for the managed node(s).
|
3247
3244
|
#
|
3248
3245
|
# @option params [required, String] :instance_id
|
3249
|
-
# The
|
3246
|
+
# The managed node ID for which you want to view all associations.
|
3250
3247
|
#
|
3251
3248
|
# @option params [Integer] :max_results
|
3252
3249
|
# The maximum number of items to return for this call. The call also
|
@@ -3362,10 +3359,11 @@ module Aws::SSM
|
|
3362
3359
|
req.send_request(options)
|
3363
3360
|
end
|
3364
3361
|
|
3365
|
-
# The status of the associations for the
|
3362
|
+
# The status of the associations for the managed node(s).
|
3366
3363
|
#
|
3367
3364
|
# @option params [required, String] :instance_id
|
3368
|
-
# The
|
3365
|
+
# The managed node IDs for which you want association status
|
3366
|
+
# information.
|
3369
3367
|
#
|
3370
3368
|
# @option params [Integer] :max_results
|
3371
3369
|
# The maximum number of items to return for this call. The call also
|
@@ -3417,17 +3415,17 @@ module Aws::SSM
|
|
3417
3415
|
req.send_request(options)
|
3418
3416
|
end
|
3419
3417
|
|
3420
|
-
# Describes one or more of your
|
3421
|
-
# the operating system platform, the version of SSM Agent
|
3422
|
-
# 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.
|
3423
3421
|
#
|
3424
|
-
# If you specify one or more
|
3425
|
-
# those
|
3426
|
-
# information for all your
|
3427
|
-
# 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.
|
3428
3426
|
#
|
3429
3427
|
# <note markdown="1"> The `IamRole` field for this API operation is the Identity and Access
|
3430
|
-
# Management (IAM) role assigned to on-premises
|
3428
|
+
# Management (IAM) role assigned to on-premises managed nodes. This call
|
3431
3429
|
# doesn't return the IAM role for EC2 instances.
|
3432
3430
|
#
|
3433
3431
|
# </note>
|
@@ -3435,8 +3433,7 @@ module Aws::SSM
|
|
3435
3433
|
# @option params [Array<Types::InstanceInformationFilter>] :instance_information_filter_list
|
3436
3434
|
# This is a legacy method. We recommend that you don't use this method.
|
3437
3435
|
# Instead, use the `Filters` data type. `Filters` enables you to return
|
3438
|
-
#
|
3439
|
-
# instances.
|
3436
|
+
# node information by filtering based on tags applied to managed nodes.
|
3440
3437
|
#
|
3441
3438
|
# <note markdown="1"> Attempting to use `InstanceInformationFilterList` and `Filters` leads
|
3442
3439
|
# to an exception error.
|
@@ -3445,9 +3442,9 @@ module Aws::SSM
|
|
3445
3442
|
#
|
3446
3443
|
# @option params [Array<Types::InstanceInformationStringFilter>] :filters
|
3447
3444
|
# One or more filters. Use a filter to return a more specific list of
|
3448
|
-
#
|
3449
|
-
# this `Filters` data type instead of
|
3450
|
-
# 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.
|
3451
3448
|
#
|
3452
3449
|
# @option params [Integer] :max_results
|
3453
3450
|
# The maximum number of items to return for this call. The call also
|
@@ -3492,7 +3489,7 @@ module Aws::SSM
|
|
3492
3489
|
# resp.instance_information_list[0].last_ping_date_time #=> Time
|
3493
3490
|
# resp.instance_information_list[0].agent_version #=> String
|
3494
3491
|
# resp.instance_information_list[0].is_latest_version #=> Boolean
|
3495
|
-
# 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"
|
3496
3493
|
# resp.instance_information_list[0].platform_name #=> String
|
3497
3494
|
# resp.instance_information_list[0].platform_version #=> String
|
3498
3495
|
# resp.instance_information_list[0].activation_id #=> String
|
@@ -3508,6 +3505,8 @@ module Aws::SSM
|
|
3508
3505
|
# resp.instance_information_list[0].association_overview.detailed_status #=> String
|
3509
3506
|
# resp.instance_information_list[0].association_overview.instance_association_status_aggregated_count #=> Hash
|
3510
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"
|
3511
3510
|
# resp.next_token #=> String
|
3512
3511
|
#
|
3513
3512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceInformation AWS API Documentation
|
@@ -3519,10 +3518,10 @@ module Aws::SSM
|
|
3519
3518
|
req.send_request(options)
|
3520
3519
|
end
|
3521
3520
|
|
3522
|
-
# Retrieves the high-level patch state of one or more
|
3521
|
+
# Retrieves the high-level patch state of one or more managed nodes.
|
3523
3522
|
#
|
3524
3523
|
# @option params [required, Array<String>] :instance_ids
|
3525
|
-
# The ID of the
|
3524
|
+
# The ID of the managed node for which patch state information should be
|
3526
3525
|
# retrieved.
|
3527
3526
|
#
|
3528
3527
|
# @option params [String] :next_token
|
@@ -3530,7 +3529,7 @@ module Aws::SSM
|
|
3530
3529
|
# token from a previous call.)
|
3531
3530
|
#
|
3532
3531
|
# @option params [Integer] :max_results
|
3533
|
-
# The maximum number of
|
3532
|
+
# The maximum number of managed nodes to return (per page).
|
3534
3533
|
#
|
3535
3534
|
# @return [Types::DescribeInstancePatchStatesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3536
3535
|
#
|
@@ -3583,7 +3582,7 @@ module Aws::SSM
|
|
3583
3582
|
req.send_request(options)
|
3584
3583
|
end
|
3585
3584
|
|
3586
|
-
# Retrieves the high-level patch state for the
|
3585
|
+
# Retrieves the high-level patch state for the managed nodes in the
|
3587
3586
|
# specified patch group.
|
3588
3587
|
#
|
3589
3588
|
# @option params [required, String] :patch_group
|
@@ -3664,12 +3663,12 @@ module Aws::SSM
|
|
3664
3663
|
req.send_request(options)
|
3665
3664
|
end
|
3666
3665
|
|
3667
|
-
# Retrieves information about the patches on the specified
|
3668
|
-
# their state relative to the patch baseline being used for the
|
3669
|
-
#
|
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.
|
3670
3669
|
#
|
3671
3670
|
# @option params [required, String] :instance_id
|
3672
|
-
# The ID of the
|
3671
|
+
# The ID of the managed node whose patch state information should be
|
3673
3672
|
# retrieved.
|
3674
3673
|
#
|
3675
3674
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
@@ -4012,7 +4011,7 @@ module Aws::SSM
|
|
4012
4011
|
# The ID of the maintenance window to retrieve information about.
|
4013
4012
|
#
|
4014
4013
|
# @option params [Array<Types::Target>] :targets
|
4015
|
-
# The
|
4014
|
+
# The managed node ID or key-value pair to retrieve information about.
|
4016
4015
|
#
|
4017
4016
|
# @option params [String] :resource_type
|
4018
4017
|
# The type of resource you want to retrieve information about. For
|
@@ -4287,10 +4286,10 @@ module Aws::SSM
|
|
4287
4286
|
end
|
4288
4287
|
|
4289
4288
|
# Retrieves information about the maintenance window targets or tasks
|
4290
|
-
# that
|
4289
|
+
# that a managed node is associated with.
|
4291
4290
|
#
|
4292
4291
|
# @option params [required, Array<Types::Target>] :targets
|
4293
|
-
# The
|
4292
|
+
# The managed node ID or key-value pair to retrieve information about.
|
4294
4293
|
#
|
4295
4294
|
# @option params [required, String] :resource_type
|
4296
4295
|
# The type of resource you want to retrieve information about. For
|
@@ -5163,18 +5162,19 @@ module Aws::SSM
|
|
5163
5162
|
# or plugin.
|
5164
5163
|
#
|
5165
5164
|
# `GetCommandInvocation` only gives the execution status of a plugin in
|
5166
|
-
# a document. To get the command execution status on a specific
|
5167
|
-
#
|
5168
|
-
#
|
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.
|
5169
5168
|
#
|
5170
5169
|
# @option params [required, String] :command_id
|
5171
5170
|
# (Required) The parent command ID of the invocation plugin.
|
5172
5171
|
#
|
5173
5172
|
# @option params [required, String] :instance_id
|
5174
|
-
# (Required) The ID of the managed
|
5175
|
-
# managed
|
5176
|
-
# instance
|
5177
|
-
# 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.
|
5178
5178
|
#
|
5179
5179
|
# @option params [String] :plugin_name
|
5180
5180
|
# The name of the plugin for which you want detailed results. If the
|
@@ -5255,12 +5255,12 @@ module Aws::SSM
|
|
5255
5255
|
req.send_request(options)
|
5256
5256
|
end
|
5257
5257
|
|
5258
|
-
# Retrieves the Session Manager connection status for
|
5258
|
+
# Retrieves the Session Manager connection status for a managed node to
|
5259
5259
|
# determine whether it is running and ready to receive Session Manager
|
5260
5260
|
# connections.
|
5261
5261
|
#
|
5262
5262
|
# @option params [required, String] :target
|
5263
|
-
# The
|
5263
|
+
# The managed node ID.
|
5264
5264
|
#
|
5265
5265
|
# @return [Types::GetConnectionStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5266
5266
|
#
|
@@ -5323,7 +5323,7 @@ module Aws::SSM
|
|
5323
5323
|
req.send_request(options)
|
5324
5324
|
end
|
5325
5325
|
|
5326
|
-
# Retrieves the current snapshot for the patch baseline the
|
5326
|
+
# Retrieves the current snapshot for the patch baseline the managed node
|
5327
5327
|
# uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems
|
5328
5328
|
# Manager document (SSM document).
|
5329
5329
|
#
|
@@ -5332,7 +5332,7 @@ module Aws::SSM
|
|
5332
5332
|
# Services credentials and the operation fails. To avoid this, you can
|
5333
5333
|
# run the command in the Amazon Web Services Systems Manager console.
|
5334
5334
|
# Use Run Command, a capability of Amazon Web Services Systems Manager,
|
5335
|
-
# with an SSM document that enables you to target
|
5335
|
+
# with an SSM document that enables you to target a managed node with a
|
5336
5336
|
# script or command. For example, run the command using the
|
5337
5337
|
# `AWS-RunShellScript` document or the `AWS-RunPowerShellScript`
|
5338
5338
|
# document.
|
@@ -5340,8 +5340,8 @@ module Aws::SSM
|
|
5340
5340
|
# </note>
|
5341
5341
|
#
|
5342
5342
|
# @option params [required, String] :instance_id
|
5343
|
-
# The ID of the
|
5344
|
-
# be retrieved.
|
5343
|
+
# The ID of the managed node for which the appropriate patch snapshot
|
5344
|
+
# should be retrieved.
|
5345
5345
|
#
|
5346
5346
|
# @option params [required, String] :snapshot_id
|
5347
5347
|
# The snapshot ID provided by the user when running
|
@@ -5496,8 +5496,8 @@ module Aws::SSM
|
|
5496
5496
|
req.send_request(options)
|
5497
5497
|
end
|
5498
5498
|
|
5499
|
-
# Query inventory information. This includes
|
5500
|
-
# `Stopped` or `Terminated`.
|
5499
|
+
# Query inventory information. This includes managed node status, such
|
5500
|
+
# as `Stopped` or `Terminated`.
|
5501
5501
|
#
|
5502
5502
|
# @option params [Array<Types::InventoryFilter>] :filters
|
5503
5503
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -5507,7 +5507,8 @@ module Aws::SSM
|
|
5507
5507
|
# Returns counts of inventory types based on one or more expressions.
|
5508
5508
|
# For example, if you aggregate by using an expression that uses the
|
5509
5509
|
# `AWS:InstanceInformation.PlatformType` type, you can see a count of
|
5510
|
-
# how many Windows and Linux
|
5510
|
+
# how many Windows and Linux managed nodes exist in your inventoried
|
5511
|
+
# fleet.
|
5511
5512
|
#
|
5512
5513
|
# @option params [Array<Types::ResultAttribute>] :result_attributes
|
5513
5514
|
# The list of inventory item types to return.
|
@@ -6786,9 +6787,9 @@ module Aws::SSM
|
|
6786
6787
|
|
6787
6788
|
# Returns all State Manager associations in the current Amazon Web
|
6788
6789
|
# Services account and Amazon Web Services Region. You can limit the
|
6789
|
-
# results to a specific State Manager association document or
|
6790
|
-
# by specifying a filter. State Manager is a capability of Amazon
|
6791
|
-
# 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.
|
6792
6793
|
#
|
6793
6794
|
# @option params [Array<Types::AssociationFilter>] :association_filter_list
|
6794
6795
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -6796,7 +6797,7 @@ module Aws::SSM
|
|
6796
6797
|
#
|
6797
6798
|
# <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
|
6798
6799
|
# legacy associations created using the `InstanceID` attribute.
|
6799
|
-
# Associations targeting the
|
6800
|
+
# Associations targeting the managed node that are part of the Target
|
6800
6801
|
# Attributes `ResourceGroup` or `Tags` aren't returned.
|
6801
6802
|
#
|
6802
6803
|
# </note>
|
@@ -6860,18 +6861,19 @@ module Aws::SSM
|
|
6860
6861
|
req.send_request(options)
|
6861
6862
|
end
|
6862
6863
|
|
6863
|
-
# An invocation is copy of a command sent to a specific
|
6864
|
-
# command can apply to one or more
|
6865
|
-
# applies to one
|
6866
|
-
# against three
|
6867
|
-
# requested
|
6868
|
-
# 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.
|
6869
6870
|
#
|
6870
6871
|
# @option params [String] :command_id
|
6871
6872
|
# (Optional) The invocations for a specific command ID.
|
6872
6873
|
#
|
6873
6874
|
# @option params [String] :instance_id
|
6874
|
-
# (Optional) The command execution details for a specific
|
6875
|
+
# (Optional) The command execution details for a specific managed node
|
6876
|
+
# ID.
|
6875
6877
|
#
|
6876
6878
|
# @option params [Integer] :max_results
|
6877
6879
|
# (Optional) The maximum number of items to return for this call. The
|
@@ -6966,11 +6968,11 @@ module Aws::SSM
|
|
6966
6968
|
# (Optional) If provided, lists only the specified command.
|
6967
6969
|
#
|
6968
6970
|
# @option params [String] :instance_id
|
6969
|
-
# (Optional) Lists commands issued against this
|
6971
|
+
# (Optional) Lists commands issued against this managed node ID.
|
6970
6972
|
#
|
6971
|
-
# <note markdown="1"> You can't specify
|
6972
|
-
# `Status` = `Pending`. This is because the command hasn't
|
6973
|
-
#
|
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.
|
6974
6976
|
#
|
6975
6977
|
# </note>
|
6976
6978
|
#
|
@@ -7384,7 +7386,7 @@ module Aws::SSM
|
|
7384
7386
|
# resp.document_identifiers[0].owner #=> String
|
7385
7387
|
# resp.document_identifiers[0].version_name #=> String
|
7386
7388
|
# resp.document_identifiers[0].platform_types #=> Array
|
7387
|
-
# 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"
|
7388
7390
|
# resp.document_identifiers[0].document_version #=> String
|
7389
7391
|
# resp.document_identifiers[0].document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
7390
7392
|
# resp.document_identifiers[0].schema_version #=> String
|
@@ -7412,7 +7414,7 @@ module Aws::SSM
|
|
7412
7414
|
# A list of inventory items returned by the request.
|
7413
7415
|
#
|
7414
7416
|
# @option params [required, String] :instance_id
|
7415
|
-
# The
|
7417
|
+
# The managed node ID for which you want inventory information.
|
7416
7418
|
#
|
7417
7419
|
# @option params [required, String] :type_name
|
7418
7420
|
# The type of inventory item for which you want information.
|
@@ -7912,7 +7914,7 @@ module Aws::SSM
|
|
7912
7914
|
# * ExecutionType: Specify patch, association, or Custom:`string`.
|
7913
7915
|
#
|
7914
7916
|
# * ExecutionTime. The time the patch, association, or custom compliance
|
7915
|
-
# item was applied to the
|
7917
|
+
# item was applied to the managed node.
|
7916
7918
|
#
|
7917
7919
|
# * Id: The patch, association, or custom compliance ID.
|
7918
7920
|
#
|
@@ -7945,8 +7947,8 @@ module Aws::SSM
|
|
7945
7947
|
# following format: yyyy-MM-dd'T'HH:mm:ss'Z'
|
7946
7948
|
#
|
7947
7949
|
# @option params [required, String] :resource_id
|
7948
|
-
# Specify an ID for this resource. For a managed
|
7949
|
-
#
|
7950
|
+
# Specify an ID for this resource. For a managed node, this is the node
|
7951
|
+
# ID.
|
7950
7952
|
#
|
7951
7953
|
# @option params [required, String] :resource_type
|
7952
7954
|
# Specify the type of resource. `ManagedInstance` is currently the only
|
@@ -8024,15 +8026,15 @@ module Aws::SSM
|
|
8024
8026
|
req.send_request(options)
|
8025
8027
|
end
|
8026
8028
|
|
8027
|
-
# Bulk update custom inventory items on one more
|
8028
|
-
# adds an inventory item, if it doesn't already exist, or
|
8029
|
-
# 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.
|
8030
8032
|
#
|
8031
8033
|
# @option params [required, String] :instance_id
|
8032
|
-
# An
|
8034
|
+
# An managed node ID where you want to add or update inventory items.
|
8033
8035
|
#
|
8034
8036
|
# @option params [required, Array<Types::InventoryItem>] :items
|
8035
|
-
# 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.
|
8036
8038
|
#
|
8037
8039
|
# @return [Types::PutInventoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8038
8040
|
#
|
@@ -8445,7 +8447,7 @@ module Aws::SSM
|
|
8445
8447
|
#
|
8446
8448
|
# @option params [required, Array<Types::Target>] :targets
|
8447
8449
|
# The targets to register with the maintenance window. In other words,
|
8448
|
-
# the
|
8450
|
+
# the managed nodes to run commands on when the maintenance window runs.
|
8449
8451
|
#
|
8450
8452
|
# <note markdown="1"> If a single maintenance window task is registered with multiple
|
8451
8453
|
# targets, its task invocations occur sequentially and not in parallel.
|
@@ -8455,35 +8457,33 @@ module Aws::SSM
|
|
8455
8457
|
#
|
8456
8458
|
# </note>
|
8457
8459
|
#
|
8458
|
-
# You can specify targets using
|
8459
|
-
# 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.
|
8460
8462
|
#
|
8461
|
-
# **Example 1**\: Specify
|
8463
|
+
# **Example 1**\: Specify managed node IDs
|
8462
8464
|
#
|
8463
|
-
# `Key=InstanceIds,Values
|
8465
|
+
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`
|
8464
8466
|
#
|
8465
|
-
# **Example 2**\: Use tag key-pairs applied to
|
8467
|
+
# **Example 2**\: Use tag key-pairs applied to managed nodes
|
8466
8468
|
#
|
8467
|
-
# `Key=tag
|
8469
|
+
# `Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`
|
8468
8470
|
#
|
8469
|
-
# **Example 3**\: Use tag-keys applied to
|
8471
|
+
# **Example 3**\: Use tag-keys applied to managed nodes
|
8470
8472
|
#
|
8471
|
-
# `Key=tag-key,Values
|
8473
|
+
# `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`
|
8472
8474
|
#
|
8473
8475
|
# **Example 4**\: Use resource group names
|
8474
8476
|
#
|
8475
|
-
# `Key=resource-groups:Name,Values
|
8477
|
+
# `Key=resource-groups:Name,Values=<resource-group-name>`
|
8476
8478
|
#
|
8477
8479
|
# **Example 5**\: Use filters for resource group types
|
8478
8480
|
#
|
8479
|
-
# `Key=resource-groups:ResourceTypeFilters,Values
|
8480
|
-
# `
|
8481
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`
|
8481
8482
|
#
|
8482
8483
|
# <note markdown="1"> For `Key=resource-groups:ResourceTypeFilters`, specify resource types
|
8483
8484
|
# in the following format
|
8484
8485
|
#
|
8485
|
-
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
|
8486
|
-
# `
|
8486
|
+
# `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC`
|
8487
8487
|
#
|
8488
8488
|
# </note>
|
8489
8489
|
#
|
@@ -8553,7 +8553,7 @@ module Aws::SSM
|
|
8553
8553
|
# The ID of the maintenance window the task should be added to.
|
8554
8554
|
#
|
8555
8555
|
# @option params [Array<Types::Target>] :targets
|
8556
|
-
# The targets (either
|
8556
|
+
# The targets (either managed nodes or maintenance window targets).
|
8557
8557
|
#
|
8558
8558
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
8559
8559
|
# Command-type tasks. Depending on the task, targets are optional for
|
@@ -8564,7 +8564,7 @@ module Aws::SSM
|
|
8564
8564
|
#
|
8565
8565
|
# </note>
|
8566
8566
|
#
|
8567
|
-
# Specify
|
8567
|
+
# Specify managed nodes using the following format:
|
8568
8568
|
#
|
8569
8569
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
8570
8570
|
#
|
@@ -8648,7 +8648,7 @@ module Aws::SSM
|
|
8648
8648
|
#
|
8649
8649
|
# @option params [Types::LoggingInfo] :logging_info
|
8650
8650
|
# A structure containing information about an Amazon Simple Storage
|
8651
|
-
# Service (Amazon S3) bucket to write
|
8651
|
+
# Service (Amazon S3) bucket to write managed node-level logs to.
|
8652
8652
|
#
|
8653
8653
|
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
8654
8654
|
# Service (Amazon S3) bucket to contain logs, instead use the
|
@@ -8787,9 +8787,8 @@ module Aws::SSM
|
|
8787
8787
|
# The type of resource from which you want to remove a tag.
|
8788
8788
|
#
|
8789
8789
|
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
8790
|
-
# on-premises managed
|
8791
|
-
#
|
8792
|
-
# `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`.
|
8793
8792
|
#
|
8794
8793
|
# </note>
|
8795
8794
|
#
|
@@ -8813,10 +8812,9 @@ module Aws::SSM
|
|
8813
8812
|
#
|
8814
8813
|
# For the Document and Parameter values, use the name of the resource.
|
8815
8814
|
#
|
8816
|
-
# <note markdown="1"> The ManagedInstance type for this API operation is only for
|
8817
|
-
# on-premises managed
|
8818
|
-
#
|
8819
|
-
# 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.
|
8820
8818
|
#
|
8821
8819
|
# </note>
|
8822
8820
|
#
|
@@ -8906,7 +8904,7 @@ module Aws::SSM
|
|
8906
8904
|
req.send_request(options)
|
8907
8905
|
end
|
8908
8906
|
|
8909
|
-
# Reconnects a session to
|
8907
|
+
# Reconnects a session to a managed node after it has been disconnected.
|
8910
8908
|
# Connections can be resumed for disconnected sessions, but not
|
8911
8909
|
# terminated sessions.
|
8912
8910
|
#
|
@@ -8996,18 +8994,18 @@ module Aws::SSM
|
|
8996
8994
|
req.send_request(options)
|
8997
8995
|
end
|
8998
8996
|
|
8999
|
-
# Runs commands on one or more managed
|
8997
|
+
# Runs commands on one or more managed nodes.
|
9000
8998
|
#
|
9001
8999
|
# @option params [Array<String>] :instance_ids
|
9002
|
-
# The IDs of the
|
9003
|
-
#
|
9004
|
-
#
|
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.
|
9005
9003
|
#
|
9006
|
-
# To target a larger number of
|
9007
|
-
# 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
|
9008
9006
|
# instead. Using `Targets`, which accepts tag key-value pairs to
|
9009
|
-
# identify the
|
9010
|
-
# 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.
|
9011
9009
|
#
|
9012
9010
|
# For more information about how to use targets, see [Using targets and
|
9013
9011
|
# rate controls to send commands to a fleet][1] in the *Amazon Web
|
@@ -9018,15 +9016,15 @@ module Aws::SSM
|
|
9018
9016
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
9019
9017
|
#
|
9020
9018
|
# @option params [Array<Types::Target>] :targets
|
9021
|
-
# An array of search criteria that targets
|
9022
|
-
# combination that you specify. Specifying targets is most
|
9023
|
-
# you want to send a command to a large number of
|
9024
|
-
# Using `Targets`, which accepts tag key-value pairs to
|
9025
|
-
#
|
9026
|
-
#
|
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.
|
9027
9025
|
#
|
9028
|
-
# To send a command to a smaller number of
|
9029
|
-
# `InstanceIds` option instead.
|
9026
|
+
# To send a command to a smaller number of managed nodes, you can use
|
9027
|
+
# the `InstanceIds` option instead.
|
9030
9028
|
#
|
9031
9029
|
# For more information about how to use targets, see [Sending commands
|
9032
9030
|
# to a fleet][1] in the *Amazon Web Services Systems Manager User
|
@@ -9108,8 +9106,8 @@ module Aws::SSM
|
|
9108
9106
|
# should be stored.
|
9109
9107
|
#
|
9110
9108
|
# @option params [String] :max_concurrency
|
9111
|
-
# (Optional) The maximum number of
|
9112
|
-
# 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
|
9113
9111
|
# percentage such as 10%. The default value is `50`. For more
|
9114
9112
|
# information about how to use `MaxConcurrency`, see [Using concurrency
|
9115
9113
|
# controls][1] in the *Amazon Web Services Systems Manager User Guide*.
|
@@ -9553,7 +9551,7 @@ module Aws::SSM
|
|
9553
9551
|
req.send_request(options)
|
9554
9552
|
end
|
9555
9553
|
|
9556
|
-
# Initiates a connection to a target (for example,
|
9554
|
+
# Initiates a connection to a target (for example, a managed node) for a
|
9557
9555
|
# Session Manager session. Returns a URL and token that can be used to
|
9558
9556
|
# open a WebSocket connection for sending input and receiving outputs.
|
9559
9557
|
#
|
@@ -9574,14 +9572,14 @@ module Aws::SSM
|
|
9574
9572
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
|
9575
9573
|
#
|
9576
9574
|
# @option params [required, String] :target
|
9577
|
-
# The
|
9575
|
+
# The managed node to connect to for the session.
|
9578
9576
|
#
|
9579
9577
|
# @option params [String] :document_name
|
9580
9578
|
# The name of the SSM document to define the parameters and plugin
|
9581
9579
|
# settings for the session. For example, `SSM-SessionManagerRunShell`.
|
9582
9580
|
# You can call the GetDocument API to verify the document exists before
|
9583
9581
|
# attempting to start a session. If no document name is provided, a
|
9584
|
-
# shell to the
|
9582
|
+
# shell to the managed node is launched by default.
|
9585
9583
|
#
|
9586
9584
|
# @option params [String] :reason
|
9587
9585
|
# The reason for connecting to the instance. This value is included in
|
@@ -9651,7 +9649,7 @@ module Aws::SSM
|
|
9651
9649
|
end
|
9652
9650
|
|
9653
9651
|
# Permanently ends a session and closes the data connection between the
|
9654
|
-
# Session Manager client and SSM Agent on the
|
9652
|
+
# Session Manager client and SSM Agent on the managed node. A terminated
|
9655
9653
|
# session isn't be resumed.
|
9656
9654
|
#
|
9657
9655
|
# @option params [required, String] :session_id
|
@@ -9759,7 +9757,7 @@ module Aws::SSM
|
|
9759
9757
|
#
|
9760
9758
|
# @option params [String] :name
|
9761
9759
|
# The name of the SSM Command document or Automation runbook that
|
9762
|
-
# contains the configuration information for the
|
9760
|
+
# contains the configuration information for the managed node.
|
9763
9761
|
#
|
9764
9762
|
# You can specify Amazon Web Services-predefined documents, documents
|
9765
9763
|
# you created, or a document that is shared with you from another
|
@@ -9804,9 +9802,9 @@ module Aws::SSM
|
|
9804
9802
|
# of the target set, for example 10%. If you specify 3, for example, the
|
9805
9803
|
# system stops sending requests when the fourth error is received. If
|
9806
9804
|
# you specify 0, then the system stops sending requests after the first
|
9807
|
-
# error is returned. If you run an association on 50
|
9808
|
-
# `MaxError` to 10%, then the system stops sending the request when
|
9809
|
-
# 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.
|
9810
9808
|
#
|
9811
9809
|
# Executions that are already running an association when `MaxErrors` is
|
9812
9810
|
# reached are allowed to complete, but some of these executions may fail
|
@@ -9820,10 +9818,10 @@ module Aws::SSM
|
|
9820
9818
|
# of the target set, for example 10%. The default value is 100%, which
|
9821
9819
|
# means all targets run the association at the same time.
|
9822
9820
|
#
|
9823
|
-
# If a new
|
9821
|
+
# If a new managed node starts and attempts to run an association while
|
9824
9822
|
# Systems Manager is running `MaxConcurrency` associations, the
|
9825
9823
|
# association is allowed to run. During the next association interval,
|
9826
|
-
# the new
|
9824
|
+
# the new managed node will process its association within the limit
|
9827
9825
|
# specified for `MaxConcurrency`.
|
9828
9826
|
#
|
9829
9827
|
# @option params [String] :compliance_severity
|
@@ -9980,7 +9978,7 @@ module Aws::SSM
|
|
9980
9978
|
end
|
9981
9979
|
|
9982
9980
|
# Updates the status of the Amazon Web Services Systems Manager document
|
9983
|
-
# (SSM document) associated with the specified
|
9981
|
+
# (SSM document) associated with the specified managed node.
|
9984
9982
|
#
|
9985
9983
|
# `UpdateAssociationStatus` is primarily used by the Amazon Web Services
|
9986
9984
|
# Systems Manager Agent (SSM Agent) to report status updates about your
|
@@ -9991,7 +9989,7 @@ module Aws::SSM
|
|
9991
9989
|
# The name of the SSM document.
|
9992
9990
|
#
|
9993
9991
|
# @option params [required, String] :instance_id
|
9994
|
-
# The
|
9992
|
+
# The managed node ID.
|
9995
9993
|
#
|
9996
9994
|
# @option params [required, Types::AssociationStatus] :association_status
|
9997
9995
|
# The association status.
|
@@ -10150,7 +10148,7 @@ module Aws::SSM
|
|
10150
10148
|
# resp.document_description.parameters[0].description #=> String
|
10151
10149
|
# resp.document_description.parameters[0].default_value #=> String
|
10152
10150
|
# resp.document_description.platform_types #=> Array
|
10153
|
-
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
10151
|
+
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux", "MacOS"
|
10154
10152
|
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
10155
10153
|
# resp.document_description.schema_version #=> String
|
10156
10154
|
# resp.document_description.latest_version #=> String
|
@@ -10546,8 +10544,8 @@ module Aws::SSM
|
|
10546
10544
|
# The task ID to modify.
|
10547
10545
|
#
|
10548
10546
|
# @option params [Array<Types::Target>] :targets
|
10549
|
-
# The targets (either
|
10550
|
-
# specified using the format
|
10547
|
+
# The targets (either managed nodes or tags) to modify. Managed nodes
|
10548
|
+
# are specified using the format
|
10551
10549
|
# `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified
|
10552
10550
|
# using the format ` Key=tag_name,Values=tag_value`.
|
10553
10551
|
#
|
@@ -10843,12 +10841,12 @@ module Aws::SSM
|
|
10843
10841
|
end
|
10844
10842
|
|
10845
10843
|
# Changes the Identity and Access Management (IAM) role that is assigned
|
10846
|
-
# to the on-premises
|
10847
|
-
# 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
|
10848
10846
|
# process. For more information, see CreateActivation.
|
10849
10847
|
#
|
10850
10848
|
# @option params [required, String] :instance_id
|
10851
|
-
# The ID of the managed
|
10849
|
+
# The ID of the managed node where you want to update the role.
|
10852
10850
|
#
|
10853
10851
|
# @option params [required, String] :iam_role
|
10854
10852
|
# The IAM role you want to assign or change.
|
@@ -11103,8 +11101,8 @@ module Aws::SSM
|
|
11103
11101
|
#
|
11104
11102
|
# @option params [Boolean] :approved_patches_enable_non_security
|
11105
11103
|
# Indicates whether the list of approved patches includes non-security
|
11106
|
-
# updates that should be applied to the
|
11107
|
-
# `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.
|
11108
11106
|
#
|
11109
11107
|
# @option params [Array<String>] :rejected_patches
|
11110
11108
|
# A list of explicitly rejected patches for the baseline.
|
@@ -11139,9 +11137,9 @@ module Aws::SSM
|
|
11139
11137
|
# A description of the patch baseline.
|
11140
11138
|
#
|
11141
11139
|
# @option params [Array<Types::PatchSource>] :sources
|
11142
|
-
# Information about the patches to use to update the
|
11140
|
+
# Information about the patches to use to update the managed nodes,
|
11143
11141
|
# including target operating systems and source repositories. Applies to
|
11144
|
-
# Linux
|
11142
|
+
# Linux managed nodes only.
|
11145
11143
|
#
|
11146
11144
|
# @option params [Boolean] :replace
|
11147
11145
|
# If True, then all fields that are required by the CreatePatchBaseline
|
@@ -11399,7 +11397,7 @@ module Aws::SSM
|
|
11399
11397
|
params: params,
|
11400
11398
|
config: config)
|
11401
11399
|
context[:gem_name] = 'aws-sdk-ssm'
|
11402
|
-
context[:gem_version] = '1.
|
11400
|
+
context[:gem_version] = '1.125.0'
|
11403
11401
|
Seahorse::Client::Request.new(handlers, context)
|
11404
11402
|
end
|
11405
11403
|
|