aws-sdk-ssm 1.109.0 → 1.113.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +1154 -768
- data/lib/aws-sdk-ssm/client_api.rb +126 -0
- data/lib/aws-sdk-ssm/errors.rb +42 -0
- data/lib/aws-sdk-ssm/types.rb +2032 -1405
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0d2adfd936e87f1e3b137eb5b15ec927370a0fb80a87026483a0b5518174e08a
|
4
|
+
data.tar.gz: 3ff7c6174bc5e9c2b69309f37b7deefee00842a74ba0543dac2403bbac8f04a5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cab85b1954548ce8468421928edb1941944a56deff74c211f81484e0e008185c0dceb79795a91e29abdf071a83dc1eee9041a9c50b6468f90b0ff1fc4c73c71f
|
7
|
+
data.tar.gz: 06db2b1969b9fcd5dcf6bf01d3fd605dd79fb778dd701c53285ead43bd91061e348ca7c78203b2bd11e039586e623f887f474edb49cc5618b0e467a06a4483f5
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.113.0 (2021-07-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.112.0 (2021-07-13)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Changes to OpsCenter APIs to support a new feature, operational insights.
|
13
|
+
|
14
|
+
1.111.0 (2021-06-03)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Documentation updates for ssm to fix customer reported issue
|
18
|
+
|
19
|
+
1.110.0 (2021-05-10)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release adds new APIs to associate, disassociate and list related items in SSM OpsCenter; and this release adds DisplayName as a version-level attribute for SSM Documents and introduces two new document types: ProblemAnalysis, ProblemAnalysisTemplate.
|
23
|
+
|
4
24
|
1.109.0 (2021-05-06)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.113.0
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -345,8 +345,18 @@ module Aws::SSM
|
|
345
345
|
# and an optional value, both of which you define. For example, you
|
346
346
|
# could define a set of tags for your account's managed instances that
|
347
347
|
# helps you track each instance's owner and stack level. For example:
|
348
|
-
#
|
349
|
-
# Value=
|
348
|
+
#
|
349
|
+
# * `Key=Owner,Value=DbAdmin`
|
350
|
+
#
|
351
|
+
# * `Key=Owner,Value=SysAdmin`
|
352
|
+
#
|
353
|
+
# * `Key=Owner,Value=Dev`
|
354
|
+
#
|
355
|
+
# * `Key=Stack,Value=Production`
|
356
|
+
#
|
357
|
+
# * `Key=Stack,Value=Pre-Production`
|
358
|
+
#
|
359
|
+
# * `Key=Stack,Value=Test`
|
350
360
|
#
|
351
361
|
# Each resource can have a maximum of 50 tags.
|
352
362
|
#
|
@@ -356,8 +366,9 @@ module Aws::SSM
|
|
356
366
|
# resources based on the tags you add. Tags don't have any semantic
|
357
367
|
# meaning to and are interpreted strictly as a string of characters.
|
358
368
|
#
|
359
|
-
# For more information about using tags with
|
360
|
-
#
|
369
|
+
# For more information about using tags with Amazon Elastic Compute
|
370
|
+
# Cloud (Amazon EC2) instances, see [Tagging your Amazon EC2
|
371
|
+
# resources][1] in the *Amazon EC2 User Guide*.
|
361
372
|
#
|
362
373
|
#
|
363
374
|
#
|
@@ -366,9 +377,10 @@ module Aws::SSM
|
|
366
377
|
# @option params [required, String] :resource_type
|
367
378
|
# Specifies the type of resource you are tagging.
|
368
379
|
#
|
369
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
380
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is for on-premises
|
370
381
|
# managed instances. You must specify the name of the managed instance
|
371
|
-
# in the following format: mi-
|
382
|
+
# in the following format: `mi-ID_number `. For example,
|
383
|
+
# `mi-1a2b3c4d5e6f`.
|
372
384
|
#
|
373
385
|
# </note>
|
374
386
|
#
|
@@ -377,13 +389,11 @@ module Aws::SSM
|
|
377
389
|
#
|
378
390
|
# Use the ID of the resource. Here are some examples:
|
379
391
|
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
# MaintenanceWindow: mw-012345abcde
|
392
|
+
# `MaintenanceWindow`\: `mw-012345abcde`
|
383
393
|
#
|
384
|
-
# PatchBaseline
|
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
|
404
|
+
# For the `Document` and `Parameter` values, use the name of the
|
405
|
+
# resource.
|
395
406
|
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
407
|
+
# `ManagedInstance`\: `mi-012345abcde`
|
408
|
+
#
|
409
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
410
|
+
# on-premises managed instances. You must specify the name of the
|
411
|
+
# managed instance in the following format: `mi-ID_number `. For
|
412
|
+
# example, `mi-1a2b3c4d5e6f`.
|
399
413
|
#
|
400
414
|
# </note>
|
401
415
|
#
|
402
416
|
# @option params [required, Array<Types::Tag>] :tags
|
403
417
|
# One or more tags. The value parameter is required.
|
404
418
|
#
|
405
|
-
#
|
419
|
+
# Don't enter personally identifiable information in this field.
|
406
420
|
#
|
407
421
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
408
422
|
#
|
@@ -428,6 +442,60 @@ module Aws::SSM
|
|
428
442
|
req.send_request(options)
|
429
443
|
end
|
430
444
|
|
445
|
+
# Associates a related resource to a Systems Manager OpsCenter OpsItem.
|
446
|
+
# For example, you can associate an Incident Manager incident or
|
447
|
+
# analysis with an OpsItem. Incident Manager is a capability of Amazon
|
448
|
+
# Web Services Systems Manager.
|
449
|
+
#
|
450
|
+
# @option params [required, String] :ops_item_id
|
451
|
+
# The ID of the OpsItem to which you want to associate a resource as a
|
452
|
+
# related item.
|
453
|
+
#
|
454
|
+
# @option params [required, String] :association_type
|
455
|
+
# The type of association that you want to create between an OpsItem and
|
456
|
+
# a resource. OpsCenter supports `IsParentOf` and `RelatesTo`
|
457
|
+
# association types.
|
458
|
+
#
|
459
|
+
# @option params [required, String] :resource_type
|
460
|
+
# The type of resource that you want to associate with an OpsItem.
|
461
|
+
# OpsCenter supports the following types:
|
462
|
+
#
|
463
|
+
# `AWS::SSMIncidents::IncidentRecord`\: an Incident Manager incident.
|
464
|
+
# Incident Manager is a capability of Amazon Web Services Systems
|
465
|
+
# Manager.
|
466
|
+
#
|
467
|
+
# `AWS::SSM::Document`\: a Systems Manager (SSM) document.
|
468
|
+
#
|
469
|
+
# @option params [required, String] :resource_uri
|
470
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services resource
|
471
|
+
# that you want to associate with the OpsItem.
|
472
|
+
#
|
473
|
+
# @return [Types::AssociateOpsItemRelatedItemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
474
|
+
#
|
475
|
+
# * {Types::AssociateOpsItemRelatedItemResponse#association_id #association_id} => String
|
476
|
+
#
|
477
|
+
# @example Request syntax with placeholder values
|
478
|
+
#
|
479
|
+
# resp = client.associate_ops_item_related_item({
|
480
|
+
# ops_item_id: "OpsItemId", # required
|
481
|
+
# association_type: "OpsItemRelatedItemAssociationType", # required
|
482
|
+
# resource_type: "OpsItemRelatedItemAssociationResourceType", # required
|
483
|
+
# resource_uri: "OpsItemRelatedItemAssociationResourceUri", # required
|
484
|
+
# })
|
485
|
+
#
|
486
|
+
# @example Response structure
|
487
|
+
#
|
488
|
+
# resp.association_id #=> String
|
489
|
+
#
|
490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociateOpsItemRelatedItem AWS API Documentation
|
491
|
+
#
|
492
|
+
# @overload associate_ops_item_related_item(params = {})
|
493
|
+
# @param [Hash] params ({})
|
494
|
+
def associate_ops_item_related_item(params = {}, options = {})
|
495
|
+
req = build_request(:associate_ops_item_related_item, params)
|
496
|
+
req.send_request(options)
|
497
|
+
end
|
498
|
+
|
431
499
|
# Attempts to cancel the command specified by the Command ID. There is
|
432
500
|
# no guarantee that the command will be terminated and the underlying
|
433
501
|
# process stopped.
|
@@ -459,8 +527,8 @@ module Aws::SSM
|
|
459
527
|
end
|
460
528
|
|
461
529
|
# Stops a maintenance window execution that is already in progress and
|
462
|
-
# cancels any tasks in the window that
|
463
|
-
# running.
|
530
|
+
# cancels any tasks in the window that haven't already starting
|
531
|
+
# running. Tasks already in progress will continue to completion.
|
464
532
|
#
|
465
533
|
# @option params [required, String] :window_execution_id
|
466
534
|
# The ID of the maintenance window execution to stop.
|
@@ -489,18 +557,19 @@ module Aws::SSM
|
|
489
557
|
end
|
490
558
|
|
491
559
|
# Generates an activation code and activation ID you can use to register
|
492
|
-
# your on-premises server or virtual machine (VM) with
|
493
|
-
# Registering these machines with Systems
|
494
|
-
# manage them using Systems Manager
|
495
|
-
# code and ID when installing SSM
|
496
|
-
# environment. For more information
|
497
|
-
# on-premises instances and VMs using
|
498
|
-
#
|
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
|
499
568
|
# Manager User Guide*.
|
500
569
|
#
|
501
570
|
# <note markdown="1"> On-premises servers or VMs that are registered with Systems Manager
|
502
|
-
# and
|
503
|
-
# *managed instances*.
|
571
|
+
# and Amazon Elastic Compute Cloud (Amazon EC2) instances that you
|
572
|
+
# manage with Systems Manager are all called *managed instances*.
|
504
573
|
#
|
505
574
|
# </note>
|
506
575
|
#
|
@@ -512,22 +581,22 @@ module Aws::SSM
|
|
512
581
|
# A user-defined description of the resource that you want to register
|
513
582
|
# with Systems Manager.
|
514
583
|
#
|
515
|
-
#
|
584
|
+
# Don't enter personally identifiable information in this field.
|
516
585
|
#
|
517
586
|
# @option params [String] :default_instance_name
|
518
587
|
# The name of the registered, managed instance as it will appear in the
|
519
|
-
# Systems Manager console or when you use the
|
520
|
-
# 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.
|
521
590
|
#
|
522
|
-
#
|
591
|
+
# Don't enter personally identifiable information in this field.
|
523
592
|
#
|
524
593
|
# @option params [required, String] :iam_role
|
525
|
-
# The
|
526
|
-
#
|
527
|
-
# permissions for the Systems Manager service
|
528
|
-
# `ssm.amazonaws.com`. For more information, see [Create an
|
529
|
-
# role for a hybrid environment][1] in the *
|
530
|
-
# Guide*.
|
594
|
+
# The Identity and Access Management (IAM) role that you want to assign
|
595
|
+
# to the managed instance. This IAMrole must provide AssumeRole
|
596
|
+
# permissions for the Amazon Web Services Systems Manager service
|
597
|
+
# principal `ssm.amazonaws.com`. For more information, see [Create an
|
598
|
+
# IAM service role for a hybrid environment][1] in the *Amazon Web
|
599
|
+
# Services Systems Manager User Guide*.
|
531
600
|
#
|
532
601
|
#
|
533
602
|
#
|
@@ -535,7 +604,7 @@ module Aws::SSM
|
|
535
604
|
#
|
536
605
|
# @option params [Integer] :registration_limit
|
537
606
|
# Specify the maximum number of managed instances you want to register.
|
538
|
-
# The default value is 1
|
607
|
+
# The default value is `1`.
|
539
608
|
#
|
540
609
|
# @option params [Time,DateTime,Date,Integer,String] :expiration_date
|
541
610
|
# The date by which this activation request should expire, in timestamp
|
@@ -549,7 +618,7 @@ module Aws::SSM
|
|
549
618
|
# environment. For example, you might want to tag an activation to
|
550
619
|
# identify which servers or virtual machines (VMs) in your on-premises
|
551
620
|
# environment you intend to activate. In this case, you could specify
|
552
|
-
# the following key
|
621
|
+
# the following key-value pairs:
|
553
622
|
#
|
554
623
|
# * `Key=OS,Value=Windows`
|
555
624
|
#
|
@@ -563,11 +632,11 @@ module Aws::SSM
|
|
563
632
|
# You can't add tags to or delete tags from an existing activation. You
|
564
633
|
# can tag your on-premises servers and VMs after they connect to Systems
|
565
634
|
# Manager for the first time and are assigned a managed instance ID.
|
566
|
-
# This means they are listed in the
|
567
|
-
# ID that is prefixed with "mi-". For information
|
568
|
-
# tags to your managed instances, see
|
569
|
-
# about how to remove tags from your
|
570
|
-
# 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.
|
571
640
|
#
|
572
641
|
# @return [Types::CreateActivationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
573
642
|
#
|
@@ -609,26 +678,28 @@ module Aws::SSM
|
|
609
678
|
# that anti-virus software must be installed and running on your
|
610
679
|
# instances, or that certain ports must be closed. For static targets,
|
611
680
|
# the association specifies a schedule for when the configuration is
|
612
|
-
# reapplied. For dynamic targets, such as an
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
# association
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
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.
|
620
691
|
#
|
621
692
|
# @option params [required, String] :name
|
622
|
-
# The name of the SSM document
|
623
|
-
# information for the instance.
|
624
|
-
# documents.
|
693
|
+
# The name of the SSM Command document or Automation runbook that
|
694
|
+
# contains the configuration information for the instance.
|
625
695
|
#
|
626
|
-
# You can specify
|
627
|
-
# document that is shared with you from another
|
696
|
+
# You can specify Amazon Web Services-predefined documents, documents
|
697
|
+
# you created, or a document that is shared with you from another
|
698
|
+
# account.
|
628
699
|
#
|
629
|
-
# For SSM documents that are shared with you
|
630
|
-
# you must specify the complete SSM document ARN,
|
631
|
-
# format:
|
700
|
+
# For Systems Manager documents (SSM documents) that are shared with you
|
701
|
+
# from other accounts, you must specify the complete SSM document ARN,
|
702
|
+
# in the following format:
|
632
703
|
#
|
633
704
|
# `arn:partition:ssm:region:account-id:document/document-name `
|
634
705
|
#
|
@@ -636,9 +707,9 @@ module Aws::SSM
|
|
636
707
|
#
|
637
708
|
# `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
|
638
709
|
#
|
639
|
-
# For
|
640
|
-
# account, you only need to specify the document name.
|
641
|
-
# `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`.
|
642
713
|
#
|
643
714
|
# @option params [String] :document_version
|
644
715
|
# The document version you want to associate with the target(s). Can be
|
@@ -649,12 +720,12 @@ module Aws::SSM
|
|
649
720
|
#
|
650
721
|
# <note markdown="1"> `InstanceId` has been deprecated. To specify an instance ID for an
|
651
722
|
# association, use the `Targets` parameter. Requests that include the
|
652
|
-
# parameter `InstanceID` with
|
653
|
-
# or later will fail. In addition, if you
|
654
|
-
# `InstanceId`, you
|
655
|
-
# `DocumentVersion`, `MaxErrors`, `MaxConcurrency`,
|
656
|
-
# `ScheduleExpression`. To use these parameters,
|
657
|
-
# `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.
|
658
729
|
#
|
659
730
|
# </note>
|
660
731
|
#
|
@@ -663,10 +734,11 @@ module Aws::SSM
|
|
663
734
|
#
|
664
735
|
# @option params [Array<Types::Target>] :targets
|
665
736
|
# The targets for the association. You can target instances by using
|
666
|
-
# tags,
|
667
|
-
# individual instance IDs. For more information about
|
668
|
-
# for an association, see [Using targets and rate
|
669
|
-
# Manager associations][1] in the *
|
737
|
+
# tags, Amazon Web Services resource groups, all instances in an
|
738
|
+
# account, or individual instance IDs. For more information about
|
739
|
+
# choosing targets for an association, see [Using targets and rate
|
740
|
+
# controls with State Manager associations][1] in the *Amazon Web
|
741
|
+
# Services Systems Manager User Guide*.
|
670
742
|
#
|
671
743
|
#
|
672
744
|
#
|
@@ -677,16 +749,17 @@ module Aws::SSM
|
|
677
749
|
# target(s).
|
678
750
|
#
|
679
751
|
# @option params [Types::InstanceAssociationOutputLocation] :output_location
|
680
|
-
# An S3 bucket where you want to
|
681
|
-
# request.
|
752
|
+
# An Amazon Simple Storage Service (Amazon S3) bucket where you want to
|
753
|
+
# store the output details of the request.
|
682
754
|
#
|
683
755
|
# @option params [String] :association_name
|
684
756
|
# Specify a descriptive name for the association.
|
685
757
|
#
|
686
758
|
# @option params [String] :automation_target_parameter_name
|
687
759
|
# Specify the target for the association. This target is required for
|
688
|
-
# associations that use an Automation
|
689
|
-
# 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.
|
690
763
|
#
|
691
764
|
# @option params [String] :max_errors
|
692
765
|
# The number of errors that are allowed before the system stops sending
|
@@ -696,13 +769,13 @@ module Aws::SSM
|
|
696
769
|
# system stops sending requests when the fourth error is received. If
|
697
770
|
# you specify 0, then the system stops sending requests after the first
|
698
771
|
# error is returned. If you run an association on 50 instances and set
|
699
|
-
# 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
|
700
773
|
# sixth error is received.
|
701
774
|
#
|
702
|
-
# Executions that are already running an association when MaxErrors is
|
775
|
+
# Executions that are already running an association when `MaxErrors` is
|
703
776
|
# reached are allowed to complete, but some of these executions may fail
|
704
777
|
# as well. If you need to ensure that there won't be more than
|
705
|
-
# max-errors failed executions, set MaxConcurrency to 1 so that
|
778
|
+
# max-errors failed executions, set `MaxConcurrency` to 1 so that
|
706
779
|
# executions proceed one at a time.
|
707
780
|
#
|
708
781
|
# @option params [String] :max_concurrency
|
@@ -712,10 +785,10 @@ module Aws::SSM
|
|
712
785
|
# means all targets run the association at the same time.
|
713
786
|
#
|
714
787
|
# If a new instance starts and attempts to run an association while
|
715
|
-
# Systems Manager is running MaxConcurrency associations, the
|
788
|
+
# Systems Manager is running `MaxConcurrency` associations, the
|
716
789
|
# association is allowed to run. During the next association interval,
|
717
790
|
# the new instance will process its association within the limit
|
718
|
-
# specified for MaxConcurrency
|
791
|
+
# specified for `MaxConcurrency`.
|
719
792
|
#
|
720
793
|
# @option params [String] :compliance_severity
|
721
794
|
# The severity level to assign to the association.
|
@@ -729,9 +802,9 @@ module Aws::SSM
|
|
729
802
|
# the association is `NON-COMPLIANT`.
|
730
803
|
#
|
731
804
|
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
732
|
-
# for the PutComplianceItems API
|
733
|
-
#
|
734
|
-
# the PutComplianceItems API
|
805
|
+
# for the PutComplianceItems API operation. In this case, compliance
|
806
|
+
# data isn't managed by State Manager. It is managed by your direct
|
807
|
+
# call to the PutComplianceItems API operation.
|
735
808
|
#
|
736
809
|
# By default, all associations use `AUTO` mode.
|
737
810
|
#
|
@@ -739,23 +812,23 @@ module Aws::SSM
|
|
739
812
|
# By default, when you create a new association, the system runs it
|
740
813
|
# immediately after it is created and then according to the schedule you
|
741
814
|
# specified. Specify this option if you don't want an association to
|
742
|
-
# run immediately after you create it. This parameter
|
815
|
+
# run immediately after you create it. This parameter isn't supported
|
743
816
|
# for rate expressions.
|
744
817
|
#
|
745
818
|
# @option params [Array<String>] :calendar_names
|
746
|
-
# The names or Amazon Resource Names (ARNs) of the
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
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].
|
750
823
|
#
|
751
824
|
#
|
752
825
|
#
|
753
826
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
754
827
|
#
|
755
828
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
756
|
-
# A location is a combination of
|
757
|
-
#
|
758
|
-
#
|
829
|
+
# A location is a combination of Regions and accounts where you want to
|
830
|
+
# run the association. Use this action to create an association in
|
831
|
+
# multiple Regions and multiple accounts.
|
759
832
|
#
|
760
833
|
# @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
761
834
|
#
|
@@ -860,12 +933,13 @@ module Aws::SSM
|
|
860
933
|
req.send_request(options)
|
861
934
|
end
|
862
935
|
|
863
|
-
# Associates the specified Systems Manager document
|
864
|
-
# instances or targets.
|
936
|
+
# Associates the specified Amazon Web Services Systems Manager document
|
937
|
+
# (SSM document) with the specified instances or targets.
|
865
938
|
#
|
866
939
|
# When you associate a document with one or more instances using
|
867
|
-
# instance IDs or tags,
|
868
|
-
#
|
940
|
+
# instance IDs or tags, Amazon Web Services Systems Manager Agent (SSM
|
941
|
+
# Agent) running on the instance processes the document and configures
|
942
|
+
# the instance as specified.
|
869
943
|
#
|
870
944
|
# If you associate a document with an instance that already has an
|
871
945
|
# associated document, the system returns the AssociationAlreadyExists
|
@@ -1017,11 +1091,12 @@ module Aws::SSM
|
|
1017
1091
|
req.send_request(options)
|
1018
1092
|
end
|
1019
1093
|
|
1020
|
-
# Creates a Systems Manager (SSM
|
1021
|
-
# actions that Systems Manager performs on your
|
1022
|
-
# more information about SSM documents, including
|
1023
|
-
# supported schemas, features, and syntax, see [
|
1024
|
-
# Documents][1] in the *
|
1094
|
+
# Creates a Amazon Web Services Systems Manager (SSM document). An SSM
|
1095
|
+
# document defines the actions that Systems Manager performs on your
|
1096
|
+
# managed instances. For more information about SSM documents, including
|
1097
|
+
# information about supported schemas, features, and syntax, see [Amazon
|
1098
|
+
# Web Services Systems Manager Documents][1] in the *Amazon Web Services
|
1099
|
+
# Systems Manager User Guide*.
|
1025
1100
|
#
|
1026
1101
|
#
|
1027
1102
|
#
|
@@ -1032,12 +1107,12 @@ module Aws::SSM
|
|
1032
1107
|
# recommend storing the contents for your new document in an external
|
1033
1108
|
# JSON or YAML file and referencing the file in a command.
|
1034
1109
|
#
|
1035
|
-
# For examples, see the following topics in the *
|
1036
|
-
# User Guide*.
|
1110
|
+
# For examples, see the following topics in the *Amazon Web Services
|
1111
|
+
# Systems Manager User Guide*.
|
1037
1112
|
#
|
1038
|
-
# * [Create an SSM document (
|
1113
|
+
# * [Create an SSM document (Amazon Web Services API)][1]
|
1039
1114
|
#
|
1040
|
-
# * [Create an SSM document (
|
1115
|
+
# * [Create an SSM document (Amazon Web Services CLI)][2]
|
1041
1116
|
#
|
1042
1117
|
# * [Create an SSM document (API)][1]
|
1043
1118
|
#
|
@@ -1048,27 +1123,27 @@ module Aws::SSM
|
|
1048
1123
|
#
|
1049
1124
|
# @option params [Array<Types::DocumentRequires>] :requires
|
1050
1125
|
# A list of SSM documents required by a document. This parameter is used
|
1051
|
-
# exclusively by
|
1126
|
+
# exclusively by AppConfig. When a user creates an AppConfig
|
1052
1127
|
# configuration in an SSM document, the user must also specify a
|
1053
1128
|
# required document for validation purposes. In this case, an
|
1054
1129
|
# `ApplicationConfiguration` document requires an
|
1055
1130
|
# `ApplicationConfigurationSchema` document for validation purposes. For
|
1056
|
-
# more information, see [
|
1057
|
-
#
|
1131
|
+
# more information, see [What is AppConfig?][1] in the *AppConfig User
|
1132
|
+
# Guide*.
|
1058
1133
|
#
|
1059
1134
|
#
|
1060
1135
|
#
|
1061
|
-
# [1]: https://docs.aws.amazon.com/
|
1136
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html
|
1062
1137
|
#
|
1063
1138
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
1064
|
-
# A list of key
|
1065
|
-
#
|
1139
|
+
# A list of key-value pairs that describe attachments to a version of a
|
1140
|
+
# document.
|
1066
1141
|
#
|
1067
1142
|
# @option params [required, String] :name
|
1068
|
-
# A name for the
|
1143
|
+
# A name for the SSM document.
|
1069
1144
|
#
|
1070
1145
|
# You can't use the following strings as document name prefixes. These
|
1071
|
-
# are reserved by
|
1146
|
+
# are reserved by Amazon Web Services for use as document name prefixes:
|
1072
1147
|
#
|
1073
1148
|
# * `aws-`
|
1074
1149
|
#
|
@@ -1076,10 +1151,16 @@ module Aws::SSM
|
|
1076
1151
|
#
|
1077
1152
|
# * `amzn`
|
1078
1153
|
#
|
1154
|
+
# @option params [String] :display_name
|
1155
|
+
# An optional field where you can specify a friendly name for the SSM
|
1156
|
+
# document. This value can differ for each version of the document. You
|
1157
|
+
# can update this value at a later time using the UpdateDocument
|
1158
|
+
# operation.
|
1159
|
+
#
|
1079
1160
|
# @option params [String] :version_name
|
1080
1161
|
# An optional field specifying the version of the artifact you are
|
1081
1162
|
# creating with the document. For example, "Release 12, Update 6".
|
1082
|
-
# This value is unique across all versions of a document, and
|
1163
|
+
# This value is unique across all versions of a document, and can't be
|
1083
1164
|
# changed.
|
1084
1165
|
#
|
1085
1166
|
# @option params [String] :document_type
|
@@ -1092,29 +1173,29 @@ module Aws::SSM
|
|
1092
1173
|
# @option params [String] :target_type
|
1093
1174
|
# Specify a target type to define the kinds of resources the document
|
1094
1175
|
# can run on. For example, to run a document on EC2 instances, specify
|
1095
|
-
# the following value:
|
1176
|
+
# the following value: `/AWS::EC2::Instance`. If you specify a value of
|
1096
1177
|
# '/' the document can run on all types of resources. If you don't
|
1097
1178
|
# specify a value, the document can't run on any resources. For a list
|
1098
|
-
# of valid resource types, see [
|
1099
|
-
# reference][1] in the *
|
1179
|
+
# of valid resource types, see [Amazon Web Services resource and
|
1180
|
+
# property types reference][1] in the *CloudFormation User Guide*.
|
1100
1181
|
#
|
1101
1182
|
#
|
1102
1183
|
#
|
1103
|
-
# [1]:
|
1184
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
|
1104
1185
|
#
|
1105
1186
|
# @option params [Array<Types::Tag>] :tags
|
1106
1187
|
# Optional metadata that you assign to a resource. Tags enable you to
|
1107
1188
|
# categorize a resource in different ways, such as by purpose, owner, or
|
1108
1189
|
# environment. For example, you might want to tag an SSM document to
|
1109
1190
|
# identify the types of targets or the environment where it will run. In
|
1110
|
-
# this case, you could specify the following key
|
1191
|
+
# this case, you could specify the following key-value pairs:
|
1111
1192
|
#
|
1112
1193
|
# * `Key=OS,Value=Windows`
|
1113
1194
|
#
|
1114
1195
|
# * `Key=Environment,Value=Production`
|
1115
1196
|
#
|
1116
1197
|
# <note markdown="1"> To add tags to an existing SSM document, use the AddTagsToResource
|
1117
|
-
#
|
1198
|
+
# operation.
|
1118
1199
|
#
|
1119
1200
|
# </note>
|
1120
1201
|
#
|
@@ -1140,8 +1221,9 @@ module Aws::SSM
|
|
1140
1221
|
# },
|
1141
1222
|
# ],
|
1142
1223
|
# name: "DocumentName", # required
|
1224
|
+
# display_name: "DocumentDisplayName",
|
1143
1225
|
# version_name: "DocumentVersionName",
|
1144
|
-
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate
|
1226
|
+
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate, ProblemAnalysis, ProblemAnalysisTemplate
|
1145
1227
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
1146
1228
|
# target_type: "TargetType",
|
1147
1229
|
# tags: [
|
@@ -1158,6 +1240,7 @@ module Aws::SSM
|
|
1158
1240
|
# resp.document_description.hash #=> String
|
1159
1241
|
# resp.document_description.hash_type #=> String, one of "Sha256", "Sha1"
|
1160
1242
|
# resp.document_description.name #=> String
|
1243
|
+
# resp.document_description.display_name #=> String
|
1161
1244
|
# resp.document_description.version_name #=> String
|
1162
1245
|
# resp.document_description.owner #=> String
|
1163
1246
|
# resp.document_description.created_date #=> Time
|
@@ -1172,7 +1255,7 @@ module Aws::SSM
|
|
1172
1255
|
# resp.document_description.parameters[0].default_value #=> String
|
1173
1256
|
# resp.document_description.platform_types #=> Array
|
1174
1257
|
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
1175
|
-
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
1258
|
+
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
1176
1259
|
# resp.document_description.schema_version #=> String
|
1177
1260
|
# resp.document_description.latest_version #=> String
|
1178
1261
|
# resp.document_description.default_version #=> String
|
@@ -1226,12 +1309,12 @@ module Aws::SSM
|
|
1226
1309
|
#
|
1227
1310
|
# @option params [String] :start_date
|
1228
1311
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
1229
|
-
# maintenance window to become active. StartDate allows you to delay
|
1312
|
+
# maintenance window to become active. `StartDate` allows you to delay
|
1230
1313
|
# activation of the maintenance window until the specified future date.
|
1231
1314
|
#
|
1232
1315
|
# @option params [String] :end_date
|
1233
1316
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
1234
|
-
# maintenance window to become inactive. EndDate allows you to set a
|
1317
|
+
# maintenance window to become inactive. `EndDate` allows you to set a
|
1235
1318
|
# date and time in the future when the maintenance window will no longer
|
1236
1319
|
# run.
|
1237
1320
|
#
|
@@ -1250,7 +1333,7 @@ module Aws::SSM
|
|
1250
1333
|
# [1]: https://www.iana.org/time-zones
|
1251
1334
|
#
|
1252
1335
|
# @option params [Integer] :schedule_offset
|
1253
|
-
# The number of days to wait after the date and time specified by a
|
1336
|
+
# The number of days to wait after the date and time specified by a cron
|
1254
1337
|
# expression before running the maintenance window.
|
1255
1338
|
#
|
1256
1339
|
# For example, the following cron expression schedules a maintenance
|
@@ -1266,11 +1349,12 @@ module Aws::SSM
|
|
1266
1349
|
#
|
1267
1350
|
# @option params [required, Integer] :cutoff
|
1268
1351
|
# The number of hours before the end of the maintenance window that
|
1269
|
-
# Systems Manager stops scheduling new tasks for
|
1352
|
+
# Amazon Web Services Systems Manager stops scheduling new tasks for
|
1353
|
+
# execution.
|
1270
1354
|
#
|
1271
1355
|
# @option params [required, Boolean] :allow_unassociated_targets
|
1272
1356
|
# Enables a maintenance window task to run on managed instances, even if
|
1273
|
-
# you
|
1357
|
+
# you haven't registered those instances as targets. If enabled, then
|
1274
1358
|
# you must specify the unregistered instances (by instance ID) when you
|
1275
1359
|
# register a task with the maintenance window.
|
1276
1360
|
#
|
@@ -1290,7 +1374,7 @@ module Aws::SSM
|
|
1290
1374
|
# environment. For example, you might want to tag a maintenance window
|
1291
1375
|
# to identify the type of tasks it will run, the types of targets, and
|
1292
1376
|
# the environment it will run in. In this case, you could specify the
|
1293
|
-
# following key
|
1377
|
+
# following key-value pairs:
|
1294
1378
|
#
|
1295
1379
|
# * `Key=TaskType,Value=AgentUpdate`
|
1296
1380
|
#
|
@@ -1299,7 +1383,7 @@ module Aws::SSM
|
|
1299
1383
|
# * `Key=Environment,Value=Production`
|
1300
1384
|
#
|
1301
1385
|
# <note markdown="1"> To add tags to an existing maintenance window, use the
|
1302
|
-
# AddTagsToResource
|
1386
|
+
# AddTagsToResource operation.
|
1303
1387
|
#
|
1304
1388
|
# </note>
|
1305
1389
|
#
|
@@ -1342,16 +1426,17 @@ module Aws::SSM
|
|
1342
1426
|
req.send_request(options)
|
1343
1427
|
end
|
1344
1428
|
|
1345
|
-
# Creates a new OpsItem. You must have permission in
|
1346
|
-
#
|
1347
|
-
#
|
1348
|
-
# User Guide*.
|
1429
|
+
# Creates a new OpsItem. You must have permission in Identity and Access
|
1430
|
+
# Management (IAM) to create a new OpsItem. For more information, see
|
1431
|
+
# [Getting started with OpsCenter][1] in the *Amazon Web Services
|
1432
|
+
# Systems Manager User Guide*.
|
1349
1433
|
#
|
1350
|
-
# Operations engineers and IT professionals use
|
1351
|
-
# investigate, and remediate
|
1352
|
-
# performance and health of their
|
1353
|
-
#
|
1354
|
-
#
|
1434
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
1435
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
1436
|
+
# operational issues impacting the performance and health of their
|
1437
|
+
# Amazon Web Services resources. For more information, see [Amazon Web
|
1438
|
+
# Services Systems Manager OpsCenter][2] in the *Amazon Web Services
|
1439
|
+
# Systems Manager User Guide*.
|
1355
1440
|
#
|
1356
1441
|
#
|
1357
1442
|
#
|
@@ -1372,22 +1457,23 @@ module Aws::SSM
|
|
1372
1457
|
# You enter operational data as key-value pairs. The key has a maximum
|
1373
1458
|
# length of 128 characters. The value has a maximum size of 20 KB.
|
1374
1459
|
#
|
1375
|
-
# Operational data keys *can't* begin with the following: amazon
|
1376
|
-
# amzn
|
1460
|
+
# Operational data keys *can't* begin with the following: `amazon`,
|
1461
|
+
# `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
|
1377
1462
|
#
|
1378
1463
|
# You can choose to make the data searchable by other users in the
|
1379
1464
|
# account or you can restrict search access. Searchable data means that
|
1380
1465
|
# all users with access to the OpsItem Overview page (as provided by the
|
1381
|
-
# DescribeOpsItems API
|
1382
|
-
# data. Operational data that
|
1466
|
+
# DescribeOpsItems API operation) can view and search on the specified
|
1467
|
+
# data. Operational data that isn't searchable is only viewable by
|
1383
1468
|
# users who have access to the OpsItem (as provided by the GetOpsItem
|
1384
|
-
# API
|
1469
|
+
# API operation).
|
1385
1470
|
#
|
1386
1471
|
# Use the `/aws/resources` key in OperationalData to specify a related
|
1387
1472
|
# resource in the request. Use the `/aws/automations` key in
|
1388
1473
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
1389
|
-
# To view
|
1390
|
-
# OpsItems manually][1] in the *
|
1474
|
+
# To view Amazon Web Services CLI example commands that use these keys,
|
1475
|
+
# see [Creating OpsItems manually][1] in the *Amazon Web Services
|
1476
|
+
# Systems Manager User Guide*.
|
1391
1477
|
#
|
1392
1478
|
#
|
1393
1479
|
#
|
@@ -1410,8 +1496,8 @@ module Aws::SSM
|
|
1410
1496
|
# @option params [required, String] :source
|
1411
1497
|
# The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
|
1412
1498
|
#
|
1413
|
-
# <note markdown="1"> The source name can't contain the following strings: aws
|
1414
|
-
# amzn
|
1499
|
+
# <note markdown="1"> The source name can't contain the following strings: `aws`, `amazon`,
|
1500
|
+
# and `amzn`.
|
1415
1501
|
#
|
1416
1502
|
# </note>
|
1417
1503
|
#
|
@@ -1423,15 +1509,16 @@ module Aws::SSM
|
|
1423
1509
|
# Optional metadata that you assign to a resource. You can restrict
|
1424
1510
|
# access to OpsItems by using an inline IAM policy that specifies tags.
|
1425
1511
|
# For more information, see [Getting started with OpsCenter][1] in the
|
1426
|
-
# *
|
1512
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
1427
1513
|
#
|
1428
1514
|
# Tags use a key-value pair. For example:
|
1429
1515
|
#
|
1430
1516
|
# `Key=Department,Value=Finance`
|
1431
1517
|
#
|
1432
|
-
#
|
1433
|
-
#
|
1434
|
-
#
|
1518
|
+
# To add tags to a new OpsItem, a user must have IAM permissions for
|
1519
|
+
# both the `ssm:CreateOpsItems` operation and the
|
1520
|
+
# `ssm:AddTagsToResource` operation. To add tags to an existing OpsItem,
|
1521
|
+
# use the AddTagsToResource operation.
|
1435
1522
|
#
|
1436
1523
|
#
|
1437
1524
|
#
|
@@ -1515,9 +1602,9 @@ module Aws::SSM
|
|
1515
1602
|
req.send_request(options)
|
1516
1603
|
end
|
1517
1604
|
|
1518
|
-
# If you create a new application in Application Manager,
|
1519
|
-
# Manager calls this API
|
1520
|
-
# application, including the application type.
|
1605
|
+
# If you create a new application in Application Manager, Amazon Web
|
1606
|
+
# Services Systems Manager calls this API operation to specify
|
1607
|
+
# information about the new application, including the application type.
|
1521
1608
|
#
|
1522
1609
|
# @option params [required, String] :resource_id
|
1523
1610
|
# A resource ID for a new Application Manager application.
|
@@ -1530,8 +1617,8 @@ module Aws::SSM
|
|
1530
1617
|
# maximum of five tags for an OpsMetadata object. Tags enable you to
|
1531
1618
|
# categorize a resource in different ways, such as by purpose, owner, or
|
1532
1619
|
# environment. For example, you might want to tag an OpsMetadata object
|
1533
|
-
# to identify an environment or target
|
1534
|
-
#
|
1620
|
+
# to identify an environment or target Region. In this case, you could
|
1621
|
+
# specify the following key-value pairs:
|
1535
1622
|
#
|
1536
1623
|
# * `Key=Environment,Value=Production`
|
1537
1624
|
#
|
@@ -1573,18 +1660,14 @@ module Aws::SSM
|
|
1573
1660
|
|
1574
1661
|
# Creates a patch baseline.
|
1575
1662
|
#
|
1576
|
-
# <note markdown="1"> For information about valid key
|
1577
|
-
#
|
1663
|
+
# <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
|
1664
|
+
# supported operating system type, see PatchFilter.
|
1578
1665
|
#
|
1579
1666
|
# </note>
|
1580
1667
|
#
|
1581
|
-
#
|
1582
|
-
#
|
1583
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
|
1584
|
-
#
|
1585
1668
|
# @option params [String] :operating_system
|
1586
1669
|
# Defines the operating system the patch baseline applies to. The
|
1587
|
-
#
|
1670
|
+
# default value is `WINDOWS`.
|
1588
1671
|
#
|
1589
1672
|
# @option params [required, String] :name
|
1590
1673
|
# The name of the patch baseline.
|
@@ -1600,7 +1683,8 @@ module Aws::SSM
|
|
1600
1683
|
#
|
1601
1684
|
# For information about accepted formats for lists of approved patches
|
1602
1685
|
# and rejected patches, see [About package name formats for approved and
|
1603
|
-
# rejected patch lists][1] in the *
|
1686
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
1687
|
+
# User Guide*.
|
1604
1688
|
#
|
1605
1689
|
#
|
1606
1690
|
#
|
@@ -1609,19 +1693,20 @@ module Aws::SSM
|
|
1609
1693
|
# @option params [String] :approved_patches_compliance_level
|
1610
1694
|
# Defines the compliance level for approved patches. When an approved
|
1611
1695
|
# patch is reported as missing, this value describes the severity of the
|
1612
|
-
# compliance violation. The default value is UNSPECIFIED
|
1696
|
+
# compliance violation. The default value is `UNSPECIFIED`.
|
1613
1697
|
#
|
1614
1698
|
# @option params [Boolean] :approved_patches_enable_non_security
|
1615
1699
|
# Indicates whether the list of approved patches includes non-security
|
1616
1700
|
# updates that should be applied to the instances. The default value is
|
1617
|
-
#
|
1701
|
+
# `false`. Applies to Linux instances only.
|
1618
1702
|
#
|
1619
1703
|
# @option params [Array<String>] :rejected_patches
|
1620
1704
|
# A list of explicitly rejected patches for the baseline.
|
1621
1705
|
#
|
1622
1706
|
# For information about accepted formats for lists of approved patches
|
1623
1707
|
# and rejected patches, see [About package name formats for approved and
|
1624
|
-
# rejected patch lists][1] in the *
|
1708
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
1709
|
+
# User Guide*.
|
1625
1710
|
#
|
1626
1711
|
#
|
1627
1712
|
#
|
@@ -1629,19 +1714,20 @@ module Aws::SSM
|
|
1629
1714
|
#
|
1630
1715
|
# @option params [String] :rejected_patches_action
|
1631
1716
|
# The action for Patch Manager to take on patches included in the
|
1632
|
-
# RejectedPackages list.
|
1717
|
+
# `RejectedPackages` list.
|
1633
1718
|
#
|
1634
|
-
# *
|
1635
|
-
# is installed only if it is a dependency of
|
1636
|
-
# considered compliant with the patch baseline,
|
1637
|
-
# reported as
|
1638
|
-
# option is specified.
|
1719
|
+
# * <b> <code>ALLOW_AS_DEPENDENCY</code> </b>\: A package in the
|
1720
|
+
# `Rejected` patches list is installed only if it is a dependency of
|
1721
|
+
# another package. It is considered compliant with the patch baseline,
|
1722
|
+
# and its status is reported as `InstalledOther`. This is the default
|
1723
|
+
# action if no option is specified.
|
1639
1724
|
#
|
1640
|
-
# *
|
1641
|
-
# include them as dependencies,
|
1642
|
-
# circumstances. If a package was installed before
|
1643
|
-
# Rejected patches list, it is considered
|
1644
|
-
# baseline, and its status is reported as
|
1725
|
+
# * <b> <code>BLOCK</code> </b>\: Packages in the `RejectedPatches`
|
1726
|
+
# list, and packages that include them as dependencies, aren't
|
1727
|
+
# installed under any circumstances. If a package was installed before
|
1728
|
+
# it was added to the Rejected patches list, it is considered
|
1729
|
+
# non-compliant with the patch baseline, and its status is reported as
|
1730
|
+
# `InstalledRejected`.
|
1645
1731
|
#
|
1646
1732
|
# @option params [String] :description
|
1647
1733
|
# A description of the patch baseline.
|
@@ -1663,14 +1749,14 @@ module Aws::SSM
|
|
1663
1749
|
# environment. For example, you might want to tag a patch baseline to
|
1664
1750
|
# identify the severity level of patches it specifies and the operating
|
1665
1751
|
# system family it applies to. In this case, you could specify the
|
1666
|
-
# following key
|
1752
|
+
# following key-value pairs:
|
1667
1753
|
#
|
1668
1754
|
# * `Key=PatchSeverity,Value=Critical`
|
1669
1755
|
#
|
1670
1756
|
# * `Key=OS,Value=Windows`
|
1671
1757
|
#
|
1672
1758
|
# <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
|
1673
|
-
#
|
1759
|
+
# operation.
|
1674
1760
|
#
|
1675
1761
|
# </note>
|
1676
1762
|
#
|
@@ -1745,30 +1831,30 @@ module Aws::SSM
|
|
1745
1831
|
end
|
1746
1832
|
|
1747
1833
|
# A resource data sync helps you view data from multiple sources in a
|
1748
|
-
# single location. Systems Manager offers two types
|
1749
|
-
# sync: `SyncToDestination` and `SyncFromSource`.
|
1834
|
+
# single location. Amazon Web Services Systems Manager offers two types
|
1835
|
+
# of resource data sync: `SyncToDestination` and `SyncFromSource`.
|
1750
1836
|
#
|
1751
1837
|
# You can configure Systems Manager Inventory to use the
|
1752
1838
|
# `SyncToDestination` type to synchronize Inventory data from multiple
|
1753
|
-
#
|
1754
|
-
#
|
1755
|
-
# Manager User Guide*.
|
1839
|
+
# Regions to a single Amazon Simple Storage Service (Amazon S3) bucket.
|
1840
|
+
# For more information, see [Configuring resource data sync for
|
1841
|
+
# Inventory][1] in the *Amazon Web Services Systems Manager User Guide*.
|
1756
1842
|
#
|
1757
1843
|
# You can configure Systems Manager Explorer to use the `SyncFromSource`
|
1758
1844
|
# type to synchronize operational work items (OpsItems) and operational
|
1759
|
-
# data (OpsData) from multiple
|
1760
|
-
# type can synchronize OpsItems and OpsData from multiple
|
1761
|
-
# and Regions or `EntireOrganization` by using
|
1762
|
-
#
|
1763
|
-
#
|
1764
|
-
# Manager User Guide*.
|
1845
|
+
# data (OpsData) from multiple Regions to a single Amazon S3 bucket.
|
1846
|
+
# This type can synchronize OpsItems and OpsData from multiple accounts
|
1847
|
+
# and Regions or `EntireOrganization` by using Organizations. For more
|
1848
|
+
# information, see [Setting up Systems Manager Explorer to display data
|
1849
|
+
# from multiple accounts and Regions][2] in the *Amazon Web Services
|
1850
|
+
# Systems Manager User Guide*.
|
1765
1851
|
#
|
1766
1852
|
# A resource data sync is an asynchronous operation that returns
|
1767
1853
|
# immediately. After a successful initial sync is completed, the system
|
1768
1854
|
# continuously syncs data. To check the status of a sync, use the
|
1769
1855
|
# ListResourceDataSync.
|
1770
1856
|
#
|
1771
|
-
# <note markdown="1"> By default, data
|
1857
|
+
# <note markdown="1"> By default, data isn't encrypted in Amazon S3. We strongly recommend
|
1772
1858
|
# that you enable encryption in Amazon S3 to ensure secure data storage.
|
1773
1859
|
# We also recommend that you secure access to the Amazon S3 bucket by
|
1774
1860
|
# creating a restrictive bucket policy.
|
@@ -1792,9 +1878,9 @@ module Aws::SSM
|
|
1792
1878
|
# synchronizes data to an S3 bucket for Inventory. If you specify
|
1793
1879
|
# `SyncToDestination`, you must provide a value for `S3Destination`.
|
1794
1880
|
# Specify `SyncFromSource` to synchronize data from a single account and
|
1795
|
-
# multiple Regions, or multiple
|
1796
|
-
#
|
1797
|
-
#
|
1881
|
+
# multiple Regions, or multiple accounts and Regions, as listed in
|
1882
|
+
# Organizations for Explorer. If you specify `SyncFromSource`, you must
|
1883
|
+
# provide a value for `SyncSource`. The default value is
|
1798
1884
|
# `SyncToDestination`.
|
1799
1885
|
#
|
1800
1886
|
# @option params [Types::ResourceDataSyncSource] :sync_source
|
@@ -1843,9 +1929,9 @@ module Aws::SSM
|
|
1843
1929
|
req.send_request(options)
|
1844
1930
|
end
|
1845
1931
|
|
1846
|
-
# Deletes an activation. You
|
1932
|
+
# Deletes an activation. You aren't required to delete an activation.
|
1847
1933
|
# If you delete an activation, you can no longer use it to register
|
1848
|
-
# additional managed instances. Deleting an activation
|
1934
|
+
# additional managed instances. Deleting an activation doesn't
|
1849
1935
|
# de-register managed instances. You must manually de-register managed
|
1850
1936
|
# instances.
|
1851
1937
|
#
|
@@ -1869,17 +1955,17 @@ module Aws::SSM
|
|
1869
1955
|
req.send_request(options)
|
1870
1956
|
end
|
1871
1957
|
|
1872
|
-
# Disassociates the specified
|
1873
|
-
# specified instance.
|
1958
|
+
# Disassociates the specified Amazon Web Services Systems Manager
|
1959
|
+
# document (SSM document) from the specified instance.
|
1874
1960
|
#
|
1875
|
-
# When you disassociate a document from an instance, it
|
1961
|
+
# When you disassociate a document from an instance, it doesn't change
|
1876
1962
|
# the configuration of the instance. To change the configuration state
|
1877
1963
|
# of an instance after you disassociate a document, you must create a
|
1878
1964
|
# new document with the desired configuration and associate it with the
|
1879
1965
|
# instance.
|
1880
1966
|
#
|
1881
1967
|
# @option params [String] :name
|
1882
|
-
# The name of the
|
1968
|
+
# The name of the SSM document.
|
1883
1969
|
#
|
1884
1970
|
# @option params [String] :instance_id
|
1885
1971
|
# The ID of the instance.
|
@@ -1906,8 +1992,8 @@ module Aws::SSM
|
|
1906
1992
|
req.send_request(options)
|
1907
1993
|
end
|
1908
1994
|
|
1909
|
-
# Deletes the Systems Manager document
|
1910
|
-
# the document.
|
1995
|
+
# Deletes the Amazon Web Services Systems Manager document (SSM
|
1996
|
+
# document) and all instance associations to the document.
|
1911
1997
|
#
|
1912
1998
|
# Before you delete the document, we recommend that you use
|
1913
1999
|
# DeleteAssociation to disassociate all instances that are associated
|
@@ -1928,8 +2014,8 @@ module Aws::SSM
|
|
1928
2014
|
# Some SSM document types require that you specify a `Force` flag before
|
1929
2015
|
# you can delete the document. For example, you must specify a `Force`
|
1930
2016
|
# flag to delete a document of type `ApplicationConfigurationSchema`.
|
1931
|
-
# You can restrict access to the `Force` flag in an
|
1932
|
-
#
|
2017
|
+
# You can restrict access to the `Force` flag in an Identity and Access
|
2018
|
+
# Management (IAM) policy.
|
1933
2019
|
#
|
1934
2020
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1935
2021
|
#
|
@@ -1967,8 +2053,8 @@ module Aws::SSM
|
|
1967
2053
|
#
|
1968
2054
|
# DisableSchema: If you choose this option, the system ignores all
|
1969
2055
|
# inventory data for the specified version, and any earlier versions. To
|
1970
|
-
# enable this schema again, you must call the `PutInventory`
|
1971
|
-
# a version greater than the disabled version.
|
2056
|
+
# enable this schema again, you must call the `PutInventory` operation
|
2057
|
+
# for a version greater than the disabled version.
|
1972
2058
|
#
|
1973
2059
|
# DeleteSchema: This option deletes the specified custom type from the
|
1974
2060
|
# Inventory service. You can recreate the schema later, if you want.
|
@@ -2153,9 +2239,9 @@ module Aws::SSM
|
|
2153
2239
|
req.send_request(options)
|
2154
2240
|
end
|
2155
2241
|
|
2156
|
-
# Deletes a
|
2242
|
+
# Deletes a resource data sync configuration. After the configuration is
|
2157
2243
|
# deleted, changes to data on managed instances are no longer synced to
|
2158
|
-
# or from the target. Deleting a sync configuration
|
2244
|
+
# or from the target. Deleting a sync configuration doesn't delete
|
2159
2245
|
# data.
|
2160
2246
|
#
|
2161
2247
|
# @option params [required, String] :sync_name
|
@@ -2253,7 +2339,7 @@ module Aws::SSM
|
|
2253
2339
|
#
|
2254
2340
|
# @option params [Boolean] :safe
|
2255
2341
|
# The system checks if the target is being referenced by a task. If the
|
2256
|
-
# target is being referenced, the system returns an error and
|
2342
|
+
# target is being referenced, the system returns an error and doesn't
|
2257
2343
|
# deregister the target from the maintenance window.
|
2258
2344
|
#
|
2259
2345
|
# @return [Types::DeregisterTargetFromMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2318,9 +2404,9 @@ module Aws::SSM
|
|
2318
2404
|
end
|
2319
2405
|
|
2320
2406
|
# Describes details about the activation, such as the date and time the
|
2321
|
-
# activation was created, its expiration date, the
|
2322
|
-
# the instances in the activation, and
|
2323
|
-
# registered by using this activation.
|
2407
|
+
# activation was created, its expiration date, the Identity and Access
|
2408
|
+
# Management (IAM) role assigned to the instances in the activation, and
|
2409
|
+
# the number of instances registered by using this activation.
|
2324
2410
|
#
|
2325
2411
|
# @option params [Array<Types::DescribeActivationsFilter>] :filters
|
2326
2412
|
# A filter to view information about your activations.
|
@@ -2383,12 +2469,12 @@ module Aws::SSM
|
|
2383
2469
|
# Describes the association for the specified target or instance. If you
|
2384
2470
|
# created the association by using the `Targets` parameter, then you
|
2385
2471
|
# must retrieve the association by using the association ID. If you
|
2386
|
-
# created the association by specifying an instance ID and
|
2387
|
-
# Manager document, then you retrieve
|
2388
|
-
# document name and the instance ID.
|
2472
|
+
# created the association by specifying an instance ID and an Amazon Web
|
2473
|
+
# Services Systems Manager document (SSM document), then you retrieve
|
2474
|
+
# the association by specifying the document name and the instance ID.
|
2389
2475
|
#
|
2390
2476
|
# @option params [String] :name
|
2391
|
-
# The name of the
|
2477
|
+
# The name of the SSM document.
|
2392
2478
|
#
|
2393
2479
|
# @option params [String] :instance_id
|
2394
2480
|
# The instance ID.
|
@@ -2473,8 +2559,8 @@ module Aws::SSM
|
|
2473
2559
|
req.send_request(options)
|
2474
2560
|
end
|
2475
2561
|
|
2476
|
-
#
|
2477
|
-
#
|
2562
|
+
# Views information about a specific execution of a specific
|
2563
|
+
# association.
|
2478
2564
|
#
|
2479
2565
|
# @option params [required, String] :association_id
|
2480
2566
|
# The association ID that includes the execution for which you want to
|
@@ -2548,8 +2634,7 @@ module Aws::SSM
|
|
2548
2634
|
req.send_request(options)
|
2549
2635
|
end
|
2550
2636
|
|
2551
|
-
#
|
2552
|
-
# ID.
|
2637
|
+
# Views all executions for a specific association ID.
|
2553
2638
|
#
|
2554
2639
|
# @option params [required, String] :association_id
|
2555
2640
|
# The association ID for which you want to view execution history
|
@@ -2746,8 +2831,8 @@ module Aws::SSM
|
|
2746
2831
|
# next set of results.
|
2747
2832
|
#
|
2748
2833
|
# @option params [Boolean] :reverse_order
|
2749
|
-
#
|
2750
|
-
#
|
2834
|
+
# Indicates whether to list step executions in reverse order by start
|
2835
|
+
# time. The default value is 'false'.
|
2751
2836
|
#
|
2752
2837
|
# @return [Types::DescribeAutomationStepExecutionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2753
2838
|
#
|
@@ -2829,7 +2914,98 @@ module Aws::SSM
|
|
2829
2914
|
# Lists all patches eligible to be included in a patch baseline.
|
2830
2915
|
#
|
2831
2916
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
2832
|
-
#
|
2917
|
+
# Each element in the array is a structure containing a key-value pair.
|
2918
|
+
#
|
2919
|
+
# **Windows Server**
|
2920
|
+
#
|
2921
|
+
# Supported keys for Windows Server instance patches include the
|
2922
|
+
# following:
|
2923
|
+
#
|
2924
|
+
# * <b> <code>PATCH_SET</code> </b>
|
2925
|
+
#
|
2926
|
+
# Sample values: `OS` \| `APPLICATION`
|
2927
|
+
#
|
2928
|
+
# * <b> <code>PRODUCT</code> </b>
|
2929
|
+
#
|
2930
|
+
# Sample values: `WindowsServer2012` \| `Office 2010` \|
|
2931
|
+
# `MicrosoftDefenderAntivirus`
|
2932
|
+
#
|
2933
|
+
# * <b> <code>PRODUCT_FAMILY</code> </b>
|
2934
|
+
#
|
2935
|
+
# Sample values: `Windows` \| `Office`
|
2936
|
+
#
|
2937
|
+
# * <b> <code>MSRC_SEVERITY</code> </b>
|
2938
|
+
#
|
2939
|
+
# Sample values: `ServicePacks` \| `Important` \| `Moderate`
|
2940
|
+
#
|
2941
|
+
# * <b> <code>CLASSIFICATION</code> </b>
|
2942
|
+
#
|
2943
|
+
# Sample values: `ServicePacks` \| `SecurityUpdates` \|
|
2944
|
+
# `DefinitionUpdates`
|
2945
|
+
#
|
2946
|
+
# * <b> <code>PATCH_ID</code> </b>
|
2947
|
+
#
|
2948
|
+
# Sample values: `KB123456` \| `KB4516046`
|
2949
|
+
#
|
2950
|
+
# **Linux**
|
2951
|
+
#
|
2952
|
+
# When specifying filters for Linux patches, you must specify a key-pair
|
2953
|
+
# for `PRODUCT`. For example, using the Command Line Interface (CLI),
|
2954
|
+
# the following command fails:
|
2955
|
+
#
|
2956
|
+
# `aws ssm describe-available-patches --filters
|
2957
|
+
# Key=CVE_ID,Values=CVE-2018-3615`
|
2958
|
+
#
|
2959
|
+
# However, the following command succeeds:
|
2960
|
+
#
|
2961
|
+
# `aws ssm describe-available-patches --filters
|
2962
|
+
# Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615`
|
2963
|
+
#
|
2964
|
+
# Supported keys for Linux instance patches include the following:
|
2965
|
+
#
|
2966
|
+
# * <b> <code>PRODUCT</code> </b>
|
2967
|
+
#
|
2968
|
+
# Sample values: `AmazonLinux2018.03` \| `AmazonLinux2.0`
|
2969
|
+
#
|
2970
|
+
# * <b> <code>NAME</code> </b>
|
2971
|
+
#
|
2972
|
+
# Sample values: `kernel-headers` \| `samba-python` \| `php`
|
2973
|
+
#
|
2974
|
+
# * <b> <code>SEVERITY</code> </b>
|
2975
|
+
#
|
2976
|
+
# Sample values: `Critical` \| `Important` \| `Medium` \| `Low`
|
2977
|
+
#
|
2978
|
+
# * <b> <code>EPOCH</code> </b>
|
2979
|
+
#
|
2980
|
+
# Sample values: `0` \| `1`
|
2981
|
+
#
|
2982
|
+
# * <b> <code>VERSION</code> </b>
|
2983
|
+
#
|
2984
|
+
# Sample values: `78.6.1` \| `4.10.16`
|
2985
|
+
#
|
2986
|
+
# * <b> <code>RELEASE</code> </b>
|
2987
|
+
#
|
2988
|
+
# Sample values: `9.56.amzn1` \| `1.amzn2`
|
2989
|
+
#
|
2990
|
+
# * <b> <code>ARCH</code> </b>
|
2991
|
+
#
|
2992
|
+
# Sample values: `i686` \| `x86_64`
|
2993
|
+
#
|
2994
|
+
# * <b> <code>REPOSITORY</code> </b>
|
2995
|
+
#
|
2996
|
+
# Sample values: `Core` \| `Updates`
|
2997
|
+
#
|
2998
|
+
# * <b> <code>ADVISORY_ID</code> </b>
|
2999
|
+
#
|
3000
|
+
# Sample values: `ALAS-2018-1058` \| `ALAS2-2021-1594`
|
3001
|
+
#
|
3002
|
+
# * <b> <code>CVE_ID</code> </b>
|
3003
|
+
#
|
3004
|
+
# Sample values: `CVE-2018-3615` \| `CVE-2020-1472`
|
3005
|
+
#
|
3006
|
+
# * <b> <code>BUGZILLA_ID</code> </b>
|
3007
|
+
#
|
3008
|
+
# Sample values: `1463241`
|
2833
3009
|
#
|
2834
3010
|
# @option params [Integer] :max_results
|
2835
3011
|
# The maximum number of patches to return (per page).
|
@@ -2898,10 +3074,11 @@ module Aws::SSM
|
|
2898
3074
|
req.send_request(options)
|
2899
3075
|
end
|
2900
3076
|
|
2901
|
-
# Describes the specified Systems Manager document
|
3077
|
+
# Describes the specified Amazon Web Services Systems Manager document
|
3078
|
+
# (SSM document).
|
2902
3079
|
#
|
2903
3080
|
# @option params [required, String] :name
|
2904
|
-
# The name of the
|
3081
|
+
# The name of the SSM document.
|
2905
3082
|
#
|
2906
3083
|
# @option params [String] :document_version
|
2907
3084
|
# The document version for which you want information. Can be a specific
|
@@ -2910,7 +3087,7 @@ module Aws::SSM
|
|
2910
3087
|
# @option params [String] :version_name
|
2911
3088
|
# An optional field specifying the version of the artifact associated
|
2912
3089
|
# with the document. For example, "Release 12, Update 6". This value
|
2913
|
-
# is unique across all versions of a document, and
|
3090
|
+
# is unique across all versions of a document, and can't be changed.
|
2914
3091
|
#
|
2915
3092
|
# @return [Types::DescribeDocumentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2916
3093
|
#
|
@@ -2930,6 +3107,7 @@ module Aws::SSM
|
|
2930
3107
|
# resp.document.hash #=> String
|
2931
3108
|
# resp.document.hash_type #=> String, one of "Sha256", "Sha1"
|
2932
3109
|
# resp.document.name #=> String
|
3110
|
+
# resp.document.display_name #=> String
|
2933
3111
|
# resp.document.version_name #=> String
|
2934
3112
|
# resp.document.owner #=> String
|
2935
3113
|
# resp.document.created_date #=> Time
|
@@ -2944,7 +3122,7 @@ module Aws::SSM
|
|
2944
3122
|
# resp.document.parameters[0].default_value #=> String
|
2945
3123
|
# resp.document.platform_types #=> Array
|
2946
3124
|
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux"
|
2947
|
-
# resp.document.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
3125
|
+
# resp.document.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
2948
3126
|
# resp.document.schema_version #=> String
|
2949
3127
|
# resp.document.latest_version #=> String
|
2950
3128
|
# resp.document.default_version #=> String
|
@@ -2976,10 +3154,10 @@ module Aws::SSM
|
|
2976
3154
|
req.send_request(options)
|
2977
3155
|
end
|
2978
3156
|
|
2979
|
-
# Describes the permissions for a
|
2980
|
-
#
|
2981
|
-
# can either be shared privately (by
|
2982
|
-
# ID) or publicly (*All*).
|
3157
|
+
# Describes the permissions for a Amazon Web Services Systems Manager
|
3158
|
+
# document (SSM document). If you created the document, you are the
|
3159
|
+
# owner. If a document is shared, it can either be shared privately (by
|
3160
|
+
# specifying a user's account ID) or publicly (*All*).
|
2983
3161
|
#
|
2984
3162
|
# @option params [required, String] :name
|
2985
3163
|
# The name of the document for which you are the owner.
|
@@ -3078,8 +3256,8 @@ module Aws::SSM
|
|
3078
3256
|
end
|
3079
3257
|
|
3080
3258
|
# Retrieves the current effective patches (the patch and the approval
|
3081
|
-
# state) for the specified patch baseline.
|
3082
|
-
#
|
3259
|
+
# state) for the specified patch baseline. Applies to patch baselines
|
3260
|
+
# for Windows only.
|
3083
3261
|
#
|
3084
3262
|
# @option params [required, String] :baseline_id
|
3085
3263
|
# The ID of the patch baseline to retrieve the effective patches for.
|
@@ -3209,13 +3387,13 @@ module Aws::SSM
|
|
3209
3387
|
# the instance, instance status, and so on.
|
3210
3388
|
#
|
3211
3389
|
# If you specify one or more instance IDs, it returns information for
|
3212
|
-
# those instances. If you
|
3390
|
+
# those instances. If you don't specify instance IDs, it returns
|
3213
3391
|
# information for all your instances. If you specify an instance ID that
|
3214
|
-
#
|
3392
|
+
# isn't valid or an instance that you don't own, you receive an error.
|
3215
3393
|
#
|
3216
|
-
# <note markdown="1"> The IamRole field for this API
|
3217
|
-
#
|
3218
|
-
#
|
3394
|
+
# <note markdown="1"> The `IamRole` field for this API operation is the Identity and Access
|
3395
|
+
# Management (IAM) role assigned to on-premises instances. This call
|
3396
|
+
# doesn't return the IAM role for EC2 instances.
|
3219
3397
|
#
|
3220
3398
|
# </note>
|
3221
3399
|
#
|
@@ -3309,7 +3487,7 @@ module Aws::SSM
|
|
3309
3487
|
# Retrieves the high-level patch state of one or more instances.
|
3310
3488
|
#
|
3311
3489
|
# @option params [required, Array<String>] :instance_ids
|
3312
|
-
# The ID of the instance
|
3490
|
+
# The ID of the instance for which patch state information should be
|
3313
3491
|
# retrieved.
|
3314
3492
|
#
|
3315
3493
|
# @option params [String] :next_token
|
@@ -3380,11 +3558,11 @@ module Aws::SSM
|
|
3380
3558
|
# @option params [Array<Types::InstancePatchStateFilter>] :filters
|
3381
3559
|
# Each entry in the array is a structure containing:
|
3382
3560
|
#
|
3383
|
-
# Key (string between 1 and 200 characters)
|
3561
|
+
# * Key (string between 1 and 200 characters)
|
3384
3562
|
#
|
3385
|
-
# Values (array containing a single string)
|
3563
|
+
# * Values (array containing a single string)
|
3386
3564
|
#
|
3387
|
-
# Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
|
3565
|
+
# * Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
|
3388
3566
|
#
|
3389
3567
|
# @option params [String] :next_token
|
3390
3568
|
# The token for the next set of items to return. (You received this
|
@@ -3460,9 +3638,26 @@ module Aws::SSM
|
|
3460
3638
|
# retrieved.
|
3461
3639
|
#
|
3462
3640
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3463
|
-
#
|
3464
|
-
#
|
3465
|
-
#
|
3641
|
+
# Each element in the array is a structure containing a key-value pair.
|
3642
|
+
#
|
3643
|
+
# Supported keys for `DescribeInstancePatches`include the following:
|
3644
|
+
#
|
3645
|
+
# * <b> <code>Classification</code> </b>
|
3646
|
+
#
|
3647
|
+
# Sample values: `Security` \| `SecurityUpdates`
|
3648
|
+
#
|
3649
|
+
# * <b> <code>KBId</code> </b>
|
3650
|
+
#
|
3651
|
+
# Sample values: `KB4480056` \| `java-1.7.0-openjdk.x86_64`
|
3652
|
+
#
|
3653
|
+
# * <b> <code>Severity</code> </b>
|
3654
|
+
#
|
3655
|
+
# Sample values: `Important` \| `Medium` \| `Low`
|
3656
|
+
#
|
3657
|
+
# * <b> <code>State</code> </b>
|
3658
|
+
#
|
3659
|
+
# Sample values: `Installed` \| `InstalledOther` \|
|
3660
|
+
# `InstalledPendingReboot`
|
3466
3661
|
#
|
3467
3662
|
# @option params [String] :next_token
|
3468
3663
|
# The token for the next set of items to return. (You received this
|
@@ -3517,7 +3712,7 @@ module Aws::SSM
|
|
3517
3712
|
#
|
3518
3713
|
# @option params [String] :deletion_id
|
3519
3714
|
# Specify the delete inventory ID for which you want information. This
|
3520
|
-
# ID was returned by the `DeleteInventory`
|
3715
|
+
# ID was returned by the `DeleteInventory` operation.
|
3521
3716
|
#
|
3522
3717
|
# @option params [String] :next_token
|
3523
3718
|
# A token to start the list. Use this token to get the next set of
|
@@ -3581,8 +3776,9 @@ module Aws::SSM
|
|
3581
3776
|
#
|
3582
3777
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3583
3778
|
# Optional filters used to scope down the returned task invocations. The
|
3584
|
-
# supported filter key is STATUS with the corresponding values
|
3585
|
-
#
|
3779
|
+
# supported filter key is `STATUS` with the corresponding values
|
3780
|
+
# `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`,
|
3781
|
+
# `CANCELLING`, and `CANCELLED`.
|
3586
3782
|
#
|
3587
3783
|
# @option params [Integer] :max_results
|
3588
3784
|
# The maximum number of items to return for this call. The call also
|
@@ -3650,8 +3846,9 @@ module Aws::SSM
|
|
3650
3846
|
#
|
3651
3847
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3652
3848
|
# Optional filters used to scope down the returned tasks. The supported
|
3653
|
-
# filter key is STATUS with the corresponding values PENDING
|
3654
|
-
#
|
3849
|
+
# filter key is `STATUS` with the corresponding values `PENDING`,
|
3850
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and
|
3851
|
+
# `CANCELLED`.
|
3655
3852
|
#
|
3656
3853
|
# @option params [Integer] :max_results
|
3657
3854
|
# The maximum number of items to return for this call. The call also
|
@@ -3716,12 +3913,12 @@ module Aws::SSM
|
|
3716
3913
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3717
3914
|
# Each entry in the array is a structure containing:
|
3718
3915
|
#
|
3719
|
-
# Key
|
3720
|
-
#
|
3721
|
-
# Values (array of strings, each string is between 1 and 256 characters)
|
3916
|
+
# * Key. A string between 1 and 128 characters. Supported keys include
|
3917
|
+
# `ExecutedBefore` and `ExecutedAfter`.
|
3722
3918
|
#
|
3723
|
-
#
|
3724
|
-
#
|
3919
|
+
# * Values. An array of strings, each between 1 and 256 characters.
|
3920
|
+
# Supported values are date/time strings in a valid ISO 8601 date/time
|
3921
|
+
# format, such as `2021-11-04T05:00:00Z`.
|
3725
3922
|
#
|
3726
3923
|
# @option params [Integer] :max_results
|
3727
3924
|
# The maximum number of items to return for this call. The call also
|
@@ -3780,11 +3977,11 @@ module Aws::SSM
|
|
3780
3977
|
# The ID of the maintenance window to retrieve information about.
|
3781
3978
|
#
|
3782
3979
|
# @option params [Array<Types::Target>] :targets
|
3783
|
-
# The instance ID or key
|
3980
|
+
# The instance ID or key-value pair to retrieve information about.
|
3784
3981
|
#
|
3785
3982
|
# @option params [String] :resource_type
|
3786
3983
|
# The type of resource you want to retrieve information about. For
|
3787
|
-
# example,
|
3984
|
+
# example, `INSTANCE`.
|
3788
3985
|
#
|
3789
3986
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3790
3987
|
# Filters used to limit the range of results. For example, you can limit
|
@@ -3852,8 +4049,8 @@ module Aws::SSM
|
|
3852
4049
|
#
|
3853
4050
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3854
4051
|
# Optional filters that can be used to narrow down the scope of the
|
3855
|
-
# returned window targets. The supported filter keys are Type
|
3856
|
-
# WindowTargetId and OwnerInformation
|
4052
|
+
# returned window targets. The supported filter keys are `Type`,
|
4053
|
+
# `WindowTargetId`, and `OwnerInformation`.
|
3857
4054
|
#
|
3858
4055
|
# @option params [Integer] :max_results
|
3859
4056
|
# The maximum number of items to return for this call. The call also
|
@@ -3911,10 +4108,10 @@ module Aws::SSM
|
|
3911
4108
|
|
3912
4109
|
# Lists the tasks in a maintenance window.
|
3913
4110
|
#
|
3914
|
-
# <note markdown="1"> For maintenance window tasks without a specified target, you
|
4111
|
+
# <note markdown="1"> For maintenance window tasks without a specified target, you can't
|
3915
4112
|
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
3916
4113
|
# system inserts a placeholder value of `1`, which may be reported in
|
3917
|
-
# the response to this command. These values
|
4114
|
+
# the response to this command. These values don't affect the running
|
3918
4115
|
# of your task and can be ignored.
|
3919
4116
|
#
|
3920
4117
|
# </note>
|
@@ -3924,8 +4121,8 @@ module Aws::SSM
|
|
3924
4121
|
#
|
3925
4122
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3926
4123
|
# Optional filters used to narrow down the scope of the returned tasks.
|
3927
|
-
# The supported filter keys are WindowTaskId
|
3928
|
-
# TaskType
|
4124
|
+
# The supported filter keys are `WindowTaskId`, `TaskArn`, `Priority`,
|
4125
|
+
# and `TaskType`.
|
3929
4126
|
#
|
3930
4127
|
# @option params [Integer] :max_results
|
3931
4128
|
# The maximum number of items to return for this call. The call also
|
@@ -3991,12 +4188,12 @@ module Aws::SSM
|
|
3991
4188
|
req.send_request(options)
|
3992
4189
|
end
|
3993
4190
|
|
3994
|
-
# Retrieves the maintenance windows in an
|
4191
|
+
# Retrieves the maintenance windows in an account.
|
3995
4192
|
#
|
3996
4193
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3997
4194
|
# Optional filters used to narrow down the scope of the returned
|
3998
|
-
# maintenance windows. Supported filter keys are
|
3999
|
-
#
|
4195
|
+
# maintenance windows. Supported filter keys are `Name` and `Enabled`.
|
4196
|
+
# For example, `Name=MyMaintenanceWindow` and `Enabled=True`.
|
4000
4197
|
#
|
4001
4198
|
# @option params [Integer] :max_results
|
4002
4199
|
# The maximum number of items to return for this call. The call also
|
@@ -4057,11 +4254,11 @@ module Aws::SSM
|
|
4057
4254
|
# that an instance is associated with.
|
4058
4255
|
#
|
4059
4256
|
# @option params [required, Array<Types::Target>] :targets
|
4060
|
-
# The instance ID or key
|
4257
|
+
# The instance ID or key-value pair to retrieve information about.
|
4061
4258
|
#
|
4062
4259
|
# @option params [required, String] :resource_type
|
4063
4260
|
# The type of resource you want to retrieve information about. For
|
4064
|
-
# example,
|
4261
|
+
# example, `INSTANCE`.
|
4065
4262
|
#
|
4066
4263
|
# @option params [Integer] :max_results
|
4067
4264
|
# The maximum number of items to return for this call. The call also
|
@@ -4109,16 +4306,17 @@ module Aws::SSM
|
|
4109
4306
|
req.send_request(options)
|
4110
4307
|
end
|
4111
4308
|
|
4112
|
-
# Query a set of OpsItems. You must have permission in
|
4309
|
+
# Query a set of OpsItems. You must have permission in Identity and
|
4113
4310
|
# Access Management (IAM) to query a list of OpsItems. For more
|
4114
|
-
# information, see [Getting started with OpsCenter][1] in the *
|
4115
|
-
# Systems Manager User Guide*.
|
4116
|
-
#
|
4117
|
-
# Operations engineers and IT professionals use
|
4118
|
-
# investigate, and remediate
|
4119
|
-
# performance and health of their
|
4120
|
-
#
|
4121
|
-
# User
|
4311
|
+
# information, see [Getting started with OpsCenter][1] in the *Amazon
|
4312
|
+
# Web Services Systems Manager User Guide*.
|
4313
|
+
#
|
4314
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
4315
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
4316
|
+
# operational issues impacting the performance and health of their
|
4317
|
+
# Amazon Web Services resources. For more information, see
|
4318
|
+
# [OpsCenter][2] in the *Amazon Web Services Systems Manager User
|
4319
|
+
# Guide*.
|
4122
4320
|
#
|
4123
4321
|
#
|
4124
4322
|
#
|
@@ -4152,11 +4350,11 @@ module Aws::SSM
|
|
4152
4350
|
#
|
4153
4351
|
# Operations: Equals
|
4154
4352
|
#
|
4155
|
-
# * Key: Title
|
4353
|
+
# * Key: Title*
|
4156
4354
|
#
|
4157
|
-
# Operations: Contains
|
4355
|
+
# Operations: Equals,Contains
|
4158
4356
|
#
|
4159
|
-
# * Key: OperationalData
|
4357
|
+
# * Key: OperationalData**
|
4160
4358
|
#
|
4161
4359
|
# Operations: Equals
|
4162
4360
|
#
|
@@ -4180,7 +4378,11 @@ module Aws::SSM
|
|
4180
4378
|
#
|
4181
4379
|
# Operations: Equals
|
4182
4380
|
#
|
4183
|
-
# *
|
4381
|
+
# *The Equals operator for Title matches the first 100 characters. If
|
4382
|
+
# you specify more than 100 characters, they system returns an error
|
4383
|
+
# that the filter value exceeds the length limit.
|
4384
|
+
#
|
4385
|
+
# **If you filter the response by using the OperationalData operator,
|
4184
4386
|
# specify a key-value pair by using the following JSON format:
|
4185
4387
|
# \\\{"key":"key\_name","value":"a\_value"\\}
|
4186
4388
|
#
|
@@ -4205,7 +4407,7 @@ module Aws::SSM
|
|
4205
4407
|
# resp = client.describe_ops_items({
|
4206
4408
|
# ops_item_filters: [
|
4207
4409
|
# {
|
4208
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup
|
4410
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup, InsightByType
|
4209
4411
|
# values: ["OpsItemFilterValue"], # required
|
4210
4412
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
4211
4413
|
# },
|
@@ -4224,7 +4426,7 @@ module Aws::SSM
|
|
4224
4426
|
# resp.ops_item_summaries[0].last_modified_time #=> Time
|
4225
4427
|
# resp.ops_item_summaries[0].priority #=> Integer
|
4226
4428
|
# resp.ops_item_summaries[0].source #=> String
|
4227
|
-
# resp.ops_item_summaries[0].status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"
|
4429
|
+
# resp.ops_item_summaries[0].status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected", "Closed"
|
4228
4430
|
# resp.ops_item_summaries[0].ops_item_id #=> String
|
4229
4431
|
# resp.ops_item_summaries[0].title #=> String
|
4230
4432
|
# resp.ops_item_summaries[0].operational_data #=> Hash
|
@@ -4249,7 +4451,7 @@ module Aws::SSM
|
|
4249
4451
|
|
4250
4452
|
# Get information about a parameter.
|
4251
4453
|
#
|
4252
|
-
#
|
4454
|
+
# Request results are returned on a best-effort basis. If you specify
|
4253
4455
|
# `MaxResults` in the request, the response includes information up to
|
4254
4456
|
# the limit specified. The number of items returned, however, can be
|
4255
4457
|
# between zero and the value of `MaxResults`. If the service reaches an
|
@@ -4258,8 +4460,6 @@ module Aws::SSM
|
|
4258
4460
|
# You can specify the `NextToken` in a subsequent call to get the next
|
4259
4461
|
# set of results.
|
4260
4462
|
#
|
4261
|
-
# </note>
|
4262
|
-
#
|
4263
4463
|
# @option params [Array<Types::ParametersFilter>] :filters
|
4264
4464
|
# This data type is deprecated. Instead, use `ParameterFilters`.
|
4265
4465
|
#
|
@@ -4330,15 +4530,24 @@ module Aws::SSM
|
|
4330
4530
|
req.send_request(options)
|
4331
4531
|
end
|
4332
4532
|
|
4333
|
-
# Lists the patch baselines in your
|
4533
|
+
# Lists the patch baselines in your account.
|
4334
4534
|
#
|
4335
4535
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
4336
|
-
# Each element in the array is a structure containing
|
4536
|
+
# Each element in the array is a structure containing a key-value pair.
|
4537
|
+
#
|
4538
|
+
# Supported keys for `DescribePatchBaselines` include the following:
|
4539
|
+
#
|
4540
|
+
# * <b> <code>NAME_PREFIX</code> </b>
|
4541
|
+
#
|
4542
|
+
# Sample values: `AWS-` \| `My-`
|
4543
|
+
#
|
4544
|
+
# * <b> <code>OWNER</code> </b>
|
4337
4545
|
#
|
4338
|
-
#
|
4546
|
+
# Sample values: `AWS` \| `Self`
|
4339
4547
|
#
|
4340
|
-
#
|
4341
|
-
#
|
4548
|
+
# * <b> <code>OPERATING_SYSTEM</code> </b>
|
4549
|
+
#
|
4550
|
+
# Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
|
4342
4551
|
#
|
4343
4552
|
# @option params [Integer] :max_results
|
4344
4553
|
# The maximum number of patch baselines to return (per page).
|
@@ -4386,8 +4595,8 @@ module Aws::SSM
|
|
4386
4595
|
req.send_request(options)
|
4387
4596
|
end
|
4388
4597
|
|
4389
|
-
# Returns high-level aggregated patch compliance state for a
|
4390
|
-
# group.
|
4598
|
+
# Returns high-level aggregated patch compliance state information for a
|
4599
|
+
# patch group.
|
4391
4600
|
#
|
4392
4601
|
# @option params [required, String] :patch_group
|
4393
4602
|
# The name of the patch group whose patch snapshot should be retrieved.
|
@@ -4443,24 +4652,17 @@ module Aws::SSM
|
|
4443
4652
|
# The maximum number of patch groups to return (per page).
|
4444
4653
|
#
|
4445
4654
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
4446
|
-
#
|
4447
|
-
# results.
|
4655
|
+
# Each element in the array is a structure containing a key-value pair.
|
4448
4656
|
#
|
4449
|
-
#
|
4657
|
+
# Supported keys for `DescribePatchGroups` include the following:
|
4450
4658
|
#
|
4451
|
-
# *
|
4452
|
-
# accepted.
|
4659
|
+
# * <b> <code>NAME_PREFIX</code> </b>
|
4453
4660
|
#
|
4454
|
-
#
|
4455
|
-
# results for. For valid operating system values, see
|
4456
|
-
# GetDefaultPatchBaselineRequest$OperatingSystem in
|
4457
|
-
# CreatePatchBaseline.
|
4661
|
+
# Sample values: `AWS-` \| `My-`.
|
4458
4662
|
#
|
4459
|
-
#
|
4663
|
+
# * <b> <code>OPERATING_SYSTEM</code> </b>
|
4460
4664
|
#
|
4461
|
-
#
|
4462
|
-
#
|
4463
|
-
# * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
|
4665
|
+
# Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
|
4464
4666
|
#
|
4465
4667
|
# @option params [String] :next_token
|
4466
4668
|
# The token for the next set of items to return. (You received this
|
@@ -4509,7 +4711,7 @@ module Aws::SSM
|
|
4509
4711
|
# Lists the properties of available patches organized by product,
|
4510
4712
|
# product family, classification, severity, and other properties of
|
4511
4713
|
# available patches. You can use the reported properties in the filters
|
4512
|
-
# you specify in requests for
|
4714
|
+
# you specify in requests for operations such as CreatePatchBaseline,
|
4513
4715
|
# UpdatePatchBaseline, DescribeAvailablePatches, and
|
4514
4716
|
# DescribePatchBaselines.
|
4515
4717
|
#
|
@@ -4518,44 +4720,44 @@ module Aws::SSM
|
|
4518
4720
|
#
|
4519
4721
|
# AMAZON\_LINUX
|
4520
4722
|
#
|
4521
|
-
# : Valid properties: PRODUCT
|
4723
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4522
4724
|
#
|
4523
4725
|
# AMAZON\_LINUX\_2
|
4524
4726
|
#
|
4525
|
-
# : Valid properties: PRODUCT
|
4727
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4526
4728
|
#
|
4527
4729
|
# CENTOS
|
4528
4730
|
#
|
4529
|
-
# : Valid properties: PRODUCT
|
4731
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4530
4732
|
#
|
4531
4733
|
# DEBIAN
|
4532
4734
|
#
|
4533
|
-
# : Valid properties: PRODUCT
|
4735
|
+
# : Valid properties: `PRODUCT` \| `PRIORITY`
|
4534
4736
|
#
|
4535
4737
|
# MACOS
|
4536
4738
|
#
|
4537
|
-
# : Valid properties: PRODUCT
|
4739
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION`
|
4538
4740
|
#
|
4539
4741
|
# ORACLE\_LINUX
|
4540
4742
|
#
|
4541
|
-
# : Valid properties: PRODUCT
|
4743
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4542
4744
|
#
|
4543
4745
|
# REDHAT\_ENTERPRISE\_LINUX
|
4544
4746
|
#
|
4545
|
-
# : Valid properties: PRODUCT
|
4747
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4546
4748
|
#
|
4547
4749
|
# SUSE
|
4548
4750
|
#
|
4549
|
-
# : Valid properties: PRODUCT
|
4751
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4550
4752
|
#
|
4551
4753
|
# UBUNTU
|
4552
4754
|
#
|
4553
|
-
# : Valid properties: PRODUCT
|
4755
|
+
# : Valid properties: `PRODUCT` \| `PRIORITY`
|
4554
4756
|
#
|
4555
4757
|
# WINDOWS
|
4556
4758
|
#
|
4557
|
-
# : Valid properties: PRODUCT
|
4558
|
-
#
|
4759
|
+
# : Valid properties: `PRODUCT` \| `PRODUCT_FAMILY` \| `CLASSIFICATION`
|
4760
|
+
# \| `MSRC_SEVERITY`
|
4559
4761
|
#
|
4560
4762
|
# @option params [required, String] :operating_system
|
4561
4763
|
# The operating system type for which to list patches.
|
@@ -4565,8 +4767,8 @@ module Aws::SSM
|
|
4565
4767
|
#
|
4566
4768
|
# @option params [String] :patch_set
|
4567
4769
|
# Indicates whether to list patches for the Windows operating system or
|
4568
|
-
# for Microsoft
|
4569
|
-
# operating systems.
|
4770
|
+
# for applications released by Microsoft. Not applicable for the Linux
|
4771
|
+
# or macOS operating systems.
|
4570
4772
|
#
|
4571
4773
|
# @option params [Integer] :max_results
|
4572
4774
|
# The maximum number of items to return for this call. The call also
|
@@ -4675,12 +4877,43 @@ module Aws::SSM
|
|
4675
4877
|
req.send_request(options)
|
4676
4878
|
end
|
4677
4879
|
|
4880
|
+
# Deletes the association between an OpsItem and a related resource. For
|
4881
|
+
# example, this API operation can delete an Incident Manager incident
|
4882
|
+
# from an OpsItem. Incident Manager is a capability of Amazon Web
|
4883
|
+
# Services Systems Manager.
|
4884
|
+
#
|
4885
|
+
# @option params [required, String] :ops_item_id
|
4886
|
+
# The ID of the OpsItem for which you want to delete an association
|
4887
|
+
# between the OpsItem and a related resource.
|
4888
|
+
#
|
4889
|
+
# @option params [required, String] :association_id
|
4890
|
+
# The ID of the association for which you want to delete an association
|
4891
|
+
# between the OpsItem and a related resource.
|
4892
|
+
#
|
4893
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4894
|
+
#
|
4895
|
+
# @example Request syntax with placeholder values
|
4896
|
+
#
|
4897
|
+
# resp = client.disassociate_ops_item_related_item({
|
4898
|
+
# ops_item_id: "OpsItemId", # required
|
4899
|
+
# association_id: "OpsItemRelatedItemAssociationId", # required
|
4900
|
+
# })
|
4901
|
+
#
|
4902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DisassociateOpsItemRelatedItem AWS API Documentation
|
4903
|
+
#
|
4904
|
+
# @overload disassociate_ops_item_related_item(params = {})
|
4905
|
+
# @param [Hash] params ({})
|
4906
|
+
def disassociate_ops_item_related_item(params = {}, options = {})
|
4907
|
+
req = build_request(:disassociate_ops_item_related_item, params)
|
4908
|
+
req.send_request(options)
|
4909
|
+
end
|
4910
|
+
|
4678
4911
|
# Get detailed information about a particular Automation execution.
|
4679
4912
|
#
|
4680
4913
|
# @option params [required, String] :automation_execution_id
|
4681
4914
|
# The unique identifier for an existing automation execution to examine.
|
4682
4915
|
# The execution ID is returned by StartAutomationExecution when the
|
4683
|
-
# execution of an Automation
|
4916
|
+
# execution of an Automation runbook is initiated.
|
4684
4917
|
#
|
4685
4918
|
# @return [Types::GetAutomationExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4686
4919
|
#
|
@@ -4819,20 +5052,22 @@ module Aws::SSM
|
|
4819
5052
|
req.send_request(options)
|
4820
5053
|
end
|
4821
5054
|
|
4822
|
-
# Gets the state of
|
4823
|
-
#
|
4824
|
-
# returns the state of the calendar at
|
4825
|
-
#
|
4826
|
-
#
|
4827
|
-
#
|
5055
|
+
# Gets the state of a Amazon Web Services Systems Manager change
|
5056
|
+
# calendar at the current time or a specified time. If you specify a
|
5057
|
+
# time, `GetCalendarState` returns the state of the calendar at that
|
5058
|
+
# specific time, and returns the next time that the change calendar
|
5059
|
+
# state will transition. If you don't specify a time,
|
5060
|
+
# `GetCalendarState` uses the current time. Change Calendar entries have
|
5061
|
+
# two possible states: `OPEN` or `CLOSED`.
|
4828
5062
|
#
|
4829
5063
|
# If you specify more than one calendar in a request, the command
|
4830
5064
|
# returns the status of `OPEN` only if all calendars in the request are
|
4831
5065
|
# open. If one or more calendars in the request are closed, the status
|
4832
5066
|
# returned is `CLOSED`.
|
4833
5067
|
#
|
4834
|
-
# For more information about
|
4835
|
-
# Systems Manager
|
5068
|
+
# For more information about Change Calendar, a capability of Amazon Web
|
5069
|
+
# Services Systems Manager, see [Amazon Web Services Systems Manager
|
5070
|
+
# Change Calendar][1] in the *Amazon Web Services Systems Manager User
|
4836
5071
|
# Guide*.
|
4837
5072
|
#
|
4838
5073
|
#
|
@@ -4841,13 +5076,13 @@ module Aws::SSM
|
|
4841
5076
|
#
|
4842
5077
|
# @option params [required, Array<String>] :calendar_names
|
4843
5078
|
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
4844
|
-
# documents that represent the calendar entries for
|
4845
|
-
# get the state.
|
5079
|
+
# documents (SSM documents) that represent the calendar entries for
|
5080
|
+
# which you want to get the state.
|
4846
5081
|
#
|
4847
5082
|
# @option params [String] :at_time
|
4848
5083
|
# (Optional) The specific time for which you want to get calendar state
|
4849
|
-
# information, in [ISO 8601][1] format. If you
|
4850
|
-
# current time is
|
5084
|
+
# information, in [ISO 8601][1] format. If you don't specify a value or
|
5085
|
+
# `AtTime`, the current time is used.
|
4851
5086
|
#
|
4852
5087
|
#
|
4853
5088
|
#
|
@@ -4896,7 +5131,7 @@ module Aws::SSM
|
|
4896
5131
|
# (Required) The ID of the managed instance targeted by the command. A
|
4897
5132
|
# managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2)
|
4898
5133
|
# instance or an instance in your hybrid environment that is configured
|
4899
|
-
# for
|
5134
|
+
# for Amazon Web Services Systems Manager.
|
4900
5135
|
#
|
4901
5136
|
# @option params [String] :plugin_name
|
4902
5137
|
# The name of the plugin for which you want detailed results. If the
|
@@ -4906,7 +5141,8 @@ module Aws::SSM
|
|
4906
5141
|
# details.
|
4907
5142
|
#
|
4908
5143
|
# Plugin names are also referred to as *step names* in Systems Manager
|
4909
|
-
# documents. For example, `aws:RunShellScript` is a
|
5144
|
+
# documents (SSM documents). For example, `aws:RunShellScript` is a
|
5145
|
+
# plugin.
|
4910
5146
|
#
|
4911
5147
|
# To find the `PluginName`, check the document content and find the name
|
4912
5148
|
# of the plugin. Alternatively, use ListCommandInvocations with the
|
@@ -5008,11 +5244,12 @@ module Aws::SSM
|
|
5008
5244
|
req.send_request(options)
|
5009
5245
|
end
|
5010
5246
|
|
5011
|
-
# Retrieves the default patch baseline.
|
5012
|
-
# supports creating multiple default patch baselines. For
|
5013
|
-
# can create a default patch baseline for each operating
|
5247
|
+
# Retrieves the default patch baseline. Amazon Web Services Systems
|
5248
|
+
# Manager supports creating multiple default patch baselines. For
|
5249
|
+
# example, you can create a default patch baseline for each operating
|
5250
|
+
# system.
|
5014
5251
|
#
|
5015
|
-
# If you
|
5252
|
+
# If you don't specify an operating system value, the default patch
|
5016
5253
|
# baseline for Windows is returned.
|
5017
5254
|
#
|
5018
5255
|
# @option params [String] :operating_system
|
@@ -5044,15 +5281,27 @@ module Aws::SSM
|
|
5044
5281
|
end
|
5045
5282
|
|
5046
5283
|
# Retrieves the current snapshot for the patch baseline the instance
|
5047
|
-
# uses. This API is primarily used by the AWS-RunPatchBaseline Systems
|
5048
|
-
# Manager document.
|
5284
|
+
# uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems
|
5285
|
+
# Manager document (SSM document).
|
5286
|
+
#
|
5287
|
+
# <note markdown="1"> If you run the command locally, such as with the Command Line
|
5288
|
+
# Interface (CLI), the system attempts to use your local AWS credentials
|
5289
|
+
# and the operation fails. To avoid this, you can run the command in the
|
5290
|
+
# Amazon Web Services Systems Manager console. Use Run Command, a
|
5291
|
+
# capability of Amazon Web Services Systems Manager, with an SSM
|
5292
|
+
# document that enables you to target an instance with a script or
|
5293
|
+
# command. For example, run the command using the `AWS-RunShellScript`
|
5294
|
+
# document or the `AWS-RunPowerShellScript` document.
|
5295
|
+
#
|
5296
|
+
# </note>
|
5049
5297
|
#
|
5050
5298
|
# @option params [required, String] :instance_id
|
5051
5299
|
# The ID of the instance for which the appropriate patch snapshot should
|
5052
5300
|
# be retrieved.
|
5053
5301
|
#
|
5054
5302
|
# @option params [required, String] :snapshot_id
|
5055
|
-
# The user
|
5303
|
+
# The snapshot ID provided by the user when running
|
5304
|
+
# `AWS-RunPatchBaseline`.
|
5056
5305
|
#
|
5057
5306
|
# @option params [Types::BaselineOverride] :baseline_override
|
5058
5307
|
# Defines the basic information about a patch baseline override.
|
@@ -5128,10 +5377,11 @@ module Aws::SSM
|
|
5128
5377
|
req.send_request(options)
|
5129
5378
|
end
|
5130
5379
|
|
5131
|
-
# Gets the contents of the specified Systems Manager
|
5380
|
+
# Gets the contents of the specified Amazon Web Services Systems Manager
|
5381
|
+
# document (SSM document).
|
5132
5382
|
#
|
5133
5383
|
# @option params [required, String] :name
|
5134
|
-
# The name of the
|
5384
|
+
# The name of the SSM document.
|
5135
5385
|
#
|
5136
5386
|
# @option params [String] :version_name
|
5137
5387
|
# An optional field specifying the version of the artifact associated
|
@@ -5148,6 +5398,8 @@ module Aws::SSM
|
|
5148
5398
|
# @return [Types::GetDocumentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5149
5399
|
#
|
5150
5400
|
# * {Types::GetDocumentResult#name #name} => String
|
5401
|
+
# * {Types::GetDocumentResult#created_date #created_date} => Time
|
5402
|
+
# * {Types::GetDocumentResult#display_name #display_name} => String
|
5151
5403
|
# * {Types::GetDocumentResult#version_name #version_name} => String
|
5152
5404
|
# * {Types::GetDocumentResult#document_version #document_version} => String
|
5153
5405
|
# * {Types::GetDocumentResult#status #status} => String
|
@@ -5171,12 +5423,14 @@ module Aws::SSM
|
|
5171
5423
|
# @example Response structure
|
5172
5424
|
#
|
5173
5425
|
# resp.name #=> String
|
5426
|
+
# resp.created_date #=> Time
|
5427
|
+
# resp.display_name #=> String
|
5174
5428
|
# resp.version_name #=> String
|
5175
5429
|
# resp.document_version #=> String
|
5176
5430
|
# resp.status #=> String, one of "Creating", "Active", "Updating", "Deleting", "Failed"
|
5177
5431
|
# resp.status_information #=> String
|
5178
5432
|
# resp.content #=> String
|
5179
|
-
# resp.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
5433
|
+
# resp.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
5180
5434
|
# resp.document_format #=> String, one of "YAML", "JSON", "TEXT"
|
5181
5435
|
# resp.requires #=> Array
|
5182
5436
|
# resp.requires[0].name #=> String
|
@@ -5572,10 +5826,10 @@ module Aws::SSM
|
|
5572
5826
|
|
5573
5827
|
# Lists the tasks in a maintenance window.
|
5574
5828
|
#
|
5575
|
-
# <note markdown="1"> For maintenance window tasks without a specified target, you
|
5829
|
+
# <note markdown="1"> For maintenance window tasks without a specified target, you can't
|
5576
5830
|
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
5577
5831
|
# system inserts a placeholder value of `1`, which may be reported in
|
5578
|
-
# the response to this command. These values
|
5832
|
+
# the response to this command. These values don't affect the running
|
5579
5833
|
# of your task and can be ignored.
|
5580
5834
|
#
|
5581
5835
|
# </note>
|
@@ -5669,15 +5923,16 @@ module Aws::SSM
|
|
5669
5923
|
end
|
5670
5924
|
|
5671
5925
|
# Get information about an OpsItem by using the ID. You must have
|
5672
|
-
# permission in
|
5673
|
-
#
|
5674
|
-
#
|
5675
|
-
#
|
5676
|
-
# Operations engineers and IT professionals use
|
5677
|
-
# investigate, and remediate
|
5678
|
-
# performance and health of their
|
5679
|
-
#
|
5680
|
-
# User
|
5926
|
+
# permission in Identity and Access Management (IAM) to view information
|
5927
|
+
# about an OpsItem. For more information, see [Getting started with
|
5928
|
+
# OpsCenter][1] in the *Amazon Web Services Systems Manager User Guide*.
|
5929
|
+
#
|
5930
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
5931
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
5932
|
+
# operational issues impacting the performance and health of their
|
5933
|
+
# Amazon Web Services resources. For more information, see
|
5934
|
+
# [OpsCenter][2] in the *Amazon Web Services Systems Manager User
|
5935
|
+
# Guide*.
|
5681
5936
|
#
|
5682
5937
|
#
|
5683
5938
|
#
|
@@ -5710,7 +5965,7 @@ module Aws::SSM
|
|
5710
5965
|
# resp.ops_item.priority #=> Integer
|
5711
5966
|
# resp.ops_item.related_ops_items #=> Array
|
5712
5967
|
# resp.ops_item.related_ops_items[0].ops_item_id #=> String
|
5713
|
-
# resp.ops_item.status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"
|
5968
|
+
# resp.ops_item.status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected", "Closed"
|
5714
5969
|
# resp.ops_item.ops_item_id #=> String
|
5715
5970
|
# resp.ops_item.version #=> String
|
5716
5971
|
# resp.ops_item.title #=> String
|
@@ -5779,20 +6034,25 @@ module Aws::SSM
|
|
5779
6034
|
req.send_request(options)
|
5780
6035
|
end
|
5781
6036
|
|
5782
|
-
# View a summary of
|
6037
|
+
# View a summary of operations metadata (OpsData) based on specified
|
6038
|
+
# filters and aggregators. OpsData can include information about Amazon
|
6039
|
+
# Web Services Systems Manager OpsCenter operational workitems
|
6040
|
+
# (OpsItems) as well as information about any Amazon Web Services
|
6041
|
+
# resource or service configured to report OpsData to Amazon Web
|
6042
|
+
# Services Systems Manager Explorer.
|
5783
6043
|
#
|
5784
6044
|
# @option params [String] :sync_name
|
5785
6045
|
# Specify the name of a resource data sync to get.
|
5786
6046
|
#
|
5787
6047
|
# @option params [Array<Types::OpsFilter>] :filters
|
5788
|
-
# Optional filters used to scope down the returned
|
6048
|
+
# Optional filters used to scope down the returned OpsData.
|
5789
6049
|
#
|
5790
6050
|
# @option params [Array<Types::OpsAggregator>] :aggregators
|
5791
|
-
# Optional aggregators that return counts of
|
6051
|
+
# Optional aggregators that return counts of OpsData based on one or
|
5792
6052
|
# more expressions.
|
5793
6053
|
#
|
5794
6054
|
# @option params [Array<Types::OpsResultAttribute>] :result_attributes
|
5795
|
-
# The
|
6055
|
+
# The OpsData data type to return.
|
5796
6056
|
#
|
5797
6057
|
# @option params [String] :next_token
|
5798
6058
|
# A token to start the list. Use this token to get the next set of
|
@@ -5871,14 +6131,14 @@ module Aws::SSM
|
|
5871
6131
|
end
|
5872
6132
|
|
5873
6133
|
# Get information about a parameter by using the parameter name. Don't
|
5874
|
-
# confuse this API
|
6134
|
+
# confuse this API operation with the GetParameters API operation.
|
5875
6135
|
#
|
5876
6136
|
# @option params [required, String] :name
|
5877
6137
|
# The name of the parameter you want to query.
|
5878
6138
|
#
|
5879
6139
|
# @option params [Boolean] :with_decryption
|
5880
6140
|
# Return decrypted values for secure string parameters. This flag is
|
5881
|
-
# ignored for String and StringList parameter types.
|
6141
|
+
# ignored for `String` and `StringList` parameter types.
|
5882
6142
|
#
|
5883
6143
|
# @return [Types::GetParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5884
6144
|
#
|
@@ -5919,7 +6179,7 @@ module Aws::SSM
|
|
5919
6179
|
#
|
5920
6180
|
# @option params [Boolean] :with_decryption
|
5921
6181
|
# Return decrypted values for secure string parameters. This flag is
|
5922
|
-
# ignored for String and StringList parameter types.
|
6182
|
+
# ignored for `String` and `StringList` parameter types.
|
5923
6183
|
#
|
5924
6184
|
# @option params [Integer] :max_results
|
5925
6185
|
# The maximum number of items to return for this call. The call also
|
@@ -5977,16 +6237,16 @@ module Aws::SSM
|
|
5977
6237
|
req.send_request(options)
|
5978
6238
|
end
|
5979
6239
|
|
5980
|
-
# Get details of a parameter. Don't confuse this API
|
5981
|
-
# GetParameter API
|
6240
|
+
# Get details of a parameter. Don't confuse this API operation with the
|
6241
|
+
# GetParameter API operation.
|
5982
6242
|
#
|
5983
6243
|
# @option params [required, Array<String>] :names
|
5984
6244
|
# Names of the parameters for which you want to query information.
|
5985
6245
|
#
|
5986
6246
|
# @option params [Boolean] :with_decryption
|
5987
6247
|
# Return decrypted secure string value. Return decrypted values for
|
5988
|
-
# secure string parameters. This flag is ignored for String and
|
5989
|
-
# StringList parameter types.
|
6248
|
+
# secure string parameters. This flag is ignored for `String` and
|
6249
|
+
# `StringList` parameter types.
|
5990
6250
|
#
|
5991
6251
|
# @return [Types::GetParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5992
6252
|
#
|
@@ -6027,7 +6287,7 @@ module Aws::SSM
|
|
6027
6287
|
# Retrieve information about one or more parameters in a specific
|
6028
6288
|
# hierarchy.
|
6029
6289
|
#
|
6030
|
-
#
|
6290
|
+
# Request results are returned on a best-effort basis. If you specify
|
6031
6291
|
# `MaxResults` in the request, the response includes information up to
|
6032
6292
|
# the limit specified. The number of items returned, however, can be
|
6033
6293
|
# between zero and the value of `MaxResults`. If the service reaches an
|
@@ -6036,13 +6296,11 @@ module Aws::SSM
|
|
6036
6296
|
# You can specify the `NextToken` in a subsequent call to get the next
|
6037
6297
|
# set of results.
|
6038
6298
|
#
|
6039
|
-
# </note>
|
6040
|
-
#
|
6041
6299
|
# @option params [required, String] :path
|
6042
6300
|
# The hierarchy for the parameter. Hierarchies start with a forward
|
6043
6301
|
# slash (/). The hierachy is the parameter name except the last part of
|
6044
6302
|
# the parameter. For the API call to succeeed, the last part of the
|
6045
|
-
# parameter name
|
6303
|
+
# parameter name can't be in the path. A parameter name hierarchy can
|
6046
6304
|
# have a maximum of 15 levels. Here is an example of a hierarchy:
|
6047
6305
|
# `/Finance/Prod/IAD/WinServ2016/license33 `
|
6048
6306
|
#
|
@@ -6053,7 +6311,7 @@ module Aws::SSM
|
|
6053
6311
|
# that path. For example, if a user has permission to access path `/a`,
|
6054
6312
|
# then the user can also access `/a/b`. Even if a user has explicitly
|
6055
6313
|
# been denied access in IAM for parameter `/a/b`, they can still call
|
6056
|
-
# the GetParametersByPath API
|
6314
|
+
# the GetParametersByPath API operation recursively for `/a` and view
|
6057
6315
|
# `/a/b`.
|
6058
6316
|
#
|
6059
6317
|
# @option params [Array<Types::ParameterStringFilter>] :parameter_filters
|
@@ -6238,31 +6496,41 @@ module Aws::SSM
|
|
6238
6496
|
req.send_request(options)
|
6239
6497
|
end
|
6240
6498
|
|
6241
|
-
# `ServiceSetting` is an account-level setting for an
|
6242
|
-
# setting defines how a user interacts with or
|
6243
|
-
# feature of a service. For example, if an
|
6244
|
-
# the account based on feature or
|
6245
|
-
#
|
6246
|
-
#
|
6247
|
-
#
|
6499
|
+
# `ServiceSetting` is an account-level setting for an Amazon Web
|
6500
|
+
# Services service. This setting defines how a user interacts with or
|
6501
|
+
# uses a service or a feature of a service. For example, if an Amazon
|
6502
|
+
# Web Services service charges money to the account based on feature or
|
6503
|
+
# service usage, then the Amazon Web Services service team might create
|
6504
|
+
# a default setting of `false`. This means the user can't use this
|
6505
|
+
# feature unless they change the setting to `true` and intentionally opt
|
6506
|
+
# in for a paid feature.
|
6248
6507
|
#
|
6249
|
-
# Services map a `SettingId` object to a setting value.
|
6250
|
-
# teams define the default value for a `SettingId`.
|
6251
|
-
# new `SettingId`, but you can overwrite the default
|
6252
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
6253
|
-
# UpdateServiceSetting API
|
6254
|
-
#
|
6255
|
-
# defined by the
|
6508
|
+
# Services map a `SettingId` object to a setting value. Amazon Web
|
6509
|
+
# Services services teams define the default value for a `SettingId`.
|
6510
|
+
# You can't create a new `SettingId`, but you can overwrite the default
|
6511
|
+
# value if you have the `ssm:UpdateServiceSetting` permission for the
|
6512
|
+
# setting. Use the UpdateServiceSetting API operation to change the
|
6513
|
+
# default setting. Or use the ResetServiceSetting to change the value
|
6514
|
+
# back to the original value defined by the Amazon Web Services service
|
6515
|
+
# team.
|
6256
6516
|
#
|
6257
6517
|
# Query the current service setting for the account.
|
6258
6518
|
#
|
6259
6519
|
# @option params [required, String] :setting_id
|
6260
|
-
# The ID of the service setting to get. The setting ID can be
|
6261
|
-
#
|
6262
|
-
#
|
6263
|
-
# `/ssm/
|
6264
|
-
#
|
6265
|
-
# `/ssm/
|
6520
|
+
# The ID of the service setting to get. The setting ID can be one of the
|
6521
|
+
# following.
|
6522
|
+
#
|
6523
|
+
# * `/ssm/automation/customer-script-log-destination`
|
6524
|
+
#
|
6525
|
+
# * `/ssm/automation/customer-script-log-group-name`
|
6526
|
+
#
|
6527
|
+
# * `/ssm/documents/console/public-sharing-permission`
|
6528
|
+
#
|
6529
|
+
# * `/ssm/parameter-store/default-parameter-tier`
|
6530
|
+
#
|
6531
|
+
# * `/ssm/parameter-store/high-throughput-enabled`
|
6532
|
+
#
|
6533
|
+
# * `/ssm/managed-instance/activation-tier`
|
6266
6534
|
#
|
6267
6535
|
# @return [Types::GetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6268
6536
|
#
|
@@ -6293,10 +6561,10 @@ module Aws::SSM
|
|
6293
6561
|
end
|
6294
6562
|
|
6295
6563
|
# A parameter label is a user-defined alias to help you manage different
|
6296
|
-
# versions of a parameter. When you modify a parameter,
|
6297
|
-
# automatically saves a new version and
|
6298
|
-
# one. A label can help you remember
|
6299
|
-
# there are multiple versions.
|
6564
|
+
# versions of a parameter. When you modify a parameter, Amazon Web
|
6565
|
+
# Services Systems Manager automatically saves a new version and
|
6566
|
+
# increments the version number by one. A label can help you remember
|
6567
|
+
# the purpose of a parameter when there are multiple versions.
|
6300
6568
|
#
|
6301
6569
|
# Parameter labels have the following requirements and restrictions.
|
6302
6570
|
#
|
@@ -6319,9 +6587,9 @@ module Aws::SSM
|
|
6319
6587
|
# * Labels can contain letters (case sensitive), numbers, periods (.),
|
6320
6588
|
# hyphens (-), or underscores (\_).
|
6321
6589
|
#
|
6322
|
-
# * Labels can't begin with a number, "aws
|
6590
|
+
# * Labels can't begin with a number, "`aws`" or "`ssm`" (not case
|
6323
6591
|
# sensitive). If a label fails to meet these requirements, then the
|
6324
|
-
# label
|
6592
|
+
# label isn't associated with a parameter and the system displays it
|
6325
6593
|
# in the list of InvalidLabels.
|
6326
6594
|
#
|
6327
6595
|
# @option params [required, String] :name
|
@@ -6439,9 +6707,10 @@ module Aws::SSM
|
|
6439
6707
|
req.send_request(options)
|
6440
6708
|
end
|
6441
6709
|
|
6442
|
-
# Returns all State Manager associations in the current
|
6710
|
+
# Returns all State Manager associations in the current account and
|
6443
6711
|
# Region. You can limit the results to a specific State Manager
|
6444
|
-
# association document or instance by specifying a filter.
|
6712
|
+
# association document or instance by specifying a filter. State Manager
|
6713
|
+
# is a capability of Amazon Web Services Systems Manager.
|
6445
6714
|
#
|
6446
6715
|
# @option params [Array<Types::AssociationFilter>] :association_filter_list
|
6447
6716
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -6450,7 +6719,7 @@ module Aws::SSM
|
|
6450
6719
|
# <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
|
6451
6720
|
# legacy associations created using the `InstanceID` attribute.
|
6452
6721
|
# Associations targeting the instance that are part of the Target
|
6453
|
-
# Attributes `ResourceGroup` or `Tags`
|
6722
|
+
# Attributes `ResourceGroup` or `Tags` aren't returned.
|
6454
6723
|
#
|
6455
6724
|
# </note>
|
6456
6725
|
#
|
@@ -6515,9 +6784,9 @@ module Aws::SSM
|
|
6515
6784
|
|
6516
6785
|
# An invocation is copy of a command sent to a specific instance. A
|
6517
6786
|
# command can apply to one or more instances. A command invocation
|
6518
|
-
# applies to one instance. For example, if a user runs SendCommand
|
6787
|
+
# applies to one instance. For example, if a user runs `SendCommand`
|
6519
6788
|
# against three instances, then a command invocation is created for each
|
6520
|
-
# requested instance ID. ListCommandInvocations provide status about
|
6789
|
+
# requested instance ID. `ListCommandInvocations` provide status about
|
6521
6790
|
# command execution.
|
6522
6791
|
#
|
6523
6792
|
# @option params [String] :command_id
|
@@ -6541,7 +6810,7 @@ module Aws::SSM
|
|
6541
6810
|
#
|
6542
6811
|
# @option params [Boolean] :details
|
6543
6812
|
# (Optional) If set this returns the response of the command executions
|
6544
|
-
# and any command output. The default value is
|
6813
|
+
# and any command output. The default value is `false`.
|
6545
6814
|
#
|
6546
6815
|
# @return [Types::ListCommandInvocationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6547
6816
|
#
|
@@ -6612,7 +6881,7 @@ module Aws::SSM
|
|
6612
6881
|
req.send_request(options)
|
6613
6882
|
end
|
6614
6883
|
|
6615
|
-
# Lists the commands requested by users of the
|
6884
|
+
# Lists the commands requested by users of the account.
|
6616
6885
|
#
|
6617
6886
|
# @option params [String] :command_id
|
6618
6887
|
# (Optional) If provided, lists only the specified command.
|
@@ -6621,7 +6890,7 @@ module Aws::SSM
|
|
6621
6890
|
# (Optional) Lists commands issued against this instance ID.
|
6622
6891
|
#
|
6623
6892
|
# <note markdown="1"> You can't specify an instance ID in the same command that you specify
|
6624
|
-
# `Status` = `Pending`. This is because the command
|
6893
|
+
# `Status` = `Pending`. This is because the command hasn't reached the
|
6625
6894
|
# instance yet.
|
6626
6895
|
#
|
6627
6896
|
# </note>
|
@@ -6709,7 +6978,7 @@ module Aws::SSM
|
|
6709
6978
|
req.send_request(options)
|
6710
6979
|
end
|
6711
6980
|
|
6712
|
-
# For a specified resource ID, this API
|
6981
|
+
# For a specified resource ID, this API operation returns a list of
|
6713
6982
|
# compliance statuses for different resource types. Currently, you can
|
6714
6983
|
# only specify one resource ID per call. List results depend on the
|
6715
6984
|
# criteria specified in the filter.
|
@@ -6949,6 +7218,7 @@ module Aws::SSM
|
|
6949
7218
|
#
|
6950
7219
|
# resp.document_versions #=> Array
|
6951
7220
|
# resp.document_versions[0].name #=> String
|
7221
|
+
# resp.document_versions[0].display_name #=> String
|
6952
7222
|
# resp.document_versions[0].document_version #=> String
|
6953
7223
|
# resp.document_versions[0].version_name #=> String
|
6954
7224
|
# resp.document_versions[0].created_date #=> Time
|
@@ -6968,9 +7238,8 @@ module Aws::SSM
|
|
6968
7238
|
req.send_request(options)
|
6969
7239
|
end
|
6970
7240
|
|
6971
|
-
# Returns all Systems Manager (SSM) documents in the current
|
6972
|
-
#
|
6973
|
-
# filter.
|
7241
|
+
# Returns all Systems Manager (SSM) documents in the current account and
|
7242
|
+
# Region. You can limit the results of this request by using a filter.
|
6974
7243
|
#
|
6975
7244
|
# @option params [Array<Types::DocumentFilter>] :document_filter_list
|
6976
7245
|
# This data type is deprecated. Instead, use `Filters`.
|
@@ -6984,7 +7253,7 @@ module Aws::SSM
|
|
6984
7253
|
# `Key=Owner,Values=Self`. To specify a custom key-value pair, use the
|
6985
7254
|
# format `Key=tag:tagName,Values=valueName`.
|
6986
7255
|
#
|
6987
|
-
# <note markdown="1"> This API
|
7256
|
+
# <note markdown="1"> This API operation only supports filtering documents by using a single
|
6988
7257
|
# tag key and one or more tag values. For example:
|
6989
7258
|
# `Key=tag:tagName,Values=valueName1,valueName2`
|
6990
7259
|
#
|
@@ -7029,12 +7298,14 @@ module Aws::SSM
|
|
7029
7298
|
#
|
7030
7299
|
# resp.document_identifiers #=> Array
|
7031
7300
|
# resp.document_identifiers[0].name #=> String
|
7301
|
+
# resp.document_identifiers[0].created_date #=> Time
|
7302
|
+
# resp.document_identifiers[0].display_name #=> String
|
7032
7303
|
# resp.document_identifiers[0].owner #=> String
|
7033
7304
|
# resp.document_identifiers[0].version_name #=> String
|
7034
7305
|
# resp.document_identifiers[0].platform_types #=> Array
|
7035
7306
|
# resp.document_identifiers[0].platform_types[0] #=> String, one of "Windows", "Linux"
|
7036
7307
|
# resp.document_identifiers[0].document_version #=> String
|
7037
|
-
# resp.document_identifiers[0].document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
7308
|
+
# resp.document_identifiers[0].document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
7038
7309
|
# resp.document_identifiers[0].schema_version #=> String
|
7039
7310
|
# resp.document_identifiers[0].document_format #=> String, one of "YAML", "JSON", "TEXT"
|
7040
7311
|
# resp.document_identifiers[0].target_type #=> String
|
@@ -7084,7 +7355,7 @@ module Aws::SSM
|
|
7084
7355
|
# * {Types::ListInventoryEntriesResult#instance_id #instance_id} => String
|
7085
7356
|
# * {Types::ListInventoryEntriesResult#schema_version #schema_version} => String
|
7086
7357
|
# * {Types::ListInventoryEntriesResult#capture_time #capture_time} => String
|
7087
|
-
# * {Types::ListInventoryEntriesResult#entries #entries} => Array<Hash<String,String>>
|
7358
|
+
# * {Types::ListInventoryEntriesResult#entries #data.entries} => Array<Hash<String,String>> (This method conflicts with a method on Response, call it through the data member)
|
7088
7359
|
# * {Types::ListInventoryEntriesResult#next_token #next_token} => String
|
7089
7360
|
#
|
7090
7361
|
# @example Request syntax with placeholder values
|
@@ -7109,9 +7380,9 @@ module Aws::SSM
|
|
7109
7380
|
# resp.instance_id #=> String
|
7110
7381
|
# resp.schema_version #=> String
|
7111
7382
|
# resp.capture_time #=> String
|
7112
|
-
# resp.entries #=> Array
|
7113
|
-
# resp.entries[0] #=> Hash
|
7114
|
-
# resp.entries[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
7383
|
+
# resp.data.entries #=> Array
|
7384
|
+
# resp.data.entries[0] #=> Hash
|
7385
|
+
# resp.data.entries[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
7115
7386
|
# resp.next_token #=> String
|
7116
7387
|
#
|
7117
7388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries AWS API Documentation
|
@@ -7123,8 +7394,8 @@ module Aws::SSM
|
|
7123
7394
|
req.send_request(options)
|
7124
7395
|
end
|
7125
7396
|
|
7126
|
-
# Returns a list of all OpsItem events in the current
|
7127
|
-
#
|
7397
|
+
# Returns a list of all OpsItem events in the current Region and
|
7398
|
+
# account. You can limit the results to events associated with specific
|
7128
7399
|
# OpsItems by specifying a filter.
|
7129
7400
|
#
|
7130
7401
|
# @option params [Array<Types::OpsItemEventFilter>] :filters
|
@@ -7182,8 +7453,72 @@ module Aws::SSM
|
|
7182
7453
|
req.send_request(options)
|
7183
7454
|
end
|
7184
7455
|
|
7185
|
-
#
|
7186
|
-
#
|
7456
|
+
# Lists all related-item resources associated with an OpsItem.
|
7457
|
+
#
|
7458
|
+
# @option params [String] :ops_item_id
|
7459
|
+
# The ID of the OpsItem for which you want to list all related-item
|
7460
|
+
# resources.
|
7461
|
+
#
|
7462
|
+
# @option params [Array<Types::OpsItemRelatedItemsFilter>] :filters
|
7463
|
+
# One or more OpsItem filters. Use a filter to return a more specific
|
7464
|
+
# list of results.
|
7465
|
+
#
|
7466
|
+
# @option params [Integer] :max_results
|
7467
|
+
# The maximum number of items to return for this call. The call also
|
7468
|
+
# returns a token that you can specify in a subsequent call to get the
|
7469
|
+
# next set of results.
|
7470
|
+
#
|
7471
|
+
# @option params [String] :next_token
|
7472
|
+
# The token for the next set of items to return. (You received this
|
7473
|
+
# token from a previous call.)
|
7474
|
+
#
|
7475
|
+
# @return [Types::ListOpsItemRelatedItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7476
|
+
#
|
7477
|
+
# * {Types::ListOpsItemRelatedItemsResponse#next_token #next_token} => String
|
7478
|
+
# * {Types::ListOpsItemRelatedItemsResponse#summaries #summaries} => Array<Types::OpsItemRelatedItemSummary>
|
7479
|
+
#
|
7480
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7481
|
+
#
|
7482
|
+
# @example Request syntax with placeholder values
|
7483
|
+
#
|
7484
|
+
# resp = client.list_ops_item_related_items({
|
7485
|
+
# ops_item_id: "OpsItemId",
|
7486
|
+
# filters: [
|
7487
|
+
# {
|
7488
|
+
# key: "ResourceType", # required, accepts ResourceType, AssociationId, ResourceUri
|
7489
|
+
# values: ["OpsItemRelatedItemsFilterValue"], # required
|
7490
|
+
# operator: "Equal", # required, accepts Equal
|
7491
|
+
# },
|
7492
|
+
# ],
|
7493
|
+
# max_results: 1,
|
7494
|
+
# next_token: "String",
|
7495
|
+
# })
|
7496
|
+
#
|
7497
|
+
# @example Response structure
|
7498
|
+
#
|
7499
|
+
# resp.next_token #=> String
|
7500
|
+
# resp.summaries #=> Array
|
7501
|
+
# resp.summaries[0].ops_item_id #=> String
|
7502
|
+
# resp.summaries[0].association_id #=> String
|
7503
|
+
# resp.summaries[0].resource_type #=> String
|
7504
|
+
# resp.summaries[0].association_type #=> String
|
7505
|
+
# resp.summaries[0].resource_uri #=> String
|
7506
|
+
# resp.summaries[0].created_by.arn #=> String
|
7507
|
+
# resp.summaries[0].created_time #=> Time
|
7508
|
+
# resp.summaries[0].last_modified_by.arn #=> String
|
7509
|
+
# resp.summaries[0].last_modified_time #=> Time
|
7510
|
+
#
|
7511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemRelatedItems AWS API Documentation
|
7512
|
+
#
|
7513
|
+
# @overload list_ops_item_related_items(params = {})
|
7514
|
+
# @param [Hash] params ({})
|
7515
|
+
def list_ops_item_related_items(params = {}, options = {})
|
7516
|
+
req = build_request(:list_ops_item_related_items, params)
|
7517
|
+
req.send_request(options)
|
7518
|
+
end
|
7519
|
+
|
7520
|
+
# Amazon Web Services Systems Manager calls this API operation when
|
7521
|
+
# displaying all Application Manager OpsMetadata objects or blobs.
|
7187
7522
|
#
|
7188
7523
|
# @option params [Array<Types::OpsMetadataFilter>] :filters
|
7189
7524
|
# One or more filters to limit the number of OpsMetadata objects
|
@@ -7329,7 +7664,7 @@ module Aws::SSM
|
|
7329
7664
|
# View a list of resource data syncs according to the sync type. Specify
|
7330
7665
|
# `SyncToDestination` to view resource data syncs that synchronize data
|
7331
7666
|
# to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data
|
7332
|
-
# syncs from
|
7667
|
+
# syncs from Organizations or from multiple Regions.
|
7333
7668
|
#
|
7334
7669
|
# @option params [String] :next_token
|
7335
7670
|
# A token to start the list. Use this token to get the next set of
|
@@ -7394,6 +7729,9 @@ module Aws::SSM
|
|
7394
7729
|
|
7395
7730
|
# Returns a list of the tags assigned to the specified resource.
|
7396
7731
|
#
|
7732
|
+
# For information about the ID format for each supported resource type,
|
7733
|
+
# see AddTagsToResource.
|
7734
|
+
#
|
7397
7735
|
# @option params [required, String] :resource_type
|
7398
7736
|
# Returns a list of tags for a specific resource type.
|
7399
7737
|
#
|
@@ -7426,10 +7764,11 @@ module Aws::SSM
|
|
7426
7764
|
req.send_request(options)
|
7427
7765
|
end
|
7428
7766
|
|
7429
|
-
# Shares a Systems Manager document
|
7430
|
-
#
|
7431
|
-
#
|
7432
|
-
#
|
7767
|
+
# Shares a Amazon Web Services Systems Manager document (SSM
|
7768
|
+
# document)publicly or privately. If you share a document privately, you
|
7769
|
+
# must specify the Amazon Web Services user account IDs for those people
|
7770
|
+
# who can use the document. If you share a document publicly, you must
|
7771
|
+
# specify *All* as the account ID.
|
7433
7772
|
#
|
7434
7773
|
# @option params [required, String] :name
|
7435
7774
|
# The name of the document that you want to share.
|
@@ -7439,18 +7778,19 @@ module Aws::SSM
|
|
7439
7778
|
# *Share*.
|
7440
7779
|
#
|
7441
7780
|
# @option params [Array<String>] :account_ids_to_add
|
7442
|
-
# The
|
7443
|
-
# account IDs can either be a group of account IDs or
|
7781
|
+
# The Amazon Web Services user accounts that should have access to the
|
7782
|
+
# document. The account IDs can either be a group of account IDs or
|
7783
|
+
# *All*.
|
7444
7784
|
#
|
7445
7785
|
# @option params [Array<String>] :account_ids_to_remove
|
7446
|
-
# The
|
7447
|
-
# document. The
|
7448
|
-
# *All*. This action has a higher
|
7449
|
-
# you specify an account ID to add
|
7450
|
-
# removes access to the document.
|
7786
|
+
# The Amazon Web Services user accounts that should no longer have
|
7787
|
+
# access to the document. The Amazon Web Services user account can
|
7788
|
+
# either be a group of account IDs or *All*. This action has a higher
|
7789
|
+
# priority than *AccountIdsToAdd*. If you specify an account ID to add
|
7790
|
+
# and the same ID to remove, the system removes access to the document.
|
7451
7791
|
#
|
7452
7792
|
# @option params [String] :shared_document_version
|
7453
|
-
# (Optional) The version of the document to share. If it'
|
7793
|
+
# (Optional) The version of the document to share. If it isn't
|
7454
7794
|
# specified, the system choose the `Default` version to share.
|
7455
7795
|
#
|
7456
7796
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -7475,10 +7815,10 @@ module Aws::SSM
|
|
7475
7815
|
end
|
7476
7816
|
|
7477
7817
|
# Registers a compliance type and other compliance details on a
|
7478
|
-
# designated resource. This
|
7479
|
-
# details with a resource. This call overwrites existing
|
7480
|
-
# information on the resource, so you must provide a full
|
7481
|
-
# compliance items each time that you send the request.
|
7818
|
+
# designated resource. This operation lets you register custom
|
7819
|
+
# compliance details with a resource. This call overwrites existing
|
7820
|
+
# compliance information on the resource, so you must provide a full
|
7821
|
+
# list of compliance items each time that you send the request.
|
7482
7822
|
#
|
7483
7823
|
# ComplianceType can be one of the following:
|
7484
7824
|
#
|
@@ -7499,8 +7839,8 @@ module Aws::SSM
|
|
7499
7839
|
#
|
7500
7840
|
# * Severity: A patch severity. For example, `critical`.
|
7501
7841
|
#
|
7502
|
-
# * DocumentName:
|
7503
|
-
# AWS-RunPatchBaseline
|
7842
|
+
# * DocumentName: An SSM document name. For example,
|
7843
|
+
# `AWS-RunPatchBaseline`.
|
7504
7844
|
#
|
7505
7845
|
# * DocumentVersion: An SSM document version number. For example, 4.
|
7506
7846
|
#
|
@@ -7662,9 +8002,9 @@ module Aws::SSM
|
|
7662
8002
|
#
|
7663
8003
|
# * Parameter names are case sensitive.
|
7664
8004
|
#
|
7665
|
-
# * A parameter name must be unique within an
|
8005
|
+
# * A parameter name must be unique within an Region
|
7666
8006
|
#
|
7667
|
-
# * A parameter name can't be prefixed with "aws" or "ssm"
|
8007
|
+
# * A parameter name can't be prefixed with "`aws`" or "`ssm`"
|
7668
8008
|
# (case-insensitive).
|
7669
8009
|
#
|
7670
8010
|
# * Parameter names can include only the following symbols and letters:
|
@@ -7680,11 +8020,11 @@ module Aws::SSM
|
|
7680
8020
|
# levels.
|
7681
8021
|
#
|
7682
8022
|
# For additional information about valid values for parameter names, see
|
7683
|
-
# [Creating Systems Manager parameters][1] in the *
|
7684
|
-
# User Guide*.
|
8023
|
+
# [Creating Systems Manager parameters][1] in the *Amazon Web Services
|
8024
|
+
# Systems Manager User Guide*.
|
7685
8025
|
#
|
7686
8026
|
# <note markdown="1"> The maximum length constraint listed below includes capacity for
|
7687
|
-
# additional system attributes that
|
8027
|
+
# additional system attributes that aren't part of the name. The
|
7688
8028
|
# maximum length for a parameter name, including the full length of the
|
7689
8029
|
# parameter ARN, is 1011 characters. For example, the length of the
|
7690
8030
|
# following parameter name is 65 characters, not 20 characters:
|
@@ -7701,7 +8041,7 @@ module Aws::SSM
|
|
7701
8041
|
# Information about the parameter that you want to add to the system.
|
7702
8042
|
# Optional but recommended.
|
7703
8043
|
#
|
7704
|
-
#
|
8044
|
+
# Don't enter personally identifiable information in this field.
|
7705
8045
|
#
|
7706
8046
|
# @option params [required, String] :value
|
7707
8047
|
# The parameter value that you want to add to the system. Standard
|
@@ -7717,7 +8057,7 @@ module Aws::SSM
|
|
7717
8057
|
# @option params [String] :type
|
7718
8058
|
# The type of parameter that you want to add to the system.
|
7719
8059
|
#
|
7720
|
-
# <note markdown="1"> `SecureString`
|
8060
|
+
# <note markdown="1"> `SecureString` isn't currently supported for CloudFormation
|
7721
8061
|
# templates.
|
7722
8062
|
#
|
7723
8063
|
# </note>
|
@@ -7727,28 +8067,27 @@ module Aws::SSM
|
|
7727
8067
|
# list. If you have a parameter value that requires a comma, then use
|
7728
8068
|
# the `String` data type.
|
7729
8069
|
#
|
7730
|
-
# Specifying a parameter type
|
8070
|
+
# Specifying a parameter type isn't required when updating a parameter.
|
7731
8071
|
# You must specify a parameter type when creating a parameter.
|
7732
8072
|
#
|
7733
8073
|
# @option params [String] :key_id
|
7734
|
-
# The KMS
|
7735
|
-
#
|
7736
|
-
#
|
7737
|
-
#
|
8074
|
+
# The Key Management Service (KMS) ID that you want to use to encrypt a
|
8075
|
+
# parameter. Either the default KMS key automatically assigned to your
|
8076
|
+
# account or a custom key. Required for parameters that use the
|
8077
|
+
# `SecureString` data type.
|
7738
8078
|
#
|
7739
8079
|
# If you don't specify a key ID, the system uses the default key
|
7740
|
-
# associated with your
|
8080
|
+
# associated with your account.
|
7741
8081
|
#
|
7742
|
-
# * To use your default
|
7743
|
-
#
|
7744
|
-
#
|
7745
|
-
# default KMS key.
|
8082
|
+
# * To use your default KMS key, choose the `SecureString` data type,
|
8083
|
+
# and do *not* specify the `Key ID` when you create the parameter. The
|
8084
|
+
# system automatically populates `Key ID` with your default KMS key.
|
7746
8085
|
#
|
7747
8086
|
# * To use a custom KMS key, choose the `SecureString` data type with
|
7748
8087
|
# the `Key ID` parameter.
|
7749
8088
|
#
|
7750
8089
|
# @option params [Boolean] :overwrite
|
7751
|
-
# Overwrite an existing parameter. The default value is
|
8090
|
+
# Overwrite an existing parameter. The default value is `false`.
|
7752
8091
|
#
|
7753
8092
|
# @option params [String] :allowed_pattern
|
7754
8093
|
# A regular expression used to validate the parameter value. For
|
@@ -7761,8 +8100,8 @@ module Aws::SSM
|
|
7761
8100
|
# environment. For example, you might want to tag a Systems Manager
|
7762
8101
|
# parameter to identify the type of resource to which it applies, the
|
7763
8102
|
# environment, or the type of configuration data referenced by the
|
7764
|
-
# parameter. In this case, you could specify the following key
|
7765
|
-
#
|
8103
|
+
# parameter. In this case, you could specify the following key-value
|
8104
|
+
# pairs:
|
7766
8105
|
#
|
7767
8106
|
# * `Key=Resource,Value=S3bucket`
|
7768
8107
|
#
|
@@ -7771,7 +8110,7 @@ module Aws::SSM
|
|
7771
8110
|
# * `Key=ParameterType,Value=LicenseKey`
|
7772
8111
|
#
|
7773
8112
|
# <note markdown="1"> To add tags to an existing Systems Manager parameter, use the
|
7774
|
-
# AddTagsToResource
|
8113
|
+
# AddTagsToResource operation.
|
7775
8114
|
#
|
7776
8115
|
# </note>
|
7777
8116
|
#
|
@@ -7781,15 +8120,15 @@ module Aws::SSM
|
|
7781
8120
|
# Parameter Store offers a standard tier and an advanced tier for
|
7782
8121
|
# parameters. Standard parameters have a content size limit of 4 KB and
|
7783
8122
|
# can't be configured to use parameter policies. You can create a
|
7784
|
-
# maximum of 10,000 standard parameters for each Region in an
|
7785
|
-
#
|
8123
|
+
# maximum of 10,000 standard parameters for each Region in an account.
|
8124
|
+
# Standard parameters are offered at no additional cost.
|
7786
8125
|
#
|
7787
8126
|
# Advanced parameters have a content size limit of 8 KB and can be
|
7788
8127
|
# configured to use parameter policies. You can create a maximum of
|
7789
|
-
# 100,000 advanced parameters for each Region in an
|
7790
|
-
#
|
7791
|
-
#
|
7792
|
-
# User Guide*.
|
8128
|
+
# 100,000 advanced parameters for each Region in an account. Advanced
|
8129
|
+
# parameters incur a charge. For more information, see [Standard and
|
8130
|
+
# advanced parameter tiers][1] in the *Amazon Web Services Systems
|
8131
|
+
# Manager User Guide*.
|
7793
8132
|
#
|
7794
8133
|
# You can change a standard parameter to an advanced parameter any time.
|
7795
8134
|
# But you can't revert an advanced parameter to a standard parameter.
|
@@ -7808,7 +8147,7 @@ module Aws::SSM
|
|
7808
8147
|
# In `PutParameter` requests, you can specify the tier to create the
|
7809
8148
|
# parameter in. Whenever you specify a tier in the request, Parameter
|
7810
8149
|
# Store creates or updates the parameter according to that request.
|
7811
|
-
# However, if you
|
8150
|
+
# However, if you don't specify a tier in a request, Parameter Store
|
7812
8151
|
# assigns the tier based on the current Parameter Store default tier
|
7813
8152
|
# configuration.
|
7814
8153
|
#
|
@@ -7839,12 +8178,12 @@ module Aws::SSM
|
|
7839
8178
|
#
|
7840
8179
|
# * The parameter uses a parameter policy.
|
7841
8180
|
#
|
7842
|
-
# * More than 10,000 parameters already exist in your
|
8181
|
+
# * More than 10,000 parameters already exist in your account in the
|
7843
8182
|
# current Region.
|
7844
8183
|
#
|
7845
8184
|
# For more information about configuring the default tier option, see
|
7846
|
-
# [Specifying a default parameter tier][2] in the *
|
7847
|
-
# User Guide*.
|
8185
|
+
# [Specifying a default parameter tier][2] in the *Amazon Web Services
|
8186
|
+
# Systems Manager User Guide*.
|
7848
8187
|
#
|
7849
8188
|
#
|
7850
8189
|
#
|
@@ -7852,13 +8191,14 @@ module Aws::SSM
|
|
7852
8191
|
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html
|
7853
8192
|
#
|
7854
8193
|
# @option params [String] :policies
|
7855
|
-
# One or more policies to apply to a parameter. This
|
7856
|
-
# array. Parameter Store
|
8194
|
+
# One or more policies to apply to a parameter. This operation takes a
|
8195
|
+
# JSON array. Parameter Store, a capability of Amazon Web Services
|
8196
|
+
# Systems Manager supports the following policy types:
|
7857
8197
|
#
|
7858
8198
|
# Expiration: This policy deletes the parameter after it expires. When
|
7859
8199
|
# you create the policy, you specify the expiration date. You can update
|
7860
8200
|
# the expiration date and time by updating the policy. Updating the
|
7861
|
-
# *parameter*
|
8201
|
+
# *parameter* doesn't affect the expiration date and time. When the
|
7862
8202
|
# expiration time is reached, Parameter Store deletes the parameter.
|
7863
8203
|
#
|
7864
8204
|
# ExpirationNotification: This policy triggers an event in Amazon
|
@@ -7866,10 +8206,10 @@ module Aws::SSM
|
|
7866
8206
|
# this policy, you can receive notification before or after the
|
7867
8207
|
# expiration time is reached, in units of days or hours.
|
7868
8208
|
#
|
7869
|
-
# NoChangeNotification: This policy triggers a CloudWatch event
|
7870
|
-
# parameter
|
7871
|
-
# policy type is useful when, for example, a secret needs to be
|
7872
|
-
# within a period of time, but it
|
8209
|
+
# NoChangeNotification: This policy triggers a CloudWatch Events event
|
8210
|
+
# if a parameter hasn't been modified for a specified period of time.
|
8211
|
+
# This policy type is useful when, for example, a secret needs to be
|
8212
|
+
# changed within a period of time, but it hasn't been changed.
|
7873
8213
|
#
|
7874
8214
|
# All existing policies are preserved until you send new policies or an
|
7875
8215
|
# empty policy. For more information about parameter policies, see
|
@@ -7881,7 +8221,7 @@ module Aws::SSM
|
|
7881
8221
|
#
|
7882
8222
|
# @option params [String] :data_type
|
7883
8223
|
# The data type for a `String` parameter. Supported data types include
|
7884
|
-
# plain text and Amazon Machine Image IDs.
|
8224
|
+
# plain text and Amazon Machine Image (AMI) IDs.
|
7885
8225
|
#
|
7886
8226
|
# **The following data type values are supported.**
|
7887
8227
|
#
|
@@ -7890,15 +8230,15 @@ module Aws::SSM
|
|
7890
8230
|
# * `aws:ec2:image`
|
7891
8231
|
#
|
7892
8232
|
# When you create a `String` parameter and specify `aws:ec2:image`,
|
7893
|
-
# Systems Manager validates the parameter value is
|
7894
|
-
# format, such as `ami-12345abcdeEXAMPLE`, and that the
|
7895
|
-
# available in your
|
7896
|
-
# parameter support for Amazon Machine Image IDs][1] in
|
7897
|
-
# Manager User Guide*.
|
8233
|
+
# Amazon Web Services Systems Manager validates the parameter value is
|
8234
|
+
# in the required format, such as `ami-12345abcdeEXAMPLE`, and that the
|
8235
|
+
# specified AMI is available in your account. For more information, see
|
8236
|
+
# [Native parameter support for Amazon Machine Image (AMI) IDs][1] in
|
8237
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
7898
8238
|
#
|
7899
8239
|
#
|
7900
8240
|
#
|
7901
|
-
# [1]:
|
8241
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html
|
7902
8242
|
#
|
7903
8243
|
# @return [Types::PutParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7904
8244
|
#
|
@@ -7942,9 +8282,9 @@ module Aws::SSM
|
|
7942
8282
|
|
7943
8283
|
# Defines the default patch baseline for the relevant operating system.
|
7944
8284
|
#
|
7945
|
-
# To reset the
|
7946
|
-
#
|
7947
|
-
# CentOS, specify
|
8285
|
+
# To reset the Amazon Web Services-predefined patch baseline as the
|
8286
|
+
# default, specify the full patch baseline Amazon Resource Name (ARN) as
|
8287
|
+
# the baseline ID value. For example, for CentOS, specify
|
7948
8288
|
# `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed`
|
7949
8289
|
# instead of `pb-0574b43a65ea646ed`.
|
7950
8290
|
#
|
@@ -7978,11 +8318,10 @@ module Aws::SSM
|
|
7978
8318
|
# Registers a patch baseline for a patch group.
|
7979
8319
|
#
|
7980
8320
|
# @option params [required, String] :baseline_id
|
7981
|
-
# The ID of the patch baseline to register the patch group
|
8321
|
+
# The ID of the patch baseline to register with the patch group.
|
7982
8322
|
#
|
7983
8323
|
# @option params [required, String] :patch_group
|
7984
|
-
# The name of the patch group
|
7985
|
-
# baseline.
|
8324
|
+
# The name of the patch group to be registered with the patch baseline.
|
7986
8325
|
#
|
7987
8326
|
# @return [Types::RegisterPatchBaselineForPatchGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7988
8327
|
#
|
@@ -8064,16 +8403,17 @@ module Aws::SSM
|
|
8064
8403
|
#
|
8065
8404
|
# For more information about these examples formats, including the best
|
8066
8405
|
# use case for each one, see [Examples: Register targets with a
|
8067
|
-
# maintenance window][1] in the *
|
8406
|
+
# maintenance window][1] in the *Amazon Web Services Systems Manager
|
8407
|
+
# User Guide*.
|
8068
8408
|
#
|
8069
8409
|
#
|
8070
8410
|
#
|
8071
8411
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
|
8072
8412
|
#
|
8073
8413
|
# @option params [String] :owner_information
|
8074
|
-
# User-provided value that will be included in any CloudWatch
|
8075
|
-
# raised while running tasks for these targets in this
|
8076
|
-
# window.
|
8414
|
+
# User-provided value that will be included in any Amazon CloudWatch
|
8415
|
+
# Events events raised while running tasks for these targets in this
|
8416
|
+
# maintenance window.
|
8077
8417
|
#
|
8078
8418
|
# @option params [String] :name
|
8079
8419
|
# An optional name for the target.
|
@@ -8131,10 +8471,10 @@ module Aws::SSM
|
|
8131
8471
|
#
|
8132
8472
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
8133
8473
|
# Command-type tasks. Depending on the task, targets are optional for
|
8134
|
-
# other maintenance window task types (Automation,
|
8135
|
-
#
|
8474
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
8475
|
+
# Functions). For more information about running tasks that don't
|
8136
8476
|
# specify targets, see [Registering maintenance window tasks without
|
8137
|
-
# targets][1] in the *
|
8477
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
8138
8478
|
#
|
8139
8479
|
# </note>
|
8140
8480
|
#
|
@@ -8154,14 +8494,15 @@ module Aws::SSM
|
|
8154
8494
|
# The ARN of the task to run.
|
8155
8495
|
#
|
8156
8496
|
# @option params [String] :service_role_arn
|
8157
|
-
# The ARN of the IAM service role for
|
8158
|
-
#
|
8159
|
-
#
|
8160
|
-
#
|
8161
|
-
# is created when you run
|
8497
|
+
# The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
|
8498
|
+
# Services Systems Manager to assume when running a maintenance window
|
8499
|
+
# task. If you do not specify a service role ARN, Systems Manager uses
|
8500
|
+
# your account's service-linked role. If no service-linked role for
|
8501
|
+
# Systems Manager exists in your account, it is created when you run
|
8502
|
+
# `RegisterTaskWithMaintenanceWindow`.
|
8162
8503
|
#
|
8163
|
-
# For more information, see the following topics in the in the *
|
8164
|
-
# Systems Manager User Guide*\:
|
8504
|
+
# For more information, see the following topics in the in the *Amazon
|
8505
|
+
# Web Services Systems Manager User Guide*\:
|
8165
8506
|
#
|
8166
8507
|
# * [Using service-linked roles for Systems Manager][1]
|
8167
8508
|
#
|
@@ -8201,9 +8542,9 @@ module Aws::SSM
|
|
8201
8542
|
# @option params [String] :max_concurrency
|
8202
8543
|
# The maximum number of targets this task can be run for in parallel.
|
8203
8544
|
#
|
8204
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
8545
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
8205
8546
|
# supply a value for this option. Instead, the system inserts a
|
8206
|
-
# placeholder value of `1`. This value
|
8547
|
+
# placeholder value of `1`. This value doesn't affect the running of
|
8207
8548
|
# your task.
|
8208
8549
|
#
|
8209
8550
|
# </note>
|
@@ -8212,21 +8553,22 @@ module Aws::SSM
|
|
8212
8553
|
# The maximum number of errors allowed before this task stops being
|
8213
8554
|
# scheduled.
|
8214
8555
|
#
|
8215
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
8556
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
8216
8557
|
# supply a value for this option. Instead, the system inserts a
|
8217
|
-
# placeholder value of `1`. This value
|
8558
|
+
# placeholder value of `1`. This value doesn't affect the running of
|
8218
8559
|
# your task.
|
8219
8560
|
#
|
8220
8561
|
# </note>
|
8221
8562
|
#
|
8222
8563
|
# @option params [Types::LoggingInfo] :logging_info
|
8223
|
-
# A structure containing information about an
|
8224
|
-
# instance-level logs to.
|
8225
|
-
#
|
8226
|
-
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an
|
8227
|
-
# logs, instead use the
|
8228
|
-
#
|
8229
|
-
#
|
8564
|
+
# A structure containing information about an Amazon Simple Storage
|
8565
|
+
# Service (Amazon S3) bucket to write instance-level logs to.
|
8566
|
+
#
|
8567
|
+
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
8568
|
+
# Service (Amazon S3) bucket to contain logs, instead use the
|
8569
|
+
# `OutputS3BucketName` and `OutputS3KeyPrefix` options in the
|
8570
|
+
# `TaskInvocationParameters` structure. For information about how Amazon
|
8571
|
+
# Web Services Systems Manager handles these options for the supported
|
8230
8572
|
# maintenance window task types, see
|
8231
8573
|
# MaintenanceWindowTaskInvocationParameters.
|
8232
8574
|
#
|
@@ -8336,9 +8678,10 @@ module Aws::SSM
|
|
8336
8678
|
# @option params [required, String] :resource_type
|
8337
8679
|
# The type of resource from which you want to remove a tag.
|
8338
8680
|
#
|
8339
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
8340
|
-
# managed instances. Specify the name of the managed
|
8341
|
-
# following format: mi-
|
8681
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is only for
|
8682
|
+
# on-premises managed instances. Specify the name of the managed
|
8683
|
+
# instance in the following format: `mi-ID_number `. For example,
|
8684
|
+
# `mi-1a2b3c4d5e6f`.
|
8342
8685
|
#
|
8343
8686
|
# </note>
|
8344
8687
|
#
|
@@ -8362,9 +8705,10 @@ module Aws::SSM
|
|
8362
8705
|
#
|
8363
8706
|
# For the Document and Parameter values, use the name of the resource.
|
8364
8707
|
#
|
8365
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
8366
|
-
# managed instances. Specify the name of the managed
|
8367
|
-
# following format: mi-ID\_number. For example,
|
8708
|
+
# <note markdown="1"> The ManagedInstance type for this API operation is only for
|
8709
|
+
# on-premises managed instances. Specify the name of the managed
|
8710
|
+
# instance in the following format: mi-ID\_number. For example,
|
8711
|
+
# mi-1a2b3c4d5e6f.
|
8368
8712
|
#
|
8369
8713
|
# </note>
|
8370
8714
|
#
|
@@ -8390,32 +8734,41 @@ module Aws::SSM
|
|
8390
8734
|
req.send_request(options)
|
8391
8735
|
end
|
8392
8736
|
|
8393
|
-
# `ServiceSetting` is an account-level setting for an
|
8394
|
-
# setting defines how a user interacts with or
|
8395
|
-
# feature of a service. For example, if an
|
8396
|
-
# the account based on feature or
|
8397
|
-
#
|
8398
|
-
#
|
8399
|
-
#
|
8737
|
+
# `ServiceSetting` is an account-level setting for an Amazon Web
|
8738
|
+
# Services service. This setting defines how a user interacts with or
|
8739
|
+
# uses a service or a feature of a service. For example, if an Amazon
|
8740
|
+
# Web Services service charges money to the account based on feature or
|
8741
|
+
# service usage, then the Amazon Web Services service team might create
|
8742
|
+
# a default setting of "false". This means the user can't use this
|
8743
|
+
# feature unless they change the setting to "true" and intentionally
|
8744
|
+
# opt in for a paid feature.
|
8400
8745
|
#
|
8401
|
-
# Services map a `SettingId` object to a setting value.
|
8402
|
-
# teams define the default value for a `SettingId`.
|
8403
|
-
# new `SettingId`, but you can overwrite the default
|
8404
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
8405
|
-
# GetServiceSetting API
|
8406
|
-
# UpdateServiceSetting API
|
8746
|
+
# Services map a `SettingId` object to a setting value. Amazon Web
|
8747
|
+
# Services services teams define the default value for a `SettingId`.
|
8748
|
+
# You can't create a new `SettingId`, but you can overwrite the default
|
8749
|
+
# value if you have the `ssm:UpdateServiceSetting` permission for the
|
8750
|
+
# setting. Use the GetServiceSetting API operation to view the current
|
8751
|
+
# value. Use the UpdateServiceSetting API operation to change the
|
8752
|
+
# default setting.
|
8407
8753
|
#
|
8408
8754
|
# Reset the service setting for the account to the default value as
|
8409
|
-
# provisioned by the
|
8755
|
+
# provisioned by the Amazon Web Services service team.
|
8410
8756
|
#
|
8411
8757
|
# @option params [required, String] :setting_id
|
8412
8758
|
# The Amazon Resource Name (ARN) of the service setting to reset. The
|
8413
|
-
# setting ID can be
|
8414
|
-
#
|
8415
|
-
# `/ssm/
|
8416
|
-
#
|
8417
|
-
# `/ssm/
|
8418
|
-
#
|
8759
|
+
# setting ID can be one of the following.
|
8760
|
+
#
|
8761
|
+
# * `/ssm/automation/customer-script-log-destination`
|
8762
|
+
#
|
8763
|
+
# * `/ssm/automation/customer-script-log-group-name`
|
8764
|
+
#
|
8765
|
+
# * `/ssm/documents/console/public-sharing-permission`
|
8766
|
+
#
|
8767
|
+
# * `/ssm/parameter-store/default-parameter-tier`
|
8768
|
+
#
|
8769
|
+
# * `/ssm/parameter-store/high-throughput-enabled`
|
8770
|
+
#
|
8771
|
+
# * `/ssm/managed-instance/activation-tier`
|
8419
8772
|
#
|
8420
8773
|
# @return [Types::ResetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8421
8774
|
#
|
@@ -8450,7 +8803,7 @@ module Aws::SSM
|
|
8450
8803
|
# terminated sessions.
|
8451
8804
|
#
|
8452
8805
|
# <note markdown="1"> This command is primarily for use by client machines to automatically
|
8453
|
-
# reconnect during intermittent network issues. It
|
8806
|
+
# reconnect during intermittent network issues. It isn't intended for
|
8454
8807
|
# any other use.
|
8455
8808
|
#
|
8456
8809
|
# </note>
|
@@ -8549,8 +8902,8 @@ module Aws::SSM
|
|
8549
8902
|
# tens, hundreds, or thousands of instances at once.
|
8550
8903
|
#
|
8551
8904
|
# For more information about how to use targets, see [Using targets and
|
8552
|
-
# rate controls to send commands to a fleet][1] in the *
|
8553
|
-
# Manager User Guide*.
|
8905
|
+
# rate controls to send commands to a fleet][1] in the *Amazon Web
|
8906
|
+
# Services Systems Manager User Guide*.
|
8554
8907
|
#
|
8555
8908
|
#
|
8556
8909
|
#
|
@@ -8568,18 +8921,20 @@ module Aws::SSM
|
|
8568
8921
|
# `InstanceIds` option instead.
|
8569
8922
|
#
|
8570
8923
|
# For more information about how to use targets, see [Sending commands
|
8571
|
-
# to a fleet][1] in the *
|
8924
|
+
# to a fleet][1] in the *Amazon Web Services Systems Manager User
|
8925
|
+
# Guide*.
|
8572
8926
|
#
|
8573
8927
|
#
|
8574
8928
|
#
|
8575
8929
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
8576
8930
|
#
|
8577
8931
|
# @option params [required, String] :document_name
|
8578
|
-
# The name of the Systems Manager document
|
8579
|
-
# document
|
8580
|
-
#
|
8581
|
-
# how to use shared documents,
|
8582
|
-
# the *
|
8932
|
+
# The name of the Amazon Web Services Systems Manager document (SSM
|
8933
|
+
# document) to run. This can be a public document or a custom document.
|
8934
|
+
# To run a shared document belonging to another account, specify the
|
8935
|
+
# document ARN. For more information about how to use shared documents,
|
8936
|
+
# see [Using shared SSM documents][1] in the *Amazon Web Services
|
8937
|
+
# Systems Manager User Guide*.
|
8583
8938
|
#
|
8584
8939
|
#
|
8585
8940
|
#
|
@@ -8588,9 +8943,10 @@ module Aws::SSM
|
|
8588
8943
|
# @option params [String] :document_version
|
8589
8944
|
# The SSM document version to use in the request. You can specify
|
8590
8945
|
# $DEFAULT, $LATEST, or a specific version number. If you run commands
|
8591
|
-
# by using the
|
8592
|
-
#
|
8593
|
-
# need to use the backslash.
|
8946
|
+
# by using the Command Line Interface (Amazon Web Services CLI), then
|
8947
|
+
# you must escape the first two options by using a backslash. If you
|
8948
|
+
# specify a version number, then you don't need to use the backslash.
|
8949
|
+
# For example:
|
8594
8950
|
#
|
8595
8951
|
# --document-version "\\$DEFAULT"
|
8596
8952
|
#
|
@@ -8614,8 +8970,8 @@ module Aws::SSM
|
|
8614
8970
|
# </note>
|
8615
8971
|
#
|
8616
8972
|
# @option params [Integer] :timeout_seconds
|
8617
|
-
# If this time is reached and the command
|
8618
|
-
# running, it
|
8973
|
+
# If this time is reached and the command hasn't already started
|
8974
|
+
# running, it won't run.
|
8619
8975
|
#
|
8620
8976
|
# @option params [String] :comment
|
8621
8977
|
# User-specified information about the command, such as a brief
|
@@ -8641,9 +8997,9 @@ module Aws::SSM
|
|
8641
8997
|
# @option params [String] :max_concurrency
|
8642
8998
|
# (Optional) The maximum number of instances that are allowed to run the
|
8643
8999
|
# command at the same time. You can specify a number such as 10 or a
|
8644
|
-
# percentage such as 10%. The default value is 50
|
8645
|
-
# about how to use MaxConcurrency
|
8646
|
-
# in the *
|
9000
|
+
# percentage such as 10%. The default value is `50`. For more
|
9001
|
+
# information about how to use `MaxConcurrency`, see [Using concurrency
|
9002
|
+
# controls][1] in the *Amazon Web Services Systems Manager User Guide*.
|
8647
9003
|
#
|
8648
9004
|
#
|
8649
9005
|
#
|
@@ -8651,27 +9007,29 @@ module Aws::SSM
|
|
8651
9007
|
#
|
8652
9008
|
# @option params [String] :max_errors
|
8653
9009
|
# The maximum number of errors allowed without the command failing. When
|
8654
|
-
# the command fails one more time beyond the value of MaxErrors
|
9010
|
+
# the command fails one more time beyond the value of `MaxErrors`, the
|
8655
9011
|
# systems stops sending the command to additional targets. You can
|
8656
9012
|
# specify a number like 10 or a percentage like 10%. The default value
|
8657
|
-
# is 0
|
8658
|
-
# error controls][1] in the *
|
9013
|
+
# is `0`. For more information about how to use `MaxErrors`, see [Using
|
9014
|
+
# error controls][1] in the *Amazon Web Services Systems Manager User
|
9015
|
+
# Guide*.
|
8659
9016
|
#
|
8660
9017
|
#
|
8661
9018
|
#
|
8662
9019
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
|
8663
9020
|
#
|
8664
9021
|
# @option params [String] :service_role_arn
|
8665
|
-
# The ARN of the IAM service role to
|
8666
|
-
# Notification Service (Amazon SNS)
|
8667
|
-
# commands.
|
9022
|
+
# The ARN of the Identity and Access Management (IAM) service role to
|
9023
|
+
# use to publish Amazon Simple Notification Service (Amazon SNS)
|
9024
|
+
# notifications for Run Command commands.
|
8668
9025
|
#
|
8669
9026
|
# @option params [Types::NotificationConfig] :notification_config
|
8670
9027
|
# Configurations for sending notifications.
|
8671
9028
|
#
|
8672
9029
|
# @option params [Types::CloudWatchOutputConfig] :cloud_watch_output_config
|
8673
|
-
# Enables Systems Manager to send Run Command output
|
8674
|
-
# CloudWatch Logs.
|
9030
|
+
# Enables Amazon Web Services Systems Manager to send Run Command output
|
9031
|
+
# to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web
|
9032
|
+
# Services Systems Manager.
|
8675
9033
|
#
|
8676
9034
|
# @return [Types::SendCommandResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8677
9035
|
#
|
@@ -8759,8 +9117,8 @@ module Aws::SSM
|
|
8759
9117
|
req.send_request(options)
|
8760
9118
|
end
|
8761
9119
|
|
8762
|
-
#
|
8763
|
-
#
|
9120
|
+
# Runs an association immediately and only one time. This operation can
|
9121
|
+
# be helpful when troubleshooting associations.
|
8764
9122
|
#
|
8765
9123
|
# @option params [required, Array<String>] :association_ids
|
8766
9124
|
# The association IDs that you want to run immediately and only one
|
@@ -8783,25 +9141,25 @@ module Aws::SSM
|
|
8783
9141
|
req.send_request(options)
|
8784
9142
|
end
|
8785
9143
|
|
8786
|
-
# Initiates execution of an Automation
|
9144
|
+
# Initiates execution of an Automation runbook.
|
8787
9145
|
#
|
8788
9146
|
# @option params [required, String] :document_name
|
8789
|
-
# The name of the
|
8790
|
-
#
|
8791
|
-
#
|
8792
|
-
#
|
8793
|
-
#
|
9147
|
+
# The name of the SSM document to run. This can be a public document or
|
9148
|
+
# a custom document. To run a shared document belonging to another
|
9149
|
+
# account, specify the document ARN. For more information about how to
|
9150
|
+
# use shared documents, see [Using shared SSM documents][1] in the
|
9151
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
8794
9152
|
#
|
8795
9153
|
#
|
8796
9154
|
#
|
8797
9155
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
8798
9156
|
#
|
8799
9157
|
# @option params [String] :document_version
|
8800
|
-
# The version of the Automation
|
9158
|
+
# The version of the Automation runbook to use for this execution.
|
8801
9159
|
#
|
8802
9160
|
# @option params [Hash<String,Array>] :parameters
|
8803
9161
|
# A key-value map of execution parameters, which match the declared
|
8804
|
-
# parameters in the Automation
|
9162
|
+
# parameters in the Automation runbook.
|
8805
9163
|
#
|
8806
9164
|
# @option params [String] :client_token
|
8807
9165
|
# User-provided idempotency token. The token must be unique, is case
|
@@ -8821,12 +9179,12 @@ module Aws::SSM
|
|
8821
9179
|
#
|
8822
9180
|
# @option params [Array<Hash>] :target_maps
|
8823
9181
|
# A key-value mapping of document parameters to target resources. Both
|
8824
|
-
# Targets and TargetMaps
|
9182
|
+
# Targets and TargetMaps can't be specified together.
|
8825
9183
|
#
|
8826
9184
|
# @option params [String] :max_concurrency
|
8827
9185
|
# The maximum number of targets allowed to run this task in parallel.
|
8828
9186
|
# You can specify a number, such as 10, or a percentage, such as 10%.
|
8829
|
-
# The default value is 10
|
9187
|
+
# The default value is `10`.
|
8830
9188
|
#
|
8831
9189
|
# @option params [String] :max_errors
|
8832
9190
|
# The number of errors that are allowed before the system stops running
|
@@ -8847,11 +9205,11 @@ module Aws::SSM
|
|
8847
9205
|
# executions proceed one at a time.
|
8848
9206
|
#
|
8849
9207
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
8850
|
-
# A location is a combination of
|
8851
|
-
#
|
8852
|
-
#
|
8853
|
-
# [Running Automation workflows in multiple
|
8854
|
-
#
|
9208
|
+
# A location is a combination of Regions and/or accounts where you want
|
9209
|
+
# to run the automation. Use this operation to start an automation in
|
9210
|
+
# multiple Regions and multiple accounts. For more information, see
|
9211
|
+
# [Running Automation workflows in multiple Regions and accounts][1] in
|
9212
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
8855
9213
|
#
|
8856
9214
|
#
|
8857
9215
|
#
|
@@ -8863,14 +9221,14 @@ module Aws::SSM
|
|
8863
9221
|
# a resource in different ways, such as by purpose, owner, or
|
8864
9222
|
# environment. For example, you might want to tag an automation to
|
8865
9223
|
# identify an environment or operating system. In this case, you could
|
8866
|
-
# specify the following key
|
9224
|
+
# specify the following key-value pairs:
|
8867
9225
|
#
|
8868
9226
|
# * `Key=environment,Value=test`
|
8869
9227
|
#
|
8870
9228
|
# * `Key=OS,Value=Windows`
|
8871
9229
|
#
|
8872
9230
|
# <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
|
8873
|
-
#
|
9231
|
+
# operation.
|
8874
9232
|
#
|
8875
9233
|
# </note>
|
8876
9234
|
#
|
@@ -8932,9 +9290,9 @@ module Aws::SSM
|
|
8932
9290
|
req.send_request(options)
|
8933
9291
|
end
|
8934
9292
|
|
8935
|
-
# Creates a change request for Change Manager. The runbooks
|
8936
|
-
#
|
8937
|
-
#
|
9293
|
+
# Creates a change request for Change Manager. The Automation runbooks
|
9294
|
+
# specified in the change request run only after all required approvals
|
9295
|
+
# for the change request have been received.
|
8938
9296
|
#
|
8939
9297
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
8940
9298
|
# The date and time specified in the change request to run the
|
@@ -8967,8 +9325,8 @@ module Aws::SSM
|
|
8967
9325
|
# insensitive, enforces the UUID format, and can't be reused.
|
8968
9326
|
#
|
8969
9327
|
# @option params [required, Array<Types::Runbook>] :runbooks
|
8970
|
-
# Information about the Automation runbooks
|
8971
|
-
#
|
9328
|
+
# Information about the Automation runbooks that are run during the
|
9329
|
+
# runbook workflow.
|
8972
9330
|
#
|
8973
9331
|
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
8974
9332
|
# until all required approvals for the change request have been
|
@@ -8981,7 +9339,7 @@ module Aws::SSM
|
|
8981
9339
|
# maximum of five tags for a change request. Tags enable you to
|
8982
9340
|
# categorize a resource in different ways, such as by purpose, owner, or
|
8983
9341
|
# environment. For example, you might want to tag a change request to
|
8984
|
-
# identify an environment or target
|
9342
|
+
# identify an environment or target Region. In this case, you could
|
8985
9343
|
# specify the following key-value pairs:
|
8986
9344
|
#
|
8987
9345
|
# * `Key=Environment,Value=Production`
|
@@ -9067,13 +9425,15 @@ module Aws::SSM
|
|
9067
9425
|
# Session Manager session. Returns a URL and token that can be used to
|
9068
9426
|
# open a WebSocket connection for sending input and receiving outputs.
|
9069
9427
|
#
|
9070
|
-
# <note markdown="1">
|
9071
|
-
# the Session Manager plugin to be installed on
|
9072
|
-
# making the call. For information, see [Install the
|
9073
|
-
# plugin for the
|
9428
|
+
# <note markdown="1"> Amazon Web Services CLI usage: `start-session` is an interactive
|
9429
|
+
# command that requires the Session Manager plugin to be installed on
|
9430
|
+
# the client machine making the call. For information, see [Install the
|
9431
|
+
# Session Manager plugin for the Amazon Web Services CLI][1] in the
|
9432
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
9074
9433
|
#
|
9075
|
-
#
|
9076
|
-
# supported by
|
9434
|
+
# Amazon Web Services Tools for PowerShell usage: Start-SSMSession
|
9435
|
+
# isn't currently supported by Amazon Web Services Tools for PowerShell
|
9436
|
+
# on Windows local machines.
|
9077
9437
|
#
|
9078
9438
|
# </note>
|
9079
9439
|
#
|
@@ -9154,7 +9514,7 @@ module Aws::SSM
|
|
9154
9514
|
|
9155
9515
|
# Permanently ends a session and closes the data connection between the
|
9156
9516
|
# Session Manager client and SSM Agent on the instance. A terminated
|
9157
|
-
# session
|
9517
|
+
# session isn't be resumed.
|
9158
9518
|
#
|
9159
9519
|
# @option params [required, String] :session_id
|
9160
9520
|
# The ID of the session to terminate.
|
@@ -9185,11 +9545,12 @@ module Aws::SSM
|
|
9185
9545
|
# Remove a label or labels from a parameter.
|
9186
9546
|
#
|
9187
9547
|
# @option params [required, String] :name
|
9188
|
-
# The
|
9548
|
+
# The name of the parameter from which you want to delete one or more
|
9549
|
+
# labels.
|
9189
9550
|
#
|
9190
9551
|
# @option params [required, Integer] :parameter_version
|
9191
9552
|
# The specific version of the parameter which you want to delete one or
|
9192
|
-
# more labels from. If it
|
9553
|
+
# more labels from. If it isn't present, the call will fail.
|
9193
9554
|
#
|
9194
9555
|
# @option params [required, Array<String>] :labels
|
9195
9556
|
# One or more labels to delete from the specified parameter version.
|
@@ -9224,16 +9585,17 @@ module Aws::SSM
|
|
9224
9585
|
end
|
9225
9586
|
|
9226
9587
|
# Updates an association. You can update the association name and
|
9227
|
-
# version, the document version, schedule, parameters, and Amazon
|
9228
|
-
# output.
|
9229
|
-
#
|
9230
|
-
# In order to call this API
|
9231
|
-
# role must be configured with
|
9232
|
-
# DescribeAssociation API
|
9233
|
-
#
|
9234
|
-
# occurred (AccessDeniedException) when
|
9235
|
-
# operation: User: <user_arn>
|
9236
|
-
# ssm:DescribeAssociation on resource:
|
9588
|
+
# version, the document version, schedule, parameters, and Amazon Simple
|
9589
|
+
# Storage Service (Amazon S3) output.
|
9590
|
+
#
|
9591
|
+
# In order to call this API operation, your Identity and Access
|
9592
|
+
# Management (IAM) user account, group, or role must be configured with
|
9593
|
+
# permission to call the DescribeAssociation API operation. If you
|
9594
|
+
# don't have permission to call `DescribeAssociation`, then you receive
|
9595
|
+
# the following error: `An error occurred (AccessDeniedException) when
|
9596
|
+
# calling the UpdateAssociation operation: User: <user_arn> isn't
|
9597
|
+
# authorized to perform: ssm:DescribeAssociation on resource:
|
9598
|
+
# <resource_arn>`
|
9237
9599
|
#
|
9238
9600
|
# When you update an association, the association immediately runs
|
9239
9601
|
# against the specified targets.
|
@@ -9243,8 +9605,9 @@ module Aws::SSM
|
|
9243
9605
|
#
|
9244
9606
|
# @option params [Hash<String,Array>] :parameters
|
9245
9607
|
# The parameters you want to update for the association. If you create a
|
9246
|
-
# parameter using Parameter Store,
|
9247
|
-
#
|
9608
|
+
# parameter using Parameter Store, a capability of Amazon Web Services
|
9609
|
+
# Systems Manager, you can reference the parameter using
|
9610
|
+
# `\{\{ssm:parameter-name\}\}`.
|
9248
9611
|
#
|
9249
9612
|
# @option params [String] :document_version
|
9250
9613
|
# The document version you want update for the association.
|
@@ -9257,16 +9620,16 @@ module Aws::SSM
|
|
9257
9620
|
# An S3 bucket where you want to store the results of this request.
|
9258
9621
|
#
|
9259
9622
|
# @option params [String] :name
|
9260
|
-
# The name of the SSM document
|
9261
|
-
# information for the instance.
|
9262
|
-
# documents.
|
9623
|
+
# The name of the SSM Command document or Automation runbook that
|
9624
|
+
# contains the configuration information for the instance.
|
9263
9625
|
#
|
9264
|
-
# You can specify
|
9265
|
-
# document that is shared with you from another
|
9626
|
+
# You can specify Amazon Web Services-predefined documents, documents
|
9627
|
+
# you created, or a document that is shared with you from another
|
9628
|
+
# account.
|
9266
9629
|
#
|
9267
|
-
# For SSM
|
9268
|
-
# you must specify the complete SSM document ARN,
|
9269
|
-
# format:
|
9630
|
+
# For Systems Manager document (SSM document) that are shared with you
|
9631
|
+
# from other accounts, you must specify the complete SSM document ARN,
|
9632
|
+
# in the following format:
|
9270
9633
|
#
|
9271
9634
|
# `arn:aws:ssm:region:account-id:document/document-name `
|
9272
9635
|
#
|
@@ -9274,9 +9637,9 @@ module Aws::SSM
|
|
9274
9637
|
#
|
9275
9638
|
# `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
|
9276
9639
|
#
|
9277
|
-
# For
|
9278
|
-
# account, you only need to specify the document name.
|
9279
|
-
# `AWS-ApplyPatchBaseline` or `My-Document`.
|
9640
|
+
# For Amazon Web Services-predefined documents and SSM documents you
|
9641
|
+
# created in your account, you only need to specify the document name.
|
9642
|
+
# For example, `AWS-ApplyPatchBaseline` or `My-Document`.
|
9280
9643
|
#
|
9281
9644
|
# @option params [Array<Types::Target>] :targets
|
9282
9645
|
# The targets of the association.
|
@@ -9292,8 +9655,9 @@ module Aws::SSM
|
|
9292
9655
|
#
|
9293
9656
|
# @option params [String] :automation_target_parameter_name
|
9294
9657
|
# Specify the target for the association. This target is required for
|
9295
|
-
# associations that use an Automation
|
9296
|
-
# using rate controls.
|
9658
|
+
# associations that use an Automation runbook and target resources by
|
9659
|
+
# using rate controls. Automation is a capability of Amazon Web Services
|
9660
|
+
# Systems Manager.
|
9297
9661
|
#
|
9298
9662
|
# @option params [String] :max_errors
|
9299
9663
|
# The number of errors that are allowed before the system stops sending
|
@@ -9303,13 +9667,13 @@ module Aws::SSM
|
|
9303
9667
|
# system stops sending requests when the fourth error is received. If
|
9304
9668
|
# you specify 0, then the system stops sending requests after the first
|
9305
9669
|
# error is returned. If you run an association on 50 instances and set
|
9306
|
-
# MaxError to 10%, then the system stops sending the request when the
|
9670
|
+
# `MaxError` to 10%, then the system stops sending the request when the
|
9307
9671
|
# sixth error is received.
|
9308
9672
|
#
|
9309
|
-
# Executions that are already running an association when MaxErrors is
|
9673
|
+
# Executions that are already running an association when `MaxErrors` is
|
9310
9674
|
# reached are allowed to complete, but some of these executions may fail
|
9311
9675
|
# as well. If you need to ensure that there won't be more than
|
9312
|
-
# max-errors failed executions, set MaxConcurrency to 1 so that
|
9676
|
+
# max-errors failed executions, set `MaxConcurrency` to 1 so that
|
9313
9677
|
# executions proceed one at a time.
|
9314
9678
|
#
|
9315
9679
|
# @option params [String] :max_concurrency
|
@@ -9319,10 +9683,10 @@ module Aws::SSM
|
|
9319
9683
|
# means all targets run the association at the same time.
|
9320
9684
|
#
|
9321
9685
|
# If a new instance starts and attempts to run an association while
|
9322
|
-
# Systems Manager is running MaxConcurrency associations, the
|
9686
|
+
# Systems Manager is running `MaxConcurrency` associations, the
|
9323
9687
|
# association is allowed to run. During the next association interval,
|
9324
9688
|
# the new instance will process its association within the limit
|
9325
|
-
# specified for MaxConcurrency
|
9689
|
+
# specified for `MaxConcurrency`.
|
9326
9690
|
#
|
9327
9691
|
# @option params [String] :compliance_severity
|
9328
9692
|
# The severity level to assign to the association.
|
@@ -9336,9 +9700,10 @@ module Aws::SSM
|
|
9336
9700
|
# the association is `NON-COMPLIANT`.
|
9337
9701
|
#
|
9338
9702
|
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
9339
|
-
# for the PutComplianceItems API
|
9340
|
-
#
|
9341
|
-
#
|
9703
|
+
# for the PutComplianceItems API operation. In this case, compliance
|
9704
|
+
# data isn't managed by State Manager, a capability of Amazon Web
|
9705
|
+
# Services Systems Manager. It is managed by your direct call to the
|
9706
|
+
# PutComplianceItems API operation.
|
9342
9707
|
#
|
9343
9708
|
# By default, all associations use `AUTO` mode.
|
9344
9709
|
#
|
@@ -9346,7 +9711,7 @@ module Aws::SSM
|
|
9346
9711
|
# By default, when you update an association, the system runs it
|
9347
9712
|
# immediately after it is updated and then according to the schedule you
|
9348
9713
|
# specified. Specify this option if you don't want an association to
|
9349
|
-
# run immediately after you update it. This parameter
|
9714
|
+
# run immediately after you update it. This parameter isn't supported
|
9350
9715
|
# for rate expressions.
|
9351
9716
|
#
|
9352
9717
|
# Also, if you specified this option when you created the association,
|
@@ -9357,19 +9722,19 @@ module Aws::SSM
|
|
9357
9722
|
# interval specified.
|
9358
9723
|
#
|
9359
9724
|
# @option params [Array<String>] :calendar_names
|
9360
|
-
# The names or Amazon Resource Names (ARNs) of the
|
9361
|
-
#
|
9362
|
-
#
|
9363
|
-
#
|
9725
|
+
# The names or Amazon Resource Names (ARNs) of the Change Calendar type
|
9726
|
+
# documents you want to gate your associations under. The associations
|
9727
|
+
# only run when that change calendar is open. For more information, see
|
9728
|
+
# [Amazon Web Services Systems Manager Change Calendar][1].
|
9364
9729
|
#
|
9365
9730
|
#
|
9366
9731
|
#
|
9367
9732
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
9368
9733
|
#
|
9369
9734
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
9370
|
-
# A location is a combination of
|
9371
|
-
#
|
9372
|
-
#
|
9735
|
+
# A location is a combination of Regions and accounts where you want to
|
9736
|
+
# run the association. Use this action to update an association in
|
9737
|
+
# multiple Regions and multiple accounts.
|
9373
9738
|
#
|
9374
9739
|
# @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9375
9740
|
#
|
@@ -9475,11 +9840,11 @@ module Aws::SSM
|
|
9475
9840
|
req.send_request(options)
|
9476
9841
|
end
|
9477
9842
|
|
9478
|
-
# Updates the status of the Systems Manager document
|
9479
|
-
# specified instance.
|
9843
|
+
# Updates the status of the Amazon Web Services Systems Manager document
|
9844
|
+
# (SSM document) associated with the specified instance.
|
9480
9845
|
#
|
9481
9846
|
# @option params [required, String] :name
|
9482
|
-
# The name of the
|
9847
|
+
# The name of the SSM document.
|
9483
9848
|
#
|
9484
9849
|
# @option params [required, String] :instance_id
|
9485
9850
|
# The ID of the instance.
|
@@ -9567,16 +9932,22 @@ module Aws::SSM
|
|
9567
9932
|
# A valid JSON or YAML string.
|
9568
9933
|
#
|
9569
9934
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
9570
|
-
# A list of key
|
9571
|
-
#
|
9935
|
+
# A list of key-value pairs that describe attachments to a version of a
|
9936
|
+
# document.
|
9572
9937
|
#
|
9573
9938
|
# @option params [required, String] :name
|
9574
|
-
# The name of the document that you want to update.
|
9939
|
+
# The name of the SSM document that you want to update.
|
9940
|
+
#
|
9941
|
+
# @option params [String] :display_name
|
9942
|
+
# The friendly name of the SSM document that you want to update. This
|
9943
|
+
# value can differ for each version of the document. If you don't
|
9944
|
+
# specify a value for this parameter in your request, the existing value
|
9945
|
+
# is applied to the new document version.
|
9575
9946
|
#
|
9576
9947
|
# @option params [String] :version_name
|
9577
9948
|
# An optional field specifying the version of the artifact you are
|
9578
9949
|
# updating with the document. For example, "Release 12, Update 6".
|
9579
|
-
# This value is unique across all versions of a document, and
|
9950
|
+
# This value is unique across all versions of a document, and can't be
|
9580
9951
|
# changed.
|
9581
9952
|
#
|
9582
9953
|
# @option params [String] :document_version
|
@@ -9608,6 +9979,7 @@ module Aws::SSM
|
|
9608
9979
|
# },
|
9609
9980
|
# ],
|
9610
9981
|
# name: "DocumentName", # required
|
9982
|
+
# display_name: "DocumentDisplayName",
|
9611
9983
|
# version_name: "DocumentVersionName",
|
9612
9984
|
# document_version: "DocumentVersion",
|
9613
9985
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
@@ -9620,6 +9992,7 @@ module Aws::SSM
|
|
9620
9992
|
# resp.document_description.hash #=> String
|
9621
9993
|
# resp.document_description.hash_type #=> String, one of "Sha256", "Sha1"
|
9622
9994
|
# resp.document_description.name #=> String
|
9995
|
+
# resp.document_description.display_name #=> String
|
9623
9996
|
# resp.document_description.version_name #=> String
|
9624
9997
|
# resp.document_description.owner #=> String
|
9625
9998
|
# resp.document_description.created_date #=> Time
|
@@ -9634,7 +10007,7 @@ module Aws::SSM
|
|
9634
10007
|
# resp.document_description.parameters[0].default_value #=> String
|
9635
10008
|
# resp.document_description.platform_types #=> Array
|
9636
10009
|
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
9637
|
-
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
10010
|
+
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate"
|
9638
10011
|
# resp.document_description.schema_version #=> String
|
9639
10012
|
# resp.document_description.latest_version #=> String
|
9640
10013
|
# resp.document_description.default_version #=> String
|
@@ -9775,7 +10148,7 @@ module Aws::SSM
|
|
9775
10148
|
#
|
9776
10149
|
# @option params [String] :end_date
|
9777
10150
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
9778
|
-
# maintenance window to become inactive. EndDate allows you to set a
|
10151
|
+
# maintenance window to become inactive. `EndDate` allows you to set a
|
9779
10152
|
# date and time in the future when the maintenance window will no longer
|
9780
10153
|
# run.
|
9781
10154
|
#
|
@@ -9794,7 +10167,7 @@ module Aws::SSM
|
|
9794
10167
|
# [1]: https://www.iana.org/time-zones
|
9795
10168
|
#
|
9796
10169
|
# @option params [Integer] :schedule_offset
|
9797
|
-
# The number of days to wait after the date and time specified by a
|
10170
|
+
# The number of days to wait after the date and time specified by a cron
|
9798
10171
|
# expression before running the maintenance window.
|
9799
10172
|
#
|
9800
10173
|
# For example, the following cron expression schedules a maintenance
|
@@ -9810,7 +10183,8 @@ module Aws::SSM
|
|
9810
10183
|
#
|
9811
10184
|
# @option params [Integer] :cutoff
|
9812
10185
|
# The number of hours before the end of the maintenance window that
|
9813
|
-
# Systems Manager stops scheduling new tasks for
|
10186
|
+
# Amazon Web Services Systems Manager stops scheduling new tasks for
|
10187
|
+
# execution.
|
9814
10188
|
#
|
9815
10189
|
# @option params [Boolean] :allow_unassociated_targets
|
9816
10190
|
# Whether targets must be registered with the maintenance window before
|
@@ -9820,9 +10194,9 @@ module Aws::SSM
|
|
9820
10194
|
# Whether the maintenance window is enabled.
|
9821
10195
|
#
|
9822
10196
|
# @option params [Boolean] :replace
|
9823
|
-
# If True
|
9824
|
-
# CreateMaintenanceWindow
|
9825
|
-
# Optional fields that
|
10197
|
+
# If `True`, then all fields that are required by the
|
10198
|
+
# CreateMaintenanceWindow operation are also required for this API
|
10199
|
+
# request. Optional fields that aren't specified are set to null.
|
9826
10200
|
#
|
9827
10201
|
# @return [Types::UpdateMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9828
10202
|
#
|
@@ -9898,7 +10272,7 @@ module Aws::SSM
|
|
9898
10272
|
# types are ID target, Tag target, and resource group. For more
|
9899
10273
|
# information, see Target.
|
9900
10274
|
#
|
9901
|
-
# <note markdown="1"> If a parameter is null, then the corresponding field
|
10275
|
+
# <note markdown="1"> If a parameter is null, then the corresponding field isn't modified.
|
9902
10276
|
#
|
9903
10277
|
# </note>
|
9904
10278
|
#
|
@@ -9912,9 +10286,9 @@ module Aws::SSM
|
|
9912
10286
|
# The targets to add or replace.
|
9913
10287
|
#
|
9914
10288
|
# @option params [String] :owner_information
|
9915
|
-
# User-provided value that will be included in any CloudWatch
|
9916
|
-
# raised while running tasks for these targets in this
|
9917
|
-
# window.
|
10289
|
+
# User-provided value that will be included in any Amazon CloudWatch
|
10290
|
+
# Events events raised while running tasks for these targets in this
|
10291
|
+
# maintenance window.
|
9918
10292
|
#
|
9919
10293
|
# @option params [String] :name
|
9920
10294
|
# A name for the update.
|
@@ -9923,9 +10297,10 @@ module Aws::SSM
|
|
9923
10297
|
# An optional description for the update.
|
9924
10298
|
#
|
9925
10299
|
# @option params [Boolean] :replace
|
9926
|
-
# If True
|
9927
|
-
# RegisterTargetWithMaintenanceWindow
|
9928
|
-
# API request. Optional fields that
|
10300
|
+
# If `True`, then all fields that are required by the
|
10301
|
+
# RegisterTargetWithMaintenanceWindow operation are also required for
|
10302
|
+
# this API request. Optional fields that aren't specified are set to
|
10303
|
+
# null.
|
9929
10304
|
#
|
9930
10305
|
# @return [Types::UpdateMaintenanceWindowTargetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9931
10306
|
#
|
@@ -9977,38 +10352,38 @@ module Aws::SSM
|
|
9977
10352
|
# Modifies a task assigned to a maintenance window. You can't change
|
9978
10353
|
# the task type, but you can change the following values:
|
9979
10354
|
#
|
9980
|
-
# * TaskARN
|
9981
|
-
# AWS-RunPowerShellScript to AWS-RunShellScript
|
10355
|
+
# * `TaskARN`. For example, you can change a `RUN_COMMAND` task from
|
10356
|
+
# `AWS-RunPowerShellScript` to `AWS-RunShellScript`.
|
9982
10357
|
#
|
9983
|
-
# * ServiceRoleArn
|
10358
|
+
# * `ServiceRoleArn`
|
9984
10359
|
#
|
9985
|
-
# * TaskInvocationParameters
|
10360
|
+
# * `TaskInvocationParameters`
|
9986
10361
|
#
|
9987
|
-
# * Priority
|
10362
|
+
# * `Priority`
|
9988
10363
|
#
|
9989
|
-
# * MaxConcurrency
|
10364
|
+
# * `MaxConcurrency`
|
9990
10365
|
#
|
9991
|
-
# * MaxErrors
|
10366
|
+
# * `MaxErrors`
|
9992
10367
|
#
|
9993
10368
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
9994
10369
|
# Command-type tasks. Depending on the task, targets are optional for
|
9995
|
-
# other maintenance window task types (Automation,
|
9996
|
-
#
|
10370
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
10371
|
+
# Functions). For more information about running tasks that don't
|
9997
10372
|
# specify targets, see [Registering maintenance window tasks without
|
9998
|
-
# targets][1] in the *
|
10373
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
9999
10374
|
#
|
10000
10375
|
# </note>
|
10001
10376
|
#
|
10002
10377
|
# If the value for a parameter in `UpdateMaintenanceWindowTask` is null,
|
10003
|
-
# then the corresponding field
|
10378
|
+
# then the corresponding field isn't modified. If you set `Replace` to
|
10004
10379
|
# true, then all fields required by the
|
10005
|
-
# RegisterTaskWithMaintenanceWindow
|
10380
|
+
# RegisterTaskWithMaintenanceWindow operation are required for this
|
10006
10381
|
# request. Optional fields that aren't specified are set to null.
|
10007
10382
|
#
|
10008
10383
|
# When you update a maintenance window task that has options specified
|
10009
10384
|
# in `TaskInvocationParameters`, you must provide again all the
|
10010
10385
|
# `TaskInvocationParameters` values that you want to retain. The values
|
10011
|
-
# you
|
10386
|
+
# you don't specify again are removed. For example, suppose that when
|
10012
10387
|
# you registered a Run Command task, you specified
|
10013
10388
|
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
10014
10389
|
# and `OutputS3BucketName`. If you update the maintenance window task
|
@@ -10027,15 +10402,16 @@ module Aws::SSM
|
|
10027
10402
|
#
|
10028
10403
|
# @option params [Array<Types::Target>] :targets
|
10029
10404
|
# The targets (either instances or tags) to modify. Instances are
|
10030
|
-
# specified using
|
10031
|
-
# Tags are specified
|
10405
|
+
# specified using the format
|
10406
|
+
# `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified
|
10407
|
+
# using the format ` Key=tag_name,Values=tag_value`.
|
10032
10408
|
#
|
10033
10409
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
10034
10410
|
# Command-type tasks. Depending on the task, targets are optional for
|
10035
|
-
# other maintenance window task types (Automation,
|
10036
|
-
#
|
10411
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
10412
|
+
# Functions). For more information about running tasks that don't
|
10037
10413
|
# specify targets, see [Registering maintenance window tasks without
|
10038
|
-
# targets][1] in the *
|
10414
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
10039
10415
|
#
|
10040
10416
|
# </note>
|
10041
10417
|
#
|
@@ -10047,14 +10423,15 @@ module Aws::SSM
|
|
10047
10423
|
# The task ARN to modify.
|
10048
10424
|
#
|
10049
10425
|
# @option params [String] :service_role_arn
|
10050
|
-
# The ARN of the IAM service role for
|
10051
|
-
#
|
10052
|
-
#
|
10053
|
-
#
|
10054
|
-
# is created when you run
|
10426
|
+
# The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
|
10427
|
+
# Services Systems Manager to assume when running a maintenance window
|
10428
|
+
# task. If you do not specify a service role ARN, Systems Manager uses
|
10429
|
+
# your account's service-linked role. If no service-linked role for
|
10430
|
+
# Systems Manager exists in your account, it is created when you run
|
10431
|
+
# `RegisterTaskWithMaintenanceWindow`.
|
10055
10432
|
#
|
10056
|
-
# For more information, see the following topics in the in the *
|
10057
|
-
# Systems Manager User Guide*\:
|
10433
|
+
# For more information, see the following topics in the in the *Amazon
|
10434
|
+
# Web Services Systems Manager User Guide*\:
|
10058
10435
|
#
|
10059
10436
|
# * [Using service-linked roles for Systems Manager][1]
|
10060
10437
|
#
|
@@ -10092,7 +10469,7 @@ module Aws::SSM
|
|
10092
10469
|
# When you update a maintenance window task that has options specified
|
10093
10470
|
# in `TaskInvocationParameters`, you must provide again all the
|
10094
10471
|
# `TaskInvocationParameters` values that you want to retain. The values
|
10095
|
-
# you
|
10472
|
+
# you don't specify again are removed. For example, suppose that when
|
10096
10473
|
# you registered a Run Command task, you specified
|
10097
10474
|
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
10098
10475
|
# and `OutputS3BucketName`. If you update the maintenance window task
|
@@ -10108,10 +10485,10 @@ module Aws::SSM
|
|
10108
10485
|
# is the number of targets that are allowed to run this task in
|
10109
10486
|
# parallel.
|
10110
10487
|
#
|
10111
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
10488
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
10112
10489
|
# supply a value for this option. Instead, the system inserts a
|
10113
10490
|
# placeholder value of `1`, which may be reported in the response to
|
10114
|
-
# this command. This value
|
10491
|
+
# this command. This value doesn't affect the running of your task and
|
10115
10492
|
# can be ignored.
|
10116
10493
|
#
|
10117
10494
|
# </note>
|
@@ -10121,10 +10498,10 @@ module Aws::SSM
|
|
10121
10498
|
# number of errors that are allowed before the task stops being
|
10122
10499
|
# scheduled.
|
10123
10500
|
#
|
10124
|
-
# <note markdown="1"> For maintenance window tasks without a target specified, you
|
10501
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you can't
|
10125
10502
|
# supply a value for this option. Instead, the system inserts a
|
10126
10503
|
# placeholder value of `1`, which may be reported in the response to
|
10127
|
-
# this command. This value
|
10504
|
+
# this command. This value doesn't affect the running of your task and
|
10128
10505
|
# can be ignored.
|
10129
10506
|
#
|
10130
10507
|
# </note>
|
@@ -10132,10 +10509,11 @@ module Aws::SSM
|
|
10132
10509
|
# @option params [Types::LoggingInfo] :logging_info
|
10133
10510
|
# The new logging location in Amazon S3 to specify.
|
10134
10511
|
#
|
10135
|
-
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an
|
10136
|
-
# logs, instead use the
|
10137
|
-
#
|
10138
|
-
#
|
10512
|
+
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage
|
10513
|
+
# Service (Amazon S3) bucket to contain logs, instead use the
|
10514
|
+
# `OutputS3BucketName` and `OutputS3KeyPrefix` options in the
|
10515
|
+
# `TaskInvocationParameters` structure. For information about how Amazon
|
10516
|
+
# Web Services Systems Manager handles these options for the supported
|
10139
10517
|
# maintenance window task types, see
|
10140
10518
|
# MaintenanceWindowTaskInvocationParameters.
|
10141
10519
|
#
|
@@ -10149,8 +10527,8 @@ module Aws::SSM
|
|
10149
10527
|
#
|
10150
10528
|
# @option params [Boolean] :replace
|
10151
10529
|
# If True, then all fields that are required by the
|
10152
|
-
# RegisterTaskWithMaintenanceWindow
|
10153
|
-
# API request. Optional fields that
|
10530
|
+
# RegisterTaskWithMaintenanceWindow operation are also required for this
|
10531
|
+
# API request. Optional fields that aren't specified are set to null.
|
10154
10532
|
#
|
10155
10533
|
# @return [Types::UpdateMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10156
10534
|
#
|
@@ -10295,10 +10673,10 @@ module Aws::SSM
|
|
10295
10673
|
req.send_request(options)
|
10296
10674
|
end
|
10297
10675
|
|
10298
|
-
# Changes the
|
10299
|
-
#
|
10300
|
-
#
|
10301
|
-
#
|
10676
|
+
# Changes the Identity and Access Management (IAM) role that is assigned
|
10677
|
+
# to the on-premises instance or virtual machines (VM). IAM roles are
|
10678
|
+
# first assigned to these hybrid instances during the activation
|
10679
|
+
# process. For more information, see CreateActivation.
|
10302
10680
|
#
|
10303
10681
|
# @option params [required, String] :instance_id
|
10304
10682
|
# The ID of the managed instance where you want to update the role.
|
@@ -10324,16 +10702,17 @@ module Aws::SSM
|
|
10324
10702
|
req.send_request(options)
|
10325
10703
|
end
|
10326
10704
|
|
10327
|
-
# Edit or change an OpsItem. You must have permission in
|
10328
|
-
#
|
10329
|
-
#
|
10705
|
+
# Edit or change an OpsItem. You must have permission in Identity and
|
10706
|
+
# Access Management (IAM) to update an OpsItem. For more information,
|
10707
|
+
# see [Getting started with OpsCenter][1] in the *Amazon Web Services
|
10330
10708
|
# Systems Manager User Guide*.
|
10331
10709
|
#
|
10332
|
-
# Operations engineers and IT professionals use
|
10333
|
-
# investigate, and remediate
|
10334
|
-
# performance and health of their
|
10335
|
-
#
|
10336
|
-
# User
|
10710
|
+
# Operations engineers and IT professionals use Amazon Web Services
|
10711
|
+
# Systems Manager OpsCenter to view, investigate, and remediate
|
10712
|
+
# operational issues impacting the performance and health of their
|
10713
|
+
# Amazon Web Services resources. For more information, see
|
10714
|
+
# [OpsCenter][2] in the *Amazon Web Services Systems Manager User
|
10715
|
+
# Guide*.
|
10337
10716
|
#
|
10338
10717
|
#
|
10339
10718
|
#
|
@@ -10355,22 +10734,23 @@ module Aws::SSM
|
|
10355
10734
|
# You enter operational data as key-value pairs. The key has a maximum
|
10356
10735
|
# length of 128 characters. The value has a maximum size of 20 KB.
|
10357
10736
|
#
|
10358
|
-
# Operational data keys *can't* begin with the following: amazon
|
10359
|
-
# amzn
|
10737
|
+
# Operational data keys *can't* begin with the following: `amazon`,
|
10738
|
+
# `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
|
10360
10739
|
#
|
10361
10740
|
# You can choose to make the data searchable by other users in the
|
10362
10741
|
# account or you can restrict search access. Searchable data means that
|
10363
10742
|
# all users with access to the OpsItem Overview page (as provided by the
|
10364
|
-
# DescribeOpsItems API
|
10365
|
-
# data. Operational data that
|
10743
|
+
# DescribeOpsItems API operation) can view and search on the specified
|
10744
|
+
# data. Operational data that isn't searchable is only viewable by
|
10366
10745
|
# users who have access to the OpsItem (as provided by the GetOpsItem
|
10367
|
-
# API
|
10746
|
+
# API operation).
|
10368
10747
|
#
|
10369
10748
|
# Use the `/aws/resources` key in OperationalData to specify a related
|
10370
10749
|
# resource in the request. Use the `/aws/automations` key in
|
10371
10750
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
10372
|
-
# To view
|
10373
|
-
# OpsItems manually][1] in the *
|
10751
|
+
# To view Amazon Web Services CLI example commands that use these keys,
|
10752
|
+
# see [Creating OpsItems manually][1] in the *Amazon Web Services
|
10753
|
+
# Systems Manager User Guide*.
|
10374
10754
|
#
|
10375
10755
|
#
|
10376
10756
|
#
|
@@ -10396,7 +10776,7 @@ module Aws::SSM
|
|
10396
10776
|
# @option params [String] :status
|
10397
10777
|
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
10398
10778
|
# `Resolved`. For more information, see [Editing OpsItem details][1] in
|
10399
|
-
# the *
|
10779
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
10400
10780
|
#
|
10401
10781
|
#
|
10402
10782
|
#
|
@@ -10456,7 +10836,7 @@ module Aws::SSM
|
|
10456
10836
|
# ops_item_id: "String", # required
|
10457
10837
|
# },
|
10458
10838
|
# ],
|
10459
|
-
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
|
10839
|
+
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected, Closed
|
10460
10840
|
# ops_item_id: "OpsItemId", # required
|
10461
10841
|
# title: "OpsItemTitle",
|
10462
10842
|
# category: "OpsItemCategory",
|
@@ -10476,8 +10856,8 @@ module Aws::SSM
|
|
10476
10856
|
req.send_request(options)
|
10477
10857
|
end
|
10478
10858
|
|
10479
|
-
# Systems Manager calls this API
|
10480
|
-
# Application Manager.
|
10859
|
+
# Amazon Web Services Systems Manager calls this API operation when you
|
10860
|
+
# edit OpsMetadata in Application Manager.
|
10481
10861
|
#
|
10482
10862
|
# @option params [required, String] :ops_metadata_arn
|
10483
10863
|
# The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
|
@@ -10520,15 +10900,11 @@ module Aws::SSM
|
|
10520
10900
|
# Modifies an existing patch baseline. Fields not specified in the
|
10521
10901
|
# request are left unchanged.
|
10522
10902
|
#
|
10523
|
-
# <note markdown="1"> For information about valid key
|
10524
|
-
#
|
10903
|
+
# <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
|
10904
|
+
# supported operating system type, see PatchFilter.
|
10525
10905
|
#
|
10526
10906
|
# </note>
|
10527
10907
|
#
|
10528
|
-
#
|
10529
|
-
#
|
10530
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
|
10531
|
-
#
|
10532
10908
|
# @option params [required, String] :baseline_id
|
10533
10909
|
# The ID of the patch baseline to update.
|
10534
10910
|
#
|
@@ -10546,7 +10922,8 @@ module Aws::SSM
|
|
10546
10922
|
#
|
10547
10923
|
# For information about accepted formats for lists of approved patches
|
10548
10924
|
# and rejected patches, see [About package name formats for approved and
|
10549
|
-
# rejected patch lists][1] in the *
|
10925
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
10926
|
+
# User Guide*.
|
10550
10927
|
#
|
10551
10928
|
#
|
10552
10929
|
#
|
@@ -10558,14 +10935,15 @@ module Aws::SSM
|
|
10558
10935
|
# @option params [Boolean] :approved_patches_enable_non_security
|
10559
10936
|
# Indicates whether the list of approved patches includes non-security
|
10560
10937
|
# updates that should be applied to the instances. The default value is
|
10561
|
-
#
|
10938
|
+
# `false`. Applies to Linux instances only.
|
10562
10939
|
#
|
10563
10940
|
# @option params [Array<String>] :rejected_patches
|
10564
10941
|
# A list of explicitly rejected patches for the baseline.
|
10565
10942
|
#
|
10566
10943
|
# For information about accepted formats for lists of approved patches
|
10567
10944
|
# and rejected patches, see [About package name formats for approved and
|
10568
|
-
# rejected patch lists][1] in the *
|
10945
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
10946
|
+
# User Guide*.
|
10569
10947
|
#
|
10570
10948
|
#
|
10571
10949
|
#
|
@@ -10573,19 +10951,20 @@ module Aws::SSM
|
|
10573
10951
|
#
|
10574
10952
|
# @option params [String] :rejected_patches_action
|
10575
10953
|
# The action for Patch Manager to take on patches included in the
|
10576
|
-
# RejectedPackages list.
|
10954
|
+
# `RejectedPackages` list.
|
10577
10955
|
#
|
10578
|
-
# *
|
10579
|
-
# is installed only if it is a dependency of
|
10580
|
-
# considered compliant with the patch baseline,
|
10581
|
-
# reported as
|
10582
|
-
# option is specified.
|
10956
|
+
# * <b> <code>ALLOW_AS_DEPENDENCY</code> </b>\: A package in the
|
10957
|
+
# `Rejected` patches list is installed only if it is a dependency of
|
10958
|
+
# another package. It is considered compliant with the patch baseline,
|
10959
|
+
# and its status is reported as `InstalledOther`. This is the default
|
10960
|
+
# action if no option is specified.
|
10583
10961
|
#
|
10584
|
-
# *
|
10585
|
-
# include them as dependencies,
|
10586
|
-
# circumstances. If a package was installed before
|
10587
|
-
# Rejected patches list, it is considered
|
10588
|
-
# baseline, and its status is reported as
|
10962
|
+
# * <b> <code>BLOCK</code> </b>\: Packages in the `RejectedPatches`
|
10963
|
+
# list, and packages that include them as dependencies, aren't
|
10964
|
+
# installed under any circumstances. If a package was installed before
|
10965
|
+
# it was added to the `Rejected` patches list, it is considered
|
10966
|
+
# non-compliant with the patch baseline, and its status is reported as
|
10967
|
+
# `InstalledRejected`.
|
10589
10968
|
#
|
10590
10969
|
# @option params [String] :description
|
10591
10970
|
# A description of the patch baseline.
|
@@ -10597,8 +10976,8 @@ module Aws::SSM
|
|
10597
10976
|
#
|
10598
10977
|
# @option params [Boolean] :replace
|
10599
10978
|
# If True, then all fields that are required by the CreatePatchBaseline
|
10600
|
-
#
|
10601
|
-
#
|
10979
|
+
# operation are also required for this API request. Optional fields that
|
10980
|
+
# aren't specified are set to null.
|
10602
10981
|
#
|
10603
10982
|
# @return [Types::UpdatePatchBaselineResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10604
10983
|
#
|
@@ -10710,12 +11089,12 @@ module Aws::SSM
|
|
10710
11089
|
# Update a resource data sync. After you create a resource data sync for
|
10711
11090
|
# a Region, you can't change the account options for that sync. For
|
10712
11091
|
# example, if you create a sync in the us-east-2 (Ohio) Region and you
|
10713
|
-
# choose the Include only the current account option, you can't edit
|
10714
|
-
# that sync later and choose the Include all accounts from my
|
10715
|
-
# Organizations configuration option. Instead, you must delete the
|
10716
|
-
# resource data sync, and create a new one.
|
11092
|
+
# choose the `Include only the current account` option, you can't edit
|
11093
|
+
# that sync later and choose the `Include all accounts from my
|
11094
|
+
# Organizations configuration` option. Instead, you must delete the
|
11095
|
+
# first resource data sync, and create a new one.
|
10717
11096
|
#
|
10718
|
-
# <note markdown="1"> This API
|
11097
|
+
# <note markdown="1"> This API operation only supports a resource data sync that was created
|
10719
11098
|
# with a SyncFromSource `SyncType`.
|
10720
11099
|
#
|
10721
11100
|
# </note>
|
@@ -10762,21 +11141,22 @@ module Aws::SSM
|
|
10762
11141
|
req.send_request(options)
|
10763
11142
|
end
|
10764
11143
|
|
10765
|
-
# `ServiceSetting` is an account-level setting for an
|
10766
|
-
# setting defines how a user interacts with or
|
10767
|
-
# feature of a service. For example, if an
|
10768
|
-
# the account based on feature or
|
10769
|
-
#
|
10770
|
-
#
|
10771
|
-
#
|
11144
|
+
# `ServiceSetting` is an account-level setting for an Amazon Web
|
11145
|
+
# Services service. This setting defines how a user interacts with or
|
11146
|
+
# uses a service or a feature of a service. For example, if an Amazon
|
11147
|
+
# Web Services service charges money to the account based on feature or
|
11148
|
+
# service usage, then the Amazon Web Services service team might create
|
11149
|
+
# a default setting of "false". This means the user can't use this
|
11150
|
+
# feature unless they change the setting to "true" and intentionally
|
11151
|
+
# opt in for a paid feature.
|
10772
11152
|
#
|
10773
|
-
# Services map a `SettingId` object to a setting value.
|
10774
|
-
# teams define the default value for a `SettingId`.
|
10775
|
-
# new `SettingId`, but you can overwrite the default
|
10776
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
10777
|
-
# GetServiceSetting API
|
10778
|
-
# ResetServiceSetting to change the value back to the
|
10779
|
-
# defined by the
|
11153
|
+
# Services map a `SettingId` object to a setting value. Amazon Web
|
11154
|
+
# Services services teams define the default value for a `SettingId`.
|
11155
|
+
# You can't create a new `SettingId`, but you can overwrite the default
|
11156
|
+
# value if you have the `ssm:UpdateServiceSetting` permission for the
|
11157
|
+
# setting. Use the GetServiceSetting API operation to view the current
|
11158
|
+
# value. Or, use the ResetServiceSetting to change the value back to the
|
11159
|
+
# original value defined by the Amazon Web Services service team.
|
10780
11160
|
#
|
10781
11161
|
# Update the service setting for the account.
|
10782
11162
|
#
|
@@ -10790,6 +11170,8 @@ module Aws::SSM
|
|
10790
11170
|
#
|
10791
11171
|
# * `/ssm/automation/customer-script-log-group-name`
|
10792
11172
|
#
|
11173
|
+
# * `/ssm/documents/console/public-sharing-permission`
|
11174
|
+
#
|
10793
11175
|
# * `/ssm/parameter-store/default-parameter-tier`
|
10794
11176
|
#
|
10795
11177
|
# * `/ssm/parameter-store/high-throughput-enabled`
|
@@ -10812,10 +11194,14 @@ module Aws::SSM
|
|
10812
11194
|
# can be true or false.
|
10813
11195
|
#
|
10814
11196
|
# For the `/ssm/automation/customer-script-log-destination` setting ID,
|
10815
|
-
# the setting value can be CloudWatch
|
11197
|
+
# the setting value can be `CloudWatch`.
|
10816
11198
|
#
|
10817
11199
|
# For the `/ssm/automation/customer-script-log-group-name` setting ID,
|
10818
|
-
# the setting value can be the name of
|
11200
|
+
# the setting value can be the name of an Amazon CloudWatch Logs log
|
11201
|
+
# group.
|
11202
|
+
#
|
11203
|
+
# For the `/ssm/documents/console/public-sharing-permission` setting ID,
|
11204
|
+
# the setting value can be `Enable` or `Disable`.
|
10819
11205
|
#
|
10820
11206
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
10821
11207
|
#
|
@@ -10848,7 +11234,7 @@ module Aws::SSM
|
|
10848
11234
|
params: params,
|
10849
11235
|
config: config)
|
10850
11236
|
context[:gem_name] = 'aws-sdk-ssm'
|
10851
|
-
context[:gem_version] = '1.
|
11237
|
+
context[:gem_version] = '1.113.0'
|
10852
11238
|
Seahorse::Client::Request.new(handlers, context)
|
10853
11239
|
end
|
10854
11240
|
|