aws-sdk-ssm 1.110.0 → 1.116.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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
- # Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and
349
- # Value=Production, Pre-Production, or Test.
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 EC2 instances, see [Tagging
360
- # your Amazon EC2 resources][1] in the *Amazon EC2 User Guide*.
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 action is for on-premises
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-ID\_number. For example, mi-1a2b3c4d5e6f.
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
- # ManagedInstance: mi-012345abcde
381
- #
382
- # MaintenanceWindow: mw-012345abcde
392
+ # `MaintenanceWindow`\: `mw-012345abcde`
383
393
  #
384
- # PatchBaseline: pb-012345abcde
394
+ # `PatchBaseline`\: `pb-012345abcde`
385
395
  #
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 resource.
404
+ # For the `Document` and `Parameter` values, use the name of the
405
+ # resource.
395
406
  #
396
- # <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
397
- # managed instances. You must specify the name of the managed instance
398
- # in the following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
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
- # Do not enter personally identifiable information in this field.
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 AWS
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 AWS Systems Manager.
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 AWS resource that you want to
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 have not already starting
516
- # running. (Tasks already in progress will continue to completion.)
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 Systems Manager.
546
- # Registering these machines with Systems Manager makes it possible to
547
- # manage them using Systems Manager capabilities. You use the activation
548
- # code and ID when installing SSM Agent on machines in your hybrid
549
- # environment. For more information about requirements for managing
550
- # on-premises instances and VMs using Systems Manager, see [Setting up
551
- # AWS Systems Manager for hybrid environments][1] in the *AWS Systems
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 EC2 instances that you manage with Systems Manager are all called
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
- # Do not enter personally identifiable information in this field.
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 AWS command line tools to
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
- # Do not enter personally identifiable information in this field.
591
+ # Don't enter personally identifiable information in this field.
576
592
  #
577
593
  # @option params [required, String] :iam_role
578
- # The Amazon Identity and Access Management (IAM) role that you want to
579
- # assign to the managed instance. This IAM role must provide AssumeRole
580
- # permissions for the Systems Manager service principal
581
- # `ssm.amazonaws.com`. For more information, see [Create an IAM service
582
- # role for a hybrid environment][1] in the *AWS Systems Manager User
583
- # Guide*.
594
+ # The name of the Identity and Access Management (IAM) role that you
595
+ # want to assign to the managed instance. This IAM role must provide
596
+ # AssumeRole permissions for the Amazon Web Services Systems Manager
597
+ # service principal `ssm.amazonaws.com`. For more information, see
598
+ # [Create an IAM service role for a hybrid environment][1] in the
599
+ # *Amazon Web 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 instance.
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 name/value pairs:
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 AWS Systems Manager console with an
620
- # ID that is prefixed with "mi-". For information about how to add
621
- # tags to your managed instances, see AddTagsToResource. For information
622
- # about how to remove tags from your managed instances, see
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 AWS Resource Group or an
666
- # AWS Autoscaling Group, State Manager applies the configuration when
667
- # new instances are added to the group. The association also specifies
668
- # actions to take when applying the configuration. For example, an
669
- # association for anti-virus software might run once a day. If the
670
- # software is not installed, then State Manager installs it. If the
671
- # software is installed, but the service is not running, then the
672
- # association might instruct State Manager to start the service.
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 that contains the configuration
676
- # information for the instance. You can specify Command or Automation
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 AWS-predefined documents, documents you created, or a
680
- # document that is shared with you from another account.
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 from other AWS accounts,
683
- # you must specify the complete SSM document ARN, in the following
684
- # format:
700
+ # For Systems Manager documents (SSM documents) that are shared with you
701
+ # from other Amazon Web Services accounts, you must specify the complete
702
+ # SSM document ARN, 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 AWS-predefined documents and SSM documents you created in your
693
- # account, you only need to specify the document name. For example,
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 SSM documents that use schema version 2.0
706
- # or later will fail. In addition, if you use the parameter
707
- # `InstanceId`, you cannot use the parameters `AssociationName`,
708
- # `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or
709
- # `ScheduleExpression`. To use these parameters, you must use the
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, AWS Resource Groups, all instances in an AWS account, or
720
- # individual instance IDs. For more information about choosing targets
721
- # for an association, see [Using targets and rate controls with State
722
- # Manager associations][1] in the *AWS Systems Manager User Guide*.
737
+ # tags, Amazon Web Services resource groups, all instances in an Amazon
738
+ # Web Services account, or individual instance IDs. For more information
739
+ # about 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 store the output details of the
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 document and target resources by
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 action. In this case, compliance data
786
- # is not managed by State Manager. It is managed by your direct call to
787
- # the PutComplianceItems API action.
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,24 @@ 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 is not supported
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 Systems Manager
800
- # Change Calendar type documents you want to gate your associations
801
- # under. The associations only run when that Change Calendar is open.
802
- # For more information, see [AWS Systems Manager Change Calendar][1].
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 AWS Regions and AWS accounts where you
810
- # want to run the association. Use this action to create an association
811
- # in multiple Regions and multiple accounts.
829
+ # A location is a combination of Amazon Web Services Regions and Amazon
830
+ # Web Services accounts where you want to run the association. Use this
831
+ # action to create an association in multiple Regions and multiple
832
+ # accounts.
812
833
  #
813
834
  # @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
814
835
  #
@@ -913,12 +934,13 @@ module Aws::SSM
913
934
  req.send_request(options)
914
935
  end
915
936
 
916
- # Associates the specified Systems Manager document with the specified
917
- # instances or targets.
937
+ # Associates the specified Amazon Web Services Systems Manager document
938
+ # (SSM document) with the specified instances or targets.
918
939
  #
919
940
  # When you associate a document with one or more instances using
920
- # instance IDs or tags, SSM Agent running on the instance processes the
921
- # document and configures the instance as specified.
941
+ # instance IDs or tags, Amazon Web Services Systems Manager Agent (SSM
942
+ # Agent) running on the instance processes the document and configures
943
+ # the instance as specified.
922
944
  #
923
945
  # If you associate a document with an instance that already has an
924
946
  # associated document, the system returns the AssociationAlreadyExists
@@ -1070,11 +1092,12 @@ module Aws::SSM
1070
1092
  req.send_request(options)
1071
1093
  end
1072
1094
 
1073
- # Creates a Systems Manager (SSM) document. An SSM document defines the
1074
- # actions that Systems Manager performs on your managed instances. For
1075
- # more information about SSM documents, including information about
1076
- # supported schemas, features, and syntax, see [AWS Systems Manager
1077
- # Documents][1] in the *AWS Systems Manager User Guide*.
1095
+ # Creates a Amazon Web Services Systems Manager (SSM document). An SSM
1096
+ # document defines the actions that Systems Manager performs on your
1097
+ # managed instances. For more information about SSM documents, including
1098
+ # information about supported schemas, features, and syntax, see [Amazon
1099
+ # Web Services Systems Manager Documents][1] in the *Amazon Web Services
1100
+ # Systems Manager User Guide*.
1078
1101
  #
1079
1102
  #
1080
1103
  #
@@ -1085,12 +1108,12 @@ module Aws::SSM
1085
1108
  # recommend storing the contents for your new document in an external
1086
1109
  # JSON or YAML file and referencing the file in a command.
1087
1110
  #
1088
- # For examples, see the following topics in the *AWS Systems Manager
1089
- # User Guide*.
1111
+ # For examples, see the following topics in the *Amazon Web Services
1112
+ # Systems Manager User Guide*.
1090
1113
  #
1091
- # * [Create an SSM document (AWS API)][1]
1114
+ # * [Create an SSM document (Amazon Web Services API)][1]
1092
1115
  #
1093
- # * [Create an SSM document (AWS CLI)][2]
1116
+ # * [Create an SSM document (Amazon Web Services CLI)][2]
1094
1117
  #
1095
1118
  # * [Create an SSM document (API)][1]
1096
1119
  #
@@ -1101,27 +1124,27 @@ module Aws::SSM
1101
1124
  #
1102
1125
  # @option params [Array<Types::DocumentRequires>] :requires
1103
1126
  # A list of SSM documents required by a document. This parameter is used
1104
- # exclusively by AWS AppConfig. When a user creates an AppConfig
1127
+ # exclusively by AppConfig. When a user creates an AppConfig
1105
1128
  # configuration in an SSM document, the user must also specify a
1106
1129
  # required document for validation purposes. In this case, an
1107
1130
  # `ApplicationConfiguration` document requires an
1108
1131
  # `ApplicationConfigurationSchema` document for validation purposes. For
1109
- # more information, see [AWS AppConfig][1] in the *AWS Systems Manager
1110
- # User Guide*.
1132
+ # more information, see [What is AppConfig?][1] in the *AppConfig User
1133
+ # Guide*.
1111
1134
  #
1112
1135
  #
1113
1136
  #
1114
- # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html
1137
+ # [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html
1115
1138
  #
1116
1139
  # @option params [Array<Types::AttachmentsSource>] :attachments
1117
- # A list of key and value pairs that describe attachments to a version
1118
- # of a document.
1140
+ # A list of key-value pairs that describe attachments to a version of a
1141
+ # document.
1119
1142
  #
1120
1143
  # @option params [required, String] :name
1121
- # A name for the Systems Manager document.
1144
+ # A name for the SSM document.
1122
1145
  #
1123
1146
  # You can't use the following strings as document name prefixes. These
1124
- # are reserved by AWS for use as document name prefixes:
1147
+ # are reserved by Amazon Web Services for use as document name prefixes:
1125
1148
  #
1126
1149
  # * `aws-`
1127
1150
  #
@@ -1130,15 +1153,15 @@ module Aws::SSM
1130
1153
  # * `amzn`
1131
1154
  #
1132
1155
  # @option params [String] :display_name
1133
- # An optional field where you can specify a friendly name for the
1134
- # Systems Manager document. This value can differ for each version of
1135
- # the document. You can update this value at a later time using the
1136
- # UpdateDocument action.
1156
+ # An optional field where you can specify a friendly name for the SSM
1157
+ # document. This value can differ for each version of the document. You
1158
+ # can update this value at a later time using the UpdateDocument
1159
+ # operation.
1137
1160
  #
1138
1161
  # @option params [String] :version_name
1139
1162
  # An optional field specifying the version of the artifact you are
1140
1163
  # creating with the document. For example, "Release 12, Update 6".
1141
- # This value is unique across all versions of a document, and cannot be
1164
+ # This value is unique across all versions of a document, and can't be
1142
1165
  # changed.
1143
1166
  #
1144
1167
  # @option params [String] :document_type
@@ -1151,29 +1174,29 @@ module Aws::SSM
1151
1174
  # @option params [String] :target_type
1152
1175
  # Specify a target type to define the kinds of resources the document
1153
1176
  # can run on. For example, to run a document on EC2 instances, specify
1154
- # the following value: /AWS::EC2::Instance. If you specify a value of
1177
+ # the following value: `/AWS::EC2::Instance`. If you specify a value of
1155
1178
  # '/' the document can run on all types of resources. If you don't
1156
1179
  # specify a value, the document can't run on any resources. For a list
1157
- # of valid resource types, see [AWS resource and property types
1158
- # reference][1] in the *AWS CloudFormation User Guide*.
1180
+ # of valid resource types, see [Amazon Web Services resource and
1181
+ # property types reference][1] in the *CloudFormation User Guide*.
1159
1182
  #
1160
1183
  #
1161
1184
  #
1162
- # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
1185
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
1163
1186
  #
1164
1187
  # @option params [Array<Types::Tag>] :tags
1165
1188
  # Optional metadata that you assign to a resource. Tags enable you to
1166
1189
  # categorize a resource in different ways, such as by purpose, owner, or
1167
1190
  # environment. For example, you might want to tag an SSM document to
1168
1191
  # identify the types of targets or the environment where it will run. In
1169
- # this case, you could specify the following key name/value pairs:
1192
+ # this case, you could specify the following key-value pairs:
1170
1193
  #
1171
1194
  # * `Key=OS,Value=Windows`
1172
1195
  #
1173
1196
  # * `Key=Environment,Value=Production`
1174
1197
  #
1175
1198
  # <note markdown="1"> To add tags to an existing SSM document, use the AddTagsToResource
1176
- # action.
1199
+ # operation.
1177
1200
  #
1178
1201
  # </note>
1179
1202
  #
@@ -1287,12 +1310,12 @@ module Aws::SSM
1287
1310
  #
1288
1311
  # @option params [String] :start_date
1289
1312
  # 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
1313
+ # maintenance window to become active. `StartDate` allows you to delay
1291
1314
  # activation of the maintenance window until the specified future date.
1292
1315
  #
1293
1316
  # @option params [String] :end_date
1294
1317
  # 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
1318
+ # maintenance window to become inactive. `EndDate` allows you to set a
1296
1319
  # date and time in the future when the maintenance window will no longer
1297
1320
  # run.
1298
1321
  #
@@ -1311,7 +1334,7 @@ module Aws::SSM
1311
1334
  # [1]: https://www.iana.org/time-zones
1312
1335
  #
1313
1336
  # @option params [Integer] :schedule_offset
1314
- # The number of days to wait after the date and time specified by a CRON
1337
+ # The number of days to wait after the date and time specified by a cron
1315
1338
  # expression before running the maintenance window.
1316
1339
  #
1317
1340
  # For example, the following cron expression schedules a maintenance
@@ -1327,11 +1350,12 @@ module Aws::SSM
1327
1350
  #
1328
1351
  # @option params [required, Integer] :cutoff
1329
1352
  # The number of hours before the end of the maintenance window that
1330
- # Systems Manager stops scheduling new tasks for execution.
1353
+ # Amazon Web Services Systems Manager stops scheduling new tasks for
1354
+ # execution.
1331
1355
  #
1332
1356
  # @option params [required, Boolean] :allow_unassociated_targets
1333
1357
  # Enables a maintenance window task to run on managed instances, even if
1334
- # you have not registered those instances as targets. If enabled, then
1358
+ # you haven't registered those instances as targets. If enabled, then
1335
1359
  # you must specify the unregistered instances (by instance ID) when you
1336
1360
  # register a task with the maintenance window.
1337
1361
  #
@@ -1351,7 +1375,7 @@ module Aws::SSM
1351
1375
  # environment. For example, you might want to tag a maintenance window
1352
1376
  # to identify the type of tasks it will run, the types of targets, and
1353
1377
  # the environment it will run in. In this case, you could specify the
1354
- # following key name/value pairs:
1378
+ # following key-value pairs:
1355
1379
  #
1356
1380
  # * `Key=TaskType,Value=AgentUpdate`
1357
1381
  #
@@ -1360,7 +1384,7 @@ module Aws::SSM
1360
1384
  # * `Key=Environment,Value=Production`
1361
1385
  #
1362
1386
  # <note markdown="1"> To add tags to an existing maintenance window, use the
1363
- # AddTagsToResource action.
1387
+ # AddTagsToResource operation.
1364
1388
  #
1365
1389
  # </note>
1366
1390
  #
@@ -1403,16 +1427,17 @@ module Aws::SSM
1403
1427
  req.send_request(options)
1404
1428
  end
1405
1429
 
1406
- # Creates a new OpsItem. You must have permission in AWS Identity and
1407
- # Access Management (IAM) to create a new OpsItem. For more information,
1408
- # see [Getting started with OpsCenter][1] in the *AWS Systems Manager
1409
- # User Guide*.
1430
+ # Creates a new OpsItem. You must have permission in Identity and Access
1431
+ # Management (IAM) to create a new OpsItem. For more information, see
1432
+ # [Getting started with OpsCenter][1] in the *Amazon Web Services
1433
+ # Systems Manager User Guide*.
1410
1434
  #
1411
- # Operations engineers and IT professionals use OpsCenter to view,
1412
- # investigate, and remediate operational issues impacting the
1413
- # performance and health of their AWS resources. For more information,
1414
- # see [AWS Systems Manager OpsCenter][2] in the *AWS Systems Manager
1415
- # User Guide*.
1435
+ # Operations engineers and IT professionals use Amazon Web Services
1436
+ # Systems Manager OpsCenter to view, investigate, and remediate
1437
+ # operational issues impacting the performance and health of their
1438
+ # Amazon Web Services resources. For more information, see [Amazon Web
1439
+ # Services Systems Manager OpsCenter][2] in the *Amazon Web Services
1440
+ # Systems Manager User Guide*.
1416
1441
  #
1417
1442
  #
1418
1443
  #
@@ -1433,22 +1458,23 @@ module Aws::SSM
1433
1458
  # You enter operational data as key-value pairs. The key has a maximum
1434
1459
  # length of 128 characters. The value has a maximum size of 20 KB.
1435
1460
  #
1436
- # Operational data keys *can't* begin with the following: amazon, aws,
1437
- # amzn, ssm, /amazon, /aws, /amzn, /ssm.
1461
+ # Operational data keys *can't* begin with the following: `amazon`,
1462
+ # `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
1438
1463
  #
1439
1464
  # You can choose to make the data searchable by other users in the
1440
1465
  # account or you can restrict search access. Searchable data means that
1441
1466
  # all users with access to the OpsItem Overview page (as provided by the
1442
- # DescribeOpsItems API action) can view and search on the specified
1443
- # data. Operational data that is not searchable is only viewable by
1467
+ # DescribeOpsItems API operation) can view and search on the specified
1468
+ # data. Operational data that isn't searchable is only viewable by
1444
1469
  # users who have access to the OpsItem (as provided by the GetOpsItem
1445
- # API action).
1470
+ # API operation).
1446
1471
  #
1447
1472
  # Use the `/aws/resources` key in OperationalData to specify a related
1448
1473
  # resource in the request. Use the `/aws/automations` key in
1449
1474
  # OperationalData to associate an Automation runbook with the OpsItem.
1450
- # To view AWS CLI example commands that use these keys, see [Creating
1451
- # OpsItems manually][1] in the *AWS Systems Manager User Guide*.
1475
+ # To view Amazon Web Services CLI example commands that use these keys,
1476
+ # see [Creating OpsItems manually][1] in the *Amazon Web Services
1477
+ # Systems Manager User Guide*.
1452
1478
  #
1453
1479
  #
1454
1480
  #
@@ -1471,8 +1497,8 @@ module Aws::SSM
1471
1497
  # @option params [required, String] :source
1472
1498
  # The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
1473
1499
  #
1474
- # <note markdown="1"> The source name can't contain the following strings: aws, amazon, and
1475
- # amzn.
1500
+ # <note markdown="1"> The source name can't contain the following strings: `aws`, `amazon`,
1501
+ # and `amzn`.
1476
1502
  #
1477
1503
  # </note>
1478
1504
  #
@@ -1484,15 +1510,16 @@ module Aws::SSM
1484
1510
  # Optional metadata that you assign to a resource. You can restrict
1485
1511
  # access to OpsItems by using an inline IAM policy that specifies tags.
1486
1512
  # For more information, see [Getting started with OpsCenter][1] in the
1487
- # *AWS Systems Manager User Guide*.
1513
+ # *Amazon Web Services Systems Manager User Guide*.
1488
1514
  #
1489
1515
  # Tags use a key-value pair. For example:
1490
1516
  #
1491
1517
  # `Key=Department,Value=Finance`
1492
1518
  #
1493
- # <note markdown="1"> To add tags to an existing OpsItem, use the AddTagsToResource action.
1494
- #
1495
- # </note>
1519
+ # To add tags to a new OpsItem, a user must have IAM permissions for
1520
+ # both the `ssm:CreateOpsItems` operation and the
1521
+ # `ssm:AddTagsToResource` operation. To add tags to an existing OpsItem,
1522
+ # use the AddTagsToResource operation.
1496
1523
  #
1497
1524
  #
1498
1525
  #
@@ -1576,9 +1603,9 @@ module Aws::SSM
1576
1603
  req.send_request(options)
1577
1604
  end
1578
1605
 
1579
- # If you create a new application in Application Manager, Systems
1580
- # Manager calls this API action to specify information about the new
1581
- # application, including the application type.
1606
+ # If you create a new application in Application Manager, Amazon Web
1607
+ # Services Systems Manager calls this API operation to specify
1608
+ # information about the new application, including the application type.
1582
1609
  #
1583
1610
  # @option params [required, String] :resource_id
1584
1611
  # A resource ID for a new Application Manager application.
@@ -1591,8 +1618,8 @@ module Aws::SSM
1591
1618
  # maximum of five tags for an OpsMetadata object. Tags enable you to
1592
1619
  # categorize a resource in different ways, such as by purpose, owner, or
1593
1620
  # environment. For example, you might want to tag an OpsMetadata object
1594
- # to identify an environment or target AWS Region. In this case, you
1595
- # could specify the following key-value pairs:
1621
+ # to identify an environment or target Amazon Web Services Region. In
1622
+ # this case, you could specify the following key-value pairs:
1596
1623
  #
1597
1624
  # * `Key=Environment,Value=Production`
1598
1625
  #
@@ -1634,18 +1661,14 @@ module Aws::SSM
1634
1661
 
1635
1662
  # Creates a patch baseline.
1636
1663
  #
1637
- # <note markdown="1"> For information about valid key and value pairs in `PatchFilters` for
1638
- # each supported operating system type, see [PatchFilter][1].
1664
+ # <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
1665
+ # supported operating system type, see PatchFilter.
1639
1666
  #
1640
1667
  # </note>
1641
1668
  #
1642
- #
1643
- #
1644
- # [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
1645
- #
1646
1669
  # @option params [String] :operating_system
1647
1670
  # Defines the operating system the patch baseline applies to. The
1648
- # Default value is WINDOWS.
1671
+ # default value is `WINDOWS`.
1649
1672
  #
1650
1673
  # @option params [required, String] :name
1651
1674
  # The name of the patch baseline.
@@ -1661,7 +1684,8 @@ module Aws::SSM
1661
1684
  #
1662
1685
  # For information about accepted formats for lists of approved patches
1663
1686
  # and rejected patches, see [About package name formats for approved and
1664
- # rejected patch lists][1] in the *AWS Systems Manager User Guide*.
1687
+ # rejected patch lists][1] in the *Amazon Web Services Systems Manager
1688
+ # User Guide*.
1665
1689
  #
1666
1690
  #
1667
1691
  #
@@ -1670,19 +1694,20 @@ module Aws::SSM
1670
1694
  # @option params [String] :approved_patches_compliance_level
1671
1695
  # Defines the compliance level for approved patches. When an approved
1672
1696
  # patch is reported as missing, this value describes the severity of the
1673
- # compliance violation. The default value is UNSPECIFIED.
1697
+ # compliance violation. The default value is `UNSPECIFIED`.
1674
1698
  #
1675
1699
  # @option params [Boolean] :approved_patches_enable_non_security
1676
1700
  # Indicates whether the list of approved patches includes non-security
1677
1701
  # updates that should be applied to the instances. The default value is
1678
- # 'false'. Applies to Linux instances only.
1702
+ # `false`. Applies to Linux instances only.
1679
1703
  #
1680
1704
  # @option params [Array<String>] :rejected_patches
1681
1705
  # A list of explicitly rejected patches for the baseline.
1682
1706
  #
1683
1707
  # For information about accepted formats for lists of approved patches
1684
1708
  # and rejected patches, see [About package name formats for approved and
1685
- # rejected patch lists][1] in the *AWS Systems Manager User Guide*.
1709
+ # rejected patch lists][1] in the *Amazon Web Services Systems Manager
1710
+ # User Guide*.
1686
1711
  #
1687
1712
  #
1688
1713
  #
@@ -1690,19 +1715,20 @@ module Aws::SSM
1690
1715
  #
1691
1716
  # @option params [String] :rejected_patches_action
1692
1717
  # The action for Patch Manager to take on patches included in the
1693
- # RejectedPackages list.
1718
+ # `RejectedPackages` list.
1694
1719
  #
1695
- # * **ALLOW\_AS\_DEPENDENCY**\: A package in the Rejected patches list
1696
- # is installed only if it is a dependency of another package. It is
1697
- # considered compliant with the patch baseline, and its status is
1698
- # reported as *InstalledOther*. This is the default action if no
1699
- # option is specified.
1720
+ # * <b> <code>ALLOW_AS_DEPENDENCY</code> </b>\: A package in the
1721
+ # `Rejected` patches list is installed only if it is a dependency of
1722
+ # another package. It is considered compliant with the patch baseline,
1723
+ # and its status is reported as `InstalledOther`. This is the default
1724
+ # action if no option is specified.
1700
1725
  #
1701
- # * **BLOCK**\: Packages in the RejectedPatches list, and packages that
1702
- # include them as dependencies, are not installed under any
1703
- # circumstances. If a package was installed before it was added to the
1704
- # Rejected patches list, it is considered non-compliant with the patch
1705
- # baseline, and its status is reported as *InstalledRejected*.
1726
+ # * <b> <code>BLOCK</code> </b>\: Packages in the `RejectedPatches`
1727
+ # list, and packages that include them as dependencies, aren't
1728
+ # installed under any circumstances. If a package was installed before
1729
+ # it was added to the Rejected patches list, it is considered
1730
+ # non-compliant with the patch baseline, and its status is reported as
1731
+ # `InstalledRejected`.
1706
1732
  #
1707
1733
  # @option params [String] :description
1708
1734
  # A description of the patch baseline.
@@ -1724,14 +1750,14 @@ module Aws::SSM
1724
1750
  # environment. For example, you might want to tag a patch baseline to
1725
1751
  # identify the severity level of patches it specifies and the operating
1726
1752
  # system family it applies to. In this case, you could specify the
1727
- # following key name/value pairs:
1753
+ # following key-value pairs:
1728
1754
  #
1729
1755
  # * `Key=PatchSeverity,Value=Critical`
1730
1756
  #
1731
1757
  # * `Key=OS,Value=Windows`
1732
1758
  #
1733
1759
  # <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
1734
- # action.
1760
+ # operation.
1735
1761
  #
1736
1762
  # </note>
1737
1763
  #
@@ -1806,30 +1832,32 @@ module Aws::SSM
1806
1832
  end
1807
1833
 
1808
1834
  # A resource data sync helps you view data from multiple sources in a
1809
- # single location. Systems Manager offers two types of resource data
1810
- # sync: `SyncToDestination` and `SyncFromSource`.
1835
+ # single location. Amazon Web Services Systems Manager offers two types
1836
+ # of resource data sync: `SyncToDestination` and `SyncFromSource`.
1811
1837
  #
1812
1838
  # You can configure Systems Manager Inventory to use the
1813
1839
  # `SyncToDestination` type to synchronize Inventory data from multiple
1814
- # AWS Regions to a single S3 bucket. For more information, see
1815
- # [Configuring Resource Data Sync for Inventory][1] in the *AWS Systems
1840
+ # Amazon Web Services Regions to a single Amazon Simple Storage Service
1841
+ # (Amazon S3) bucket. For more information, see [Configuring resource
1842
+ # data sync for Inventory][1] in the *Amazon Web Services Systems
1816
1843
  # Manager User Guide*.
1817
1844
  #
1818
1845
  # You can configure Systems Manager Explorer to use the `SyncFromSource`
1819
1846
  # type to synchronize operational work items (OpsItems) and operational
1820
- # data (OpsData) from multiple AWS Regions to a single S3 bucket. This
1821
- # type can synchronize OpsItems and OpsData from multiple AWS accounts
1822
- # and Regions or `EntireOrganization` by using AWS Organizations. For
1823
- # more information, see [Setting up Systems Manager Explorer to display
1824
- # data from multiple accounts and Regions][2] in the *AWS Systems
1825
- # Manager User Guide*.
1847
+ # data (OpsData) from multiple Amazon Web Services Regions to a single
1848
+ # Amazon S3 bucket. This type can synchronize OpsItems and OpsData from
1849
+ # multiple Amazon Web Services accounts and Amazon Web Services Regions
1850
+ # or `EntireOrganization` by using Organizations. For more information,
1851
+ # see [Setting up Systems Manager Explorer to display data from multiple
1852
+ # accounts and Regions][2] in the *Amazon Web Services Systems Manager
1853
+ # User Guide*.
1826
1854
  #
1827
1855
  # A resource data sync is an asynchronous operation that returns
1828
1856
  # immediately. After a successful initial sync is completed, the system
1829
1857
  # continuously syncs data. To check the status of a sync, use the
1830
1858
  # ListResourceDataSync.
1831
1859
  #
1832
- # <note markdown="1"> By default, data is not encrypted in Amazon S3. We strongly recommend
1860
+ # <note markdown="1"> By default, data isn't encrypted in Amazon S3. We strongly recommend
1833
1861
  # that you enable encryption in Amazon S3 to ensure secure data storage.
1834
1862
  # We also recommend that you secure access to the Amazon S3 bucket by
1835
1863
  # creating a restrictive bucket policy.
@@ -1853,10 +1881,10 @@ module Aws::SSM
1853
1881
  # synchronizes data to an S3 bucket for Inventory. If you specify
1854
1882
  # `SyncToDestination`, you must provide a value for `S3Destination`.
1855
1883
  # Specify `SyncFromSource` to synchronize data from a single account and
1856
- # multiple Regions, or multiple AWS accounts and Regions, as listed in
1857
- # AWS Organizations for Explorer. If you specify `SyncFromSource`, you
1858
- # must provide a value for `SyncSource`. The default value is
1859
- # `SyncToDestination`.
1884
+ # multiple Regions, or multiple Amazon Web Services accounts and Amazon
1885
+ # Web Services Regions, as listed in Organizations for Explorer. If you
1886
+ # specify `SyncFromSource`, you must provide a value for `SyncSource`.
1887
+ # The default value is `SyncToDestination`.
1860
1888
  #
1861
1889
  # @option params [Types::ResourceDataSyncSource] :sync_source
1862
1890
  # Specify information about the data sources to synchronize. This
@@ -1904,9 +1932,9 @@ module Aws::SSM
1904
1932
  req.send_request(options)
1905
1933
  end
1906
1934
 
1907
- # Deletes an activation. You are not required to delete an activation.
1935
+ # Deletes an activation. You aren't required to delete an activation.
1908
1936
  # If you delete an activation, you can no longer use it to register
1909
- # additional managed instances. Deleting an activation does not
1937
+ # additional managed instances. Deleting an activation doesn't
1910
1938
  # de-register managed instances. You must manually de-register managed
1911
1939
  # instances.
1912
1940
  #
@@ -1930,20 +1958,33 @@ module Aws::SSM
1930
1958
  req.send_request(options)
1931
1959
  end
1932
1960
 
1933
- # Disassociates the specified Systems Manager document from the
1934
- # specified instance.
1961
+ # Disassociates the specified Amazon Web Services Systems Manager
1962
+ # document (SSM document) from the specified instance. If you created
1963
+ # the association by using the `Targets` parameter, then you must delete
1964
+ # the association by using the association ID.
1935
1965
  #
1936
- # When you disassociate a document from an instance, it does not change
1966
+ # When you disassociate a document from an instance, it doesn't change
1937
1967
  # the configuration of the instance. To change the configuration state
1938
1968
  # of an instance after you disassociate a document, you must create a
1939
1969
  # new document with the desired configuration and associate it with the
1940
1970
  # instance.
1941
1971
  #
1942
1972
  # @option params [String] :name
1943
- # The name of the Systems Manager document.
1973
+ # The name of the SSM document.
1944
1974
  #
1945
1975
  # @option params [String] :instance_id
1946
- # The ID of the instance.
1976
+ # The instance ID.
1977
+ #
1978
+ # <note markdown="1"> `InstanceId` has been deprecated. To specify an instance ID for an
1979
+ # association, use the `Targets` parameter. Requests that include the
1980
+ # parameter `InstanceID` with Systems Manager documents (SSM documents)
1981
+ # that use schema version 2.0 or later will fail. In addition, if you
1982
+ # use the parameter `InstanceId`, you can't use the parameters
1983
+ # `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`,
1984
+ # `OutputLocation`, or `ScheduleExpression`. To use these parameters,
1985
+ # you must use the `Targets` parameter.
1986
+ #
1987
+ # </note>
1947
1988
  #
1948
1989
  # @option params [String] :association_id
1949
1990
  # The association ID that you want to delete.
@@ -1967,8 +2008,8 @@ module Aws::SSM
1967
2008
  req.send_request(options)
1968
2009
  end
1969
2010
 
1970
- # Deletes the Systems Manager document and all instance associations to
1971
- # the document.
2011
+ # Deletes the Amazon Web Services Systems Manager document (SSM
2012
+ # document) and all instance associations to the document.
1972
2013
  #
1973
2014
  # Before you delete the document, we recommend that you use
1974
2015
  # DeleteAssociation to disassociate all instances that are associated
@@ -1989,8 +2030,8 @@ module Aws::SSM
1989
2030
  # Some SSM document types require that you specify a `Force` flag before
1990
2031
  # you can delete the document. For example, you must specify a `Force`
1991
2032
  # flag to delete a document of type `ApplicationConfigurationSchema`.
1992
- # You can restrict access to the `Force` flag in an AWS Identity and
1993
- # Access Management (IAM) policy.
2033
+ # You can restrict access to the `Force` flag in an Identity and Access
2034
+ # Management (IAM) policy.
1994
2035
  #
1995
2036
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1996
2037
  #
@@ -2028,8 +2069,8 @@ module Aws::SSM
2028
2069
  #
2029
2070
  # DisableSchema: If you choose this option, the system ignores all
2030
2071
  # inventory data for the specified version, and any earlier versions. To
2031
- # enable this schema again, you must call the `PutInventory` action for
2032
- # a version greater than the disabled version.
2072
+ # enable this schema again, you must call the `PutInventory` operation
2073
+ # for a version greater than the disabled version.
2033
2074
  #
2034
2075
  # DeleteSchema: This option deletes the specified custom type from the
2035
2076
  # Inventory service. You can recreate the schema later, if you want.
@@ -2132,7 +2173,8 @@ module Aws::SSM
2132
2173
  req.send_request(options)
2133
2174
  end
2134
2175
 
2135
- # Delete a parameter from the system.
2176
+ # Delete a parameter from the system. After deleting a parameter, wait
2177
+ # for at least 30 seconds to create a parameter with the same name.
2136
2178
  #
2137
2179
  # @option params [required, String] :name
2138
2180
  # The name of the parameter to delete.
@@ -2154,10 +2196,12 @@ module Aws::SSM
2154
2196
  req.send_request(options)
2155
2197
  end
2156
2198
 
2157
- # Delete a list of parameters.
2199
+ # Delete a list of parameters. After deleting a parameter, wait for at
2200
+ # least 30 seconds to create a parameter with the same name.
2158
2201
  #
2159
2202
  # @option params [required, Array<String>] :names
2160
- # The names of the parameters to delete.
2203
+ # The names of the parameters to delete. After deleting a parameter,
2204
+ # wait for at least 30 seconds to create a parameter with the same name.
2161
2205
  #
2162
2206
  # @return [Types::DeleteParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2163
2207
  #
@@ -2214,9 +2258,9 @@ module Aws::SSM
2214
2258
  req.send_request(options)
2215
2259
  end
2216
2260
 
2217
- # Deletes a Resource Data Sync configuration. After the configuration is
2261
+ # Deletes a resource data sync configuration. After the configuration is
2218
2262
  # deleted, changes to data on managed instances are no longer synced to
2219
- # or from the target. Deleting a sync configuration does not delete
2263
+ # or from the target. Deleting a sync configuration doesn't delete
2220
2264
  # data.
2221
2265
  #
2222
2266
  # @option params [required, String] :sync_name
@@ -2314,7 +2358,7 @@ module Aws::SSM
2314
2358
  #
2315
2359
  # @option params [Boolean] :safe
2316
2360
  # 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 does not
2361
+ # target is being referenced, the system returns an error and doesn't
2318
2362
  # deregister the target from the maintenance window.
2319
2363
  #
2320
2364
  # @return [Types::DeregisterTargetFromMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2379,9 +2423,9 @@ module Aws::SSM
2379
2423
  end
2380
2424
 
2381
2425
  # Describes details about the activation, such as the date and time the
2382
- # activation was created, its expiration date, the IAM role assigned to
2383
- # the instances in the activation, and the number of instances
2384
- # registered by using this activation.
2426
+ # activation was created, its expiration date, the Identity and Access
2427
+ # Management (IAM) role assigned to the instances in the activation, and
2428
+ # the number of instances registered by using this activation.
2385
2429
  #
2386
2430
  # @option params [Array<Types::DescribeActivationsFilter>] :filters
2387
2431
  # A filter to view information about your activations.
@@ -2443,13 +2487,10 @@ module Aws::SSM
2443
2487
 
2444
2488
  # Describes the association for the specified target or instance. If you
2445
2489
  # created the association by using the `Targets` parameter, then you
2446
- # must retrieve the association by using the association ID. If you
2447
- # created the association by specifying an instance ID and a Systems
2448
- # Manager document, then you retrieve the association by specifying the
2449
- # document name and the instance ID.
2490
+ # must retrieve the association by using the association ID.
2450
2491
  #
2451
2492
  # @option params [String] :name
2452
- # The name of the Systems Manager document.
2493
+ # The name of the SSM document.
2453
2494
  #
2454
2495
  # @option params [String] :instance_id
2455
2496
  # The instance ID.
@@ -2534,8 +2575,8 @@ module Aws::SSM
2534
2575
  req.send_request(options)
2535
2576
  end
2536
2577
 
2537
- # Use this API action to view information about a specific execution of
2538
- # a specific association.
2578
+ # Views information about a specific execution of a specific
2579
+ # association.
2539
2580
  #
2540
2581
  # @option params [required, String] :association_id
2541
2582
  # The association ID that includes the execution for which you want to
@@ -2609,8 +2650,7 @@ module Aws::SSM
2609
2650
  req.send_request(options)
2610
2651
  end
2611
2652
 
2612
- # Use this API action to view all executions for a specific association
2613
- # ID.
2653
+ # Views all executions for a specific association ID.
2614
2654
  #
2615
2655
  # @option params [required, String] :association_id
2616
2656
  # The association ID for which you want to view execution history
@@ -2890,7 +2930,98 @@ module Aws::SSM
2890
2930
  # Lists all patches eligible to be included in a patch baseline.
2891
2931
  #
2892
2932
  # @option params [Array<Types::PatchOrchestratorFilter>] :filters
2893
- # Filters used to scope down the returned patches.
2933
+ # Each element in the array is a structure containing a key-value pair.
2934
+ #
2935
+ # **Windows Server**
2936
+ #
2937
+ # Supported keys for Windows Server instance patches include the
2938
+ # following:
2939
+ #
2940
+ # * <b> <code>PATCH_SET</code> </b>
2941
+ #
2942
+ # Sample values: `OS` \| `APPLICATION`
2943
+ #
2944
+ # * <b> <code>PRODUCT</code> </b>
2945
+ #
2946
+ # Sample values: `WindowsServer2012` \| `Office 2010` \|
2947
+ # `MicrosoftDefenderAntivirus`
2948
+ #
2949
+ # * <b> <code>PRODUCT_FAMILY</code> </b>
2950
+ #
2951
+ # Sample values: `Windows` \| `Office`
2952
+ #
2953
+ # * <b> <code>MSRC_SEVERITY</code> </b>
2954
+ #
2955
+ # Sample values: `ServicePacks` \| `Important` \| `Moderate`
2956
+ #
2957
+ # * <b> <code>CLASSIFICATION</code> </b>
2958
+ #
2959
+ # Sample values: `ServicePacks` \| `SecurityUpdates` \|
2960
+ # `DefinitionUpdates`
2961
+ #
2962
+ # * <b> <code>PATCH_ID</code> </b>
2963
+ #
2964
+ # Sample values: `KB123456` \| `KB4516046`
2965
+ #
2966
+ # **Linux**
2967
+ #
2968
+ # When specifying filters for Linux patches, you must specify a key-pair
2969
+ # for `PRODUCT`. For example, using the Command Line Interface (CLI),
2970
+ # the following command fails:
2971
+ #
2972
+ # `aws ssm describe-available-patches --filters
2973
+ # Key=CVE_ID,Values=CVE-2018-3615`
2974
+ #
2975
+ # However, the following command succeeds:
2976
+ #
2977
+ # `aws ssm describe-available-patches --filters
2978
+ # Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615`
2979
+ #
2980
+ # Supported keys for Linux instance patches include the following:
2981
+ #
2982
+ # * <b> <code>PRODUCT</code> </b>
2983
+ #
2984
+ # Sample values: `AmazonLinux2018.03` \| `AmazonLinux2.0`
2985
+ #
2986
+ # * <b> <code>NAME</code> </b>
2987
+ #
2988
+ # Sample values: `kernel-headers` \| `samba-python` \| `php`
2989
+ #
2990
+ # * <b> <code>SEVERITY</code> </b>
2991
+ #
2992
+ # Sample values: `Critical` \| `Important` \| `Medium` \| `Low`
2993
+ #
2994
+ # * <b> <code>EPOCH</code> </b>
2995
+ #
2996
+ # Sample values: `0` \| `1`
2997
+ #
2998
+ # * <b> <code>VERSION</code> </b>
2999
+ #
3000
+ # Sample values: `78.6.1` \| `4.10.16`
3001
+ #
3002
+ # * <b> <code>RELEASE</code> </b>
3003
+ #
3004
+ # Sample values: `9.56.amzn1` \| `1.amzn2`
3005
+ #
3006
+ # * <b> <code>ARCH</code> </b>
3007
+ #
3008
+ # Sample values: `i686` \| `x86_64`
3009
+ #
3010
+ # * <b> <code>REPOSITORY</code> </b>
3011
+ #
3012
+ # Sample values: `Core` \| `Updates`
3013
+ #
3014
+ # * <b> <code>ADVISORY_ID</code> </b>
3015
+ #
3016
+ # Sample values: `ALAS-2018-1058` \| `ALAS2-2021-1594`
3017
+ #
3018
+ # * <b> <code>CVE_ID</code> </b>
3019
+ #
3020
+ # Sample values: `CVE-2018-3615` \| `CVE-2020-1472`
3021
+ #
3022
+ # * <b> <code>BUGZILLA_ID</code> </b>
3023
+ #
3024
+ # Sample values: `1463241`
2894
3025
  #
2895
3026
  # @option params [Integer] :max_results
2896
3027
  # The maximum number of patches to return (per page).
@@ -2959,10 +3090,11 @@ module Aws::SSM
2959
3090
  req.send_request(options)
2960
3091
  end
2961
3092
 
2962
- # Describes the specified Systems Manager document.
3093
+ # Describes the specified Amazon Web Services Systems Manager document
3094
+ # (SSM document).
2963
3095
  #
2964
3096
  # @option params [required, String] :name
2965
- # The name of the Systems Manager document.
3097
+ # The name of the SSM document.
2966
3098
  #
2967
3099
  # @option params [String] :document_version
2968
3100
  # The document version for which you want information. Can be a specific
@@ -2971,7 +3103,7 @@ module Aws::SSM
2971
3103
  # @option params [String] :version_name
2972
3104
  # An optional field specifying the version of the artifact associated
2973
3105
  # with the document. For example, "Release 12, Update 6". This value
2974
- # is unique across all versions of a document, and cannot be changed.
3106
+ # is unique across all versions of a document, and can't be changed.
2975
3107
  #
2976
3108
  # @return [Types::DescribeDocumentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2977
3109
  #
@@ -3038,10 +3170,11 @@ module Aws::SSM
3038
3170
  req.send_request(options)
3039
3171
  end
3040
3172
 
3041
- # Describes the permissions for a Systems Manager document. If you
3042
- # created the document, you are the owner. If a document is shared, it
3043
- # can either be shared privately (by specifying a user's AWS account
3044
- # ID) or publicly (*All*).
3173
+ # Describes the permissions for a Amazon Web Services Systems Manager
3174
+ # document (SSM document). If you created the document, you are the
3175
+ # owner. If a document is shared, it can either be shared privately (by
3176
+ # specifying a user's Amazon Web Services account ID) or publicly
3177
+ # (*All*).
3045
3178
  #
3046
3179
  # @option params [required, String] :name
3047
3180
  # The name of the document for which you are the owner.
@@ -3140,8 +3273,8 @@ module Aws::SSM
3140
3273
  end
3141
3274
 
3142
3275
  # Retrieves the current effective patches (the patch and the approval
3143
- # state) for the specified patch baseline. Note that this API applies
3144
- # only to Windows patch baselines.
3276
+ # state) for the specified patch baseline. Applies to patch baselines
3277
+ # for Windows only.
3145
3278
  #
3146
3279
  # @option params [required, String] :baseline_id
3147
3280
  # The ID of the patch baseline to retrieve the effective patches for.
@@ -3271,13 +3404,13 @@ module Aws::SSM
3271
3404
  # the instance, instance status, and so on.
3272
3405
  #
3273
3406
  # If you specify one or more instance IDs, it returns information for
3274
- # those instances. If you do not specify instance IDs, it returns
3407
+ # those instances. If you don't specify instance IDs, it returns
3275
3408
  # information for all your instances. If you specify an instance ID that
3276
- # is not valid or an instance that you do not own, you receive an error.
3409
+ # isn't valid or an instance that you don't own, you receive an error.
3277
3410
  #
3278
- # <note markdown="1"> The IamRole field for this API action is the Amazon Identity and
3279
- # Access Management (IAM) role assigned to on-premises instances. This
3280
- # call does not return the IAM role for EC2 instances.
3411
+ # <note markdown="1"> The `IamRole` field for this API operation is the Identity and Access
3412
+ # Management (IAM) role assigned to on-premises instances. This call
3413
+ # doesn't return the IAM role for EC2 instances.
3281
3414
  #
3282
3415
  # </note>
3283
3416
  #
@@ -3371,7 +3504,7 @@ module Aws::SSM
3371
3504
  # Retrieves the high-level patch state of one or more instances.
3372
3505
  #
3373
3506
  # @option params [required, Array<String>] :instance_ids
3374
- # The ID of the instance whose patch state information should be
3507
+ # The ID of the instance for which patch state information should be
3375
3508
  # retrieved.
3376
3509
  #
3377
3510
  # @option params [String] :next_token
@@ -3442,11 +3575,11 @@ module Aws::SSM
3442
3575
  # @option params [Array<Types::InstancePatchStateFilter>] :filters
3443
3576
  # Each entry in the array is a structure containing:
3444
3577
  #
3445
- # Key (string between 1 and 200 characters)
3578
+ # * Key (string between 1 and 200 characters)
3446
3579
  #
3447
- # Values (array containing a single string)
3580
+ # * Values (array containing a single string)
3448
3581
  #
3449
- # Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
3582
+ # * Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
3450
3583
  #
3451
3584
  # @option params [String] :next_token
3452
3585
  # The token for the next set of items to return. (You received this
@@ -3522,9 +3655,26 @@ module Aws::SSM
3522
3655
  # retrieved.
3523
3656
  #
3524
3657
  # @option params [Array<Types::PatchOrchestratorFilter>] :filters
3525
- # An array of structures. Each entry in the array is a structure
3526
- # containing a Key, Value combination. Valid values for Key are
3527
- # `Classification` \| `KBId` \| `Severity` \| `State`.
3658
+ # Each element in the array is a structure containing a key-value pair.
3659
+ #
3660
+ # Supported keys for `DescribeInstancePatches`include the following:
3661
+ #
3662
+ # * <b> <code>Classification</code> </b>
3663
+ #
3664
+ # Sample values: `Security` \| `SecurityUpdates`
3665
+ #
3666
+ # * <b> <code>KBId</code> </b>
3667
+ #
3668
+ # Sample values: `KB4480056` \| `java-1.7.0-openjdk.x86_64`
3669
+ #
3670
+ # * <b> <code>Severity</code> </b>
3671
+ #
3672
+ # Sample values: `Important` \| `Medium` \| `Low`
3673
+ #
3674
+ # * <b> <code>State</code> </b>
3675
+ #
3676
+ # Sample values: `Installed` \| `InstalledOther` \|
3677
+ # `InstalledPendingReboot`
3528
3678
  #
3529
3679
  # @option params [String] :next_token
3530
3680
  # The token for the next set of items to return. (You received this
@@ -3579,7 +3729,7 @@ module Aws::SSM
3579
3729
  #
3580
3730
  # @option params [String] :deletion_id
3581
3731
  # Specify the delete inventory ID for which you want information. This
3582
- # ID was returned by the `DeleteInventory` action.
3732
+ # ID was returned by the `DeleteInventory` operation.
3583
3733
  #
3584
3734
  # @option params [String] :next_token
3585
3735
  # A token to start the list. Use this token to get the next set of
@@ -3643,8 +3793,9 @@ module Aws::SSM
3643
3793
  #
3644
3794
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
3645
3795
  # Optional filters used to scope down the returned task invocations. The
3646
- # supported filter key is STATUS with the corresponding values PENDING,
3647
- # IN\_PROGRESS, SUCCESS, FAILED, TIMED\_OUT, CANCELLING, and CANCELLED.
3796
+ # supported filter key is `STATUS` with the corresponding values
3797
+ # `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`,
3798
+ # `CANCELLING`, and `CANCELLED`.
3648
3799
  #
3649
3800
  # @option params [Integer] :max_results
3650
3801
  # The maximum number of items to return for this call. The call also
@@ -3712,8 +3863,9 @@ module Aws::SSM
3712
3863
  #
3713
3864
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
3714
3865
  # Optional filters used to scope down the returned tasks. The supported
3715
- # filter key is STATUS with the corresponding values PENDING,
3716
- # IN\_PROGRESS, SUCCESS, FAILED, TIMED\_OUT, CANCELLING, and CANCELLED.
3866
+ # filter key is `STATUS` with the corresponding values `PENDING`,
3867
+ # `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and
3868
+ # `CANCELLED`.
3717
3869
  #
3718
3870
  # @option params [Integer] :max_results
3719
3871
  # The maximum number of items to return for this call. The call also
@@ -3778,12 +3930,12 @@ module Aws::SSM
3778
3930
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
3779
3931
  # Each entry in the array is a structure containing:
3780
3932
  #
3781
- # Key (string, between 1 and 128 characters)
3933
+ # * Key. A string between 1 and 128 characters. Supported keys include
3934
+ # `ExecutedBefore` and `ExecutedAfter`.
3782
3935
  #
3783
- # Values (array of strings, each string is between 1 and 256 characters)
3784
- #
3785
- # The supported Keys are ExecutedBefore and ExecutedAfter with the value
3786
- # being a date/time string such as 2016-11-04T05:00:00Z.
3936
+ # * Values. An array of strings, each between 1 and 256 characters.
3937
+ # Supported values are date/time strings in a valid ISO 8601 date/time
3938
+ # format, such as `2021-11-04T05:00:00Z`.
3787
3939
  #
3788
3940
  # @option params [Integer] :max_results
3789
3941
  # The maximum number of items to return for this call. The call also
@@ -3842,11 +3994,11 @@ module Aws::SSM
3842
3994
  # The ID of the maintenance window to retrieve information about.
3843
3995
  #
3844
3996
  # @option params [Array<Types::Target>] :targets
3845
- # The instance ID or key/value pair to retrieve information about.
3997
+ # The instance ID or key-value pair to retrieve information about.
3846
3998
  #
3847
3999
  # @option params [String] :resource_type
3848
4000
  # The type of resource you want to retrieve information about. For
3849
- # example, "INSTANCE".
4001
+ # example, `INSTANCE`.
3850
4002
  #
3851
4003
  # @option params [Array<Types::PatchOrchestratorFilter>] :filters
3852
4004
  # Filters used to limit the range of results. For example, you can limit
@@ -3914,8 +4066,8 @@ module Aws::SSM
3914
4066
  #
3915
4067
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
3916
4068
  # 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.
4069
+ # returned window targets. The supported filter keys are `Type`,
4070
+ # `WindowTargetId`, and `OwnerInformation`.
3919
4071
  #
3920
4072
  # @option params [Integer] :max_results
3921
4073
  # The maximum number of items to return for this call. The call also
@@ -3973,10 +4125,10 @@ module Aws::SSM
3973
4125
 
3974
4126
  # Lists the tasks in a maintenance window.
3975
4127
  #
3976
- # <note markdown="1"> For maintenance window tasks without a specified target, you cannot
4128
+ # <note markdown="1"> For maintenance window tasks without a specified target, you can't
3977
4129
  # supply values for `--max-errors` and `--max-concurrency`. Instead, the
3978
4130
  # system inserts a placeholder value of `1`, which may be reported in
3979
- # the response to this command. These values do not affect the running
4131
+ # the response to this command. These values don't affect the running
3980
4132
  # of your task and can be ignored.
3981
4133
  #
3982
4134
  # </note>
@@ -3986,8 +4138,8 @@ module Aws::SSM
3986
4138
  #
3987
4139
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
3988
4140
  # Optional filters used to narrow down the scope of the returned tasks.
3989
- # The supported filter keys are WindowTaskId, TaskArn, Priority, and
3990
- # TaskType.
4141
+ # The supported filter keys are `WindowTaskId`, `TaskArn`, `Priority`,
4142
+ # and `TaskType`.
3991
4143
  #
3992
4144
  # @option params [Integer] :max_results
3993
4145
  # The maximum number of items to return for this call. The call also
@@ -4053,12 +4205,12 @@ module Aws::SSM
4053
4205
  req.send_request(options)
4054
4206
  end
4055
4207
 
4056
- # Retrieves the maintenance windows in an AWS account.
4208
+ # Retrieves the maintenance windows in an Amazon Web Services account.
4057
4209
  #
4058
4210
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
4059
4211
  # Optional filters used to narrow down the scope of the returned
4060
- # maintenance windows. Supported filter keys are **Name** and
4061
- # **Enabled**.
4212
+ # maintenance windows. Supported filter keys are `Name` and `Enabled`.
4213
+ # For example, `Name=MyMaintenanceWindow` and `Enabled=True`.
4062
4214
  #
4063
4215
  # @option params [Integer] :max_results
4064
4216
  # The maximum number of items to return for this call. The call also
@@ -4119,11 +4271,11 @@ module Aws::SSM
4119
4271
  # that an instance is associated with.
4120
4272
  #
4121
4273
  # @option params [required, Array<Types::Target>] :targets
4122
- # The instance ID or key/value pair to retrieve information about.
4274
+ # The instance ID or key-value pair to retrieve information about.
4123
4275
  #
4124
4276
  # @option params [required, String] :resource_type
4125
4277
  # The type of resource you want to retrieve information about. For
4126
- # example, "INSTANCE".
4278
+ # example, `INSTANCE`.
4127
4279
  #
4128
4280
  # @option params [Integer] :max_results
4129
4281
  # The maximum number of items to return for this call. The call also
@@ -4171,16 +4323,17 @@ module Aws::SSM
4171
4323
  req.send_request(options)
4172
4324
  end
4173
4325
 
4174
- # Query a set of OpsItems. You must have permission in AWS Identity and
4326
+ # Query a set of OpsItems. You must have permission in Identity and
4175
4327
  # Access Management (IAM) to query a list of OpsItems. For more
4176
- # information, see [Getting started with OpsCenter][1] in the *AWS
4177
- # Systems Manager User Guide*.
4178
- #
4179
- # Operations engineers and IT professionals use OpsCenter to view,
4180
- # investigate, and remediate operational issues impacting the
4181
- # performance and health of their AWS resources. For more information,
4182
- # see [AWS Systems Manager OpsCenter][2] in the *AWS Systems Manager
4183
- # User Guide*.
4328
+ # information, see [Getting started with OpsCenter][1] in the *Amazon
4329
+ # Web Services Systems Manager User Guide*.
4330
+ #
4331
+ # Operations engineers and IT professionals use Amazon Web Services
4332
+ # Systems Manager OpsCenter to view, investigate, and remediate
4333
+ # operational issues impacting the performance and health of their
4334
+ # Amazon Web Services resources. For more information, see
4335
+ # [OpsCenter][2] in the *Amazon Web Services Systems Manager User
4336
+ # Guide*.
4184
4337
  #
4185
4338
  #
4186
4339
  #
@@ -4214,11 +4367,11 @@ module Aws::SSM
4214
4367
  #
4215
4368
  # Operations: Equals
4216
4369
  #
4217
- # * Key: Title
4370
+ # * Key: Title*
4218
4371
  #
4219
- # Operations: Contains
4372
+ # Operations: Equals,Contains
4220
4373
  #
4221
- # * Key: OperationalData*
4374
+ # * Key: OperationalData**
4222
4375
  #
4223
4376
  # Operations: Equals
4224
4377
  #
@@ -4242,7 +4395,11 @@ module Aws::SSM
4242
4395
  #
4243
4396
  # Operations: Equals
4244
4397
  #
4245
- # *If you filter the response by using the OperationalData operator,
4398
+ # *The Equals operator for Title matches the first 100 characters. If
4399
+ # you specify more than 100 characters, they system returns an error
4400
+ # that the filter value exceeds the length limit.
4401
+ #
4402
+ # **If you filter the response by using the OperationalData operator,
4246
4403
  # specify a key-value pair by using the following JSON format:
4247
4404
  # \\\{"key":"key\_name","value":"a\_value"\\}
4248
4405
  #
@@ -4267,7 +4424,7 @@ module Aws::SSM
4267
4424
  # resp = client.describe_ops_items({
4268
4425
  # ops_item_filters: [
4269
4426
  # {
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
4427
+ # 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
4428
  # values: ["OpsItemFilterValue"], # required
4272
4429
  # operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
4273
4430
  # },
@@ -4286,7 +4443,7 @@ module Aws::SSM
4286
4443
  # resp.ops_item_summaries[0].last_modified_time #=> Time
4287
4444
  # resp.ops_item_summaries[0].priority #=> Integer
4288
4445
  # 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"
4446
+ # 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
4447
  # resp.ops_item_summaries[0].ops_item_id #=> String
4291
4448
  # resp.ops_item_summaries[0].title #=> String
4292
4449
  # resp.ops_item_summaries[0].operational_data #=> Hash
@@ -4311,7 +4468,7 @@ module Aws::SSM
4311
4468
 
4312
4469
  # Get information about a parameter.
4313
4470
  #
4314
- # <note markdown="1"> Request results are returned on a best-effort basis. If you specify
4471
+ # Request results are returned on a best-effort basis. If you specify
4315
4472
  # `MaxResults` in the request, the response includes information up to
4316
4473
  # the limit specified. The number of items returned, however, can be
4317
4474
  # between zero and the value of `MaxResults`. If the service reaches an
@@ -4320,8 +4477,6 @@ module Aws::SSM
4320
4477
  # You can specify the `NextToken` in a subsequent call to get the next
4321
4478
  # set of results.
4322
4479
  #
4323
- # </note>
4324
- #
4325
4480
  # @option params [Array<Types::ParametersFilter>] :filters
4326
4481
  # This data type is deprecated. Instead, use `ParameterFilters`.
4327
4482
  #
@@ -4392,15 +4547,24 @@ module Aws::SSM
4392
4547
  req.send_request(options)
4393
4548
  end
4394
4549
 
4395
- # Lists the patch baselines in your AWS account.
4550
+ # Lists the patch baselines in your Amazon Web Services account.
4396
4551
  #
4397
4552
  # @option params [Array<Types::PatchOrchestratorFilter>] :filters
4398
- # Each element in the array is a structure containing:
4553
+ # Each element in the array is a structure containing a key-value pair.
4554
+ #
4555
+ # Supported keys for `DescribePatchBaselines` include the following:
4556
+ #
4557
+ # * <b> <code>NAME_PREFIX</code> </b>
4558
+ #
4559
+ # Sample values: `AWS-` \| `My-`
4399
4560
  #
4400
- # Key: (string, "NAME\_PREFIX" or "OWNER")
4561
+ # * <b> <code>OWNER</code> </b>
4401
4562
  #
4402
- # Value: (array of strings, exactly 1 entry, between 1 and 255
4403
- # characters)
4563
+ # Sample values: `AWS` \| `Self`
4564
+ #
4565
+ # * <b> <code>OPERATING_SYSTEM</code> </b>
4566
+ #
4567
+ # Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
4404
4568
  #
4405
4569
  # @option params [Integer] :max_results
4406
4570
  # The maximum number of patch baselines to return (per page).
@@ -4448,8 +4612,8 @@ module Aws::SSM
4448
4612
  req.send_request(options)
4449
4613
  end
4450
4614
 
4451
- # Returns high-level aggregated patch compliance state for a patch
4452
- # group.
4615
+ # Returns high-level aggregated patch compliance state information for a
4616
+ # patch group.
4453
4617
  #
4454
4618
  # @option params [required, String] :patch_group
4455
4619
  # The name of the patch group whose patch snapshot should be retrieved.
@@ -4505,24 +4669,17 @@ module Aws::SSM
4505
4669
  # The maximum number of patch groups to return (per page).
4506
4670
  #
4507
4671
  # @option params [Array<Types::PatchOrchestratorFilter>] :filters
4508
- # One or more filters. Use a filter to return a more specific list of
4509
- # results.
4510
- #
4511
- # For `DescribePatchGroups`,valid filter keys include the following:
4672
+ # Each element in the array is a structure containing a key-value pair.
4512
4673
  #
4513
- # * `NAME_PREFIX`\: The name of the patch group. Wildcards (*) are
4514
- # accepted.
4674
+ # Supported keys for `DescribePatchGroups` include the following:
4515
4675
  #
4516
- # * `OPERATING_SYSTEM`\: The supported operating system type to return
4517
- # results for. For valid operating system values, see
4518
- # GetDefaultPatchBaselineRequest$OperatingSystem in
4519
- # CreatePatchBaseline.
4676
+ # * <b> <code>NAME_PREFIX</code> </b>
4520
4677
  #
4521
- # Examples:
4678
+ # Sample values: `AWS-` \| `My-`.
4522
4679
  #
4523
- # * `--filters Key=NAME_PREFIX,Values=MyPatchGroup*`
4680
+ # * <b> <code>OPERATING_SYSTEM</code> </b>
4524
4681
  #
4525
- # * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
4682
+ # Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
4526
4683
  #
4527
4684
  # @option params [String] :next_token
4528
4685
  # The token for the next set of items to return. (You received this
@@ -4571,7 +4728,7 @@ module Aws::SSM
4571
4728
  # Lists the properties of available patches organized by product,
4572
4729
  # product family, classification, severity, and other properties of
4573
4730
  # available patches. You can use the reported properties in the filters
4574
- # you specify in requests for actions such as CreatePatchBaseline,
4731
+ # you specify in requests for operations such as CreatePatchBaseline,
4575
4732
  # UpdatePatchBaseline, DescribeAvailablePatches, and
4576
4733
  # DescribePatchBaselines.
4577
4734
  #
@@ -4580,44 +4737,44 @@ module Aws::SSM
4580
4737
  #
4581
4738
  # AMAZON\_LINUX
4582
4739
  #
4583
- # : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4740
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
4584
4741
  #
4585
4742
  # AMAZON\_LINUX\_2
4586
4743
  #
4587
- # : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4744
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
4588
4745
  #
4589
4746
  # CENTOS
4590
4747
  #
4591
- # : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4748
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
4592
4749
  #
4593
4750
  # DEBIAN
4594
4751
  #
4595
- # : Valid properties: PRODUCT, PRIORITY
4752
+ # : Valid properties: `PRODUCT` \| `PRIORITY`
4596
4753
  #
4597
4754
  # MACOS
4598
4755
  #
4599
- # : Valid properties: PRODUCT, CLASSIFICATION
4756
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION`
4600
4757
  #
4601
4758
  # ORACLE\_LINUX
4602
4759
  #
4603
- # : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4760
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
4604
4761
  #
4605
4762
  # REDHAT\_ENTERPRISE\_LINUX
4606
4763
  #
4607
- # : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4764
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
4608
4765
  #
4609
4766
  # SUSE
4610
4767
  #
4611
- # : Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4768
+ # : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
4612
4769
  #
4613
4770
  # UBUNTU
4614
4771
  #
4615
- # : Valid properties: PRODUCT, PRIORITY
4772
+ # : Valid properties: `PRODUCT` \| `PRIORITY`
4616
4773
  #
4617
4774
  # WINDOWS
4618
4775
  #
4619
- # : Valid properties: PRODUCT, PRODUCT\_FAMILY, CLASSIFICATION,
4620
- # MSRC\_SEVERITY
4776
+ # : Valid properties: `PRODUCT` \| `PRODUCT_FAMILY` \| `CLASSIFICATION`
4777
+ # \| `MSRC_SEVERITY`
4621
4778
  #
4622
4779
  # @option params [required, String] :operating_system
4623
4780
  # The operating system type for which to list patches.
@@ -4627,8 +4784,8 @@ module Aws::SSM
4627
4784
  #
4628
4785
  # @option params [String] :patch_set
4629
4786
  # Indicates whether to list patches for the Windows operating system or
4630
- # for Microsoft applications. Not applicable for the Linux or macOS
4631
- # operating systems.
4787
+ # for applications released by Microsoft. Not applicable for the Linux
4788
+ # or macOS operating systems.
4632
4789
  #
4633
4790
  # @option params [Integer] :max_results
4634
4791
  # The maximum number of items to return for this call. The call also
@@ -4738,8 +4895,9 @@ module Aws::SSM
4738
4895
  end
4739
4896
 
4740
4897
  # Deletes the association between an OpsItem and a related resource. For
4741
- # example, this API action can delete an Incident Manager incident from
4742
- # an OpsItem. Incident Manager is a capability of AWS Systems Manager.
4898
+ # example, this API operation can delete an Incident Manager incident
4899
+ # from an OpsItem. Incident Manager is a capability of Amazon Web
4900
+ # Services Systems Manager.
4743
4901
  #
4744
4902
  # @option params [required, String] :ops_item_id
4745
4903
  # The ID of the OpsItem for which you want to delete an association
@@ -4772,7 +4930,7 @@ module Aws::SSM
4772
4930
  # @option params [required, String] :automation_execution_id
4773
4931
  # The unique identifier for an existing automation execution to examine.
4774
4932
  # The execution ID is returned by StartAutomationExecution when the
4775
- # execution of an Automation document is initiated.
4933
+ # execution of an Automation runbook is initiated.
4776
4934
  #
4777
4935
  # @return [Types::GetAutomationExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4778
4936
  #
@@ -4911,20 +5069,22 @@ module Aws::SSM
4911
5069
  req.send_request(options)
4912
5070
  end
4913
5071
 
4914
- # Gets the state of the AWS Systems Manager Change Calendar at an
4915
- # optional, specified time. If you specify a time, `GetCalendarState`
4916
- # returns the state of the calendar at a specific time, and returns the
4917
- # next time that the Change Calendar state will transition. If you do
4918
- # not specify a time, `GetCalendarState` assumes the current time.
4919
- # Change Calendar entries have two possible states: `OPEN` or `CLOSED`.
5072
+ # Gets the state of a Amazon Web Services Systems Manager change
5073
+ # calendar at the current time or a specified time. If you specify a
5074
+ # time, `GetCalendarState` returns the state of the calendar at that
5075
+ # specific time, and returns the next time that the change calendar
5076
+ # state will transition. If you don't specify a time,
5077
+ # `GetCalendarState` uses the current time. Change Calendar entries have
5078
+ # two possible states: `OPEN` or `CLOSED`.
4920
5079
  #
4921
5080
  # If you specify more than one calendar in a request, the command
4922
5081
  # returns the status of `OPEN` only if all calendars in the request are
4923
5082
  # open. If one or more calendars in the request are closed, the status
4924
5083
  # returned is `CLOSED`.
4925
5084
  #
4926
- # For more information about Systems Manager Change Calendar, see [AWS
4927
- # Systems Manager Change Calendar][1] in the *AWS Systems Manager User
5085
+ # For more information about Change Calendar, a capability of Amazon Web
5086
+ # Services Systems Manager, see [Amazon Web Services Systems Manager
5087
+ # Change Calendar][1] in the *Amazon Web Services Systems Manager User
4928
5088
  # Guide*.
4929
5089
  #
4930
5090
  #
@@ -4933,13 +5093,13 @@ module Aws::SSM
4933
5093
  #
4934
5094
  # @option params [required, Array<String>] :calendar_names
4935
5095
  # The names or Amazon Resource Names (ARNs) of the Systems Manager
4936
- # documents that represent the calendar entries for which you want to
4937
- # get the state.
5096
+ # documents (SSM documents) that represent the calendar entries for
5097
+ # which you want to get the state.
4938
5098
  #
4939
5099
  # @option params [String] :at_time
4940
5100
  # (Optional) The specific time for which you want to get calendar state
4941
- # information, in [ISO 8601][1] format. If you do not add `AtTime`, the
4942
- # current time is assumed.
5101
+ # information, in [ISO 8601][1] format. If you don't specify a value or
5102
+ # `AtTime`, the current time is used.
4943
5103
  #
4944
5104
  #
4945
5105
  #
@@ -4988,7 +5148,7 @@ module Aws::SSM
4988
5148
  # (Required) The ID of the managed instance targeted by the command. A
4989
5149
  # managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2)
4990
5150
  # instance or an instance in your hybrid environment that is configured
4991
- # for AWS Systems Manager.
5151
+ # for Amazon Web Services Systems Manager.
4992
5152
  #
4993
5153
  # @option params [String] :plugin_name
4994
5154
  # The name of the plugin for which you want detailed results. If the
@@ -4998,7 +5158,8 @@ module Aws::SSM
4998
5158
  # details.
4999
5159
  #
5000
5160
  # Plugin names are also referred to as *step names* in Systems Manager
5001
- # documents. For example, `aws:RunShellScript` is a plugin.
5161
+ # documents (SSM documents). For example, `aws:RunShellScript` is a
5162
+ # plugin.
5002
5163
  #
5003
5164
  # To find the `PluginName`, check the document content and find the name
5004
5165
  # of the plugin. Alternatively, use ListCommandInvocations with the
@@ -5073,7 +5234,7 @@ module Aws::SSM
5073
5234
  # connections.
5074
5235
  #
5075
5236
  # @option params [required, String] :target
5076
- # The ID of the instance.
5237
+ # The instance ID.
5077
5238
  #
5078
5239
  # @return [Types::GetConnectionStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5079
5240
  #
@@ -5100,11 +5261,12 @@ module Aws::SSM
5100
5261
  req.send_request(options)
5101
5262
  end
5102
5263
 
5103
- # Retrieves the default patch baseline. Note that Systems Manager
5104
- # supports creating multiple default patch baselines. For example, you
5105
- # can create a default patch baseline for each operating system.
5264
+ # Retrieves the default patch baseline. Amazon Web Services Systems
5265
+ # Manager supports creating multiple default patch baselines. For
5266
+ # example, you can create a default patch baseline for each operating
5267
+ # system.
5106
5268
  #
5107
- # If you do not specify an operating system value, the default patch
5269
+ # If you don't specify an operating system value, the default patch
5108
5270
  # baseline for Windows is returned.
5109
5271
  #
5110
5272
  # @option params [String] :operating_system
@@ -5136,15 +5298,28 @@ module Aws::SSM
5136
5298
  end
5137
5299
 
5138
5300
  # 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.
5301
+ # uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems
5302
+ # Manager document (SSM document).
5303
+ #
5304
+ # <note markdown="1"> If you run the command locally, such as with the Command Line
5305
+ # Interface (CLI), the system attempts to use your local Amazon Web
5306
+ # Services credentials and the operation fails. To avoid this, you can
5307
+ # run the command in the Amazon Web Services Systems Manager console.
5308
+ # Use Run Command, a capability of Amazon Web Services Systems Manager,
5309
+ # with an SSM document that enables you to target an instance with a
5310
+ # script or command. For example, run the command using the
5311
+ # `AWS-RunShellScript` document or the `AWS-RunPowerShellScript`
5312
+ # document.
5313
+ #
5314
+ # </note>
5141
5315
  #
5142
5316
  # @option params [required, String] :instance_id
5143
5317
  # The ID of the instance for which the appropriate patch snapshot should
5144
5318
  # be retrieved.
5145
5319
  #
5146
5320
  # @option params [required, String] :snapshot_id
5147
- # The user-defined snapshot ID.
5321
+ # The snapshot ID provided by the user when running
5322
+ # `AWS-RunPatchBaseline`.
5148
5323
  #
5149
5324
  # @option params [Types::BaselineOverride] :baseline_override
5150
5325
  # Defines the basic information about a patch baseline override.
@@ -5220,10 +5395,11 @@ module Aws::SSM
5220
5395
  req.send_request(options)
5221
5396
  end
5222
5397
 
5223
- # Gets the contents of the specified Systems Manager document.
5398
+ # Gets the contents of the specified Amazon Web Services Systems Manager
5399
+ # document (SSM document).
5224
5400
  #
5225
5401
  # @option params [required, String] :name
5226
- # The name of the Systems Manager document.
5402
+ # The name of the SSM document.
5227
5403
  #
5228
5404
  # @option params [String] :version_name
5229
5405
  # An optional field specifying the version of the artifact associated
@@ -5294,7 +5470,8 @@ module Aws::SSM
5294
5470
  req.send_request(options)
5295
5471
  end
5296
5472
 
5297
- # Query inventory information.
5473
+ # Query inventory information. This includes instance status, such as
5474
+ # `Stopped` or `Terminated`.
5298
5475
  #
5299
5476
  # @option params [Array<Types::InventoryFilter>] :filters
5300
5477
  # One or more filters. Use a filter to return a more specific list of
@@ -5668,10 +5845,10 @@ module Aws::SSM
5668
5845
 
5669
5846
  # Lists the tasks in a maintenance window.
5670
5847
  #
5671
- # <note markdown="1"> For maintenance window tasks without a specified target, you cannot
5848
+ # <note markdown="1"> For maintenance window tasks without a specified target, you can't
5672
5849
  # supply values for `--max-errors` and `--max-concurrency`. Instead, the
5673
5850
  # system inserts a placeholder value of `1`, which may be reported in
5674
- # the response to this command. These values do not affect the running
5851
+ # the response to this command. These values don't affect the running
5675
5852
  # of your task and can be ignored.
5676
5853
  #
5677
5854
  # </note>
@@ -5765,15 +5942,16 @@ module Aws::SSM
5765
5942
  end
5766
5943
 
5767
5944
  # Get information about an OpsItem by using the ID. You must have
5768
- # permission in AWS Identity and Access Management (IAM) to view
5769
- # information about an OpsItem. For more information, see [Getting
5770
- # started with OpsCenter][1] in the *AWS Systems Manager User Guide*.
5771
- #
5772
- # Operations engineers and IT professionals use OpsCenter to view,
5773
- # investigate, and remediate operational issues impacting the
5774
- # performance and health of their AWS resources. For more information,
5775
- # see [AWS Systems Manager OpsCenter][2] in the *AWS Systems Manager
5776
- # User Guide*.
5945
+ # permission in Identity and Access Management (IAM) to view information
5946
+ # about an OpsItem. For more information, see [Getting started with
5947
+ # OpsCenter][1] in the *Amazon Web Services Systems Manager User Guide*.
5948
+ #
5949
+ # Operations engineers and IT professionals use Amazon Web Services
5950
+ # Systems Manager OpsCenter to view, investigate, and remediate
5951
+ # operational issues impacting the performance and health of their
5952
+ # Amazon Web Services resources. For more information, see
5953
+ # [OpsCenter][2] in the *Amazon Web Services Systems Manager User
5954
+ # Guide*.
5777
5955
  #
5778
5956
  #
5779
5957
  #
@@ -5806,7 +5984,7 @@ module Aws::SSM
5806
5984
  # resp.ops_item.priority #=> Integer
5807
5985
  # resp.ops_item.related_ops_items #=> Array
5808
5986
  # 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"
5987
+ # 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
5988
  # resp.ops_item.ops_item_id #=> String
5811
5989
  # resp.ops_item.version #=> String
5812
5990
  # resp.ops_item.title #=> String
@@ -5875,20 +6053,25 @@ module Aws::SSM
5875
6053
  req.send_request(options)
5876
6054
  end
5877
6055
 
5878
- # View a summary of OpsItems based on specified filters and aggregators.
6056
+ # View a summary of operations metadata (OpsData) based on specified
6057
+ # filters and aggregators. OpsData can include information about Amazon
6058
+ # Web Services Systems Manager OpsCenter operational workitems
6059
+ # (OpsItems) as well as information about any Amazon Web Services
6060
+ # resource or service configured to report OpsData to Amazon Web
6061
+ # Services Systems Manager Explorer.
5879
6062
  #
5880
6063
  # @option params [String] :sync_name
5881
6064
  # Specify the name of a resource data sync to get.
5882
6065
  #
5883
6066
  # @option params [Array<Types::OpsFilter>] :filters
5884
- # Optional filters used to scope down the returned OpsItems.
6067
+ # Optional filters used to scope down the returned OpsData.
5885
6068
  #
5886
6069
  # @option params [Array<Types::OpsAggregator>] :aggregators
5887
- # Optional aggregators that return counts of OpsItems based on one or
6070
+ # Optional aggregators that return counts of OpsData based on one or
5888
6071
  # more expressions.
5889
6072
  #
5890
6073
  # @option params [Array<Types::OpsResultAttribute>] :result_attributes
5891
- # The OpsItem data type to return.
6074
+ # The OpsData data type to return.
5892
6075
  #
5893
6076
  # @option params [String] :next_token
5894
6077
  # A token to start the list. Use this token to get the next set of
@@ -5966,15 +6149,23 @@ module Aws::SSM
5966
6149
  req.send_request(options)
5967
6150
  end
5968
6151
 
5969
- # Get information about a parameter by using the parameter name. Don't
5970
- # confuse this API action with the GetParameters API action.
6152
+ # Get information about a single parameter by specifying the parameter
6153
+ # name.
6154
+ #
6155
+ # <note markdown="1"> To get information about more than one parameter at a time, use the
6156
+ # GetParameters operation.
6157
+ #
6158
+ # </note>
5971
6159
  #
5972
6160
  # @option params [required, String] :name
5973
6161
  # The name of the parameter you want to query.
5974
6162
  #
6163
+ # To query by parameter label, use `"Name": "name:label"`. To query by
6164
+ # parameter version, use `"Name": "name:version"`.
6165
+ #
5975
6166
  # @option params [Boolean] :with_decryption
5976
6167
  # Return decrypted values for secure string parameters. This flag is
5977
- # ignored for String and StringList parameter types.
6168
+ # ignored for `String` and `StringList` parameter types.
5978
6169
  #
5979
6170
  # @return [Types::GetParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5980
6171
  #
@@ -6015,7 +6206,7 @@ module Aws::SSM
6015
6206
  #
6016
6207
  # @option params [Boolean] :with_decryption
6017
6208
  # Return decrypted values for secure string parameters. This flag is
6018
- # ignored for String and StringList parameter types.
6209
+ # ignored for `String` and `StringList` parameter types.
6019
6210
  #
6020
6211
  # @option params [Integer] :max_results
6021
6212
  # The maximum number of items to return for this call. The call also
@@ -6073,16 +6264,24 @@ module Aws::SSM
6073
6264
  req.send_request(options)
6074
6265
  end
6075
6266
 
6076
- # Get details of a parameter. Don't confuse this API action with the
6077
- # GetParameter API action.
6267
+ # Get information about one or more parameters by specifying multiple
6268
+ # parameter names.
6269
+ #
6270
+ # <note markdown="1"> To get information about a single parameter, you can use the
6271
+ # GetParameter operation instead.
6272
+ #
6273
+ # </note>
6078
6274
  #
6079
6275
  # @option params [required, Array<String>] :names
6080
6276
  # Names of the parameters for which you want to query information.
6081
6277
  #
6278
+ # To query by parameter label, use `"Name": "name:label"`. To query by
6279
+ # parameter version, use `"Name": "name:version"`.
6280
+ #
6082
6281
  # @option params [Boolean] :with_decryption
6083
6282
  # Return decrypted secure string value. Return decrypted values for
6084
- # secure string parameters. This flag is ignored for String and
6085
- # StringList parameter types.
6283
+ # secure string parameters. This flag is ignored for `String` and
6284
+ # `StringList` parameter types.
6086
6285
  #
6087
6286
  # @return [Types::GetParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6088
6287
  #
@@ -6123,7 +6322,7 @@ module Aws::SSM
6123
6322
  # Retrieve information about one or more parameters in a specific
6124
6323
  # hierarchy.
6125
6324
  #
6126
- # <note markdown="1"> Request results are returned on a best-effort basis. If you specify
6325
+ # Request results are returned on a best-effort basis. If you specify
6127
6326
  # `MaxResults` in the request, the response includes information up to
6128
6327
  # the limit specified. The number of items returned, however, can be
6129
6328
  # between zero and the value of `MaxResults`. If the service reaches an
@@ -6132,13 +6331,11 @@ module Aws::SSM
6132
6331
  # You can specify the `NextToken` in a subsequent call to get the next
6133
6332
  # set of results.
6134
6333
  #
6135
- # </note>
6136
- #
6137
6334
  # @option params [required, String] :path
6138
6335
  # The hierarchy for the parameter. Hierarchies start with a forward
6139
6336
  # slash (/). The hierachy is the parameter name except the last part of
6140
6337
  # the parameter. For the API call to succeeed, the last part of the
6141
- # parameter name cannot be in the path. A parameter name hierarchy can
6338
+ # parameter name can't be in the path. A parameter name hierarchy can
6142
6339
  # have a maximum of 15 levels. Here is an example of a hierarchy:
6143
6340
  # `/Finance/Prod/IAD/WinServ2016/license33 `
6144
6341
  #
@@ -6149,7 +6346,7 @@ module Aws::SSM
6149
6346
  # that path. For example, if a user has permission to access path `/a`,
6150
6347
  # then the user can also access `/a/b`. Even if a user has explicitly
6151
6348
  # been denied access in IAM for parameter `/a/b`, they can still call
6152
- # the GetParametersByPath API action recursively for `/a` and view
6349
+ # the GetParametersByPath API operation recursively for `/a` and view
6153
6350
  # `/a/b`.
6154
6351
  #
6155
6352
  # @option params [Array<Types::ParameterStringFilter>] :parameter_filters
@@ -6227,6 +6424,15 @@ module Aws::SSM
6227
6424
  # @option params [required, String] :baseline_id
6228
6425
  # The ID of the patch baseline to retrieve.
6229
6426
  #
6427
+ # <note markdown="1"> To retrieve information about an Amazon Web Services managed patch
6428
+ # baseline, specify the full Amazon Resource Name (ARN) of the baseline.
6429
+ # For example, for the baseline `AWS-AmazonLinuxDefaultPatchBaseline`,
6430
+ # specify
6431
+ # `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7`
6432
+ # instead of `pb-0e392de35e7c563b7`.
6433
+ #
6434
+ # </note>
6435
+ #
6230
6436
  # @return [Types::GetPatchBaselineResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6231
6437
  #
6232
6438
  # * {Types::GetPatchBaselineResult#baseline_id #baseline_id} => String
@@ -6334,31 +6540,41 @@ module Aws::SSM
6334
6540
  req.send_request(options)
6335
6541
  end
6336
6542
 
6337
- # `ServiceSetting` is an account-level setting for an AWS service. This
6338
- # setting defines how a user interacts with or uses a service or a
6339
- # feature of a service. For example, if an AWS service charges money to
6340
- # the account based on feature or service usage, then the AWS service
6341
- # team might create a default setting of "false". This means the user
6342
- # can't use this feature unless they change the setting to "true" and
6343
- # intentionally opt in for a paid feature.
6543
+ # `ServiceSetting` is an account-level setting for an Amazon Web
6544
+ # Services service. This setting defines how a user interacts with or
6545
+ # uses a service or a feature of a service. For example, if an Amazon
6546
+ # Web Services service charges money to the account based on feature or
6547
+ # service usage, then the Amazon Web Services service team might create
6548
+ # a default setting of `false`. This means the user can't use this
6549
+ # feature unless they change the setting to `true` and intentionally opt
6550
+ # in for a paid feature.
6344
6551
  #
6345
- # Services map a `SettingId` object to a setting value. AWS services
6346
- # teams define the default value for a `SettingId`. You can't create a
6347
- # new `SettingId`, but you can overwrite the default value if you have
6348
- # the `ssm:UpdateServiceSetting` permission for the setting. Use the
6349
- # UpdateServiceSetting API action to change the default setting. Or use
6350
- # the ResetServiceSetting to change the value back to the original value
6351
- # defined by the AWS service team.
6552
+ # Services map a `SettingId` object to a setting value. Amazon Web
6553
+ # Services services teams define the default value for a `SettingId`.
6554
+ # You can't create a new `SettingId`, but you can overwrite the default
6555
+ # value if you have the `ssm:UpdateServiceSetting` permission for the
6556
+ # setting. Use the UpdateServiceSetting API operation to change the
6557
+ # default setting. Or use the ResetServiceSetting to change the value
6558
+ # back to the original value defined by the Amazon Web Services service
6559
+ # team.
6352
6560
  #
6353
- # Query the current service setting for the account.
6561
+ # Query the current service setting for the Amazon Web Services account.
6354
6562
  #
6355
6563
  # @option params [required, String] :setting_id
6356
- # The ID of the service setting to get. The setting ID can be
6357
- # `/ssm/automation/customer-script-log-destination`,
6358
- # `/ssm/automation/customer-script-log-group-name`,
6359
- # `/ssm/parameter-store/default-parameter-tier`,
6360
- # `/ssm/parameter-store/high-throughput-enabled`, or
6361
- # `/ssm/managed-instance/activation-tier`.
6564
+ # The ID of the service setting to get. The setting ID can be one of the
6565
+ # following.
6566
+ #
6567
+ # * `/ssm/automation/customer-script-log-destination`
6568
+ #
6569
+ # * `/ssm/automation/customer-script-log-group-name`
6570
+ #
6571
+ # * `/ssm/documents/console/public-sharing-permission`
6572
+ #
6573
+ # * `/ssm/parameter-store/default-parameter-tier`
6574
+ #
6575
+ # * `/ssm/parameter-store/high-throughput-enabled`
6576
+ #
6577
+ # * `/ssm/managed-instance/activation-tier`
6362
6578
  #
6363
6579
  # @return [Types::GetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6364
6580
  #
@@ -6389,10 +6605,10 @@ module Aws::SSM
6389
6605
  end
6390
6606
 
6391
6607
  # A parameter label is a user-defined alias to help you manage different
6392
- # versions of a parameter. When you modify a parameter, Systems Manager
6393
- # automatically saves a new version and increments the version number by
6394
- # one. A label can help you remember the purpose of a parameter when
6395
- # there are multiple versions.
6608
+ # versions of a parameter. When you modify a parameter, Amazon Web
6609
+ # Services Systems Manager automatically saves a new version and
6610
+ # increments the version number by one. A label can help you remember
6611
+ # the purpose of a parameter when there are multiple versions.
6396
6612
  #
6397
6613
  # Parameter labels have the following requirements and restrictions.
6398
6614
  #
@@ -6415,9 +6631,9 @@ module Aws::SSM
6415
6631
  # * Labels can contain letters (case sensitive), numbers, periods (.),
6416
6632
  # hyphens (-), or underscores (\_).
6417
6633
  #
6418
- # * Labels can't begin with a number, "aws," or "ssm" (not case
6634
+ # * Labels can't begin with a number, "`aws`" or "`ssm`" (not case
6419
6635
  # sensitive). If a label fails to meet these requirements, then the
6420
- # label is not associated with a parameter and the system displays it
6636
+ # label isn't associated with a parameter and the system displays it
6421
6637
  # in the list of InvalidLabels.
6422
6638
  #
6423
6639
  # @option params [required, String] :name
@@ -6535,9 +6751,11 @@ module Aws::SSM
6535
6751
  req.send_request(options)
6536
6752
  end
6537
6753
 
6538
- # Returns all State Manager associations in the current AWS account and
6539
- # Region. You can limit the results to a specific State Manager
6540
- # association document or instance by specifying a filter.
6754
+ # Returns all State Manager associations in the current Amazon Web
6755
+ # Services account and Amazon Web Services Region. You can limit the
6756
+ # results to a specific State Manager association document or instance
6757
+ # by specifying a filter. State Manager is a capability of Amazon Web
6758
+ # Services Systems Manager.
6541
6759
  #
6542
6760
  # @option params [Array<Types::AssociationFilter>] :association_filter_list
6543
6761
  # One or more filters. Use a filter to return a more specific list of
@@ -6546,7 +6764,7 @@ module Aws::SSM
6546
6764
  # <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
6547
6765
  # legacy associations created using the `InstanceID` attribute.
6548
6766
  # Associations targeting the instance that are part of the Target
6549
- # Attributes `ResourceGroup` or `Tags` are not returned.
6767
+ # Attributes `ResourceGroup` or `Tags` aren't returned.
6550
6768
  #
6551
6769
  # </note>
6552
6770
  #
@@ -6611,9 +6829,9 @@ module Aws::SSM
6611
6829
 
6612
6830
  # An invocation is copy of a command sent to a specific instance. A
6613
6831
  # command can apply to one or more instances. A command invocation
6614
- # applies to one instance. For example, if a user runs SendCommand
6832
+ # applies to one instance. For example, if a user runs `SendCommand`
6615
6833
  # against three instances, then a command invocation is created for each
6616
- # requested instance ID. ListCommandInvocations provide status about
6834
+ # requested instance ID. `ListCommandInvocations` provide status about
6617
6835
  # command execution.
6618
6836
  #
6619
6837
  # @option params [String] :command_id
@@ -6637,7 +6855,7 @@ module Aws::SSM
6637
6855
  #
6638
6856
  # @option params [Boolean] :details
6639
6857
  # (Optional) If set this returns the response of the command executions
6640
- # and any command output. The default value is 'false'.
6858
+ # and any command output. The default value is `false`.
6641
6859
  #
6642
6860
  # @return [Types::ListCommandInvocationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6643
6861
  #
@@ -6708,7 +6926,8 @@ module Aws::SSM
6708
6926
  req.send_request(options)
6709
6927
  end
6710
6928
 
6711
- # Lists the commands requested by users of the AWS account.
6929
+ # Lists the commands requested by users of the Amazon Web Services
6930
+ # account.
6712
6931
  #
6713
6932
  # @option params [String] :command_id
6714
6933
  # (Optional) If provided, lists only the specified command.
@@ -6717,7 +6936,7 @@ module Aws::SSM
6717
6936
  # (Optional) Lists commands issued against this instance ID.
6718
6937
  #
6719
6938
  # <note markdown="1"> You can't specify an instance ID in the same command that you specify
6720
- # `Status` = `Pending`. This is because the command has not reached the
6939
+ # `Status` = `Pending`. This is because the command hasn't reached the
6721
6940
  # instance yet.
6722
6941
  #
6723
6942
  # </note>
@@ -6805,7 +7024,7 @@ module Aws::SSM
6805
7024
  req.send_request(options)
6806
7025
  end
6807
7026
 
6808
- # For a specified resource ID, this API action returns a list of
7027
+ # For a specified resource ID, this API operation returns a list of
6809
7028
  # compliance statuses for different resource types. Currently, you can
6810
7029
  # only specify one resource ID per call. List results depend on the
6811
7030
  # criteria specified in the filter.
@@ -6948,13 +7167,14 @@ module Aws::SSM
6948
7167
  req.send_request(options)
6949
7168
  end
6950
7169
 
6951
- # Information about approval reviews for a version of an SSM document.
7170
+ # Information about approval reviews for a version of a change template
7171
+ # in Change Manager.
6952
7172
  #
6953
7173
  # @option params [required, String] :name
6954
- # The name of the document.
7174
+ # The name of the change template.
6955
7175
  #
6956
7176
  # @option params [String] :document_version
6957
- # The version of the document.
7177
+ # The version of the change template.
6958
7178
  #
6959
7179
  # @option params [required, String] :metadata
6960
7180
  # The type of data for which details are being requested. Currently, the
@@ -7065,9 +7285,9 @@ module Aws::SSM
7065
7285
  req.send_request(options)
7066
7286
  end
7067
7287
 
7068
- # Returns all Systems Manager (SSM) documents in the current AWS account
7069
- # and Region. You can limit the results of this request by using a
7070
- # filter.
7288
+ # Returns all Systems Manager (SSM) documents in the current Amazon Web
7289
+ # Services account and Amazon Web Services Region. You can limit the
7290
+ # results of this request by using a filter.
7071
7291
  #
7072
7292
  # @option params [Array<Types::DocumentFilter>] :document_filter_list
7073
7293
  # This data type is deprecated. Instead, use `Filters`.
@@ -7081,7 +7301,7 @@ module Aws::SSM
7081
7301
  # `Key=Owner,Values=Self`. To specify a custom key-value pair, use the
7082
7302
  # format `Key=tag:tagName,Values=valueName`.
7083
7303
  #
7084
- # <note markdown="1"> This API action only supports filtering documents by using a single
7304
+ # <note markdown="1"> This API operation only supports filtering documents by using a single
7085
7305
  # tag key and one or more tag values. For example:
7086
7306
  # `Key=tag:tagName,Values=valueName1,valueName2`
7087
7307
  #
@@ -7183,7 +7403,7 @@ module Aws::SSM
7183
7403
  # * {Types::ListInventoryEntriesResult#instance_id #instance_id} => String
7184
7404
  # * {Types::ListInventoryEntriesResult#schema_version #schema_version} => String
7185
7405
  # * {Types::ListInventoryEntriesResult#capture_time #capture_time} => String
7186
- # * {Types::ListInventoryEntriesResult#entries #entries} => Array&lt;Hash&lt;String,String&gt;&gt;
7406
+ # * {Types::ListInventoryEntriesResult#entries #data.entries} => Array&lt;Hash&lt;String,String&gt;&gt; (This method conflicts with a method on Response, call it through the data member)
7187
7407
  # * {Types::ListInventoryEntriesResult#next_token #next_token} => String
7188
7408
  #
7189
7409
  # @example Request syntax with placeholder values
@@ -7208,9 +7428,9 @@ module Aws::SSM
7208
7428
  # resp.instance_id #=> String
7209
7429
  # resp.schema_version #=> String
7210
7430
  # resp.capture_time #=> String
7211
- # resp.entries #=> Array
7212
- # resp.entries[0] #=> Hash
7213
- # resp.entries[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
7431
+ # resp.data.entries #=> Array
7432
+ # resp.data.entries[0] #=> Hash
7433
+ # resp.data.entries[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
7214
7434
  # resp.next_token #=> String
7215
7435
  #
7216
7436
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries AWS API Documentation
@@ -7222,9 +7442,10 @@ module Aws::SSM
7222
7442
  req.send_request(options)
7223
7443
  end
7224
7444
 
7225
- # Returns a list of all OpsItem events in the current AWS account and
7226
- # Region. You can limit the results to events associated with specific
7227
- # OpsItems by specifying a filter.
7445
+ # Returns a list of all OpsItem events in the current Amazon Web
7446
+ # Services Region and Amazon Web Services account. You can limit the
7447
+ # results to events associated with specific OpsItems by specifying a
7448
+ # filter.
7228
7449
  #
7229
7450
  # @option params [Array<Types::OpsItemEventFilter>] :filters
7230
7451
  # One or more OpsItem filters. Use a filter to return a more specific
@@ -7345,8 +7566,8 @@ module Aws::SSM
7345
7566
  req.send_request(options)
7346
7567
  end
7347
7568
 
7348
- # Systems Manager calls this API action when displaying all Application
7349
- # Manager OpsMetadata objects or blobs.
7569
+ # Amazon Web Services Systems Manager calls this API operation when
7570
+ # displaying all Application Manager OpsMetadata objects or blobs.
7350
7571
  #
7351
7572
  # @option params [Array<Types::OpsMetadataFilter>] :filters
7352
7573
  # One or more filters to limit the number of OpsMetadata objects
@@ -7492,7 +7713,7 @@ module Aws::SSM
7492
7713
  # View a list of resource data syncs according to the sync type. Specify
7493
7714
  # `SyncToDestination` to view resource data syncs that synchronize data
7494
7715
  # to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data
7495
- # syncs from AWS Organizations or from multiple AWS Regions.
7716
+ # syncs from Organizations or from multiple Amazon Web Services Regions.
7496
7717
  #
7497
7718
  # @option params [String] :next_token
7498
7719
  # A token to start the list. Use this token to get the next set of
@@ -7557,6 +7778,9 @@ module Aws::SSM
7557
7778
 
7558
7779
  # Returns a list of the tags assigned to the specified resource.
7559
7780
  #
7781
+ # For information about the ID format for each supported resource type,
7782
+ # see AddTagsToResource.
7783
+ #
7560
7784
  # @option params [required, String] :resource_type
7561
7785
  # Returns a list of tags for a specific resource type.
7562
7786
  #
@@ -7589,10 +7813,11 @@ module Aws::SSM
7589
7813
  req.send_request(options)
7590
7814
  end
7591
7815
 
7592
- # Shares a Systems Manager document publicly or privately. If you share
7593
- # a document privately, you must specify the AWS user account IDs for
7594
- # those people who can use the document. If you share a document
7595
- # publicly, you must specify *All* as the account ID.
7816
+ # Shares a Amazon Web Services Systems Manager document (SSM
7817
+ # document)publicly or privately. If you share a document privately, you
7818
+ # must specify the Amazon Web Services user account IDs for those people
7819
+ # who can use the document. If you share a document publicly, you must
7820
+ # specify *All* as the account ID.
7596
7821
  #
7597
7822
  # @option params [required, String] :name
7598
7823
  # The name of the document that you want to share.
@@ -7602,18 +7827,19 @@ module Aws::SSM
7602
7827
  # *Share*.
7603
7828
  #
7604
7829
  # @option params [Array<String>] :account_ids_to_add
7605
- # The AWS user accounts that should have access to the document. The
7606
- # account IDs can either be a group of account IDs or *All*.
7830
+ # The Amazon Web Services user accounts that should have access to the
7831
+ # document. The account IDs can either be a group of account IDs or
7832
+ # *All*.
7607
7833
  #
7608
7834
  # @option params [Array<String>] :account_ids_to_remove
7609
- # The AWS user accounts that should no longer have access to the
7610
- # document. The AWS user account can either be a group of account IDs or
7611
- # *All*. This action has a higher priority than *AccountIdsToAdd*. If
7612
- # you specify an account ID to add and the same ID to remove, the system
7613
- # removes access to the document.
7835
+ # The Amazon Web Services user accounts that should no longer have
7836
+ # access to the document. The Amazon Web Services user account can
7837
+ # either be a group of account IDs or *All*. This action has a higher
7838
+ # priority than *AccountIdsToAdd*. If you specify an account ID to add
7839
+ # and the same ID to remove, the system removes access to the document.
7614
7840
  #
7615
7841
  # @option params [String] :shared_document_version
7616
- # (Optional) The version of the document to share. If it's not
7842
+ # (Optional) The version of the document to share. If it isn't
7617
7843
  # specified, the system choose the `Default` version to share.
7618
7844
  #
7619
7845
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -7638,10 +7864,10 @@ module Aws::SSM
7638
7864
  end
7639
7865
 
7640
7866
  # Registers a compliance type and other compliance details on a
7641
- # designated resource. This action lets you register custom compliance
7642
- # details with a resource. This call overwrites existing compliance
7643
- # information on the resource, so you must provide a full list of
7644
- # compliance items each time that you send the request.
7867
+ # designated resource. This operation lets you register custom
7868
+ # compliance details with a resource. This call overwrites existing
7869
+ # compliance information on the resource, so you must provide a full
7870
+ # list of compliance items each time that you send the request.
7645
7871
  #
7646
7872
  # ComplianceType can be one of the following:
7647
7873
  #
@@ -7662,8 +7888,8 @@ module Aws::SSM
7662
7888
  #
7663
7889
  # * Severity: A patch severity. For example, `critical`.
7664
7890
  #
7665
- # * DocumentName: A SSM document name. For example,
7666
- # AWS-RunPatchBaseline.
7891
+ # * DocumentName: An SSM document name. For example,
7892
+ # `AWS-RunPatchBaseline`.
7667
7893
  #
7668
7894
  # * DocumentVersion: An SSM document version number. For example, 4.
7669
7895
  #
@@ -7825,9 +8051,9 @@ module Aws::SSM
7825
8051
  #
7826
8052
  # * Parameter names are case sensitive.
7827
8053
  #
7828
- # * A parameter name must be unique within an AWS Region
8054
+ # * A parameter name must be unique within an Amazon Web Services Region
7829
8055
  #
7830
- # * A parameter name can't be prefixed with "aws" or "ssm"
8056
+ # * A parameter name can't be prefixed with "`aws`" or "`ssm`"
7831
8057
  # (case-insensitive).
7832
8058
  #
7833
8059
  # * Parameter names can include only the following symbols and letters:
@@ -7843,11 +8069,11 @@ module Aws::SSM
7843
8069
  # levels.
7844
8070
  #
7845
8071
  # For additional information about valid values for parameter names, see
7846
- # [Creating Systems Manager parameters][1] in the *AWS Systems Manager
7847
- # User Guide*.
8072
+ # [Creating Systems Manager parameters][1] in the *Amazon Web Services
8073
+ # Systems Manager User Guide*.
7848
8074
  #
7849
8075
  # <note markdown="1"> The maximum length constraint listed below includes capacity for
7850
- # additional system attributes that are not part of the name. The
8076
+ # additional system attributes that aren't part of the name. The
7851
8077
  # maximum length for a parameter name, including the full length of the
7852
8078
  # parameter ARN, is 1011 characters. For example, the length of the
7853
8079
  # following parameter name is 65 characters, not 20 characters:
@@ -7864,7 +8090,7 @@ module Aws::SSM
7864
8090
  # Information about the parameter that you want to add to the system.
7865
8091
  # Optional but recommended.
7866
8092
  #
7867
- # Do not enter personally identifiable information in this field.
8093
+ # Don't enter personally identifiable information in this field.
7868
8094
  #
7869
8095
  # @option params [required, String] :value
7870
8096
  # The parameter value that you want to add to the system. Standard
@@ -7880,7 +8106,7 @@ module Aws::SSM
7880
8106
  # @option params [String] :type
7881
8107
  # The type of parameter that you want to add to the system.
7882
8108
  #
7883
- # <note markdown="1"> `SecureString` is not currently supported for AWS CloudFormation
8109
+ # <note markdown="1"> `SecureString` isn't currently supported for CloudFormation
7884
8110
  # templates.
7885
8111
  #
7886
8112
  # </note>
@@ -7890,28 +8116,27 @@ module Aws::SSM
7890
8116
  # list. If you have a parameter value that requires a comma, then use
7891
8117
  # the `String` data type.
7892
8118
  #
7893
- # Specifying a parameter type is not required when updating a parameter.
8119
+ # Specifying a parameter type isn't required when updating a parameter.
7894
8120
  # You must specify a parameter type when creating a parameter.
7895
8121
  #
7896
8122
  # @option params [String] :key_id
7897
- # The KMS Key ID that you want to use to encrypt a parameter. Either the
7898
- # default AWS Key Management Service (AWS KMS) key automatically
7899
- # assigned to your AWS account or a custom key. Required for parameters
8123
+ # The Key Management Service (KMS) ID that you want to use to encrypt a
8124
+ # parameter. Either the default KMS key automatically assigned to your
8125
+ # Amazon Web Services account or a custom key. Required for parameters
7900
8126
  # that use the `SecureString` data type.
7901
8127
  #
7902
8128
  # If you don't specify a key ID, the system uses the default key
7903
- # associated with your AWS account.
8129
+ # associated with your Amazon Web Services account.
7904
8130
  #
7905
- # * To use your default AWS KMS key, choose the `SecureString` data
7906
- # type, and do *not* specify the `Key ID` when you create the
7907
- # parameter. The system automatically populates `Key ID` with your
7908
- # default KMS key.
8131
+ # * To use your default KMS key, choose the `SecureString` data type,
8132
+ # and do *not* specify the `Key ID` when you create the parameter. The
8133
+ # system automatically populates `Key ID` with your default KMS key.
7909
8134
  #
7910
8135
  # * To use a custom KMS key, choose the `SecureString` data type with
7911
8136
  # the `Key ID` parameter.
7912
8137
  #
7913
8138
  # @option params [Boolean] :overwrite
7914
- # Overwrite an existing parameter. The default value is 'false'.
8139
+ # Overwrite an existing parameter. The default value is `false`.
7915
8140
  #
7916
8141
  # @option params [String] :allowed_pattern
7917
8142
  # A regular expression used to validate the parameter value. For
@@ -7924,8 +8149,8 @@ module Aws::SSM
7924
8149
  # environment. For example, you might want to tag a Systems Manager
7925
8150
  # parameter to identify the type of resource to which it applies, the
7926
8151
  # environment, or the type of configuration data referenced by the
7927
- # parameter. In this case, you could specify the following key
7928
- # name/value pairs:
8152
+ # parameter. In this case, you could specify the following key-value
8153
+ # pairs:
7929
8154
  #
7930
8155
  # * `Key=Resource,Value=S3bucket`
7931
8156
  #
@@ -7934,7 +8159,7 @@ module Aws::SSM
7934
8159
  # * `Key=ParameterType,Value=LicenseKey`
7935
8160
  #
7936
8161
  # <note markdown="1"> To add tags to an existing Systems Manager parameter, use the
7937
- # AddTagsToResource action.
8162
+ # AddTagsToResource operation.
7938
8163
  #
7939
8164
  # </note>
7940
8165
  #
@@ -7944,15 +8169,16 @@ module Aws::SSM
7944
8169
  # Parameter Store offers a standard tier and an advanced tier for
7945
8170
  # parameters. Standard parameters have a content size limit of 4 KB and
7946
8171
  # can't be configured to use parameter policies. You can create a
7947
- # maximum of 10,000 standard parameters for each Region in an AWS
7948
- # account. Standard parameters are offered at no additional cost.
8172
+ # maximum of 10,000 standard parameters for each Region in an Amazon Web
8173
+ # Services account. Standard parameters are offered at no additional
8174
+ # cost.
7949
8175
  #
7950
8176
  # Advanced parameters have a content size limit of 8 KB and can be
7951
8177
  # configured to use parameter policies. You can create a maximum of
7952
- # 100,000 advanced parameters for each Region in an AWS account.
7953
- # Advanced parameters incur a charge. For more information, see
7954
- # [Standard and advanced parameter tiers][1] in the *AWS Systems Manager
7955
- # User Guide*.
8178
+ # 100,000 advanced parameters for each Region in an Amazon Web Services
8179
+ # account. Advanced parameters incur a charge. For more information, see
8180
+ # [Standard and advanced parameter tiers][1] in the *Amazon Web Services
8181
+ # Systems Manager User Guide*.
7956
8182
  #
7957
8183
  # You can change a standard parameter to an advanced parameter any time.
7958
8184
  # But you can't revert an advanced parameter to a standard parameter.
@@ -7971,7 +8197,7 @@ module Aws::SSM
7971
8197
  # In `PutParameter` requests, you can specify the tier to create the
7972
8198
  # parameter in. Whenever you specify a tier in the request, Parameter
7973
8199
  # Store creates or updates the parameter according to that request.
7974
- # However, if you do not specify a tier in a request, Parameter Store
8200
+ # However, if you don't specify a tier in a request, Parameter Store
7975
8201
  # assigns the tier based on the current Parameter Store default tier
7976
8202
  # configuration.
7977
8203
  #
@@ -8002,12 +8228,12 @@ module Aws::SSM
8002
8228
  #
8003
8229
  # * The parameter uses a parameter policy.
8004
8230
  #
8005
- # * More than 10,000 parameters already exist in your AWS account in the
8006
- # current Region.
8231
+ # * More than 10,000 parameters already exist in your Amazon Web
8232
+ # Services account in the current Amazon Web Services Region.
8007
8233
  #
8008
8234
  # For more information about configuring the default tier option, see
8009
- # [Specifying a default parameter tier][2] in the *AWS Systems Manager
8010
- # User Guide*.
8235
+ # [Specifying a default parameter tier][2] in the *Amazon Web Services
8236
+ # Systems Manager User Guide*.
8011
8237
  #
8012
8238
  #
8013
8239
  #
@@ -8015,13 +8241,14 @@ module Aws::SSM
8015
8241
  # [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html
8016
8242
  #
8017
8243
  # @option params [String] :policies
8018
- # One or more policies to apply to a parameter. This action takes a JSON
8019
- # array. Parameter Store supports the following policy types:
8244
+ # One or more policies to apply to a parameter. This operation takes a
8245
+ # JSON array. Parameter Store, a capability of Amazon Web Services
8246
+ # Systems Manager supports the following policy types:
8020
8247
  #
8021
8248
  # Expiration: This policy deletes the parameter after it expires. When
8022
8249
  # you create the policy, you specify the expiration date. You can update
8023
8250
  # the expiration date and time by updating the policy. Updating the
8024
- # *parameter* does not affect the expiration date and time. When the
8251
+ # *parameter* doesn't affect the expiration date and time. When the
8025
8252
  # expiration time is reached, Parameter Store deletes the parameter.
8026
8253
  #
8027
8254
  # ExpirationNotification: This policy triggers an event in Amazon
@@ -8029,10 +8256,10 @@ module Aws::SSM
8029
8256
  # this policy, you can receive notification before or after the
8030
8257
  # expiration time is reached, in units of days or hours.
8031
8258
  #
8032
- # NoChangeNotification: This policy triggers a CloudWatch event if a
8033
- # parameter has not been modified for a specified period of time. This
8034
- # policy type is useful when, for example, a secret needs to be changed
8035
- # within a period of time, but it has not been changed.
8259
+ # NoChangeNotification: This policy triggers a CloudWatch Events event
8260
+ # if a parameter hasn't been modified for a specified period of time.
8261
+ # This policy type is useful when, for example, a secret needs to be
8262
+ # changed within a period of time, but it hasn't been changed.
8036
8263
  #
8037
8264
  # All existing policies are preserved until you send new policies or an
8038
8265
  # empty policy. For more information about parameter policies, see
@@ -8044,7 +8271,7 @@ module Aws::SSM
8044
8271
  #
8045
8272
  # @option params [String] :data_type
8046
8273
  # The data type for a `String` parameter. Supported data types include
8047
- # plain text and Amazon Machine Image IDs.
8274
+ # plain text and Amazon Machine Image (AMI) IDs.
8048
8275
  #
8049
8276
  # **The following data type values are supported.**
8050
8277
  #
@@ -8053,15 +8280,16 @@ module Aws::SSM
8053
8280
  # * `aws:ec2:image`
8054
8281
  #
8055
8282
  # When you create a `String` parameter and specify `aws:ec2:image`,
8056
- # Systems Manager validates the parameter value is in the required
8057
- # format, such as `ami-12345abcdeEXAMPLE`, and that the specified AMI is
8058
- # available in your AWS account. For more information, see [Native
8059
- # parameter support for Amazon Machine Image IDs][1] in the *AWS Systems
8060
- # Manager User Guide*.
8283
+ # Amazon Web Services Systems Manager validates the parameter value is
8284
+ # in the required format, such as `ami-12345abcdeEXAMPLE`, and that the
8285
+ # specified AMI is available in your Amazon Web Services account. For
8286
+ # more information, see [Native parameter support for Amazon Machine
8287
+ # Image (AMI) IDs][1] in the *Amazon Web Services Systems Manager User
8288
+ # Guide*.
8061
8289
  #
8062
8290
  #
8063
8291
  #
8064
- # [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html
8292
+ # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html
8065
8293
  #
8066
8294
  # @return [Types::PutParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8067
8295
  #
@@ -8105,9 +8333,9 @@ module Aws::SSM
8105
8333
 
8106
8334
  # Defines the default patch baseline for the relevant operating system.
8107
8335
  #
8108
- # To reset the AWS predefined patch baseline as the default, specify the
8109
- # full patch baseline ARN as the baseline ID value. For example, for
8110
- # CentOS, specify
8336
+ # To reset the Amazon Web Services-predefined patch baseline as the
8337
+ # default, specify the full patch baseline Amazon Resource Name (ARN) as
8338
+ # the baseline ID value. For example, for CentOS, specify
8111
8339
  # `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed`
8112
8340
  # instead of `pb-0574b43a65ea646ed`.
8113
8341
  #
@@ -8141,11 +8369,10 @@ module Aws::SSM
8141
8369
  # Registers a patch baseline for a patch group.
8142
8370
  #
8143
8371
  # @option params [required, String] :baseline_id
8144
- # The ID of the patch baseline to register the patch group with.
8372
+ # The ID of the patch baseline to register with the patch group.
8145
8373
  #
8146
8374
  # @option params [required, String] :patch_group
8147
- # The name of the patch group that should be registered with the patch
8148
- # baseline.
8375
+ # The name of the patch group to be registered with the patch baseline.
8149
8376
  #
8150
8377
  # @return [Types::RegisterPatchBaselineForPatchGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8151
8378
  #
@@ -8227,16 +8454,17 @@ module Aws::SSM
8227
8454
  #
8228
8455
  # For more information about these examples formats, including the best
8229
8456
  # use case for each one, see [Examples: Register targets with a
8230
- # maintenance window][1] in the *AWS Systems Manager User Guide*.
8457
+ # maintenance window][1] in the *Amazon Web Services Systems Manager
8458
+ # User Guide*.
8231
8459
  #
8232
8460
  #
8233
8461
  #
8234
8462
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
8235
8463
  #
8236
8464
  # @option params [String] :owner_information
8237
- # User-provided value that will be included in any CloudWatch events
8238
- # raised while running tasks for these targets in this maintenance
8239
- # window.
8465
+ # User-provided value that will be included in any Amazon CloudWatch
8466
+ # Events events raised while running tasks for these targets in this
8467
+ # maintenance window.
8240
8468
  #
8241
8469
  # @option params [String] :name
8242
8470
  # An optional name for the target.
@@ -8294,10 +8522,10 @@ module Aws::SSM
8294
8522
  #
8295
8523
  # <note markdown="1"> One or more targets must be specified for maintenance window Run
8296
8524
  # Command-type tasks. Depending on the task, targets are optional for
8297
- # other maintenance window task types (Automation, AWS Lambda, and AWS
8298
- # Step Functions). For more information about running tasks that do not
8525
+ # other maintenance window task types (Automation, Lambda, and Step
8526
+ # Functions). For more information about running tasks that don't
8299
8527
  # specify targets, see [Registering maintenance window tasks without
8300
- # targets][1] in the *AWS Systems Manager User Guide*.
8528
+ # targets][1] in the *Amazon Web Services Systems Manager User Guide*.
8301
8529
  #
8302
8530
  # </note>
8303
8531
  #
@@ -8317,14 +8545,15 @@ module Aws::SSM
8317
8545
  # The ARN of the task to run.
8318
8546
  #
8319
8547
  # @option params [String] :service_role_arn
8320
- # The ARN of the IAM service role for Systems Manager to assume when
8321
- # running a maintenance window task. If you do not specify a service
8322
- # role ARN, Systems Manager uses your account's service-linked role. If
8323
- # no service-linked role for Systems Manager exists in your account, it
8324
- # is created when you run `RegisterTaskWithMaintenanceWindow`.
8548
+ # The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
8549
+ # Services Systems Manager to assume when running a maintenance window
8550
+ # task. If you do not specify a service role ARN, Systems Manager uses
8551
+ # your account's service-linked role. If no service-linked role for
8552
+ # Systems Manager exists in your account, it is created when you run
8553
+ # `RegisterTaskWithMaintenanceWindow`.
8325
8554
  #
8326
- # For more information, see the following topics in the in the *AWS
8327
- # Systems Manager User Guide*\:
8555
+ # For more information, see the following topics in the in the *Amazon
8556
+ # Web Services Systems Manager User Guide*\:
8328
8557
  #
8329
8558
  # * [Using service-linked roles for Systems Manager][1]
8330
8559
  #
@@ -8364,9 +8593,9 @@ module Aws::SSM
8364
8593
  # @option params [String] :max_concurrency
8365
8594
  # The maximum number of targets this task can be run for in parallel.
8366
8595
  #
8367
- # <note markdown="1"> For maintenance window tasks without a target specified, you cannot
8596
+ # <note markdown="1"> For maintenance window tasks without a target specified, you can't
8368
8597
  # supply a value for this option. Instead, the system inserts a
8369
- # placeholder value of `1`. This value does not affect the running of
8598
+ # placeholder value of `1`. This value doesn't affect the running of
8370
8599
  # your task.
8371
8600
  #
8372
8601
  # </note>
@@ -8375,21 +8604,22 @@ module Aws::SSM
8375
8604
  # The maximum number of errors allowed before this task stops being
8376
8605
  # scheduled.
8377
8606
  #
8378
- # <note markdown="1"> For maintenance window tasks without a target specified, you cannot
8607
+ # <note markdown="1"> For maintenance window tasks without a target specified, you can't
8379
8608
  # supply a value for this option. Instead, the system inserts a
8380
- # placeholder value of `1`. This value does not affect the running of
8609
+ # placeholder value of `1`. This value doesn't affect the running of
8381
8610
  # your task.
8382
8611
  #
8383
8612
  # </note>
8384
8613
  #
8385
8614
  # @option params [Types::LoggingInfo] :logging_info
8386
- # A structure containing information about an S3 bucket to write
8387
- # instance-level logs to.
8388
- #
8389
- # <note markdown="1"> `LoggingInfo` has been deprecated. To specify an S3 bucket to contain
8390
- # logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
8391
- # options in the `TaskInvocationParameters` structure. For information
8392
- # about how Systems Manager handles these options for the supported
8615
+ # A structure containing information about an Amazon Simple Storage
8616
+ # Service (Amazon S3) bucket to write instance-level logs to.
8617
+ #
8618
+ # <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
8619
+ # Service (Amazon S3) bucket to contain logs, instead use the
8620
+ # `OutputS3BucketName` and `OutputS3KeyPrefix` options in the
8621
+ # `TaskInvocationParameters` structure. For information about how Amazon
8622
+ # Web Services Systems Manager handles these options for the supported
8393
8623
  # maintenance window task types, see
8394
8624
  # MaintenanceWindowTaskInvocationParameters.
8395
8625
  #
@@ -8499,9 +8729,10 @@ module Aws::SSM
8499
8729
  # @option params [required, String] :resource_type
8500
8730
  # The type of resource from which you want to remove a tag.
8501
8731
  #
8502
- # <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
8503
- # managed instances. Specify the name of the managed instance in the
8504
- # following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
8732
+ # <note markdown="1"> The `ManagedInstance` type for this API operation is only for
8733
+ # on-premises managed instances. Specify the name of the managed
8734
+ # instance in the following format: `mi-ID_number `. For example,
8735
+ # `mi-1a2b3c4d5e6f`.
8505
8736
  #
8506
8737
  # </note>
8507
8738
  #
@@ -8525,9 +8756,10 @@ module Aws::SSM
8525
8756
  #
8526
8757
  # For the Document and Parameter values, use the name of the resource.
8527
8758
  #
8528
- # <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
8529
- # managed instances. Specify the name of the managed instance in the
8530
- # following format: mi-ID\_number. For example, mi-1a2b3c4d5e6f.
8759
+ # <note markdown="1"> The ManagedInstance type for this API operation is only for
8760
+ # on-premises managed instances. Specify the name of the managed
8761
+ # instance in the following format: mi-ID\_number. For example,
8762
+ # mi-1a2b3c4d5e6f.
8531
8763
  #
8532
8764
  # </note>
8533
8765
  #
@@ -8553,32 +8785,41 @@ module Aws::SSM
8553
8785
  req.send_request(options)
8554
8786
  end
8555
8787
 
8556
- # `ServiceSetting` is an account-level setting for an AWS service. This
8557
- # setting defines how a user interacts with or uses a service or a
8558
- # feature of a service. For example, if an AWS service charges money to
8559
- # the account based on feature or service usage, then the AWS service
8560
- # team might create a default setting of "false". This means the user
8561
- # can't use this feature unless they change the setting to "true" and
8562
- # intentionally opt in for a paid feature.
8788
+ # `ServiceSetting` is an account-level setting for an Amazon Web
8789
+ # Services service. This setting defines how a user interacts with or
8790
+ # uses a service or a feature of a service. For example, if an Amazon
8791
+ # Web Services service charges money to the account based on feature or
8792
+ # service usage, then the Amazon Web Services service team might create
8793
+ # a default setting of "false". This means the user can't use this
8794
+ # feature unless they change the setting to "true" and intentionally
8795
+ # opt in for a paid feature.
8563
8796
  #
8564
- # Services map a `SettingId` object to a setting value. AWS services
8565
- # teams define the default value for a `SettingId`. You can't create a
8566
- # new `SettingId`, but you can overwrite the default value if you have
8567
- # the `ssm:UpdateServiceSetting` permission for the setting. Use the
8568
- # GetServiceSetting API action to view the current value. Use the
8569
- # UpdateServiceSetting API action to change the default setting.
8797
+ # Services map a `SettingId` object to a setting value. Amazon Web
8798
+ # Services services teams define the default value for a `SettingId`.
8799
+ # You can't create a new `SettingId`, but you can overwrite the default
8800
+ # value if you have the `ssm:UpdateServiceSetting` permission for the
8801
+ # setting. Use the GetServiceSetting API operation to view the current
8802
+ # value. Use the UpdateServiceSetting API operation to change the
8803
+ # default setting.
8570
8804
  #
8571
8805
  # Reset the service setting for the account to the default value as
8572
- # provisioned by the AWS service team.
8806
+ # provisioned by the Amazon Web Services service team.
8573
8807
  #
8574
8808
  # @option params [required, String] :setting_id
8575
8809
  # The Amazon Resource Name (ARN) of the service setting to reset. The
8576
- # setting ID can be `/ssm/automation/customer-script-log-destination`,
8577
- # `/ssm/automation/customer-script-log-group-name`,
8578
- # `/ssm/parameter-store/default-parameter-tier`,
8579
- # `/ssm/parameter-store/high-throughput-enabled`, or
8580
- # `/ssm/managed-instance/activation-tier`. For example,
8581
- # `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`.
8810
+ # setting ID can be one of the following.
8811
+ #
8812
+ # * `/ssm/automation/customer-script-log-destination`
8813
+ #
8814
+ # * `/ssm/automation/customer-script-log-group-name`
8815
+ #
8816
+ # * `/ssm/documents/console/public-sharing-permission`
8817
+ #
8818
+ # * `/ssm/parameter-store/default-parameter-tier`
8819
+ #
8820
+ # * `/ssm/parameter-store/high-throughput-enabled`
8821
+ #
8822
+ # * `/ssm/managed-instance/activation-tier`
8582
8823
  #
8583
8824
  # @return [Types::ResetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8584
8825
  #
@@ -8613,7 +8854,7 @@ module Aws::SSM
8613
8854
  # terminated sessions.
8614
8855
  #
8615
8856
  # <note markdown="1"> This command is primarily for use by client machines to automatically
8616
- # reconnect during intermittent network issues. It is not intended for
8857
+ # reconnect during intermittent network issues. It isn't intended for
8617
8858
  # any other use.
8618
8859
  #
8619
8860
  # </note>
@@ -8712,8 +8953,8 @@ module Aws::SSM
8712
8953
  # tens, hundreds, or thousands of instances at once.
8713
8954
  #
8714
8955
  # For more information about how to use targets, see [Using targets and
8715
- # rate controls to send commands to a fleet][1] in the *AWS Systems
8716
- # Manager User Guide*.
8956
+ # rate controls to send commands to a fleet][1] in the *Amazon Web
8957
+ # Services Systems Manager User Guide*.
8717
8958
  #
8718
8959
  #
8719
8960
  #
@@ -8731,18 +8972,20 @@ module Aws::SSM
8731
8972
  # `InstanceIds` option instead.
8732
8973
  #
8733
8974
  # For more information about how to use targets, see [Sending commands
8734
- # to a fleet][1] in the *AWS Systems Manager User Guide*.
8975
+ # to a fleet][1] in the *Amazon Web Services Systems Manager User
8976
+ # Guide*.
8735
8977
  #
8736
8978
  #
8737
8979
  #
8738
8980
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
8739
8981
  #
8740
8982
  # @option params [required, String] :document_name
8741
- # The name of the Systems Manager document to run. This can be a public
8742
- # document or a custom document. To run a shared document belonging to
8743
- # another account, specify the document ARN. For more information about
8744
- # how to use shared documents, see [Using shared SSM documents][1] in
8745
- # the *AWS Systems Manager User Guide*.
8983
+ # The name of the Amazon Web Services Systems Manager document (SSM
8984
+ # document) to run. This can be a public document or a custom document.
8985
+ # To run a shared document belonging to another account, specify the
8986
+ # document ARN. For more information about how to use shared documents,
8987
+ # see [Using shared SSM documents][1] in the *Amazon Web Services
8988
+ # Systems Manager User Guide*.
8746
8989
  #
8747
8990
  #
8748
8991
  #
@@ -8751,9 +8994,10 @@ module Aws::SSM
8751
8994
  # @option params [String] :document_version
8752
8995
  # The SSM document version to use in the request. You can specify
8753
8996
  # $DEFAULT, $LATEST, or a specific version number. If you run commands
8754
- # by using the AWS CLI, then you must escape the first two options by
8755
- # using a backslash. If you specify a version number, then you don't
8756
- # need to use the backslash. For example:
8997
+ # by using the Command Line Interface (Amazon Web Services CLI), then
8998
+ # you must escape the first two options by using a backslash. If you
8999
+ # specify a version number, then you don't need to use the backslash.
9000
+ # For example:
8757
9001
  #
8758
9002
  # --document-version "\\$DEFAULT"
8759
9003
  #
@@ -8777,8 +9021,8 @@ module Aws::SSM
8777
9021
  # </note>
8778
9022
  #
8779
9023
  # @option params [Integer] :timeout_seconds
8780
- # If this time is reached and the command has not already started
8781
- # running, it will not run.
9024
+ # If this time is reached and the command hasn't already started
9025
+ # running, it won't run.
8782
9026
  #
8783
9027
  # @option params [String] :comment
8784
9028
  # User-specified information about the command, such as a brief
@@ -8791,7 +9035,7 @@ module Aws::SSM
8791
9035
  # @option params [String] :output_s3_region
8792
9036
  # (Deprecated) You can no longer specify this parameter. The system
8793
9037
  # ignores it. Instead, Systems Manager automatically determines the
8794
- # Region of the S3 bucket.
9038
+ # Amazon Web Services Region of the S3 bucket.
8795
9039
  #
8796
9040
  # @option params [String] :output_s3_bucket_name
8797
9041
  # The name of the S3 bucket where command execution responses should be
@@ -8804,9 +9048,9 @@ module Aws::SSM
8804
9048
  # @option params [String] :max_concurrency
8805
9049
  # (Optional) The maximum number of instances that are allowed to run the
8806
9050
  # command at the same time. You can specify a number such as 10 or a
8807
- # percentage such as 10%. The default value is 50. For more information
8808
- # about how to use MaxConcurrency, see [Using concurrency controls][1]
8809
- # in the *AWS Systems Manager User Guide*.
9051
+ # percentage such as 10%. The default value is `50`. For more
9052
+ # information about how to use `MaxConcurrency`, see [Using concurrency
9053
+ # controls][1] in the *Amazon Web Services Systems Manager User Guide*.
8810
9054
  #
8811
9055
  #
8812
9056
  #
@@ -8814,27 +9058,29 @@ module Aws::SSM
8814
9058
  #
8815
9059
  # @option params [String] :max_errors
8816
9060
  # The maximum number of errors allowed without the command failing. When
8817
- # the command fails one more time beyond the value of MaxErrors, the
9061
+ # the command fails one more time beyond the value of `MaxErrors`, the
8818
9062
  # systems stops sending the command to additional targets. You can
8819
9063
  # specify a number like 10 or a percentage like 10%. The default value
8820
- # is 0. For more information about how to use MaxErrors, see [Using
8821
- # error controls][1] in the *AWS Systems Manager User Guide*.
9064
+ # is `0`. For more information about how to use `MaxErrors`, see [Using
9065
+ # error controls][1] in the *Amazon Web Services Systems Manager User
9066
+ # Guide*.
8822
9067
  #
8823
9068
  #
8824
9069
  #
8825
9070
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
8826
9071
  #
8827
9072
  # @option params [String] :service_role_arn
8828
- # The ARN of the IAM service role to use to publish Amazon Simple
8829
- # Notification Service (Amazon SNS) notifications for Run Command
8830
- # commands.
9073
+ # The ARN of the Identity and Access Management (IAM) service role to
9074
+ # use to publish Amazon Simple Notification Service (Amazon SNS)
9075
+ # notifications for Run Command commands.
8831
9076
  #
8832
9077
  # @option params [Types::NotificationConfig] :notification_config
8833
9078
  # Configurations for sending notifications.
8834
9079
  #
8835
9080
  # @option params [Types::CloudWatchOutputConfig] :cloud_watch_output_config
8836
- # Enables Systems Manager to send Run Command output to Amazon
8837
- # CloudWatch Logs.
9081
+ # Enables Amazon Web Services Systems Manager to send Run Command output
9082
+ # to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web
9083
+ # Services Systems Manager.
8838
9084
  #
8839
9085
  # @return [Types::SendCommandResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8840
9086
  #
@@ -8922,8 +9168,8 @@ module Aws::SSM
8922
9168
  req.send_request(options)
8923
9169
  end
8924
9170
 
8925
- # Use this API action to run an association immediately and only one
8926
- # time. This action can be helpful when troubleshooting associations.
9171
+ # Runs an association immediately and only one time. This operation can
9172
+ # be helpful when troubleshooting associations.
8927
9173
  #
8928
9174
  # @option params [required, Array<String>] :association_ids
8929
9175
  # The association IDs that you want to run immediately and only one
@@ -8946,25 +9192,25 @@ module Aws::SSM
8946
9192
  req.send_request(options)
8947
9193
  end
8948
9194
 
8949
- # Initiates execution of an Automation document.
9195
+ # Initiates execution of an Automation runbook.
8950
9196
  #
8951
9197
  # @option params [required, String] :document_name
8952
- # The name of the Systems Manager document to run. This can be a public
8953
- # document or a custom document. To run a shared document belonging to
8954
- # another account, specify the document ARN. For more information about
8955
- # how to use shared documents, see [Using shared SSM documents][1] in
8956
- # the *AWS Systems Manager User Guide*.
9198
+ # The name of the SSM document to run. This can be a public document or
9199
+ # a custom document. To run a shared document belonging to another
9200
+ # account, specify the document ARN. For more information about how to
9201
+ # use shared documents, see [Using shared SSM documents][1] in the
9202
+ # *Amazon Web Services Systems Manager User Guide*.
8957
9203
  #
8958
9204
  #
8959
9205
  #
8960
9206
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
8961
9207
  #
8962
9208
  # @option params [String] :document_version
8963
- # The version of the Automation document to use for this execution.
9209
+ # The version of the Automation runbook to use for this execution.
8964
9210
  #
8965
9211
  # @option params [Hash<String,Array>] :parameters
8966
9212
  # A key-value map of execution parameters, which match the declared
8967
- # parameters in the Automation document.
9213
+ # parameters in the Automation runbook.
8968
9214
  #
8969
9215
  # @option params [String] :client_token
8970
9216
  # User-provided idempotency token. The token must be unique, is case
@@ -8984,12 +9230,12 @@ module Aws::SSM
8984
9230
  #
8985
9231
  # @option params [Array<Hash>] :target_maps
8986
9232
  # A key-value mapping of document parameters to target resources. Both
8987
- # Targets and TargetMaps cannot be specified together.
9233
+ # Targets and TargetMaps can't be specified together.
8988
9234
  #
8989
9235
  # @option params [String] :max_concurrency
8990
9236
  # The maximum number of targets allowed to run this task in parallel.
8991
9237
  # You can specify a number, such as 10, or a percentage, such as 10%.
8992
- # The default value is 10.
9238
+ # The default value is `10`.
8993
9239
  #
8994
9240
  # @option params [String] :max_errors
8995
9241
  # The number of errors that are allowed before the system stops running
@@ -9010,11 +9256,13 @@ module Aws::SSM
9010
9256
  # executions proceed one at a time.
9011
9257
  #
9012
9258
  # @option params [Array<Types::TargetLocation>] :target_locations
9013
- # A location is a combination of AWS Regions and/or AWS accounts where
9014
- # you want to run the Automation. Use this action to start an Automation
9015
- # in multiple Regions and multiple accounts. For more information, see
9016
- # [Running Automation workflows in multiple AWS Regions and accounts][1]
9017
- # in the *AWS Systems Manager User Guide*.
9259
+ # A location is a combination of Amazon Web Services Regions and/or
9260
+ # Amazon Web Services accounts where you want to run the automation. Use
9261
+ # this operation to start an automation in multiple Amazon Web Services
9262
+ # Regions and multiple Amazon Web Services accounts. For more
9263
+ # information, see [Running Automation workflows in multiple Amazon Web
9264
+ # Services Regions and Amazon Web Services accounts][1] in the *Amazon
9265
+ # Web Services Systems Manager User Guide*.
9018
9266
  #
9019
9267
  #
9020
9268
  #
@@ -9026,14 +9274,14 @@ module Aws::SSM
9026
9274
  # a resource in different ways, such as by purpose, owner, or
9027
9275
  # environment. For example, you might want to tag an automation to
9028
9276
  # identify an environment or operating system. In this case, you could
9029
- # specify the following key name/value pairs:
9277
+ # specify the following key-value pairs:
9030
9278
  #
9031
9279
  # * `Key=environment,Value=test`
9032
9280
  #
9033
9281
  # * `Key=OS,Value=Windows`
9034
9282
  #
9035
9283
  # <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
9036
- # action.
9284
+ # operation.
9037
9285
  #
9038
9286
  # </note>
9039
9287
  #
@@ -9095,9 +9343,9 @@ module Aws::SSM
9095
9343
  req.send_request(options)
9096
9344
  end
9097
9345
 
9098
- # Creates a change request for Change Manager. The runbooks (Automation
9099
- # documents) specified in the change request run only after all required
9100
- # approvals for the change request have been received.
9346
+ # Creates a change request for Change Manager. The Automation runbooks
9347
+ # specified in the change request run only after all required approvals
9348
+ # for the change request have been received.
9101
9349
  #
9102
9350
  # @option params [Time,DateTime,Date,Integer,String] :scheduled_time
9103
9351
  # The date and time specified in the change request to run the
@@ -9130,8 +9378,8 @@ module Aws::SSM
9130
9378
  # insensitive, enforces the UUID format, and can't be reused.
9131
9379
  #
9132
9380
  # @option params [required, Array<Types::Runbook>] :runbooks
9133
- # Information about the Automation runbooks (Automation documents) that
9134
- # are run during the runbook workflow.
9381
+ # Information about the Automation runbooks that are run during the
9382
+ # runbook workflow.
9135
9383
  #
9136
9384
  # <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
9137
9385
  # until all required approvals for the change request have been
@@ -9144,8 +9392,8 @@ module Aws::SSM
9144
9392
  # maximum of five tags for a change request. Tags enable you to
9145
9393
  # categorize a resource in different ways, such as by purpose, owner, or
9146
9394
  # environment. For example, you might want to tag a change request to
9147
- # identify an environment or target AWS Region. In this case, you could
9148
- # specify the following key-value pairs:
9395
+ # identify an environment or target Amazon Web Services Region. In this
9396
+ # case, you could specify the following key-value pairs:
9149
9397
  #
9150
9398
  # * `Key=Environment,Value=Production`
9151
9399
  #
@@ -9230,13 +9478,15 @@ module Aws::SSM
9230
9478
  # Session Manager session. Returns a URL and token that can be used to
9231
9479
  # open a WebSocket connection for sending input and receiving outputs.
9232
9480
  #
9233
- # <note markdown="1"> AWS CLI usage: `start-session` is an interactive command that requires
9234
- # the Session Manager plugin to be installed on the client machine
9235
- # making the call. For information, see [Install the Session Manager
9236
- # plugin for the AWS CLI][1] in the *AWS Systems Manager User Guide*.
9481
+ # <note markdown="1"> Amazon Web Services CLI usage: `start-session` is an interactive
9482
+ # command that requires the Session Manager plugin to be installed on
9483
+ # the client machine making the call. For information, see [Install the
9484
+ # Session Manager plugin for the Amazon Web Services CLI][1] in the
9485
+ # *Amazon Web Services Systems Manager User Guide*.
9237
9486
  #
9238
- # AWS Tools for PowerShell usage: Start-SSMSession is not currently
9239
- # supported by AWS Tools for PowerShell on Windows local machines.
9487
+ # Amazon Web Services Tools for PowerShell usage: Start-SSMSession
9488
+ # isn't currently supported by Amazon Web Services Tools for PowerShell
9489
+ # on Windows local machines.
9240
9490
  #
9241
9491
  # </note>
9242
9492
  #
@@ -9317,7 +9567,7 @@ module Aws::SSM
9317
9567
 
9318
9568
  # Permanently ends a session and closes the data connection between the
9319
9569
  # Session Manager client and SSM Agent on the instance. A terminated
9320
- # session cannot be resumed.
9570
+ # session isn't be resumed.
9321
9571
  #
9322
9572
  # @option params [required, String] :session_id
9323
9573
  # The ID of the session to terminate.
@@ -9348,11 +9598,12 @@ module Aws::SSM
9348
9598
  # Remove a label or labels from a parameter.
9349
9599
  #
9350
9600
  # @option params [required, String] :name
9351
- # The parameter name of which you want to delete one or more labels.
9601
+ # The name of the parameter from which you want to delete one or more
9602
+ # labels.
9352
9603
  #
9353
9604
  # @option params [required, Integer] :parameter_version
9354
9605
  # The specific version of the parameter which you want to delete one or
9355
- # more labels from. If it is not present, the call will fail.
9606
+ # more labels from. If it isn't present, the call will fail.
9356
9607
  #
9357
9608
  # @option params [required, Array<String>] :labels
9358
9609
  # One or more labels to delete from the specified parameter version.
@@ -9387,16 +9638,17 @@ module Aws::SSM
9387
9638
  end
9388
9639
 
9389
9640
  # Updates an association. You can update the association name and
9390
- # version, the document version, schedule, parameters, and Amazon S3
9391
- # output.
9392
- #
9393
- # In order to call this API action, your IAM user account, group, or
9394
- # role must be configured with permission to call the
9395
- # DescribeAssociation API action. If you don't have permission to call
9396
- # DescribeAssociation, then you receive the following error: `An error
9397
- # occurred (AccessDeniedException) when calling the UpdateAssociation
9398
- # operation: User: <user_arn> is not authorized to perform:
9399
- # ssm:DescribeAssociation on resource: <resource_arn>`
9641
+ # version, the document version, schedule, parameters, and Amazon Simple
9642
+ # Storage Service (Amazon S3) output.
9643
+ #
9644
+ # In order to call this API operation, your Identity and Access
9645
+ # Management (IAM) user account, group, or role must be configured with
9646
+ # permission to call the DescribeAssociation API operation. If you
9647
+ # don't have permission to call `DescribeAssociation`, then you receive
9648
+ # the following error: `An error occurred (AccessDeniedException) when
9649
+ # calling the UpdateAssociation operation: User: <user_arn> isn't
9650
+ # authorized to perform: ssm:DescribeAssociation on resource:
9651
+ # <resource_arn>`
9400
9652
  #
9401
9653
  # When you update an association, the association immediately runs
9402
9654
  # against the specified targets.
@@ -9406,8 +9658,9 @@ module Aws::SSM
9406
9658
  #
9407
9659
  # @option params [Hash<String,Array>] :parameters
9408
9660
  # The parameters you want to update for the association. If you create a
9409
- # parameter using Parameter Store, you can reference the parameter using
9410
- # \\\{\\\{ssm:parameter-name\\}\\}
9661
+ # parameter using Parameter Store, a capability of Amazon Web Services
9662
+ # Systems Manager, you can reference the parameter using
9663
+ # `\{\{ssm:parameter-name\}\}`.
9411
9664
  #
9412
9665
  # @option params [String] :document_version
9413
9666
  # The document version you want update for the association.
@@ -9420,16 +9673,16 @@ module Aws::SSM
9420
9673
  # An S3 bucket where you want to store the results of this request.
9421
9674
  #
9422
9675
  # @option params [String] :name
9423
- # The name of the SSM document that contains the configuration
9424
- # information for the instance. You can specify Command or Automation
9425
- # documents.
9676
+ # The name of the SSM Command document or Automation runbook that
9677
+ # contains the configuration information for the instance.
9426
9678
  #
9427
- # You can specify AWS-predefined documents, documents you created, or a
9428
- # document that is shared with you from another account.
9679
+ # You can specify Amazon Web Services-predefined documents, documents
9680
+ # you created, or a document that is shared with you from another
9681
+ # account.
9429
9682
  #
9430
- # For SSM documents that are shared with you from other AWS accounts,
9431
- # you must specify the complete SSM document ARN, in the following
9432
- # format:
9683
+ # For Systems Manager document (SSM document) that are shared with you
9684
+ # from other Amazon Web Services accounts, you must specify the complete
9685
+ # SSM document ARN, in the following format:
9433
9686
  #
9434
9687
  # `arn:aws:ssm:region:account-id:document/document-name `
9435
9688
  #
@@ -9437,9 +9690,9 @@ module Aws::SSM
9437
9690
  #
9438
9691
  # `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
9439
9692
  #
9440
- # For AWS-predefined documents and SSM documents you created in your
9441
- # account, you only need to specify the document name. For example,
9442
- # `AWS-ApplyPatchBaseline` or `My-Document`.
9693
+ # For Amazon Web Services-predefined documents and SSM documents you
9694
+ # created in your account, you only need to specify the document name.
9695
+ # For example, `AWS-ApplyPatchBaseline` or `My-Document`.
9443
9696
  #
9444
9697
  # @option params [Array<Types::Target>] :targets
9445
9698
  # The targets of the association.
@@ -9455,8 +9708,9 @@ module Aws::SSM
9455
9708
  #
9456
9709
  # @option params [String] :automation_target_parameter_name
9457
9710
  # Specify the target for the association. This target is required for
9458
- # associations that use an Automation document and target resources by
9459
- # using rate controls.
9711
+ # associations that use an Automation runbook and target resources by
9712
+ # using rate controls. Automation is a capability of Amazon Web Services
9713
+ # Systems Manager.
9460
9714
  #
9461
9715
  # @option params [String] :max_errors
9462
9716
  # The number of errors that are allowed before the system stops sending
@@ -9466,13 +9720,13 @@ module Aws::SSM
9466
9720
  # system stops sending requests when the fourth error is received. If
9467
9721
  # you specify 0, then the system stops sending requests after the first
9468
9722
  # error is returned. If you run an association on 50 instances and set
9469
- # MaxError to 10%, then the system stops sending the request when the
9723
+ # `MaxError` to 10%, then the system stops sending the request when the
9470
9724
  # sixth error is received.
9471
9725
  #
9472
- # Executions that are already running an association when MaxErrors is
9726
+ # Executions that are already running an association when `MaxErrors` is
9473
9727
  # reached are allowed to complete, but some of these executions may fail
9474
9728
  # as well. If you need to ensure that there won't be more than
9475
- # max-errors failed executions, set MaxConcurrency to 1 so that
9729
+ # max-errors failed executions, set `MaxConcurrency` to 1 so that
9476
9730
  # executions proceed one at a time.
9477
9731
  #
9478
9732
  # @option params [String] :max_concurrency
@@ -9482,10 +9736,10 @@ module Aws::SSM
9482
9736
  # means all targets run the association at the same time.
9483
9737
  #
9484
9738
  # If a new instance starts and attempts to run an association while
9485
- # Systems Manager is running MaxConcurrency associations, the
9739
+ # Systems Manager is running `MaxConcurrency` associations, the
9486
9740
  # association is allowed to run. During the next association interval,
9487
9741
  # the new instance will process its association within the limit
9488
- # specified for MaxConcurrency.
9742
+ # specified for `MaxConcurrency`.
9489
9743
  #
9490
9744
  # @option params [String] :compliance_severity
9491
9745
  # The severity level to assign to the association.
@@ -9499,9 +9753,10 @@ module Aws::SSM
9499
9753
  # the association is `NON-COMPLIANT`.
9500
9754
  #
9501
9755
  # In `MANUAL` mode, you must specify the `AssociationId` as a parameter
9502
- # for the PutComplianceItems API action. In this case, compliance data
9503
- # is not managed by State Manager. It is managed by your direct call to
9504
- # the PutComplianceItems API action.
9756
+ # for the PutComplianceItems API operation. In this case, compliance
9757
+ # data isn't managed by State Manager, a capability of Amazon Web
9758
+ # Services Systems Manager. It is managed by your direct call to the
9759
+ # PutComplianceItems API operation.
9505
9760
  #
9506
9761
  # By default, all associations use `AUTO` mode.
9507
9762
  #
@@ -9509,7 +9764,7 @@ module Aws::SSM
9509
9764
  # By default, when you update an association, the system runs it
9510
9765
  # immediately after it is updated and then according to the schedule you
9511
9766
  # specified. Specify this option if you don't want an association to
9512
- # run immediately after you update it. This parameter is not supported
9767
+ # run immediately after you update it. This parameter isn't supported
9513
9768
  # for rate expressions.
9514
9769
  #
9515
9770
  # Also, if you specified this option when you created the association,
@@ -9520,19 +9775,20 @@ module Aws::SSM
9520
9775
  # interval specified.
9521
9776
  #
9522
9777
  # @option params [Array<String>] :calendar_names
9523
- # The names or Amazon Resource Names (ARNs) of the Systems Manager
9524
- # Change Calendar type documents you want to gate your associations
9525
- # under. The associations only run when that Change Calendar is open.
9526
- # For more information, see [AWS Systems Manager Change Calendar][1].
9778
+ # The names or Amazon Resource Names (ARNs) of the Change Calendar type
9779
+ # documents you want to gate your associations under. The associations
9780
+ # only run when that change calendar is open. For more information, see
9781
+ # [Amazon Web Services Systems Manager Change Calendar][1].
9527
9782
  #
9528
9783
  #
9529
9784
  #
9530
9785
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
9531
9786
  #
9532
9787
  # @option params [Array<Types::TargetLocation>] :target_locations
9533
- # A location is a combination of AWS Regions and AWS accounts where you
9534
- # want to run the association. Use this action to update an association
9535
- # in multiple Regions and multiple accounts.
9788
+ # A location is a combination of Amazon Web Services Regions and Amazon
9789
+ # Web Services accounts where you want to run the association. Use this
9790
+ # action to update an association in multiple Regions and multiple
9791
+ # accounts.
9536
9792
  #
9537
9793
  # @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9538
9794
  #
@@ -9638,14 +9894,19 @@ module Aws::SSM
9638
9894
  req.send_request(options)
9639
9895
  end
9640
9896
 
9641
- # Updates the status of the Systems Manager document associated with the
9642
- # specified instance.
9897
+ # Updates the status of the Amazon Web Services Systems Manager document
9898
+ # (SSM document) associated with the specified instance.
9899
+ #
9900
+ # `UpdateAssociationStatus` is primarily used by the Amazon Web Services
9901
+ # Systems Manager Agent (SSM Agent) to report status updates about your
9902
+ # associations and is only used for associations created with the
9903
+ # `InstanceId` legacy parameter.
9643
9904
  #
9644
9905
  # @option params [required, String] :name
9645
- # The name of the Systems Manager document.
9906
+ # The name of the SSM document.
9646
9907
  #
9647
9908
  # @option params [required, String] :instance_id
9648
- # The ID of the instance.
9909
+ # The instance ID.
9649
9910
  #
9650
9911
  # @option params [required, Types::AssociationStatus] :association_status
9651
9912
  # The association status.
@@ -9730,22 +9991,22 @@ module Aws::SSM
9730
9991
  # A valid JSON or YAML string.
9731
9992
  #
9732
9993
  # @option params [Array<Types::AttachmentsSource>] :attachments
9733
- # A list of key and value pairs that describe attachments to a version
9734
- # of a document.
9994
+ # A list of key-value pairs that describe attachments to a version of a
9995
+ # document.
9735
9996
  #
9736
9997
  # @option params [required, String] :name
9737
- # The name of the Systems Manager document that you want to update.
9998
+ # The name of the SSM document that you want to update.
9738
9999
  #
9739
10000
  # @option params [String] :display_name
9740
- # The friendly name of the Systems Manager document that you want to
9741
- # update. This value can differ for each version of the document. If you
9742
- # do not specify a value for this parameter in your request, the
9743
- # existing value is applied to the new document version.
10001
+ # The friendly name of the SSM document that you want to update. This
10002
+ # value can differ for each version of the document. If you don't
10003
+ # specify a value for this parameter in your request, the existing value
10004
+ # is applied to the new document version.
9744
10005
  #
9745
10006
  # @option params [String] :version_name
9746
10007
  # An optional field specifying the version of the artifact you are
9747
10008
  # updating with the document. For example, "Release 12, Update 6".
9748
- # This value is unique across all versions of a document, and cannot be
10009
+ # This value is unique across all versions of a document, and can't be
9749
10010
  # changed.
9750
10011
  #
9751
10012
  # @option params [String] :document_version
@@ -9874,16 +10135,17 @@ module Aws::SSM
9874
10135
  end
9875
10136
 
9876
10137
  # Updates information related to approval reviews for a specific version
9877
- # of a document.
10138
+ # of a change template in Change Manager.
9878
10139
  #
9879
10140
  # @option params [required, String] :name
9880
- # The name of the document for which a version is to be updated.
10141
+ # The name of the change template for which a version's metadata is to
10142
+ # be updated.
9881
10143
  #
9882
10144
  # @option params [String] :document_version
9883
- # The version of a document to update.
10145
+ # The version of a change template in which to update approval metadata.
9884
10146
  #
9885
10147
  # @option params [required, Types::DocumentReviews] :document_reviews
9886
- # The document review details to update.
10148
+ # The change template review details to update.
9887
10149
  #
9888
10150
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
9889
10151
  #
@@ -9946,7 +10208,7 @@ module Aws::SSM
9946
10208
  #
9947
10209
  # @option params [String] :end_date
9948
10210
  # The date and time, in ISO-8601 Extended format, for when you want the
9949
- # maintenance window to become inactive. EndDate allows you to set a
10211
+ # maintenance window to become inactive. `EndDate` allows you to set a
9950
10212
  # date and time in the future when the maintenance window will no longer
9951
10213
  # run.
9952
10214
  #
@@ -9965,7 +10227,7 @@ module Aws::SSM
9965
10227
  # [1]: https://www.iana.org/time-zones
9966
10228
  #
9967
10229
  # @option params [Integer] :schedule_offset
9968
- # The number of days to wait after the date and time specified by a CRON
10230
+ # The number of days to wait after the date and time specified by a cron
9969
10231
  # expression before running the maintenance window.
9970
10232
  #
9971
10233
  # For example, the following cron expression schedules a maintenance
@@ -9981,7 +10243,8 @@ module Aws::SSM
9981
10243
  #
9982
10244
  # @option params [Integer] :cutoff
9983
10245
  # The number of hours before the end of the maintenance window that
9984
- # Systems Manager stops scheduling new tasks for execution.
10246
+ # Amazon Web Services Systems Manager stops scheduling new tasks for
10247
+ # execution.
9985
10248
  #
9986
10249
  # @option params [Boolean] :allow_unassociated_targets
9987
10250
  # Whether targets must be registered with the maintenance window before
@@ -9991,9 +10254,9 @@ module Aws::SSM
9991
10254
  # Whether the maintenance window is enabled.
9992
10255
  #
9993
10256
  # @option params [Boolean] :replace
9994
- # If True, then all fields that are required by the
9995
- # CreateMaintenanceWindow action are also required for this API request.
9996
- # Optional fields that are not specified are set to null.
10257
+ # If `True`, then all fields that are required by the
10258
+ # CreateMaintenanceWindow operation are also required for this API
10259
+ # request. Optional fields that aren't specified are set to null.
9997
10260
  #
9998
10261
  # @return [Types::UpdateMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9999
10262
  #
@@ -10069,7 +10332,7 @@ module Aws::SSM
10069
10332
  # types are ID target, Tag target, and resource group. For more
10070
10333
  # information, see Target.
10071
10334
  #
10072
- # <note markdown="1"> If a parameter is null, then the corresponding field is not modified.
10335
+ # <note markdown="1"> If a parameter is null, then the corresponding field isn't modified.
10073
10336
  #
10074
10337
  # </note>
10075
10338
  #
@@ -10083,9 +10346,9 @@ module Aws::SSM
10083
10346
  # The targets to add or replace.
10084
10347
  #
10085
10348
  # @option params [String] :owner_information
10086
- # User-provided value that will be included in any CloudWatch events
10087
- # raised while running tasks for these targets in this maintenance
10088
- # window.
10349
+ # User-provided value that will be included in any Amazon CloudWatch
10350
+ # Events events raised while running tasks for these targets in this
10351
+ # maintenance window.
10089
10352
  #
10090
10353
  # @option params [String] :name
10091
10354
  # A name for the update.
@@ -10094,9 +10357,10 @@ module Aws::SSM
10094
10357
  # An optional description for the update.
10095
10358
  #
10096
10359
  # @option params [Boolean] :replace
10097
- # If True, then all fields that are required by the
10098
- # RegisterTargetWithMaintenanceWindow action are also required for this
10099
- # API request. Optional fields that are not specified are set to null.
10360
+ # If `True`, then all fields that are required by the
10361
+ # RegisterTargetWithMaintenanceWindow operation are also required for
10362
+ # this API request. Optional fields that aren't specified are set to
10363
+ # null.
10100
10364
  #
10101
10365
  # @return [Types::UpdateMaintenanceWindowTargetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
10102
10366
  #
@@ -10148,38 +10412,38 @@ module Aws::SSM
10148
10412
  # Modifies a task assigned to a maintenance window. You can't change
10149
10413
  # the task type, but you can change the following values:
10150
10414
  #
10151
- # * TaskARN. For example, you can change a RUN\_COMMAND task from
10152
- # AWS-RunPowerShellScript to AWS-RunShellScript.
10415
+ # * `TaskARN`. For example, you can change a `RUN_COMMAND` task from
10416
+ # `AWS-RunPowerShellScript` to `AWS-RunShellScript`.
10153
10417
  #
10154
- # * ServiceRoleArn
10418
+ # * `ServiceRoleArn`
10155
10419
  #
10156
- # * TaskInvocationParameters
10420
+ # * `TaskInvocationParameters`
10157
10421
  #
10158
- # * Priority
10422
+ # * `Priority`
10159
10423
  #
10160
- # * MaxConcurrency
10424
+ # * `MaxConcurrency`
10161
10425
  #
10162
- # * MaxErrors
10426
+ # * `MaxErrors`
10163
10427
  #
10164
10428
  # <note markdown="1"> One or more targets must be specified for maintenance window Run
10165
10429
  # Command-type tasks. Depending on the task, targets are optional for
10166
- # other maintenance window task types (Automation, AWS Lambda, and AWS
10167
- # Step Functions). For more information about running tasks that do not
10430
+ # other maintenance window task types (Automation, Lambda, and Step
10431
+ # Functions). For more information about running tasks that don't
10168
10432
  # specify targets, see [Registering maintenance window tasks without
10169
- # targets][1] in the *AWS Systems Manager User Guide*.
10433
+ # targets][1] in the *Amazon Web Services Systems Manager User Guide*.
10170
10434
  #
10171
10435
  # </note>
10172
10436
  #
10173
10437
  # If the value for a parameter in `UpdateMaintenanceWindowTask` is null,
10174
- # then the corresponding field is not modified. If you set `Replace` to
10438
+ # then the corresponding field isn't modified. If you set `Replace` to
10175
10439
  # true, then all fields required by the
10176
- # RegisterTaskWithMaintenanceWindow action are required for this
10440
+ # RegisterTaskWithMaintenanceWindow operation are required for this
10177
10441
  # request. Optional fields that aren't specified are set to null.
10178
10442
  #
10179
10443
  # When you update a maintenance window task that has options specified
10180
10444
  # in `TaskInvocationParameters`, you must provide again all the
10181
10445
  # `TaskInvocationParameters` values that you want to retain. The values
10182
- # you do not specify again are removed. For example, suppose that when
10446
+ # you don't specify again are removed. For example, suppose that when
10183
10447
  # you registered a Run Command task, you specified
10184
10448
  # `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
10185
10449
  # and `OutputS3BucketName`. If you update the maintenance window task
@@ -10198,15 +10462,16 @@ module Aws::SSM
10198
10462
  #
10199
10463
  # @option params [Array<Types::Target>] :targets
10200
10464
  # The targets (either instances or tags) to modify. Instances are
10201
- # specified using Key=instanceids,Values=instanceID\_1,instanceID\_2.
10202
- # Tags are specified using Key=tag\_name,Values=tag\_value.
10465
+ # specified using the format
10466
+ # `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified
10467
+ # using the format ` Key=tag_name,Values=tag_value`.
10203
10468
  #
10204
10469
  # <note markdown="1"> One or more targets must be specified for maintenance window Run
10205
10470
  # Command-type tasks. Depending on the task, targets are optional for
10206
- # other maintenance window task types (Automation, AWS Lambda, and AWS
10207
- # Step Functions). For more information about running tasks that do not
10471
+ # other maintenance window task types (Automation, Lambda, and Step
10472
+ # Functions). For more information about running tasks that don't
10208
10473
  # specify targets, see [Registering maintenance window tasks without
10209
- # targets][1] in the *AWS Systems Manager User Guide*.
10474
+ # targets][1] in the *Amazon Web Services Systems Manager User Guide*.
10210
10475
  #
10211
10476
  # </note>
10212
10477
  #
@@ -10218,14 +10483,15 @@ module Aws::SSM
10218
10483
  # The task ARN to modify.
10219
10484
  #
10220
10485
  # @option params [String] :service_role_arn
10221
- # The ARN of the IAM service role for Systems Manager to assume when
10222
- # running a maintenance window task. If you do not specify a service
10223
- # role ARN, Systems Manager uses your account's service-linked role. If
10224
- # no service-linked role for Systems Manager exists in your account, it
10225
- # is created when you run `RegisterTaskWithMaintenanceWindow`.
10486
+ # The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
10487
+ # Services Systems Manager to assume when running a maintenance window
10488
+ # task. If you do not specify a service role ARN, Systems Manager uses
10489
+ # your account's service-linked role. If no service-linked role for
10490
+ # Systems Manager exists in your account, it is created when you run
10491
+ # `RegisterTaskWithMaintenanceWindow`.
10226
10492
  #
10227
- # For more information, see the following topics in the in the *AWS
10228
- # Systems Manager User Guide*\:
10493
+ # For more information, see the following topics in the in the *Amazon
10494
+ # Web Services Systems Manager User Guide*\:
10229
10495
  #
10230
10496
  # * [Using service-linked roles for Systems Manager][1]
10231
10497
  #
@@ -10263,7 +10529,7 @@ module Aws::SSM
10263
10529
  # When you update a maintenance window task that has options specified
10264
10530
  # in `TaskInvocationParameters`, you must provide again all the
10265
10531
  # `TaskInvocationParameters` values that you want to retain. The values
10266
- # you do not specify again are removed. For example, suppose that when
10532
+ # you don't specify again are removed. For example, suppose that when
10267
10533
  # you registered a Run Command task, you specified
10268
10534
  # `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
10269
10535
  # and `OutputS3BucketName`. If you update the maintenance window task
@@ -10279,10 +10545,10 @@ module Aws::SSM
10279
10545
  # is the number of targets that are allowed to run this task in
10280
10546
  # parallel.
10281
10547
  #
10282
- # <note markdown="1"> For maintenance window tasks without a target specified, you cannot
10548
+ # <note markdown="1"> For maintenance window tasks without a target specified, you can't
10283
10549
  # supply a value for this option. Instead, the system inserts a
10284
10550
  # placeholder value of `1`, which may be reported in the response to
10285
- # this command. This value does not affect the running of your task and
10551
+ # this command. This value doesn't affect the running of your task and
10286
10552
  # can be ignored.
10287
10553
  #
10288
10554
  # </note>
@@ -10292,10 +10558,10 @@ module Aws::SSM
10292
10558
  # number of errors that are allowed before the task stops being
10293
10559
  # scheduled.
10294
10560
  #
10295
- # <note markdown="1"> For maintenance window tasks without a target specified, you cannot
10561
+ # <note markdown="1"> For maintenance window tasks without a target specified, you can't
10296
10562
  # supply a value for this option. Instead, the system inserts a
10297
10563
  # placeholder value of `1`, which may be reported in the response to
10298
- # this command. This value does not affect the running of your task and
10564
+ # this command. This value doesn't affect the running of your task and
10299
10565
  # can be ignored.
10300
10566
  #
10301
10567
  # </note>
@@ -10303,10 +10569,11 @@ module Aws::SSM
10303
10569
  # @option params [Types::LoggingInfo] :logging_info
10304
10570
  # The new logging location in Amazon S3 to specify.
10305
10571
  #
10306
- # <note markdown="1"> `LoggingInfo` has been deprecated. To specify an S3 bucket to contain
10307
- # logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
10308
- # options in the `TaskInvocationParameters` structure. For information
10309
- # about how Systems Manager handles these options for the supported
10572
+ # <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
10573
+ # Service (Amazon S3) bucket to contain logs, instead use the
10574
+ # `OutputS3BucketName` and `OutputS3KeyPrefix` options in the
10575
+ # `TaskInvocationParameters` structure. For information about how Amazon
10576
+ # Web Services Systems Manager handles these options for the supported
10310
10577
  # maintenance window task types, see
10311
10578
  # MaintenanceWindowTaskInvocationParameters.
10312
10579
  #
@@ -10320,8 +10587,8 @@ module Aws::SSM
10320
10587
  #
10321
10588
  # @option params [Boolean] :replace
10322
10589
  # If True, then all fields that are required by the
10323
- # RegisterTaskWithMaintenanceWindow action are also required for this
10324
- # API request. Optional fields that are not specified are set to null.
10590
+ # RegisterTaskWithMaintenanceWindow operation are also required for this
10591
+ # API request. Optional fields that aren't specified are set to null.
10325
10592
  #
10326
10593
  # @return [Types::UpdateMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
10327
10594
  #
@@ -10466,10 +10733,10 @@ module Aws::SSM
10466
10733
  req.send_request(options)
10467
10734
  end
10468
10735
 
10469
- # Changes the Amazon Identity and Access Management (IAM) role that is
10470
- # assigned to the on-premises instance or virtual machines (VM). IAM
10471
- # roles are first assigned to these hybrid instances during the
10472
- # activation process. For more information, see CreateActivation.
10736
+ # Changes the Identity and Access Management (IAM) role that is assigned
10737
+ # to the on-premises instance or virtual machines (VM). IAM roles are
10738
+ # first assigned to these hybrid instances during the activation
10739
+ # process. For more information, see CreateActivation.
10473
10740
  #
10474
10741
  # @option params [required, String] :instance_id
10475
10742
  # The ID of the managed instance where you want to update the role.
@@ -10495,16 +10762,17 @@ module Aws::SSM
10495
10762
  req.send_request(options)
10496
10763
  end
10497
10764
 
10498
- # Edit or change an OpsItem. You must have permission in AWS Identity
10499
- # and Access Management (IAM) to update an OpsItem. For more
10500
- # information, see [Getting started with OpsCenter][1] in the *AWS
10765
+ # Edit or change an OpsItem. You must have permission in Identity and
10766
+ # Access Management (IAM) to update an OpsItem. For more information,
10767
+ # see [Getting started with OpsCenter][1] in the *Amazon Web Services
10501
10768
  # Systems Manager User Guide*.
10502
10769
  #
10503
- # Operations engineers and IT professionals use OpsCenter to view,
10504
- # investigate, and remediate operational issues impacting the
10505
- # performance and health of their AWS resources. For more information,
10506
- # see [AWS Systems Manager OpsCenter][2] in the *AWS Systems Manager
10507
- # User Guide*.
10770
+ # Operations engineers and IT professionals use Amazon Web Services
10771
+ # Systems Manager OpsCenter to view, investigate, and remediate
10772
+ # operational issues impacting the performance and health of their
10773
+ # Amazon Web Services resources. For more information, see
10774
+ # [OpsCenter][2] in the *Amazon Web Services Systems Manager User
10775
+ # Guide*.
10508
10776
  #
10509
10777
  #
10510
10778
  #
@@ -10526,22 +10794,23 @@ module Aws::SSM
10526
10794
  # You enter operational data as key-value pairs. The key has a maximum
10527
10795
  # length of 128 characters. The value has a maximum size of 20 KB.
10528
10796
  #
10529
- # Operational data keys *can't* begin with the following: amazon, aws,
10530
- # amzn, ssm, /amazon, /aws, /amzn, /ssm.
10797
+ # Operational data keys *can't* begin with the following: `amazon`,
10798
+ # `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
10531
10799
  #
10532
10800
  # You can choose to make the data searchable by other users in the
10533
10801
  # account or you can restrict search access. Searchable data means that
10534
10802
  # all users with access to the OpsItem Overview page (as provided by the
10535
- # DescribeOpsItems API action) can view and search on the specified
10536
- # data. Operational data that is not searchable is only viewable by
10803
+ # DescribeOpsItems API operation) can view and search on the specified
10804
+ # data. Operational data that isn't searchable is only viewable by
10537
10805
  # users who have access to the OpsItem (as provided by the GetOpsItem
10538
- # API action).
10806
+ # API operation).
10539
10807
  #
10540
10808
  # Use the `/aws/resources` key in OperationalData to specify a related
10541
10809
  # resource in the request. Use the `/aws/automations` key in
10542
10810
  # OperationalData to associate an Automation runbook with the OpsItem.
10543
- # To view AWS CLI example commands that use these keys, see [Creating
10544
- # OpsItems manually][1] in the *AWS Systems Manager User Guide*.
10811
+ # To view Amazon Web Services CLI example commands that use these keys,
10812
+ # see [Creating OpsItems manually][1] in the *Amazon Web Services
10813
+ # Systems Manager User Guide*.
10545
10814
  #
10546
10815
  #
10547
10816
  #
@@ -10567,7 +10836,7 @@ module Aws::SSM
10567
10836
  # @option params [String] :status
10568
10837
  # The OpsItem status. Status can be `Open`, `In Progress`, or
10569
10838
  # `Resolved`. For more information, see [Editing OpsItem details][1] in
10570
- # the *AWS Systems Manager User Guide*.
10839
+ # the *Amazon Web Services Systems Manager User Guide*.
10571
10840
  #
10572
10841
  #
10573
10842
  #
@@ -10627,7 +10896,7 @@ module Aws::SSM
10627
10896
  # ops_item_id: "String", # required
10628
10897
  # },
10629
10898
  # ],
10630
- # status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
10899
+ # status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected, Closed
10631
10900
  # ops_item_id: "OpsItemId", # required
10632
10901
  # title: "OpsItemTitle",
10633
10902
  # category: "OpsItemCategory",
@@ -10647,8 +10916,8 @@ module Aws::SSM
10647
10916
  req.send_request(options)
10648
10917
  end
10649
10918
 
10650
- # Systems Manager calls this API action when you edit OpsMetadata in
10651
- # Application Manager.
10919
+ # Amazon Web Services Systems Manager calls this API operation when you
10920
+ # edit OpsMetadata in Application Manager.
10652
10921
  #
10653
10922
  # @option params [required, String] :ops_metadata_arn
10654
10923
  # The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
@@ -10691,15 +10960,11 @@ module Aws::SSM
10691
10960
  # Modifies an existing patch baseline. Fields not specified in the
10692
10961
  # request are left unchanged.
10693
10962
  #
10694
- # <note markdown="1"> For information about valid key and value pairs in `PatchFilters` for
10695
- # each supported operating system type, see [PatchFilter][1].
10963
+ # <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
10964
+ # supported operating system type, see PatchFilter.
10696
10965
  #
10697
10966
  # </note>
10698
10967
  #
10699
- #
10700
- #
10701
- # [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
10702
- #
10703
10968
  # @option params [required, String] :baseline_id
10704
10969
  # The ID of the patch baseline to update.
10705
10970
  #
@@ -10717,7 +10982,8 @@ module Aws::SSM
10717
10982
  #
10718
10983
  # For information about accepted formats for lists of approved patches
10719
10984
  # and rejected patches, see [About package name formats for approved and
10720
- # rejected patch lists][1] in the *AWS Systems Manager User Guide*.
10985
+ # rejected patch lists][1] in the *Amazon Web Services Systems Manager
10986
+ # User Guide*.
10721
10987
  #
10722
10988
  #
10723
10989
  #
@@ -10729,14 +10995,15 @@ module Aws::SSM
10729
10995
  # @option params [Boolean] :approved_patches_enable_non_security
10730
10996
  # Indicates whether the list of approved patches includes non-security
10731
10997
  # updates that should be applied to the instances. The default value is
10732
- # 'false'. Applies to Linux instances only.
10998
+ # `false`. Applies to Linux instances only.
10733
10999
  #
10734
11000
  # @option params [Array<String>] :rejected_patches
10735
11001
  # A list of explicitly rejected patches for the baseline.
10736
11002
  #
10737
11003
  # For information about accepted formats for lists of approved patches
10738
11004
  # and rejected patches, see [About package name formats for approved and
10739
- # rejected patch lists][1] in the *AWS Systems Manager User Guide*.
11005
+ # rejected patch lists][1] in the *Amazon Web Services Systems Manager
11006
+ # User Guide*.
10740
11007
  #
10741
11008
  #
10742
11009
  #
@@ -10744,19 +11011,20 @@ module Aws::SSM
10744
11011
  #
10745
11012
  # @option params [String] :rejected_patches_action
10746
11013
  # The action for Patch Manager to take on patches included in the
10747
- # RejectedPackages list.
11014
+ # `RejectedPackages` list.
10748
11015
  #
10749
- # * **ALLOW\_AS\_DEPENDENCY**\: A package in the Rejected patches list
10750
- # is installed only if it is a dependency of another package. It is
10751
- # considered compliant with the patch baseline, and its status is
10752
- # reported as *InstalledOther*. This is the default action if no
10753
- # option is specified.
11016
+ # * <b> <code>ALLOW_AS_DEPENDENCY</code> </b>\: A package in the
11017
+ # `Rejected` patches list is installed only if it is a dependency of
11018
+ # another package. It is considered compliant with the patch baseline,
11019
+ # and its status is reported as `InstalledOther`. This is the default
11020
+ # action if no option is specified.
10754
11021
  #
10755
- # * **BLOCK**\: Packages in the RejectedPatches list, and packages that
10756
- # include them as dependencies, are not installed under any
10757
- # circumstances. If a package was installed before it was added to the
10758
- # Rejected patches list, it is considered non-compliant with the patch
10759
- # baseline, and its status is reported as *InstalledRejected*.
11022
+ # * <b> <code>BLOCK</code> </b>\: Packages in the `RejectedPatches`
11023
+ # list, and packages that include them as dependencies, aren't
11024
+ # installed under any circumstances. If a package was installed before
11025
+ # it was added to the `Rejected` patches list, it is considered
11026
+ # non-compliant with the patch baseline, and its status is reported as
11027
+ # `InstalledRejected`.
10760
11028
  #
10761
11029
  # @option params [String] :description
10762
11030
  # A description of the patch baseline.
@@ -10768,8 +11036,8 @@ module Aws::SSM
10768
11036
  #
10769
11037
  # @option params [Boolean] :replace
10770
11038
  # If True, then all fields that are required by the CreatePatchBaseline
10771
- # action are also required for this API request. Optional fields that
10772
- # are not specified are set to null.
11039
+ # operation are also required for this API request. Optional fields that
11040
+ # aren't specified are set to null.
10773
11041
  #
10774
11042
  # @return [Types::UpdatePatchBaselineResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
10775
11043
  #
@@ -10881,12 +11149,12 @@ module Aws::SSM
10881
11149
  # Update a resource data sync. After you create a resource data sync for
10882
11150
  # a Region, you can't change the account options for that sync. For
10883
11151
  # example, if you create a sync in the us-east-2 (Ohio) Region and you
10884
- # choose the Include only the current account option, you can't edit
10885
- # that sync later and choose the Include all accounts from my AWS
10886
- # Organizations configuration option. Instead, you must delete the first
10887
- # resource data sync, and create a new one.
11152
+ # choose the `Include only the current account` option, you can't edit
11153
+ # that sync later and choose the `Include all accounts from my
11154
+ # Organizations configuration` option. Instead, you must delete the
11155
+ # first resource data sync, and create a new one.
10888
11156
  #
10889
- # <note markdown="1"> This API action only supports a resource data sync that was created
11157
+ # <note markdown="1"> This API operation only supports a resource data sync that was created
10890
11158
  # with a SyncFromSource `SyncType`.
10891
11159
  #
10892
11160
  # </note>
@@ -10933,21 +11201,22 @@ module Aws::SSM
10933
11201
  req.send_request(options)
10934
11202
  end
10935
11203
 
10936
- # `ServiceSetting` is an account-level setting for an AWS service. This
10937
- # setting defines how a user interacts with or uses a service or a
10938
- # feature of a service. For example, if an AWS service charges money to
10939
- # the account based on feature or service usage, then the AWS service
10940
- # team might create a default setting of "false". This means the user
10941
- # can't use this feature unless they change the setting to "true" and
10942
- # intentionally opt in for a paid feature.
11204
+ # `ServiceSetting` is an account-level setting for an Amazon Web
11205
+ # Services service. This setting defines how a user interacts with or
11206
+ # uses a service or a feature of a service. For example, if an Amazon
11207
+ # Web Services service charges money to the account based on feature or
11208
+ # service usage, then the Amazon Web Services service team might create
11209
+ # a default setting of "false". This means the user can't use this
11210
+ # feature unless they change the setting to "true" and intentionally
11211
+ # opt in for a paid feature.
10943
11212
  #
10944
- # Services map a `SettingId` object to a setting value. AWS services
10945
- # teams define the default value for a `SettingId`. You can't create a
10946
- # new `SettingId`, but you can overwrite the default value if you have
10947
- # the `ssm:UpdateServiceSetting` permission for the setting. Use the
10948
- # GetServiceSetting API action to view the current value. Or, use the
10949
- # ResetServiceSetting to change the value back to the original value
10950
- # defined by the AWS service team.
11213
+ # Services map a `SettingId` object to a setting value. Amazon Web
11214
+ # Services services teams define the default value for a `SettingId`.
11215
+ # You can't create a new `SettingId`, but you can overwrite the default
11216
+ # value if you have the `ssm:UpdateServiceSetting` permission for the
11217
+ # setting. Use the GetServiceSetting API operation to view the current
11218
+ # value. Or, use the ResetServiceSetting to change the value back to the
11219
+ # original value defined by the Amazon Web Services service team.
10951
11220
  #
10952
11221
  # Update the service setting for the account.
10953
11222
  #
@@ -10961,6 +11230,8 @@ module Aws::SSM
10961
11230
  #
10962
11231
  # * `/ssm/automation/customer-script-log-group-name`
10963
11232
  #
11233
+ # * `/ssm/documents/console/public-sharing-permission`
11234
+ #
10964
11235
  # * `/ssm/parameter-store/default-parameter-tier`
10965
11236
  #
10966
11237
  # * `/ssm/parameter-store/high-throughput-enabled`
@@ -10983,10 +11254,14 @@ module Aws::SSM
10983
11254
  # can be true or false.
10984
11255
  #
10985
11256
  # For the `/ssm/automation/customer-script-log-destination` setting ID,
10986
- # the setting value can be CloudWatch.
11257
+ # the setting value can be `CloudWatch`.
10987
11258
  #
10988
11259
  # For the `/ssm/automation/customer-script-log-group-name` setting ID,
10989
- # the setting value can be the name of a CloudWatch Logs log group.
11260
+ # the setting value can be the name of an Amazon CloudWatch Logs log
11261
+ # group.
11262
+ #
11263
+ # For the `/ssm/documents/console/public-sharing-permission` setting ID,
11264
+ # the setting value can be `Enable` or `Disable`.
10990
11265
  #
10991
11266
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
10992
11267
  #
@@ -11019,7 +11294,7 @@ module Aws::SSM
11019
11294
  params: params,
11020
11295
  config: config)
11021
11296
  context[:gem_name] = 'aws-sdk-ssm'
11022
- context[:gem_version] = '1.110.0'
11297
+ context[:gem_version] = '1.116.0'
11023
11298
  Seahorse::Client::Request.new(handlers, context)
11024
11299
  end
11025
11300