aws-sdk-ssm 1.111.0 → 1.112.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +957 -762
- data/lib/aws-sdk-ssm/types.rb +1668 -1403
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9b60596d2fe5a2378e7d457378675afef799b1a18cb40ee209777fe9859882c8
|
4
|
+
data.tar.gz: bd5583488fbcb8c5c4a8dcdb5645f915b10f44ed825d7baca10cd211ac055fcd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7035bf3fac82d4f628db7de4b8d331f4f539a951f3dfc0785d7717ad77abfd737e3d8a59b4047b1cb52b3878fa358206709d0b7df45abf75ee3f007728b98052
|
7
|
+
data.tar.gz: 22fd6c6f511fb3257fe459d17157aa1ba2439c6c0a0d1af8b33ac59507c5cb44340fecb8ababdc23d24a0c8700274eb925b311dae2c1aa8741c51f2a4f730f12
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.112.0
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -345,8 +345,18 @@ module Aws::SSM
|
|
345
345
|
# and an optional value, both of which you define. For example, you
|
346
346
|
# could define a set of tags for your account's managed instances that
|
347
347
|
# helps you track each instance's owner and stack level. For example:
|
348
|
-
#
|
349
|
-
# Value=
|
348
|
+
#
|
349
|
+
# * `Key=Owner,Value=DbAdmin`
|
350
|
+
#
|
351
|
+
# * `Key=Owner,Value=SysAdmin`
|
352
|
+
#
|
353
|
+
# * `Key=Owner,Value=Dev`
|
354
|
+
#
|
355
|
+
# * `Key=Stack,Value=Production`
|
356
|
+
#
|
357
|
+
# * `Key=Stack,Value=Pre-Production`
|
358
|
+
#
|
359
|
+
# * `Key=Stack,Value=Test`
|
350
360
|
#
|
351
361
|
# Each resource can have a maximum of 50 tags.
|
352
362
|
#
|
@@ -356,8 +366,9 @@ module Aws::SSM
|
|
356
366
|
# resources based on the tags you add. Tags don't have any semantic
|
357
367
|
# meaning to and are interpreted strictly as a string of characters.
|
358
368
|
#
|
359
|
-
# For more information about using tags with
|
360
|
-
#
|
369
|
+
# For more information about using tags with Amazon Elastic Compute
|
370
|
+
# Cloud (Amazon EC2) instances, see [Tagging your Amazon EC2
|
371
|
+
# resources][1] in the *Amazon EC2 User Guide*.
|
361
372
|
#
|
362
373
|
#
|
363
374
|
#
|
@@ -366,9 +377,10 @@ module Aws::SSM
|
|
366
377
|
# @option params [required, String] :resource_type
|
367
378
|
# Specifies the type of resource you are tagging.
|
368
379
|
#
|
369
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
380
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is for on-premises
|
370
381
|
# managed instances. You must specify the name of the managed instance
|
371
|
-
# in the following format: mi-
|
382
|
+
# in the following format: `mi-ID_number `. For example,
|
383
|
+
# `mi-1a2b3c4d5e6f`.
|
372
384
|
#
|
373
385
|
# </note>
|
374
386
|
#
|
@@ -377,13 +389,11 @@ module Aws::SSM
|
|
377
389
|
#
|
378
390
|
# Use the ID of the resource. Here are some examples:
|
379
391
|
#
|
380
|
-
#
|
392
|
+
# `MaintenanceWindow`\: `mw-012345abcde`
|
381
393
|
#
|
382
|
-
#
|
394
|
+
# `PatchBaseline`\: `pb-012345abcde`
|
383
395
|
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
# OpsMetadata object: `ResourceID` for tagging is created from the
|
396
|
+
# `OpsMetadata` object: `ResourceID` for tagging is created from the
|
387
397
|
# Amazon Resource Name (ARN) for the object. Specifically, `ResourceID`
|
388
398
|
# is created from the strings that come after the word `opsmetadata` in
|
389
399
|
# the ARN. For example, an OpsMetadata object with an ARN of
|
@@ -391,18 +401,22 @@ module Aws::SSM
|
|
391
401
|
# has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or
|
392
402
|
# `/aws/ssm/MyGroup/appmanager`.
|
393
403
|
#
|
394
|
-
# For the Document and Parameter values, use the name of the
|
404
|
+
# For the `Document` and `Parameter` values, use the name of the
|
405
|
+
# resource.
|
395
406
|
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
407
|
+
# `ManagedInstance`\: `mi-012345abcde`
|
408
|
+
#
|
409
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
410
|
+
# on-premises managed instances. You must specify the name of the
|
411
|
+
# managed instance in the following format: `mi-ID_number `. For
|
412
|
+
# example, `mi-1a2b3c4d5e6f`.
|
399
413
|
#
|
400
414
|
# </note>
|
401
415
|
#
|
402
416
|
# @option params [required, Array<Types::Tag>] :tags
|
403
417
|
# One or more tags. The value parameter is required.
|
404
418
|
#
|
405
|
-
#
|
419
|
+
# Don't enter personally identifiable information in this field.
|
406
420
|
#
|
407
421
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
408
422
|
#
|
@@ -430,8 +444,8 @@ module Aws::SSM
|
|
430
444
|
|
431
445
|
# Associates a related resource to a Systems Manager OpsCenter OpsItem.
|
432
446
|
# For example, you can associate an Incident Manager incident or
|
433
|
-
# analysis with an OpsItem. Incident Manager is a capability of
|
434
|
-
# Systems Manager.
|
447
|
+
# analysis with an OpsItem. Incident Manager is a capability of Amazon
|
448
|
+
# Web Services Systems Manager.
|
435
449
|
#
|
436
450
|
# @option params [required, String] :ops_item_id
|
437
451
|
# The ID of the OpsItem to which you want to associate a resource as a
|
@@ -447,13 +461,14 @@ module Aws::SSM
|
|
447
461
|
# OpsCenter supports the following types:
|
448
462
|
#
|
449
463
|
# `AWS::SSMIncidents::IncidentRecord`\: an Incident Manager incident.
|
450
|
-
# Incident Manager is a capability of
|
464
|
+
# Incident Manager is a capability of Amazon Web Services Systems
|
465
|
+
# Manager.
|
451
466
|
#
|
452
467
|
# `AWS::SSM::Document`\: a Systems Manager (SSM) document.
|
453
468
|
#
|
454
469
|
# @option params [required, String] :resource_uri
|
455
|
-
# The Amazon Resource Name (ARN) of the
|
456
|
-
# associate with the OpsItem.
|
470
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services resource
|
471
|
+
# that you want to associate with the OpsItem.
|
457
472
|
#
|
458
473
|
# @return [Types::AssociateOpsItemRelatedItemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
459
474
|
#
|
@@ -512,8 +527,8 @@ module Aws::SSM
|
|
512
527
|
end
|
513
528
|
|
514
529
|
# Stops a maintenance window execution that is already in progress and
|
515
|
-
# cancels any tasks in the window that
|
516
|
-
# running.
|
530
|
+
# cancels any tasks in the window that haven't already starting
|
531
|
+
# running. Tasks already in progress will continue to completion.
|
517
532
|
#
|
518
533
|
# @option params [required, String] :window_execution_id
|
519
534
|
# The ID of the maintenance window execution to stop.
|
@@ -542,18 +557,19 @@ module Aws::SSM
|
|
542
557
|
end
|
543
558
|
|
544
559
|
# Generates an activation code and activation ID you can use to register
|
545
|
-
# your on-premises server or virtual machine (VM) with
|
546
|
-
# Registering these machines with Systems
|
547
|
-
# manage them using Systems Manager
|
548
|
-
# code and ID when installing SSM
|
549
|
-
# environment. For more information
|
550
|
-
# on-premises instances and VMs using
|
551
|
-
#
|
560
|
+
# your on-premises server or virtual machine (VM) with Amazon Web
|
561
|
+
# Services Systems Manager. Registering these machines with Systems
|
562
|
+
# Manager makes it possible to manage them using Systems Manager
|
563
|
+
# capabilities. You use the activation code and ID when installing SSM
|
564
|
+
# Agent on machines in your hybrid environment. For more information
|
565
|
+
# about requirements for managing on-premises instances and VMs using
|
566
|
+
# Systems Manager, see [Setting up Amazon Web Services Systems Manager
|
567
|
+
# for hybrid environments][1] in the *Amazon Web Services Systems
|
552
568
|
# Manager User Guide*.
|
553
569
|
#
|
554
570
|
# <note markdown="1"> On-premises servers or VMs that are registered with Systems Manager
|
555
|
-
# and
|
556
|
-
# *managed instances*.
|
571
|
+
# and Amazon Elastic Compute Cloud (Amazon EC2) instances that you
|
572
|
+
# manage with Systems Manager are all called *managed instances*.
|
557
573
|
#
|
558
574
|
# </note>
|
559
575
|
#
|
@@ -565,22 +581,22 @@ module Aws::SSM
|
|
565
581
|
# A user-defined description of the resource that you want to register
|
566
582
|
# with Systems Manager.
|
567
583
|
#
|
568
|
-
#
|
584
|
+
# Don't enter personally identifiable information in this field.
|
569
585
|
#
|
570
586
|
# @option params [String] :default_instance_name
|
571
587
|
# The name of the registered, managed instance as it will appear in the
|
572
|
-
# Systems Manager console or when you use the
|
573
|
-
# list Systems Manager resources.
|
588
|
+
# Amazon Web Services Systems Manager console or when you use the Amazon
|
589
|
+
# Web Services command line tools to list Systems Manager resources.
|
574
590
|
#
|
575
|
-
#
|
591
|
+
# Don't enter personally identifiable information in this field.
|
576
592
|
#
|
577
593
|
# @option params [required, String] :iam_role
|
578
|
-
# The
|
579
|
-
#
|
580
|
-
# permissions for the Systems Manager service
|
581
|
-
# `ssm.amazonaws.com`. For more information, see [Create an
|
582
|
-
# role for a hybrid environment][1] in the *
|
583
|
-
# Guide*.
|
594
|
+
# The Identity and Access Management (IAM) role that you want to assign
|
595
|
+
# to the managed instance. This IAMrole must provide AssumeRole
|
596
|
+
# permissions for the Amazon Web Services Systems Manager service
|
597
|
+
# principal `ssm.amazonaws.com`. For more information, see [Create an
|
598
|
+
# IAM service role for a hybrid environment][1] in the *Amazon Web
|
599
|
+
# Services Systems Manager User Guide*.
|
584
600
|
#
|
585
601
|
#
|
586
602
|
#
|
@@ -588,7 +604,7 @@ module Aws::SSM
|
|
588
604
|
#
|
589
605
|
# @option params [Integer] :registration_limit
|
590
606
|
# Specify the maximum number of managed instances you want to register.
|
591
|
-
# The default value is 1
|
607
|
+
# The default value is `1`.
|
592
608
|
#
|
593
609
|
# @option params [Time,DateTime,Date,Integer,String] :expiration_date
|
594
610
|
# The date by which this activation request should expire, in timestamp
|
@@ -602,7 +618,7 @@ module Aws::SSM
|
|
602
618
|
# environment. For example, you might want to tag an activation to
|
603
619
|
# identify which servers or virtual machines (VMs) in your on-premises
|
604
620
|
# environment you intend to activate. In this case, you could specify
|
605
|
-
# the following key
|
621
|
+
# the following key-value pairs:
|
606
622
|
#
|
607
623
|
# * `Key=OS,Value=Windows`
|
608
624
|
#
|
@@ -616,11 +632,11 @@ module Aws::SSM
|
|
616
632
|
# You can't add tags to or delete tags from an existing activation. You
|
617
633
|
# can tag your on-premises servers and VMs after they connect to Systems
|
618
634
|
# Manager for the first time and are assigned a managed instance ID.
|
619
|
-
# This means they are listed in the
|
620
|
-
# ID that is prefixed with "mi-". For information
|
621
|
-
# tags to your managed instances, see
|
622
|
-
# about how to remove tags from your
|
623
|
-
# RemoveTagsFromResource.
|
635
|
+
# This means they are listed in the Amazon Web Services Systems Manager
|
636
|
+
# console with an ID that is prefixed with "mi-". For information
|
637
|
+
# about how to add tags to your managed instances, see
|
638
|
+
# AddTagsToResource. For information about how to remove tags from your
|
639
|
+
# managed instances, see RemoveTagsFromResource.
|
624
640
|
#
|
625
641
|
# @return [Types::CreateActivationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
626
642
|
#
|
@@ -662,26 +678,28 @@ module Aws::SSM
|
|
662
678
|
# that anti-virus software must be installed and running on your
|
663
679
|
# instances, or that certain ports must be closed. For static targets,
|
664
680
|
# the association specifies a schedule for when the configuration is
|
665
|
-
# reapplied. For dynamic targets, such as an
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
# association
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
681
|
+
# reapplied. For dynamic targets, such as an Amazon Web Services
|
682
|
+
# resource group or an Amazon Web Services autoscaling group, State
|
683
|
+
# Manager, a capability of Amazon Web Services Systems Manager applies
|
684
|
+
# the configuration when new instances are added to the group. The
|
685
|
+
# association also specifies actions to take when applying the
|
686
|
+
# configuration. For example, an association for anti-virus software
|
687
|
+
# might run once a day. If the software isn't installed, then State
|
688
|
+
# Manager installs it. If the software is installed, but the service
|
689
|
+
# isn't running, then the association might instruct State Manager to
|
690
|
+
# start the service.
|
673
691
|
#
|
674
692
|
# @option params [required, String] :name
|
675
|
-
# The name of the SSM document
|
676
|
-
# information for the instance.
|
677
|
-
# documents.
|
693
|
+
# The name of the SSM Command document or Automation runbook that
|
694
|
+
# contains the configuration information for the instance.
|
678
695
|
#
|
679
|
-
# You can specify
|
680
|
-
# document that is shared with you from another
|
696
|
+
# You can specify Amazon Web Services-predefined documents, documents
|
697
|
+
# you created, or a document that is shared with you from another
|
698
|
+
# account.
|
681
699
|
#
|
682
|
-
# For SSM documents that are shared with you
|
683
|
-
# you must specify the complete SSM document ARN,
|
684
|
-
# format:
|
700
|
+
# For Systems Manager documents (SSM documents) that are shared with you
|
701
|
+
# from other accounts, you must specify the complete SSM document ARN,
|
702
|
+
# in the following format:
|
685
703
|
#
|
686
704
|
# `arn:partition:ssm:region:account-id:document/document-name `
|
687
705
|
#
|
@@ -689,9 +707,9 @@ module Aws::SSM
|
|
689
707
|
#
|
690
708
|
# `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
|
691
709
|
#
|
692
|
-
# For
|
693
|
-
# account, you only need to specify the document name.
|
694
|
-
# `AWS-ApplyPatchBaseline` or `My-Document`.
|
710
|
+
# For Amazon Web Services-predefined documents and SSM documents you
|
711
|
+
# created in your account, you only need to specify the document name.
|
712
|
+
# For example, `AWS-ApplyPatchBaseline` or `My-Document`.
|
695
713
|
#
|
696
714
|
# @option params [String] :document_version
|
697
715
|
# The document version you want to associate with the target(s). Can be
|
@@ -702,12 +720,12 @@ module Aws::SSM
|
|
702
720
|
#
|
703
721
|
# <note markdown="1"> `InstanceId` has been deprecated. To specify an instance ID for an
|
704
722
|
# association, use the `Targets` parameter. Requests that include the
|
705
|
-
# parameter `InstanceID` with
|
706
|
-
# or later will fail. In addition, if you
|
707
|
-
# `InstanceId`, you
|
708
|
-
# `DocumentVersion`, `MaxErrors`, `MaxConcurrency`,
|
709
|
-
# `ScheduleExpression`. To use these parameters,
|
710
|
-
# `Targets` parameter.
|
723
|
+
# parameter `InstanceID` with Systems Manager documents (SSM documents)
|
724
|
+
# that use schema version 2.0 or later will fail. In addition, if you
|
725
|
+
# use the parameter `InstanceId`, you can't use the parameters
|
726
|
+
# `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`,
|
727
|
+
# `OutputLocation`, or `ScheduleExpression`. To use these parameters,
|
728
|
+
# you must use the `Targets` parameter.
|
711
729
|
#
|
712
730
|
# </note>
|
713
731
|
#
|
@@ -716,10 +734,11 @@ module Aws::SSM
|
|
716
734
|
#
|
717
735
|
# @option params [Array<Types::Target>] :targets
|
718
736
|
# The targets for the association. You can target instances by using
|
719
|
-
# tags,
|
720
|
-
# individual instance IDs. For more information about
|
721
|
-
# for an association, see [Using targets and rate
|
722
|
-
# Manager associations][1] in the *
|
737
|
+
# tags, Amazon Web Services resource groups, all instances in an
|
738
|
+
# account, or individual instance IDs. For more information about
|
739
|
+
# choosing targets for an association, see [Using targets and rate
|
740
|
+
# controls with State Manager associations][1] in the *Amazon Web
|
741
|
+
# Services Systems Manager User Guide*.
|
723
742
|
#
|
724
743
|
#
|
725
744
|
#
|
@@ -730,16 +749,17 @@ module Aws::SSM
|
|
730
749
|
# target(s).
|
731
750
|
#
|
732
751
|
# @option params [Types::InstanceAssociationOutputLocation] :output_location
|
733
|
-
# An S3 bucket where you want to
|
734
|
-
# request.
|
752
|
+
# An Amazon Simple Storage Service (Amazon S3) bucket where you want to
|
753
|
+
# store the output details of the request.
|
735
754
|
#
|
736
755
|
# @option params [String] :association_name
|
737
756
|
# Specify a descriptive name for the association.
|
738
757
|
#
|
739
758
|
# @option params [String] :automation_target_parameter_name
|
740
759
|
# Specify the target for the association. This target is required for
|
741
|
-
# associations that use an Automation
|
742
|
-
# using rate controls.
|
760
|
+
# associations that use an Automation runbook and target resources by
|
761
|
+
# using rate controls. Automation is a capability of Amazon Web Services
|
762
|
+
# Systems Manager.
|
743
763
|
#
|
744
764
|
# @option params [String] :max_errors
|
745
765
|
# The number of errors that are allowed before the system stops sending
|
@@ -749,13 +769,13 @@ module Aws::SSM
|
|
749
769
|
# system stops sending requests when the fourth error is received. If
|
750
770
|
# you specify 0, then the system stops sending requests after the first
|
751
771
|
# error is returned. If you run an association on 50 instances and set
|
752
|
-
# MaxError to 10%, then the system stops sending the request when the
|
772
|
+
# `MaxError` to 10%, then the system stops sending the request when the
|
753
773
|
# sixth error is received.
|
754
774
|
#
|
755
|
-
# Executions that are already running an association when MaxErrors is
|
775
|
+
# Executions that are already running an association when `MaxErrors` is
|
756
776
|
# reached are allowed to complete, but some of these executions may fail
|
757
777
|
# as well. If you need to ensure that there won't be more than
|
758
|
-
# max-errors failed executions, set MaxConcurrency to 1 so that
|
778
|
+
# max-errors failed executions, set `MaxConcurrency` to 1 so that
|
759
779
|
# executions proceed one at a time.
|
760
780
|
#
|
761
781
|
# @option params [String] :max_concurrency
|
@@ -765,10 +785,10 @@ module Aws::SSM
|
|
765
785
|
# means all targets run the association at the same time.
|
766
786
|
#
|
767
787
|
# If a new instance starts and attempts to run an association while
|
768
|
-
# Systems Manager is running MaxConcurrency associations, the
|
788
|
+
# Systems Manager is running `MaxConcurrency` associations, the
|
769
789
|
# association is allowed to run. During the next association interval,
|
770
790
|
# the new instance will process its association within the limit
|
771
|
-
# specified for MaxConcurrency
|
791
|
+
# specified for `MaxConcurrency`.
|
772
792
|
#
|
773
793
|
# @option params [String] :compliance_severity
|
774
794
|
# The severity level to assign to the association.
|
@@ -782,9 +802,9 @@ module Aws::SSM
|
|
782
802
|
# the association is `NON-COMPLIANT`.
|
783
803
|
#
|
784
804
|
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
785
|
-
# for the PutComplianceItems API
|
786
|
-
#
|
787
|
-
# the PutComplianceItems API
|
805
|
+
# for the PutComplianceItems API operation. In this case, compliance
|
806
|
+
# data isn't managed by State Manager. It is managed by your direct
|
807
|
+
# call to the PutComplianceItems API operation.
|
788
808
|
#
|
789
809
|
# By default, all associations use `AUTO` mode.
|
790
810
|
#
|
@@ -792,23 +812,23 @@ module Aws::SSM
|
|
792
812
|
# By default, when you create a new association, the system runs it
|
793
813
|
# immediately after it is created and then according to the schedule you
|
794
814
|
# specified. Specify this option if you don't want an association to
|
795
|
-
# run immediately after you create it. This parameter
|
815
|
+
# run immediately after you create it. This parameter isn't supported
|
796
816
|
# for rate expressions.
|
797
817
|
#
|
798
818
|
# @option params [Array<String>] :calendar_names
|
799
|
-
# The names or Amazon Resource Names (ARNs) of the
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
819
|
+
# The names or Amazon Resource Names (ARNs) of the Change Calendar type
|
820
|
+
# documents you want to gate your associations under. The associations
|
821
|
+
# only run when that change calendar is open. For more information, see
|
822
|
+
# [Amazon Web Services Systems Manager Change Calendar][1].
|
803
823
|
#
|
804
824
|
#
|
805
825
|
#
|
806
826
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
807
827
|
#
|
808
828
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
809
|
-
# A location is a combination of
|
810
|
-
#
|
811
|
-
#
|
829
|
+
# A location is a combination of Regions and accounts where you want to
|
830
|
+
# run the association. Use this action to create an association in
|
831
|
+
# multiple Regions and multiple accounts.
|
812
832
|
#
|
813
833
|
# @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
814
834
|
#
|
@@ -913,12 +933,13 @@ module Aws::SSM
|
|
913
933
|
req.send_request(options)
|
914
934
|
end
|
915
935
|
|
916
|
-
# Associates the specified Systems Manager document
|
917
|
-
# instances or targets.
|
936
|
+
# Associates the specified Amazon Web Services Systems Manager document
|
937
|
+
# (SSM document) with the specified instances or targets.
|
918
938
|
#
|
919
939
|
# When you associate a document with one or more instances using
|
920
|
-
# instance IDs or tags,
|
921
|
-
#
|
940
|
+
# instance IDs or tags, Amazon Web Services Systems Manager Agent (SSM
|
941
|
+
# Agent) running on the instance processes the document and configures
|
942
|
+
# the instance as specified.
|
922
943
|
#
|
923
944
|
# If you associate a document with an instance that already has an
|
924
945
|
# associated document, the system returns the AssociationAlreadyExists
|
@@ -1070,11 +1091,12 @@ module Aws::SSM
|
|
1070
1091
|
req.send_request(options)
|
1071
1092
|
end
|
1072
1093
|
|
1073
|
-
# Creates a Systems Manager (SSM
|
1074
|
-
# actions that Systems Manager performs on your
|
1075
|
-
# more information about SSM documents, including
|
1076
|
-
# supported schemas, features, and syntax, see [
|
1077
|
-
# Documents][1] in the *
|
1094
|
+
# Creates a Amazon Web Services Systems Manager (SSM document). An SSM
|
1095
|
+
# document defines the actions that Systems Manager performs on your
|
1096
|
+
# managed instances. For more information about SSM documents, including
|
1097
|
+
# information about supported schemas, features, and syntax, see [Amazon
|
1098
|
+
# Web Services Systems Manager Documents][1] in the *Amazon Web Services
|
1099
|
+
# Systems Manager User Guide*.
|
1078
1100
|
#
|
1079
1101
|
#
|
1080
1102
|
#
|
@@ -1085,12 +1107,12 @@ module Aws::SSM
|
|
1085
1107
|
# recommend storing the contents for your new document in an external
|
1086
1108
|
# JSON or YAML file and referencing the file in a command.
|
1087
1109
|
#
|
1088
|
-
# For examples, see the following topics in the *
|
1089
|
-
# User Guide*.
|
1110
|
+
# For examples, see the following topics in the *Amazon Web Services
|
1111
|
+
# Systems Manager User Guide*.
|
1090
1112
|
#
|
1091
|
-
# * [Create an SSM document (
|
1113
|
+
# * [Create an SSM document (Amazon Web Services API)][1]
|
1092
1114
|
#
|
1093
|
-
# * [Create an SSM document (
|
1115
|
+
# * [Create an SSM document (Amazon Web Services CLI)][2]
|
1094
1116
|
#
|
1095
1117
|
# * [Create an SSM document (API)][1]
|
1096
1118
|
#
|
@@ -1101,27 +1123,27 @@ module Aws::SSM
|
|
1101
1123
|
#
|
1102
1124
|
# @option params [Array<Types::DocumentRequires>] :requires
|
1103
1125
|
# A list of SSM documents required by a document. This parameter is used
|
1104
|
-
# exclusively by
|
1126
|
+
# exclusively by AppConfig. When a user creates an AppConfig
|
1105
1127
|
# configuration in an SSM document, the user must also specify a
|
1106
1128
|
# required document for validation purposes. In this case, an
|
1107
1129
|
# `ApplicationConfiguration` document requires an
|
1108
1130
|
# `ApplicationConfigurationSchema` document for validation purposes. For
|
1109
|
-
# more information, see [
|
1110
|
-
#
|
1131
|
+
# more information, see [What is AppConfig?][1] in the *AppConfig User
|
1132
|
+
# Guide*.
|
1111
1133
|
#
|
1112
1134
|
#
|
1113
1135
|
#
|
1114
|
-
# [1]: https://docs.aws.amazon.com/
|
1136
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html
|
1115
1137
|
#
|
1116
1138
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
1117
|
-
# A list of key
|
1118
|
-
#
|
1139
|
+
# A list of key-value pairs that describe attachments to a version of a
|
1140
|
+
# document.
|
1119
1141
|
#
|
1120
1142
|
# @option params [required, String] :name
|
1121
|
-
# A name for the
|
1143
|
+
# A name for the SSM document.
|
1122
1144
|
#
|
1123
1145
|
# You can't use the following strings as document name prefixes. These
|
1124
|
-
# are reserved by
|
1146
|
+
# are reserved by Amazon Web Services for use as document name prefixes:
|
1125
1147
|
#
|
1126
1148
|
# * `aws-`
|
1127
1149
|
#
|
@@ -1130,15 +1152,15 @@ module Aws::SSM
|
|
1130
1152
|
# * `amzn`
|
1131
1153
|
#
|
1132
1154
|
# @option params [String] :display_name
|
1133
|
-
# An optional field where you can specify a friendly name for the
|
1134
|
-
#
|
1135
|
-
#
|
1136
|
-
#
|
1155
|
+
# An optional field where you can specify a friendly name for the SSM
|
1156
|
+
# document. This value can differ for each version of the document. You
|
1157
|
+
# can update this value at a later time using the UpdateDocument
|
1158
|
+
# operation.
|
1137
1159
|
#
|
1138
1160
|
# @option params [String] :version_name
|
1139
1161
|
# An optional field specifying the version of the artifact you are
|
1140
1162
|
# creating with the document. For example, "Release 12, Update 6".
|
1141
|
-
# This value is unique across all versions of a document, and
|
1163
|
+
# This value is unique across all versions of a document, and can't be
|
1142
1164
|
# changed.
|
1143
1165
|
#
|
1144
1166
|
# @option params [String] :document_type
|
@@ -1151,11 +1173,11 @@ module Aws::SSM
|
|
1151
1173
|
# @option params [String] :target_type
|
1152
1174
|
# Specify a target type to define the kinds of resources the document
|
1153
1175
|
# can run on. For example, to run a document on EC2 instances, specify
|
1154
|
-
# the following value:
|
1176
|
+
# the following value: `/AWS::EC2::Instance`. If you specify a value of
|
1155
1177
|
# '/' the document can run on all types of resources. If you don't
|
1156
1178
|
# specify a value, the document can't run on any resources. For a list
|
1157
|
-
# of valid resource types, see [
|
1158
|
-
# reference][1] in the *
|
1179
|
+
# of valid resource types, see [Amazon Web Services resource and
|
1180
|
+
# property types reference][1] in the *CloudFormation User Guide*.
|
1159
1181
|
#
|
1160
1182
|
#
|
1161
1183
|
#
|
@@ -1166,14 +1188,14 @@ module Aws::SSM
|
|
1166
1188
|
# categorize a resource in different ways, such as by purpose, owner, or
|
1167
1189
|
# environment. For example, you might want to tag an SSM document to
|
1168
1190
|
# identify the types of targets or the environment where it will run. In
|
1169
|
-
# this case, you could specify the following key
|
1191
|
+
# this case, you could specify the following key-value pairs:
|
1170
1192
|
#
|
1171
1193
|
# * `Key=OS,Value=Windows`
|
1172
1194
|
#
|
1173
1195
|
# * `Key=Environment,Value=Production`
|
1174
1196
|
#
|
1175
1197
|
# <note markdown="1"> To add tags to an existing SSM document, use the AddTagsToResource
|
1176
|
-
#
|
1198
|
+
# operation.
|
1177
1199
|
#
|
1178
1200
|
# </note>
|
1179
1201
|
#
|
@@ -1287,12 +1309,12 @@ module Aws::SSM
|
|
1287
1309
|
#
|
1288
1310
|
# @option params [String] :start_date
|
1289
1311
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
1290
|
-
# maintenance window to become active. StartDate allows you to delay
|
1312
|
+
# maintenance window to become active. `StartDate` allows you to delay
|
1291
1313
|
# activation of the maintenance window until the specified future date.
|
1292
1314
|
#
|
1293
1315
|
# @option params [String] :end_date
|
1294
1316
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
1295
|
-
# maintenance window to become inactive. EndDate allows you to set a
|
1317
|
+
# maintenance window to become inactive. `EndDate` allows you to set a
|
1296
1318
|
# date and time in the future when the maintenance window will no longer
|
1297
1319
|
# run.
|
1298
1320
|
#
|
@@ -1311,7 +1333,7 @@ module Aws::SSM
|
|
1311
1333
|
# [1]: https://www.iana.org/time-zones
|
1312
1334
|
#
|
1313
1335
|
# @option params [Integer] :schedule_offset
|
1314
|
-
# The number of days to wait after the date and time specified by a
|
1336
|
+
# The number of days to wait after the date and time specified by a cron
|
1315
1337
|
# expression before running the maintenance window.
|
1316
1338
|
#
|
1317
1339
|
# For example, the following cron expression schedules a maintenance
|
@@ -1327,11 +1349,12 @@ module Aws::SSM
|
|
1327
1349
|
#
|
1328
1350
|
# @option params [required, Integer] :cutoff
|
1329
1351
|
# The number of hours before the end of the maintenance window that
|
1330
|
-
# Systems Manager stops scheduling new tasks for
|
1352
|
+
# Amazon Web Services Systems Manager stops scheduling new tasks for
|
1353
|
+
# execution.
|
1331
1354
|
#
|
1332
1355
|
# @option params [required, Boolean] :allow_unassociated_targets
|
1333
1356
|
# Enables a maintenance window task to run on managed instances, even if
|
1334
|
-
# you
|
1357
|
+
# you haven't registered those instances as targets. If enabled, then
|
1335
1358
|
# you must specify the unregistered instances (by instance ID) when you
|
1336
1359
|
# register a task with the maintenance window.
|
1337
1360
|
#
|
@@ -1351,7 +1374,7 @@ module Aws::SSM
|
|
1351
1374
|
# environment. For example, you might want to tag a maintenance window
|
1352
1375
|
# to identify the type of tasks it will run, the types of targets, and
|
1353
1376
|
# the environment it will run in. In this case, you could specify the
|
1354
|
-
# following key
|
1377
|
+
# following key-value pairs:
|
1355
1378
|
#
|
1356
1379
|
# * `Key=TaskType,Value=AgentUpdate`
|
1357
1380
|
#
|
@@ -1360,7 +1383,7 @@ module Aws::SSM
|
|
1360
1383
|
# * `Key=Environment,Value=Production`
|
1361
1384
|
#
|
1362
1385
|
# <note markdown="1"> To add tags to an existing maintenance window, use the
|
1363
|
-
# AddTagsToResource
|
1386
|
+
# AddTagsToResource operation.
|
1364
1387
|
#
|
1365
1388
|
# </note>
|
1366
1389
|
#
|
@@ -1403,16 +1426,17 @@ module Aws::SSM
|
|
1403
1426
|
req.send_request(options)
|
1404
1427
|
end
|
1405
1428
|
|
1406
|
-
# Creates a new OpsItem. You must have permission in
|
1407
|
-
#
|
1408
|
-
#
|
1409
|
-
# User Guide*.
|
1429
|
+
# Creates a new OpsItem. You must have permission in Identity and Access
|
1430
|
+
# Management (IAM) to create a new OpsItem. For more information, see
|
1431
|
+
# [Getting started with OpsCenter][1] in the *Amazon Web Services
|
1432
|
+
# Systems Manager User Guide*.
|
1410
1433
|
#
|
1411
|
-
# Operations engineers and IT professionals use
|
1412
|
-
# investigate, and remediate
|
1413
|
-
# performance and health of their
|
1414
|
-
#
|
1415
|
-
#
|
1434
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
1435
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
1436
|
+
# operational issues impacting the performance and health of their
|
1437
|
+
# Amazon Web Services resources. For more information, see [Amazon Web
|
1438
|
+
# Services Systems Manager OpsCenter][2] in the *Amazon Web Services
|
1439
|
+
# Systems Manager User Guide*.
|
1416
1440
|
#
|
1417
1441
|
#
|
1418
1442
|
#
|
@@ -1433,22 +1457,23 @@ module Aws::SSM
|
|
1433
1457
|
# You enter operational data as key-value pairs. The key has a maximum
|
1434
1458
|
# length of 128 characters. The value has a maximum size of 20 KB.
|
1435
1459
|
#
|
1436
|
-
# Operational data keys *can't* begin with the following: amazon
|
1437
|
-
# amzn
|
1460
|
+
# Operational data keys *can't* begin with the following: `amazon`,
|
1461
|
+
# `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
|
1438
1462
|
#
|
1439
1463
|
# You can choose to make the data searchable by other users in the
|
1440
1464
|
# account or you can restrict search access. Searchable data means that
|
1441
1465
|
# all users with access to the OpsItem Overview page (as provided by the
|
1442
|
-
# DescribeOpsItems API
|
1443
|
-
# data. Operational data that
|
1466
|
+
# DescribeOpsItems API operation) can view and search on the specified
|
1467
|
+
# data. Operational data that isn't searchable is only viewable by
|
1444
1468
|
# users who have access to the OpsItem (as provided by the GetOpsItem
|
1445
|
-
# API
|
1469
|
+
# API operation).
|
1446
1470
|
#
|
1447
1471
|
# Use the `/aws/resources` key in OperationalData to specify a related
|
1448
1472
|
# resource in the request. Use the `/aws/automations` key in
|
1449
1473
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
1450
|
-
# To view
|
1451
|
-
# OpsItems manually][1] in the *
|
1474
|
+
# To view Amazon Web Services CLI example commands that use these keys,
|
1475
|
+
# see [Creating OpsItems manually][1] in the *Amazon Web Services
|
1476
|
+
# Systems Manager User Guide*.
|
1452
1477
|
#
|
1453
1478
|
#
|
1454
1479
|
#
|
@@ -1471,8 +1496,8 @@ module Aws::SSM
|
|
1471
1496
|
# @option params [required, String] :source
|
1472
1497
|
# The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
|
1473
1498
|
#
|
1474
|
-
# <note markdown="1"> The source name can't contain the following strings: aws
|
1475
|
-
# amzn
|
1499
|
+
# <note markdown="1"> The source name can't contain the following strings: `aws`, `amazon`,
|
1500
|
+
# and `amzn`.
|
1476
1501
|
#
|
1477
1502
|
# </note>
|
1478
1503
|
#
|
@@ -1484,15 +1509,16 @@ module Aws::SSM
|
|
1484
1509
|
# Optional metadata that you assign to a resource. You can restrict
|
1485
1510
|
# access to OpsItems by using an inline IAM policy that specifies tags.
|
1486
1511
|
# For more information, see [Getting started with OpsCenter][1] in the
|
1487
|
-
# *
|
1512
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
1488
1513
|
#
|
1489
1514
|
# Tags use a key-value pair. For example:
|
1490
1515
|
#
|
1491
1516
|
# `Key=Department,Value=Finance`
|
1492
1517
|
#
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
#
|
1518
|
+
# To add tags to a new OpsItem, a user must have IAM permissions for
|
1519
|
+
# both the `ssm:CreateOpsItems` operation and the
|
1520
|
+
# `ssm:AddTagsToResource` operation. To add tags to an existing OpsItem,
|
1521
|
+
# use the AddTagsToResource operation.
|
1496
1522
|
#
|
1497
1523
|
#
|
1498
1524
|
#
|
@@ -1576,9 +1602,9 @@ module Aws::SSM
|
|
1576
1602
|
req.send_request(options)
|
1577
1603
|
end
|
1578
1604
|
|
1579
|
-
# If you create a new application in Application Manager,
|
1580
|
-
# Manager calls this API
|
1581
|
-
# application, including the application type.
|
1605
|
+
# If you create a new application in Application Manager, Amazon Web
|
1606
|
+
# Services Systems Manager calls this API operation to specify
|
1607
|
+
# information about the new application, including the application type.
|
1582
1608
|
#
|
1583
1609
|
# @option params [required, String] :resource_id
|
1584
1610
|
# A resource ID for a new Application Manager application.
|
@@ -1591,8 +1617,8 @@ module Aws::SSM
|
|
1591
1617
|
# maximum of five tags for an OpsMetadata object. Tags enable you to
|
1592
1618
|
# categorize a resource in different ways, such as by purpose, owner, or
|
1593
1619
|
# environment. For example, you might want to tag an OpsMetadata object
|
1594
|
-
# to identify an environment or target
|
1595
|
-
#
|
1620
|
+
# to identify an environment or target Region. In this case, you could
|
1621
|
+
# specify the following key-value pairs:
|
1596
1622
|
#
|
1597
1623
|
# * `Key=Environment,Value=Production`
|
1598
1624
|
#
|
@@ -1634,18 +1660,14 @@ module Aws::SSM
|
|
1634
1660
|
|
1635
1661
|
# Creates a patch baseline.
|
1636
1662
|
#
|
1637
|
-
# <note markdown="1"> For information about valid key
|
1638
|
-
#
|
1663
|
+
# <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
|
1664
|
+
# supported operating system type, see PatchFilter.
|
1639
1665
|
#
|
1640
1666
|
# </note>
|
1641
1667
|
#
|
1642
|
-
#
|
1643
|
-
#
|
1644
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
|
1645
|
-
#
|
1646
1668
|
# @option params [String] :operating_system
|
1647
1669
|
# Defines the operating system the patch baseline applies to. The
|
1648
|
-
#
|
1670
|
+
# default value is `WINDOWS`.
|
1649
1671
|
#
|
1650
1672
|
# @option params [required, String] :name
|
1651
1673
|
# The name of the patch baseline.
|
@@ -1661,7 +1683,8 @@ module Aws::SSM
|
|
1661
1683
|
#
|
1662
1684
|
# For information about accepted formats for lists of approved patches
|
1663
1685
|
# and rejected patches, see [About package name formats for approved and
|
1664
|
-
# rejected patch lists][1] in the *
|
1686
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
1687
|
+
# User Guide*.
|
1665
1688
|
#
|
1666
1689
|
#
|
1667
1690
|
#
|
@@ -1670,19 +1693,20 @@ module Aws::SSM
|
|
1670
1693
|
# @option params [String] :approved_patches_compliance_level
|
1671
1694
|
# Defines the compliance level for approved patches. When an approved
|
1672
1695
|
# patch is reported as missing, this value describes the severity of the
|
1673
|
-
# compliance violation. The default value is UNSPECIFIED
|
1696
|
+
# compliance violation. The default value is `UNSPECIFIED`.
|
1674
1697
|
#
|
1675
1698
|
# @option params [Boolean] :approved_patches_enable_non_security
|
1676
1699
|
# Indicates whether the list of approved patches includes non-security
|
1677
1700
|
# updates that should be applied to the instances. The default value is
|
1678
|
-
#
|
1701
|
+
# `false`. Applies to Linux instances only.
|
1679
1702
|
#
|
1680
1703
|
# @option params [Array<String>] :rejected_patches
|
1681
1704
|
# A list of explicitly rejected patches for the baseline.
|
1682
1705
|
#
|
1683
1706
|
# For information about accepted formats for lists of approved patches
|
1684
1707
|
# and rejected patches, see [About package name formats for approved and
|
1685
|
-
# rejected patch lists][1] in the *
|
1708
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
1709
|
+
# User Guide*.
|
1686
1710
|
#
|
1687
1711
|
#
|
1688
1712
|
#
|
@@ -1690,19 +1714,20 @@ module Aws::SSM
|
|
1690
1714
|
#
|
1691
1715
|
# @option params [String] :rejected_patches_action
|
1692
1716
|
# The action for Patch Manager to take on patches included in the
|
1693
|
-
# RejectedPackages list.
|
1717
|
+
# `RejectedPackages` list.
|
1694
1718
|
#
|
1695
|
-
# *
|
1696
|
-
# is installed only if it is a dependency of
|
1697
|
-
# considered compliant with the patch baseline,
|
1698
|
-
# reported as
|
1699
|
-
# option is specified.
|
1719
|
+
# * <b> <code>ALLOW_AS_DEPENDENCY</code> </b>\: A package in the
|
1720
|
+
# `Rejected` patches list is installed only if it is a dependency of
|
1721
|
+
# another package. It is considered compliant with the patch baseline,
|
1722
|
+
# and its status is reported as `InstalledOther`. This is the default
|
1723
|
+
# action if no option is specified.
|
1700
1724
|
#
|
1701
|
-
# *
|
1702
|
-
# include them as dependencies,
|
1703
|
-
# circumstances. If a package was installed before
|
1704
|
-
# Rejected patches list, it is considered
|
1705
|
-
# baseline, and its status is reported as
|
1725
|
+
# * <b> <code>BLOCK</code> </b>\: Packages in the `RejectedPatches`
|
1726
|
+
# list, and packages that include them as dependencies, aren't
|
1727
|
+
# installed under any circumstances. If a package was installed before
|
1728
|
+
# it was added to the Rejected patches list, it is considered
|
1729
|
+
# non-compliant with the patch baseline, and its status is reported as
|
1730
|
+
# `InstalledRejected`.
|
1706
1731
|
#
|
1707
1732
|
# @option params [String] :description
|
1708
1733
|
# A description of the patch baseline.
|
@@ -1724,14 +1749,14 @@ module Aws::SSM
|
|
1724
1749
|
# environment. For example, you might want to tag a patch baseline to
|
1725
1750
|
# identify the severity level of patches it specifies and the operating
|
1726
1751
|
# system family it applies to. In this case, you could specify the
|
1727
|
-
# following key
|
1752
|
+
# following key-value pairs:
|
1728
1753
|
#
|
1729
1754
|
# * `Key=PatchSeverity,Value=Critical`
|
1730
1755
|
#
|
1731
1756
|
# * `Key=OS,Value=Windows`
|
1732
1757
|
#
|
1733
1758
|
# <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
|
1734
|
-
#
|
1759
|
+
# operation.
|
1735
1760
|
#
|
1736
1761
|
# </note>
|
1737
1762
|
#
|
@@ -1806,30 +1831,30 @@ module Aws::SSM
|
|
1806
1831
|
end
|
1807
1832
|
|
1808
1833
|
# A resource data sync helps you view data from multiple sources in a
|
1809
|
-
# single location. Systems Manager offers two types
|
1810
|
-
# sync: `SyncToDestination` and `SyncFromSource`.
|
1834
|
+
# single location. Amazon Web Services Systems Manager offers two types
|
1835
|
+
# of resource data sync: `SyncToDestination` and `SyncFromSource`.
|
1811
1836
|
#
|
1812
1837
|
# You can configure Systems Manager Inventory to use the
|
1813
1838
|
# `SyncToDestination` type to synchronize Inventory data from multiple
|
1814
|
-
#
|
1815
|
-
#
|
1816
|
-
# Manager User Guide*.
|
1839
|
+
# Regions to a single Amazon Simple Storage Service (Amazon S3) bucket.
|
1840
|
+
# For more information, see [Configuring resource data sync for
|
1841
|
+
# Inventory][1] in the *Amazon Web Services Systems Manager User Guide*.
|
1817
1842
|
#
|
1818
1843
|
# You can configure Systems Manager Explorer to use the `SyncFromSource`
|
1819
1844
|
# type to synchronize operational work items (OpsItems) and operational
|
1820
|
-
# data (OpsData) from multiple
|
1821
|
-
# type can synchronize OpsItems and OpsData from multiple
|
1822
|
-
# and Regions or `EntireOrganization` by using
|
1823
|
-
#
|
1824
|
-
#
|
1825
|
-
# Manager User Guide*.
|
1845
|
+
# data (OpsData) from multiple Regions to a single Amazon S3 bucket.
|
1846
|
+
# This type can synchronize OpsItems and OpsData from multiple accounts
|
1847
|
+
# and Regions or `EntireOrganization` by using Organizations. For more
|
1848
|
+
# information, see [Setting up Systems Manager Explorer to display data
|
1849
|
+
# from multiple accounts and Regions][2] in the *Amazon Web Services
|
1850
|
+
# Systems Manager User Guide*.
|
1826
1851
|
#
|
1827
1852
|
# A resource data sync is an asynchronous operation that returns
|
1828
1853
|
# immediately. After a successful initial sync is completed, the system
|
1829
1854
|
# continuously syncs data. To check the status of a sync, use the
|
1830
1855
|
# ListResourceDataSync.
|
1831
1856
|
#
|
1832
|
-
# <note markdown="1"> By default, data
|
1857
|
+
# <note markdown="1"> By default, data isn't encrypted in Amazon S3. We strongly recommend
|
1833
1858
|
# that you enable encryption in Amazon S3 to ensure secure data storage.
|
1834
1859
|
# We also recommend that you secure access to the Amazon S3 bucket by
|
1835
1860
|
# creating a restrictive bucket policy.
|
@@ -1853,9 +1878,9 @@ module Aws::SSM
|
|
1853
1878
|
# synchronizes data to an S3 bucket for Inventory. If you specify
|
1854
1879
|
# `SyncToDestination`, you must provide a value for `S3Destination`.
|
1855
1880
|
# Specify `SyncFromSource` to synchronize data from a single account and
|
1856
|
-
# multiple Regions, or multiple
|
1857
|
-
#
|
1858
|
-
#
|
1881
|
+
# multiple Regions, or multiple accounts and Regions, as listed in
|
1882
|
+
# Organizations for Explorer. If you specify `SyncFromSource`, you must
|
1883
|
+
# provide a value for `SyncSource`. The default value is
|
1859
1884
|
# `SyncToDestination`.
|
1860
1885
|
#
|
1861
1886
|
# @option params [Types::ResourceDataSyncSource] :sync_source
|
@@ -1904,9 +1929,9 @@ module Aws::SSM
|
|
1904
1929
|
req.send_request(options)
|
1905
1930
|
end
|
1906
1931
|
|
1907
|
-
# Deletes an activation. You
|
1932
|
+
# Deletes an activation. You aren't required to delete an activation.
|
1908
1933
|
# If you delete an activation, you can no longer use it to register
|
1909
|
-
# additional managed instances. Deleting an activation
|
1934
|
+
# additional managed instances. Deleting an activation doesn't
|
1910
1935
|
# de-register managed instances. You must manually de-register managed
|
1911
1936
|
# instances.
|
1912
1937
|
#
|
@@ -1930,17 +1955,17 @@ module Aws::SSM
|
|
1930
1955
|
req.send_request(options)
|
1931
1956
|
end
|
1932
1957
|
|
1933
|
-
# Disassociates the specified
|
1934
|
-
# specified instance.
|
1958
|
+
# Disassociates the specified Amazon Web Services Systems Manager
|
1959
|
+
# document (SSM document) from the specified instance.
|
1935
1960
|
#
|
1936
|
-
# When you disassociate a document from an instance, it
|
1961
|
+
# When you disassociate a document from an instance, it doesn't change
|
1937
1962
|
# the configuration of the instance. To change the configuration state
|
1938
1963
|
# of an instance after you disassociate a document, you must create a
|
1939
1964
|
# new document with the desired configuration and associate it with the
|
1940
1965
|
# instance.
|
1941
1966
|
#
|
1942
1967
|
# @option params [String] :name
|
1943
|
-
# The name of the
|
1968
|
+
# The name of the SSM document.
|
1944
1969
|
#
|
1945
1970
|
# @option params [String] :instance_id
|
1946
1971
|
# The ID of the instance.
|
@@ -1967,8 +1992,8 @@ module Aws::SSM
|
|
1967
1992
|
req.send_request(options)
|
1968
1993
|
end
|
1969
1994
|
|
1970
|
-
# Deletes the Systems Manager document
|
1971
|
-
# the document.
|
1995
|
+
# Deletes the Amazon Web Services Systems Manager document (SSM
|
1996
|
+
# document) and all instance associations to the document.
|
1972
1997
|
#
|
1973
1998
|
# Before you delete the document, we recommend that you use
|
1974
1999
|
# DeleteAssociation to disassociate all instances that are associated
|
@@ -1989,8 +2014,8 @@ module Aws::SSM
|
|
1989
2014
|
# Some SSM document types require that you specify a `Force` flag before
|
1990
2015
|
# you can delete the document. For example, you must specify a `Force`
|
1991
2016
|
# flag to delete a document of type `ApplicationConfigurationSchema`.
|
1992
|
-
# You can restrict access to the `Force` flag in an
|
1993
|
-
#
|
2017
|
+
# You can restrict access to the `Force` flag in an Identity and Access
|
2018
|
+
# Management (IAM) policy.
|
1994
2019
|
#
|
1995
2020
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1996
2021
|
#
|
@@ -2028,8 +2053,8 @@ module Aws::SSM
|
|
2028
2053
|
#
|
2029
2054
|
# DisableSchema: If you choose this option, the system ignores all
|
2030
2055
|
# inventory data for the specified version, and any earlier versions. To
|
2031
|
-
# enable this schema again, you must call the `PutInventory`
|
2032
|
-
# a version greater than the disabled version.
|
2056
|
+
# enable this schema again, you must call the `PutInventory` operation
|
2057
|
+
# for a version greater than the disabled version.
|
2033
2058
|
#
|
2034
2059
|
# DeleteSchema: This option deletes the specified custom type from the
|
2035
2060
|
# Inventory service. You can recreate the schema later, if you want.
|
@@ -2214,9 +2239,9 @@ module Aws::SSM
|
|
2214
2239
|
req.send_request(options)
|
2215
2240
|
end
|
2216
2241
|
|
2217
|
-
# Deletes a
|
2242
|
+
# Deletes a resource data sync configuration. After the configuration is
|
2218
2243
|
# deleted, changes to data on managed instances are no longer synced to
|
2219
|
-
# or from the target. Deleting a sync configuration
|
2244
|
+
# or from the target. Deleting a sync configuration doesn't delete
|
2220
2245
|
# data.
|
2221
2246
|
#
|
2222
2247
|
# @option params [required, String] :sync_name
|
@@ -2314,7 +2339,7 @@ module Aws::SSM
|
|
2314
2339
|
#
|
2315
2340
|
# @option params [Boolean] :safe
|
2316
2341
|
# The system checks if the target is being referenced by a task. If the
|
2317
|
-
# target is being referenced, the system returns an error and
|
2342
|
+
# target is being referenced, the system returns an error and doesn't
|
2318
2343
|
# deregister the target from the maintenance window.
|
2319
2344
|
#
|
2320
2345
|
# @return [Types::DeregisterTargetFromMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2379,9 +2404,9 @@ module Aws::SSM
|
|
2379
2404
|
end
|
2380
2405
|
|
2381
2406
|
# Describes details about the activation, such as the date and time the
|
2382
|
-
# activation was created, its expiration date, the
|
2383
|
-
# the instances in the activation, and
|
2384
|
-
# registered by using this activation.
|
2407
|
+
# activation was created, its expiration date, the Identity and Access
|
2408
|
+
# Management (IAM) role assigned to the instances in the activation, and
|
2409
|
+
# the number of instances registered by using this activation.
|
2385
2410
|
#
|
2386
2411
|
# @option params [Array<Types::DescribeActivationsFilter>] :filters
|
2387
2412
|
# A filter to view information about your activations.
|
@@ -2444,12 +2469,12 @@ module Aws::SSM
|
|
2444
2469
|
# Describes the association for the specified target or instance. If you
|
2445
2470
|
# created the association by using the `Targets` parameter, then you
|
2446
2471
|
# must retrieve the association by using the association ID. If you
|
2447
|
-
# created the association by specifying an instance ID and
|
2448
|
-
# Manager document, then you retrieve
|
2449
|
-
# document name and the instance ID.
|
2472
|
+
# created the association by specifying an instance ID and an Amazon Web
|
2473
|
+
# Services Systems Manager document (SSM document), then you retrieve
|
2474
|
+
# the association by specifying the document name and the instance ID.
|
2450
2475
|
#
|
2451
2476
|
# @option params [String] :name
|
2452
|
-
# The name of the
|
2477
|
+
# The name of the SSM document.
|
2453
2478
|
#
|
2454
2479
|
# @option params [String] :instance_id
|
2455
2480
|
# The instance ID.
|
@@ -2534,8 +2559,8 @@ module Aws::SSM
|
|
2534
2559
|
req.send_request(options)
|
2535
2560
|
end
|
2536
2561
|
|
2537
|
-
#
|
2538
|
-
#
|
2562
|
+
# Views information about a specific execution of a specific
|
2563
|
+
# association.
|
2539
2564
|
#
|
2540
2565
|
# @option params [required, String] :association_id
|
2541
2566
|
# The association ID that includes the execution for which you want to
|
@@ -2609,8 +2634,7 @@ module Aws::SSM
|
|
2609
2634
|
req.send_request(options)
|
2610
2635
|
end
|
2611
2636
|
|
2612
|
-
#
|
2613
|
-
# ID.
|
2637
|
+
# Views all executions for a specific association ID.
|
2614
2638
|
#
|
2615
2639
|
# @option params [required, String] :association_id
|
2616
2640
|
# The association ID for which you want to view execution history
|
@@ -2890,7 +2914,98 @@ module Aws::SSM
|
|
2890
2914
|
# Lists all patches eligible to be included in a patch baseline.
|
2891
2915
|
#
|
2892
2916
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
2893
|
-
#
|
2917
|
+
# Each element in the array is a structure containing a key-value pair.
|
2918
|
+
#
|
2919
|
+
# **Windows Server**
|
2920
|
+
#
|
2921
|
+
# Supported keys for Windows Server instance patches include the
|
2922
|
+
# following:
|
2923
|
+
#
|
2924
|
+
# * <b> <code>PATCH_SET</code> </b>
|
2925
|
+
#
|
2926
|
+
# Sample values: `OS` \| `APPLICATION`
|
2927
|
+
#
|
2928
|
+
# * <b> <code>PRODUCT</code> </b>
|
2929
|
+
#
|
2930
|
+
# Sample values: `WindowsServer2012` \| `Office 2010` \|
|
2931
|
+
# `MicrosoftDefenderAntivirus`
|
2932
|
+
#
|
2933
|
+
# * <b> <code>PRODUCT_FAMILY</code> </b>
|
2934
|
+
#
|
2935
|
+
# Sample values: `Windows` \| `Office`
|
2936
|
+
#
|
2937
|
+
# * <b> <code>MSRC_SEVERITY</code> </b>
|
2938
|
+
#
|
2939
|
+
# Sample values: `ServicePacks` \| `Important` \| `Moderate`
|
2940
|
+
#
|
2941
|
+
# * <b> <code>CLASSIFICATION</code> </b>
|
2942
|
+
#
|
2943
|
+
# Sample values: `ServicePacks` \| `SecurityUpdates` \|
|
2944
|
+
# `DefinitionUpdates`
|
2945
|
+
#
|
2946
|
+
# * <b> <code>PATCH_ID</code> </b>
|
2947
|
+
#
|
2948
|
+
# Sample values: `KB123456` \| `KB4516046`
|
2949
|
+
#
|
2950
|
+
# **Linux**
|
2951
|
+
#
|
2952
|
+
# When specifying filters for Linux patches, you must specify a key-pair
|
2953
|
+
# for `PRODUCT`. For example, using the Command Line Interface (CLI),
|
2954
|
+
# the following command fails:
|
2955
|
+
#
|
2956
|
+
# `aws ssm describe-available-patches --filters
|
2957
|
+
# Key=CVE_ID,Values=CVE-2018-3615`
|
2958
|
+
#
|
2959
|
+
# However, the following command succeeds:
|
2960
|
+
#
|
2961
|
+
# `aws ssm describe-available-patches --filters
|
2962
|
+
# Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615`
|
2963
|
+
#
|
2964
|
+
# Supported keys for Linux instance patches include the following:
|
2965
|
+
#
|
2966
|
+
# * <b> <code>PRODUCT</code> </b>
|
2967
|
+
#
|
2968
|
+
# Sample values: `AmazonLinux2018.03` \| `AmazonLinux2.0`
|
2969
|
+
#
|
2970
|
+
# * <b> <code>NAME</code> </b>
|
2971
|
+
#
|
2972
|
+
# Sample values: `kernel-headers` \| `samba-python` \| `php`
|
2973
|
+
#
|
2974
|
+
# * <b> <code>SEVERITY</code> </b>
|
2975
|
+
#
|
2976
|
+
# Sample values: `Critical` \| `Important` \| `Medium` \| `Low`
|
2977
|
+
#
|
2978
|
+
# * <b> <code>EPOCH</code> </b>
|
2979
|
+
#
|
2980
|
+
# Sample values: `0` \| `1`
|
2981
|
+
#
|
2982
|
+
# * <b> <code>VERSION</code> </b>
|
2983
|
+
#
|
2984
|
+
# Sample values: `78.6.1` \| `4.10.16`
|
2985
|
+
#
|
2986
|
+
# * <b> <code>RELEASE</code> </b>
|
2987
|
+
#
|
2988
|
+
# Sample values: `9.56.amzn1` \| `1.amzn2`
|
2989
|
+
#
|
2990
|
+
# * <b> <code>ARCH</code> </b>
|
2991
|
+
#
|
2992
|
+
# Sample values: `i686` \| `x86_64`
|
2993
|
+
#
|
2994
|
+
# * <b> <code>REPOSITORY</code> </b>
|
2995
|
+
#
|
2996
|
+
# Sample values: `Core` \| `Updates`
|
2997
|
+
#
|
2998
|
+
# * <b> <code>ADVISORY_ID</code> </b>
|
2999
|
+
#
|
3000
|
+
# Sample values: `ALAS-2018-1058` \| `ALAS2-2021-1594`
|
3001
|
+
#
|
3002
|
+
# * <b> <code>CVE_ID</code> </b>
|
3003
|
+
#
|
3004
|
+
# Sample values: `CVE-2018-3615` \| `CVE-2020-1472`
|
3005
|
+
#
|
3006
|
+
# * <b> <code>BUGZILLA_ID</code> </b>
|
3007
|
+
#
|
3008
|
+
# Sample values: `1463241`
|
2894
3009
|
#
|
2895
3010
|
# @option params [Integer] :max_results
|
2896
3011
|
# The maximum number of patches to return (per page).
|
@@ -2959,10 +3074,11 @@ module Aws::SSM
|
|
2959
3074
|
req.send_request(options)
|
2960
3075
|
end
|
2961
3076
|
|
2962
|
-
# Describes the specified Systems Manager document
|
3077
|
+
# Describes the specified Amazon Web Services Systems Manager document
|
3078
|
+
# (SSM document).
|
2963
3079
|
#
|
2964
3080
|
# @option params [required, String] :name
|
2965
|
-
# The name of the
|
3081
|
+
# The name of the SSM document.
|
2966
3082
|
#
|
2967
3083
|
# @option params [String] :document_version
|
2968
3084
|
# The document version for which you want information. Can be a specific
|
@@ -2971,7 +3087,7 @@ module Aws::SSM
|
|
2971
3087
|
# @option params [String] :version_name
|
2972
3088
|
# An optional field specifying the version of the artifact associated
|
2973
3089
|
# with the document. For example, "Release 12, Update 6". This value
|
2974
|
-
# is unique across all versions of a document, and
|
3090
|
+
# is unique across all versions of a document, and can't be changed.
|
2975
3091
|
#
|
2976
3092
|
# @return [Types::DescribeDocumentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2977
3093
|
#
|
@@ -3038,10 +3154,10 @@ module Aws::SSM
|
|
3038
3154
|
req.send_request(options)
|
3039
3155
|
end
|
3040
3156
|
|
3041
|
-
# Describes the permissions for a
|
3042
|
-
#
|
3043
|
-
# can either be shared privately (by
|
3044
|
-
# ID) or publicly (*All*).
|
3157
|
+
# Describes the permissions for a Amazon Web Services Systems Manager
|
3158
|
+
# document (SSM document). If you created the document, you are the
|
3159
|
+
# owner. If a document is shared, it can either be shared privately (by
|
3160
|
+
# specifying a user's account ID) or publicly (*All*).
|
3045
3161
|
#
|
3046
3162
|
# @option params [required, String] :name
|
3047
3163
|
# The name of the document for which you are the owner.
|
@@ -3140,8 +3256,8 @@ module Aws::SSM
|
|
3140
3256
|
end
|
3141
3257
|
|
3142
3258
|
# Retrieves the current effective patches (the patch and the approval
|
3143
|
-
# state) for the specified patch baseline.
|
3144
|
-
#
|
3259
|
+
# state) for the specified patch baseline. Applies to patch baselines
|
3260
|
+
# for Windows only.
|
3145
3261
|
#
|
3146
3262
|
# @option params [required, String] :baseline_id
|
3147
3263
|
# The ID of the patch baseline to retrieve the effective patches for.
|
@@ -3271,13 +3387,13 @@ module Aws::SSM
|
|
3271
3387
|
# the instance, instance status, and so on.
|
3272
3388
|
#
|
3273
3389
|
# If you specify one or more instance IDs, it returns information for
|
3274
|
-
# those instances. If you
|
3390
|
+
# those instances. If you don't specify instance IDs, it returns
|
3275
3391
|
# information for all your instances. If you specify an instance ID that
|
3276
|
-
#
|
3392
|
+
# isn't valid or an instance that you don't own, you receive an error.
|
3277
3393
|
#
|
3278
|
-
# <note markdown="1"> The IamRole field for this API
|
3279
|
-
#
|
3280
|
-
#
|
3394
|
+
# <note markdown="1"> The `IamRole` field for this API operation is the Identity and Access
|
3395
|
+
# Management (IAM) role assigned to on-premises instances. This call
|
3396
|
+
# doesn't return the IAM role for EC2 instances.
|
3281
3397
|
#
|
3282
3398
|
# </note>
|
3283
3399
|
#
|
@@ -3371,7 +3487,7 @@ module Aws::SSM
|
|
3371
3487
|
# Retrieves the high-level patch state of one or more instances.
|
3372
3488
|
#
|
3373
3489
|
# @option params [required, Array<String>] :instance_ids
|
3374
|
-
# The ID of the instance
|
3490
|
+
# The ID of the instance for which patch state information should be
|
3375
3491
|
# retrieved.
|
3376
3492
|
#
|
3377
3493
|
# @option params [String] :next_token
|
@@ -3442,11 +3558,11 @@ module Aws::SSM
|
|
3442
3558
|
# @option params [Array<Types::InstancePatchStateFilter>] :filters
|
3443
3559
|
# Each entry in the array is a structure containing:
|
3444
3560
|
#
|
3445
|
-
# Key (string between 1 and 200 characters)
|
3561
|
+
# * Key (string between 1 and 200 characters)
|
3446
3562
|
#
|
3447
|
-
# Values (array containing a single string)
|
3563
|
+
# * Values (array containing a single string)
|
3448
3564
|
#
|
3449
|
-
# Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
|
3565
|
+
# * Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
|
3450
3566
|
#
|
3451
3567
|
# @option params [String] :next_token
|
3452
3568
|
# The token for the next set of items to return. (You received this
|
@@ -3522,9 +3638,26 @@ module Aws::SSM
|
|
3522
3638
|
# retrieved.
|
3523
3639
|
#
|
3524
3640
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3525
|
-
#
|
3526
|
-
#
|
3527
|
-
#
|
3641
|
+
# Each element in the array is a structure containing a key-value pair.
|
3642
|
+
#
|
3643
|
+
# Supported keys for `DescribeInstancePatches`include the following:
|
3644
|
+
#
|
3645
|
+
# * <b> <code>Classification</code> </b>
|
3646
|
+
#
|
3647
|
+
# Sample values: `Security` \| `SecurityUpdates`
|
3648
|
+
#
|
3649
|
+
# * <b> <code>KBId</code> </b>
|
3650
|
+
#
|
3651
|
+
# Sample values: `KB4480056` \| `java-1.7.0-openjdk.x86_64`
|
3652
|
+
#
|
3653
|
+
# * <b> <code>Severity</code> </b>
|
3654
|
+
#
|
3655
|
+
# Sample values: `Important` \| `Medium` \| `Low`
|
3656
|
+
#
|
3657
|
+
# * <b> <code>State</code> </b>
|
3658
|
+
#
|
3659
|
+
# Sample values: `Installed` \| `InstalledOther` \|
|
3660
|
+
# `InstalledPendingReboot`
|
3528
3661
|
#
|
3529
3662
|
# @option params [String] :next_token
|
3530
3663
|
# The token for the next set of items to return. (You received this
|
@@ -3579,7 +3712,7 @@ module Aws::SSM
|
|
3579
3712
|
#
|
3580
3713
|
# @option params [String] :deletion_id
|
3581
3714
|
# Specify the delete inventory ID for which you want information. This
|
3582
|
-
# ID was returned by the `DeleteInventory`
|
3715
|
+
# ID was returned by the `DeleteInventory` operation.
|
3583
3716
|
#
|
3584
3717
|
# @option params [String] :next_token
|
3585
3718
|
# A token to start the list. Use this token to get the next set of
|
@@ -3643,8 +3776,9 @@ module Aws::SSM
|
|
3643
3776
|
#
|
3644
3777
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3645
3778
|
# Optional filters used to scope down the returned task invocations. The
|
3646
|
-
# supported filter key is STATUS with the corresponding values
|
3647
|
-
#
|
3779
|
+
# supported filter key is `STATUS` with the corresponding values
|
3780
|
+
# `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`,
|
3781
|
+
# `CANCELLING`, and `CANCELLED`.
|
3648
3782
|
#
|
3649
3783
|
# @option params [Integer] :max_results
|
3650
3784
|
# The maximum number of items to return for this call. The call also
|
@@ -3712,8 +3846,9 @@ module Aws::SSM
|
|
3712
3846
|
#
|
3713
3847
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3714
3848
|
# Optional filters used to scope down the returned tasks. The supported
|
3715
|
-
# filter key is STATUS with the corresponding values PENDING
|
3716
|
-
#
|
3849
|
+
# filter key is `STATUS` with the corresponding values `PENDING`,
|
3850
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and
|
3851
|
+
# `CANCELLED`.
|
3717
3852
|
#
|
3718
3853
|
# @option params [Integer] :max_results
|
3719
3854
|
# The maximum number of items to return for this call. The call also
|
@@ -3778,12 +3913,12 @@ module Aws::SSM
|
|
3778
3913
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3779
3914
|
# Each entry in the array is a structure containing:
|
3780
3915
|
#
|
3781
|
-
# Key
|
3782
|
-
#
|
3783
|
-
# Values (array of strings, each string is between 1 and 256 characters)
|
3916
|
+
# * Key. A string between 1 and 128 characters. Supported keys include
|
3917
|
+
# `ExecutedBefore` and `ExecutedAfter`.
|
3784
3918
|
#
|
3785
|
-
#
|
3786
|
-
#
|
3919
|
+
# * Values. An array of strings, each between 1 and 256 characters.
|
3920
|
+
# Supported values are date/time strings in a valid ISO 8601 date/time
|
3921
|
+
# format, such as `2021-11-04T05:00:00Z`.
|
3787
3922
|
#
|
3788
3923
|
# @option params [Integer] :max_results
|
3789
3924
|
# The maximum number of items to return for this call. The call also
|
@@ -3842,11 +3977,11 @@ module Aws::SSM
|
|
3842
3977
|
# The ID of the maintenance window to retrieve information about.
|
3843
3978
|
#
|
3844
3979
|
# @option params [Array<Types::Target>] :targets
|
3845
|
-
# The instance ID or key
|
3980
|
+
# The instance ID or key-value pair to retrieve information about.
|
3846
3981
|
#
|
3847
3982
|
# @option params [String] :resource_type
|
3848
3983
|
# The type of resource you want to retrieve information about. For
|
3849
|
-
# example,
|
3984
|
+
# example, `INSTANCE`.
|
3850
3985
|
#
|
3851
3986
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3852
3987
|
# Filters used to limit the range of results. For example, you can limit
|
@@ -3914,8 +4049,8 @@ module Aws::SSM
|
|
3914
4049
|
#
|
3915
4050
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3916
4051
|
# Optional filters that can be used to narrow down the scope of the
|
3917
|
-
# returned window targets. The supported filter keys are Type
|
3918
|
-
# WindowTargetId and OwnerInformation
|
4052
|
+
# returned window targets. The supported filter keys are `Type`,
|
4053
|
+
# `WindowTargetId`, and `OwnerInformation`.
|
3919
4054
|
#
|
3920
4055
|
# @option params [Integer] :max_results
|
3921
4056
|
# The maximum number of items to return for this call. The call also
|
@@ -3973,10 +4108,10 @@ module Aws::SSM
|
|
3973
4108
|
|
3974
4109
|
# Lists the tasks in a maintenance window.
|
3975
4110
|
#
|
3976
|
-
# <note markdown="1"> For maintenance window tasks without a specified target, you
|
4111
|
+
# <note markdown="1"> For maintenance window tasks without a specified target, you can't
|
3977
4112
|
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
3978
4113
|
# system inserts a placeholder value of `1`, which may be reported in
|
3979
|
-
# the response to this command. These values
|
4114
|
+
# the response to this command. These values don't affect the running
|
3980
4115
|
# of your task and can be ignored.
|
3981
4116
|
#
|
3982
4117
|
# </note>
|
@@ -3986,8 +4121,8 @@ module Aws::SSM
|
|
3986
4121
|
#
|
3987
4122
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3988
4123
|
# Optional filters used to narrow down the scope of the returned tasks.
|
3989
|
-
# The supported filter keys are WindowTaskId
|
3990
|
-
# TaskType
|
4124
|
+
# The supported filter keys are `WindowTaskId`, `TaskArn`, `Priority`,
|
4125
|
+
# and `TaskType`.
|
3991
4126
|
#
|
3992
4127
|
# @option params [Integer] :max_results
|
3993
4128
|
# The maximum number of items to return for this call. The call also
|
@@ -4053,12 +4188,12 @@ module Aws::SSM
|
|
4053
4188
|
req.send_request(options)
|
4054
4189
|
end
|
4055
4190
|
|
4056
|
-
# Retrieves the maintenance windows in an
|
4191
|
+
# Retrieves the maintenance windows in an account.
|
4057
4192
|
#
|
4058
4193
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
4059
4194
|
# Optional filters used to narrow down the scope of the returned
|
4060
|
-
# maintenance windows. Supported filter keys are
|
4061
|
-
#
|
4195
|
+
# maintenance windows. Supported filter keys are `Name` and `Enabled`.
|
4196
|
+
# For example, `Name=MyMaintenanceWindow` and `Enabled=True`.
|
4062
4197
|
#
|
4063
4198
|
# @option params [Integer] :max_results
|
4064
4199
|
# The maximum number of items to return for this call. The call also
|
@@ -4119,11 +4254,11 @@ module Aws::SSM
|
|
4119
4254
|
# that an instance is associated with.
|
4120
4255
|
#
|
4121
4256
|
# @option params [required, Array<Types::Target>] :targets
|
4122
|
-
# The instance ID or key
|
4257
|
+
# The instance ID or key-value pair to retrieve information about.
|
4123
4258
|
#
|
4124
4259
|
# @option params [required, String] :resource_type
|
4125
4260
|
# The type of resource you want to retrieve information about. For
|
4126
|
-
# example,
|
4261
|
+
# example, `INSTANCE`.
|
4127
4262
|
#
|
4128
4263
|
# @option params [Integer] :max_results
|
4129
4264
|
# The maximum number of items to return for this call. The call also
|
@@ -4171,16 +4306,17 @@ module Aws::SSM
|
|
4171
4306
|
req.send_request(options)
|
4172
4307
|
end
|
4173
4308
|
|
4174
|
-
# Query a set of OpsItems. You must have permission in
|
4309
|
+
# Query a set of OpsItems. You must have permission in Identity and
|
4175
4310
|
# Access Management (IAM) to query a list of OpsItems. For more
|
4176
|
-
# information, see [Getting started with OpsCenter][1] in the *
|
4177
|
-
# Systems Manager User Guide*.
|
4178
|
-
#
|
4179
|
-
# Operations engineers and IT professionals use
|
4180
|
-
# investigate, and remediate
|
4181
|
-
# performance and health of their
|
4182
|
-
#
|
4183
|
-
# User
|
4311
|
+
# information, see [Getting started with OpsCenter][1] in the *Amazon
|
4312
|
+
# Web Services Systems Manager User Guide*.
|
4313
|
+
#
|
4314
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
4315
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
4316
|
+
# operational issues impacting the performance and health of their
|
4317
|
+
# Amazon Web Services resources. For more information, see
|
4318
|
+
# [OpsCenter][2] in the *Amazon Web Services Systems Manager User
|
4319
|
+
# Guide*.
|
4184
4320
|
#
|
4185
4321
|
#
|
4186
4322
|
#
|
@@ -4214,11 +4350,11 @@ module Aws::SSM
|
|
4214
4350
|
#
|
4215
4351
|
# Operations: Equals
|
4216
4352
|
#
|
4217
|
-
# * Key: Title
|
4353
|
+
# * Key: Title*
|
4218
4354
|
#
|
4219
|
-
# Operations: Contains
|
4355
|
+
# Operations: Equals,Contains
|
4220
4356
|
#
|
4221
|
-
# * Key: OperationalData
|
4357
|
+
# * Key: OperationalData**
|
4222
4358
|
#
|
4223
4359
|
# Operations: Equals
|
4224
4360
|
#
|
@@ -4242,7 +4378,11 @@ module Aws::SSM
|
|
4242
4378
|
#
|
4243
4379
|
# Operations: Equals
|
4244
4380
|
#
|
4245
|
-
# *
|
4381
|
+
# *The Equals operator for Title matches the first 100 characters. If
|
4382
|
+
# you specify more than 100 characters, they system returns an error
|
4383
|
+
# that the filter value exceeds the length limit.
|
4384
|
+
#
|
4385
|
+
# **If you filter the response by using the OperationalData operator,
|
4246
4386
|
# specify a key-value pair by using the following JSON format:
|
4247
4387
|
# \\\{"key":"key\_name","value":"a\_value"\\}
|
4248
4388
|
#
|
@@ -4267,7 +4407,7 @@ module Aws::SSM
|
|
4267
4407
|
# resp = client.describe_ops_items({
|
4268
4408
|
# ops_item_filters: [
|
4269
4409
|
# {
|
4270
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup
|
4410
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup, InsightByType
|
4271
4411
|
# values: ["OpsItemFilterValue"], # required
|
4272
4412
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
4273
4413
|
# },
|
@@ -4286,7 +4426,7 @@ module Aws::SSM
|
|
4286
4426
|
# resp.ops_item_summaries[0].last_modified_time #=> Time
|
4287
4427
|
# resp.ops_item_summaries[0].priority #=> Integer
|
4288
4428
|
# resp.ops_item_summaries[0].source #=> String
|
4289
|
-
# resp.ops_item_summaries[0].status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"
|
4429
|
+
# resp.ops_item_summaries[0].status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected", "Closed"
|
4290
4430
|
# resp.ops_item_summaries[0].ops_item_id #=> String
|
4291
4431
|
# resp.ops_item_summaries[0].title #=> String
|
4292
4432
|
# resp.ops_item_summaries[0].operational_data #=> Hash
|
@@ -4311,7 +4451,7 @@ module Aws::SSM
|
|
4311
4451
|
|
4312
4452
|
# Get information about a parameter.
|
4313
4453
|
#
|
4314
|
-
#
|
4454
|
+
# Request results are returned on a best-effort basis. If you specify
|
4315
4455
|
# `MaxResults` in the request, the response includes information up to
|
4316
4456
|
# the limit specified. The number of items returned, however, can be
|
4317
4457
|
# between zero and the value of `MaxResults`. If the service reaches an
|
@@ -4320,8 +4460,6 @@ module Aws::SSM
|
|
4320
4460
|
# You can specify the `NextToken` in a subsequent call to get the next
|
4321
4461
|
# set of results.
|
4322
4462
|
#
|
4323
|
-
# </note>
|
4324
|
-
#
|
4325
4463
|
# @option params [Array<Types::ParametersFilter>] :filters
|
4326
4464
|
# This data type is deprecated. Instead, use `ParameterFilters`.
|
4327
4465
|
#
|
@@ -4392,15 +4530,24 @@ module Aws::SSM
|
|
4392
4530
|
req.send_request(options)
|
4393
4531
|
end
|
4394
4532
|
|
4395
|
-
# Lists the patch baselines in your
|
4533
|
+
# Lists the patch baselines in your account.
|
4396
4534
|
#
|
4397
4535
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
4398
|
-
# Each element in the array is a structure containing
|
4536
|
+
# Each element in the array is a structure containing a key-value pair.
|
4537
|
+
#
|
4538
|
+
# Supported keys for `DescribePatchBaselines` include the following:
|
4539
|
+
#
|
4540
|
+
# * <b> <code>NAME_PREFIX</code> </b>
|
4541
|
+
#
|
4542
|
+
# Sample values: `AWS-` \| `My-`
|
4399
4543
|
#
|
4400
|
-
#
|
4544
|
+
# * <b> <code>OWNER</code> </b>
|
4401
4545
|
#
|
4402
|
-
#
|
4403
|
-
#
|
4546
|
+
# Sample values: `AWS` \| `Self`
|
4547
|
+
#
|
4548
|
+
# * <b> <code>OPERATING_SYSTEM</code> </b>
|
4549
|
+
#
|
4550
|
+
# Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
|
4404
4551
|
#
|
4405
4552
|
# @option params [Integer] :max_results
|
4406
4553
|
# The maximum number of patch baselines to return (per page).
|
@@ -4448,8 +4595,8 @@ module Aws::SSM
|
|
4448
4595
|
req.send_request(options)
|
4449
4596
|
end
|
4450
4597
|
|
4451
|
-
# Returns high-level aggregated patch compliance state for a
|
4452
|
-
# group.
|
4598
|
+
# Returns high-level aggregated patch compliance state information for a
|
4599
|
+
# patch group.
|
4453
4600
|
#
|
4454
4601
|
# @option params [required, String] :patch_group
|
4455
4602
|
# The name of the patch group whose patch snapshot should be retrieved.
|
@@ -4505,24 +4652,17 @@ module Aws::SSM
|
|
4505
4652
|
# The maximum number of patch groups to return (per page).
|
4506
4653
|
#
|
4507
4654
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
4508
|
-
#
|
4509
|
-
# results.
|
4510
|
-
#
|
4511
|
-
# For `DescribePatchGroups`,valid filter keys include the following:
|
4655
|
+
# Each element in the array is a structure containing a key-value pair.
|
4512
4656
|
#
|
4513
|
-
#
|
4514
|
-
# accepted.
|
4657
|
+
# Supported keys for `DescribePatchGroups` include the following:
|
4515
4658
|
#
|
4516
|
-
# *
|
4517
|
-
# results for. For valid operating system values, see
|
4518
|
-
# GetDefaultPatchBaselineRequest$OperatingSystem in
|
4519
|
-
# CreatePatchBaseline.
|
4659
|
+
# * <b> <code>NAME_PREFIX</code> </b>
|
4520
4660
|
#
|
4521
|
-
#
|
4661
|
+
# Sample values: `AWS-` \| `My-`.
|
4522
4662
|
#
|
4523
|
-
#
|
4663
|
+
# * <b> <code>OPERATING_SYSTEM</code> </b>
|
4524
4664
|
#
|
4525
|
-
#
|
4665
|
+
# Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
|
4526
4666
|
#
|
4527
4667
|
# @option params [String] :next_token
|
4528
4668
|
# The token for the next set of items to return. (You received this
|
@@ -4571,7 +4711,7 @@ module Aws::SSM
|
|
4571
4711
|
# Lists the properties of available patches organized by product,
|
4572
4712
|
# product family, classification, severity, and other properties of
|
4573
4713
|
# available patches. You can use the reported properties in the filters
|
4574
|
-
# you specify in requests for
|
4714
|
+
# you specify in requests for operations such as CreatePatchBaseline,
|
4575
4715
|
# UpdatePatchBaseline, DescribeAvailablePatches, and
|
4576
4716
|
# DescribePatchBaselines.
|
4577
4717
|
#
|
@@ -4580,44 +4720,44 @@ module Aws::SSM
|
|
4580
4720
|
#
|
4581
4721
|
# AMAZON\_LINUX
|
4582
4722
|
#
|
4583
|
-
# : Valid properties: PRODUCT
|
4723
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4584
4724
|
#
|
4585
4725
|
# AMAZON\_LINUX\_2
|
4586
4726
|
#
|
4587
|
-
# : Valid properties: PRODUCT
|
4727
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4588
4728
|
#
|
4589
4729
|
# CENTOS
|
4590
4730
|
#
|
4591
|
-
# : Valid properties: PRODUCT
|
4731
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4592
4732
|
#
|
4593
4733
|
# DEBIAN
|
4594
4734
|
#
|
4595
|
-
# : Valid properties: PRODUCT
|
4735
|
+
# : Valid properties: `PRODUCT` \| `PRIORITY`
|
4596
4736
|
#
|
4597
4737
|
# MACOS
|
4598
4738
|
#
|
4599
|
-
# : Valid properties: PRODUCT
|
4739
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION`
|
4600
4740
|
#
|
4601
4741
|
# ORACLE\_LINUX
|
4602
4742
|
#
|
4603
|
-
# : Valid properties: PRODUCT
|
4743
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4604
4744
|
#
|
4605
4745
|
# REDHAT\_ENTERPRISE\_LINUX
|
4606
4746
|
#
|
4607
|
-
# : Valid properties: PRODUCT
|
4747
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4608
4748
|
#
|
4609
4749
|
# SUSE
|
4610
4750
|
#
|
4611
|
-
# : Valid properties: PRODUCT
|
4751
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4612
4752
|
#
|
4613
4753
|
# UBUNTU
|
4614
4754
|
#
|
4615
|
-
# : Valid properties: PRODUCT
|
4755
|
+
# : Valid properties: `PRODUCT` \| `PRIORITY`
|
4616
4756
|
#
|
4617
4757
|
# WINDOWS
|
4618
4758
|
#
|
4619
|
-
# : Valid properties: PRODUCT
|
4620
|
-
#
|
4759
|
+
# : Valid properties: `PRODUCT` \| `PRODUCT_FAMILY` \| `CLASSIFICATION`
|
4760
|
+
# \| `MSRC_SEVERITY`
|
4621
4761
|
#
|
4622
4762
|
# @option params [required, String] :operating_system
|
4623
4763
|
# The operating system type for which to list patches.
|
@@ -4627,8 +4767,8 @@ module Aws::SSM
|
|
4627
4767
|
#
|
4628
4768
|
# @option params [String] :patch_set
|
4629
4769
|
# Indicates whether to list patches for the Windows operating system or
|
4630
|
-
# for Microsoft
|
4631
|
-
# operating systems.
|
4770
|
+
# for applications released by Microsoft. Not applicable for the Linux
|
4771
|
+
# or macOS operating systems.
|
4632
4772
|
#
|
4633
4773
|
# @option params [Integer] :max_results
|
4634
4774
|
# The maximum number of items to return for this call. The call also
|
@@ -4738,8 +4878,9 @@ module Aws::SSM
|
|
4738
4878
|
end
|
4739
4879
|
|
4740
4880
|
# Deletes the association between an OpsItem and a related resource. For
|
4741
|
-
# example, this API
|
4742
|
-
# an OpsItem. Incident Manager is a capability of
|
4881
|
+
# example, this API operation can delete an Incident Manager incident
|
4882
|
+
# from an OpsItem. Incident Manager is a capability of Amazon Web
|
4883
|
+
# Services Systems Manager.
|
4743
4884
|
#
|
4744
4885
|
# @option params [required, String] :ops_item_id
|
4745
4886
|
# The ID of the OpsItem for which you want to delete an association
|
@@ -4772,7 +4913,7 @@ module Aws::SSM
|
|
4772
4913
|
# @option params [required, String] :automation_execution_id
|
4773
4914
|
# The unique identifier for an existing automation execution to examine.
|
4774
4915
|
# The execution ID is returned by StartAutomationExecution when the
|
4775
|
-
# execution of an Automation
|
4916
|
+
# execution of an Automation runbook is initiated.
|
4776
4917
|
#
|
4777
4918
|
# @return [Types::GetAutomationExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4778
4919
|
#
|
@@ -4911,20 +5052,22 @@ module Aws::SSM
|
|
4911
5052
|
req.send_request(options)
|
4912
5053
|
end
|
4913
5054
|
|
4914
|
-
# Gets the state of
|
4915
|
-
#
|
4916
|
-
# returns the state of the calendar at
|
4917
|
-
#
|
4918
|
-
#
|
4919
|
-
#
|
5055
|
+
# Gets the state of a Amazon Web Services Systems Manager change
|
5056
|
+
# calendar at the current time or a specified time. If you specify a
|
5057
|
+
# time, `GetCalendarState` returns the state of the calendar at that
|
5058
|
+
# specific time, and returns the next time that the change calendar
|
5059
|
+
# state will transition. If you don't specify a time,
|
5060
|
+
# `GetCalendarState` uses the current time. Change Calendar entries have
|
5061
|
+
# two possible states: `OPEN` or `CLOSED`.
|
4920
5062
|
#
|
4921
5063
|
# If you specify more than one calendar in a request, the command
|
4922
5064
|
# returns the status of `OPEN` only if all calendars in the request are
|
4923
5065
|
# open. If one or more calendars in the request are closed, the status
|
4924
5066
|
# returned is `CLOSED`.
|
4925
5067
|
#
|
4926
|
-
# For more information about
|
4927
|
-
# Systems Manager
|
5068
|
+
# For more information about Change Calendar, a capability of Amazon Web
|
5069
|
+
# Services Systems Manager, see [Amazon Web Services Systems Manager
|
5070
|
+
# Change Calendar][1] in the *Amazon Web Services Systems Manager User
|
4928
5071
|
# Guide*.
|
4929
5072
|
#
|
4930
5073
|
#
|
@@ -4933,13 +5076,13 @@ module Aws::SSM
|
|
4933
5076
|
#
|
4934
5077
|
# @option params [required, Array<String>] :calendar_names
|
4935
5078
|
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
4936
|
-
# documents that represent the calendar entries for
|
4937
|
-
# get the state.
|
5079
|
+
# documents (SSM documents) that represent the calendar entries for
|
5080
|
+
# which you want to get the state.
|
4938
5081
|
#
|
4939
5082
|
# @option params [String] :at_time
|
4940
5083
|
# (Optional) The specific time for which you want to get calendar state
|
4941
|
-
# information, in [ISO 8601][1] format. If you
|
4942
|
-
# current time is
|
5084
|
+
# information, in [ISO 8601][1] format. If you don't specify a value or
|
5085
|
+
# `AtTime`, the current time is used.
|
4943
5086
|
#
|
4944
5087
|
#
|
4945
5088
|
#
|
@@ -4988,7 +5131,7 @@ module Aws::SSM
|
|
4988
5131
|
# (Required) The ID of the managed instance targeted by the command. A
|
4989
5132
|
# managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2)
|
4990
5133
|
# instance or an instance in your hybrid environment that is configured
|
4991
|
-
# for
|
5134
|
+
# for Amazon Web Services Systems Manager.
|
4992
5135
|
#
|
4993
5136
|
# @option params [String] :plugin_name
|
4994
5137
|
# The name of the plugin for which you want detailed results. If the
|
@@ -4998,7 +5141,8 @@ module Aws::SSM
|
|
4998
5141
|
# details.
|
4999
5142
|
#
|
5000
5143
|
# Plugin names are also referred to as *step names* in Systems Manager
|
5001
|
-
# documents. For example, `aws:RunShellScript` is a
|
5144
|
+
# documents (SSM documents). For example, `aws:RunShellScript` is a
|
5145
|
+
# plugin.
|
5002
5146
|
#
|
5003
5147
|
# To find the `PluginName`, check the document content and find the name
|
5004
5148
|
# of the plugin. Alternatively, use ListCommandInvocations with the
|
@@ -5100,11 +5244,12 @@ module Aws::SSM
|
|
5100
5244
|
req.send_request(options)
|
5101
5245
|
end
|
5102
5246
|
|
5103
|
-
# Retrieves the default patch baseline.
|
5104
|
-
# supports creating multiple default patch baselines. For
|
5105
|
-
# can create a default patch baseline for each operating
|
5247
|
+
# Retrieves the default patch baseline. Amazon Web Services Systems
|
5248
|
+
# Manager supports creating multiple default patch baselines. For
|
5249
|
+
# example, you can create a default patch baseline for each operating
|
5250
|
+
# system.
|
5106
5251
|
#
|
5107
|
-
# If you
|
5252
|
+
# If you don't specify an operating system value, the default patch
|
5108
5253
|
# baseline for Windows is returned.
|
5109
5254
|
#
|
5110
5255
|
# @option params [String] :operating_system
|
@@ -5136,15 +5281,27 @@ module Aws::SSM
|
|
5136
5281
|
end
|
5137
5282
|
|
5138
5283
|
# Retrieves the current snapshot for the patch baseline the instance
|
5139
|
-
# uses. This API is primarily used by the AWS-RunPatchBaseline Systems
|
5140
|
-
# Manager document.
|
5284
|
+
# uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems
|
5285
|
+
# Manager document (SSM document).
|
5286
|
+
#
|
5287
|
+
# <note markdown="1"> If you run the command locally, such as with the Command Line
|
5288
|
+
# Interface (CLI), the system attempts to use your local AWS credentials
|
5289
|
+
# and the operation fails. To avoid this, you can run the command in the
|
5290
|
+
# Amazon Web Services Systems Manager console. Use Run Command, a
|
5291
|
+
# capability of Amazon Web Services Systems Manager, with an SSM
|
5292
|
+
# document that enables you to target an instance with a script or
|
5293
|
+
# command. For example, run the command using the `AWS-RunShellScript`
|
5294
|
+
# document or the `AWS-RunPowerShellScript` document.
|
5295
|
+
#
|
5296
|
+
# </note>
|
5141
5297
|
#
|
5142
5298
|
# @option params [required, String] :instance_id
|
5143
5299
|
# The ID of the instance for which the appropriate patch snapshot should
|
5144
5300
|
# be retrieved.
|
5145
5301
|
#
|
5146
5302
|
# @option params [required, String] :snapshot_id
|
5147
|
-
# The user
|
5303
|
+
# The snapshot ID provided by the user when running
|
5304
|
+
# `AWS-RunPatchBaseline`.
|
5148
5305
|
#
|
5149
5306
|
# @option params [Types::BaselineOverride] :baseline_override
|
5150
5307
|
# Defines the basic information about a patch baseline override.
|
@@ -5220,10 +5377,11 @@ module Aws::SSM
|
|
5220
5377
|
req.send_request(options)
|
5221
5378
|
end
|
5222
5379
|
|
5223
|
-
# Gets the contents of the specified Systems Manager
|
5380
|
+
# Gets the contents of the specified Amazon Web Services Systems Manager
|
5381
|
+
# document (SSM document).
|
5224
5382
|
#
|
5225
5383
|
# @option params [required, String] :name
|
5226
|
-
# The name of the
|
5384
|
+
# The name of the SSM document.
|
5227
5385
|
#
|
5228
5386
|
# @option params [String] :version_name
|
5229
5387
|
# An optional field specifying the version of the artifact associated
|
@@ -5668,10 +5826,10 @@ module Aws::SSM
|
|
5668
5826
|
|
5669
5827
|
# Lists the tasks in a maintenance window.
|
5670
5828
|
#
|
5671
|
-
# <note markdown="1"> For maintenance window tasks without a specified target, you
|
5829
|
+
# <note markdown="1"> For maintenance window tasks without a specified target, you can't
|
5672
5830
|
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
5673
5831
|
# system inserts a placeholder value of `1`, which may be reported in
|
5674
|
-
# the response to this command. These values
|
5832
|
+
# the response to this command. These values don't affect the running
|
5675
5833
|
# of your task and can be ignored.
|
5676
5834
|
#
|
5677
5835
|
# </note>
|
@@ -5765,15 +5923,16 @@ module Aws::SSM
|
|
5765
5923
|
end
|
5766
5924
|
|
5767
5925
|
# Get information about an OpsItem by using the ID. You must have
|
5768
|
-
# permission in
|
5769
|
-
#
|
5770
|
-
#
|
5771
|
-
#
|
5772
|
-
# Operations engineers and IT professionals use
|
5773
|
-
# investigate, and remediate
|
5774
|
-
# performance and health of their
|
5775
|
-
#
|
5776
|
-
# User
|
5926
|
+
# permission in Identity and Access Management (IAM) to view information
|
5927
|
+
# about an OpsItem. For more information, see [Getting started with
|
5928
|
+
# OpsCenter][1] in the *Amazon Web Services Systems Manager User Guide*.
|
5929
|
+
#
|
5930
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
5931
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
5932
|
+
# operational issues impacting the performance and health of their
|
5933
|
+
# Amazon Web Services resources. For more information, see
|
5934
|
+
# [OpsCenter][2] in the *Amazon Web Services Systems Manager User
|
5935
|
+
# Guide*.
|
5777
5936
|
#
|
5778
5937
|
#
|
5779
5938
|
#
|
@@ -5806,7 +5965,7 @@ module Aws::SSM
|
|
5806
5965
|
# resp.ops_item.priority #=> Integer
|
5807
5966
|
# resp.ops_item.related_ops_items #=> Array
|
5808
5967
|
# resp.ops_item.related_ops_items[0].ops_item_id #=> String
|
5809
|
-
# resp.ops_item.status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"
|
5968
|
+
# resp.ops_item.status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected", "Closed"
|
5810
5969
|
# resp.ops_item.ops_item_id #=> String
|
5811
5970
|
# resp.ops_item.version #=> String
|
5812
5971
|
# resp.ops_item.title #=> String
|
@@ -5875,20 +6034,25 @@ module Aws::SSM
|
|
5875
6034
|
req.send_request(options)
|
5876
6035
|
end
|
5877
6036
|
|
5878
|
-
# View a summary of
|
6037
|
+
# View a summary of operations metadata (OpsData) based on specified
|
6038
|
+
# filters and aggregators. OpsData can include information about Amazon
|
6039
|
+
# Web Services Systems Manager OpsCenter operational workitems
|
6040
|
+
# (OpsItems) as well as information about any Amazon Web Services
|
6041
|
+
# resource or service configured to report OpsData to Amazon Web
|
6042
|
+
# Services Systems Manager Explorer.
|
5879
6043
|
#
|
5880
6044
|
# @option params [String] :sync_name
|
5881
6045
|
# Specify the name of a resource data sync to get.
|
5882
6046
|
#
|
5883
6047
|
# @option params [Array<Types::OpsFilter>] :filters
|
5884
|
-
# Optional filters used to scope down the returned
|
6048
|
+
# Optional filters used to scope down the returned OpsData.
|
5885
6049
|
#
|
5886
6050
|
# @option params [Array<Types::OpsAggregator>] :aggregators
|
5887
|
-
# Optional aggregators that return counts of
|
6051
|
+
# Optional aggregators that return counts of OpsData based on one or
|
5888
6052
|
# more expressions.
|
5889
6053
|
#
|
5890
6054
|
# @option params [Array<Types::OpsResultAttribute>] :result_attributes
|
5891
|
-
# The
|
6055
|
+
# The OpsData data type to return.
|
5892
6056
|
#
|
5893
6057
|
# @option params [String] :next_token
|
5894
6058
|
# A token to start the list. Use this token to get the next set of
|
@@ -5967,14 +6131,14 @@ module Aws::SSM
|
|
5967
6131
|
end
|
5968
6132
|
|
5969
6133
|
# Get information about a parameter by using the parameter name. Don't
|
5970
|
-
# confuse this API
|
6134
|
+
# confuse this API operation with the GetParameters API operation.
|
5971
6135
|
#
|
5972
6136
|
# @option params [required, String] :name
|
5973
6137
|
# The name of the parameter you want to query.
|
5974
6138
|
#
|
5975
6139
|
# @option params [Boolean] :with_decryption
|
5976
6140
|
# Return decrypted values for secure string parameters. This flag is
|
5977
|
-
# ignored for String and StringList parameter types.
|
6141
|
+
# ignored for `String` and `StringList` parameter types.
|
5978
6142
|
#
|
5979
6143
|
# @return [Types::GetParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5980
6144
|
#
|
@@ -6015,7 +6179,7 @@ module Aws::SSM
|
|
6015
6179
|
#
|
6016
6180
|
# @option params [Boolean] :with_decryption
|
6017
6181
|
# Return decrypted values for secure string parameters. This flag is
|
6018
|
-
# ignored for String and StringList parameter types.
|
6182
|
+
# ignored for `String` and `StringList` parameter types.
|
6019
6183
|
#
|
6020
6184
|
# @option params [Integer] :max_results
|
6021
6185
|
# The maximum number of items to return for this call. The call also
|
@@ -6073,16 +6237,16 @@ module Aws::SSM
|
|
6073
6237
|
req.send_request(options)
|
6074
6238
|
end
|
6075
6239
|
|
6076
|
-
# Get details of a parameter. Don't confuse this API
|
6077
|
-
# GetParameter API
|
6240
|
+
# Get details of a parameter. Don't confuse this API operation with the
|
6241
|
+
# GetParameter API operation.
|
6078
6242
|
#
|
6079
6243
|
# @option params [required, Array<String>] :names
|
6080
6244
|
# Names of the parameters for which you want to query information.
|
6081
6245
|
#
|
6082
6246
|
# @option params [Boolean] :with_decryption
|
6083
6247
|
# Return decrypted secure string value. Return decrypted values for
|
6084
|
-
# secure string parameters. This flag is ignored for String and
|
6085
|
-
# StringList parameter types.
|
6248
|
+
# secure string parameters. This flag is ignored for `String` and
|
6249
|
+
# `StringList` parameter types.
|
6086
6250
|
#
|
6087
6251
|
# @return [Types::GetParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6088
6252
|
#
|
@@ -6123,7 +6287,7 @@ module Aws::SSM
|
|
6123
6287
|
# Retrieve information about one or more parameters in a specific
|
6124
6288
|
# hierarchy.
|
6125
6289
|
#
|
6126
|
-
#
|
6290
|
+
# Request results are returned on a best-effort basis. If you specify
|
6127
6291
|
# `MaxResults` in the request, the response includes information up to
|
6128
6292
|
# the limit specified. The number of items returned, however, can be
|
6129
6293
|
# between zero and the value of `MaxResults`. If the service reaches an
|
@@ -6132,13 +6296,11 @@ module Aws::SSM
|
|
6132
6296
|
# You can specify the `NextToken` in a subsequent call to get the next
|
6133
6297
|
# set of results.
|
6134
6298
|
#
|
6135
|
-
# </note>
|
6136
|
-
#
|
6137
6299
|
# @option params [required, String] :path
|
6138
6300
|
# The hierarchy for the parameter. Hierarchies start with a forward
|
6139
6301
|
# slash (/). The hierachy is the parameter name except the last part of
|
6140
6302
|
# the parameter. For the API call to succeeed, the last part of the
|
6141
|
-
# parameter name
|
6303
|
+
# parameter name can't be in the path. A parameter name hierarchy can
|
6142
6304
|
# have a maximum of 15 levels. Here is an example of a hierarchy:
|
6143
6305
|
# `/Finance/Prod/IAD/WinServ2016/license33 `
|
6144
6306
|
#
|
@@ -6149,7 +6311,7 @@ module Aws::SSM
|
|
6149
6311
|
# that path. For example, if a user has permission to access path `/a`,
|
6150
6312
|
# then the user can also access `/a/b`. Even if a user has explicitly
|
6151
6313
|
# been denied access in IAM for parameter `/a/b`, they can still call
|
6152
|
-
# the GetParametersByPath API
|
6314
|
+
# the GetParametersByPath API operation recursively for `/a` and view
|
6153
6315
|
# `/a/b`.
|
6154
6316
|
#
|
6155
6317
|
# @option params [Array<Types::ParameterStringFilter>] :parameter_filters
|
@@ -6334,21 +6496,23 @@ module Aws::SSM
|
|
6334
6496
|
req.send_request(options)
|
6335
6497
|
end
|
6336
6498
|
|
6337
|
-
# `ServiceSetting` is an account-level setting for an
|
6338
|
-
# setting defines how a user interacts with or
|
6339
|
-
# feature of a service. For example, if an
|
6340
|
-
# the account based on feature or
|
6341
|
-
#
|
6342
|
-
#
|
6343
|
-
#
|
6499
|
+
# `ServiceSetting` is an account-level setting for an Amazon Web
|
6500
|
+
# Services service. This setting defines how a user interacts with or
|
6501
|
+
# uses a service or a feature of a service. For example, if an Amazon
|
6502
|
+
# Web Services service charges money to the account based on feature or
|
6503
|
+
# service usage, then the Amazon Web Services service team might create
|
6504
|
+
# a default setting of `false`. This means the user can't use this
|
6505
|
+
# feature unless they change the setting to `true` and intentionally opt
|
6506
|
+
# in for a paid feature.
|
6344
6507
|
#
|
6345
|
-
# Services map a `SettingId` object to a setting value.
|
6346
|
-
# teams define the default value for a `SettingId`.
|
6347
|
-
# new `SettingId`, but you can overwrite the default
|
6348
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
6349
|
-
# UpdateServiceSetting API
|
6350
|
-
#
|
6351
|
-
# defined by the
|
6508
|
+
# Services map a `SettingId` object to a setting value. Amazon Web
|
6509
|
+
# Services services teams define the default value for a `SettingId`.
|
6510
|
+
# You can't create a new `SettingId`, but you can overwrite the default
|
6511
|
+
# value if you have the `ssm:UpdateServiceSetting` permission for the
|
6512
|
+
# setting. Use the UpdateServiceSetting API operation to change the
|
6513
|
+
# default setting. Or use the ResetServiceSetting to change the value
|
6514
|
+
# back to the original value defined by the Amazon Web Services service
|
6515
|
+
# team.
|
6352
6516
|
#
|
6353
6517
|
# Query the current service setting for the account.
|
6354
6518
|
#
|
@@ -6397,10 +6561,10 @@ module Aws::SSM
|
|
6397
6561
|
end
|
6398
6562
|
|
6399
6563
|
# A parameter label is a user-defined alias to help you manage different
|
6400
|
-
# versions of a parameter. When you modify a parameter,
|
6401
|
-
# automatically saves a new version and
|
6402
|
-
# one. A label can help you remember
|
6403
|
-
# there are multiple versions.
|
6564
|
+
# versions of a parameter. When you modify a parameter, Amazon Web
|
6565
|
+
# Services Systems Manager automatically saves a new version and
|
6566
|
+
# increments the version number by one. A label can help you remember
|
6567
|
+
# the purpose of a parameter when there are multiple versions.
|
6404
6568
|
#
|
6405
6569
|
# Parameter labels have the following requirements and restrictions.
|
6406
6570
|
#
|
@@ -6423,9 +6587,9 @@ module Aws::SSM
|
|
6423
6587
|
# * Labels can contain letters (case sensitive), numbers, periods (.),
|
6424
6588
|
# hyphens (-), or underscores (\_).
|
6425
6589
|
#
|
6426
|
-
# * Labels can't begin with a number, "aws
|
6590
|
+
# * Labels can't begin with a number, "`aws`" or "`ssm`" (not case
|
6427
6591
|
# sensitive). If a label fails to meet these requirements, then the
|
6428
|
-
# label
|
6592
|
+
# label isn't associated with a parameter and the system displays it
|
6429
6593
|
# in the list of InvalidLabels.
|
6430
6594
|
#
|
6431
6595
|
# @option params [required, String] :name
|
@@ -6543,9 +6707,10 @@ module Aws::SSM
|
|
6543
6707
|
req.send_request(options)
|
6544
6708
|
end
|
6545
6709
|
|
6546
|
-
# Returns all State Manager associations in the current
|
6710
|
+
# Returns all State Manager associations in the current account and
|
6547
6711
|
# Region. You can limit the results to a specific State Manager
|
6548
|
-
# association document or instance by specifying a filter.
|
6712
|
+
# association document or instance by specifying a filter. State Manager
|
6713
|
+
# is a capability of Amazon Web Services Systems Manager.
|
6549
6714
|
#
|
6550
6715
|
# @option params [Array<Types::AssociationFilter>] :association_filter_list
|
6551
6716
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -6554,7 +6719,7 @@ module Aws::SSM
|
|
6554
6719
|
# <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
|
6555
6720
|
# legacy associations created using the `InstanceID` attribute.
|
6556
6721
|
# Associations targeting the instance that are part of the Target
|
6557
|
-
# Attributes `ResourceGroup` or `Tags`
|
6722
|
+
# Attributes `ResourceGroup` or `Tags` aren't returned.
|
6558
6723
|
#
|
6559
6724
|
# </note>
|
6560
6725
|
#
|
@@ -6619,9 +6784,9 @@ module Aws::SSM
|
|
6619
6784
|
|
6620
6785
|
# An invocation is copy of a command sent to a specific instance. A
|
6621
6786
|
# command can apply to one or more instances. A command invocation
|
6622
|
-
# applies to one instance. For example, if a user runs SendCommand
|
6787
|
+
# applies to one instance. For example, if a user runs `SendCommand`
|
6623
6788
|
# against three instances, then a command invocation is created for each
|
6624
|
-
# requested instance ID. ListCommandInvocations provide status about
|
6789
|
+
# requested instance ID. `ListCommandInvocations` provide status about
|
6625
6790
|
# command execution.
|
6626
6791
|
#
|
6627
6792
|
# @option params [String] :command_id
|
@@ -6645,7 +6810,7 @@ module Aws::SSM
|
|
6645
6810
|
#
|
6646
6811
|
# @option params [Boolean] :details
|
6647
6812
|
# (Optional) If set this returns the response of the command executions
|
6648
|
-
# and any command output. The default value is
|
6813
|
+
# and any command output. The default value is `false`.
|
6649
6814
|
#
|
6650
6815
|
# @return [Types::ListCommandInvocationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6651
6816
|
#
|
@@ -6716,7 +6881,7 @@ module Aws::SSM
|
|
6716
6881
|
req.send_request(options)
|
6717
6882
|
end
|
6718
6883
|
|
6719
|
-
# Lists the commands requested by users of the
|
6884
|
+
# Lists the commands requested by users of the account.
|
6720
6885
|
#
|
6721
6886
|
# @option params [String] :command_id
|
6722
6887
|
# (Optional) If provided, lists only the specified command.
|
@@ -6725,7 +6890,7 @@ module Aws::SSM
|
|
6725
6890
|
# (Optional) Lists commands issued against this instance ID.
|
6726
6891
|
#
|
6727
6892
|
# <note markdown="1"> You can't specify an instance ID in the same command that you specify
|
6728
|
-
# `Status` = `Pending`. This is because the command
|
6893
|
+
# `Status` = `Pending`. This is because the command hasn't reached the
|
6729
6894
|
# instance yet.
|
6730
6895
|
#
|
6731
6896
|
# </note>
|
@@ -6813,7 +6978,7 @@ module Aws::SSM
|
|
6813
6978
|
req.send_request(options)
|
6814
6979
|
end
|
6815
6980
|
|
6816
|
-
# For a specified resource ID, this API
|
6981
|
+
# For a specified resource ID, this API operation returns a list of
|
6817
6982
|
# compliance statuses for different resource types. Currently, you can
|
6818
6983
|
# only specify one resource ID per call. List results depend on the
|
6819
6984
|
# criteria specified in the filter.
|
@@ -7073,9 +7238,8 @@ module Aws::SSM
|
|
7073
7238
|
req.send_request(options)
|
7074
7239
|
end
|
7075
7240
|
|
7076
|
-
# Returns all Systems Manager (SSM) documents in the current
|
7077
|
-
#
|
7078
|
-
# filter.
|
7241
|
+
# Returns all Systems Manager (SSM) documents in the current account and
|
7242
|
+
# Region. You can limit the results of this request by using a filter.
|
7079
7243
|
#
|
7080
7244
|
# @option params [Array<Types::DocumentFilter>] :document_filter_list
|
7081
7245
|
# This data type is deprecated. Instead, use `Filters`.
|
@@ -7089,7 +7253,7 @@ module Aws::SSM
|
|
7089
7253
|
# `Key=Owner,Values=Self`. To specify a custom key-value pair, use the
|
7090
7254
|
# format `Key=tag:tagName,Values=valueName`.
|
7091
7255
|
#
|
7092
|
-
# <note markdown="1"> This API
|
7256
|
+
# <note markdown="1"> This API operation only supports filtering documents by using a single
|
7093
7257
|
# tag key and one or more tag values. For example:
|
7094
7258
|
# `Key=tag:tagName,Values=valueName1,valueName2`
|
7095
7259
|
#
|
@@ -7191,7 +7355,7 @@ module Aws::SSM
|
|
7191
7355
|
# * {Types::ListInventoryEntriesResult#instance_id #instance_id} => String
|
7192
7356
|
# * {Types::ListInventoryEntriesResult#schema_version #schema_version} => String
|
7193
7357
|
# * {Types::ListInventoryEntriesResult#capture_time #capture_time} => String
|
7194
|
-
# * {Types::ListInventoryEntriesResult#entries #entries} => Array<Hash<String,String>>
|
7358
|
+
# * {Types::ListInventoryEntriesResult#entries #data.entries} => Array<Hash<String,String>> (This method conflicts with a method on Response, call it through the data member)
|
7195
7359
|
# * {Types::ListInventoryEntriesResult#next_token #next_token} => String
|
7196
7360
|
#
|
7197
7361
|
# @example Request syntax with placeholder values
|
@@ -7216,9 +7380,9 @@ module Aws::SSM
|
|
7216
7380
|
# resp.instance_id #=> String
|
7217
7381
|
# resp.schema_version #=> String
|
7218
7382
|
# resp.capture_time #=> String
|
7219
|
-
# resp.entries #=> Array
|
7220
|
-
# resp.entries[0] #=> Hash
|
7221
|
-
# resp.entries[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
7383
|
+
# resp.data.entries #=> Array
|
7384
|
+
# resp.data.entries[0] #=> Hash
|
7385
|
+
# resp.data.entries[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
7222
7386
|
# resp.next_token #=> String
|
7223
7387
|
#
|
7224
7388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries AWS API Documentation
|
@@ -7230,8 +7394,8 @@ module Aws::SSM
|
|
7230
7394
|
req.send_request(options)
|
7231
7395
|
end
|
7232
7396
|
|
7233
|
-
# Returns a list of all OpsItem events in the current
|
7234
|
-
#
|
7397
|
+
# Returns a list of all OpsItem events in the current Region and
|
7398
|
+
# account. You can limit the results to events associated with specific
|
7235
7399
|
# OpsItems by specifying a filter.
|
7236
7400
|
#
|
7237
7401
|
# @option params [Array<Types::OpsItemEventFilter>] :filters
|
@@ -7353,8 +7517,8 @@ module Aws::SSM
|
|
7353
7517
|
req.send_request(options)
|
7354
7518
|
end
|
7355
7519
|
|
7356
|
-
# Systems Manager calls this API
|
7357
|
-
# Manager OpsMetadata objects or blobs.
|
7520
|
+
# Amazon Web Services Systems Manager calls this API operation when
|
7521
|
+
# displaying all Application Manager OpsMetadata objects or blobs.
|
7358
7522
|
#
|
7359
7523
|
# @option params [Array<Types::OpsMetadataFilter>] :filters
|
7360
7524
|
# One or more filters to limit the number of OpsMetadata objects
|
@@ -7500,7 +7664,7 @@ module Aws::SSM
|
|
7500
7664
|
# View a list of resource data syncs according to the sync type. Specify
|
7501
7665
|
# `SyncToDestination` to view resource data syncs that synchronize data
|
7502
7666
|
# to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data
|
7503
|
-
# syncs from
|
7667
|
+
# syncs from Organizations or from multiple Regions.
|
7504
7668
|
#
|
7505
7669
|
# @option params [String] :next_token
|
7506
7670
|
# A token to start the list. Use this token to get the next set of
|
@@ -7565,6 +7729,9 @@ module Aws::SSM
|
|
7565
7729
|
|
7566
7730
|
# Returns a list of the tags assigned to the specified resource.
|
7567
7731
|
#
|
7732
|
+
# For information about the ID format for each supported resource type,
|
7733
|
+
# see AddTagsToResource.
|
7734
|
+
#
|
7568
7735
|
# @option params [required, String] :resource_type
|
7569
7736
|
# Returns a list of tags for a specific resource type.
|
7570
7737
|
#
|
@@ -7597,10 +7764,11 @@ module Aws::SSM
|
|
7597
7764
|
req.send_request(options)
|
7598
7765
|
end
|
7599
7766
|
|
7600
|
-
# Shares a Systems Manager document
|
7601
|
-
#
|
7602
|
-
#
|
7603
|
-
#
|
7767
|
+
# Shares a Amazon Web Services Systems Manager document (SSM
|
7768
|
+
# document)publicly or privately. If you share a document privately, you
|
7769
|
+
# must specify the Amazon Web Services user account IDs for those people
|
7770
|
+
# who can use the document. If you share a document publicly, you must
|
7771
|
+
# specify *All* as the account ID.
|
7604
7772
|
#
|
7605
7773
|
# @option params [required, String] :name
|
7606
7774
|
# The name of the document that you want to share.
|
@@ -7610,18 +7778,19 @@ module Aws::SSM
|
|
7610
7778
|
# *Share*.
|
7611
7779
|
#
|
7612
7780
|
# @option params [Array<String>] :account_ids_to_add
|
7613
|
-
# The
|
7614
|
-
# account IDs can either be a group of account IDs or
|
7781
|
+
# The Amazon Web Services user accounts that should have access to the
|
7782
|
+
# document. The account IDs can either be a group of account IDs or
|
7783
|
+
# *All*.
|
7615
7784
|
#
|
7616
7785
|
# @option params [Array<String>] :account_ids_to_remove
|
7617
|
-
# The
|
7618
|
-
# document. The
|
7619
|
-
# *All*. This action has a higher
|
7620
|
-
# you specify an account ID to add
|
7621
|
-
# removes access to the document.
|
7786
|
+
# The Amazon Web Services user accounts that should no longer have
|
7787
|
+
# access to the document. The Amazon Web Services user account can
|
7788
|
+
# either be a group of account IDs or *All*. This action has a higher
|
7789
|
+
# priority than *AccountIdsToAdd*. If you specify an account ID to add
|
7790
|
+
# and the same ID to remove, the system removes access to the document.
|
7622
7791
|
#
|
7623
7792
|
# @option params [String] :shared_document_version
|
7624
|
-
# (Optional) The version of the document to share. If it'
|
7793
|
+
# (Optional) The version of the document to share. If it isn't
|
7625
7794
|
# specified, the system choose the `Default` version to share.
|
7626
7795
|
#
|
7627
7796
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -7646,10 +7815,10 @@ module Aws::SSM
|
|
7646
7815
|
end
|
7647
7816
|
|
7648
7817
|
# Registers a compliance type and other compliance details on a
|
7649
|
-
# designated resource. This
|
7650
|
-
# details with a resource. This call overwrites existing
|
7651
|
-
# information on the resource, so you must provide a full
|
7652
|
-
# compliance items each time that you send the request.
|
7818
|
+
# designated resource. This operation lets you register custom
|
7819
|
+
# compliance details with a resource. This call overwrites existing
|
7820
|
+
# compliance information on the resource, so you must provide a full
|
7821
|
+
# list of compliance items each time that you send the request.
|
7653
7822
|
#
|
7654
7823
|
# ComplianceType can be one of the following:
|
7655
7824
|
#
|
@@ -7670,8 +7839,8 @@ module Aws::SSM
|
|
7670
7839
|
#
|
7671
7840
|
# * Severity: A patch severity. For example, `critical`.
|
7672
7841
|
#
|
7673
|
-
# * DocumentName:
|
7674
|
-
# AWS-RunPatchBaseline
|
7842
|
+
# * DocumentName: An SSM document name. For example,
|
7843
|
+
# `AWS-RunPatchBaseline`.
|
7675
7844
|
#
|
7676
7845
|
# * DocumentVersion: An SSM document version number. For example, 4.
|
7677
7846
|
#
|
@@ -7833,9 +8002,9 @@ module Aws::SSM
|
|
7833
8002
|
#
|
7834
8003
|
# * Parameter names are case sensitive.
|
7835
8004
|
#
|
7836
|
-
# * A parameter name must be unique within an
|
8005
|
+
# * A parameter name must be unique within an Region
|
7837
8006
|
#
|
7838
|
-
# * A parameter name can't be prefixed with "aws" or "ssm"
|
8007
|
+
# * A parameter name can't be prefixed with "`aws`" or "`ssm`"
|
7839
8008
|
# (case-insensitive).
|
7840
8009
|
#
|
7841
8010
|
# * Parameter names can include only the following symbols and letters:
|
@@ -7851,11 +8020,11 @@ module Aws::SSM
|
|
7851
8020
|
# levels.
|
7852
8021
|
#
|
7853
8022
|
# For additional information about valid values for parameter names, see
|
7854
|
-
# [Creating Systems Manager parameters][1] in the *
|
7855
|
-
# User Guide*.
|
8023
|
+
# [Creating Systems Manager parameters][1] in the *Amazon Web Services
|
8024
|
+
# Systems Manager User Guide*.
|
7856
8025
|
#
|
7857
8026
|
# <note markdown="1"> The maximum length constraint listed below includes capacity for
|
7858
|
-
# additional system attributes that
|
8027
|
+
# additional system attributes that aren't part of the name. The
|
7859
8028
|
# maximum length for a parameter name, including the full length of the
|
7860
8029
|
# parameter ARN, is 1011 characters. For example, the length of the
|
7861
8030
|
# following parameter name is 65 characters, not 20 characters:
|
@@ -7872,7 +8041,7 @@ module Aws::SSM
|
|
7872
8041
|
# Information about the parameter that you want to add to the system.
|
7873
8042
|
# Optional but recommended.
|
7874
8043
|
#
|
7875
|
-
#
|
8044
|
+
# Don't enter personally identifiable information in this field.
|
7876
8045
|
#
|
7877
8046
|
# @option params [required, String] :value
|
7878
8047
|
# The parameter value that you want to add to the system. Standard
|
@@ -7888,7 +8057,7 @@ module Aws::SSM
|
|
7888
8057
|
# @option params [String] :type
|
7889
8058
|
# The type of parameter that you want to add to the system.
|
7890
8059
|
#
|
7891
|
-
# <note markdown="1"> `SecureString`
|
8060
|
+
# <note markdown="1"> `SecureString` isn't currently supported for CloudFormation
|
7892
8061
|
# templates.
|
7893
8062
|
#
|
7894
8063
|
# </note>
|
@@ -7898,28 +8067,27 @@ module Aws::SSM
|
|
7898
8067
|
# list. If you have a parameter value that requires a comma, then use
|
7899
8068
|
# the `String` data type.
|
7900
8069
|
#
|
7901
|
-
# Specifying a parameter type
|
8070
|
+
# Specifying a parameter type isn't required when updating a parameter.
|
7902
8071
|
# You must specify a parameter type when creating a parameter.
|
7903
8072
|
#
|
7904
8073
|
# @option params [String] :key_id
|
7905
|
-
# The KMS
|
7906
|
-
#
|
7907
|
-
#
|
7908
|
-
#
|
8074
|
+
# The Key Management Service (KMS) ID that you want to use to encrypt a
|
8075
|
+
# parameter. Either the default KMS key automatically assigned to your
|
8076
|
+
# account or a custom key. Required for parameters that use the
|
8077
|
+
# `SecureString` data type.
|
7909
8078
|
#
|
7910
8079
|
# If you don't specify a key ID, the system uses the default key
|
7911
|
-
# associated with your
|
8080
|
+
# associated with your account.
|
7912
8081
|
#
|
7913
|
-
# * To use your default
|
7914
|
-
#
|
7915
|
-
#
|
7916
|
-
# default KMS key.
|
8082
|
+
# * To use your default KMS key, choose the `SecureString` data type,
|
8083
|
+
# and do *not* specify the `Key ID` when you create the parameter. The
|
8084
|
+
# system automatically populates `Key ID` with your default KMS key.
|
7917
8085
|
#
|
7918
8086
|
# * To use a custom KMS key, choose the `SecureString` data type with
|
7919
8087
|
# the `Key ID` parameter.
|
7920
8088
|
#
|
7921
8089
|
# @option params [Boolean] :overwrite
|
7922
|
-
# Overwrite an existing parameter. The default value is
|
8090
|
+
# Overwrite an existing parameter. The default value is `false`.
|
7923
8091
|
#
|
7924
8092
|
# @option params [String] :allowed_pattern
|
7925
8093
|
# A regular expression used to validate the parameter value. For
|
@@ -7932,8 +8100,8 @@ module Aws::SSM
|
|
7932
8100
|
# environment. For example, you might want to tag a Systems Manager
|
7933
8101
|
# parameter to identify the type of resource to which it applies, the
|
7934
8102
|
# environment, or the type of configuration data referenced by the
|
7935
|
-
# parameter. In this case, you could specify the following key
|
7936
|
-
#
|
8103
|
+
# parameter. In this case, you could specify the following key-value
|
8104
|
+
# pairs:
|
7937
8105
|
#
|
7938
8106
|
# * `Key=Resource,Value=S3bucket`
|
7939
8107
|
#
|
@@ -7942,7 +8110,7 @@ module Aws::SSM
|
|
7942
8110
|
# * `Key=ParameterType,Value=LicenseKey`
|
7943
8111
|
#
|
7944
8112
|
# <note markdown="1"> To add tags to an existing Systems Manager parameter, use the
|
7945
|
-
# AddTagsToResource
|
8113
|
+
# AddTagsToResource operation.
|
7946
8114
|
#
|
7947
8115
|
# </note>
|
7948
8116
|
#
|
@@ -7952,15 +8120,15 @@ module Aws::SSM
|
|
7952
8120
|
# Parameter Store offers a standard tier and an advanced tier for
|
7953
8121
|
# parameters. Standard parameters have a content size limit of 4 KB and
|
7954
8122
|
# can't be configured to use parameter policies. You can create a
|
7955
|
-
# maximum of 10,000 standard parameters for each Region in an
|
7956
|
-
#
|
8123
|
+
# maximum of 10,000 standard parameters for each Region in an account.
|
8124
|
+
# Standard parameters are offered at no additional cost.
|
7957
8125
|
#
|
7958
8126
|
# Advanced parameters have a content size limit of 8 KB and can be
|
7959
8127
|
# configured to use parameter policies. You can create a maximum of
|
7960
|
-
# 100,000 advanced parameters for each Region in an
|
7961
|
-
#
|
7962
|
-
#
|
7963
|
-
# User Guide*.
|
8128
|
+
# 100,000 advanced parameters for each Region in an account. Advanced
|
8129
|
+
# parameters incur a charge. For more information, see [Standard and
|
8130
|
+
# advanced parameter tiers][1] in the *Amazon Web Services Systems
|
8131
|
+
# Manager User Guide*.
|
7964
8132
|
#
|
7965
8133
|
# You can change a standard parameter to an advanced parameter any time.
|
7966
8134
|
# But you can't revert an advanced parameter to a standard parameter.
|
@@ -7979,7 +8147,7 @@ module Aws::SSM
|
|
7979
8147
|
# In `PutParameter` requests, you can specify the tier to create the
|
7980
8148
|
# parameter in. Whenever you specify a tier in the request, Parameter
|
7981
8149
|
# Store creates or updates the parameter according to that request.
|
7982
|
-
# However, if you
|
8150
|
+
# However, if you don't specify a tier in a request, Parameter Store
|
7983
8151
|
# assigns the tier based on the current Parameter Store default tier
|
7984
8152
|
# configuration.
|
7985
8153
|
#
|
@@ -8010,12 +8178,12 @@ module Aws::SSM
|
|
8010
8178
|
#
|
8011
8179
|
# * The parameter uses a parameter policy.
|
8012
8180
|
#
|
8013
|
-
# * More than 10,000 parameters already exist in your
|
8181
|
+
# * More than 10,000 parameters already exist in your account in the
|
8014
8182
|
# current Region.
|
8015
8183
|
#
|
8016
8184
|
# For more information about configuring the default tier option, see
|
8017
|
-
# [Specifying a default parameter tier][2] in the *
|
8018
|
-
# User Guide*.
|
8185
|
+
# [Specifying a default parameter tier][2] in the *Amazon Web Services
|
8186
|
+
# Systems Manager User Guide*.
|
8019
8187
|
#
|
8020
8188
|
#
|
8021
8189
|
#
|
@@ -8023,13 +8191,14 @@ module Aws::SSM
|
|
8023
8191
|
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html
|
8024
8192
|
#
|
8025
8193
|
# @option params [String] :policies
|
8026
|
-
# One or more policies to apply to a parameter. This
|
8027
|
-
# array. Parameter Store
|
8194
|
+
# One or more policies to apply to a parameter. This operation takes a
|
8195
|
+
# JSON array. Parameter Store, a capability of Amazon Web Services
|
8196
|
+
# Systems Manager supports the following policy types:
|
8028
8197
|
#
|
8029
8198
|
# Expiration: This policy deletes the parameter after it expires. When
|
8030
8199
|
# you create the policy, you specify the expiration date. You can update
|
8031
8200
|
# the expiration date and time by updating the policy. Updating the
|
8032
|
-
# *parameter*
|
8201
|
+
# *parameter* doesn't affect the expiration date and time. When the
|
8033
8202
|
# expiration time is reached, Parameter Store deletes the parameter.
|
8034
8203
|
#
|
8035
8204
|
# ExpirationNotification: This policy triggers an event in Amazon
|
@@ -8037,10 +8206,10 @@ module Aws::SSM
|
|
8037
8206
|
# this policy, you can receive notification before or after the
|
8038
8207
|
# expiration time is reached, in units of days or hours.
|
8039
8208
|
#
|
8040
|
-
# NoChangeNotification: This policy triggers a CloudWatch event
|
8041
|
-
# parameter
|
8042
|
-
# policy type is useful when, for example, a secret needs to be
|
8043
|
-
# within a period of time, but it
|
8209
|
+
# NoChangeNotification: This policy triggers a CloudWatch Events event
|
8210
|
+
# if a parameter hasn't been modified for a specified period of time.
|
8211
|
+
# This policy type is useful when, for example, a secret needs to be
|
8212
|
+
# changed within a period of time, but it hasn't been changed.
|
8044
8213
|
#
|
8045
8214
|
# All existing policies are preserved until you send new policies or an
|
8046
8215
|
# empty policy. For more information about parameter policies, see
|
@@ -8052,7 +8221,7 @@ module Aws::SSM
|
|
8052
8221
|
#
|
8053
8222
|
# @option params [String] :data_type
|
8054
8223
|
# The data type for a `String` parameter. Supported data types include
|
8055
|
-
# plain text and Amazon Machine Image IDs.
|
8224
|
+
# plain text and Amazon Machine Image (AMI) IDs.
|
8056
8225
|
#
|
8057
8226
|
# **The following data type values are supported.**
|
8058
8227
|
#
|
@@ -8061,11 +8230,11 @@ module Aws::SSM
|
|
8061
8230
|
# * `aws:ec2:image`
|
8062
8231
|
#
|
8063
8232
|
# When you create a `String` parameter and specify `aws:ec2:image`,
|
8064
|
-
# Systems Manager validates the parameter value is
|
8065
|
-
# format, such as `ami-12345abcdeEXAMPLE`, and that the
|
8066
|
-
# available in your
|
8067
|
-
# parameter support for Amazon Machine Image IDs][1] in
|
8068
|
-
# Manager User Guide*.
|
8233
|
+
# Amazon Web Services Systems Manager validates the parameter value is
|
8234
|
+
# in the required format, such as `ami-12345abcdeEXAMPLE`, and that the
|
8235
|
+
# specified AMI is available in your account. For more information, see
|
8236
|
+
# [Native parameter support for Amazon Machine Image (AMI) IDs][1] in
|
8237
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
8069
8238
|
#
|
8070
8239
|
#
|
8071
8240
|
#
|
@@ -8113,9 +8282,9 @@ module Aws::SSM
|
|
8113
8282
|
|
8114
8283
|
# Defines the default patch baseline for the relevant operating system.
|
8115
8284
|
#
|
8116
|
-
# To reset the
|
8117
|
-
#
|
8118
|
-
# CentOS, specify
|
8285
|
+
# To reset the Amazon Web Services-predefined patch baseline as the
|
8286
|
+
# default, specify the full patch baseline Amazon Resource Name (ARN) as
|
8287
|
+
# the baseline ID value. For example, for CentOS, specify
|
8119
8288
|
# `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed`
|
8120
8289
|
# instead of `pb-0574b43a65ea646ed`.
|
8121
8290
|
#
|
@@ -8149,11 +8318,10 @@ module Aws::SSM
|
|
8149
8318
|
# Registers a patch baseline for a patch group.
|
8150
8319
|
#
|
8151
8320
|
# @option params [required, String] :baseline_id
|
8152
|
-
# The ID of the patch baseline to register the patch group
|
8321
|
+
# The ID of the patch baseline to register with the patch group.
|
8153
8322
|
#
|
8154
8323
|
# @option params [required, String] :patch_group
|
8155
|
-
# The name of the patch group
|
8156
|
-
# baseline.
|
8324
|
+
# The name of the patch group to be registered with the patch baseline.
|
8157
8325
|
#
|
8158
8326
|
# @return [Types::RegisterPatchBaselineForPatchGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8159
8327
|
#
|
@@ -8235,16 +8403,17 @@ module Aws::SSM
|
|
8235
8403
|
#
|
8236
8404
|
# For more information about these examples formats, including the best
|
8237
8405
|
# use case for each one, see [Examples: Register targets with a
|
8238
|
-
# maintenance window][1] in the *
|
8406
|
+
# maintenance window][1] in the *Amazon Web Services Systems Manager
|
8407
|
+
# User Guide*.
|
8239
8408
|
#
|
8240
8409
|
#
|
8241
8410
|
#
|
8242
8411
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
|
8243
8412
|
#
|
8244
8413
|
# @option params [String] :owner_information
|
8245
|
-
# User-provided value that will be included in any CloudWatch
|
8246
|
-
# raised while running tasks for these targets in this
|
8247
|
-
# window.
|
8414
|
+
# User-provided value that will be included in any Amazon CloudWatch
|
8415
|
+
# Events events raised while running tasks for these targets in this
|
8416
|
+
# maintenance window.
|
8248
8417
|
#
|
8249
8418
|
# @option params [String] :name
|
8250
8419
|
# An optional name for the target.
|
@@ -8302,10 +8471,10 @@ module Aws::SSM
|
|
8302
8471
|
#
|
8303
8472
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
8304
8473
|
# Command-type tasks. Depending on the task, targets are optional for
|
8305
|
-
# other maintenance window task types (Automation,
|
8306
|
-
#
|
8474
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
8475
|
+
# Functions). For more information about running tasks that don't
|
8307
8476
|
# specify targets, see [Registering maintenance window tasks without
|
8308
|
-
# targets][1] in the *
|
8477
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
8309
8478
|
#
|
8310
8479
|
# </note>
|
8311
8480
|
#
|
@@ -8325,14 +8494,15 @@ module Aws::SSM
|
|
8325
8494
|
# The ARN of the task to run.
|
8326
8495
|
#
|
8327
8496
|
# @option params [String] :service_role_arn
|
8328
|
-
# The ARN of the IAM service role for
|
8329
|
-
#
|
8330
|
-
#
|
8331
|
-
#
|
8332
|
-
# is created when you run
|
8497
|
+
# The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
|
8498
|
+
# Services Systems Manager to assume when running a maintenance window
|
8499
|
+
# task. If you do not specify a service role ARN, Systems Manager uses
|
8500
|
+
# your account's service-linked role. If no service-linked role for
|
8501
|
+
# Systems Manager exists in your account, it is created when you run
|
8502
|
+
# `RegisterTaskWithMaintenanceWindow`.
|
8333
8503
|
#
|
8334
|
-
# For more information, see the following topics in the in the *
|
8335
|
-
# Systems Manager User Guide*\:
|
8504
|
+
# For more information, see the following topics in the in the *Amazon
|
8505
|
+
# Web Services Systems Manager User Guide*\:
|
8336
8506
|
#
|
8337
8507
|
# * [Using service-linked roles for Systems Manager][1]
|
8338
8508
|
#
|
@@ -8372,9 +8542,9 @@ module Aws::SSM
|
|
8372
8542
|
# @option params [String] :max_concurrency
|
8373
8543
|
# The maximum number of targets this task can be run for in parallel.
|
8374
8544
|
#
|
8375
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
8545
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
8376
8546
|
# supply a value for this option. Instead, the system inserts a
|
8377
|
-
# placeholder value of `1`. This value
|
8547
|
+
# placeholder value of `1`. This value doesn't affect the running of
|
8378
8548
|
# your task.
|
8379
8549
|
#
|
8380
8550
|
# </note>
|
@@ -8383,21 +8553,22 @@ module Aws::SSM
|
|
8383
8553
|
# The maximum number of errors allowed before this task stops being
|
8384
8554
|
# scheduled.
|
8385
8555
|
#
|
8386
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
8556
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
8387
8557
|
# supply a value for this option. Instead, the system inserts a
|
8388
|
-
# placeholder value of `1`. This value
|
8558
|
+
# placeholder value of `1`. This value doesn't affect the running of
|
8389
8559
|
# your task.
|
8390
8560
|
#
|
8391
8561
|
# </note>
|
8392
8562
|
#
|
8393
8563
|
# @option params [Types::LoggingInfo] :logging_info
|
8394
|
-
# A structure containing information about an
|
8395
|
-
# instance-level logs to.
|
8396
|
-
#
|
8397
|
-
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an
|
8398
|
-
# logs, instead use the
|
8399
|
-
#
|
8400
|
-
#
|
8564
|
+
# A structure containing information about an Amazon Simple Storage
|
8565
|
+
# Service (Amazon S3) bucket to write instance-level logs to.
|
8566
|
+
#
|
8567
|
+
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
8568
|
+
# Service (Amazon S3) bucket to contain logs, instead use the
|
8569
|
+
# `OutputS3BucketName` and `OutputS3KeyPrefix` options in the
|
8570
|
+
# `TaskInvocationParameters` structure. For information about how Amazon
|
8571
|
+
# Web Services Systems Manager handles these options for the supported
|
8401
8572
|
# maintenance window task types, see
|
8402
8573
|
# MaintenanceWindowTaskInvocationParameters.
|
8403
8574
|
#
|
@@ -8507,9 +8678,10 @@ module Aws::SSM
|
|
8507
8678
|
# @option params [required, String] :resource_type
|
8508
8679
|
# The type of resource from which you want to remove a tag.
|
8509
8680
|
#
|
8510
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
8511
|
-
# managed instances. Specify the name of the managed
|
8512
|
-
# following format: mi-
|
8681
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
8682
|
+
# on-premises managed instances. Specify the name of the managed
|
8683
|
+
# instance in the following format: `mi-ID_number `. For example,
|
8684
|
+
# `mi-1a2b3c4d5e6f`.
|
8513
8685
|
#
|
8514
8686
|
# </note>
|
8515
8687
|
#
|
@@ -8533,9 +8705,10 @@ module Aws::SSM
|
|
8533
8705
|
#
|
8534
8706
|
# For the Document and Parameter values, use the name of the resource.
|
8535
8707
|
#
|
8536
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
8537
|
-
# managed instances. Specify the name of the managed
|
8538
|
-
# following format: mi-ID\_number. For example,
|
8708
|
+
# <note markdown="1"> The ManagedInstance type for this API operation is only for
|
8709
|
+
# on-premises managed instances. Specify the name of the managed
|
8710
|
+
# instance in the following format: mi-ID\_number. For example,
|
8711
|
+
# mi-1a2b3c4d5e6f.
|
8539
8712
|
#
|
8540
8713
|
# </note>
|
8541
8714
|
#
|
@@ -8561,23 +8734,25 @@ module Aws::SSM
|
|
8561
8734
|
req.send_request(options)
|
8562
8735
|
end
|
8563
8736
|
|
8564
|
-
# `ServiceSetting` is an account-level setting for an
|
8565
|
-
# setting defines how a user interacts with or
|
8566
|
-
# feature of a service. For example, if an
|
8567
|
-
# the account based on feature or
|
8568
|
-
#
|
8569
|
-
#
|
8570
|
-
#
|
8737
|
+
# `ServiceSetting` is an account-level setting for an Amazon Web
|
8738
|
+
# Services service. This setting defines how a user interacts with or
|
8739
|
+
# uses a service or a feature of a service. For example, if an Amazon
|
8740
|
+
# Web Services service charges money to the account based on feature or
|
8741
|
+
# service usage, then the Amazon Web Services service team might create
|
8742
|
+
# a default setting of "false". This means the user can't use this
|
8743
|
+
# feature unless they change the setting to "true" and intentionally
|
8744
|
+
# opt in for a paid feature.
|
8571
8745
|
#
|
8572
|
-
# Services map a `SettingId` object to a setting value.
|
8573
|
-
# teams define the default value for a `SettingId`.
|
8574
|
-
# new `SettingId`, but you can overwrite the default
|
8575
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
8576
|
-
# GetServiceSetting API
|
8577
|
-
# UpdateServiceSetting API
|
8746
|
+
# Services map a `SettingId` object to a setting value. Amazon Web
|
8747
|
+
# Services services teams define the default value for a `SettingId`.
|
8748
|
+
# You can't create a new `SettingId`, but you can overwrite the default
|
8749
|
+
# value if you have the `ssm:UpdateServiceSetting` permission for the
|
8750
|
+
# setting. Use the GetServiceSetting API operation to view the current
|
8751
|
+
# value. Use the UpdateServiceSetting API operation to change the
|
8752
|
+
# default setting.
|
8578
8753
|
#
|
8579
8754
|
# Reset the service setting for the account to the default value as
|
8580
|
-
# provisioned by the
|
8755
|
+
# provisioned by the Amazon Web Services service team.
|
8581
8756
|
#
|
8582
8757
|
# @option params [required, String] :setting_id
|
8583
8758
|
# The Amazon Resource Name (ARN) of the service setting to reset. The
|
@@ -8628,7 +8803,7 @@ module Aws::SSM
|
|
8628
8803
|
# terminated sessions.
|
8629
8804
|
#
|
8630
8805
|
# <note markdown="1"> This command is primarily for use by client machines to automatically
|
8631
|
-
# reconnect during intermittent network issues. It
|
8806
|
+
# reconnect during intermittent network issues. It isn't intended for
|
8632
8807
|
# any other use.
|
8633
8808
|
#
|
8634
8809
|
# </note>
|
@@ -8727,8 +8902,8 @@ module Aws::SSM
|
|
8727
8902
|
# tens, hundreds, or thousands of instances at once.
|
8728
8903
|
#
|
8729
8904
|
# For more information about how to use targets, see [Using targets and
|
8730
|
-
# rate controls to send commands to a fleet][1] in the *
|
8731
|
-
# Manager User Guide*.
|
8905
|
+
# rate controls to send commands to a fleet][1] in the *Amazon Web
|
8906
|
+
# Services Systems Manager User Guide*.
|
8732
8907
|
#
|
8733
8908
|
#
|
8734
8909
|
#
|
@@ -8746,18 +8921,20 @@ module Aws::SSM
|
|
8746
8921
|
# `InstanceIds` option instead.
|
8747
8922
|
#
|
8748
8923
|
# For more information about how to use targets, see [Sending commands
|
8749
|
-
# to a fleet][1] in the *
|
8924
|
+
# to a fleet][1] in the *Amazon Web Services Systems Manager User
|
8925
|
+
# Guide*.
|
8750
8926
|
#
|
8751
8927
|
#
|
8752
8928
|
#
|
8753
8929
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
8754
8930
|
#
|
8755
8931
|
# @option params [required, String] :document_name
|
8756
|
-
# The name of the Systems Manager document
|
8757
|
-
# document
|
8758
|
-
#
|
8759
|
-
# how to use shared documents,
|
8760
|
-
# the *
|
8932
|
+
# The name of the Amazon Web Services Systems Manager document (SSM
|
8933
|
+
# document) to run. This can be a public document or a custom document.
|
8934
|
+
# To run a shared document belonging to another account, specify the
|
8935
|
+
# document ARN. For more information about how to use shared documents,
|
8936
|
+
# see [Using shared SSM documents][1] in the *Amazon Web Services
|
8937
|
+
# Systems Manager User Guide*.
|
8761
8938
|
#
|
8762
8939
|
#
|
8763
8940
|
#
|
@@ -8766,9 +8943,10 @@ module Aws::SSM
|
|
8766
8943
|
# @option params [String] :document_version
|
8767
8944
|
# The SSM document version to use in the request. You can specify
|
8768
8945
|
# $DEFAULT, $LATEST, or a specific version number. If you run commands
|
8769
|
-
# by using the
|
8770
|
-
#
|
8771
|
-
# need to use the backslash.
|
8946
|
+
# by using the Command Line Interface (Amazon Web Services CLI), then
|
8947
|
+
# you must escape the first two options by using a backslash. If you
|
8948
|
+
# specify a version number, then you don't need to use the backslash.
|
8949
|
+
# For example:
|
8772
8950
|
#
|
8773
8951
|
# --document-version "\\$DEFAULT"
|
8774
8952
|
#
|
@@ -8792,8 +8970,8 @@ module Aws::SSM
|
|
8792
8970
|
# </note>
|
8793
8971
|
#
|
8794
8972
|
# @option params [Integer] :timeout_seconds
|
8795
|
-
# If this time is reached and the command
|
8796
|
-
# running, it
|
8973
|
+
# If this time is reached and the command hasn't already started
|
8974
|
+
# running, it won't run.
|
8797
8975
|
#
|
8798
8976
|
# @option params [String] :comment
|
8799
8977
|
# User-specified information about the command, such as a brief
|
@@ -8819,9 +8997,9 @@ module Aws::SSM
|
|
8819
8997
|
# @option params [String] :max_concurrency
|
8820
8998
|
# (Optional) The maximum number of instances that are allowed to run the
|
8821
8999
|
# command at the same time. You can specify a number such as 10 or a
|
8822
|
-
# percentage such as 10%. The default value is 50
|
8823
|
-
# about how to use MaxConcurrency
|
8824
|
-
# in the *
|
9000
|
+
# percentage such as 10%. The default value is `50`. For more
|
9001
|
+
# information about how to use `MaxConcurrency`, see [Using concurrency
|
9002
|
+
# controls][1] in the *Amazon Web Services Systems Manager User Guide*.
|
8825
9003
|
#
|
8826
9004
|
#
|
8827
9005
|
#
|
@@ -8829,27 +9007,29 @@ module Aws::SSM
|
|
8829
9007
|
#
|
8830
9008
|
# @option params [String] :max_errors
|
8831
9009
|
# The maximum number of errors allowed without the command failing. When
|
8832
|
-
# the command fails one more time beyond the value of MaxErrors
|
9010
|
+
# the command fails one more time beyond the value of `MaxErrors`, the
|
8833
9011
|
# systems stops sending the command to additional targets. You can
|
8834
9012
|
# specify a number like 10 or a percentage like 10%. The default value
|
8835
|
-
# is 0
|
8836
|
-
# error controls][1] in the *
|
9013
|
+
# is `0`. For more information about how to use `MaxErrors`, see [Using
|
9014
|
+
# error controls][1] in the *Amazon Web Services Systems Manager User
|
9015
|
+
# Guide*.
|
8837
9016
|
#
|
8838
9017
|
#
|
8839
9018
|
#
|
8840
9019
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
|
8841
9020
|
#
|
8842
9021
|
# @option params [String] :service_role_arn
|
8843
|
-
# The ARN of the IAM service role to
|
8844
|
-
# Notification Service (Amazon SNS)
|
8845
|
-
# commands.
|
9022
|
+
# The ARN of the Identity and Access Management (IAM) service role to
|
9023
|
+
# use to publish Amazon Simple Notification Service (Amazon SNS)
|
9024
|
+
# notifications for Run Command commands.
|
8846
9025
|
#
|
8847
9026
|
# @option params [Types::NotificationConfig] :notification_config
|
8848
9027
|
# Configurations for sending notifications.
|
8849
9028
|
#
|
8850
9029
|
# @option params [Types::CloudWatchOutputConfig] :cloud_watch_output_config
|
8851
|
-
# Enables Systems Manager to send Run Command output
|
8852
|
-
# CloudWatch Logs.
|
9030
|
+
# Enables Amazon Web Services Systems Manager to send Run Command output
|
9031
|
+
# to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web
|
9032
|
+
# Services Systems Manager.
|
8853
9033
|
#
|
8854
9034
|
# @return [Types::SendCommandResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8855
9035
|
#
|
@@ -8937,8 +9117,8 @@ module Aws::SSM
|
|
8937
9117
|
req.send_request(options)
|
8938
9118
|
end
|
8939
9119
|
|
8940
|
-
#
|
8941
|
-
#
|
9120
|
+
# Runs an association immediately and only one time. This operation can
|
9121
|
+
# be helpful when troubleshooting associations.
|
8942
9122
|
#
|
8943
9123
|
# @option params [required, Array<String>] :association_ids
|
8944
9124
|
# The association IDs that you want to run immediately and only one
|
@@ -8961,25 +9141,25 @@ module Aws::SSM
|
|
8961
9141
|
req.send_request(options)
|
8962
9142
|
end
|
8963
9143
|
|
8964
|
-
# Initiates execution of an Automation
|
9144
|
+
# Initiates execution of an Automation runbook.
|
8965
9145
|
#
|
8966
9146
|
# @option params [required, String] :document_name
|
8967
|
-
# The name of the
|
8968
|
-
#
|
8969
|
-
#
|
8970
|
-
#
|
8971
|
-
#
|
9147
|
+
# The name of the SSM document to run. This can be a public document or
|
9148
|
+
# a custom document. To run a shared document belonging to another
|
9149
|
+
# account, specify the document ARN. For more information about how to
|
9150
|
+
# use shared documents, see [Using shared SSM documents][1] in the
|
9151
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
8972
9152
|
#
|
8973
9153
|
#
|
8974
9154
|
#
|
8975
9155
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
8976
9156
|
#
|
8977
9157
|
# @option params [String] :document_version
|
8978
|
-
# The version of the Automation
|
9158
|
+
# The version of the Automation runbook to use for this execution.
|
8979
9159
|
#
|
8980
9160
|
# @option params [Hash<String,Array>] :parameters
|
8981
9161
|
# A key-value map of execution parameters, which match the declared
|
8982
|
-
# parameters in the Automation
|
9162
|
+
# parameters in the Automation runbook.
|
8983
9163
|
#
|
8984
9164
|
# @option params [String] :client_token
|
8985
9165
|
# User-provided idempotency token. The token must be unique, is case
|
@@ -8999,12 +9179,12 @@ module Aws::SSM
|
|
8999
9179
|
#
|
9000
9180
|
# @option params [Array<Hash>] :target_maps
|
9001
9181
|
# A key-value mapping of document parameters to target resources. Both
|
9002
|
-
# Targets and TargetMaps
|
9182
|
+
# Targets and TargetMaps can't be specified together.
|
9003
9183
|
#
|
9004
9184
|
# @option params [String] :max_concurrency
|
9005
9185
|
# The maximum number of targets allowed to run this task in parallel.
|
9006
9186
|
# You can specify a number, such as 10, or a percentage, such as 10%.
|
9007
|
-
# The default value is 10
|
9187
|
+
# The default value is `10`.
|
9008
9188
|
#
|
9009
9189
|
# @option params [String] :max_errors
|
9010
9190
|
# The number of errors that are allowed before the system stops running
|
@@ -9025,11 +9205,11 @@ module Aws::SSM
|
|
9025
9205
|
# executions proceed one at a time.
|
9026
9206
|
#
|
9027
9207
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
9028
|
-
# A location is a combination of
|
9029
|
-
#
|
9030
|
-
#
|
9031
|
-
# [Running Automation workflows in multiple
|
9032
|
-
#
|
9208
|
+
# A location is a combination of Regions and/or accounts where you want
|
9209
|
+
# to run the automation. Use this operation to start an automation in
|
9210
|
+
# multiple Regions and multiple accounts. For more information, see
|
9211
|
+
# [Running Automation workflows in multiple Regions and accounts][1] in
|
9212
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
9033
9213
|
#
|
9034
9214
|
#
|
9035
9215
|
#
|
@@ -9041,14 +9221,14 @@ module Aws::SSM
|
|
9041
9221
|
# a resource in different ways, such as by purpose, owner, or
|
9042
9222
|
# environment. For example, you might want to tag an automation to
|
9043
9223
|
# identify an environment or operating system. In this case, you could
|
9044
|
-
# specify the following key
|
9224
|
+
# specify the following key-value pairs:
|
9045
9225
|
#
|
9046
9226
|
# * `Key=environment,Value=test`
|
9047
9227
|
#
|
9048
9228
|
# * `Key=OS,Value=Windows`
|
9049
9229
|
#
|
9050
9230
|
# <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
|
9051
|
-
#
|
9231
|
+
# operation.
|
9052
9232
|
#
|
9053
9233
|
# </note>
|
9054
9234
|
#
|
@@ -9110,9 +9290,9 @@ module Aws::SSM
|
|
9110
9290
|
req.send_request(options)
|
9111
9291
|
end
|
9112
9292
|
|
9113
|
-
# Creates a change request for Change Manager. The runbooks
|
9114
|
-
#
|
9115
|
-
#
|
9293
|
+
# Creates a change request for Change Manager. The Automation runbooks
|
9294
|
+
# specified in the change request run only after all required approvals
|
9295
|
+
# for the change request have been received.
|
9116
9296
|
#
|
9117
9297
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
9118
9298
|
# The date and time specified in the change request to run the
|
@@ -9145,8 +9325,8 @@ module Aws::SSM
|
|
9145
9325
|
# insensitive, enforces the UUID format, and can't be reused.
|
9146
9326
|
#
|
9147
9327
|
# @option params [required, Array<Types::Runbook>] :runbooks
|
9148
|
-
# Information about the Automation runbooks
|
9149
|
-
#
|
9328
|
+
# Information about the Automation runbooks that are run during the
|
9329
|
+
# runbook workflow.
|
9150
9330
|
#
|
9151
9331
|
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
9152
9332
|
# until all required approvals for the change request have been
|
@@ -9159,7 +9339,7 @@ module Aws::SSM
|
|
9159
9339
|
# maximum of five tags for a change request. Tags enable you to
|
9160
9340
|
# categorize a resource in different ways, such as by purpose, owner, or
|
9161
9341
|
# environment. For example, you might want to tag a change request to
|
9162
|
-
# identify an environment or target
|
9342
|
+
# identify an environment or target Region. In this case, you could
|
9163
9343
|
# specify the following key-value pairs:
|
9164
9344
|
#
|
9165
9345
|
# * `Key=Environment,Value=Production`
|
@@ -9245,13 +9425,15 @@ module Aws::SSM
|
|
9245
9425
|
# Session Manager session. Returns a URL and token that can be used to
|
9246
9426
|
# open a WebSocket connection for sending input and receiving outputs.
|
9247
9427
|
#
|
9248
|
-
# <note markdown="1">
|
9249
|
-
# the Session Manager plugin to be installed on
|
9250
|
-
# making the call. For information, see [Install the
|
9251
|
-
# plugin for the
|
9428
|
+
# <note markdown="1"> Amazon Web Services CLI usage: `start-session` is an interactive
|
9429
|
+
# command that requires the Session Manager plugin to be installed on
|
9430
|
+
# the client machine making the call. For information, see [Install the
|
9431
|
+
# Session Manager plugin for the Amazon Web Services CLI][1] in the
|
9432
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
9252
9433
|
#
|
9253
|
-
#
|
9254
|
-
# supported by
|
9434
|
+
# Amazon Web Services Tools for PowerShell usage: Start-SSMSession
|
9435
|
+
# isn't currently supported by Amazon Web Services Tools for PowerShell
|
9436
|
+
# on Windows local machines.
|
9255
9437
|
#
|
9256
9438
|
# </note>
|
9257
9439
|
#
|
@@ -9332,7 +9514,7 @@ module Aws::SSM
|
|
9332
9514
|
|
9333
9515
|
# Permanently ends a session and closes the data connection between the
|
9334
9516
|
# Session Manager client and SSM Agent on the instance. A terminated
|
9335
|
-
# session
|
9517
|
+
# session isn't be resumed.
|
9336
9518
|
#
|
9337
9519
|
# @option params [required, String] :session_id
|
9338
9520
|
# The ID of the session to terminate.
|
@@ -9363,11 +9545,12 @@ module Aws::SSM
|
|
9363
9545
|
# Remove a label or labels from a parameter.
|
9364
9546
|
#
|
9365
9547
|
# @option params [required, String] :name
|
9366
|
-
# The
|
9548
|
+
# The name of the parameter from which you want to delete one or more
|
9549
|
+
# labels.
|
9367
9550
|
#
|
9368
9551
|
# @option params [required, Integer] :parameter_version
|
9369
9552
|
# The specific version of the parameter which you want to delete one or
|
9370
|
-
# more labels from. If it
|
9553
|
+
# more labels from. If it isn't present, the call will fail.
|
9371
9554
|
#
|
9372
9555
|
# @option params [required, Array<String>] :labels
|
9373
9556
|
# One or more labels to delete from the specified parameter version.
|
@@ -9402,16 +9585,17 @@ module Aws::SSM
|
|
9402
9585
|
end
|
9403
9586
|
|
9404
9587
|
# Updates an association. You can update the association name and
|
9405
|
-
# version, the document version, schedule, parameters, and Amazon
|
9406
|
-
# output.
|
9407
|
-
#
|
9408
|
-
# In order to call this API
|
9409
|
-
# role must be configured with
|
9410
|
-
# DescribeAssociation API
|
9411
|
-
#
|
9412
|
-
# occurred (AccessDeniedException) when
|
9413
|
-
# operation: User: <user_arn>
|
9414
|
-
# ssm:DescribeAssociation on resource:
|
9588
|
+
# version, the document version, schedule, parameters, and Amazon Simple
|
9589
|
+
# Storage Service (Amazon S3) output.
|
9590
|
+
#
|
9591
|
+
# In order to call this API operation, your Identity and Access
|
9592
|
+
# Management (IAM) user account, group, or role must be configured with
|
9593
|
+
# permission to call the DescribeAssociation API operation. If you
|
9594
|
+
# don't have permission to call `DescribeAssociation`, then you receive
|
9595
|
+
# the following error: `An error occurred (AccessDeniedException) when
|
9596
|
+
# calling the UpdateAssociation operation: User: <user_arn> isn't
|
9597
|
+
# authorized to perform: ssm:DescribeAssociation on resource:
|
9598
|
+
# <resource_arn>`
|
9415
9599
|
#
|
9416
9600
|
# When you update an association, the association immediately runs
|
9417
9601
|
# against the specified targets.
|
@@ -9421,8 +9605,9 @@ module Aws::SSM
|
|
9421
9605
|
#
|
9422
9606
|
# @option params [Hash<String,Array>] :parameters
|
9423
9607
|
# The parameters you want to update for the association. If you create a
|
9424
|
-
# parameter using Parameter Store,
|
9425
|
-
#
|
9608
|
+
# parameter using Parameter Store, a capability of Amazon Web Services
|
9609
|
+
# Systems Manager, you can reference the parameter using
|
9610
|
+
# `\{\{ssm:parameter-name\}\}`.
|
9426
9611
|
#
|
9427
9612
|
# @option params [String] :document_version
|
9428
9613
|
# The document version you want update for the association.
|
@@ -9435,16 +9620,16 @@ module Aws::SSM
|
|
9435
9620
|
# An S3 bucket where you want to store the results of this request.
|
9436
9621
|
#
|
9437
9622
|
# @option params [String] :name
|
9438
|
-
# The name of the SSM document
|
9439
|
-
# information for the instance.
|
9440
|
-
# documents.
|
9623
|
+
# The name of the SSM Command document or Automation runbook that
|
9624
|
+
# contains the configuration information for the instance.
|
9441
9625
|
#
|
9442
|
-
# You can specify
|
9443
|
-
# document that is shared with you from another
|
9626
|
+
# You can specify Amazon Web Services-predefined documents, documents
|
9627
|
+
# you created, or a document that is shared with you from another
|
9628
|
+
# account.
|
9444
9629
|
#
|
9445
|
-
# For SSM
|
9446
|
-
# you must specify the complete SSM document ARN,
|
9447
|
-
# format:
|
9630
|
+
# For Systems Manager document (SSM document) that are shared with you
|
9631
|
+
# from other accounts, you must specify the complete SSM document ARN,
|
9632
|
+
# in the following format:
|
9448
9633
|
#
|
9449
9634
|
# `arn:aws:ssm:region:account-id:document/document-name `
|
9450
9635
|
#
|
@@ -9452,9 +9637,9 @@ module Aws::SSM
|
|
9452
9637
|
#
|
9453
9638
|
# `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
|
9454
9639
|
#
|
9455
|
-
# For
|
9456
|
-
# account, you only need to specify the document name.
|
9457
|
-
# `AWS-ApplyPatchBaseline` or `My-Document`.
|
9640
|
+
# For Amazon Web Services-predefined documents and SSM documents you
|
9641
|
+
# created in your account, you only need to specify the document name.
|
9642
|
+
# For example, `AWS-ApplyPatchBaseline` or `My-Document`.
|
9458
9643
|
#
|
9459
9644
|
# @option params [Array<Types::Target>] :targets
|
9460
9645
|
# The targets of the association.
|
@@ -9470,8 +9655,9 @@ module Aws::SSM
|
|
9470
9655
|
#
|
9471
9656
|
# @option params [String] :automation_target_parameter_name
|
9472
9657
|
# Specify the target for the association. This target is required for
|
9473
|
-
# associations that use an Automation
|
9474
|
-
# using rate controls.
|
9658
|
+
# associations that use an Automation runbook and target resources by
|
9659
|
+
# using rate controls. Automation is a capability of Amazon Web Services
|
9660
|
+
# Systems Manager.
|
9475
9661
|
#
|
9476
9662
|
# @option params [String] :max_errors
|
9477
9663
|
# The number of errors that are allowed before the system stops sending
|
@@ -9481,13 +9667,13 @@ module Aws::SSM
|
|
9481
9667
|
# system stops sending requests when the fourth error is received. If
|
9482
9668
|
# you specify 0, then the system stops sending requests after the first
|
9483
9669
|
# error is returned. If you run an association on 50 instances and set
|
9484
|
-
# MaxError to 10%, then the system stops sending the request when the
|
9670
|
+
# `MaxError` to 10%, then the system stops sending the request when the
|
9485
9671
|
# sixth error is received.
|
9486
9672
|
#
|
9487
|
-
# Executions that are already running an association when MaxErrors is
|
9673
|
+
# Executions that are already running an association when `MaxErrors` is
|
9488
9674
|
# reached are allowed to complete, but some of these executions may fail
|
9489
9675
|
# as well. If you need to ensure that there won't be more than
|
9490
|
-
# max-errors failed executions, set MaxConcurrency to 1 so that
|
9676
|
+
# max-errors failed executions, set `MaxConcurrency` to 1 so that
|
9491
9677
|
# executions proceed one at a time.
|
9492
9678
|
#
|
9493
9679
|
# @option params [String] :max_concurrency
|
@@ -9497,10 +9683,10 @@ module Aws::SSM
|
|
9497
9683
|
# means all targets run the association at the same time.
|
9498
9684
|
#
|
9499
9685
|
# If a new instance starts and attempts to run an association while
|
9500
|
-
# Systems Manager is running MaxConcurrency associations, the
|
9686
|
+
# Systems Manager is running `MaxConcurrency` associations, the
|
9501
9687
|
# association is allowed to run. During the next association interval,
|
9502
9688
|
# the new instance will process its association within the limit
|
9503
|
-
# specified for MaxConcurrency
|
9689
|
+
# specified for `MaxConcurrency`.
|
9504
9690
|
#
|
9505
9691
|
# @option params [String] :compliance_severity
|
9506
9692
|
# The severity level to assign to the association.
|
@@ -9514,9 +9700,10 @@ module Aws::SSM
|
|
9514
9700
|
# the association is `NON-COMPLIANT`.
|
9515
9701
|
#
|
9516
9702
|
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
9517
|
-
# for the PutComplianceItems API
|
9518
|
-
#
|
9519
|
-
#
|
9703
|
+
# for the PutComplianceItems API operation. In this case, compliance
|
9704
|
+
# data isn't managed by State Manager, a capability of Amazon Web
|
9705
|
+
# Services Systems Manager. It is managed by your direct call to the
|
9706
|
+
# PutComplianceItems API operation.
|
9520
9707
|
#
|
9521
9708
|
# By default, all associations use `AUTO` mode.
|
9522
9709
|
#
|
@@ -9524,7 +9711,7 @@ module Aws::SSM
|
|
9524
9711
|
# By default, when you update an association, the system runs it
|
9525
9712
|
# immediately after it is updated and then according to the schedule you
|
9526
9713
|
# specified. Specify this option if you don't want an association to
|
9527
|
-
# run immediately after you update it. This parameter
|
9714
|
+
# run immediately after you update it. This parameter isn't supported
|
9528
9715
|
# for rate expressions.
|
9529
9716
|
#
|
9530
9717
|
# Also, if you specified this option when you created the association,
|
@@ -9535,19 +9722,19 @@ module Aws::SSM
|
|
9535
9722
|
# interval specified.
|
9536
9723
|
#
|
9537
9724
|
# @option params [Array<String>] :calendar_names
|
9538
|
-
# The names or Amazon Resource Names (ARNs) of the
|
9539
|
-
#
|
9540
|
-
#
|
9541
|
-
#
|
9725
|
+
# The names or Amazon Resource Names (ARNs) of the Change Calendar type
|
9726
|
+
# documents you want to gate your associations under. The associations
|
9727
|
+
# only run when that change calendar is open. For more information, see
|
9728
|
+
# [Amazon Web Services Systems Manager Change Calendar][1].
|
9542
9729
|
#
|
9543
9730
|
#
|
9544
9731
|
#
|
9545
9732
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
9546
9733
|
#
|
9547
9734
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
9548
|
-
# A location is a combination of
|
9549
|
-
#
|
9550
|
-
#
|
9735
|
+
# A location is a combination of Regions and accounts where you want to
|
9736
|
+
# run the association. Use this action to update an association in
|
9737
|
+
# multiple Regions and multiple accounts.
|
9551
9738
|
#
|
9552
9739
|
# @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9553
9740
|
#
|
@@ -9653,11 +9840,11 @@ module Aws::SSM
|
|
9653
9840
|
req.send_request(options)
|
9654
9841
|
end
|
9655
9842
|
|
9656
|
-
# Updates the status of the Systems Manager document
|
9657
|
-
# specified instance.
|
9843
|
+
# Updates the status of the Amazon Web Services Systems Manager document
|
9844
|
+
# (SSM document) associated with the specified instance.
|
9658
9845
|
#
|
9659
9846
|
# @option params [required, String] :name
|
9660
|
-
# The name of the
|
9847
|
+
# The name of the SSM document.
|
9661
9848
|
#
|
9662
9849
|
# @option params [required, String] :instance_id
|
9663
9850
|
# The ID of the instance.
|
@@ -9745,22 +9932,22 @@ module Aws::SSM
|
|
9745
9932
|
# A valid JSON or YAML string.
|
9746
9933
|
#
|
9747
9934
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
9748
|
-
# A list of key
|
9749
|
-
#
|
9935
|
+
# A list of key-value pairs that describe attachments to a version of a
|
9936
|
+
# document.
|
9750
9937
|
#
|
9751
9938
|
# @option params [required, String] :name
|
9752
|
-
# The name of the
|
9939
|
+
# The name of the SSM document that you want to update.
|
9753
9940
|
#
|
9754
9941
|
# @option params [String] :display_name
|
9755
|
-
# The friendly name of the
|
9756
|
-
#
|
9757
|
-
#
|
9758
|
-
#
|
9942
|
+
# The friendly name of the SSM document that you want to update. This
|
9943
|
+
# value can differ for each version of the document. If you don't
|
9944
|
+
# specify a value for this parameter in your request, the existing value
|
9945
|
+
# is applied to the new document version.
|
9759
9946
|
#
|
9760
9947
|
# @option params [String] :version_name
|
9761
9948
|
# An optional field specifying the version of the artifact you are
|
9762
9949
|
# updating with the document. For example, "Release 12, Update 6".
|
9763
|
-
# This value is unique across all versions of a document, and
|
9950
|
+
# This value is unique across all versions of a document, and can't be
|
9764
9951
|
# changed.
|
9765
9952
|
#
|
9766
9953
|
# @option params [String] :document_version
|
@@ -9961,7 +10148,7 @@ module Aws::SSM
|
|
9961
10148
|
#
|
9962
10149
|
# @option params [String] :end_date
|
9963
10150
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
9964
|
-
# maintenance window to become inactive. EndDate allows you to set a
|
10151
|
+
# maintenance window to become inactive. `EndDate` allows you to set a
|
9965
10152
|
# date and time in the future when the maintenance window will no longer
|
9966
10153
|
# run.
|
9967
10154
|
#
|
@@ -9980,7 +10167,7 @@ module Aws::SSM
|
|
9980
10167
|
# [1]: https://www.iana.org/time-zones
|
9981
10168
|
#
|
9982
10169
|
# @option params [Integer] :schedule_offset
|
9983
|
-
# The number of days to wait after the date and time specified by a
|
10170
|
+
# The number of days to wait after the date and time specified by a cron
|
9984
10171
|
# expression before running the maintenance window.
|
9985
10172
|
#
|
9986
10173
|
# For example, the following cron expression schedules a maintenance
|
@@ -9996,7 +10183,8 @@ module Aws::SSM
|
|
9996
10183
|
#
|
9997
10184
|
# @option params [Integer] :cutoff
|
9998
10185
|
# The number of hours before the end of the maintenance window that
|
9999
|
-
# Systems Manager stops scheduling new tasks for
|
10186
|
+
# Amazon Web Services Systems Manager stops scheduling new tasks for
|
10187
|
+
# execution.
|
10000
10188
|
#
|
10001
10189
|
# @option params [Boolean] :allow_unassociated_targets
|
10002
10190
|
# Whether targets must be registered with the maintenance window before
|
@@ -10006,9 +10194,9 @@ module Aws::SSM
|
|
10006
10194
|
# Whether the maintenance window is enabled.
|
10007
10195
|
#
|
10008
10196
|
# @option params [Boolean] :replace
|
10009
|
-
# If True
|
10010
|
-
# CreateMaintenanceWindow
|
10011
|
-
# Optional fields that
|
10197
|
+
# If `True`, then all fields that are required by the
|
10198
|
+
# CreateMaintenanceWindow operation are also required for this API
|
10199
|
+
# request. Optional fields that aren't specified are set to null.
|
10012
10200
|
#
|
10013
10201
|
# @return [Types::UpdateMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10014
10202
|
#
|
@@ -10084,7 +10272,7 @@ module Aws::SSM
|
|
10084
10272
|
# types are ID target, Tag target, and resource group. For more
|
10085
10273
|
# information, see Target.
|
10086
10274
|
#
|
10087
|
-
# <note markdown="1"> If a parameter is null, then the corresponding field
|
10275
|
+
# <note markdown="1"> If a parameter is null, then the corresponding field isn't modified.
|
10088
10276
|
#
|
10089
10277
|
# </note>
|
10090
10278
|
#
|
@@ -10098,9 +10286,9 @@ module Aws::SSM
|
|
10098
10286
|
# The targets to add or replace.
|
10099
10287
|
#
|
10100
10288
|
# @option params [String] :owner_information
|
10101
|
-
# User-provided value that will be included in any CloudWatch
|
10102
|
-
# raised while running tasks for these targets in this
|
10103
|
-
# window.
|
10289
|
+
# User-provided value that will be included in any Amazon CloudWatch
|
10290
|
+
# Events events raised while running tasks for these targets in this
|
10291
|
+
# maintenance window.
|
10104
10292
|
#
|
10105
10293
|
# @option params [String] :name
|
10106
10294
|
# A name for the update.
|
@@ -10109,9 +10297,10 @@ module Aws::SSM
|
|
10109
10297
|
# An optional description for the update.
|
10110
10298
|
#
|
10111
10299
|
# @option params [Boolean] :replace
|
10112
|
-
# If True
|
10113
|
-
# RegisterTargetWithMaintenanceWindow
|
10114
|
-
# API request. Optional fields that
|
10300
|
+
# If `True`, then all fields that are required by the
|
10301
|
+
# RegisterTargetWithMaintenanceWindow operation are also required for
|
10302
|
+
# this API request. Optional fields that aren't specified are set to
|
10303
|
+
# null.
|
10115
10304
|
#
|
10116
10305
|
# @return [Types::UpdateMaintenanceWindowTargetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10117
10306
|
#
|
@@ -10163,38 +10352,38 @@ module Aws::SSM
|
|
10163
10352
|
# Modifies a task assigned to a maintenance window. You can't change
|
10164
10353
|
# the task type, but you can change the following values:
|
10165
10354
|
#
|
10166
|
-
# * TaskARN
|
10167
|
-
# AWS-RunPowerShellScript to AWS-RunShellScript
|
10355
|
+
# * `TaskARN`. For example, you can change a `RUN_COMMAND` task from
|
10356
|
+
# `AWS-RunPowerShellScript` to `AWS-RunShellScript`.
|
10168
10357
|
#
|
10169
|
-
# * ServiceRoleArn
|
10358
|
+
# * `ServiceRoleArn`
|
10170
10359
|
#
|
10171
|
-
# * TaskInvocationParameters
|
10360
|
+
# * `TaskInvocationParameters`
|
10172
10361
|
#
|
10173
|
-
# * Priority
|
10362
|
+
# * `Priority`
|
10174
10363
|
#
|
10175
|
-
# * MaxConcurrency
|
10364
|
+
# * `MaxConcurrency`
|
10176
10365
|
#
|
10177
|
-
# * MaxErrors
|
10366
|
+
# * `MaxErrors`
|
10178
10367
|
#
|
10179
10368
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
10180
10369
|
# Command-type tasks. Depending on the task, targets are optional for
|
10181
|
-
# other maintenance window task types (Automation,
|
10182
|
-
#
|
10370
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
10371
|
+
# Functions). For more information about running tasks that don't
|
10183
10372
|
# specify targets, see [Registering maintenance window tasks without
|
10184
|
-
# targets][1] in the *
|
10373
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
10185
10374
|
#
|
10186
10375
|
# </note>
|
10187
10376
|
#
|
10188
10377
|
# If the value for a parameter in `UpdateMaintenanceWindowTask` is null,
|
10189
|
-
# then the corresponding field
|
10378
|
+
# then the corresponding field isn't modified. If you set `Replace` to
|
10190
10379
|
# true, then all fields required by the
|
10191
|
-
# RegisterTaskWithMaintenanceWindow
|
10380
|
+
# RegisterTaskWithMaintenanceWindow operation are required for this
|
10192
10381
|
# request. Optional fields that aren't specified are set to null.
|
10193
10382
|
#
|
10194
10383
|
# When you update a maintenance window task that has options specified
|
10195
10384
|
# in `TaskInvocationParameters`, you must provide again all the
|
10196
10385
|
# `TaskInvocationParameters` values that you want to retain. The values
|
10197
|
-
# you
|
10386
|
+
# you don't specify again are removed. For example, suppose that when
|
10198
10387
|
# you registered a Run Command task, you specified
|
10199
10388
|
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
10200
10389
|
# and `OutputS3BucketName`. If you update the maintenance window task
|
@@ -10213,15 +10402,16 @@ module Aws::SSM
|
|
10213
10402
|
#
|
10214
10403
|
# @option params [Array<Types::Target>] :targets
|
10215
10404
|
# The targets (either instances or tags) to modify. Instances are
|
10216
|
-
# specified using
|
10217
|
-
# Tags are specified
|
10405
|
+
# specified using the format
|
10406
|
+
# `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified
|
10407
|
+
# using the format ` Key=tag_name,Values=tag_value`.
|
10218
10408
|
#
|
10219
10409
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
10220
10410
|
# Command-type tasks. Depending on the task, targets are optional for
|
10221
|
-
# other maintenance window task types (Automation,
|
10222
|
-
#
|
10411
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
10412
|
+
# Functions). For more information about running tasks that don't
|
10223
10413
|
# specify targets, see [Registering maintenance window tasks without
|
10224
|
-
# targets][1] in the *
|
10414
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
10225
10415
|
#
|
10226
10416
|
# </note>
|
10227
10417
|
#
|
@@ -10233,14 +10423,15 @@ module Aws::SSM
|
|
10233
10423
|
# The task ARN to modify.
|
10234
10424
|
#
|
10235
10425
|
# @option params [String] :service_role_arn
|
10236
|
-
# The ARN of the IAM service role for
|
10237
|
-
#
|
10238
|
-
#
|
10239
|
-
#
|
10240
|
-
# is created when you run
|
10426
|
+
# The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
|
10427
|
+
# Services Systems Manager to assume when running a maintenance window
|
10428
|
+
# task. If you do not specify a service role ARN, Systems Manager uses
|
10429
|
+
# your account's service-linked role. If no service-linked role for
|
10430
|
+
# Systems Manager exists in your account, it is created when you run
|
10431
|
+
# `RegisterTaskWithMaintenanceWindow`.
|
10241
10432
|
#
|
10242
|
-
# For more information, see the following topics in the in the *
|
10243
|
-
# Systems Manager User Guide*\:
|
10433
|
+
# For more information, see the following topics in the in the *Amazon
|
10434
|
+
# Web Services Systems Manager User Guide*\:
|
10244
10435
|
#
|
10245
10436
|
# * [Using service-linked roles for Systems Manager][1]
|
10246
10437
|
#
|
@@ -10278,7 +10469,7 @@ module Aws::SSM
|
|
10278
10469
|
# When you update a maintenance window task that has options specified
|
10279
10470
|
# in `TaskInvocationParameters`, you must provide again all the
|
10280
10471
|
# `TaskInvocationParameters` values that you want to retain. The values
|
10281
|
-
# you
|
10472
|
+
# you don't specify again are removed. For example, suppose that when
|
10282
10473
|
# you registered a Run Command task, you specified
|
10283
10474
|
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
10284
10475
|
# and `OutputS3BucketName`. If you update the maintenance window task
|
@@ -10294,10 +10485,10 @@ module Aws::SSM
|
|
10294
10485
|
# is the number of targets that are allowed to run this task in
|
10295
10486
|
# parallel.
|
10296
10487
|
#
|
10297
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
10488
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
10298
10489
|
# supply a value for this option. Instead, the system inserts a
|
10299
10490
|
# placeholder value of `1`, which may be reported in the response to
|
10300
|
-
# this command. This value
|
10491
|
+
# this command. This value doesn't affect the running of your task and
|
10301
10492
|
# can be ignored.
|
10302
10493
|
#
|
10303
10494
|
# </note>
|
@@ -10307,10 +10498,10 @@ module Aws::SSM
|
|
10307
10498
|
# number of errors that are allowed before the task stops being
|
10308
10499
|
# scheduled.
|
10309
10500
|
#
|
10310
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
10501
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
10311
10502
|
# supply a value for this option. Instead, the system inserts a
|
10312
10503
|
# placeholder value of `1`, which may be reported in the response to
|
10313
|
-
# this command. This value
|
10504
|
+
# this command. This value doesn't affect the running of your task and
|
10314
10505
|
# can be ignored.
|
10315
10506
|
#
|
10316
10507
|
# </note>
|
@@ -10318,10 +10509,11 @@ module Aws::SSM
|
|
10318
10509
|
# @option params [Types::LoggingInfo] :logging_info
|
10319
10510
|
# The new logging location in Amazon S3 to specify.
|
10320
10511
|
#
|
10321
|
-
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an
|
10322
|
-
# logs, instead use the
|
10323
|
-
#
|
10324
|
-
#
|
10512
|
+
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
10513
|
+
# Service (Amazon S3) bucket to contain logs, instead use the
|
10514
|
+
# `OutputS3BucketName` and `OutputS3KeyPrefix` options in the
|
10515
|
+
# `TaskInvocationParameters` structure. For information about how Amazon
|
10516
|
+
# Web Services Systems Manager handles these options for the supported
|
10325
10517
|
# maintenance window task types, see
|
10326
10518
|
# MaintenanceWindowTaskInvocationParameters.
|
10327
10519
|
#
|
@@ -10335,8 +10527,8 @@ module Aws::SSM
|
|
10335
10527
|
#
|
10336
10528
|
# @option params [Boolean] :replace
|
10337
10529
|
# If True, then all fields that are required by the
|
10338
|
-
# RegisterTaskWithMaintenanceWindow
|
10339
|
-
# API request. Optional fields that
|
10530
|
+
# RegisterTaskWithMaintenanceWindow operation are also required for this
|
10531
|
+
# API request. Optional fields that aren't specified are set to null.
|
10340
10532
|
#
|
10341
10533
|
# @return [Types::UpdateMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10342
10534
|
#
|
@@ -10481,10 +10673,10 @@ module Aws::SSM
|
|
10481
10673
|
req.send_request(options)
|
10482
10674
|
end
|
10483
10675
|
|
10484
|
-
# Changes the
|
10485
|
-
#
|
10486
|
-
#
|
10487
|
-
#
|
10676
|
+
# Changes the Identity and Access Management (IAM) role that is assigned
|
10677
|
+
# to the on-premises instance or virtual machines (VM). IAM roles are
|
10678
|
+
# first assigned to these hybrid instances during the activation
|
10679
|
+
# process. For more information, see CreateActivation.
|
10488
10680
|
#
|
10489
10681
|
# @option params [required, String] :instance_id
|
10490
10682
|
# The ID of the managed instance where you want to update the role.
|
@@ -10510,16 +10702,17 @@ module Aws::SSM
|
|
10510
10702
|
req.send_request(options)
|
10511
10703
|
end
|
10512
10704
|
|
10513
|
-
# Edit or change an OpsItem. You must have permission in
|
10514
|
-
#
|
10515
|
-
#
|
10705
|
+
# Edit or change an OpsItem. You must have permission in Identity and
|
10706
|
+
# Access Management (IAM) to update an OpsItem. For more information,
|
10707
|
+
# see [Getting started with OpsCenter][1] in the *Amazon Web Services
|
10516
10708
|
# Systems Manager User Guide*.
|
10517
10709
|
#
|
10518
|
-
# Operations engineers and IT professionals use
|
10519
|
-
# investigate, and remediate
|
10520
|
-
# performance and health of their
|
10521
|
-
#
|
10522
|
-
# User
|
10710
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
10711
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
10712
|
+
# operational issues impacting the performance and health of their
|
10713
|
+
# Amazon Web Services resources. For more information, see
|
10714
|
+
# [OpsCenter][2] in the *Amazon Web Services Systems Manager User
|
10715
|
+
# Guide*.
|
10523
10716
|
#
|
10524
10717
|
#
|
10525
10718
|
#
|
@@ -10541,22 +10734,23 @@ module Aws::SSM
|
|
10541
10734
|
# You enter operational data as key-value pairs. The key has a maximum
|
10542
10735
|
# length of 128 characters. The value has a maximum size of 20 KB.
|
10543
10736
|
#
|
10544
|
-
# Operational data keys *can't* begin with the following: amazon
|
10545
|
-
# amzn
|
10737
|
+
# Operational data keys *can't* begin with the following: `amazon`,
|
10738
|
+
# `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
|
10546
10739
|
#
|
10547
10740
|
# You can choose to make the data searchable by other users in the
|
10548
10741
|
# account or you can restrict search access. Searchable data means that
|
10549
10742
|
# all users with access to the OpsItem Overview page (as provided by the
|
10550
|
-
# DescribeOpsItems API
|
10551
|
-
# data. Operational data that
|
10743
|
+
# DescribeOpsItems API operation) can view and search on the specified
|
10744
|
+
# data. Operational data that isn't searchable is only viewable by
|
10552
10745
|
# users who have access to the OpsItem (as provided by the GetOpsItem
|
10553
|
-
# API
|
10746
|
+
# API operation).
|
10554
10747
|
#
|
10555
10748
|
# Use the `/aws/resources` key in OperationalData to specify a related
|
10556
10749
|
# resource in the request. Use the `/aws/automations` key in
|
10557
10750
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
10558
|
-
# To view
|
10559
|
-
# OpsItems manually][1] in the *
|
10751
|
+
# To view Amazon Web Services CLI example commands that use these keys,
|
10752
|
+
# see [Creating OpsItems manually][1] in the *Amazon Web Services
|
10753
|
+
# Systems Manager User Guide*.
|
10560
10754
|
#
|
10561
10755
|
#
|
10562
10756
|
#
|
@@ -10582,7 +10776,7 @@ module Aws::SSM
|
|
10582
10776
|
# @option params [String] :status
|
10583
10777
|
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
10584
10778
|
# `Resolved`. For more information, see [Editing OpsItem details][1] in
|
10585
|
-
# the *
|
10779
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
10586
10780
|
#
|
10587
10781
|
#
|
10588
10782
|
#
|
@@ -10642,7 +10836,7 @@ module Aws::SSM
|
|
10642
10836
|
# ops_item_id: "String", # required
|
10643
10837
|
# },
|
10644
10838
|
# ],
|
10645
|
-
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
|
10839
|
+
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected, Closed
|
10646
10840
|
# ops_item_id: "OpsItemId", # required
|
10647
10841
|
# title: "OpsItemTitle",
|
10648
10842
|
# category: "OpsItemCategory",
|
@@ -10662,8 +10856,8 @@ module Aws::SSM
|
|
10662
10856
|
req.send_request(options)
|
10663
10857
|
end
|
10664
10858
|
|
10665
|
-
# Systems Manager calls this API
|
10666
|
-
# Application Manager.
|
10859
|
+
# Amazon Web Services Systems Manager calls this API operation when you
|
10860
|
+
# edit OpsMetadata in Application Manager.
|
10667
10861
|
#
|
10668
10862
|
# @option params [required, String] :ops_metadata_arn
|
10669
10863
|
# The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
|
@@ -10706,15 +10900,11 @@ module Aws::SSM
|
|
10706
10900
|
# Modifies an existing patch baseline. Fields not specified in the
|
10707
10901
|
# request are left unchanged.
|
10708
10902
|
#
|
10709
|
-
# <note markdown="1"> For information about valid key
|
10710
|
-
#
|
10903
|
+
# <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
|
10904
|
+
# supported operating system type, see PatchFilter.
|
10711
10905
|
#
|
10712
10906
|
# </note>
|
10713
10907
|
#
|
10714
|
-
#
|
10715
|
-
#
|
10716
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
|
10717
|
-
#
|
10718
10908
|
# @option params [required, String] :baseline_id
|
10719
10909
|
# The ID of the patch baseline to update.
|
10720
10910
|
#
|
@@ -10732,7 +10922,8 @@ module Aws::SSM
|
|
10732
10922
|
#
|
10733
10923
|
# For information about accepted formats for lists of approved patches
|
10734
10924
|
# and rejected patches, see [About package name formats for approved and
|
10735
|
-
# rejected patch lists][1] in the *
|
10925
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
10926
|
+
# User Guide*.
|
10736
10927
|
#
|
10737
10928
|
#
|
10738
10929
|
#
|
@@ -10744,14 +10935,15 @@ module Aws::SSM
|
|
10744
10935
|
# @option params [Boolean] :approved_patches_enable_non_security
|
10745
10936
|
# Indicates whether the list of approved patches includes non-security
|
10746
10937
|
# updates that should be applied to the instances. The default value is
|
10747
|
-
#
|
10938
|
+
# `false`. Applies to Linux instances only.
|
10748
10939
|
#
|
10749
10940
|
# @option params [Array<String>] :rejected_patches
|
10750
10941
|
# A list of explicitly rejected patches for the baseline.
|
10751
10942
|
#
|
10752
10943
|
# For information about accepted formats for lists of approved patches
|
10753
10944
|
# and rejected patches, see [About package name formats for approved and
|
10754
|
-
# rejected patch lists][1] in the *
|
10945
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
10946
|
+
# User Guide*.
|
10755
10947
|
#
|
10756
10948
|
#
|
10757
10949
|
#
|
@@ -10759,19 +10951,20 @@ module Aws::SSM
|
|
10759
10951
|
#
|
10760
10952
|
# @option params [String] :rejected_patches_action
|
10761
10953
|
# The action for Patch Manager to take on patches included in the
|
10762
|
-
# RejectedPackages list.
|
10954
|
+
# `RejectedPackages` list.
|
10763
10955
|
#
|
10764
|
-
# *
|
10765
|
-
# is installed only if it is a dependency of
|
10766
|
-
# considered compliant with the patch baseline,
|
10767
|
-
# reported as
|
10768
|
-
# option is specified.
|
10956
|
+
# * <b> <code>ALLOW_AS_DEPENDENCY</code> </b>\: A package in the
|
10957
|
+
# `Rejected` patches list is installed only if it is a dependency of
|
10958
|
+
# another package. It is considered compliant with the patch baseline,
|
10959
|
+
# and its status is reported as `InstalledOther`. This is the default
|
10960
|
+
# action if no option is specified.
|
10769
10961
|
#
|
10770
|
-
# *
|
10771
|
-
# include them as dependencies,
|
10772
|
-
# circumstances. If a package was installed before
|
10773
|
-
# Rejected patches list, it is considered
|
10774
|
-
# baseline, and its status is reported as
|
10962
|
+
# * <b> <code>BLOCK</code> </b>\: Packages in the `RejectedPatches`
|
10963
|
+
# list, and packages that include them as dependencies, aren't
|
10964
|
+
# installed under any circumstances. If a package was installed before
|
10965
|
+
# it was added to the `Rejected` patches list, it is considered
|
10966
|
+
# non-compliant with the patch baseline, and its status is reported as
|
10967
|
+
# `InstalledRejected`.
|
10775
10968
|
#
|
10776
10969
|
# @option params [String] :description
|
10777
10970
|
# A description of the patch baseline.
|
@@ -10783,8 +10976,8 @@ module Aws::SSM
|
|
10783
10976
|
#
|
10784
10977
|
# @option params [Boolean] :replace
|
10785
10978
|
# If True, then all fields that are required by the CreatePatchBaseline
|
10786
|
-
#
|
10787
|
-
#
|
10979
|
+
# operation are also required for this API request. Optional fields that
|
10980
|
+
# aren't specified are set to null.
|
10788
10981
|
#
|
10789
10982
|
# @return [Types::UpdatePatchBaselineResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10790
10983
|
#
|
@@ -10896,12 +11089,12 @@ module Aws::SSM
|
|
10896
11089
|
# Update a resource data sync. After you create a resource data sync for
|
10897
11090
|
# a Region, you can't change the account options for that sync. For
|
10898
11091
|
# example, if you create a sync in the us-east-2 (Ohio) Region and you
|
10899
|
-
# choose the Include only the current account option, you can't edit
|
10900
|
-
# that sync later and choose the Include all accounts from my
|
10901
|
-
# Organizations configuration option. Instead, you must delete the
|
10902
|
-
# resource data sync, and create a new one.
|
11092
|
+
# choose the `Include only the current account` option, you can't edit
|
11093
|
+
# that sync later and choose the `Include all accounts from my
|
11094
|
+
# Organizations configuration` option. Instead, you must delete the
|
11095
|
+
# first resource data sync, and create a new one.
|
10903
11096
|
#
|
10904
|
-
# <note markdown="1"> This API
|
11097
|
+
# <note markdown="1"> This API operation only supports a resource data sync that was created
|
10905
11098
|
# with a SyncFromSource `SyncType`.
|
10906
11099
|
#
|
10907
11100
|
# </note>
|
@@ -10948,21 +11141,22 @@ module Aws::SSM
|
|
10948
11141
|
req.send_request(options)
|
10949
11142
|
end
|
10950
11143
|
|
10951
|
-
# `ServiceSetting` is an account-level setting for an
|
10952
|
-
# setting defines how a user interacts with or
|
10953
|
-
# feature of a service. For example, if an
|
10954
|
-
# the account based on feature or
|
10955
|
-
#
|
10956
|
-
#
|
10957
|
-
#
|
11144
|
+
# `ServiceSetting` is an account-level setting for an Amazon Web
|
11145
|
+
# Services service. This setting defines how a user interacts with or
|
11146
|
+
# uses a service or a feature of a service. For example, if an Amazon
|
11147
|
+
# Web Services service charges money to the account based on feature or
|
11148
|
+
# service usage, then the Amazon Web Services service team might create
|
11149
|
+
# a default setting of "false". This means the user can't use this
|
11150
|
+
# feature unless they change the setting to "true" and intentionally
|
11151
|
+
# opt in for a paid feature.
|
10958
11152
|
#
|
10959
|
-
# Services map a `SettingId` object to a setting value.
|
10960
|
-
# teams define the default value for a `SettingId`.
|
10961
|
-
# new `SettingId`, but you can overwrite the default
|
10962
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
10963
|
-
# GetServiceSetting API
|
10964
|
-
# ResetServiceSetting to change the value back to the
|
10965
|
-
# defined by the
|
11153
|
+
# Services map a `SettingId` object to a setting value. Amazon Web
|
11154
|
+
# Services services teams define the default value for a `SettingId`.
|
11155
|
+
# You can't create a new `SettingId`, but you can overwrite the default
|
11156
|
+
# value if you have the `ssm:UpdateServiceSetting` permission for the
|
11157
|
+
# setting. Use the GetServiceSetting API operation to view the current
|
11158
|
+
# value. Or, use the ResetServiceSetting to change the value back to the
|
11159
|
+
# original value defined by the Amazon Web Services service team.
|
10966
11160
|
#
|
10967
11161
|
# Update the service setting for the account.
|
10968
11162
|
#
|
@@ -11000,13 +11194,14 @@ module Aws::SSM
|
|
11000
11194
|
# can be true or false.
|
11001
11195
|
#
|
11002
11196
|
# For the `/ssm/automation/customer-script-log-destination` setting ID,
|
11003
|
-
# the setting value can be CloudWatch
|
11197
|
+
# the setting value can be `CloudWatch`.
|
11004
11198
|
#
|
11005
11199
|
# For the `/ssm/automation/customer-script-log-group-name` setting ID,
|
11006
|
-
# the setting value can be the name of
|
11200
|
+
# the setting value can be the name of an Amazon CloudWatch Logs log
|
11201
|
+
# group.
|
11007
11202
|
#
|
11008
11203
|
# For the `/ssm/documents/console/public-sharing-permission` setting ID,
|
11009
|
-
# the setting value can be Enable or Disable
|
11204
|
+
# the setting value can be `Enable` or `Disable`.
|
11010
11205
|
#
|
11011
11206
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
11012
11207
|
#
|
@@ -11039,7 +11234,7 @@ module Aws::SSM
|
|
11039
11234
|
params: params,
|
11040
11235
|
config: config)
|
11041
11236
|
context[:gem_name] = 'aws-sdk-ssm'
|
11042
|
-
context[:gem_version] = '1.
|
11237
|
+
context[:gem_version] = '1.112.0'
|
11043
11238
|
Seahorse::Client::Request.new(handlers, context)
|
11044
11239
|
end
|
11045
11240
|
|