aws-sdk-ssm 1.73.0 → 1.78.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/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +366 -178
- data/lib/aws-sdk-ssm/client_api.rb +15 -1
- data/lib/aws-sdk-ssm/resource.rb +1 -7
- data/lib/aws-sdk-ssm/types.rb +527 -288
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d5bf2ad3cfabbbef5e9bf8bb3d3eb65f1629aa34193e40d307ccf140d313c62b
|
4
|
+
data.tar.gz: 2d7fd1a0968dedc23420a89ef4fa6de33909edfaa1fbab7917af75615016c2af
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f19fd080ce1245ce80e828c4ecedd33368a22c0fb3b44b80161da633602ca3fa71de5411216480337219b1b0319d0f3cba1dcefeee1e39e9cd41d6173a6cc51f
|
7
|
+
data.tar.gz: ba90f5e96f31021d198e453c1033b965a29198b55552d5b63eb81b62dffd277b554b465cb9d231eb88dd96edcdb393c5076a85e1a69e01f143157f004388d3db
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -105,7 +105,7 @@ module Aws::SSM
|
|
105
105
|
# @option options [required, String] :region
|
106
106
|
# The AWS region to connect to. The configured `:region` is
|
107
107
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
109
109
|
#
|
110
110
|
# * `Aws.config[:region]`
|
111
111
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +161,7 @@ module Aws::SSM
|
|
161
161
|
# @option options [String] :endpoint
|
162
162
|
# The client endpoint is normally constructed from the `:region`
|
163
163
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
165
165
|
#
|
166
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -279,8 +279,7 @@ module Aws::SSM
|
|
279
279
|
#
|
280
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
281
281
|
# number of seconds to wait for response data. This value can
|
282
|
-
# safely be set
|
283
|
-
# per-request on the session yielded by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
284
283
|
#
|
285
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
286
285
|
# seconds a connection is allowed to sit idle before it is
|
@@ -292,7 +291,7 @@ module Aws::SSM
|
|
292
291
|
# request body. This option has no effect unless the request has
|
293
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
294
293
|
# disables this behaviour. This value can safely be set per
|
295
|
-
# request on the session
|
294
|
+
# request on the session.
|
296
295
|
#
|
297
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
298
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -336,15 +335,14 @@ module Aws::SSM
|
|
336
335
|
# for each resource type. Using a consistent set of tag keys makes it
|
337
336
|
# easier for you to manage your resources. You can search and filter the
|
338
337
|
# resources based on the tags you add. Tags don't have any semantic
|
339
|
-
# meaning to
|
340
|
-
# characters.
|
338
|
+
# meaning to and are interpreted strictly as a string of characters.
|
341
339
|
#
|
342
|
-
# For more information about tags, see [Tagging
|
343
|
-
#
|
340
|
+
# For more information about using tags with EC2 instances, see [Tagging
|
341
|
+
# your Amazon EC2 resources][1] in the *Amazon EC2 User Guide*.
|
344
342
|
#
|
345
343
|
#
|
346
344
|
#
|
347
|
-
# [1]:
|
345
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html
|
348
346
|
#
|
349
347
|
# @option params [required, String] :resource_type
|
350
348
|
# Specifies the type of resource you are tagging.
|
@@ -471,19 +469,19 @@ module Aws::SSM
|
|
471
469
|
# manage them using Systems Manager capabilities. You use the activation
|
472
470
|
# code and ID when installing SSM Agent on machines in your hybrid
|
473
471
|
# environment. For more information about requirements for managing
|
474
|
-
# on-premises instances and VMs using Systems Manager, see [Setting
|
475
|
-
# AWS Systems Manager for
|
472
|
+
# on-premises instances and VMs using Systems Manager, see [Setting up
|
473
|
+
# AWS Systems Manager for hybrid environments][1] in the *AWS Systems
|
476
474
|
# Manager User Guide*.
|
477
475
|
#
|
478
476
|
# <note markdown="1"> On-premises servers or VMs that are registered with Systems Manager
|
479
|
-
# and
|
480
|
-
#
|
477
|
+
# and EC2 instances that you manage with Systems Manager are all called
|
478
|
+
# *managed instances*.
|
481
479
|
#
|
482
480
|
# </note>
|
483
481
|
#
|
484
482
|
#
|
485
483
|
#
|
486
|
-
# [1]:
|
484
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html
|
487
485
|
#
|
488
486
|
# @option params [String] :description
|
489
487
|
# A user-defined description of the resource that you want to register
|
@@ -502,13 +500,13 @@ module Aws::SSM
|
|
502
500
|
# The Amazon Identity and Access Management (IAM) role that you want to
|
503
501
|
# assign to the managed instance. This IAM role must provide AssumeRole
|
504
502
|
# permissions for the Systems Manager service principal
|
505
|
-
# `ssm.amazonaws.com`. For more information, see [Create an IAM
|
506
|
-
#
|
503
|
+
# `ssm.amazonaws.com`. For more information, see [Create an IAM service
|
504
|
+
# role for a hybrid environment][1] in the *AWS Systems Manager User
|
507
505
|
# Guide*.
|
508
506
|
#
|
509
507
|
#
|
510
508
|
#
|
511
|
-
# [1]:
|
509
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html
|
512
510
|
#
|
513
511
|
# @option params [Integer] :registration_limit
|
514
512
|
# Specify the maximum number of managed instances you want to register.
|
@@ -582,13 +580,11 @@ module Aws::SSM
|
|
582
580
|
# Associates the specified Systems Manager document with the specified
|
583
581
|
# instances or targets.
|
584
582
|
#
|
585
|
-
# When you associate a document with one or more instances
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
# associated document, the system returns the AssociationAlreadyExists
|
591
|
-
# exception.
|
583
|
+
# When you associate a document with one or more instances, SSM Agent
|
584
|
+
# running on the instance processes the document and configures the
|
585
|
+
# instance as specified. If you associate a document with an instance
|
586
|
+
# that already has an associated document, the system returns the
|
587
|
+
# `AssociationAlreadyExists` exception.
|
592
588
|
#
|
593
589
|
# @option params [required, String] :name
|
594
590
|
# The name of the SSM document that contains the configuration
|
@@ -634,16 +630,22 @@ module Aws::SSM
|
|
634
630
|
# The parameters for the runtime configuration of the document.
|
635
631
|
#
|
636
632
|
# @option params [Array<Types::Target>] :targets
|
637
|
-
# The targets
|
638
|
-
#
|
639
|
-
#
|
633
|
+
# The targets for the association. You can target instances by using
|
634
|
+
# tags, AWS Resource Groups, all instances in an AWS account, or
|
635
|
+
# individual instance IDs. For more information about choosing targets
|
636
|
+
# for an association, see [Using targets and rate controls with State
|
637
|
+
# Manager associations][1] in the *AWS Systems Manager User Guide*.
|
638
|
+
#
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html
|
640
642
|
#
|
641
643
|
# @option params [String] :schedule_expression
|
642
644
|
# A cron expression when the association will be applied to the
|
643
645
|
# target(s).
|
644
646
|
#
|
645
647
|
# @option params [Types::InstanceAssociationOutputLocation] :output_location
|
646
|
-
# An
|
648
|
+
# An S3 bucket where you want to store the output details of the
|
647
649
|
# request.
|
648
650
|
#
|
649
651
|
# @option params [String] :association_name
|
@@ -686,6 +688,21 @@ module Aws::SSM
|
|
686
688
|
# @option params [String] :compliance_severity
|
687
689
|
# The severity level to assign to the association.
|
688
690
|
#
|
691
|
+
# @option params [String] :sync_compliance
|
692
|
+
# The mode for generating association compliance. You can specify `AUTO`
|
693
|
+
# or `MANUAL`. In `AUTO` mode, the system uses the status of the
|
694
|
+
# association execution to determine the compliance status. If the
|
695
|
+
# association execution runs successfully, then the association is
|
696
|
+
# `COMPLIANT`. If the association execution doesn't run successfully,
|
697
|
+
# the association is `NON-COMPLIANT`.
|
698
|
+
#
|
699
|
+
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
700
|
+
# for the PutComplianceItems API action. In this case, compliance data
|
701
|
+
# is not managed by State Manager. It is managed by your direct call to
|
702
|
+
# the PutComplianceItems API action.
|
703
|
+
#
|
704
|
+
# By default, all associations use `AUTO` mode.
|
705
|
+
#
|
689
706
|
# @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
690
707
|
#
|
691
708
|
# * {Types::CreateAssociationResult#association_description #association_description} => Types::AssociationDescription
|
@@ -718,6 +735,7 @@ module Aws::SSM
|
|
718
735
|
# max_errors: "MaxErrors",
|
719
736
|
# max_concurrency: "MaxConcurrency",
|
720
737
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
738
|
+
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
721
739
|
# })
|
722
740
|
#
|
723
741
|
# @example Response structure
|
@@ -755,6 +773,7 @@ module Aws::SSM
|
|
755
773
|
# resp.association_description.max_errors #=> String
|
756
774
|
# resp.association_description.max_concurrency #=> String
|
757
775
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
776
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
758
777
|
#
|
759
778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociation AWS API Documentation
|
760
779
|
#
|
@@ -814,6 +833,7 @@ module Aws::SSM
|
|
814
833
|
# max_errors: "MaxErrors",
|
815
834
|
# max_concurrency: "MaxConcurrency",
|
816
835
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
836
|
+
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
817
837
|
# },
|
818
838
|
# ],
|
819
839
|
# })
|
@@ -854,6 +874,7 @@ module Aws::SSM
|
|
854
874
|
# resp.successful[0].max_errors #=> String
|
855
875
|
# resp.successful[0].max_concurrency #=> String
|
856
876
|
# resp.successful[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
877
|
+
# resp.successful[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
857
878
|
# resp.failed #=> Array
|
858
879
|
# resp.failed[0].entry.name #=> String
|
859
880
|
# resp.failed[0].entry.instance_id #=> String
|
@@ -874,6 +895,7 @@ module Aws::SSM
|
|
874
895
|
# resp.failed[0].entry.max_errors #=> String
|
875
896
|
# resp.failed[0].entry.max_concurrency #=> String
|
876
897
|
# resp.failed[0].entry.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
898
|
+
# resp.failed[0].entry.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
877
899
|
# resp.failed[0].message #=> String
|
878
900
|
# resp.failed[0].fault #=> String, one of "Client", "Server", "Unknown"
|
879
901
|
#
|
@@ -886,18 +908,48 @@ module Aws::SSM
|
|
886
908
|
req.send_request(options)
|
887
909
|
end
|
888
910
|
|
889
|
-
# Creates a Systems Manager document.
|
911
|
+
# Creates a Systems Manager (SSM) document. An SSM document defines the
|
912
|
+
# actions that Systems Manager performs on your managed instances. For
|
913
|
+
# more information about SSM documents, including information about
|
914
|
+
# supported schemas, features, and syntax, see [AWS Systems Manager
|
915
|
+
# Documents][1] in the *AWS Systems Manager User Guide*.
|
916
|
+
#
|
890
917
|
#
|
891
|
-
#
|
892
|
-
#
|
918
|
+
#
|
919
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html
|
893
920
|
#
|
894
921
|
# @option params [required, String] :content
|
895
|
-
#
|
922
|
+
# The content for the new SSM document in JSON or YAML format. We
|
923
|
+
# recommend storing the contents for your new document in an external
|
924
|
+
# JSON or YAML file and referencing the file in a command.
|
925
|
+
#
|
926
|
+
# For examples, see the following topics in the *AWS Systems Manager
|
927
|
+
# User Guide*.
|
928
|
+
#
|
929
|
+
# * [Create an SSM document (AWS API)][1]
|
930
|
+
#
|
931
|
+
# * [Create an SSM document (AWS CLI)][2]
|
932
|
+
#
|
933
|
+
# * [Create an SSM document (API)][1]
|
934
|
+
#
|
935
|
+
#
|
936
|
+
#
|
937
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html
|
938
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html
|
896
939
|
#
|
897
940
|
# @option params [Array<Types::DocumentRequires>] :requires
|
898
|
-
# A list of SSM documents required by a document.
|
941
|
+
# A list of SSM documents required by a document. This parameter is used
|
942
|
+
# exclusively by AWS AppConfig. When a user creates an AppConfig
|
943
|
+
# configuration in an SSM document, the user must also specify a
|
944
|
+
# required document for validation purposes. In this case, an
|
899
945
|
# `ApplicationConfiguration` document requires an
|
900
|
-
# `ApplicationConfigurationSchema` document.
|
946
|
+
# `ApplicationConfigurationSchema` document for validation purposes. For
|
947
|
+
# more information, see [AWS AppConfig][1] in the *AWS Systems Manager
|
948
|
+
# User Guide*.
|
949
|
+
#
|
950
|
+
#
|
951
|
+
#
|
952
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html
|
901
953
|
#
|
902
954
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
903
955
|
# A list of key and value pairs that describe attachments to a version
|
@@ -906,10 +958,10 @@ module Aws::SSM
|
|
906
958
|
# @option params [required, String] :name
|
907
959
|
# A name for the Systems Manager document.
|
908
960
|
#
|
909
|
-
#
|
910
|
-
#
|
961
|
+
# You can't use the following strings as document name prefixes. These
|
962
|
+
# are reserved by AWS for use as document name prefixes:
|
911
963
|
#
|
912
|
-
# * `aws
|
964
|
+
# * `aws-`
|
913
965
|
#
|
914
966
|
# * `amazon`
|
915
967
|
#
|
@@ -934,8 +986,8 @@ module Aws::SSM
|
|
934
986
|
# the following value: /AWS::EC2::Instance. If you specify a value of
|
935
987
|
# '/' the document can run on all types of resources. If you don't
|
936
988
|
# specify a value, the document can't run on any resources. For a list
|
937
|
-
# of valid resource types, see [AWS
|
938
|
-
# *AWS CloudFormation User Guide*.
|
989
|
+
# of valid resource types, see [AWS resource and property types
|
990
|
+
# reference][1] in the *AWS CloudFormation User Guide*.
|
939
991
|
#
|
940
992
|
#
|
941
993
|
#
|
@@ -1162,7 +1214,7 @@ module Aws::SSM
|
|
1162
1214
|
|
1163
1215
|
# Creates a new OpsItem. You must have permission in AWS Identity and
|
1164
1216
|
# Access Management (IAM) to create a new OpsItem. For more information,
|
1165
|
-
# see [Getting
|
1217
|
+
# see [Getting started with OpsCenter][1] in the *AWS Systems Manager
|
1166
1218
|
# User Guide*.
|
1167
1219
|
#
|
1168
1220
|
# Operations engineers and IT professionals use OpsCenter to view,
|
@@ -1173,8 +1225,8 @@ module Aws::SSM
|
|
1173
1225
|
#
|
1174
1226
|
#
|
1175
1227
|
#
|
1176
|
-
# [1]:
|
1177
|
-
# [2]:
|
1228
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
1229
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
1178
1230
|
#
|
1179
1231
|
# @option params [required, String] :description
|
1180
1232
|
# Information about the OpsItem.
|
@@ -1201,11 +1253,11 @@ module Aws::SSM
|
|
1201
1253
|
# resource in the request. Use the `/aws/automations` key in
|
1202
1254
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
1203
1255
|
# To view AWS CLI example commands that use these keys, see [Creating
|
1204
|
-
# OpsItems
|
1256
|
+
# OpsItems manually][1] in the *AWS Systems Manager User Guide*.
|
1205
1257
|
#
|
1206
1258
|
#
|
1207
1259
|
#
|
1208
|
-
# [1]:
|
1260
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems
|
1209
1261
|
#
|
1210
1262
|
# @option params [Array<Types::OpsItemNotification>] :notifications
|
1211
1263
|
# The Amazon Resource Name (ARN) of an SNS topic where notifications are
|
@@ -1222,7 +1274,12 @@ module Aws::SSM
|
|
1222
1274
|
# impacted resource.
|
1223
1275
|
#
|
1224
1276
|
# @option params [required, String] :source
|
1225
|
-
# The origin of the OpsItem, such as Amazon EC2 or
|
1277
|
+
# The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
|
1278
|
+
#
|
1279
|
+
# <note markdown="1"> The source name can't contain the following strings: aws, amazon, and
|
1280
|
+
# amzn.
|
1281
|
+
#
|
1282
|
+
# </note>
|
1226
1283
|
#
|
1227
1284
|
# @option params [required, String] :title
|
1228
1285
|
# A short heading that describes the nature of the OpsItem and the
|
@@ -1231,7 +1288,7 @@ module Aws::SSM
|
|
1231
1288
|
# @option params [Array<Types::Tag>] :tags
|
1232
1289
|
# Optional metadata that you assign to a resource. You can restrict
|
1233
1290
|
# access to OpsItems by using an inline IAM policy that specifies tags.
|
1234
|
-
# For more information, see [Getting
|
1291
|
+
# For more information, see [Getting started with OpsCenter][1] in the
|
1235
1292
|
# *AWS Systems Manager User Guide*.
|
1236
1293
|
#
|
1237
1294
|
# Tags use a key-value pair. For example:
|
@@ -1244,7 +1301,7 @@ module Aws::SSM
|
|
1244
1301
|
#
|
1245
1302
|
#
|
1246
1303
|
#
|
1247
|
-
# [1]:
|
1304
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions
|
1248
1305
|
#
|
1249
1306
|
# @option params [String] :category
|
1250
1307
|
# Specify a category to assign to an OpsItem.
|
@@ -1330,8 +1387,8 @@ module Aws::SSM
|
|
1330
1387
|
# A list of explicitly approved patches for the baseline.
|
1331
1388
|
#
|
1332
1389
|
# For information about accepted formats for lists of approved patches
|
1333
|
-
# and rejected patches, see [
|
1334
|
-
#
|
1390
|
+
# and rejected patches, see [About package name formats for approved and
|
1391
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
1335
1392
|
#
|
1336
1393
|
#
|
1337
1394
|
#
|
@@ -1351,8 +1408,8 @@ module Aws::SSM
|
|
1351
1408
|
# A list of explicitly rejected patches for the baseline.
|
1352
1409
|
#
|
1353
1410
|
# For information about accepted formats for lists of approved patches
|
1354
|
-
# and rejected patches, see [
|
1355
|
-
#
|
1411
|
+
# and rejected patches, see [About package name formats for approved and
|
1412
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
1356
1413
|
#
|
1357
1414
|
#
|
1358
1415
|
#
|
@@ -1412,7 +1469,7 @@ module Aws::SSM
|
|
1412
1469
|
# @example Request syntax with placeholder values
|
1413
1470
|
#
|
1414
1471
|
# resp = client.create_patch_baseline({
|
1415
|
-
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS
|
1472
|
+
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
1416
1473
|
# name: "BaselineName", # required
|
1417
1474
|
# global_filters: {
|
1418
1475
|
# patch_filters: [ # required
|
@@ -1481,18 +1538,18 @@ module Aws::SSM
|
|
1481
1538
|
#
|
1482
1539
|
# You can configure Systems Manager Inventory to use the
|
1483
1540
|
# `SyncToDestination` type to synchronize Inventory data from multiple
|
1484
|
-
# AWS Regions to a single
|
1541
|
+
# AWS Regions to a single S3 bucket. For more information, see
|
1485
1542
|
# [Configuring Resource Data Sync for Inventory][1] in the *AWS Systems
|
1486
1543
|
# Manager User Guide*.
|
1487
1544
|
#
|
1488
1545
|
# You can configure Systems Manager Explorer to use the `SyncFromSource`
|
1489
1546
|
# type to synchronize operational work items (OpsItems) and operational
|
1490
|
-
# data (OpsData) from multiple AWS Regions to a single
|
1491
|
-
#
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
#
|
1547
|
+
# data (OpsData) from multiple AWS Regions to a single S3 bucket. This
|
1548
|
+
# type can synchronize OpsItems and OpsData from multiple AWS accounts
|
1549
|
+
# and Regions or `EntireOrganization` by using AWS Organizations. For
|
1550
|
+
# more information, see [Setting up Systems Manager Explorer to display
|
1551
|
+
# data from multiple accounts and Regions][2] in the *AWS Systems
|
1552
|
+
# Manager User Guide*.
|
1496
1553
|
#
|
1497
1554
|
# A resource data sync is an asynchronous operation that returns
|
1498
1555
|
# immediately. After a successful initial sync is completed, the system
|
@@ -1508,23 +1565,29 @@ module Aws::SSM
|
|
1508
1565
|
#
|
1509
1566
|
#
|
1510
1567
|
#
|
1511
|
-
# [1]:
|
1512
|
-
# [2]:
|
1568
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html
|
1569
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html
|
1513
1570
|
#
|
1514
1571
|
# @option params [required, String] :sync_name
|
1515
1572
|
# A name for the configuration.
|
1516
1573
|
#
|
1517
1574
|
# @option params [Types::ResourceDataSyncS3Destination] :s3_destination
|
1518
|
-
# Amazon S3 configuration details for the sync.
|
1575
|
+
# Amazon S3 configuration details for the sync. This parameter is
|
1576
|
+
# required if the `SyncType` value is SyncToDestination.
|
1519
1577
|
#
|
1520
1578
|
# @option params [String] :sync_type
|
1521
1579
|
# Specify `SyncToDestination` to create a resource data sync that
|
1522
|
-
# synchronizes data
|
1523
|
-
#
|
1524
|
-
#
|
1580
|
+
# synchronizes data to an S3 bucket for Inventory. If you specify
|
1581
|
+
# `SyncToDestination`, you must provide a value for `S3Destination`.
|
1582
|
+
# Specify `SyncFromSource` to synchronize data from a single account and
|
1583
|
+
# multiple Regions, or multiple AWS accounts and Regions, as listed in
|
1584
|
+
# AWS Organizations for Explorer. If you specify `SyncFromSource`, you
|
1585
|
+
# must provide a value for `SyncSource`. The default value is
|
1586
|
+
# `SyncToDestination`.
|
1525
1587
|
#
|
1526
1588
|
# @option params [Types::ResourceDataSyncSource] :sync_source
|
1527
|
-
# Specify information about the data sources to synchronize.
|
1589
|
+
# Specify information about the data sources to synchronize. This
|
1590
|
+
# parameter is required if the `SyncType` value is SyncFromSource.
|
1528
1591
|
#
|
1529
1592
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1530
1593
|
#
|
@@ -2041,6 +2104,8 @@ module Aws::SSM
|
|
2041
2104
|
# * {Types::DescribeActivationsResult#activation_list #activation_list} => Array<Types::Activation>
|
2042
2105
|
# * {Types::DescribeActivationsResult#next_token #next_token} => String
|
2043
2106
|
#
|
2107
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2108
|
+
#
|
2044
2109
|
# @example Request syntax with placeholder values
|
2045
2110
|
#
|
2046
2111
|
# resp = client.describe_activations({
|
@@ -2151,6 +2216,7 @@ module Aws::SSM
|
|
2151
2216
|
# resp.association_description.max_errors #=> String
|
2152
2217
|
# resp.association_description.max_concurrency #=> String
|
2153
2218
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
2219
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
2154
2220
|
#
|
2155
2221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociation AWS API Documentation
|
2156
2222
|
#
|
@@ -2803,34 +2869,37 @@ module Aws::SSM
|
|
2803
2869
|
req.send_request(options)
|
2804
2870
|
end
|
2805
2871
|
|
2806
|
-
# Describes one or more of your instances
|
2807
|
-
#
|
2808
|
-
#
|
2809
|
-
#
|
2810
|
-
#
|
2811
|
-
# instances. If you specify
|
2812
|
-
#
|
2872
|
+
# Describes one or more of your instances, including information about
|
2873
|
+
# the operating system platform, the version of SSM Agent installed on
|
2874
|
+
# the instance, instance status, and so on.
|
2875
|
+
#
|
2876
|
+
# If you specify one or more instance IDs, it returns information for
|
2877
|
+
# those instances. If you do not specify instance IDs, it returns
|
2878
|
+
# information for all your instances. If you specify an instance ID that
|
2879
|
+
# is not valid or an instance that you do not own, you receive an error.
|
2813
2880
|
#
|
2814
2881
|
# <note markdown="1"> The IamRole field for this API action is the Amazon Identity and
|
2815
2882
|
# Access Management (IAM) role assigned to on-premises instances. This
|
2816
|
-
# call does not return the IAM role for
|
2883
|
+
# call does not return the IAM role for EC2 instances.
|
2817
2884
|
#
|
2818
2885
|
# </note>
|
2819
2886
|
#
|
2820
2887
|
# @option params [Array<Types::InstanceInformationFilter>] :instance_information_filter_list
|
2821
2888
|
# This is a legacy method. We recommend that you don't use this method.
|
2822
|
-
# Instead, use the
|
2823
|
-
#
|
2824
|
-
#
|
2889
|
+
# Instead, use the `Filters` data type. `Filters` enables you to return
|
2890
|
+
# instance information by filtering based on tags applied to managed
|
2891
|
+
# instances.
|
2892
|
+
#
|
2893
|
+
# <note markdown="1"> Attempting to use `InstanceInformationFilterList` and `Filters` leads
|
2894
|
+
# to an exception error.
|
2825
2895
|
#
|
2826
|
-
#
|
2827
|
-
# `InstanceInformationFilter` action. Using this method and the
|
2828
|
-
# `InstanceInformationFilter` action causes an exception error.
|
2896
|
+
# </note>
|
2829
2897
|
#
|
2830
2898
|
# @option params [Array<Types::InstanceInformationStringFilter>] :filters
|
2831
2899
|
# One or more filters. Use a filter to return a more specific list of
|
2832
|
-
# instances. You can filter on
|
2833
|
-
#
|
2900
|
+
# instances. You can filter based on tags applied to EC2 instances. Use
|
2901
|
+
# this `Filters` data type instead of `InstanceInformationFilterList`,
|
2902
|
+
# which is deprecated.
|
2834
2903
|
#
|
2835
2904
|
# @option params [Integer] :max_results
|
2836
2905
|
# The maximum number of items to return for this call. The call also
|
@@ -2846,6 +2915,8 @@ module Aws::SSM
|
|
2846
2915
|
# * {Types::DescribeInstanceInformationResult#instance_information_list #instance_information_list} => Array<Types::InstanceInformation>
|
2847
2916
|
# * {Types::DescribeInstanceInformationResult#next_token #next_token} => String
|
2848
2917
|
#
|
2918
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2919
|
+
#
|
2849
2920
|
# @example Request syntax with placeholder values
|
2850
2921
|
#
|
2851
2922
|
# resp = client.describe_instance_information({
|
@@ -3665,7 +3736,7 @@ module Aws::SSM
|
|
3665
3736
|
|
3666
3737
|
# Query a set of OpsItems. You must have permission in AWS Identity and
|
3667
3738
|
# Access Management (IAM) to query a list of OpsItems. For more
|
3668
|
-
# information, see [Getting
|
3739
|
+
# information, see [Getting started with OpsCenter][1] in the *AWS
|
3669
3740
|
# Systems Manager User Guide*.
|
3670
3741
|
#
|
3671
3742
|
# Operations engineers and IT professionals use OpsCenter to view,
|
@@ -3676,11 +3747,11 @@ module Aws::SSM
|
|
3676
3747
|
#
|
3677
3748
|
#
|
3678
3749
|
#
|
3679
|
-
# [1]:
|
3680
|
-
# [2]:
|
3750
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
3751
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
3681
3752
|
#
|
3682
3753
|
# @option params [Array<Types::OpsItemFilter>] :ops_item_filters
|
3683
|
-
# One or more filters to limit the
|
3754
|
+
# One or more filters to limit the response.
|
3684
3755
|
#
|
3685
3756
|
# * Key: CreatedTime
|
3686
3757
|
#
|
@@ -3827,6 +3898,8 @@ module Aws::SSM
|
|
3827
3898
|
# * {Types::DescribeParametersResult#parameters #parameters} => Array<Types::ParameterMetadata>
|
3828
3899
|
# * {Types::DescribeParametersResult#next_token #next_token} => String
|
3829
3900
|
#
|
3901
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3902
|
+
#
|
3830
3903
|
# @example Request syntax with placeholder values
|
3831
3904
|
#
|
3832
3905
|
# resp = client.describe_parameters({
|
@@ -3863,6 +3936,7 @@ module Aws::SSM
|
|
3863
3936
|
# resp.parameters[0].policies[0].policy_text #=> String
|
3864
3937
|
# resp.parameters[0].policies[0].policy_type #=> String
|
3865
3938
|
# resp.parameters[0].policies[0].policy_status #=> String
|
3939
|
+
# resp.parameters[0].data_type #=> String
|
3866
3940
|
# resp.next_token #=> String
|
3867
3941
|
#
|
3868
3942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeParameters AWS API Documentation
|
@@ -3914,7 +3988,7 @@ module Aws::SSM
|
|
3914
3988
|
# resp.baseline_identities #=> Array
|
3915
3989
|
# resp.baseline_identities[0].baseline_id #=> String
|
3916
3990
|
# resp.baseline_identities[0].baseline_name #=> String
|
3917
|
-
# resp.baseline_identities[0].operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS"
|
3991
|
+
# resp.baseline_identities[0].operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN"
|
3918
3992
|
# resp.baseline_identities[0].baseline_description #=> String
|
3919
3993
|
# resp.baseline_identities[0].default_baseline #=> Boolean
|
3920
3994
|
# resp.next_token #=> String
|
@@ -4010,7 +4084,7 @@ module Aws::SSM
|
|
4010
4084
|
# resp.mappings[0].patch_group #=> String
|
4011
4085
|
# resp.mappings[0].baseline_identity.baseline_id #=> String
|
4012
4086
|
# resp.mappings[0].baseline_identity.baseline_name #=> String
|
4013
|
-
# resp.mappings[0].baseline_identity.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS"
|
4087
|
+
# 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"
|
4014
4088
|
# resp.mappings[0].baseline_identity.baseline_description #=> String
|
4015
4089
|
# resp.mappings[0].baseline_identity.default_baseline #=> Boolean
|
4016
4090
|
# resp.next_token #=> String
|
@@ -4091,7 +4165,7 @@ module Aws::SSM
|
|
4091
4165
|
# @example Request syntax with placeholder values
|
4092
4166
|
#
|
4093
4167
|
# resp = client.describe_patch_properties({
|
4094
|
-
# operating_system: "WINDOWS", # required, accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS
|
4168
|
+
# operating_system: "WINDOWS", # required, accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
4095
4169
|
# property: "PRODUCT", # required, accepts PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY, PRIORITY, SEVERITY
|
4096
4170
|
# patch_set: "OS", # accepts OS, APPLICATION
|
4097
4171
|
# max_results: 1,
|
@@ -4359,8 +4433,8 @@ module Aws::SSM
|
|
4359
4433
|
#
|
4360
4434
|
# @option params [required, String] :instance_id
|
4361
4435
|
# (Required) The ID of the managed instance targeted by the command. A
|
4362
|
-
# managed instance can be an
|
4363
|
-
#
|
4436
|
+
# managed instance can be an EC2 instance or an instance in your hybrid
|
4437
|
+
# environment that is configured for Systems Manager.
|
4364
4438
|
#
|
4365
4439
|
# @option params [String] :plugin_name
|
4366
4440
|
# (Optional) The name of the plugin for which you want detailed results.
|
@@ -4426,7 +4500,7 @@ module Aws::SSM
|
|
4426
4500
|
end
|
4427
4501
|
|
4428
4502
|
# Retrieves the Session Manager connection status for an instance to
|
4429
|
-
# determine whether it is
|
4503
|
+
# determine whether it is running and ready to receive Session Manager
|
4430
4504
|
# connections.
|
4431
4505
|
#
|
4432
4506
|
# @option params [required, String] :target
|
@@ -4475,13 +4549,13 @@ module Aws::SSM
|
|
4475
4549
|
# @example Request syntax with placeholder values
|
4476
4550
|
#
|
4477
4551
|
# resp = client.get_default_patch_baseline({
|
4478
|
-
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS
|
4552
|
+
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
4479
4553
|
# })
|
4480
4554
|
#
|
4481
4555
|
# @example Response structure
|
4482
4556
|
#
|
4483
4557
|
# resp.baseline_id #=> String
|
4484
|
-
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS"
|
4558
|
+
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN"
|
4485
4559
|
#
|
4486
4560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDefaultPatchBaseline AWS API Documentation
|
4487
4561
|
#
|
@@ -4541,7 +4615,7 @@ module Aws::SSM
|
|
4541
4615
|
# @option params [String] :version_name
|
4542
4616
|
# An optional field specifying the version of the artifact associated
|
4543
4617
|
# with the document. For example, "Release 12, Update 6". This value
|
4544
|
-
# is unique across all versions of a document
|
4618
|
+
# is unique across all versions of a document and can't be changed.
|
4545
4619
|
#
|
4546
4620
|
# @option params [String] :document_version
|
4547
4621
|
# The document version for which you want information.
|
@@ -5060,7 +5134,7 @@ module Aws::SSM
|
|
5060
5134
|
# Get information about an OpsItem by using the ID. You must have
|
5061
5135
|
# permission in AWS Identity and Access Management (IAM) to view
|
5062
5136
|
# information about an OpsItem. For more information, see [Getting
|
5063
|
-
#
|
5137
|
+
# started with OpsCenter][1] in the *AWS Systems Manager User Guide*.
|
5064
5138
|
#
|
5065
5139
|
# Operations engineers and IT professionals use OpsCenter to view,
|
5066
5140
|
# investigate, and remediate operational issues impacting the
|
@@ -5070,8 +5144,8 @@ module Aws::SSM
|
|
5070
5144
|
#
|
5071
5145
|
#
|
5072
5146
|
#
|
5073
|
-
# [1]:
|
5074
|
-
# [2]:
|
5147
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
5148
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
5075
5149
|
#
|
5076
5150
|
# @option params [required, String] :ops_item_id
|
5077
5151
|
# The ID of the OpsItem that you want to get.
|
@@ -5238,6 +5312,7 @@ module Aws::SSM
|
|
5238
5312
|
# resp.parameter.source_result #=> String
|
5239
5313
|
# resp.parameter.last_modified_date #=> Time
|
5240
5314
|
# resp.parameter.arn #=> String
|
5315
|
+
# resp.parameter.data_type #=> String
|
5241
5316
|
#
|
5242
5317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameter AWS API Documentation
|
5243
5318
|
#
|
@@ -5271,6 +5346,8 @@ module Aws::SSM
|
|
5271
5346
|
# * {Types::GetParameterHistoryResult#parameters #parameters} => Array<Types::ParameterHistory>
|
5272
5347
|
# * {Types::GetParameterHistoryResult#next_token #next_token} => String
|
5273
5348
|
#
|
5349
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5350
|
+
#
|
5274
5351
|
# @example Request syntax with placeholder values
|
5275
5352
|
#
|
5276
5353
|
# resp = client.get_parameter_history({
|
@@ -5299,6 +5376,7 @@ module Aws::SSM
|
|
5299
5376
|
# resp.parameters[0].policies[0].policy_text #=> String
|
5300
5377
|
# resp.parameters[0].policies[0].policy_type #=> String
|
5301
5378
|
# resp.parameters[0].policies[0].policy_status #=> String
|
5379
|
+
# resp.parameters[0].data_type #=> String
|
5302
5380
|
# resp.next_token #=> String
|
5303
5381
|
#
|
5304
5382
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameterHistory AWS API Documentation
|
@@ -5344,6 +5422,7 @@ module Aws::SSM
|
|
5344
5422
|
# resp.parameters[0].source_result #=> String
|
5345
5423
|
# resp.parameters[0].last_modified_date #=> Time
|
5346
5424
|
# resp.parameters[0].arn #=> String
|
5425
|
+
# resp.parameters[0].data_type #=> String
|
5347
5426
|
# resp.invalid_parameters #=> Array
|
5348
5427
|
# resp.invalid_parameters[0] #=> String
|
5349
5428
|
#
|
@@ -5406,6 +5485,8 @@ module Aws::SSM
|
|
5406
5485
|
# * {Types::GetParametersByPathResult#parameters #parameters} => Array<Types::Parameter>
|
5407
5486
|
# * {Types::GetParametersByPathResult#next_token #next_token} => String
|
5408
5487
|
#
|
5488
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5489
|
+
#
|
5409
5490
|
# @example Request syntax with placeholder values
|
5410
5491
|
#
|
5411
5492
|
# resp = client.get_parameters_by_path({
|
@@ -5434,6 +5515,7 @@ module Aws::SSM
|
|
5434
5515
|
# resp.parameters[0].source_result #=> String
|
5435
5516
|
# resp.parameters[0].last_modified_date #=> Time
|
5436
5517
|
# resp.parameters[0].arn #=> String
|
5518
|
+
# resp.parameters[0].data_type #=> String
|
5437
5519
|
# resp.next_token #=> String
|
5438
5520
|
#
|
5439
5521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParametersByPath AWS API Documentation
|
@@ -5478,7 +5560,7 @@ module Aws::SSM
|
|
5478
5560
|
#
|
5479
5561
|
# resp.baseline_id #=> String
|
5480
5562
|
# resp.name #=> String
|
5481
|
-
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS"
|
5563
|
+
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN"
|
5482
5564
|
# resp.global_filters.patch_filters #=> Array
|
5483
5565
|
# resp.global_filters.patch_filters[0].key #=> String, one of "PATCH_SET", "PRODUCT", "PRODUCT_FAMILY", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID", "SECTION", "PRIORITY", "SEVERITY"
|
5484
5566
|
# resp.global_filters.patch_filters[0].values #=> Array
|
@@ -5539,14 +5621,14 @@ module Aws::SSM
|
|
5539
5621
|
#
|
5540
5622
|
# resp = client.get_patch_baseline_for_patch_group({
|
5541
5623
|
# patch_group: "PatchGroup", # required
|
5542
|
-
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS
|
5624
|
+
# operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN
|
5543
5625
|
# })
|
5544
5626
|
#
|
5545
5627
|
# @example Response structure
|
5546
5628
|
#
|
5547
5629
|
# resp.baseline_id #=> String
|
5548
5630
|
# resp.patch_group #=> String
|
5549
|
-
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS"
|
5631
|
+
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN"
|
5550
5632
|
#
|
5551
5633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaselineForPatchGroup AWS API Documentation
|
5552
5634
|
#
|
@@ -5576,7 +5658,10 @@ module Aws::SSM
|
|
5576
5658
|
# Query the current service setting for the account.
|
5577
5659
|
#
|
5578
5660
|
# @option params [required, String] :setting_id
|
5579
|
-
# The ID of the service setting to get.
|
5661
|
+
# The ID of the service setting to get. The setting ID can be
|
5662
|
+
# `/ssm/parameter-store/default-parameter-tier`,
|
5663
|
+
# `/ssm/parameter-store/high-throughput-enabled`, or
|
5664
|
+
# `/ssm/managed-instance/activation-tier`.
|
5580
5665
|
#
|
5581
5666
|
# @return [Types::GetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5582
5667
|
#
|
@@ -5729,6 +5814,7 @@ module Aws::SSM
|
|
5729
5814
|
# resp.association_versions[0].max_errors #=> String
|
5730
5815
|
# resp.association_versions[0].max_concurrency #=> String
|
5731
5816
|
# resp.association_versions[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
5817
|
+
# resp.association_versions[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
5732
5818
|
# resp.next_token #=> String
|
5733
5819
|
#
|
5734
5820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociationVersions AWS API Documentation
|
@@ -5762,12 +5848,14 @@ module Aws::SSM
|
|
5762
5848
|
# * {Types::ListAssociationsResult#associations #associations} => Array<Types::Association>
|
5763
5849
|
# * {Types::ListAssociationsResult#next_token #next_token} => String
|
5764
5850
|
#
|
5851
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5852
|
+
#
|
5765
5853
|
# @example Request syntax with placeholder values
|
5766
5854
|
#
|
5767
5855
|
# resp = client.list_associations({
|
5768
5856
|
# association_filter_list: [
|
5769
5857
|
# {
|
5770
|
-
# key: "InstanceId", # required, accepts InstanceId, Name, AssociationId, AssociationStatusName, LastExecutedBefore, LastExecutedAfter, AssociationName
|
5858
|
+
# key: "InstanceId", # required, accepts InstanceId, Name, AssociationId, AssociationStatusName, LastExecutedBefore, LastExecutedAfter, AssociationName, ResourceGroupName
|
5771
5859
|
# value: "AssociationFilterValue", # required
|
5772
5860
|
# },
|
5773
5861
|
# ],
|
@@ -5829,8 +5917,7 @@ module Aws::SSM
|
|
5829
5917
|
#
|
5830
5918
|
# @option params [Array<Types::CommandFilter>] :filters
|
5831
5919
|
# (Optional) One or more filters. Use a filter to return a more specific
|
5832
|
-
# list of results.
|
5833
|
-
# for ListCommandInvocations.
|
5920
|
+
# list of results.
|
5834
5921
|
#
|
5835
5922
|
# @option params [Boolean] :details
|
5836
5923
|
# (Optional) If set this returns the response of the command executions
|
@@ -5841,6 +5928,8 @@ module Aws::SSM
|
|
5841
5928
|
# * {Types::ListCommandInvocationsResult#command_invocations #command_invocations} => Array<Types::CommandInvocation>
|
5842
5929
|
# * {Types::ListCommandInvocationsResult#next_token #next_token} => String
|
5843
5930
|
#
|
5931
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5932
|
+
#
|
5844
5933
|
# @example Request syntax with placeholder values
|
5845
5934
|
#
|
5846
5935
|
# resp = client.list_command_invocations({
|
@@ -5929,6 +6018,8 @@ module Aws::SSM
|
|
5929
6018
|
# * {Types::ListCommandsResult#commands #commands} => Array<Types::Command>
|
5930
6019
|
# * {Types::ListCommandsResult#next_token #next_token} => String
|
5931
6020
|
#
|
6021
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6022
|
+
#
|
5932
6023
|
# @example Request syntax with placeholder values
|
5933
6024
|
#
|
5934
6025
|
# resp = client.list_commands({
|
@@ -5980,6 +6071,7 @@ module Aws::SSM
|
|
5980
6071
|
# resp.commands[0].notification_config.notification_type #=> String, one of "Command", "Invocation"
|
5981
6072
|
# resp.commands[0].cloud_watch_output_config.cloud_watch_log_group_name #=> String
|
5982
6073
|
# resp.commands[0].cloud_watch_output_config.cloud_watch_output_enabled #=> Boolean
|
6074
|
+
# resp.commands[0].timeout_seconds #=> Integer
|
5983
6075
|
# resp.next_token #=> String
|
5984
6076
|
#
|
5985
6077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommands AWS API Documentation
|
@@ -6185,12 +6277,16 @@ module Aws::SSM
|
|
6185
6277
|
# filter.
|
6186
6278
|
#
|
6187
6279
|
# @option params [Array<Types::DocumentFilter>] :document_filter_list
|
6188
|
-
#
|
6189
|
-
# results.
|
6280
|
+
# This data type is deprecated. Instead, use `Filters`.
|
6190
6281
|
#
|
6191
6282
|
# @option params [Array<Types::DocumentKeyValuesFilter>] :filters
|
6192
|
-
# One or more
|
6193
|
-
# results.
|
6283
|
+
# One or more DocumentKeyValuesFilter objects. Use a filter to return a
|
6284
|
+
# more specific list of results. For keys, you can specify one or more
|
6285
|
+
# key-value pair tags that have been applied to a document. Other valid
|
6286
|
+
# keys include `Owner`, `Name`, `PlatformTypes`, `DocumentType`, and
|
6287
|
+
# `TargetType`. For example, to return documents you own use
|
6288
|
+
# `Key=Owner,Values=Self`. To specify a custom key-value pair, use the
|
6289
|
+
# format `Key=tag:tagName,Values=valueName`.
|
6194
6290
|
#
|
6195
6291
|
# @option params [Integer] :max_results
|
6196
6292
|
# The maximum number of items to return for this call. The call also
|
@@ -6206,6 +6302,8 @@ module Aws::SSM
|
|
6206
6302
|
# * {Types::ListDocumentsResult#document_identifiers #document_identifiers} => Array<Types::DocumentIdentifier>
|
6207
6303
|
# * {Types::ListDocumentsResult#next_token #next_token} => String
|
6208
6304
|
#
|
6305
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6306
|
+
#
|
6209
6307
|
# @example Request syntax with placeholder values
|
6210
6308
|
#
|
6211
6309
|
# resp = client.list_documents({
|
@@ -6620,13 +6718,28 @@ module Aws::SSM
|
|
6620
6718
|
# @option params [required, Array<Types::ComplianceItemEntry>] :items
|
6621
6719
|
# Information about the compliance as defined by the resource type. For
|
6622
6720
|
# example, for a patch compliance type, `Items` includes information
|
6623
|
-
# about the PatchSeverity, Classification,
|
6721
|
+
# about the PatchSeverity, Classification, and so on.
|
6624
6722
|
#
|
6625
6723
|
# @option params [String] :item_content_hash
|
6626
6724
|
# MD5 or SHA-256 content hash. The content hash is used to determine if
|
6627
6725
|
# existing information should be overwritten or ignored. If the content
|
6628
6726
|
# hashes match, the request to put compliance information is ignored.
|
6629
6727
|
#
|
6728
|
+
# @option params [String] :upload_type
|
6729
|
+
# The mode for uploading compliance items. You can specify `COMPLETE` or
|
6730
|
+
# `PARTIAL`. In `COMPLETE` mode, the system overwrites all existing
|
6731
|
+
# compliance information for the resource. You must provide a full list
|
6732
|
+
# of compliance items each time you send the request.
|
6733
|
+
#
|
6734
|
+
# In `PARTIAL` mode, the system overwrites compliance information for a
|
6735
|
+
# specific association. The association must be configured with
|
6736
|
+
# `SyncCompliance` set to `MANUAL`. By default, all requests use
|
6737
|
+
# `COMPLETE` mode.
|
6738
|
+
#
|
6739
|
+
# <note markdown="1"> This attribute is only valid for association compliance.
|
6740
|
+
#
|
6741
|
+
# </note>
|
6742
|
+
#
|
6630
6743
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6631
6744
|
#
|
6632
6745
|
# @example Request syntax with placeholder values
|
@@ -6652,6 +6765,7 @@ module Aws::SSM
|
|
6652
6765
|
# },
|
6653
6766
|
# ],
|
6654
6767
|
# item_content_hash: "ComplianceItemContentHash",
|
6768
|
+
# upload_type: "COMPLETE", # accepts COMPLETE, PARTIAL
|
6655
6769
|
# })
|
6656
6770
|
#
|
6657
6771
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutComplianceItems AWS API Documentation
|
@@ -6739,8 +6853,8 @@ module Aws::SSM
|
|
6739
6853
|
# levels.
|
6740
6854
|
#
|
6741
6855
|
# For additional information about valid values for parameter names, see
|
6742
|
-
# [
|
6743
|
-
# Systems Manager User Guide*.
|
6856
|
+
# [About requirements and constraints for parameter names][1] in the
|
6857
|
+
# *AWS Systems Manager User Guide*.
|
6744
6858
|
#
|
6745
6859
|
# <note markdown="1"> The maximum length constraint listed below includes capacity for
|
6746
6860
|
# additional system attributes that are not part of the name. The
|
@@ -6754,7 +6868,7 @@ module Aws::SSM
|
|
6754
6868
|
#
|
6755
6869
|
#
|
6756
6870
|
#
|
6757
|
-
# [1]:
|
6871
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html
|
6758
6872
|
#
|
6759
6873
|
# @option params [String] :description
|
6760
6874
|
# Information about the parameter that you want to add to the system.
|
@@ -6767,7 +6881,7 @@ module Aws::SSM
|
|
6767
6881
|
# parameters have a value limit of 4 KB. Advanced parameters have a
|
6768
6882
|
# value limit of 8 KB.
|
6769
6883
|
#
|
6770
|
-
# @option params [
|
6884
|
+
# @option params [String] :type
|
6771
6885
|
# The type of parameter that you want to add to the system.
|
6772
6886
|
#
|
6773
6887
|
# Items in a `StringList` must be separated by a comma (,). You can't
|
@@ -6838,8 +6952,9 @@ module Aws::SSM
|
|
6838
6952
|
# Advanced parameters have a content size limit of 8 KB and can be
|
6839
6953
|
# configured to use parameter policies. You can create a maximum of
|
6840
6954
|
# 100,000 advanced parameters for each Region in an AWS account.
|
6841
|
-
# Advanced parameters incur a charge. For more information, see
|
6842
|
-
#
|
6955
|
+
# Advanced parameters incur a charge. For more information, see
|
6956
|
+
# [Standard and advanced parameter tiers][1] in the *AWS Systems Manager
|
6957
|
+
# User Guide*.
|
6843
6958
|
#
|
6844
6959
|
# You can change a standard parameter to an advanced parameter any time.
|
6845
6960
|
# But you can't revert an advanced parameter to a standard parameter.
|
@@ -6893,13 +7008,13 @@ module Aws::SSM
|
|
6893
7008
|
# current Region.
|
6894
7009
|
#
|
6895
7010
|
# For more information about configuring the default tier option, see
|
6896
|
-
# [Specifying a
|
7011
|
+
# [Specifying a default parameter tier][2] in the *AWS Systems Manager
|
6897
7012
|
# User Guide*.
|
6898
7013
|
#
|
6899
7014
|
#
|
6900
7015
|
#
|
6901
|
-
# [1]:
|
6902
|
-
# [2]:
|
7016
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html
|
7017
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html
|
6903
7018
|
#
|
6904
7019
|
# @option params [String] :policies
|
6905
7020
|
# One or more policies to apply to a parameter. This action takes a JSON
|
@@ -6923,11 +7038,32 @@ module Aws::SSM
|
|
6923
7038
|
#
|
6924
7039
|
# All existing policies are preserved until you send new policies or an
|
6925
7040
|
# empty policy. For more information about parameter policies, see
|
6926
|
-
# [
|
7041
|
+
# [Assigning parameter policies][1].
|
7042
|
+
#
|
7043
|
+
#
|
7044
|
+
#
|
7045
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html
|
6927
7046
|
#
|
7047
|
+
# @option params [String] :data_type
|
7048
|
+
# The data type for a `String` parameter. Supported data types include
|
7049
|
+
# plain text and Amazon Machine Image IDs.
|
6928
7050
|
#
|
7051
|
+
# **The following data type values are supported.**
|
6929
7052
|
#
|
6930
|
-
#
|
7053
|
+
# * `text`
|
7054
|
+
#
|
7055
|
+
# * `aws:ec2:image`
|
7056
|
+
#
|
7057
|
+
# When you create a `String` parameter and specify `aws:ec2:image`,
|
7058
|
+
# Systems Manager validates the parameter value is in the required
|
7059
|
+
# format, such as `ami-12345abcdeEXAMPLE`, and that the specified AMI is
|
7060
|
+
# available in your AWS account. For more information, see [Native
|
7061
|
+
# parameter support for Amazon Machine Image IDs][1] in the *AWS Systems
|
7062
|
+
# Manager User Guide*.
|
7063
|
+
#
|
7064
|
+
#
|
7065
|
+
#
|
7066
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html
|
6931
7067
|
#
|
6932
7068
|
# @return [Types::PutParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6933
7069
|
#
|
@@ -6940,7 +7076,7 @@ module Aws::SSM
|
|
6940
7076
|
# name: "PSParameterName", # required
|
6941
7077
|
# description: "ParameterDescription",
|
6942
7078
|
# value: "PSParameterValue", # required
|
6943
|
-
# type: "String", #
|
7079
|
+
# type: "String", # accepts String, StringList, SecureString
|
6944
7080
|
# key_id: "ParameterKeyId",
|
6945
7081
|
# overwrite: false,
|
6946
7082
|
# allowed_pattern: "AllowedPattern",
|
@@ -6952,6 +7088,7 @@ module Aws::SSM
|
|
6952
7088
|
# ],
|
6953
7089
|
# tier: "Standard", # accepts Standard, Advanced, Intelligent-Tiering
|
6954
7090
|
# policies: "ParameterPolicies",
|
7091
|
+
# data_type: "ParameterDataType",
|
6955
7092
|
# })
|
6956
7093
|
#
|
6957
7094
|
# @example Response structure
|
@@ -7083,8 +7220,8 @@ module Aws::SSM
|
|
7083
7220
|
# </note>
|
7084
7221
|
#
|
7085
7222
|
# For more information about these examples formats, including the best
|
7086
|
-
# use case for each one, see [Examples: Register
|
7087
|
-
#
|
7223
|
+
# use case for each one, see [Examples: Register targets with a
|
7224
|
+
# maintenance window][1] in the *AWS Systems Manager User Guide*.
|
7088
7225
|
#
|
7089
7226
|
#
|
7090
7227
|
#
|
@@ -7170,15 +7307,15 @@ module Aws::SSM
|
|
7170
7307
|
# For more information, see the following topics in the in the *AWS
|
7171
7308
|
# Systems Manager User Guide*\:
|
7172
7309
|
#
|
7173
|
-
# * [
|
7310
|
+
# * [Using service-linked roles for Systems Manager][1]
|
7174
7311
|
#
|
7175
|
-
# * [Should I
|
7176
|
-
#
|
7312
|
+
# * [Should I use a service-linked role or a custom service role to run
|
7313
|
+
# maintenance window tasks? ][2]
|
7177
7314
|
#
|
7178
7315
|
#
|
7179
7316
|
#
|
7180
|
-
# [1]:
|
7181
|
-
# [2]:
|
7317
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions
|
7318
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role
|
7182
7319
|
#
|
7183
7320
|
# @option params [required, String] :task_type
|
7184
7321
|
# The type of task being registered.
|
@@ -7213,7 +7350,7 @@ module Aws::SSM
|
|
7213
7350
|
# scheduled.
|
7214
7351
|
#
|
7215
7352
|
# @option params [Types::LoggingInfo] :logging_info
|
7216
|
-
# A structure containing information about an
|
7353
|
+
# A structure containing information about an S3 bucket to write
|
7217
7354
|
# instance-level logs to.
|
7218
7355
|
#
|
7219
7356
|
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an S3 bucket to contain
|
@@ -7394,7 +7531,11 @@ module Aws::SSM
|
|
7394
7531
|
# provisioned by the AWS service team.
|
7395
7532
|
#
|
7396
7533
|
# @option params [required, String] :setting_id
|
7397
|
-
# The
|
7534
|
+
# The Amazon Resource Name (ARN) of the service setting to reset. The
|
7535
|
+
# setting ID can be `/ssm/parameter-store/default-parameter-tier`,
|
7536
|
+
# `/ssm/parameter-store/high-throughput-enabled`, or
|
7537
|
+
# `/ssm/managed-instance/activation-tier`. For example,
|
7538
|
+
# `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`.
|
7398
7539
|
#
|
7399
7540
|
# @return [Types::ResetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7400
7541
|
#
|
@@ -7521,23 +7662,23 @@ module Aws::SSM
|
|
7521
7662
|
# maximum of 50 IDs. If you prefer not to list individual instance IDs,
|
7522
7663
|
# you can instead send commands to a fleet of instances using the
|
7523
7664
|
# Targets parameter, which accepts EC2 tags. For more information about
|
7524
|
-
# how to use targets, see [
|
7525
|
-
# Systems Manager User Guide*.
|
7665
|
+
# how to use targets, see [Using targets and rate controls to send
|
7666
|
+
# commands to a fleet][1] in the *AWS Systems Manager User Guide*.
|
7526
7667
|
#
|
7527
7668
|
#
|
7528
7669
|
#
|
7529
|
-
# [1]:
|
7670
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
7530
7671
|
#
|
7531
7672
|
# @option params [Array<Types::Target>] :targets
|
7532
7673
|
# (Optional) An array of search criteria that targets instances using a
|
7533
7674
|
# Key,Value combination that you specify. Targets is required if you
|
7534
7675
|
# don't provide one or more instance IDs in the call. For more
|
7535
|
-
# information about how to use targets, see [Sending
|
7536
|
-
#
|
7676
|
+
# information about how to use targets, see [Sending commands to a
|
7677
|
+
# fleet][1] in the *AWS Systems Manager User Guide*.
|
7537
7678
|
#
|
7538
7679
|
#
|
7539
7680
|
#
|
7540
|
-
# [1]:
|
7681
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
7541
7682
|
#
|
7542
7683
|
# @option params [required, String] :document_name
|
7543
7684
|
# Required. The name of the Systems Manager document to run. This can be
|
@@ -7586,7 +7727,7 @@ module Aws::SSM
|
|
7586
7727
|
# @option params [String] :output_s3_region
|
7587
7728
|
# (Deprecated) You can no longer specify this parameter. The system
|
7588
7729
|
# ignores it. Instead, Systems Manager automatically determines the
|
7589
|
-
#
|
7730
|
+
# Region of the S3 bucket.
|
7590
7731
|
#
|
7591
7732
|
# @option params [String] :output_s3_bucket_name
|
7592
7733
|
# The name of the S3 bucket where command execution responses should be
|
@@ -7600,12 +7741,12 @@ module Aws::SSM
|
|
7600
7741
|
# (Optional) The maximum number of instances that are allowed to run the
|
7601
7742
|
# command at the same time. You can specify a number such as 10 or a
|
7602
7743
|
# percentage such as 10%. The default value is 50. For more information
|
7603
|
-
# about how to use MaxConcurrency, see [Using
|
7744
|
+
# about how to use MaxConcurrency, see [Using concurrency controls][1]
|
7604
7745
|
# in the *AWS Systems Manager User Guide*.
|
7605
7746
|
#
|
7606
7747
|
#
|
7607
7748
|
#
|
7608
|
-
# [1]:
|
7749
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity
|
7609
7750
|
#
|
7610
7751
|
# @option params [String] :max_errors
|
7611
7752
|
# The maximum number of errors allowed without the command failing. When
|
@@ -7613,11 +7754,11 @@ module Aws::SSM
|
|
7613
7754
|
# systems stops sending the command to additional targets. You can
|
7614
7755
|
# specify a number like 10 or a percentage like 10%. The default value
|
7615
7756
|
# is 0. For more information about how to use MaxErrors, see [Using
|
7616
|
-
#
|
7757
|
+
# error controls][1] in the *AWS Systems Manager User Guide*.
|
7617
7758
|
#
|
7618
7759
|
#
|
7619
7760
|
#
|
7620
|
-
# [1]:
|
7761
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
|
7621
7762
|
#
|
7622
7763
|
# @option params [String] :service_role_arn
|
7623
7764
|
# The ARN of the IAM service role to use to publish Amazon Simple
|
@@ -7706,6 +7847,7 @@ module Aws::SSM
|
|
7706
7847
|
# resp.command.notification_config.notification_type #=> String, one of "Command", "Invocation"
|
7707
7848
|
# resp.command.cloud_watch_output_config.cloud_watch_log_group_name #=> String
|
7708
7849
|
# resp.command.cloud_watch_output_config.cloud_watch_output_enabled #=> Boolean
|
7850
|
+
# resp.command.timeout_seconds #=> Integer
|
7709
7851
|
#
|
7710
7852
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendCommand AWS API Documentation
|
7711
7853
|
#
|
@@ -7799,12 +7941,12 @@ module Aws::SSM
|
|
7799
7941
|
# A location is a combination of AWS Regions and/or AWS accounts where
|
7800
7942
|
# you want to run the Automation. Use this action to start an Automation
|
7801
7943
|
# in multiple Regions and multiple accounts. For more information, see
|
7802
|
-
# [
|
7803
|
-
# *AWS Systems Manager User Guide*.
|
7944
|
+
# [Running Automation workflows in multiple AWS Regions and accounts][1]
|
7945
|
+
# in the *AWS Systems Manager User Guide*.
|
7804
7946
|
#
|
7805
7947
|
#
|
7806
7948
|
#
|
7807
|
-
# [1]:
|
7949
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html
|
7808
7950
|
#
|
7809
7951
|
# @option params [Array<Types::Tag>] :tags
|
7810
7952
|
# Optional metadata that you assign to a resource. You can specify a
|
@@ -7887,8 +8029,8 @@ module Aws::SSM
|
|
7887
8029
|
#
|
7888
8030
|
# <note markdown="1"> AWS CLI usage: `start-session` is an interactive command that requires
|
7889
8031
|
# the Session Manager plugin to be installed on the client machine
|
7890
|
-
# making the call. For information, see [
|
7891
|
-
#
|
8032
|
+
# making the call. For information, see [Install the Session Manager
|
8033
|
+
# plugin for the AWS CLI][1] in the *AWS Systems Manager User Guide*.
|
7892
8034
|
#
|
7893
8035
|
# AWS Tools for PowerShell usage: Start-SSMSession is not currently
|
7894
8036
|
# supported by AWS Tools for PowerShell on Windows local machines.
|
@@ -7897,7 +8039,7 @@ module Aws::SSM
|
|
7897
8039
|
#
|
7898
8040
|
#
|
7899
8041
|
#
|
7900
|
-
# [1]:
|
8042
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
|
7901
8043
|
#
|
7902
8044
|
# @option params [required, String] :target
|
7903
8045
|
# The instance to connect to for the session.
|
@@ -8030,8 +8172,7 @@ module Aws::SSM
|
|
8030
8172
|
# update.
|
8031
8173
|
#
|
8032
8174
|
# @option params [Types::InstanceAssociationOutputLocation] :output_location
|
8033
|
-
# An
|
8034
|
-
# request.
|
8175
|
+
# An S3 bucket where you want to store the results of this request.
|
8035
8176
|
#
|
8036
8177
|
# @option params [String] :name
|
8037
8178
|
# The name of the SSM document that contains the configuration
|
@@ -8104,6 +8245,21 @@ module Aws::SSM
|
|
8104
8245
|
# @option params [String] :compliance_severity
|
8105
8246
|
# The severity level to assign to the association.
|
8106
8247
|
#
|
8248
|
+
# @option params [String] :sync_compliance
|
8249
|
+
# The mode for generating association compliance. You can specify `AUTO`
|
8250
|
+
# or `MANUAL`. In `AUTO` mode, the system uses the status of the
|
8251
|
+
# association execution to determine the compliance status. If the
|
8252
|
+
# association execution runs successfully, then the association is
|
8253
|
+
# `COMPLIANT`. If the association execution doesn't run successfully,
|
8254
|
+
# the association is `NON-COMPLIANT`.
|
8255
|
+
#
|
8256
|
+
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
8257
|
+
# for the PutComplianceItems API action. In this case, compliance data
|
8258
|
+
# is not managed by State Manager. It is managed by your direct call to
|
8259
|
+
# the PutComplianceItems API action.
|
8260
|
+
#
|
8261
|
+
# By default, all associations use `AUTO` mode.
|
8262
|
+
#
|
8107
8263
|
# @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8108
8264
|
#
|
8109
8265
|
# * {Types::UpdateAssociationResult#association_description #association_description} => Types::AssociationDescription
|
@@ -8137,6 +8293,7 @@ module Aws::SSM
|
|
8137
8293
|
# max_errors: "MaxErrors",
|
8138
8294
|
# max_concurrency: "MaxConcurrency",
|
8139
8295
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
8296
|
+
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
8140
8297
|
# })
|
8141
8298
|
#
|
8142
8299
|
# @example Response structure
|
@@ -8174,6 +8331,7 @@ module Aws::SSM
|
|
8174
8331
|
# resp.association_description.max_errors #=> String
|
8175
8332
|
# resp.association_description.max_concurrency #=> String
|
8176
8333
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
8334
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
8177
8335
|
#
|
8178
8336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociation AWS API Documentation
|
8179
8337
|
#
|
@@ -8248,6 +8406,7 @@ module Aws::SSM
|
|
8248
8406
|
# resp.association_description.max_errors #=> String
|
8249
8407
|
# resp.association_description.max_concurrency #=> String
|
8250
8408
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
8409
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
8251
8410
|
#
|
8252
8411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationStatus AWS API Documentation
|
8253
8412
|
#
|
@@ -8277,7 +8436,10 @@ module Aws::SSM
|
|
8277
8436
|
# changed.
|
8278
8437
|
#
|
8279
8438
|
# @option params [String] :document_version
|
8280
|
-
# (Required) The version of the document that you want to update.
|
8439
|
+
# (Required) The latest version of the document that you want to update.
|
8440
|
+
# The latest document version can be specified using the $LATEST
|
8441
|
+
# variable or by the version number. Updating a previous version of a
|
8442
|
+
# document is not supported.
|
8281
8443
|
#
|
8282
8444
|
# @option params [String] :document_format
|
8283
8445
|
# Specify the document format for the new document version. Systems
|
@@ -8651,15 +8813,15 @@ module Aws::SSM
|
|
8651
8813
|
# For more information, see the following topics in the in the *AWS
|
8652
8814
|
# Systems Manager User Guide*\:
|
8653
8815
|
#
|
8654
|
-
# * [
|
8816
|
+
# * [Using service-linked roles for Systems Manager][1]
|
8655
8817
|
#
|
8656
|
-
# * [Should I
|
8657
|
-
#
|
8818
|
+
# * [Should I use a service-linked role or a custom service role to run
|
8819
|
+
# maintenance window tasks? ][2]
|
8658
8820
|
#
|
8659
8821
|
#
|
8660
8822
|
#
|
8661
|
-
# [1]:
|
8662
|
-
# [2]:
|
8823
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions
|
8824
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role
|
8663
8825
|
#
|
8664
8826
|
# @option params [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>] :task_parameters
|
8665
8827
|
# The parameters to modify.
|
@@ -8864,8 +9026,10 @@ module Aws::SSM
|
|
8864
9026
|
req.send_request(options)
|
8865
9027
|
end
|
8866
9028
|
|
8867
|
-
#
|
8868
|
-
#
|
9029
|
+
# Changes the Amazon Identity and Access Management (IAM) role that is
|
9030
|
+
# assigned to the on-premises instance or virtual machines (VM). IAM
|
9031
|
+
# roles are first assigned to these hybrid instances during the
|
9032
|
+
# activation process. For more information, see CreateActivation.
|
8869
9033
|
#
|
8870
9034
|
# @option params [required, String] :instance_id
|
8871
9035
|
# The ID of the managed instance where you want to update the role.
|
@@ -8893,7 +9057,7 @@ module Aws::SSM
|
|
8893
9057
|
|
8894
9058
|
# Edit or change an OpsItem. You must have permission in AWS Identity
|
8895
9059
|
# and Access Management (IAM) to update an OpsItem. For more
|
8896
|
-
# information, see [Getting
|
9060
|
+
# information, see [Getting started with OpsCenter][1] in the *AWS
|
8897
9061
|
# Systems Manager User Guide*.
|
8898
9062
|
#
|
8899
9063
|
# Operations engineers and IT professionals use OpsCenter to view,
|
@@ -8904,8 +9068,8 @@ module Aws::SSM
|
|
8904
9068
|
#
|
8905
9069
|
#
|
8906
9070
|
#
|
8907
|
-
# [1]:
|
8908
|
-
# [2]:
|
9071
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
9072
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
8909
9073
|
#
|
8910
9074
|
# @option params [String] :description
|
8911
9075
|
# Update the information about the OpsItem. Provide enough information
|
@@ -8937,11 +9101,11 @@ module Aws::SSM
|
|
8937
9101
|
# resource in the request. Use the `/aws/automations` key in
|
8938
9102
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
8939
9103
|
# To view AWS CLI example commands that use these keys, see [Creating
|
8940
|
-
# OpsItems
|
9104
|
+
# OpsItems manually][1] in the *AWS Systems Manager User Guide*.
|
8941
9105
|
#
|
8942
9106
|
#
|
8943
9107
|
#
|
8944
|
-
# [1]:
|
9108
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems
|
8945
9109
|
#
|
8946
9110
|
# @option params [Array<String>] :operational_data_to_delete
|
8947
9111
|
# Keys that you want to remove from the OperationalData map.
|
@@ -8962,12 +9126,12 @@ module Aws::SSM
|
|
8962
9126
|
#
|
8963
9127
|
# @option params [String] :status
|
8964
9128
|
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
8965
|
-
# `Resolved`. For more information, see [Editing OpsItem
|
9129
|
+
# `Resolved`. For more information, see [Editing OpsItem details][1] in
|
8966
9130
|
# the *AWS Systems Manager User Guide*.
|
8967
9131
|
#
|
8968
9132
|
#
|
8969
9133
|
#
|
8970
|
-
# [1]:
|
9134
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details
|
8971
9135
|
#
|
8972
9136
|
# @option params [required, String] :ops_item_id
|
8973
9137
|
# The ID of the OpsItem.
|
@@ -9050,8 +9214,8 @@ module Aws::SSM
|
|
9050
9214
|
# A list of explicitly approved patches for the baseline.
|
9051
9215
|
#
|
9052
9216
|
# For information about accepted formats for lists of approved patches
|
9053
|
-
# and rejected patches, see [
|
9054
|
-
#
|
9217
|
+
# and rejected patches, see [About package name formats for approved and
|
9218
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
9055
9219
|
#
|
9056
9220
|
#
|
9057
9221
|
#
|
@@ -9069,8 +9233,8 @@ module Aws::SSM
|
|
9069
9233
|
# A list of explicitly rejected patches for the baseline.
|
9070
9234
|
#
|
9071
9235
|
# For information about accepted formats for lists of approved patches
|
9072
|
-
# and rejected patches, see [
|
9073
|
-
#
|
9236
|
+
# and rejected patches, see [About package name formats for approved and
|
9237
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
9074
9238
|
#
|
9075
9239
|
#
|
9076
9240
|
#
|
@@ -9173,7 +9337,7 @@ module Aws::SSM
|
|
9173
9337
|
#
|
9174
9338
|
# resp.baseline_id #=> String
|
9175
9339
|
# resp.name #=> String
|
9176
|
-
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS"
|
9340
|
+
# resp.operating_system #=> String, one of "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN"
|
9177
9341
|
# resp.global_filters.patch_filters #=> Array
|
9178
9342
|
# resp.global_filters.patch_filters[0].key #=> String, one of "PATCH_SET", "PRODUCT", "PRODUCT_FAMILY", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID", "SECTION", "PRIORITY", "SEVERITY"
|
9179
9343
|
# resp.global_filters.patch_filters[0].values #=> Array
|
@@ -9220,14 +9384,17 @@ module Aws::SSM
|
|
9220
9384
|
# Organizations configuration option. Instead, you must delete the first
|
9221
9385
|
# resource data sync, and create a new one.
|
9222
9386
|
#
|
9387
|
+
# <note markdown="1"> This API action only supports a resource data sync that was created
|
9388
|
+
# with a SyncFromSource `SyncType`.
|
9389
|
+
#
|
9390
|
+
# </note>
|
9391
|
+
#
|
9223
9392
|
# @option params [required, String] :sync_name
|
9224
9393
|
# The name of the resource data sync you want to update.
|
9225
9394
|
#
|
9226
9395
|
# @option params [required, String] :sync_type
|
9227
|
-
# The type of resource data sync.
|
9228
|
-
#
|
9229
|
-
# If the `SyncType` is `SyncFromSource` then the resource data sync
|
9230
|
-
# synchronizes data from AWS Organizations or from multiple AWS Regions.
|
9396
|
+
# The type of resource data sync. The supported `SyncType` is
|
9397
|
+
# SyncFromSource.
|
9231
9398
|
#
|
9232
9399
|
# @option params [required, Types::ResourceDataSyncSource] :sync_source
|
9233
9400
|
# Specify information about the data sources to synchronize.
|
@@ -9282,10 +9449,31 @@ module Aws::SSM
|
|
9282
9449
|
# Update the service setting for the account.
|
9283
9450
|
#
|
9284
9451
|
# @option params [required, String] :setting_id
|
9285
|
-
# The
|
9452
|
+
# The Amazon Resource Name (ARN) of the service setting to reset. For
|
9453
|
+
# example,
|
9454
|
+
# `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`.
|
9455
|
+
# The setting ID can be one of the following.
|
9456
|
+
#
|
9457
|
+
# * `/ssm/parameter-store/default-parameter-tier`
|
9458
|
+
#
|
9459
|
+
# * `/ssm/parameter-store/high-throughput-enabled`
|
9460
|
+
#
|
9461
|
+
# * `/ssm/managed-instance/activation-tier`
|
9286
9462
|
#
|
9287
9463
|
# @option params [required, String] :setting_value
|
9288
|
-
# The new value to specify for the service setting.
|
9464
|
+
# The new value to specify for the service setting. For the
|
9465
|
+
# `/ssm/parameter-store/default-parameter-tier` setting ID, the setting
|
9466
|
+
# value can be one of the following.
|
9467
|
+
#
|
9468
|
+
# * Standard
|
9469
|
+
#
|
9470
|
+
# * Advanced
|
9471
|
+
#
|
9472
|
+
# * Intelligent-Tiering
|
9473
|
+
#
|
9474
|
+
# For the `/ssm/parameter-store/high-throughput-enabled`, and
|
9475
|
+
# `/ssm/managed-instance/activation-tier` setting IDs, the setting value
|
9476
|
+
# can be true or false.
|
9289
9477
|
#
|
9290
9478
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
9291
9479
|
#
|
@@ -9318,7 +9506,7 @@ module Aws::SSM
|
|
9318
9506
|
params: params,
|
9319
9507
|
config: config)
|
9320
9508
|
context[:gem_name] = 'aws-sdk-ssm'
|
9321
|
-
context[:gem_version] = '1.
|
9509
|
+
context[:gem_version] = '1.78.0'
|
9322
9510
|
Seahorse::Client::Request.new(handlers, context)
|
9323
9511
|
end
|
9324
9512
|
|