aws-sdk-ssm 1.73.0 → 1.74.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +317 -154
- data/lib/aws-sdk-ssm/client_api.rb +8 -0
- data/lib/aws-sdk-ssm/resource.rb +1 -7
- data/lib/aws-sdk-ssm/types.rb +467 -273
- 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: d57d1d2b6a56a64118b09cf6ed588ff876a23aa0d594733ba14c4f7f2ca53f61
|
4
|
+
data.tar.gz: 81c7d01d799870a500cd66213cc9ca3530cde248c47021750f025ede7537fa58
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4c57cc13a65a2883ea042e43bd2967607d807792c973cad3625d8c6c8659756d68701b30d6cd077a3c5142081ea292600923a1523f136f921c6f35e755344ea8
|
7
|
+
data.tar.gz: b0fc7842a048cc3ad76d73c28047f35abf6528dbd734e9d47ac46c2901d9f4b59641d0b54a35c19e08d56d678b4127b6558f4d53d73a20bf0fc0c1e952d79969
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -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.
|
@@ -634,16 +632,22 @@ module Aws::SSM
|
|
634
632
|
# The parameters for the runtime configuration of the document.
|
635
633
|
#
|
636
634
|
# @option params [Array<Types::Target>] :targets
|
637
|
-
# The targets
|
638
|
-
#
|
639
|
-
#
|
635
|
+
# The targets for the association. You can target instances by using
|
636
|
+
# tags, AWS Resource Groups, all instances in an AWS account, or
|
637
|
+
# individual instance IDs. For more information about choosing targets
|
638
|
+
# for an association, see [Using targets and rate controls with State
|
639
|
+
# Manager associations][1] in the *AWS Systems Manager User Guide*.
|
640
|
+
#
|
641
|
+
#
|
642
|
+
#
|
643
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html
|
640
644
|
#
|
641
645
|
# @option params [String] :schedule_expression
|
642
646
|
# A cron expression when the association will be applied to the
|
643
647
|
# target(s).
|
644
648
|
#
|
645
649
|
# @option params [Types::InstanceAssociationOutputLocation] :output_location
|
646
|
-
# An
|
650
|
+
# An S3 bucket where you want to store the output details of the
|
647
651
|
# request.
|
648
652
|
#
|
649
653
|
# @option params [String] :association_name
|
@@ -686,6 +690,21 @@ module Aws::SSM
|
|
686
690
|
# @option params [String] :compliance_severity
|
687
691
|
# The severity level to assign to the association.
|
688
692
|
#
|
693
|
+
# @option params [String] :sync_compliance
|
694
|
+
# The mode for generating association compliance. You can specify `AUTO`
|
695
|
+
# or `MANUAL`. In `AUTO` mode, the system uses the status of the
|
696
|
+
# association execution to determine the compliance status. If the
|
697
|
+
# association execution runs successfully, then the association is
|
698
|
+
# `COMPLIANT`. If the association execution doesn't run successfully,
|
699
|
+
# the association is `NON-COMPLIANT`.
|
700
|
+
#
|
701
|
+
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
702
|
+
# for the PutComplianceItems API action. In this case, compliance data
|
703
|
+
# is not managed by State Manager. It is managed by your direct call to
|
704
|
+
# the PutComplianceItems API action.
|
705
|
+
#
|
706
|
+
# By default, all associations use `AUTO` mode.
|
707
|
+
#
|
689
708
|
# @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
690
709
|
#
|
691
710
|
# * {Types::CreateAssociationResult#association_description #association_description} => Types::AssociationDescription
|
@@ -718,6 +737,7 @@ module Aws::SSM
|
|
718
737
|
# max_errors: "MaxErrors",
|
719
738
|
# max_concurrency: "MaxConcurrency",
|
720
739
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
740
|
+
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
721
741
|
# })
|
722
742
|
#
|
723
743
|
# @example Response structure
|
@@ -755,6 +775,7 @@ module Aws::SSM
|
|
755
775
|
# resp.association_description.max_errors #=> String
|
756
776
|
# resp.association_description.max_concurrency #=> String
|
757
777
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
778
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
758
779
|
#
|
759
780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociation AWS API Documentation
|
760
781
|
#
|
@@ -814,6 +835,7 @@ module Aws::SSM
|
|
814
835
|
# max_errors: "MaxErrors",
|
815
836
|
# max_concurrency: "MaxConcurrency",
|
816
837
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
838
|
+
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
817
839
|
# },
|
818
840
|
# ],
|
819
841
|
# })
|
@@ -854,6 +876,7 @@ module Aws::SSM
|
|
854
876
|
# resp.successful[0].max_errors #=> String
|
855
877
|
# resp.successful[0].max_concurrency #=> String
|
856
878
|
# resp.successful[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
879
|
+
# resp.successful[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
857
880
|
# resp.failed #=> Array
|
858
881
|
# resp.failed[0].entry.name #=> String
|
859
882
|
# resp.failed[0].entry.instance_id #=> String
|
@@ -874,6 +897,7 @@ module Aws::SSM
|
|
874
897
|
# resp.failed[0].entry.max_errors #=> String
|
875
898
|
# resp.failed[0].entry.max_concurrency #=> String
|
876
899
|
# resp.failed[0].entry.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
900
|
+
# resp.failed[0].entry.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
877
901
|
# resp.failed[0].message #=> String
|
878
902
|
# resp.failed[0].fault #=> String, one of "Client", "Server", "Unknown"
|
879
903
|
#
|
@@ -886,18 +910,49 @@ module Aws::SSM
|
|
886
910
|
req.send_request(options)
|
887
911
|
end
|
888
912
|
|
889
|
-
# Creates a Systems Manager document.
|
913
|
+
# Creates a Systems Manager (SSM) document. An SSM document defines the
|
914
|
+
# actions that Systems Manager performs on your managed instances. For
|
915
|
+
# more information about SSM documents, including information about
|
916
|
+
# supported schemas, features, and syntax, see [AWS Systems Manager
|
917
|
+
# Documents][1] in the *AWS Systems Manager User Guide*.
|
918
|
+
#
|
890
919
|
#
|
891
|
-
#
|
892
|
-
#
|
920
|
+
#
|
921
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html
|
893
922
|
#
|
894
923
|
# @option params [required, String] :content
|
895
|
-
#
|
924
|
+
# The content for the new SSM document in JSON or YAML format. We
|
925
|
+
# recommend storing the contents for your new document in an external
|
926
|
+
# JSON or YAML file and referencing the file in a command.
|
927
|
+
#
|
928
|
+
# For examples, see the following topics in the *AWS Systems Manager
|
929
|
+
# User Guide*.
|
930
|
+
#
|
931
|
+
# * [Create an SSM document (console)][1]
|
932
|
+
#
|
933
|
+
# * [Create an SSM document (AWS CLI)][2]
|
934
|
+
#
|
935
|
+
# * [Create an SSM document (API)][3]
|
936
|
+
#
|
937
|
+
#
|
938
|
+
#
|
939
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-console.html
|
940
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html
|
941
|
+
# [3]: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html
|
896
942
|
#
|
897
943
|
# @option params [Array<Types::DocumentRequires>] :requires
|
898
|
-
# A list of SSM documents required by a document.
|
944
|
+
# A list of SSM documents required by a document. This parameter is used
|
945
|
+
# exclusively by AWS AppConfig. When a user creates an AppConfig
|
946
|
+
# configuration in an SSM document, the user must also specify a
|
947
|
+
# required document for validation purposes. In this case, an
|
899
948
|
# `ApplicationConfiguration` document requires an
|
900
|
-
# `ApplicationConfigurationSchema` document.
|
949
|
+
# `ApplicationConfigurationSchema` document for validation purposes. For
|
950
|
+
# more information, see [AWS AppConfig][1] in the *AWS Systems Manager
|
951
|
+
# User Guide*.
|
952
|
+
#
|
953
|
+
#
|
954
|
+
#
|
955
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html
|
901
956
|
#
|
902
957
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
903
958
|
# A list of key and value pairs that describe attachments to a version
|
@@ -906,8 +961,8 @@ module Aws::SSM
|
|
906
961
|
# @option params [required, String] :name
|
907
962
|
# A name for the Systems Manager document.
|
908
963
|
#
|
909
|
-
#
|
910
|
-
#
|
964
|
+
# You can't use the following strings as document name prefixes. These
|
965
|
+
# are reserved by AWS for use as document name prefixes:
|
911
966
|
#
|
912
967
|
# * `aws`
|
913
968
|
#
|
@@ -934,8 +989,8 @@ module Aws::SSM
|
|
934
989
|
# the following value: /AWS::EC2::Instance. If you specify a value of
|
935
990
|
# '/' the document can run on all types of resources. If you don't
|
936
991
|
# 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*.
|
992
|
+
# of valid resource types, see [AWS resource and property types
|
993
|
+
# reference][1] in the *AWS CloudFormation User Guide*.
|
939
994
|
#
|
940
995
|
#
|
941
996
|
#
|
@@ -1162,7 +1217,7 @@ module Aws::SSM
|
|
1162
1217
|
|
1163
1218
|
# Creates a new OpsItem. You must have permission in AWS Identity and
|
1164
1219
|
# Access Management (IAM) to create a new OpsItem. For more information,
|
1165
|
-
# see [Getting
|
1220
|
+
# see [Getting started with OpsCenter][1] in the *AWS Systems Manager
|
1166
1221
|
# User Guide*.
|
1167
1222
|
#
|
1168
1223
|
# Operations engineers and IT professionals use OpsCenter to view,
|
@@ -1173,8 +1228,8 @@ module Aws::SSM
|
|
1173
1228
|
#
|
1174
1229
|
#
|
1175
1230
|
#
|
1176
|
-
# [1]:
|
1177
|
-
# [2]:
|
1231
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
1232
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
1178
1233
|
#
|
1179
1234
|
# @option params [required, String] :description
|
1180
1235
|
# Information about the OpsItem.
|
@@ -1201,11 +1256,11 @@ module Aws::SSM
|
|
1201
1256
|
# resource in the request. Use the `/aws/automations` key in
|
1202
1257
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
1203
1258
|
# To view AWS CLI example commands that use these keys, see [Creating
|
1204
|
-
# OpsItems
|
1259
|
+
# OpsItems manually][1] in the *AWS Systems Manager User Guide*.
|
1205
1260
|
#
|
1206
1261
|
#
|
1207
1262
|
#
|
1208
|
-
# [1]:
|
1263
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems
|
1209
1264
|
#
|
1210
1265
|
# @option params [Array<Types::OpsItemNotification>] :notifications
|
1211
1266
|
# The Amazon Resource Name (ARN) of an SNS topic where notifications are
|
@@ -1222,7 +1277,12 @@ module Aws::SSM
|
|
1222
1277
|
# impacted resource.
|
1223
1278
|
#
|
1224
1279
|
# @option params [required, String] :source
|
1225
|
-
# The origin of the OpsItem, such as Amazon EC2 or
|
1280
|
+
# The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
|
1281
|
+
#
|
1282
|
+
# <note markdown="1"> The source name can't contain the following strings: aws, amazon, and
|
1283
|
+
# amzn.
|
1284
|
+
#
|
1285
|
+
# </note>
|
1226
1286
|
#
|
1227
1287
|
# @option params [required, String] :title
|
1228
1288
|
# A short heading that describes the nature of the OpsItem and the
|
@@ -1231,7 +1291,7 @@ module Aws::SSM
|
|
1231
1291
|
# @option params [Array<Types::Tag>] :tags
|
1232
1292
|
# Optional metadata that you assign to a resource. You can restrict
|
1233
1293
|
# access to OpsItems by using an inline IAM policy that specifies tags.
|
1234
|
-
# For more information, see [Getting
|
1294
|
+
# For more information, see [Getting started with OpsCenter][1] in the
|
1235
1295
|
# *AWS Systems Manager User Guide*.
|
1236
1296
|
#
|
1237
1297
|
# Tags use a key-value pair. For example:
|
@@ -1244,7 +1304,7 @@ module Aws::SSM
|
|
1244
1304
|
#
|
1245
1305
|
#
|
1246
1306
|
#
|
1247
|
-
# [1]:
|
1307
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions
|
1248
1308
|
#
|
1249
1309
|
# @option params [String] :category
|
1250
1310
|
# Specify a category to assign to an OpsItem.
|
@@ -1330,8 +1390,8 @@ module Aws::SSM
|
|
1330
1390
|
# A list of explicitly approved patches for the baseline.
|
1331
1391
|
#
|
1332
1392
|
# For information about accepted formats for lists of approved patches
|
1333
|
-
# and rejected patches, see [
|
1334
|
-
#
|
1393
|
+
# and rejected patches, see [About package name formats for approved and
|
1394
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
1335
1395
|
#
|
1336
1396
|
#
|
1337
1397
|
#
|
@@ -1351,8 +1411,8 @@ module Aws::SSM
|
|
1351
1411
|
# A list of explicitly rejected patches for the baseline.
|
1352
1412
|
#
|
1353
1413
|
# For information about accepted formats for lists of approved patches
|
1354
|
-
# and rejected patches, see [
|
1355
|
-
#
|
1414
|
+
# and rejected patches, see [About package name formats for approved and
|
1415
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
1356
1416
|
#
|
1357
1417
|
#
|
1358
1418
|
#
|
@@ -1481,18 +1541,18 @@ module Aws::SSM
|
|
1481
1541
|
#
|
1482
1542
|
# You can configure Systems Manager Inventory to use the
|
1483
1543
|
# `SyncToDestination` type to synchronize Inventory data from multiple
|
1484
|
-
# AWS Regions to a single
|
1544
|
+
# AWS Regions to a single S3 bucket. For more information, see
|
1485
1545
|
# [Configuring Resource Data Sync for Inventory][1] in the *AWS Systems
|
1486
1546
|
# Manager User Guide*.
|
1487
1547
|
#
|
1488
1548
|
# You can configure Systems Manager Explorer to use the `SyncFromSource`
|
1489
1549
|
# type to synchronize operational work items (OpsItems) and operational
|
1490
|
-
# data (OpsData) from multiple AWS Regions to a single
|
1491
|
-
#
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
#
|
1550
|
+
# data (OpsData) from multiple AWS Regions to a single S3 bucket. This
|
1551
|
+
# type can synchronize OpsItems and OpsData from multiple AWS accounts
|
1552
|
+
# and Regions or `EntireOrganization` by using AWS Organizations. For
|
1553
|
+
# more information, see [Setting up Systems Manager Explorer to display
|
1554
|
+
# data from multiple accounts and Regions][2] in the *AWS Systems
|
1555
|
+
# Manager User Guide*.
|
1496
1556
|
#
|
1497
1557
|
# A resource data sync is an asynchronous operation that returns
|
1498
1558
|
# immediately. After a successful initial sync is completed, the system
|
@@ -1508,23 +1568,29 @@ module Aws::SSM
|
|
1508
1568
|
#
|
1509
1569
|
#
|
1510
1570
|
#
|
1511
|
-
# [1]:
|
1512
|
-
# [2]:
|
1571
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html
|
1572
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html
|
1513
1573
|
#
|
1514
1574
|
# @option params [required, String] :sync_name
|
1515
1575
|
# A name for the configuration.
|
1516
1576
|
#
|
1517
1577
|
# @option params [Types::ResourceDataSyncS3Destination] :s3_destination
|
1518
|
-
# Amazon S3 configuration details for the sync.
|
1578
|
+
# Amazon S3 configuration details for the sync. This parameter is
|
1579
|
+
# required if the `SyncType` value is SyncToDestination.
|
1519
1580
|
#
|
1520
1581
|
# @option params [String] :sync_type
|
1521
1582
|
# Specify `SyncToDestination` to create a resource data sync that
|
1522
|
-
# synchronizes data
|
1523
|
-
#
|
1524
|
-
#
|
1583
|
+
# synchronizes data to an S3 bucket for Inventory. If you specify
|
1584
|
+
# `SyncToDestination`, you must provide a value for `S3Destination`.
|
1585
|
+
# Specify `SyncFromSource` to synchronize data from a single account and
|
1586
|
+
# multiple Regions, or multiple AWS accounts and Regions, as listed in
|
1587
|
+
# AWS Organizations for Explorer. If you specify `SyncFromSource`, you
|
1588
|
+
# must provide a value for `SyncSource`. The default value is
|
1589
|
+
# `SyncToDestination`.
|
1525
1590
|
#
|
1526
1591
|
# @option params [Types::ResourceDataSyncSource] :sync_source
|
1527
|
-
# Specify information about the data sources to synchronize.
|
1592
|
+
# Specify information about the data sources to synchronize. This
|
1593
|
+
# parameter is required if the `SyncType` value is SyncFromSource.
|
1528
1594
|
#
|
1529
1595
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1530
1596
|
#
|
@@ -2041,6 +2107,8 @@ module Aws::SSM
|
|
2041
2107
|
# * {Types::DescribeActivationsResult#activation_list #activation_list} => Array<Types::Activation>
|
2042
2108
|
# * {Types::DescribeActivationsResult#next_token #next_token} => String
|
2043
2109
|
#
|
2110
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2111
|
+
#
|
2044
2112
|
# @example Request syntax with placeholder values
|
2045
2113
|
#
|
2046
2114
|
# resp = client.describe_activations({
|
@@ -2151,6 +2219,7 @@ module Aws::SSM
|
|
2151
2219
|
# resp.association_description.max_errors #=> String
|
2152
2220
|
# resp.association_description.max_concurrency #=> String
|
2153
2221
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
2222
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
2154
2223
|
#
|
2155
2224
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociation AWS API Documentation
|
2156
2225
|
#
|
@@ -2803,34 +2872,37 @@ module Aws::SSM
|
|
2803
2872
|
req.send_request(options)
|
2804
2873
|
end
|
2805
2874
|
|
2806
|
-
# Describes one or more of your instances
|
2807
|
-
#
|
2808
|
-
#
|
2809
|
-
#
|
2810
|
-
#
|
2811
|
-
# instances. If you specify
|
2812
|
-
#
|
2875
|
+
# Describes one or more of your instances, including information about
|
2876
|
+
# the operating system platform, the version of SSM Agent installed on
|
2877
|
+
# the instance, instance status, and so on.
|
2878
|
+
#
|
2879
|
+
# If you specify one or more instance IDs, it returns information for
|
2880
|
+
# those instances. If you do not specify instance IDs, it returns
|
2881
|
+
# information for all your instances. If you specify an instance ID that
|
2882
|
+
# is not valid or an instance that you do not own, you receive an error.
|
2813
2883
|
#
|
2814
2884
|
# <note markdown="1"> The IamRole field for this API action is the Amazon Identity and
|
2815
2885
|
# Access Management (IAM) role assigned to on-premises instances. This
|
2816
|
-
# call does not return the IAM role for
|
2886
|
+
# call does not return the IAM role for EC2 instances.
|
2817
2887
|
#
|
2818
2888
|
# </note>
|
2819
2889
|
#
|
2820
2890
|
# @option params [Array<Types::InstanceInformationFilter>] :instance_information_filter_list
|
2821
2891
|
# This is a legacy method. We recommend that you don't use this method.
|
2822
|
-
# Instead, use the
|
2823
|
-
#
|
2824
|
-
#
|
2892
|
+
# Instead, use the `Filters` data type. `Filters` enables you to return
|
2893
|
+
# instance information by filtering based on tags applied to managed
|
2894
|
+
# instances.
|
2895
|
+
#
|
2896
|
+
# <note markdown="1"> Attempting to use `InstanceInformationFilterList` and `Filters` leads
|
2897
|
+
# to an exception error.
|
2825
2898
|
#
|
2826
|
-
#
|
2827
|
-
# `InstanceInformationFilter` action. Using this method and the
|
2828
|
-
# `InstanceInformationFilter` action causes an exception error.
|
2899
|
+
# </note>
|
2829
2900
|
#
|
2830
2901
|
# @option params [Array<Types::InstanceInformationStringFilter>] :filters
|
2831
2902
|
# One or more filters. Use a filter to return a more specific list of
|
2832
|
-
# instances. You can filter on
|
2833
|
-
#
|
2903
|
+
# instances. You can filter based on tags applied to EC2 instances. Use
|
2904
|
+
# this `Filters` data type instead of `InstanceInformationFilterList`,
|
2905
|
+
# which is deprecated.
|
2834
2906
|
#
|
2835
2907
|
# @option params [Integer] :max_results
|
2836
2908
|
# The maximum number of items to return for this call. The call also
|
@@ -2846,6 +2918,8 @@ module Aws::SSM
|
|
2846
2918
|
# * {Types::DescribeInstanceInformationResult#instance_information_list #instance_information_list} => Array<Types::InstanceInformation>
|
2847
2919
|
# * {Types::DescribeInstanceInformationResult#next_token #next_token} => String
|
2848
2920
|
#
|
2921
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2922
|
+
#
|
2849
2923
|
# @example Request syntax with placeholder values
|
2850
2924
|
#
|
2851
2925
|
# resp = client.describe_instance_information({
|
@@ -3665,7 +3739,7 @@ module Aws::SSM
|
|
3665
3739
|
|
3666
3740
|
# Query a set of OpsItems. You must have permission in AWS Identity and
|
3667
3741
|
# Access Management (IAM) to query a list of OpsItems. For more
|
3668
|
-
# information, see [Getting
|
3742
|
+
# information, see [Getting started with OpsCenter][1] in the *AWS
|
3669
3743
|
# Systems Manager User Guide*.
|
3670
3744
|
#
|
3671
3745
|
# Operations engineers and IT professionals use OpsCenter to view,
|
@@ -3676,11 +3750,11 @@ module Aws::SSM
|
|
3676
3750
|
#
|
3677
3751
|
#
|
3678
3752
|
#
|
3679
|
-
# [1]:
|
3680
|
-
# [2]:
|
3753
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
3754
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
3681
3755
|
#
|
3682
3756
|
# @option params [Array<Types::OpsItemFilter>] :ops_item_filters
|
3683
|
-
# One or more filters to limit the
|
3757
|
+
# One or more filters to limit the response.
|
3684
3758
|
#
|
3685
3759
|
# * Key: CreatedTime
|
3686
3760
|
#
|
@@ -3827,6 +3901,8 @@ module Aws::SSM
|
|
3827
3901
|
# * {Types::DescribeParametersResult#parameters #parameters} => Array<Types::ParameterMetadata>
|
3828
3902
|
# * {Types::DescribeParametersResult#next_token #next_token} => String
|
3829
3903
|
#
|
3904
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3905
|
+
#
|
3830
3906
|
# @example Request syntax with placeholder values
|
3831
3907
|
#
|
3832
3908
|
# resp = client.describe_parameters({
|
@@ -4359,8 +4435,8 @@ module Aws::SSM
|
|
4359
4435
|
#
|
4360
4436
|
# @option params [required, String] :instance_id
|
4361
4437
|
# (Required) The ID of the managed instance targeted by the command. A
|
4362
|
-
# managed instance can be an
|
4363
|
-
#
|
4438
|
+
# managed instance can be an EC2 instance or an instance in your hybrid
|
4439
|
+
# environment that is configured for Systems Manager.
|
4364
4440
|
#
|
4365
4441
|
# @option params [String] :plugin_name
|
4366
4442
|
# (Optional) The name of the plugin for which you want detailed results.
|
@@ -4426,7 +4502,7 @@ module Aws::SSM
|
|
4426
4502
|
end
|
4427
4503
|
|
4428
4504
|
# Retrieves the Session Manager connection status for an instance to
|
4429
|
-
# determine whether it is
|
4505
|
+
# determine whether it is running and ready to receive Session Manager
|
4430
4506
|
# connections.
|
4431
4507
|
#
|
4432
4508
|
# @option params [required, String] :target
|
@@ -4541,7 +4617,7 @@ module Aws::SSM
|
|
4541
4617
|
# @option params [String] :version_name
|
4542
4618
|
# An optional field specifying the version of the artifact associated
|
4543
4619
|
# with the document. For example, "Release 12, Update 6". This value
|
4544
|
-
# is unique across all versions of a document
|
4620
|
+
# is unique across all versions of a document and can't be changed.
|
4545
4621
|
#
|
4546
4622
|
# @option params [String] :document_version
|
4547
4623
|
# The document version for which you want information.
|
@@ -5060,7 +5136,7 @@ module Aws::SSM
|
|
5060
5136
|
# Get information about an OpsItem by using the ID. You must have
|
5061
5137
|
# permission in AWS Identity and Access Management (IAM) to view
|
5062
5138
|
# information about an OpsItem. For more information, see [Getting
|
5063
|
-
#
|
5139
|
+
# started with OpsCenter][1] in the *AWS Systems Manager User Guide*.
|
5064
5140
|
#
|
5065
5141
|
# Operations engineers and IT professionals use OpsCenter to view,
|
5066
5142
|
# investigate, and remediate operational issues impacting the
|
@@ -5070,8 +5146,8 @@ module Aws::SSM
|
|
5070
5146
|
#
|
5071
5147
|
#
|
5072
5148
|
#
|
5073
|
-
# [1]:
|
5074
|
-
# [2]:
|
5149
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
5150
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
5075
5151
|
#
|
5076
5152
|
# @option params [required, String] :ops_item_id
|
5077
5153
|
# The ID of the OpsItem that you want to get.
|
@@ -5271,6 +5347,8 @@ module Aws::SSM
|
|
5271
5347
|
# * {Types::GetParameterHistoryResult#parameters #parameters} => Array<Types::ParameterHistory>
|
5272
5348
|
# * {Types::GetParameterHistoryResult#next_token #next_token} => String
|
5273
5349
|
#
|
5350
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5351
|
+
#
|
5274
5352
|
# @example Request syntax with placeholder values
|
5275
5353
|
#
|
5276
5354
|
# resp = client.get_parameter_history({
|
@@ -5406,6 +5484,8 @@ module Aws::SSM
|
|
5406
5484
|
# * {Types::GetParametersByPathResult#parameters #parameters} => Array<Types::Parameter>
|
5407
5485
|
# * {Types::GetParametersByPathResult#next_token #next_token} => String
|
5408
5486
|
#
|
5487
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5488
|
+
#
|
5409
5489
|
# @example Request syntax with placeholder values
|
5410
5490
|
#
|
5411
5491
|
# resp = client.get_parameters_by_path({
|
@@ -5576,7 +5656,10 @@ module Aws::SSM
|
|
5576
5656
|
# Query the current service setting for the account.
|
5577
5657
|
#
|
5578
5658
|
# @option params [required, String] :setting_id
|
5579
|
-
# The ID of the service setting to get.
|
5659
|
+
# The ID of the service setting to get. The setting ID can be
|
5660
|
+
# `/ssm/parameter-store/default-parameter-tier`,
|
5661
|
+
# `/ssm/parameter-store/high-throughput-enabled`, or
|
5662
|
+
# `/ssm/managed-instance/activation-tier`.
|
5580
5663
|
#
|
5581
5664
|
# @return [Types::GetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5582
5665
|
#
|
@@ -5729,6 +5812,7 @@ module Aws::SSM
|
|
5729
5812
|
# resp.association_versions[0].max_errors #=> String
|
5730
5813
|
# resp.association_versions[0].max_concurrency #=> String
|
5731
5814
|
# resp.association_versions[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
5815
|
+
# resp.association_versions[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
5732
5816
|
# resp.next_token #=> String
|
5733
5817
|
#
|
5734
5818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociationVersions AWS API Documentation
|
@@ -5762,12 +5846,14 @@ module Aws::SSM
|
|
5762
5846
|
# * {Types::ListAssociationsResult#associations #associations} => Array<Types::Association>
|
5763
5847
|
# * {Types::ListAssociationsResult#next_token #next_token} => String
|
5764
5848
|
#
|
5849
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5850
|
+
#
|
5765
5851
|
# @example Request syntax with placeholder values
|
5766
5852
|
#
|
5767
5853
|
# resp = client.list_associations({
|
5768
5854
|
# association_filter_list: [
|
5769
5855
|
# {
|
5770
|
-
# key: "InstanceId", # required, accepts InstanceId, Name, AssociationId, AssociationStatusName, LastExecutedBefore, LastExecutedAfter, AssociationName
|
5856
|
+
# key: "InstanceId", # required, accepts InstanceId, Name, AssociationId, AssociationStatusName, LastExecutedBefore, LastExecutedAfter, AssociationName, ResourceGroupName
|
5771
5857
|
# value: "AssociationFilterValue", # required
|
5772
5858
|
# },
|
5773
5859
|
# ],
|
@@ -5841,6 +5927,8 @@ module Aws::SSM
|
|
5841
5927
|
# * {Types::ListCommandInvocationsResult#command_invocations #command_invocations} => Array<Types::CommandInvocation>
|
5842
5928
|
# * {Types::ListCommandInvocationsResult#next_token #next_token} => String
|
5843
5929
|
#
|
5930
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5931
|
+
#
|
5844
5932
|
# @example Request syntax with placeholder values
|
5845
5933
|
#
|
5846
5934
|
# resp = client.list_command_invocations({
|
@@ -5929,6 +6017,8 @@ module Aws::SSM
|
|
5929
6017
|
# * {Types::ListCommandsResult#commands #commands} => Array<Types::Command>
|
5930
6018
|
# * {Types::ListCommandsResult#next_token #next_token} => String
|
5931
6019
|
#
|
6020
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6021
|
+
#
|
5932
6022
|
# @example Request syntax with placeholder values
|
5933
6023
|
#
|
5934
6024
|
# resp = client.list_commands({
|
@@ -6185,12 +6275,16 @@ module Aws::SSM
|
|
6185
6275
|
# filter.
|
6186
6276
|
#
|
6187
6277
|
# @option params [Array<Types::DocumentFilter>] :document_filter_list
|
6188
|
-
#
|
6189
|
-
# results.
|
6278
|
+
# This data type is deprecated. Instead, use `Filters`.
|
6190
6279
|
#
|
6191
6280
|
# @option params [Array<Types::DocumentKeyValuesFilter>] :filters
|
6192
|
-
# One or more
|
6193
|
-
# results.
|
6281
|
+
# One or more DocumentKeyValuesFilter objects. Use a filter to return a
|
6282
|
+
# more specific list of results. For keys, you can specify one or more
|
6283
|
+
# key-value pair tags that have been applied to a document. Other valid
|
6284
|
+
# keys include `Owner`, `Name`, `PlatformTypes`, and `DocumentType`. For
|
6285
|
+
# example, to return documents you own use `Key=Owner,Values=Self`. To
|
6286
|
+
# specify a custom key-value pair, use the format
|
6287
|
+
# `Key=tag:tagName,Values=valueName`.
|
6194
6288
|
#
|
6195
6289
|
# @option params [Integer] :max_results
|
6196
6290
|
# The maximum number of items to return for this call. The call also
|
@@ -6206,6 +6300,8 @@ module Aws::SSM
|
|
6206
6300
|
# * {Types::ListDocumentsResult#document_identifiers #document_identifiers} => Array<Types::DocumentIdentifier>
|
6207
6301
|
# * {Types::ListDocumentsResult#next_token #next_token} => String
|
6208
6302
|
#
|
6303
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6304
|
+
#
|
6209
6305
|
# @example Request syntax with placeholder values
|
6210
6306
|
#
|
6211
6307
|
# resp = client.list_documents({
|
@@ -6620,13 +6716,28 @@ module Aws::SSM
|
|
6620
6716
|
# @option params [required, Array<Types::ComplianceItemEntry>] :items
|
6621
6717
|
# Information about the compliance as defined by the resource type. For
|
6622
6718
|
# example, for a patch compliance type, `Items` includes information
|
6623
|
-
# about the PatchSeverity, Classification,
|
6719
|
+
# about the PatchSeverity, Classification, and so on.
|
6624
6720
|
#
|
6625
6721
|
# @option params [String] :item_content_hash
|
6626
6722
|
# MD5 or SHA-256 content hash. The content hash is used to determine if
|
6627
6723
|
# existing information should be overwritten or ignored. If the content
|
6628
6724
|
# hashes match, the request to put compliance information is ignored.
|
6629
6725
|
#
|
6726
|
+
# @option params [String] :upload_type
|
6727
|
+
# The mode for uploading compliance items. You can specify `COMPLETE` or
|
6728
|
+
# `PARTIAL`. In `COMPLETE` mode, the system overwrites all existing
|
6729
|
+
# compliance information for the resource. You must provide a full list
|
6730
|
+
# of compliance items each time you send the request.
|
6731
|
+
#
|
6732
|
+
# In `PARTIAL` mode, the system overwrites compliance information for a
|
6733
|
+
# specific association. The association must be configured with
|
6734
|
+
# `SyncCompliance` set to `MANUAL`. By default, all requests use
|
6735
|
+
# `COMPLETE` mode.
|
6736
|
+
#
|
6737
|
+
# <note markdown="1"> This attribute is only valid for association compliance.
|
6738
|
+
#
|
6739
|
+
# </note>
|
6740
|
+
#
|
6630
6741
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6631
6742
|
#
|
6632
6743
|
# @example Request syntax with placeholder values
|
@@ -6652,6 +6763,7 @@ module Aws::SSM
|
|
6652
6763
|
# },
|
6653
6764
|
# ],
|
6654
6765
|
# item_content_hash: "ComplianceItemContentHash",
|
6766
|
+
# upload_type: "COMPLETE", # accepts COMPLETE, PARTIAL
|
6655
6767
|
# })
|
6656
6768
|
#
|
6657
6769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutComplianceItems AWS API Documentation
|
@@ -6739,8 +6851,8 @@ module Aws::SSM
|
|
6739
6851
|
# levels.
|
6740
6852
|
#
|
6741
6853
|
# For additional information about valid values for parameter names, see
|
6742
|
-
# [
|
6743
|
-
# Systems Manager User Guide*.
|
6854
|
+
# [About requirements and constraints for parameter names][1] in the
|
6855
|
+
# *AWS Systems Manager User Guide*.
|
6744
6856
|
#
|
6745
6857
|
# <note markdown="1"> The maximum length constraint listed below includes capacity for
|
6746
6858
|
# additional system attributes that are not part of the name. The
|
@@ -6754,7 +6866,7 @@ module Aws::SSM
|
|
6754
6866
|
#
|
6755
6867
|
#
|
6756
6868
|
#
|
6757
|
-
# [1]:
|
6869
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html
|
6758
6870
|
#
|
6759
6871
|
# @option params [String] :description
|
6760
6872
|
# Information about the parameter that you want to add to the system.
|
@@ -6838,8 +6950,9 @@ module Aws::SSM
|
|
6838
6950
|
# Advanced parameters have a content size limit of 8 KB and can be
|
6839
6951
|
# configured to use parameter policies. You can create a maximum of
|
6840
6952
|
# 100,000 advanced parameters for each Region in an AWS account.
|
6841
|
-
# Advanced parameters incur a charge. For more information, see
|
6842
|
-
#
|
6953
|
+
# Advanced parameters incur a charge. For more information, see
|
6954
|
+
# [Standard and advanced parameter tiers][1] in the *AWS Systems Manager
|
6955
|
+
# User Guide*.
|
6843
6956
|
#
|
6844
6957
|
# You can change a standard parameter to an advanced parameter any time.
|
6845
6958
|
# But you can't revert an advanced parameter to a standard parameter.
|
@@ -6893,13 +7006,13 @@ module Aws::SSM
|
|
6893
7006
|
# current Region.
|
6894
7007
|
#
|
6895
7008
|
# For more information about configuring the default tier option, see
|
6896
|
-
# [Specifying a
|
7009
|
+
# [Specifying a default parameter tier][2] in the *AWS Systems Manager
|
6897
7010
|
# User Guide*.
|
6898
7011
|
#
|
6899
7012
|
#
|
6900
7013
|
#
|
6901
|
-
# [1]:
|
6902
|
-
# [2]:
|
7014
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html
|
7015
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html
|
6903
7016
|
#
|
6904
7017
|
# @option params [String] :policies
|
6905
7018
|
# One or more policies to apply to a parameter. This action takes a JSON
|
@@ -6923,11 +7036,11 @@ module Aws::SSM
|
|
6923
7036
|
#
|
6924
7037
|
# All existing policies are preserved until you send new policies or an
|
6925
7038
|
# empty policy. For more information about parameter policies, see
|
6926
|
-
# [
|
7039
|
+
# [Assigning parameter policies][1].
|
6927
7040
|
#
|
6928
7041
|
#
|
6929
7042
|
#
|
6930
|
-
# [1]:
|
7043
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html
|
6931
7044
|
#
|
6932
7045
|
# @return [Types::PutParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6933
7046
|
#
|
@@ -7083,8 +7196,8 @@ module Aws::SSM
|
|
7083
7196
|
# </note>
|
7084
7197
|
#
|
7085
7198
|
# For more information about these examples formats, including the best
|
7086
|
-
# use case for each one, see [Examples: Register
|
7087
|
-
#
|
7199
|
+
# use case for each one, see [Examples: Register targets with a
|
7200
|
+
# maintenance window][1] in the *AWS Systems Manager User Guide*.
|
7088
7201
|
#
|
7089
7202
|
#
|
7090
7203
|
#
|
@@ -7170,15 +7283,15 @@ module Aws::SSM
|
|
7170
7283
|
# For more information, see the following topics in the in the *AWS
|
7171
7284
|
# Systems Manager User Guide*\:
|
7172
7285
|
#
|
7173
|
-
# * [
|
7286
|
+
# * [Using service-linked roles for Systems Manager][1]
|
7174
7287
|
#
|
7175
|
-
# * [Should I
|
7176
|
-
#
|
7288
|
+
# * [Should I use a service-linked role or a custom service role to run
|
7289
|
+
# maintenance window tasks? ][2]
|
7177
7290
|
#
|
7178
7291
|
#
|
7179
7292
|
#
|
7180
|
-
# [1]:
|
7181
|
-
# [2]:
|
7293
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions
|
7294
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role
|
7182
7295
|
#
|
7183
7296
|
# @option params [required, String] :task_type
|
7184
7297
|
# The type of task being registered.
|
@@ -7213,7 +7326,7 @@ module Aws::SSM
|
|
7213
7326
|
# scheduled.
|
7214
7327
|
#
|
7215
7328
|
# @option params [Types::LoggingInfo] :logging_info
|
7216
|
-
# A structure containing information about an
|
7329
|
+
# A structure containing information about an S3 bucket to write
|
7217
7330
|
# instance-level logs to.
|
7218
7331
|
#
|
7219
7332
|
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an S3 bucket to contain
|
@@ -7394,7 +7507,11 @@ module Aws::SSM
|
|
7394
7507
|
# provisioned by the AWS service team.
|
7395
7508
|
#
|
7396
7509
|
# @option params [required, String] :setting_id
|
7397
|
-
# The
|
7510
|
+
# The Amazon Resource Name (ARN) of the service setting to reset. The
|
7511
|
+
# setting ID can be `/ssm/parameter-store/default-parameter-tier`,
|
7512
|
+
# `/ssm/parameter-store/high-throughput-enabled`, or
|
7513
|
+
# `/ssm/managed-instance/activation-tier`. For example,
|
7514
|
+
# `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`.
|
7398
7515
|
#
|
7399
7516
|
# @return [Types::ResetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7400
7517
|
#
|
@@ -7521,23 +7638,23 @@ module Aws::SSM
|
|
7521
7638
|
# maximum of 50 IDs. If you prefer not to list individual instance IDs,
|
7522
7639
|
# you can instead send commands to a fleet of instances using the
|
7523
7640
|
# Targets parameter, which accepts EC2 tags. For more information about
|
7524
|
-
# how to use targets, see [
|
7525
|
-
# Systems Manager User Guide*.
|
7641
|
+
# how to use targets, see [Using targets and rate controls to send
|
7642
|
+
# commands to a fleet][1] in the *AWS Systems Manager User Guide*.
|
7526
7643
|
#
|
7527
7644
|
#
|
7528
7645
|
#
|
7529
|
-
# [1]:
|
7646
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
7530
7647
|
#
|
7531
7648
|
# @option params [Array<Types::Target>] :targets
|
7532
7649
|
# (Optional) An array of search criteria that targets instances using a
|
7533
7650
|
# Key,Value combination that you specify. Targets is required if you
|
7534
7651
|
# don't provide one or more instance IDs in the call. For more
|
7535
|
-
# information about how to use targets, see [Sending
|
7536
|
-
#
|
7652
|
+
# information about how to use targets, see [Sending commands to a
|
7653
|
+
# fleet][1] in the *AWS Systems Manager User Guide*.
|
7537
7654
|
#
|
7538
7655
|
#
|
7539
7656
|
#
|
7540
|
-
# [1]:
|
7657
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
7541
7658
|
#
|
7542
7659
|
# @option params [required, String] :document_name
|
7543
7660
|
# Required. The name of the Systems Manager document to run. This can be
|
@@ -7586,7 +7703,7 @@ module Aws::SSM
|
|
7586
7703
|
# @option params [String] :output_s3_region
|
7587
7704
|
# (Deprecated) You can no longer specify this parameter. The system
|
7588
7705
|
# ignores it. Instead, Systems Manager automatically determines the
|
7589
|
-
#
|
7706
|
+
# Region of the S3 bucket.
|
7590
7707
|
#
|
7591
7708
|
# @option params [String] :output_s3_bucket_name
|
7592
7709
|
# The name of the S3 bucket where command execution responses should be
|
@@ -7600,12 +7717,12 @@ module Aws::SSM
|
|
7600
7717
|
# (Optional) The maximum number of instances that are allowed to run the
|
7601
7718
|
# command at the same time. You can specify a number such as 10 or a
|
7602
7719
|
# percentage such as 10%. The default value is 50. For more information
|
7603
|
-
# about how to use MaxConcurrency, see [Using
|
7720
|
+
# about how to use MaxConcurrency, see [Using concurrency controls][1]
|
7604
7721
|
# in the *AWS Systems Manager User Guide*.
|
7605
7722
|
#
|
7606
7723
|
#
|
7607
7724
|
#
|
7608
|
-
# [1]:
|
7725
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity
|
7609
7726
|
#
|
7610
7727
|
# @option params [String] :max_errors
|
7611
7728
|
# The maximum number of errors allowed without the command failing. When
|
@@ -7613,11 +7730,11 @@ module Aws::SSM
|
|
7613
7730
|
# systems stops sending the command to additional targets. You can
|
7614
7731
|
# specify a number like 10 or a percentage like 10%. The default value
|
7615
7732
|
# is 0. For more information about how to use MaxErrors, see [Using
|
7616
|
-
#
|
7733
|
+
# error controls][1] in the *AWS Systems Manager User Guide*.
|
7617
7734
|
#
|
7618
7735
|
#
|
7619
7736
|
#
|
7620
|
-
# [1]:
|
7737
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
|
7621
7738
|
#
|
7622
7739
|
# @option params [String] :service_role_arn
|
7623
7740
|
# The ARN of the IAM service role to use to publish Amazon Simple
|
@@ -7799,12 +7916,12 @@ module Aws::SSM
|
|
7799
7916
|
# A location is a combination of AWS Regions and/or AWS accounts where
|
7800
7917
|
# you want to run the Automation. Use this action to start an Automation
|
7801
7918
|
# in multiple Regions and multiple accounts. For more information, see
|
7802
|
-
# [
|
7803
|
-
# *AWS Systems Manager User Guide*.
|
7919
|
+
# [Running Automation workflows in multiple AWS Regions and accounts][1]
|
7920
|
+
# in the *AWS Systems Manager User Guide*.
|
7804
7921
|
#
|
7805
7922
|
#
|
7806
7923
|
#
|
7807
|
-
# [1]:
|
7924
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html
|
7808
7925
|
#
|
7809
7926
|
# @option params [Array<Types::Tag>] :tags
|
7810
7927
|
# Optional metadata that you assign to a resource. You can specify a
|
@@ -7887,8 +8004,8 @@ module Aws::SSM
|
|
7887
8004
|
#
|
7888
8005
|
# <note markdown="1"> AWS CLI usage: `start-session` is an interactive command that requires
|
7889
8006
|
# the Session Manager plugin to be installed on the client machine
|
7890
|
-
# making the call. For information, see [
|
7891
|
-
#
|
8007
|
+
# making the call. For information, see [Install the Session Manager
|
8008
|
+
# plugin for the AWS CLI][1] in the *AWS Systems Manager User Guide*.
|
7892
8009
|
#
|
7893
8010
|
# AWS Tools for PowerShell usage: Start-SSMSession is not currently
|
7894
8011
|
# supported by AWS Tools for PowerShell on Windows local machines.
|
@@ -7897,7 +8014,7 @@ module Aws::SSM
|
|
7897
8014
|
#
|
7898
8015
|
#
|
7899
8016
|
#
|
7900
|
-
# [1]:
|
8017
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
|
7901
8018
|
#
|
7902
8019
|
# @option params [required, String] :target
|
7903
8020
|
# The instance to connect to for the session.
|
@@ -8030,8 +8147,7 @@ module Aws::SSM
|
|
8030
8147
|
# update.
|
8031
8148
|
#
|
8032
8149
|
# @option params [Types::InstanceAssociationOutputLocation] :output_location
|
8033
|
-
# An
|
8034
|
-
# request.
|
8150
|
+
# An S3 bucket where you want to store the results of this request.
|
8035
8151
|
#
|
8036
8152
|
# @option params [String] :name
|
8037
8153
|
# The name of the SSM document that contains the configuration
|
@@ -8104,6 +8220,21 @@ module Aws::SSM
|
|
8104
8220
|
# @option params [String] :compliance_severity
|
8105
8221
|
# The severity level to assign to the association.
|
8106
8222
|
#
|
8223
|
+
# @option params [String] :sync_compliance
|
8224
|
+
# The mode for generating association compliance. You can specify `AUTO`
|
8225
|
+
# or `MANUAL`. In `AUTO` mode, the system uses the status of the
|
8226
|
+
# association execution to determine the compliance status. If the
|
8227
|
+
# association execution runs successfully, then the association is
|
8228
|
+
# `COMPLIANT`. If the association execution doesn't run successfully,
|
8229
|
+
# the association is `NON-COMPLIANT`.
|
8230
|
+
#
|
8231
|
+
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
8232
|
+
# for the PutComplianceItems API action. In this case, compliance data
|
8233
|
+
# is not managed by State Manager. It is managed by your direct call to
|
8234
|
+
# the PutComplianceItems API action.
|
8235
|
+
#
|
8236
|
+
# By default, all associations use `AUTO` mode.
|
8237
|
+
#
|
8107
8238
|
# @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8108
8239
|
#
|
8109
8240
|
# * {Types::UpdateAssociationResult#association_description #association_description} => Types::AssociationDescription
|
@@ -8137,6 +8268,7 @@ module Aws::SSM
|
|
8137
8268
|
# max_errors: "MaxErrors",
|
8138
8269
|
# max_concurrency: "MaxConcurrency",
|
8139
8270
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
8271
|
+
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
8140
8272
|
# })
|
8141
8273
|
#
|
8142
8274
|
# @example Response structure
|
@@ -8174,6 +8306,7 @@ module Aws::SSM
|
|
8174
8306
|
# resp.association_description.max_errors #=> String
|
8175
8307
|
# resp.association_description.max_concurrency #=> String
|
8176
8308
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
8309
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
8177
8310
|
#
|
8178
8311
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociation AWS API Documentation
|
8179
8312
|
#
|
@@ -8248,6 +8381,7 @@ module Aws::SSM
|
|
8248
8381
|
# resp.association_description.max_errors #=> String
|
8249
8382
|
# resp.association_description.max_concurrency #=> String
|
8250
8383
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
8384
|
+
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
8251
8385
|
#
|
8252
8386
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationStatus AWS API Documentation
|
8253
8387
|
#
|
@@ -8277,7 +8411,10 @@ module Aws::SSM
|
|
8277
8411
|
# changed.
|
8278
8412
|
#
|
8279
8413
|
# @option params [String] :document_version
|
8280
|
-
# (Required) The version of the document that you want to update.
|
8414
|
+
# (Required) The latest version of the document that you want to update.
|
8415
|
+
# The latest document version can be specified using the $LATEST
|
8416
|
+
# variable or by the version number. Updating a previous version of a
|
8417
|
+
# document is not supported.
|
8281
8418
|
#
|
8282
8419
|
# @option params [String] :document_format
|
8283
8420
|
# Specify the document format for the new document version. Systems
|
@@ -8651,15 +8788,15 @@ module Aws::SSM
|
|
8651
8788
|
# For more information, see the following topics in the in the *AWS
|
8652
8789
|
# Systems Manager User Guide*\:
|
8653
8790
|
#
|
8654
|
-
# * [
|
8791
|
+
# * [Using service-linked roles for Systems Manager][1]
|
8655
8792
|
#
|
8656
|
-
# * [Should I
|
8657
|
-
#
|
8793
|
+
# * [Should I use a service-linked role or a custom service role to run
|
8794
|
+
# maintenance window tasks? ][2]
|
8658
8795
|
#
|
8659
8796
|
#
|
8660
8797
|
#
|
8661
|
-
# [1]:
|
8662
|
-
# [2]:
|
8798
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions
|
8799
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role
|
8663
8800
|
#
|
8664
8801
|
# @option params [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>] :task_parameters
|
8665
8802
|
# The parameters to modify.
|
@@ -8864,8 +9001,10 @@ module Aws::SSM
|
|
8864
9001
|
req.send_request(options)
|
8865
9002
|
end
|
8866
9003
|
|
8867
|
-
#
|
8868
|
-
#
|
9004
|
+
# Changes the Amazon Identity and Access Management (IAM) role that is
|
9005
|
+
# assigned to the on-premises instance or virtual machines (VM). IAM
|
9006
|
+
# roles are first assigned to these hybrid instances during the
|
9007
|
+
# activation process. For more information, see CreateActivation.
|
8869
9008
|
#
|
8870
9009
|
# @option params [required, String] :instance_id
|
8871
9010
|
# The ID of the managed instance where you want to update the role.
|
@@ -8893,7 +9032,7 @@ module Aws::SSM
|
|
8893
9032
|
|
8894
9033
|
# Edit or change an OpsItem. You must have permission in AWS Identity
|
8895
9034
|
# and Access Management (IAM) to update an OpsItem. For more
|
8896
|
-
# information, see [Getting
|
9035
|
+
# information, see [Getting started with OpsCenter][1] in the *AWS
|
8897
9036
|
# Systems Manager User Guide*.
|
8898
9037
|
#
|
8899
9038
|
# Operations engineers and IT professionals use OpsCenter to view,
|
@@ -8904,8 +9043,8 @@ module Aws::SSM
|
|
8904
9043
|
#
|
8905
9044
|
#
|
8906
9045
|
#
|
8907
|
-
# [1]:
|
8908
|
-
# [2]:
|
9046
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html
|
9047
|
+
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
8909
9048
|
#
|
8910
9049
|
# @option params [String] :description
|
8911
9050
|
# Update the information about the OpsItem. Provide enough information
|
@@ -8937,11 +9076,11 @@ module Aws::SSM
|
|
8937
9076
|
# resource in the request. Use the `/aws/automations` key in
|
8938
9077
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
8939
9078
|
# To view AWS CLI example commands that use these keys, see [Creating
|
8940
|
-
# OpsItems
|
9079
|
+
# OpsItems manually][1] in the *AWS Systems Manager User Guide*.
|
8941
9080
|
#
|
8942
9081
|
#
|
8943
9082
|
#
|
8944
|
-
# [1]:
|
9083
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems
|
8945
9084
|
#
|
8946
9085
|
# @option params [Array<String>] :operational_data_to_delete
|
8947
9086
|
# Keys that you want to remove from the OperationalData map.
|
@@ -8962,12 +9101,12 @@ module Aws::SSM
|
|
8962
9101
|
#
|
8963
9102
|
# @option params [String] :status
|
8964
9103
|
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
8965
|
-
# `Resolved`. For more information, see [Editing OpsItem
|
9104
|
+
# `Resolved`. For more information, see [Editing OpsItem details][1] in
|
8966
9105
|
# the *AWS Systems Manager User Guide*.
|
8967
9106
|
#
|
8968
9107
|
#
|
8969
9108
|
#
|
8970
|
-
# [1]:
|
9109
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details
|
8971
9110
|
#
|
8972
9111
|
# @option params [required, String] :ops_item_id
|
8973
9112
|
# The ID of the OpsItem.
|
@@ -9050,8 +9189,8 @@ module Aws::SSM
|
|
9050
9189
|
# A list of explicitly approved patches for the baseline.
|
9051
9190
|
#
|
9052
9191
|
# For information about accepted formats for lists of approved patches
|
9053
|
-
# and rejected patches, see [
|
9054
|
-
#
|
9192
|
+
# and rejected patches, see [About package name formats for approved and
|
9193
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
9055
9194
|
#
|
9056
9195
|
#
|
9057
9196
|
#
|
@@ -9069,8 +9208,8 @@ module Aws::SSM
|
|
9069
9208
|
# A list of explicitly rejected patches for the baseline.
|
9070
9209
|
#
|
9071
9210
|
# For information about accepted formats for lists of approved patches
|
9072
|
-
# and rejected patches, see [
|
9073
|
-
#
|
9211
|
+
# and rejected patches, see [About package name formats for approved and
|
9212
|
+
# rejected patch lists][1] in the *AWS Systems Manager User Guide*.
|
9074
9213
|
#
|
9075
9214
|
#
|
9076
9215
|
#
|
@@ -9220,14 +9359,17 @@ module Aws::SSM
|
|
9220
9359
|
# Organizations configuration option. Instead, you must delete the first
|
9221
9360
|
# resource data sync, and create a new one.
|
9222
9361
|
#
|
9362
|
+
# <note markdown="1"> This API action only supports a resource data sync that was created
|
9363
|
+
# with a SyncFromSource `SyncType`.
|
9364
|
+
#
|
9365
|
+
# </note>
|
9366
|
+
#
|
9223
9367
|
# @option params [required, String] :sync_name
|
9224
9368
|
# The name of the resource data sync you want to update.
|
9225
9369
|
#
|
9226
9370
|
# @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.
|
9371
|
+
# The type of resource data sync. The supported `SyncType` is
|
9372
|
+
# SyncFromSource.
|
9231
9373
|
#
|
9232
9374
|
# @option params [required, Types::ResourceDataSyncSource] :sync_source
|
9233
9375
|
# Specify information about the data sources to synchronize.
|
@@ -9282,10 +9424,31 @@ module Aws::SSM
|
|
9282
9424
|
# Update the service setting for the account.
|
9283
9425
|
#
|
9284
9426
|
# @option params [required, String] :setting_id
|
9285
|
-
# The
|
9427
|
+
# The Amazon Resource Name (ARN) of the service setting to reset. For
|
9428
|
+
# example,
|
9429
|
+
# `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`.
|
9430
|
+
# The setting ID can be one of the following.
|
9431
|
+
#
|
9432
|
+
# * `/ssm/parameter-store/default-parameter-tier`
|
9433
|
+
#
|
9434
|
+
# * `/ssm/parameter-store/high-throughput-enabled`
|
9435
|
+
#
|
9436
|
+
# * `/ssm/managed-instance/activation-tier`
|
9286
9437
|
#
|
9287
9438
|
# @option params [required, String] :setting_value
|
9288
|
-
# The new value to specify for the service setting.
|
9439
|
+
# The new value to specify for the service setting. For the
|
9440
|
+
# `/ssm/parameter-store/default-parameter-tier` setting ID, the setting
|
9441
|
+
# value can be one of the following.
|
9442
|
+
#
|
9443
|
+
# * Standard
|
9444
|
+
#
|
9445
|
+
# * Advanced
|
9446
|
+
#
|
9447
|
+
# * Intelligent-Tiering
|
9448
|
+
#
|
9449
|
+
# For the `/ssm/parameter-store/high-throughput-enabled`, and
|
9450
|
+
# `/ssm/managed-instance/activation-tier` setting IDs, the setting value
|
9451
|
+
# can be true or false.
|
9289
9452
|
#
|
9290
9453
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
9291
9454
|
#
|
@@ -9318,7 +9481,7 @@ module Aws::SSM
|
|
9318
9481
|
params: params,
|
9319
9482
|
config: config)
|
9320
9483
|
context[:gem_name] = 'aws-sdk-ssm'
|
9321
|
-
context[:gem_version] = '1.
|
9484
|
+
context[:gem_version] = '1.74.0'
|
9322
9485
|
Seahorse::Client::Request.new(handlers, context)
|
9323
9486
|
end
|
9324
9487
|
|