aws-sdk-ssm 1.108.0 → 1.112.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 +1184 -761
- data/lib/aws-sdk-ssm/client_api.rb +131 -0
- data/lib/aws-sdk-ssm/errors.rb +42 -0
- data/lib/aws-sdk-ssm/types.rb +2078 -1386
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9b60596d2fe5a2378e7d457378675afef799b1a18cb40ee209777fe9859882c8
|
4
|
+
data.tar.gz: bd5583488fbcb8c5c4a8dcdb5645f915b10f44ed825d7baca10cd211ac055fcd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7035bf3fac82d4f628db7de4b8d331f4f539a951f3dfc0785d7717ad77abfd737e3d8a59b4047b1cb52b3878fa358206709d0b7df45abf75ee3f007728b98052
|
7
|
+
data.tar.gz: 22fd6c6f511fb3257fe459d17157aa1ba2439c6c0a0d1af8b33ac59507c5cb44340fecb8ababdc23d24a0c8700274eb925b311dae2c1aa8741c51f2a4f730f12
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.112.0 (2021-07-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Changes to OpsCenter APIs to support a new feature, operational insights.
|
8
|
+
|
9
|
+
1.111.0 (2021-06-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation updates for ssm to fix customer reported issue
|
13
|
+
|
14
|
+
1.110.0 (2021-05-10)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* 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.
|
18
|
+
|
19
|
+
1.109.0 (2021-05-06)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - SSM feature release - ChangeCalendar integration with StateManager.
|
23
|
+
|
4
24
|
1.108.0 (2021-04-06)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.112.0
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -345,8 +345,18 @@ module Aws::SSM
|
|
345
345
|
# and an optional value, both of which you define. For example, you
|
346
346
|
# could define a set of tags for your account's managed instances that
|
347
347
|
# helps you track each instance's owner and stack level. For example:
|
348
|
-
#
|
349
|
-
# Value=
|
348
|
+
#
|
349
|
+
# * `Key=Owner,Value=DbAdmin`
|
350
|
+
#
|
351
|
+
# * `Key=Owner,Value=SysAdmin`
|
352
|
+
#
|
353
|
+
# * `Key=Owner,Value=Dev`
|
354
|
+
#
|
355
|
+
# * `Key=Stack,Value=Production`
|
356
|
+
#
|
357
|
+
# * `Key=Stack,Value=Pre-Production`
|
358
|
+
#
|
359
|
+
# * `Key=Stack,Value=Test`
|
350
360
|
#
|
351
361
|
# Each resource can have a maximum of 50 tags.
|
352
362
|
#
|
@@ -356,8 +366,9 @@ module Aws::SSM
|
|
356
366
|
# resources based on the tags you add. Tags don't have any semantic
|
357
367
|
# meaning to and are interpreted strictly as a string of characters.
|
358
368
|
#
|
359
|
-
# For more information about using tags with
|
360
|
-
#
|
369
|
+
# For more information about using tags with Amazon Elastic Compute
|
370
|
+
# Cloud (Amazon EC2) instances, see [Tagging your Amazon EC2
|
371
|
+
# resources][1] in the *Amazon EC2 User Guide*.
|
361
372
|
#
|
362
373
|
#
|
363
374
|
#
|
@@ -366,9 +377,10 @@ module Aws::SSM
|
|
366
377
|
# @option params [required, String] :resource_type
|
367
378
|
# Specifies the type of resource you are tagging.
|
368
379
|
#
|
369
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
380
|
+
# <note markdown="1"> The `ManagedInstance` type for this API operation is for on-premises
|
370
381
|
# managed instances. You must specify the name of the managed instance
|
371
|
-
# in the following format: mi-
|
382
|
+
# in the following format: `mi-ID_number `. For example,
|
383
|
+
# `mi-1a2b3c4d5e6f`.
|
372
384
|
#
|
373
385
|
# </note>
|
374
386
|
#
|
@@ -377,13 +389,11 @@ module Aws::SSM
|
|
377
389
|
#
|
378
390
|
# Use the ID of the resource. Here are some examples:
|
379
391
|
#
|
380
|
-
#
|
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,23 +802,33 @@ 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
|
#
|
738
811
|
# @option params [Boolean] :apply_only_at_cron_interval
|
739
|
-
# By default, when you create a new
|
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
|
#
|
818
|
+
# @option params [Array<String>] :calendar_names
|
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].
|
823
|
+
#
|
824
|
+
#
|
825
|
+
#
|
826
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
827
|
+
#
|
745
828
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
746
|
-
# A location is a combination of
|
747
|
-
#
|
748
|
-
#
|
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.
|
749
832
|
#
|
750
833
|
# @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
751
834
|
#
|
@@ -781,6 +864,7 @@ module Aws::SSM
|
|
781
864
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
782
865
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
783
866
|
# apply_only_at_cron_interval: false,
|
867
|
+
# calendar_names: ["CalendarNameOrARN"],
|
784
868
|
# target_locations: [
|
785
869
|
# {
|
786
870
|
# accounts: ["Account"],
|
@@ -829,6 +913,8 @@ module Aws::SSM
|
|
829
913
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
830
914
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
831
915
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
916
|
+
# resp.association_description.calendar_names #=> Array
|
917
|
+
# resp.association_description.calendar_names[0] #=> String
|
832
918
|
# resp.association_description.target_locations #=> Array
|
833
919
|
# resp.association_description.target_locations[0].accounts #=> Array
|
834
920
|
# resp.association_description.target_locations[0].accounts[0] #=> String
|
@@ -847,12 +933,13 @@ module Aws::SSM
|
|
847
933
|
req.send_request(options)
|
848
934
|
end
|
849
935
|
|
850
|
-
# Associates the specified Systems Manager document
|
851
|
-
# instances or targets.
|
936
|
+
# Associates the specified Amazon Web Services Systems Manager document
|
937
|
+
# (SSM document) with the specified instances or targets.
|
852
938
|
#
|
853
939
|
# When you associate a document with one or more instances using
|
854
|
-
# instance IDs or tags,
|
855
|
-
#
|
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.
|
856
943
|
#
|
857
944
|
# If you associate a document with an instance that already has an
|
858
945
|
# associated document, the system returns the AssociationAlreadyExists
|
@@ -898,6 +985,7 @@ module Aws::SSM
|
|
898
985
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
899
986
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
900
987
|
# apply_only_at_cron_interval: false,
|
988
|
+
# calendar_names: ["CalendarNameOrARN"],
|
901
989
|
# target_locations: [
|
902
990
|
# {
|
903
991
|
# accounts: ["Account"],
|
@@ -949,6 +1037,8 @@ module Aws::SSM
|
|
949
1037
|
# resp.successful[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
950
1038
|
# resp.successful[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
951
1039
|
# resp.successful[0].apply_only_at_cron_interval #=> Boolean
|
1040
|
+
# resp.successful[0].calendar_names #=> Array
|
1041
|
+
# resp.successful[0].calendar_names[0] #=> String
|
952
1042
|
# resp.successful[0].target_locations #=> Array
|
953
1043
|
# resp.successful[0].target_locations[0].accounts #=> Array
|
954
1044
|
# resp.successful[0].target_locations[0].accounts[0] #=> String
|
@@ -979,6 +1069,8 @@ module Aws::SSM
|
|
979
1069
|
# resp.failed[0].entry.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
980
1070
|
# resp.failed[0].entry.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
981
1071
|
# resp.failed[0].entry.apply_only_at_cron_interval #=> Boolean
|
1072
|
+
# resp.failed[0].entry.calendar_names #=> Array
|
1073
|
+
# resp.failed[0].entry.calendar_names[0] #=> String
|
982
1074
|
# resp.failed[0].entry.target_locations #=> Array
|
983
1075
|
# resp.failed[0].entry.target_locations[0].accounts #=> Array
|
984
1076
|
# resp.failed[0].entry.target_locations[0].accounts[0] #=> String
|
@@ -999,11 +1091,12 @@ module Aws::SSM
|
|
999
1091
|
req.send_request(options)
|
1000
1092
|
end
|
1001
1093
|
|
1002
|
-
# Creates a Systems Manager (SSM
|
1003
|
-
# actions that Systems Manager performs on your
|
1004
|
-
# more information about SSM documents, including
|
1005
|
-
# supported schemas, features, and syntax, see [
|
1006
|
-
# 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*.
|
1007
1100
|
#
|
1008
1101
|
#
|
1009
1102
|
#
|
@@ -1014,12 +1107,12 @@ module Aws::SSM
|
|
1014
1107
|
# recommend storing the contents for your new document in an external
|
1015
1108
|
# JSON or YAML file and referencing the file in a command.
|
1016
1109
|
#
|
1017
|
-
# For examples, see the following topics in the *
|
1018
|
-
# User Guide*.
|
1110
|
+
# For examples, see the following topics in the *Amazon Web Services
|
1111
|
+
# Systems Manager User Guide*.
|
1019
1112
|
#
|
1020
|
-
# * [Create an SSM document (
|
1113
|
+
# * [Create an SSM document (Amazon Web Services API)][1]
|
1021
1114
|
#
|
1022
|
-
# * [Create an SSM document (
|
1115
|
+
# * [Create an SSM document (Amazon Web Services CLI)][2]
|
1023
1116
|
#
|
1024
1117
|
# * [Create an SSM document (API)][1]
|
1025
1118
|
#
|
@@ -1030,27 +1123,27 @@ module Aws::SSM
|
|
1030
1123
|
#
|
1031
1124
|
# @option params [Array<Types::DocumentRequires>] :requires
|
1032
1125
|
# A list of SSM documents required by a document. This parameter is used
|
1033
|
-
# exclusively by
|
1126
|
+
# exclusively by AppConfig. When a user creates an AppConfig
|
1034
1127
|
# configuration in an SSM document, the user must also specify a
|
1035
1128
|
# required document for validation purposes. In this case, an
|
1036
1129
|
# `ApplicationConfiguration` document requires an
|
1037
1130
|
# `ApplicationConfigurationSchema` document for validation purposes. For
|
1038
|
-
# more information, see [
|
1039
|
-
#
|
1131
|
+
# more information, see [What is AppConfig?][1] in the *AppConfig User
|
1132
|
+
# Guide*.
|
1040
1133
|
#
|
1041
1134
|
#
|
1042
1135
|
#
|
1043
|
-
# [1]: https://docs.aws.amazon.com/
|
1136
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html
|
1044
1137
|
#
|
1045
1138
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
1046
|
-
# A list of key
|
1047
|
-
#
|
1139
|
+
# A list of key-value pairs that describe attachments to a version of a
|
1140
|
+
# document.
|
1048
1141
|
#
|
1049
1142
|
# @option params [required, String] :name
|
1050
|
-
# A name for the
|
1143
|
+
# A name for the SSM document.
|
1051
1144
|
#
|
1052
1145
|
# You can't use the following strings as document name prefixes. These
|
1053
|
-
# are reserved by
|
1146
|
+
# are reserved by Amazon Web Services for use as document name prefixes:
|
1054
1147
|
#
|
1055
1148
|
# * `aws-`
|
1056
1149
|
#
|
@@ -1058,10 +1151,16 @@ module Aws::SSM
|
|
1058
1151
|
#
|
1059
1152
|
# * `amzn`
|
1060
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
|
+
#
|
1061
1160
|
# @option params [String] :version_name
|
1062
1161
|
# An optional field specifying the version of the artifact you are
|
1063
1162
|
# creating with the document. For example, "Release 12, Update 6".
|
1064
|
-
# 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
|
1065
1164
|
# changed.
|
1066
1165
|
#
|
1067
1166
|
# @option params [String] :document_type
|
@@ -1074,29 +1173,29 @@ module Aws::SSM
|
|
1074
1173
|
# @option params [String] :target_type
|
1075
1174
|
# Specify a target type to define the kinds of resources the document
|
1076
1175
|
# can run on. For example, to run a document on EC2 instances, specify
|
1077
|
-
# the following value:
|
1176
|
+
# the following value: `/AWS::EC2::Instance`. If you specify a value of
|
1078
1177
|
# '/' the document can run on all types of resources. If you don't
|
1079
1178
|
# specify a value, the document can't run on any resources. For a list
|
1080
|
-
# of valid resource types, see [
|
1081
|
-
# 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*.
|
1082
1181
|
#
|
1083
1182
|
#
|
1084
1183
|
#
|
1085
|
-
# [1]:
|
1184
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
|
1086
1185
|
#
|
1087
1186
|
# @option params [Array<Types::Tag>] :tags
|
1088
1187
|
# Optional metadata that you assign to a resource. Tags enable you to
|
1089
1188
|
# categorize a resource in different ways, such as by purpose, owner, or
|
1090
1189
|
# environment. For example, you might want to tag an SSM document to
|
1091
1190
|
# identify the types of targets or the environment where it will run. In
|
1092
|
-
# this case, you could specify the following key
|
1191
|
+
# this case, you could specify the following key-value pairs:
|
1093
1192
|
#
|
1094
1193
|
# * `Key=OS,Value=Windows`
|
1095
1194
|
#
|
1096
1195
|
# * `Key=Environment,Value=Production`
|
1097
1196
|
#
|
1098
1197
|
# <note markdown="1"> To add tags to an existing SSM document, use the AddTagsToResource
|
1099
|
-
#
|
1198
|
+
# operation.
|
1100
1199
|
#
|
1101
1200
|
# </note>
|
1102
1201
|
#
|
@@ -1122,8 +1221,9 @@ module Aws::SSM
|
|
1122
1221
|
# },
|
1123
1222
|
# ],
|
1124
1223
|
# name: "DocumentName", # required
|
1224
|
+
# display_name: "DocumentDisplayName",
|
1125
1225
|
# version_name: "DocumentVersionName",
|
1126
|
-
# 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
|
1127
1227
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
1128
1228
|
# target_type: "TargetType",
|
1129
1229
|
# tags: [
|
@@ -1140,6 +1240,7 @@ module Aws::SSM
|
|
1140
1240
|
# resp.document_description.hash #=> String
|
1141
1241
|
# resp.document_description.hash_type #=> String, one of "Sha256", "Sha1"
|
1142
1242
|
# resp.document_description.name #=> String
|
1243
|
+
# resp.document_description.display_name #=> String
|
1143
1244
|
# resp.document_description.version_name #=> String
|
1144
1245
|
# resp.document_description.owner #=> String
|
1145
1246
|
# resp.document_description.created_date #=> Time
|
@@ -1154,7 +1255,7 @@ module Aws::SSM
|
|
1154
1255
|
# resp.document_description.parameters[0].default_value #=> String
|
1155
1256
|
# resp.document_description.platform_types #=> Array
|
1156
1257
|
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
1157
|
-
# 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"
|
1158
1259
|
# resp.document_description.schema_version #=> String
|
1159
1260
|
# resp.document_description.latest_version #=> String
|
1160
1261
|
# resp.document_description.default_version #=> String
|
@@ -1208,12 +1309,12 @@ module Aws::SSM
|
|
1208
1309
|
#
|
1209
1310
|
# @option params [String] :start_date
|
1210
1311
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
1211
|
-
# maintenance window to become active. StartDate allows you to delay
|
1312
|
+
# maintenance window to become active. `StartDate` allows you to delay
|
1212
1313
|
# activation of the maintenance window until the specified future date.
|
1213
1314
|
#
|
1214
1315
|
# @option params [String] :end_date
|
1215
1316
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
1216
|
-
# maintenance window to become inactive. EndDate allows you to set a
|
1317
|
+
# maintenance window to become inactive. `EndDate` allows you to set a
|
1217
1318
|
# date and time in the future when the maintenance window will no longer
|
1218
1319
|
# run.
|
1219
1320
|
#
|
@@ -1232,7 +1333,7 @@ module Aws::SSM
|
|
1232
1333
|
# [1]: https://www.iana.org/time-zones
|
1233
1334
|
#
|
1234
1335
|
# @option params [Integer] :schedule_offset
|
1235
|
-
# 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
|
1236
1337
|
# expression before running the maintenance window.
|
1237
1338
|
#
|
1238
1339
|
# For example, the following cron expression schedules a maintenance
|
@@ -1248,11 +1349,12 @@ module Aws::SSM
|
|
1248
1349
|
#
|
1249
1350
|
# @option params [required, Integer] :cutoff
|
1250
1351
|
# The number of hours before the end of the maintenance window that
|
1251
|
-
# Systems Manager stops scheduling new tasks for
|
1352
|
+
# Amazon Web Services Systems Manager stops scheduling new tasks for
|
1353
|
+
# execution.
|
1252
1354
|
#
|
1253
1355
|
# @option params [required, Boolean] :allow_unassociated_targets
|
1254
1356
|
# Enables a maintenance window task to run on managed instances, even if
|
1255
|
-
# you
|
1357
|
+
# you haven't registered those instances as targets. If enabled, then
|
1256
1358
|
# you must specify the unregistered instances (by instance ID) when you
|
1257
1359
|
# register a task with the maintenance window.
|
1258
1360
|
#
|
@@ -1272,7 +1374,7 @@ module Aws::SSM
|
|
1272
1374
|
# environment. For example, you might want to tag a maintenance window
|
1273
1375
|
# to identify the type of tasks it will run, the types of targets, and
|
1274
1376
|
# the environment it will run in. In this case, you could specify the
|
1275
|
-
# following key
|
1377
|
+
# following key-value pairs:
|
1276
1378
|
#
|
1277
1379
|
# * `Key=TaskType,Value=AgentUpdate`
|
1278
1380
|
#
|
@@ -1281,7 +1383,7 @@ module Aws::SSM
|
|
1281
1383
|
# * `Key=Environment,Value=Production`
|
1282
1384
|
#
|
1283
1385
|
# <note markdown="1"> To add tags to an existing maintenance window, use the
|
1284
|
-
# AddTagsToResource
|
1386
|
+
# AddTagsToResource operation.
|
1285
1387
|
#
|
1286
1388
|
# </note>
|
1287
1389
|
#
|
@@ -1324,16 +1426,17 @@ module Aws::SSM
|
|
1324
1426
|
req.send_request(options)
|
1325
1427
|
end
|
1326
1428
|
|
1327
|
-
# Creates a new OpsItem. You must have permission in
|
1328
|
-
#
|
1329
|
-
#
|
1330
|
-
# 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*.
|
1331
1433
|
#
|
1332
|
-
# Operations engineers and IT professionals use
|
1333
|
-
# investigate, and remediate
|
1334
|
-
# performance and health of their
|
1335
|
-
#
|
1336
|
-
#
|
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*.
|
1337
1440
|
#
|
1338
1441
|
#
|
1339
1442
|
#
|
@@ -1354,22 +1457,23 @@ module Aws::SSM
|
|
1354
1457
|
# You enter operational data as key-value pairs. The key has a maximum
|
1355
1458
|
# length of 128 characters. The value has a maximum size of 20 KB.
|
1356
1459
|
#
|
1357
|
-
# Operational data keys *can't* begin with the following: amazon
|
1358
|
-
# amzn
|
1460
|
+
# Operational data keys *can't* begin with the following: `amazon`,
|
1461
|
+
# `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
|
1359
1462
|
#
|
1360
1463
|
# You can choose to make the data searchable by other users in the
|
1361
1464
|
# account or you can restrict search access. Searchable data means that
|
1362
1465
|
# all users with access to the OpsItem Overview page (as provided by the
|
1363
|
-
# DescribeOpsItems API
|
1364
|
-
# 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
|
1365
1468
|
# users who have access to the OpsItem (as provided by the GetOpsItem
|
1366
|
-
# API
|
1469
|
+
# API operation).
|
1367
1470
|
#
|
1368
1471
|
# Use the `/aws/resources` key in OperationalData to specify a related
|
1369
1472
|
# resource in the request. Use the `/aws/automations` key in
|
1370
1473
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
1371
|
-
# To view
|
1372
|
-
# 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*.
|
1373
1477
|
#
|
1374
1478
|
#
|
1375
1479
|
#
|
@@ -1392,8 +1496,8 @@ module Aws::SSM
|
|
1392
1496
|
# @option params [required, String] :source
|
1393
1497
|
# The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
|
1394
1498
|
#
|
1395
|
-
# <note markdown="1"> The source name can't contain the following strings: aws
|
1396
|
-
# amzn
|
1499
|
+
# <note markdown="1"> The source name can't contain the following strings: `aws`, `amazon`,
|
1500
|
+
# and `amzn`.
|
1397
1501
|
#
|
1398
1502
|
# </note>
|
1399
1503
|
#
|
@@ -1405,15 +1509,16 @@ module Aws::SSM
|
|
1405
1509
|
# Optional metadata that you assign to a resource. You can restrict
|
1406
1510
|
# access to OpsItems by using an inline IAM policy that specifies tags.
|
1407
1511
|
# For more information, see [Getting started with OpsCenter][1] in the
|
1408
|
-
# *
|
1512
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
1409
1513
|
#
|
1410
1514
|
# Tags use a key-value pair. For example:
|
1411
1515
|
#
|
1412
1516
|
# `Key=Department,Value=Finance`
|
1413
1517
|
#
|
1414
|
-
#
|
1415
|
-
#
|
1416
|
-
#
|
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.
|
1417
1522
|
#
|
1418
1523
|
#
|
1419
1524
|
#
|
@@ -1497,9 +1602,9 @@ module Aws::SSM
|
|
1497
1602
|
req.send_request(options)
|
1498
1603
|
end
|
1499
1604
|
|
1500
|
-
# If you create a new application in Application Manager,
|
1501
|
-
# Manager calls this API
|
1502
|
-
# 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.
|
1503
1608
|
#
|
1504
1609
|
# @option params [required, String] :resource_id
|
1505
1610
|
# A resource ID for a new Application Manager application.
|
@@ -1512,8 +1617,8 @@ module Aws::SSM
|
|
1512
1617
|
# maximum of five tags for an OpsMetadata object. Tags enable you to
|
1513
1618
|
# categorize a resource in different ways, such as by purpose, owner, or
|
1514
1619
|
# environment. For example, you might want to tag an OpsMetadata object
|
1515
|
-
# to identify an environment or target
|
1516
|
-
#
|
1620
|
+
# to identify an environment or target Region. In this case, you could
|
1621
|
+
# specify the following key-value pairs:
|
1517
1622
|
#
|
1518
1623
|
# * `Key=Environment,Value=Production`
|
1519
1624
|
#
|
@@ -1555,18 +1660,14 @@ module Aws::SSM
|
|
1555
1660
|
|
1556
1661
|
# Creates a patch baseline.
|
1557
1662
|
#
|
1558
|
-
# <note markdown="1"> For information about valid key
|
1559
|
-
#
|
1663
|
+
# <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
|
1664
|
+
# supported operating system type, see PatchFilter.
|
1560
1665
|
#
|
1561
1666
|
# </note>
|
1562
1667
|
#
|
1563
|
-
#
|
1564
|
-
#
|
1565
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
|
1566
|
-
#
|
1567
1668
|
# @option params [String] :operating_system
|
1568
1669
|
# Defines the operating system the patch baseline applies to. The
|
1569
|
-
#
|
1670
|
+
# default value is `WINDOWS`.
|
1570
1671
|
#
|
1571
1672
|
# @option params [required, String] :name
|
1572
1673
|
# The name of the patch baseline.
|
@@ -1582,7 +1683,8 @@ module Aws::SSM
|
|
1582
1683
|
#
|
1583
1684
|
# For information about accepted formats for lists of approved patches
|
1584
1685
|
# and rejected patches, see [About package name formats for approved and
|
1585
|
-
# rejected patch lists][1] in the *
|
1686
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
1687
|
+
# User Guide*.
|
1586
1688
|
#
|
1587
1689
|
#
|
1588
1690
|
#
|
@@ -1591,19 +1693,20 @@ module Aws::SSM
|
|
1591
1693
|
# @option params [String] :approved_patches_compliance_level
|
1592
1694
|
# Defines the compliance level for approved patches. When an approved
|
1593
1695
|
# patch is reported as missing, this value describes the severity of the
|
1594
|
-
# compliance violation. The default value is UNSPECIFIED
|
1696
|
+
# compliance violation. The default value is `UNSPECIFIED`.
|
1595
1697
|
#
|
1596
1698
|
# @option params [Boolean] :approved_patches_enable_non_security
|
1597
1699
|
# Indicates whether the list of approved patches includes non-security
|
1598
1700
|
# updates that should be applied to the instances. The default value is
|
1599
|
-
#
|
1701
|
+
# `false`. Applies to Linux instances only.
|
1600
1702
|
#
|
1601
1703
|
# @option params [Array<String>] :rejected_patches
|
1602
1704
|
# A list of explicitly rejected patches for the baseline.
|
1603
1705
|
#
|
1604
1706
|
# For information about accepted formats for lists of approved patches
|
1605
1707
|
# and rejected patches, see [About package name formats for approved and
|
1606
|
-
# rejected patch lists][1] in the *
|
1708
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
1709
|
+
# User Guide*.
|
1607
1710
|
#
|
1608
1711
|
#
|
1609
1712
|
#
|
@@ -1611,19 +1714,20 @@ module Aws::SSM
|
|
1611
1714
|
#
|
1612
1715
|
# @option params [String] :rejected_patches_action
|
1613
1716
|
# The action for Patch Manager to take on patches included in the
|
1614
|
-
# RejectedPackages list.
|
1717
|
+
# `RejectedPackages` list.
|
1615
1718
|
#
|
1616
|
-
# *
|
1617
|
-
# is installed only if it is a dependency of
|
1618
|
-
# considered compliant with the patch baseline,
|
1619
|
-
# reported as
|
1620
|
-
# 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.
|
1621
1724
|
#
|
1622
|
-
# *
|
1623
|
-
# include them as dependencies,
|
1624
|
-
# circumstances. If a package was installed before
|
1625
|
-
# Rejected patches list, it is considered
|
1626
|
-
# 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`.
|
1627
1731
|
#
|
1628
1732
|
# @option params [String] :description
|
1629
1733
|
# A description of the patch baseline.
|
@@ -1645,14 +1749,14 @@ module Aws::SSM
|
|
1645
1749
|
# environment. For example, you might want to tag a patch baseline to
|
1646
1750
|
# identify the severity level of patches it specifies and the operating
|
1647
1751
|
# system family it applies to. In this case, you could specify the
|
1648
|
-
# following key
|
1752
|
+
# following key-value pairs:
|
1649
1753
|
#
|
1650
1754
|
# * `Key=PatchSeverity,Value=Critical`
|
1651
1755
|
#
|
1652
1756
|
# * `Key=OS,Value=Windows`
|
1653
1757
|
#
|
1654
1758
|
# <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
|
1655
|
-
#
|
1759
|
+
# operation.
|
1656
1760
|
#
|
1657
1761
|
# </note>
|
1658
1762
|
#
|
@@ -1727,30 +1831,30 @@ module Aws::SSM
|
|
1727
1831
|
end
|
1728
1832
|
|
1729
1833
|
# A resource data sync helps you view data from multiple sources in a
|
1730
|
-
# single location. Systems Manager offers two types
|
1731
|
-
# sync: `SyncToDestination` and `SyncFromSource`.
|
1834
|
+
# single location. Amazon Web Services Systems Manager offers two types
|
1835
|
+
# of resource data sync: `SyncToDestination` and `SyncFromSource`.
|
1732
1836
|
#
|
1733
1837
|
# You can configure Systems Manager Inventory to use the
|
1734
1838
|
# `SyncToDestination` type to synchronize Inventory data from multiple
|
1735
|
-
#
|
1736
|
-
#
|
1737
|
-
# 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*.
|
1738
1842
|
#
|
1739
1843
|
# You can configure Systems Manager Explorer to use the `SyncFromSource`
|
1740
1844
|
# type to synchronize operational work items (OpsItems) and operational
|
1741
|
-
# data (OpsData) from multiple
|
1742
|
-
# type can synchronize OpsItems and OpsData from multiple
|
1743
|
-
# and Regions or `EntireOrganization` by using
|
1744
|
-
#
|
1745
|
-
#
|
1746
|
-
# 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*.
|
1747
1851
|
#
|
1748
1852
|
# A resource data sync is an asynchronous operation that returns
|
1749
1853
|
# immediately. After a successful initial sync is completed, the system
|
1750
1854
|
# continuously syncs data. To check the status of a sync, use the
|
1751
1855
|
# ListResourceDataSync.
|
1752
1856
|
#
|
1753
|
-
# <note markdown="1"> By default, data
|
1857
|
+
# <note markdown="1"> By default, data isn't encrypted in Amazon S3. We strongly recommend
|
1754
1858
|
# that you enable encryption in Amazon S3 to ensure secure data storage.
|
1755
1859
|
# We also recommend that you secure access to the Amazon S3 bucket by
|
1756
1860
|
# creating a restrictive bucket policy.
|
@@ -1774,9 +1878,9 @@ module Aws::SSM
|
|
1774
1878
|
# synchronizes data to an S3 bucket for Inventory. If you specify
|
1775
1879
|
# `SyncToDestination`, you must provide a value for `S3Destination`.
|
1776
1880
|
# Specify `SyncFromSource` to synchronize data from a single account and
|
1777
|
-
# multiple Regions, or multiple
|
1778
|
-
#
|
1779
|
-
#
|
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
|
1780
1884
|
# `SyncToDestination`.
|
1781
1885
|
#
|
1782
1886
|
# @option params [Types::ResourceDataSyncSource] :sync_source
|
@@ -1825,9 +1929,9 @@ module Aws::SSM
|
|
1825
1929
|
req.send_request(options)
|
1826
1930
|
end
|
1827
1931
|
|
1828
|
-
# Deletes an activation. You
|
1932
|
+
# Deletes an activation. You aren't required to delete an activation.
|
1829
1933
|
# If you delete an activation, you can no longer use it to register
|
1830
|
-
# additional managed instances. Deleting an activation
|
1934
|
+
# additional managed instances. Deleting an activation doesn't
|
1831
1935
|
# de-register managed instances. You must manually de-register managed
|
1832
1936
|
# instances.
|
1833
1937
|
#
|
@@ -1851,17 +1955,17 @@ module Aws::SSM
|
|
1851
1955
|
req.send_request(options)
|
1852
1956
|
end
|
1853
1957
|
|
1854
|
-
# Disassociates the specified
|
1855
|
-
# specified instance.
|
1958
|
+
# Disassociates the specified Amazon Web Services Systems Manager
|
1959
|
+
# document (SSM document) from the specified instance.
|
1856
1960
|
#
|
1857
|
-
# When you disassociate a document from an instance, it
|
1961
|
+
# When you disassociate a document from an instance, it doesn't change
|
1858
1962
|
# the configuration of the instance. To change the configuration state
|
1859
1963
|
# of an instance after you disassociate a document, you must create a
|
1860
1964
|
# new document with the desired configuration and associate it with the
|
1861
1965
|
# instance.
|
1862
1966
|
#
|
1863
1967
|
# @option params [String] :name
|
1864
|
-
# The name of the
|
1968
|
+
# The name of the SSM document.
|
1865
1969
|
#
|
1866
1970
|
# @option params [String] :instance_id
|
1867
1971
|
# The ID of the instance.
|
@@ -1888,8 +1992,8 @@ module Aws::SSM
|
|
1888
1992
|
req.send_request(options)
|
1889
1993
|
end
|
1890
1994
|
|
1891
|
-
# Deletes the Systems Manager document
|
1892
|
-
# the document.
|
1995
|
+
# Deletes the Amazon Web Services Systems Manager document (SSM
|
1996
|
+
# document) and all instance associations to the document.
|
1893
1997
|
#
|
1894
1998
|
# Before you delete the document, we recommend that you use
|
1895
1999
|
# DeleteAssociation to disassociate all instances that are associated
|
@@ -1910,8 +2014,8 @@ module Aws::SSM
|
|
1910
2014
|
# Some SSM document types require that you specify a `Force` flag before
|
1911
2015
|
# you can delete the document. For example, you must specify a `Force`
|
1912
2016
|
# flag to delete a document of type `ApplicationConfigurationSchema`.
|
1913
|
-
# You can restrict access to the `Force` flag in an
|
1914
|
-
#
|
2017
|
+
# You can restrict access to the `Force` flag in an Identity and Access
|
2018
|
+
# Management (IAM) policy.
|
1915
2019
|
#
|
1916
2020
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1917
2021
|
#
|
@@ -1949,8 +2053,8 @@ module Aws::SSM
|
|
1949
2053
|
#
|
1950
2054
|
# DisableSchema: If you choose this option, the system ignores all
|
1951
2055
|
# inventory data for the specified version, and any earlier versions. To
|
1952
|
-
# enable this schema again, you must call the `PutInventory`
|
1953
|
-
# 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.
|
1954
2058
|
#
|
1955
2059
|
# DeleteSchema: This option deletes the specified custom type from the
|
1956
2060
|
# Inventory service. You can recreate the schema later, if you want.
|
@@ -2135,9 +2239,9 @@ module Aws::SSM
|
|
2135
2239
|
req.send_request(options)
|
2136
2240
|
end
|
2137
2241
|
|
2138
|
-
# Deletes a
|
2242
|
+
# Deletes a resource data sync configuration. After the configuration is
|
2139
2243
|
# deleted, changes to data on managed instances are no longer synced to
|
2140
|
-
# or from the target. Deleting a sync configuration
|
2244
|
+
# or from the target. Deleting a sync configuration doesn't delete
|
2141
2245
|
# data.
|
2142
2246
|
#
|
2143
2247
|
# @option params [required, String] :sync_name
|
@@ -2235,7 +2339,7 @@ module Aws::SSM
|
|
2235
2339
|
#
|
2236
2340
|
# @option params [Boolean] :safe
|
2237
2341
|
# The system checks if the target is being referenced by a task. If the
|
2238
|
-
# target is being referenced, the system returns an error and
|
2342
|
+
# target is being referenced, the system returns an error and doesn't
|
2239
2343
|
# deregister the target from the maintenance window.
|
2240
2344
|
#
|
2241
2345
|
# @return [Types::DeregisterTargetFromMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2300,9 +2404,9 @@ module Aws::SSM
|
|
2300
2404
|
end
|
2301
2405
|
|
2302
2406
|
# Describes details about the activation, such as the date and time the
|
2303
|
-
# activation was created, its expiration date, the
|
2304
|
-
# the instances in the activation, and
|
2305
|
-
# 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.
|
2306
2410
|
#
|
2307
2411
|
# @option params [Array<Types::DescribeActivationsFilter>] :filters
|
2308
2412
|
# A filter to view information about your activations.
|
@@ -2365,12 +2469,12 @@ module Aws::SSM
|
|
2365
2469
|
# Describes the association for the specified target or instance. If you
|
2366
2470
|
# created the association by using the `Targets` parameter, then you
|
2367
2471
|
# must retrieve the association by using the association ID. If you
|
2368
|
-
# created the association by specifying an instance ID and
|
2369
|
-
# Manager document, then you retrieve
|
2370
|
-
# 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.
|
2371
2475
|
#
|
2372
2476
|
# @option params [String] :name
|
2373
|
-
# The name of the
|
2477
|
+
# The name of the SSM document.
|
2374
2478
|
#
|
2375
2479
|
# @option params [String] :instance_id
|
2376
2480
|
# The instance ID.
|
@@ -2435,6 +2539,8 @@ module Aws::SSM
|
|
2435
2539
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
2436
2540
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
2437
2541
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
2542
|
+
# resp.association_description.calendar_names #=> Array
|
2543
|
+
# resp.association_description.calendar_names[0] #=> String
|
2438
2544
|
# resp.association_description.target_locations #=> Array
|
2439
2545
|
# resp.association_description.target_locations[0].accounts #=> Array
|
2440
2546
|
# resp.association_description.target_locations[0].accounts[0] #=> String
|
@@ -2453,8 +2559,8 @@ module Aws::SSM
|
|
2453
2559
|
req.send_request(options)
|
2454
2560
|
end
|
2455
2561
|
|
2456
|
-
#
|
2457
|
-
#
|
2562
|
+
# Views information about a specific execution of a specific
|
2563
|
+
# association.
|
2458
2564
|
#
|
2459
2565
|
# @option params [required, String] :association_id
|
2460
2566
|
# The association ID that includes the execution for which you want to
|
@@ -2528,8 +2634,7 @@ module Aws::SSM
|
|
2528
2634
|
req.send_request(options)
|
2529
2635
|
end
|
2530
2636
|
|
2531
|
-
#
|
2532
|
-
# ID.
|
2637
|
+
# Views all executions for a specific association ID.
|
2533
2638
|
#
|
2534
2639
|
# @option params [required, String] :association_id
|
2535
2640
|
# The association ID for which you want to view execution history
|
@@ -2726,8 +2831,8 @@ module Aws::SSM
|
|
2726
2831
|
# next set of results.
|
2727
2832
|
#
|
2728
2833
|
# @option params [Boolean] :reverse_order
|
2729
|
-
#
|
2730
|
-
#
|
2834
|
+
# Indicates whether to list step executions in reverse order by start
|
2835
|
+
# time. The default value is 'false'.
|
2731
2836
|
#
|
2732
2837
|
# @return [Types::DescribeAutomationStepExecutionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2733
2838
|
#
|
@@ -2809,7 +2914,98 @@ module Aws::SSM
|
|
2809
2914
|
# Lists all patches eligible to be included in a patch baseline.
|
2810
2915
|
#
|
2811
2916
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
2812
|
-
#
|
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`
|
2813
3009
|
#
|
2814
3010
|
# @option params [Integer] :max_results
|
2815
3011
|
# The maximum number of patches to return (per page).
|
@@ -2878,10 +3074,11 @@ module Aws::SSM
|
|
2878
3074
|
req.send_request(options)
|
2879
3075
|
end
|
2880
3076
|
|
2881
|
-
# Describes the specified Systems Manager document
|
3077
|
+
# Describes the specified Amazon Web Services Systems Manager document
|
3078
|
+
# (SSM document).
|
2882
3079
|
#
|
2883
3080
|
# @option params [required, String] :name
|
2884
|
-
# The name of the
|
3081
|
+
# The name of the SSM document.
|
2885
3082
|
#
|
2886
3083
|
# @option params [String] :document_version
|
2887
3084
|
# The document version for which you want information. Can be a specific
|
@@ -2890,7 +3087,7 @@ module Aws::SSM
|
|
2890
3087
|
# @option params [String] :version_name
|
2891
3088
|
# An optional field specifying the version of the artifact associated
|
2892
3089
|
# with the document. For example, "Release 12, Update 6". This value
|
2893
|
-
# is unique across all versions of a document, and
|
3090
|
+
# is unique across all versions of a document, and can't be changed.
|
2894
3091
|
#
|
2895
3092
|
# @return [Types::DescribeDocumentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2896
3093
|
#
|
@@ -2910,6 +3107,7 @@ module Aws::SSM
|
|
2910
3107
|
# resp.document.hash #=> String
|
2911
3108
|
# resp.document.hash_type #=> String, one of "Sha256", "Sha1"
|
2912
3109
|
# resp.document.name #=> String
|
3110
|
+
# resp.document.display_name #=> String
|
2913
3111
|
# resp.document.version_name #=> String
|
2914
3112
|
# resp.document.owner #=> String
|
2915
3113
|
# resp.document.created_date #=> Time
|
@@ -2924,7 +3122,7 @@ module Aws::SSM
|
|
2924
3122
|
# resp.document.parameters[0].default_value #=> String
|
2925
3123
|
# resp.document.platform_types #=> Array
|
2926
3124
|
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux"
|
2927
|
-
# 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"
|
2928
3126
|
# resp.document.schema_version #=> String
|
2929
3127
|
# resp.document.latest_version #=> String
|
2930
3128
|
# resp.document.default_version #=> String
|
@@ -2956,10 +3154,10 @@ module Aws::SSM
|
|
2956
3154
|
req.send_request(options)
|
2957
3155
|
end
|
2958
3156
|
|
2959
|
-
# Describes the permissions for a
|
2960
|
-
#
|
2961
|
-
# can either be shared privately (by
|
2962
|
-
# 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*).
|
2963
3161
|
#
|
2964
3162
|
# @option params [required, String] :name
|
2965
3163
|
# The name of the document for which you are the owner.
|
@@ -3058,8 +3256,8 @@ module Aws::SSM
|
|
3058
3256
|
end
|
3059
3257
|
|
3060
3258
|
# Retrieves the current effective patches (the patch and the approval
|
3061
|
-
# state) for the specified patch baseline.
|
3062
|
-
#
|
3259
|
+
# state) for the specified patch baseline. Applies to patch baselines
|
3260
|
+
# for Windows only.
|
3063
3261
|
#
|
3064
3262
|
# @option params [required, String] :baseline_id
|
3065
3263
|
# The ID of the patch baseline to retrieve the effective patches for.
|
@@ -3189,13 +3387,13 @@ module Aws::SSM
|
|
3189
3387
|
# the instance, instance status, and so on.
|
3190
3388
|
#
|
3191
3389
|
# If you specify one or more instance IDs, it returns information for
|
3192
|
-
# those instances. If you
|
3390
|
+
# those instances. If you don't specify instance IDs, it returns
|
3193
3391
|
# information for all your instances. If you specify an instance ID that
|
3194
|
-
#
|
3392
|
+
# isn't valid or an instance that you don't own, you receive an error.
|
3195
3393
|
#
|
3196
|
-
# <note markdown="1"> The IamRole field for this API
|
3197
|
-
#
|
3198
|
-
#
|
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.
|
3199
3397
|
#
|
3200
3398
|
# </note>
|
3201
3399
|
#
|
@@ -3289,7 +3487,7 @@ module Aws::SSM
|
|
3289
3487
|
# Retrieves the high-level patch state of one or more instances.
|
3290
3488
|
#
|
3291
3489
|
# @option params [required, Array<String>] :instance_ids
|
3292
|
-
# The ID of the instance
|
3490
|
+
# The ID of the instance for which patch state information should be
|
3293
3491
|
# retrieved.
|
3294
3492
|
#
|
3295
3493
|
# @option params [String] :next_token
|
@@ -3360,11 +3558,11 @@ module Aws::SSM
|
|
3360
3558
|
# @option params [Array<Types::InstancePatchStateFilter>] :filters
|
3361
3559
|
# Each entry in the array is a structure containing:
|
3362
3560
|
#
|
3363
|
-
# Key (string between 1 and 200 characters)
|
3561
|
+
# * Key (string between 1 and 200 characters)
|
3364
3562
|
#
|
3365
|
-
# Values (array containing a single string)
|
3563
|
+
# * Values (array containing a single string)
|
3366
3564
|
#
|
3367
|
-
# Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
|
3565
|
+
# * Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
|
3368
3566
|
#
|
3369
3567
|
# @option params [String] :next_token
|
3370
3568
|
# The token for the next set of items to return. (You received this
|
@@ -3440,9 +3638,26 @@ module Aws::SSM
|
|
3440
3638
|
# retrieved.
|
3441
3639
|
#
|
3442
3640
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3443
|
-
#
|
3444
|
-
#
|
3445
|
-
#
|
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`
|
3446
3661
|
#
|
3447
3662
|
# @option params [String] :next_token
|
3448
3663
|
# The token for the next set of items to return. (You received this
|
@@ -3497,7 +3712,7 @@ module Aws::SSM
|
|
3497
3712
|
#
|
3498
3713
|
# @option params [String] :deletion_id
|
3499
3714
|
# Specify the delete inventory ID for which you want information. This
|
3500
|
-
# ID was returned by the `DeleteInventory`
|
3715
|
+
# ID was returned by the `DeleteInventory` operation.
|
3501
3716
|
#
|
3502
3717
|
# @option params [String] :next_token
|
3503
3718
|
# A token to start the list. Use this token to get the next set of
|
@@ -3561,8 +3776,9 @@ module Aws::SSM
|
|
3561
3776
|
#
|
3562
3777
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3563
3778
|
# Optional filters used to scope down the returned task invocations. The
|
3564
|
-
# supported filter key is STATUS with the corresponding values
|
3565
|
-
#
|
3779
|
+
# supported filter key is `STATUS` with the corresponding values
|
3780
|
+
# `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`,
|
3781
|
+
# `CANCELLING`, and `CANCELLED`.
|
3566
3782
|
#
|
3567
3783
|
# @option params [Integer] :max_results
|
3568
3784
|
# The maximum number of items to return for this call. The call also
|
@@ -3630,8 +3846,9 @@ module Aws::SSM
|
|
3630
3846
|
#
|
3631
3847
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3632
3848
|
# Optional filters used to scope down the returned tasks. The supported
|
3633
|
-
# filter key is STATUS with the corresponding values PENDING
|
3634
|
-
#
|
3849
|
+
# filter key is `STATUS` with the corresponding values `PENDING`,
|
3850
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and
|
3851
|
+
# `CANCELLED`.
|
3635
3852
|
#
|
3636
3853
|
# @option params [Integer] :max_results
|
3637
3854
|
# The maximum number of items to return for this call. The call also
|
@@ -3696,12 +3913,12 @@ module Aws::SSM
|
|
3696
3913
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3697
3914
|
# Each entry in the array is a structure containing:
|
3698
3915
|
#
|
3699
|
-
# Key
|
3700
|
-
#
|
3701
|
-
# 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`.
|
3702
3918
|
#
|
3703
|
-
#
|
3704
|
-
#
|
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`.
|
3705
3922
|
#
|
3706
3923
|
# @option params [Integer] :max_results
|
3707
3924
|
# The maximum number of items to return for this call. The call also
|
@@ -3760,11 +3977,11 @@ module Aws::SSM
|
|
3760
3977
|
# The ID of the maintenance window to retrieve information about.
|
3761
3978
|
#
|
3762
3979
|
# @option params [Array<Types::Target>] :targets
|
3763
|
-
# The instance ID or key
|
3980
|
+
# The instance ID or key-value pair to retrieve information about.
|
3764
3981
|
#
|
3765
3982
|
# @option params [String] :resource_type
|
3766
3983
|
# The type of resource you want to retrieve information about. For
|
3767
|
-
# example,
|
3984
|
+
# example, `INSTANCE`.
|
3768
3985
|
#
|
3769
3986
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
3770
3987
|
# Filters used to limit the range of results. For example, you can limit
|
@@ -3832,8 +4049,8 @@ module Aws::SSM
|
|
3832
4049
|
#
|
3833
4050
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3834
4051
|
# Optional filters that can be used to narrow down the scope of the
|
3835
|
-
# returned window targets. The supported filter keys are Type
|
3836
|
-
# WindowTargetId and OwnerInformation
|
4052
|
+
# returned window targets. The supported filter keys are `Type`,
|
4053
|
+
# `WindowTargetId`, and `OwnerInformation`.
|
3837
4054
|
#
|
3838
4055
|
# @option params [Integer] :max_results
|
3839
4056
|
# The maximum number of items to return for this call. The call also
|
@@ -3891,10 +4108,10 @@ module Aws::SSM
|
|
3891
4108
|
|
3892
4109
|
# Lists the tasks in a maintenance window.
|
3893
4110
|
#
|
3894
|
-
# <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
|
3895
4112
|
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
3896
4113
|
# system inserts a placeholder value of `1`, which may be reported in
|
3897
|
-
# the response to this command. These values
|
4114
|
+
# the response to this command. These values don't affect the running
|
3898
4115
|
# of your task and can be ignored.
|
3899
4116
|
#
|
3900
4117
|
# </note>
|
@@ -3904,8 +4121,8 @@ module Aws::SSM
|
|
3904
4121
|
#
|
3905
4122
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3906
4123
|
# Optional filters used to narrow down the scope of the returned tasks.
|
3907
|
-
# The supported filter keys are WindowTaskId
|
3908
|
-
# TaskType
|
4124
|
+
# The supported filter keys are `WindowTaskId`, `TaskArn`, `Priority`,
|
4125
|
+
# and `TaskType`.
|
3909
4126
|
#
|
3910
4127
|
# @option params [Integer] :max_results
|
3911
4128
|
# The maximum number of items to return for this call. The call also
|
@@ -3971,12 +4188,12 @@ module Aws::SSM
|
|
3971
4188
|
req.send_request(options)
|
3972
4189
|
end
|
3973
4190
|
|
3974
|
-
# Retrieves the maintenance windows in an
|
4191
|
+
# Retrieves the maintenance windows in an account.
|
3975
4192
|
#
|
3976
4193
|
# @option params [Array<Types::MaintenanceWindowFilter>] :filters
|
3977
4194
|
# Optional filters used to narrow down the scope of the returned
|
3978
|
-
# maintenance windows. Supported filter keys are
|
3979
|
-
#
|
4195
|
+
# maintenance windows. Supported filter keys are `Name` and `Enabled`.
|
4196
|
+
# For example, `Name=MyMaintenanceWindow` and `Enabled=True`.
|
3980
4197
|
#
|
3981
4198
|
# @option params [Integer] :max_results
|
3982
4199
|
# The maximum number of items to return for this call. The call also
|
@@ -4037,11 +4254,11 @@ module Aws::SSM
|
|
4037
4254
|
# that an instance is associated with.
|
4038
4255
|
#
|
4039
4256
|
# @option params [required, Array<Types::Target>] :targets
|
4040
|
-
# The instance ID or key
|
4257
|
+
# The instance ID or key-value pair to retrieve information about.
|
4041
4258
|
#
|
4042
4259
|
# @option params [required, String] :resource_type
|
4043
4260
|
# The type of resource you want to retrieve information about. For
|
4044
|
-
# example,
|
4261
|
+
# example, `INSTANCE`.
|
4045
4262
|
#
|
4046
4263
|
# @option params [Integer] :max_results
|
4047
4264
|
# The maximum number of items to return for this call. The call also
|
@@ -4089,16 +4306,17 @@ module Aws::SSM
|
|
4089
4306
|
req.send_request(options)
|
4090
4307
|
end
|
4091
4308
|
|
4092
|
-
# Query a set of OpsItems. You must have permission in
|
4309
|
+
# Query a set of OpsItems. You must have permission in Identity and
|
4093
4310
|
# Access Management (IAM) to query a list of OpsItems. For more
|
4094
|
-
# information, see [Getting started with OpsCenter][1] in the *
|
4095
|
-
# Systems Manager User Guide*.
|
4096
|
-
#
|
4097
|
-
# Operations engineers and IT professionals use
|
4098
|
-
# investigate, and remediate
|
4099
|
-
# performance and health of their
|
4100
|
-
#
|
4101
|
-
# 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*.
|
4102
4320
|
#
|
4103
4321
|
#
|
4104
4322
|
#
|
@@ -4132,11 +4350,11 @@ module Aws::SSM
|
|
4132
4350
|
#
|
4133
4351
|
# Operations: Equals
|
4134
4352
|
#
|
4135
|
-
# * Key: Title
|
4353
|
+
# * Key: Title*
|
4136
4354
|
#
|
4137
|
-
# Operations: Contains
|
4355
|
+
# Operations: Equals,Contains
|
4138
4356
|
#
|
4139
|
-
# * Key: OperationalData
|
4357
|
+
# * Key: OperationalData**
|
4140
4358
|
#
|
4141
4359
|
# Operations: Equals
|
4142
4360
|
#
|
@@ -4160,7 +4378,11 @@ module Aws::SSM
|
|
4160
4378
|
#
|
4161
4379
|
# Operations: Equals
|
4162
4380
|
#
|
4163
|
-
# *
|
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,
|
4164
4386
|
# specify a key-value pair by using the following JSON format:
|
4165
4387
|
# \\\{"key":"key\_name","value":"a\_value"\\}
|
4166
4388
|
#
|
@@ -4185,7 +4407,7 @@ module Aws::SSM
|
|
4185
4407
|
# resp = client.describe_ops_items({
|
4186
4408
|
# ops_item_filters: [
|
4187
4409
|
# {
|
4188
|
-
# 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
|
4189
4411
|
# values: ["OpsItemFilterValue"], # required
|
4190
4412
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
4191
4413
|
# },
|
@@ -4204,7 +4426,7 @@ module Aws::SSM
|
|
4204
4426
|
# resp.ops_item_summaries[0].last_modified_time #=> Time
|
4205
4427
|
# resp.ops_item_summaries[0].priority #=> Integer
|
4206
4428
|
# resp.ops_item_summaries[0].source #=> String
|
4207
|
-
# 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"
|
4208
4430
|
# resp.ops_item_summaries[0].ops_item_id #=> String
|
4209
4431
|
# resp.ops_item_summaries[0].title #=> String
|
4210
4432
|
# resp.ops_item_summaries[0].operational_data #=> Hash
|
@@ -4229,7 +4451,7 @@ module Aws::SSM
|
|
4229
4451
|
|
4230
4452
|
# Get information about a parameter.
|
4231
4453
|
#
|
4232
|
-
#
|
4454
|
+
# Request results are returned on a best-effort basis. If you specify
|
4233
4455
|
# `MaxResults` in the request, the response includes information up to
|
4234
4456
|
# the limit specified. The number of items returned, however, can be
|
4235
4457
|
# between zero and the value of `MaxResults`. If the service reaches an
|
@@ -4238,8 +4460,6 @@ module Aws::SSM
|
|
4238
4460
|
# You can specify the `NextToken` in a subsequent call to get the next
|
4239
4461
|
# set of results.
|
4240
4462
|
#
|
4241
|
-
# </note>
|
4242
|
-
#
|
4243
4463
|
# @option params [Array<Types::ParametersFilter>] :filters
|
4244
4464
|
# This data type is deprecated. Instead, use `ParameterFilters`.
|
4245
4465
|
#
|
@@ -4310,15 +4530,24 @@ module Aws::SSM
|
|
4310
4530
|
req.send_request(options)
|
4311
4531
|
end
|
4312
4532
|
|
4313
|
-
# Lists the patch baselines in your
|
4533
|
+
# Lists the patch baselines in your account.
|
4314
4534
|
#
|
4315
4535
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
4316
|
-
# 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>
|
4317
4545
|
#
|
4318
|
-
#
|
4546
|
+
# Sample values: `AWS` \| `Self`
|
4319
4547
|
#
|
4320
|
-
#
|
4321
|
-
#
|
4548
|
+
# * <b> <code>OPERATING_SYSTEM</code> </b>
|
4549
|
+
#
|
4550
|
+
# Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
|
4322
4551
|
#
|
4323
4552
|
# @option params [Integer] :max_results
|
4324
4553
|
# The maximum number of patch baselines to return (per page).
|
@@ -4366,8 +4595,8 @@ module Aws::SSM
|
|
4366
4595
|
req.send_request(options)
|
4367
4596
|
end
|
4368
4597
|
|
4369
|
-
# Returns high-level aggregated patch compliance state for a
|
4370
|
-
# group.
|
4598
|
+
# Returns high-level aggregated patch compliance state information for a
|
4599
|
+
# patch group.
|
4371
4600
|
#
|
4372
4601
|
# @option params [required, String] :patch_group
|
4373
4602
|
# The name of the patch group whose patch snapshot should be retrieved.
|
@@ -4423,24 +4652,17 @@ module Aws::SSM
|
|
4423
4652
|
# The maximum number of patch groups to return (per page).
|
4424
4653
|
#
|
4425
4654
|
# @option params [Array<Types::PatchOrchestratorFilter>] :filters
|
4426
|
-
#
|
4427
|
-
# results.
|
4655
|
+
# Each element in the array is a structure containing a key-value pair.
|
4428
4656
|
#
|
4429
|
-
#
|
4657
|
+
# Supported keys for `DescribePatchGroups` include the following:
|
4430
4658
|
#
|
4431
|
-
# *
|
4432
|
-
# accepted.
|
4659
|
+
# * <b> <code>NAME_PREFIX</code> </b>
|
4433
4660
|
#
|
4434
|
-
#
|
4435
|
-
# results for. For valid operating system values, see
|
4436
|
-
# GetDefaultPatchBaselineRequest$OperatingSystem in
|
4437
|
-
# CreatePatchBaseline.
|
4661
|
+
# Sample values: `AWS-` \| `My-`.
|
4438
4662
|
#
|
4439
|
-
#
|
4663
|
+
# * <b> <code>OPERATING_SYSTEM</code> </b>
|
4440
4664
|
#
|
4441
|
-
#
|
4442
|
-
#
|
4443
|
-
# * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
|
4665
|
+
# Sample values: `AMAZON_LINUX` \| `SUSE` \| `WINDOWS`
|
4444
4666
|
#
|
4445
4667
|
# @option params [String] :next_token
|
4446
4668
|
# The token for the next set of items to return. (You received this
|
@@ -4489,7 +4711,7 @@ module Aws::SSM
|
|
4489
4711
|
# Lists the properties of available patches organized by product,
|
4490
4712
|
# product family, classification, severity, and other properties of
|
4491
4713
|
# available patches. You can use the reported properties in the filters
|
4492
|
-
# you specify in requests for
|
4714
|
+
# you specify in requests for operations such as CreatePatchBaseline,
|
4493
4715
|
# UpdatePatchBaseline, DescribeAvailablePatches, and
|
4494
4716
|
# DescribePatchBaselines.
|
4495
4717
|
#
|
@@ -4498,44 +4720,44 @@ module Aws::SSM
|
|
4498
4720
|
#
|
4499
4721
|
# AMAZON\_LINUX
|
4500
4722
|
#
|
4501
|
-
# : Valid properties: PRODUCT
|
4723
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4502
4724
|
#
|
4503
4725
|
# AMAZON\_LINUX\_2
|
4504
4726
|
#
|
4505
|
-
# : Valid properties: PRODUCT
|
4727
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4506
4728
|
#
|
4507
4729
|
# CENTOS
|
4508
4730
|
#
|
4509
|
-
# : Valid properties: PRODUCT
|
4731
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4510
4732
|
#
|
4511
4733
|
# DEBIAN
|
4512
4734
|
#
|
4513
|
-
# : Valid properties: PRODUCT
|
4735
|
+
# : Valid properties: `PRODUCT` \| `PRIORITY`
|
4514
4736
|
#
|
4515
4737
|
# MACOS
|
4516
4738
|
#
|
4517
|
-
# : Valid properties: PRODUCT
|
4739
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION`
|
4518
4740
|
#
|
4519
4741
|
# ORACLE\_LINUX
|
4520
4742
|
#
|
4521
|
-
# : Valid properties: PRODUCT
|
4743
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4522
4744
|
#
|
4523
4745
|
# REDHAT\_ENTERPRISE\_LINUX
|
4524
4746
|
#
|
4525
|
-
# : Valid properties: PRODUCT
|
4747
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4526
4748
|
#
|
4527
4749
|
# SUSE
|
4528
4750
|
#
|
4529
|
-
# : Valid properties: PRODUCT
|
4751
|
+
# : Valid properties: `PRODUCT` \| `CLASSIFICATION` \| `SEVERITY`
|
4530
4752
|
#
|
4531
4753
|
# UBUNTU
|
4532
4754
|
#
|
4533
|
-
# : Valid properties: PRODUCT
|
4755
|
+
# : Valid properties: `PRODUCT` \| `PRIORITY`
|
4534
4756
|
#
|
4535
4757
|
# WINDOWS
|
4536
4758
|
#
|
4537
|
-
# : Valid properties: PRODUCT
|
4538
|
-
#
|
4759
|
+
# : Valid properties: `PRODUCT` \| `PRODUCT_FAMILY` \| `CLASSIFICATION`
|
4760
|
+
# \| `MSRC_SEVERITY`
|
4539
4761
|
#
|
4540
4762
|
# @option params [required, String] :operating_system
|
4541
4763
|
# The operating system type for which to list patches.
|
@@ -4545,8 +4767,8 @@ module Aws::SSM
|
|
4545
4767
|
#
|
4546
4768
|
# @option params [String] :patch_set
|
4547
4769
|
# Indicates whether to list patches for the Windows operating system or
|
4548
|
-
# for Microsoft
|
4549
|
-
# operating systems.
|
4770
|
+
# for applications released by Microsoft. Not applicable for the Linux
|
4771
|
+
# or macOS operating systems.
|
4550
4772
|
#
|
4551
4773
|
# @option params [Integer] :max_results
|
4552
4774
|
# The maximum number of items to return for this call. The call also
|
@@ -4655,12 +4877,43 @@ module Aws::SSM
|
|
4655
4877
|
req.send_request(options)
|
4656
4878
|
end
|
4657
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
|
+
|
4658
4911
|
# Get detailed information about a particular Automation execution.
|
4659
4912
|
#
|
4660
4913
|
# @option params [required, String] :automation_execution_id
|
4661
4914
|
# The unique identifier for an existing automation execution to examine.
|
4662
4915
|
# The execution ID is returned by StartAutomationExecution when the
|
4663
|
-
# execution of an Automation
|
4916
|
+
# execution of an Automation runbook is initiated.
|
4664
4917
|
#
|
4665
4918
|
# @return [Types::GetAutomationExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4666
4919
|
#
|
@@ -4799,20 +5052,22 @@ module Aws::SSM
|
|
4799
5052
|
req.send_request(options)
|
4800
5053
|
end
|
4801
5054
|
|
4802
|
-
# Gets the state of
|
4803
|
-
#
|
4804
|
-
# returns the state of the calendar at
|
4805
|
-
#
|
4806
|
-
#
|
4807
|
-
#
|
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`.
|
4808
5062
|
#
|
4809
5063
|
# If you specify more than one calendar in a request, the command
|
4810
5064
|
# returns the status of `OPEN` only if all calendars in the request are
|
4811
5065
|
# open. If one or more calendars in the request are closed, the status
|
4812
5066
|
# returned is `CLOSED`.
|
4813
5067
|
#
|
4814
|
-
# For more information about
|
4815
|
-
# 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
|
4816
5071
|
# Guide*.
|
4817
5072
|
#
|
4818
5073
|
#
|
@@ -4821,13 +5076,13 @@ module Aws::SSM
|
|
4821
5076
|
#
|
4822
5077
|
# @option params [required, Array<String>] :calendar_names
|
4823
5078
|
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
4824
|
-
# documents that represent the calendar entries for
|
4825
|
-
# get the state.
|
5079
|
+
# documents (SSM documents) that represent the calendar entries for
|
5080
|
+
# which you want to get the state.
|
4826
5081
|
#
|
4827
5082
|
# @option params [String] :at_time
|
4828
5083
|
# (Optional) The specific time for which you want to get calendar state
|
4829
|
-
# information, in [ISO 8601][1] format. If you
|
4830
|
-
# 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.
|
4831
5086
|
#
|
4832
5087
|
#
|
4833
5088
|
#
|
@@ -4876,7 +5131,7 @@ module Aws::SSM
|
|
4876
5131
|
# (Required) The ID of the managed instance targeted by the command. A
|
4877
5132
|
# managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2)
|
4878
5133
|
# instance or an instance in your hybrid environment that is configured
|
4879
|
-
# for
|
5134
|
+
# for Amazon Web Services Systems Manager.
|
4880
5135
|
#
|
4881
5136
|
# @option params [String] :plugin_name
|
4882
5137
|
# The name of the plugin for which you want detailed results. If the
|
@@ -4886,7 +5141,8 @@ module Aws::SSM
|
|
4886
5141
|
# details.
|
4887
5142
|
#
|
4888
5143
|
# Plugin names are also referred to as *step names* in Systems Manager
|
4889
|
-
# documents. For example, `aws:RunShellScript` is a
|
5144
|
+
# documents (SSM documents). For example, `aws:RunShellScript` is a
|
5145
|
+
# plugin.
|
4890
5146
|
#
|
4891
5147
|
# To find the `PluginName`, check the document content and find the name
|
4892
5148
|
# of the plugin. Alternatively, use ListCommandInvocations with the
|
@@ -4988,11 +5244,12 @@ module Aws::SSM
|
|
4988
5244
|
req.send_request(options)
|
4989
5245
|
end
|
4990
5246
|
|
4991
|
-
# Retrieves the default patch baseline.
|
4992
|
-
# supports creating multiple default patch baselines. For
|
4993
|
-
# 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.
|
4994
5251
|
#
|
4995
|
-
# If you
|
5252
|
+
# If you don't specify an operating system value, the default patch
|
4996
5253
|
# baseline for Windows is returned.
|
4997
5254
|
#
|
4998
5255
|
# @option params [String] :operating_system
|
@@ -5024,15 +5281,27 @@ module Aws::SSM
|
|
5024
5281
|
end
|
5025
5282
|
|
5026
5283
|
# Retrieves the current snapshot for the patch baseline the instance
|
5027
|
-
# uses. This API is primarily used by the AWS-RunPatchBaseline Systems
|
5028
|
-
# 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>
|
5029
5297
|
#
|
5030
5298
|
# @option params [required, String] :instance_id
|
5031
5299
|
# The ID of the instance for which the appropriate patch snapshot should
|
5032
5300
|
# be retrieved.
|
5033
5301
|
#
|
5034
5302
|
# @option params [required, String] :snapshot_id
|
5035
|
-
# The user
|
5303
|
+
# The snapshot ID provided by the user when running
|
5304
|
+
# `AWS-RunPatchBaseline`.
|
5036
5305
|
#
|
5037
5306
|
# @option params [Types::BaselineOverride] :baseline_override
|
5038
5307
|
# Defines the basic information about a patch baseline override.
|
@@ -5108,10 +5377,11 @@ module Aws::SSM
|
|
5108
5377
|
req.send_request(options)
|
5109
5378
|
end
|
5110
5379
|
|
5111
|
-
# Gets the contents of the specified Systems Manager
|
5380
|
+
# Gets the contents of the specified Amazon Web Services Systems Manager
|
5381
|
+
# document (SSM document).
|
5112
5382
|
#
|
5113
5383
|
# @option params [required, String] :name
|
5114
|
-
# The name of the
|
5384
|
+
# The name of the SSM document.
|
5115
5385
|
#
|
5116
5386
|
# @option params [String] :version_name
|
5117
5387
|
# An optional field specifying the version of the artifact associated
|
@@ -5128,6 +5398,8 @@ module Aws::SSM
|
|
5128
5398
|
# @return [Types::GetDocumentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5129
5399
|
#
|
5130
5400
|
# * {Types::GetDocumentResult#name #name} => String
|
5401
|
+
# * {Types::GetDocumentResult#created_date #created_date} => Time
|
5402
|
+
# * {Types::GetDocumentResult#display_name #display_name} => String
|
5131
5403
|
# * {Types::GetDocumentResult#version_name #version_name} => String
|
5132
5404
|
# * {Types::GetDocumentResult#document_version #document_version} => String
|
5133
5405
|
# * {Types::GetDocumentResult#status #status} => String
|
@@ -5151,12 +5423,14 @@ module Aws::SSM
|
|
5151
5423
|
# @example Response structure
|
5152
5424
|
#
|
5153
5425
|
# resp.name #=> String
|
5426
|
+
# resp.created_date #=> Time
|
5427
|
+
# resp.display_name #=> String
|
5154
5428
|
# resp.version_name #=> String
|
5155
5429
|
# resp.document_version #=> String
|
5156
5430
|
# resp.status #=> String, one of "Creating", "Active", "Updating", "Deleting", "Failed"
|
5157
5431
|
# resp.status_information #=> String
|
5158
5432
|
# resp.content #=> String
|
5159
|
-
# 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"
|
5160
5434
|
# resp.document_format #=> String, one of "YAML", "JSON", "TEXT"
|
5161
5435
|
# resp.requires #=> Array
|
5162
5436
|
# resp.requires[0].name #=> String
|
@@ -5552,10 +5826,10 @@ module Aws::SSM
|
|
5552
5826
|
|
5553
5827
|
# Lists the tasks in a maintenance window.
|
5554
5828
|
#
|
5555
|
-
# <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
|
5556
5830
|
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
5557
5831
|
# system inserts a placeholder value of `1`, which may be reported in
|
5558
|
-
# the response to this command. These values
|
5832
|
+
# the response to this command. These values don't affect the running
|
5559
5833
|
# of your task and can be ignored.
|
5560
5834
|
#
|
5561
5835
|
# </note>
|
@@ -5649,15 +5923,16 @@ module Aws::SSM
|
|
5649
5923
|
end
|
5650
5924
|
|
5651
5925
|
# Get information about an OpsItem by using the ID. You must have
|
5652
|
-
# permission in
|
5653
|
-
#
|
5654
|
-
#
|
5655
|
-
#
|
5656
|
-
# Operations engineers and IT professionals use
|
5657
|
-
# investigate, and remediate
|
5658
|
-
# performance and health of their
|
5659
|
-
#
|
5660
|
-
# 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*.
|
5661
5936
|
#
|
5662
5937
|
#
|
5663
5938
|
#
|
@@ -5690,7 +5965,7 @@ module Aws::SSM
|
|
5690
5965
|
# resp.ops_item.priority #=> Integer
|
5691
5966
|
# resp.ops_item.related_ops_items #=> Array
|
5692
5967
|
# resp.ops_item.related_ops_items[0].ops_item_id #=> String
|
5693
|
-
# 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"
|
5694
5969
|
# resp.ops_item.ops_item_id #=> String
|
5695
5970
|
# resp.ops_item.version #=> String
|
5696
5971
|
# resp.ops_item.title #=> String
|
@@ -5759,20 +6034,25 @@ module Aws::SSM
|
|
5759
6034
|
req.send_request(options)
|
5760
6035
|
end
|
5761
6036
|
|
5762
|
-
# 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.
|
5763
6043
|
#
|
5764
6044
|
# @option params [String] :sync_name
|
5765
6045
|
# Specify the name of a resource data sync to get.
|
5766
6046
|
#
|
5767
6047
|
# @option params [Array<Types::OpsFilter>] :filters
|
5768
|
-
# Optional filters used to scope down the returned
|
6048
|
+
# Optional filters used to scope down the returned OpsData.
|
5769
6049
|
#
|
5770
6050
|
# @option params [Array<Types::OpsAggregator>] :aggregators
|
5771
|
-
# Optional aggregators that return counts of
|
6051
|
+
# Optional aggregators that return counts of OpsData based on one or
|
5772
6052
|
# more expressions.
|
5773
6053
|
#
|
5774
6054
|
# @option params [Array<Types::OpsResultAttribute>] :result_attributes
|
5775
|
-
# The
|
6055
|
+
# The OpsData data type to return.
|
5776
6056
|
#
|
5777
6057
|
# @option params [String] :next_token
|
5778
6058
|
# A token to start the list. Use this token to get the next set of
|
@@ -5851,14 +6131,14 @@ module Aws::SSM
|
|
5851
6131
|
end
|
5852
6132
|
|
5853
6133
|
# Get information about a parameter by using the parameter name. Don't
|
5854
|
-
# confuse this API
|
6134
|
+
# confuse this API operation with the GetParameters API operation.
|
5855
6135
|
#
|
5856
6136
|
# @option params [required, String] :name
|
5857
6137
|
# The name of the parameter you want to query.
|
5858
6138
|
#
|
5859
6139
|
# @option params [Boolean] :with_decryption
|
5860
6140
|
# Return decrypted values for secure string parameters. This flag is
|
5861
|
-
# ignored for String and StringList parameter types.
|
6141
|
+
# ignored for `String` and `StringList` parameter types.
|
5862
6142
|
#
|
5863
6143
|
# @return [Types::GetParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5864
6144
|
#
|
@@ -5899,7 +6179,7 @@ module Aws::SSM
|
|
5899
6179
|
#
|
5900
6180
|
# @option params [Boolean] :with_decryption
|
5901
6181
|
# Return decrypted values for secure string parameters. This flag is
|
5902
|
-
# ignored for String and StringList parameter types.
|
6182
|
+
# ignored for `String` and `StringList` parameter types.
|
5903
6183
|
#
|
5904
6184
|
# @option params [Integer] :max_results
|
5905
6185
|
# The maximum number of items to return for this call. The call also
|
@@ -5957,16 +6237,16 @@ module Aws::SSM
|
|
5957
6237
|
req.send_request(options)
|
5958
6238
|
end
|
5959
6239
|
|
5960
|
-
# Get details of a parameter. Don't confuse this API
|
5961
|
-
# GetParameter API
|
6240
|
+
# Get details of a parameter. Don't confuse this API operation with the
|
6241
|
+
# GetParameter API operation.
|
5962
6242
|
#
|
5963
6243
|
# @option params [required, Array<String>] :names
|
5964
6244
|
# Names of the parameters for which you want to query information.
|
5965
6245
|
#
|
5966
6246
|
# @option params [Boolean] :with_decryption
|
5967
6247
|
# Return decrypted secure string value. Return decrypted values for
|
5968
|
-
# secure string parameters. This flag is ignored for String and
|
5969
|
-
# StringList parameter types.
|
6248
|
+
# secure string parameters. This flag is ignored for `String` and
|
6249
|
+
# `StringList` parameter types.
|
5970
6250
|
#
|
5971
6251
|
# @return [Types::GetParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5972
6252
|
#
|
@@ -6007,7 +6287,7 @@ module Aws::SSM
|
|
6007
6287
|
# Retrieve information about one or more parameters in a specific
|
6008
6288
|
# hierarchy.
|
6009
6289
|
#
|
6010
|
-
#
|
6290
|
+
# Request results are returned on a best-effort basis. If you specify
|
6011
6291
|
# `MaxResults` in the request, the response includes information up to
|
6012
6292
|
# the limit specified. The number of items returned, however, can be
|
6013
6293
|
# between zero and the value of `MaxResults`. If the service reaches an
|
@@ -6016,13 +6296,11 @@ module Aws::SSM
|
|
6016
6296
|
# You can specify the `NextToken` in a subsequent call to get the next
|
6017
6297
|
# set of results.
|
6018
6298
|
#
|
6019
|
-
# </note>
|
6020
|
-
#
|
6021
6299
|
# @option params [required, String] :path
|
6022
6300
|
# The hierarchy for the parameter. Hierarchies start with a forward
|
6023
6301
|
# slash (/). The hierachy is the parameter name except the last part of
|
6024
6302
|
# the parameter. For the API call to succeeed, the last part of the
|
6025
|
-
# parameter name
|
6303
|
+
# parameter name can't be in the path. A parameter name hierarchy can
|
6026
6304
|
# have a maximum of 15 levels. Here is an example of a hierarchy:
|
6027
6305
|
# `/Finance/Prod/IAD/WinServ2016/license33 `
|
6028
6306
|
#
|
@@ -6033,7 +6311,7 @@ module Aws::SSM
|
|
6033
6311
|
# that path. For example, if a user has permission to access path `/a`,
|
6034
6312
|
# then the user can also access `/a/b`. Even if a user has explicitly
|
6035
6313
|
# been denied access in IAM for parameter `/a/b`, they can still call
|
6036
|
-
# the GetParametersByPath API
|
6314
|
+
# the GetParametersByPath API operation recursively for `/a` and view
|
6037
6315
|
# `/a/b`.
|
6038
6316
|
#
|
6039
6317
|
# @option params [Array<Types::ParameterStringFilter>] :parameter_filters
|
@@ -6218,31 +6496,41 @@ module Aws::SSM
|
|
6218
6496
|
req.send_request(options)
|
6219
6497
|
end
|
6220
6498
|
|
6221
|
-
# `ServiceSetting` is an account-level setting for an
|
6222
|
-
# setting defines how a user interacts with or
|
6223
|
-
# feature of a service. For example, if an
|
6224
|
-
# the account based on feature or
|
6225
|
-
#
|
6226
|
-
#
|
6227
|
-
#
|
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.
|
6228
6507
|
#
|
6229
|
-
# Services map a `SettingId` object to a setting value.
|
6230
|
-
# teams define the default value for a `SettingId`.
|
6231
|
-
# new `SettingId`, but you can overwrite the default
|
6232
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
6233
|
-
# UpdateServiceSetting API
|
6234
|
-
#
|
6235
|
-
# 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.
|
6236
6516
|
#
|
6237
6517
|
# Query the current service setting for the account.
|
6238
6518
|
#
|
6239
6519
|
# @option params [required, String] :setting_id
|
6240
|
-
# The ID of the service setting to get. The setting ID can be
|
6241
|
-
#
|
6242
|
-
#
|
6243
|
-
# `/ssm/
|
6244
|
-
#
|
6245
|
-
# `/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`
|
6246
6534
|
#
|
6247
6535
|
# @return [Types::GetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6248
6536
|
#
|
@@ -6273,10 +6561,10 @@ module Aws::SSM
|
|
6273
6561
|
end
|
6274
6562
|
|
6275
6563
|
# A parameter label is a user-defined alias to help you manage different
|
6276
|
-
# versions of a parameter. When you modify a parameter,
|
6277
|
-
# automatically saves a new version and
|
6278
|
-
# one. A label can help you remember
|
6279
|
-
# 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.
|
6280
6568
|
#
|
6281
6569
|
# Parameter labels have the following requirements and restrictions.
|
6282
6570
|
#
|
@@ -6299,9 +6587,9 @@ module Aws::SSM
|
|
6299
6587
|
# * Labels can contain letters (case sensitive), numbers, periods (.),
|
6300
6588
|
# hyphens (-), or underscores (\_).
|
6301
6589
|
#
|
6302
|
-
# * Labels can't begin with a number, "aws
|
6590
|
+
# * Labels can't begin with a number, "`aws`" or "`ssm`" (not case
|
6303
6591
|
# sensitive). If a label fails to meet these requirements, then the
|
6304
|
-
# label
|
6592
|
+
# label isn't associated with a parameter and the system displays it
|
6305
6593
|
# in the list of InvalidLabels.
|
6306
6594
|
#
|
6307
6595
|
# @option params [required, String] :name
|
@@ -6398,6 +6686,8 @@ module Aws::SSM
|
|
6398
6686
|
# resp.association_versions[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
6399
6687
|
# resp.association_versions[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
6400
6688
|
# resp.association_versions[0].apply_only_at_cron_interval #=> Boolean
|
6689
|
+
# resp.association_versions[0].calendar_names #=> Array
|
6690
|
+
# resp.association_versions[0].calendar_names[0] #=> String
|
6401
6691
|
# resp.association_versions[0].target_locations #=> Array
|
6402
6692
|
# resp.association_versions[0].target_locations[0].accounts #=> Array
|
6403
6693
|
# resp.association_versions[0].target_locations[0].accounts[0] #=> String
|
@@ -6417,9 +6707,10 @@ module Aws::SSM
|
|
6417
6707
|
req.send_request(options)
|
6418
6708
|
end
|
6419
6709
|
|
6420
|
-
# Returns all State Manager associations in the current
|
6710
|
+
# Returns all State Manager associations in the current account and
|
6421
6711
|
# Region. You can limit the results to a specific State Manager
|
6422
|
-
# 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.
|
6423
6714
|
#
|
6424
6715
|
# @option params [Array<Types::AssociationFilter>] :association_filter_list
|
6425
6716
|
# One or more filters. Use a filter to return a more specific list of
|
@@ -6428,7 +6719,7 @@ module Aws::SSM
|
|
6428
6719
|
# <note markdown="1"> Filtering associations using the `InstanceID` attribute only returns
|
6429
6720
|
# legacy associations created using the `InstanceID` attribute.
|
6430
6721
|
# Associations targeting the instance that are part of the Target
|
6431
|
-
# Attributes `ResourceGroup` or `Tags`
|
6722
|
+
# Attributes `ResourceGroup` or `Tags` aren't returned.
|
6432
6723
|
#
|
6433
6724
|
# </note>
|
6434
6725
|
#
|
@@ -6493,9 +6784,9 @@ module Aws::SSM
|
|
6493
6784
|
|
6494
6785
|
# An invocation is copy of a command sent to a specific instance. A
|
6495
6786
|
# command can apply to one or more instances. A command invocation
|
6496
|
-
# applies to one instance. For example, if a user runs SendCommand
|
6787
|
+
# applies to one instance. For example, if a user runs `SendCommand`
|
6497
6788
|
# against three instances, then a command invocation is created for each
|
6498
|
-
# requested instance ID. ListCommandInvocations provide status about
|
6789
|
+
# requested instance ID. `ListCommandInvocations` provide status about
|
6499
6790
|
# command execution.
|
6500
6791
|
#
|
6501
6792
|
# @option params [String] :command_id
|
@@ -6519,7 +6810,7 @@ module Aws::SSM
|
|
6519
6810
|
#
|
6520
6811
|
# @option params [Boolean] :details
|
6521
6812
|
# (Optional) If set this returns the response of the command executions
|
6522
|
-
# and any command output. The default value is
|
6813
|
+
# and any command output. The default value is `false`.
|
6523
6814
|
#
|
6524
6815
|
# @return [Types::ListCommandInvocationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6525
6816
|
#
|
@@ -6590,7 +6881,7 @@ module Aws::SSM
|
|
6590
6881
|
req.send_request(options)
|
6591
6882
|
end
|
6592
6883
|
|
6593
|
-
# Lists the commands requested by users of the
|
6884
|
+
# Lists the commands requested by users of the account.
|
6594
6885
|
#
|
6595
6886
|
# @option params [String] :command_id
|
6596
6887
|
# (Optional) If provided, lists only the specified command.
|
@@ -6599,7 +6890,7 @@ module Aws::SSM
|
|
6599
6890
|
# (Optional) Lists commands issued against this instance ID.
|
6600
6891
|
#
|
6601
6892
|
# <note markdown="1"> You can't specify an instance ID in the same command that you specify
|
6602
|
-
# `Status` = `Pending`. This is because the command
|
6893
|
+
# `Status` = `Pending`. This is because the command hasn't reached the
|
6603
6894
|
# instance yet.
|
6604
6895
|
#
|
6605
6896
|
# </note>
|
@@ -6687,7 +6978,7 @@ module Aws::SSM
|
|
6687
6978
|
req.send_request(options)
|
6688
6979
|
end
|
6689
6980
|
|
6690
|
-
# For a specified resource ID, this API
|
6981
|
+
# For a specified resource ID, this API operation returns a list of
|
6691
6982
|
# compliance statuses for different resource types. Currently, you can
|
6692
6983
|
# only specify one resource ID per call. List results depend on the
|
6693
6984
|
# criteria specified in the filter.
|
@@ -6927,6 +7218,7 @@ module Aws::SSM
|
|
6927
7218
|
#
|
6928
7219
|
# resp.document_versions #=> Array
|
6929
7220
|
# resp.document_versions[0].name #=> String
|
7221
|
+
# resp.document_versions[0].display_name #=> String
|
6930
7222
|
# resp.document_versions[0].document_version #=> String
|
6931
7223
|
# resp.document_versions[0].version_name #=> String
|
6932
7224
|
# resp.document_versions[0].created_date #=> Time
|
@@ -6946,9 +7238,8 @@ module Aws::SSM
|
|
6946
7238
|
req.send_request(options)
|
6947
7239
|
end
|
6948
7240
|
|
6949
|
-
# Returns all Systems Manager (SSM) documents in the current
|
6950
|
-
#
|
6951
|
-
# 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.
|
6952
7243
|
#
|
6953
7244
|
# @option params [Array<Types::DocumentFilter>] :document_filter_list
|
6954
7245
|
# This data type is deprecated. Instead, use `Filters`.
|
@@ -6962,7 +7253,7 @@ module Aws::SSM
|
|
6962
7253
|
# `Key=Owner,Values=Self`. To specify a custom key-value pair, use the
|
6963
7254
|
# format `Key=tag:tagName,Values=valueName`.
|
6964
7255
|
#
|
6965
|
-
# <note markdown="1"> This API
|
7256
|
+
# <note markdown="1"> This API operation only supports filtering documents by using a single
|
6966
7257
|
# tag key and one or more tag values. For example:
|
6967
7258
|
# `Key=tag:tagName,Values=valueName1,valueName2`
|
6968
7259
|
#
|
@@ -7007,12 +7298,14 @@ module Aws::SSM
|
|
7007
7298
|
#
|
7008
7299
|
# resp.document_identifiers #=> Array
|
7009
7300
|
# resp.document_identifiers[0].name #=> String
|
7301
|
+
# resp.document_identifiers[0].created_date #=> Time
|
7302
|
+
# resp.document_identifiers[0].display_name #=> String
|
7010
7303
|
# resp.document_identifiers[0].owner #=> String
|
7011
7304
|
# resp.document_identifiers[0].version_name #=> String
|
7012
7305
|
# resp.document_identifiers[0].platform_types #=> Array
|
7013
7306
|
# resp.document_identifiers[0].platform_types[0] #=> String, one of "Windows", "Linux"
|
7014
7307
|
# resp.document_identifiers[0].document_version #=> String
|
7015
|
-
# 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"
|
7016
7309
|
# resp.document_identifiers[0].schema_version #=> String
|
7017
7310
|
# resp.document_identifiers[0].document_format #=> String, one of "YAML", "JSON", "TEXT"
|
7018
7311
|
# resp.document_identifiers[0].target_type #=> String
|
@@ -7062,7 +7355,7 @@ module Aws::SSM
|
|
7062
7355
|
# * {Types::ListInventoryEntriesResult#instance_id #instance_id} => String
|
7063
7356
|
# * {Types::ListInventoryEntriesResult#schema_version #schema_version} => String
|
7064
7357
|
# * {Types::ListInventoryEntriesResult#capture_time #capture_time} => String
|
7065
|
-
# * {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)
|
7066
7359
|
# * {Types::ListInventoryEntriesResult#next_token #next_token} => String
|
7067
7360
|
#
|
7068
7361
|
# @example Request syntax with placeholder values
|
@@ -7087,9 +7380,9 @@ module Aws::SSM
|
|
7087
7380
|
# resp.instance_id #=> String
|
7088
7381
|
# resp.schema_version #=> String
|
7089
7382
|
# resp.capture_time #=> String
|
7090
|
-
# resp.entries #=> Array
|
7091
|
-
# resp.entries[0] #=> Hash
|
7092
|
-
# 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>
|
7093
7386
|
# resp.next_token #=> String
|
7094
7387
|
#
|
7095
7388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries AWS API Documentation
|
@@ -7101,8 +7394,8 @@ module Aws::SSM
|
|
7101
7394
|
req.send_request(options)
|
7102
7395
|
end
|
7103
7396
|
|
7104
|
-
# Returns a list of all OpsItem events in the current
|
7105
|
-
#
|
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
|
7106
7399
|
# OpsItems by specifying a filter.
|
7107
7400
|
#
|
7108
7401
|
# @option params [Array<Types::OpsItemEventFilter>] :filters
|
@@ -7160,8 +7453,72 @@ module Aws::SSM
|
|
7160
7453
|
req.send_request(options)
|
7161
7454
|
end
|
7162
7455
|
|
7163
|
-
#
|
7164
|
-
#
|
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.
|
7165
7522
|
#
|
7166
7523
|
# @option params [Array<Types::OpsMetadataFilter>] :filters
|
7167
7524
|
# One or more filters to limit the number of OpsMetadata objects
|
@@ -7307,7 +7664,7 @@ module Aws::SSM
|
|
7307
7664
|
# View a list of resource data syncs according to the sync type. Specify
|
7308
7665
|
# `SyncToDestination` to view resource data syncs that synchronize data
|
7309
7666
|
# to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data
|
7310
|
-
# syncs from
|
7667
|
+
# syncs from Organizations or from multiple Regions.
|
7311
7668
|
#
|
7312
7669
|
# @option params [String] :next_token
|
7313
7670
|
# A token to start the list. Use this token to get the next set of
|
@@ -7372,6 +7729,9 @@ module Aws::SSM
|
|
7372
7729
|
|
7373
7730
|
# Returns a list of the tags assigned to the specified resource.
|
7374
7731
|
#
|
7732
|
+
# For information about the ID format for each supported resource type,
|
7733
|
+
# see AddTagsToResource.
|
7734
|
+
#
|
7375
7735
|
# @option params [required, String] :resource_type
|
7376
7736
|
# Returns a list of tags for a specific resource type.
|
7377
7737
|
#
|
@@ -7404,10 +7764,11 @@ module Aws::SSM
|
|
7404
7764
|
req.send_request(options)
|
7405
7765
|
end
|
7406
7766
|
|
7407
|
-
# Shares a Systems Manager document
|
7408
|
-
#
|
7409
|
-
#
|
7410
|
-
#
|
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.
|
7411
7772
|
#
|
7412
7773
|
# @option params [required, String] :name
|
7413
7774
|
# The name of the document that you want to share.
|
@@ -7417,18 +7778,19 @@ module Aws::SSM
|
|
7417
7778
|
# *Share*.
|
7418
7779
|
#
|
7419
7780
|
# @option params [Array<String>] :account_ids_to_add
|
7420
|
-
# The
|
7421
|
-
# 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*.
|
7422
7784
|
#
|
7423
7785
|
# @option params [Array<String>] :account_ids_to_remove
|
7424
|
-
# The
|
7425
|
-
# document. The
|
7426
|
-
# *All*. This action has a higher
|
7427
|
-
# you specify an account ID to add
|
7428
|
-
# 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.
|
7429
7791
|
#
|
7430
7792
|
# @option params [String] :shared_document_version
|
7431
|
-
# (Optional) The version of the document to share. If it'
|
7793
|
+
# (Optional) The version of the document to share. If it isn't
|
7432
7794
|
# specified, the system choose the `Default` version to share.
|
7433
7795
|
#
|
7434
7796
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -7453,10 +7815,10 @@ module Aws::SSM
|
|
7453
7815
|
end
|
7454
7816
|
|
7455
7817
|
# Registers a compliance type and other compliance details on a
|
7456
|
-
# designated resource. This
|
7457
|
-
# details with a resource. This call overwrites existing
|
7458
|
-
# information on the resource, so you must provide a full
|
7459
|
-
# 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.
|
7460
7822
|
#
|
7461
7823
|
# ComplianceType can be one of the following:
|
7462
7824
|
#
|
@@ -7477,8 +7839,8 @@ module Aws::SSM
|
|
7477
7839
|
#
|
7478
7840
|
# * Severity: A patch severity. For example, `critical`.
|
7479
7841
|
#
|
7480
|
-
# * DocumentName:
|
7481
|
-
# AWS-RunPatchBaseline
|
7842
|
+
# * DocumentName: An SSM document name. For example,
|
7843
|
+
# `AWS-RunPatchBaseline`.
|
7482
7844
|
#
|
7483
7845
|
# * DocumentVersion: An SSM document version number. For example, 4.
|
7484
7846
|
#
|
@@ -7640,9 +8002,9 @@ module Aws::SSM
|
|
7640
8002
|
#
|
7641
8003
|
# * Parameter names are case sensitive.
|
7642
8004
|
#
|
7643
|
-
# * A parameter name must be unique within an
|
8005
|
+
# * A parameter name must be unique within an Region
|
7644
8006
|
#
|
7645
|
-
# * A parameter name can't be prefixed with "aws" or "ssm"
|
8007
|
+
# * A parameter name can't be prefixed with "`aws`" or "`ssm`"
|
7646
8008
|
# (case-insensitive).
|
7647
8009
|
#
|
7648
8010
|
# * Parameter names can include only the following symbols and letters:
|
@@ -7658,11 +8020,11 @@ module Aws::SSM
|
|
7658
8020
|
# levels.
|
7659
8021
|
#
|
7660
8022
|
# For additional information about valid values for parameter names, see
|
7661
|
-
# [Creating Systems Manager parameters][1] in the *
|
7662
|
-
# User Guide*.
|
8023
|
+
# [Creating Systems Manager parameters][1] in the *Amazon Web Services
|
8024
|
+
# Systems Manager User Guide*.
|
7663
8025
|
#
|
7664
8026
|
# <note markdown="1"> The maximum length constraint listed below includes capacity for
|
7665
|
-
# additional system attributes that
|
8027
|
+
# additional system attributes that aren't part of the name. The
|
7666
8028
|
# maximum length for a parameter name, including the full length of the
|
7667
8029
|
# parameter ARN, is 1011 characters. For example, the length of the
|
7668
8030
|
# following parameter name is 65 characters, not 20 characters:
|
@@ -7679,7 +8041,7 @@ module Aws::SSM
|
|
7679
8041
|
# Information about the parameter that you want to add to the system.
|
7680
8042
|
# Optional but recommended.
|
7681
8043
|
#
|
7682
|
-
#
|
8044
|
+
# Don't enter personally identifiable information in this field.
|
7683
8045
|
#
|
7684
8046
|
# @option params [required, String] :value
|
7685
8047
|
# The parameter value that you want to add to the system. Standard
|
@@ -7695,7 +8057,7 @@ module Aws::SSM
|
|
7695
8057
|
# @option params [String] :type
|
7696
8058
|
# The type of parameter that you want to add to the system.
|
7697
8059
|
#
|
7698
|
-
# <note markdown="1"> `SecureString`
|
8060
|
+
# <note markdown="1"> `SecureString` isn't currently supported for CloudFormation
|
7699
8061
|
# templates.
|
7700
8062
|
#
|
7701
8063
|
# </note>
|
@@ -7705,28 +8067,27 @@ module Aws::SSM
|
|
7705
8067
|
# list. If you have a parameter value that requires a comma, then use
|
7706
8068
|
# the `String` data type.
|
7707
8069
|
#
|
7708
|
-
# Specifying a parameter type
|
8070
|
+
# Specifying a parameter type isn't required when updating a parameter.
|
7709
8071
|
# You must specify a parameter type when creating a parameter.
|
7710
8072
|
#
|
7711
8073
|
# @option params [String] :key_id
|
7712
|
-
# The KMS
|
7713
|
-
#
|
7714
|
-
#
|
7715
|
-
#
|
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.
|
7716
8078
|
#
|
7717
8079
|
# If you don't specify a key ID, the system uses the default key
|
7718
|
-
# associated with your
|
8080
|
+
# associated with your account.
|
7719
8081
|
#
|
7720
|
-
# * To use your default
|
7721
|
-
#
|
7722
|
-
#
|
7723
|
-
# 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.
|
7724
8085
|
#
|
7725
8086
|
# * To use a custom KMS key, choose the `SecureString` data type with
|
7726
8087
|
# the `Key ID` parameter.
|
7727
8088
|
#
|
7728
8089
|
# @option params [Boolean] :overwrite
|
7729
|
-
# Overwrite an existing parameter. The default value is
|
8090
|
+
# Overwrite an existing parameter. The default value is `false`.
|
7730
8091
|
#
|
7731
8092
|
# @option params [String] :allowed_pattern
|
7732
8093
|
# A regular expression used to validate the parameter value. For
|
@@ -7739,8 +8100,8 @@ module Aws::SSM
|
|
7739
8100
|
# environment. For example, you might want to tag a Systems Manager
|
7740
8101
|
# parameter to identify the type of resource to which it applies, the
|
7741
8102
|
# environment, or the type of configuration data referenced by the
|
7742
|
-
# parameter. In this case, you could specify the following key
|
7743
|
-
#
|
8103
|
+
# parameter. In this case, you could specify the following key-value
|
8104
|
+
# pairs:
|
7744
8105
|
#
|
7745
8106
|
# * `Key=Resource,Value=S3bucket`
|
7746
8107
|
#
|
@@ -7749,7 +8110,7 @@ module Aws::SSM
|
|
7749
8110
|
# * `Key=ParameterType,Value=LicenseKey`
|
7750
8111
|
#
|
7751
8112
|
# <note markdown="1"> To add tags to an existing Systems Manager parameter, use the
|
7752
|
-
# AddTagsToResource
|
8113
|
+
# AddTagsToResource operation.
|
7753
8114
|
#
|
7754
8115
|
# </note>
|
7755
8116
|
#
|
@@ -7759,15 +8120,15 @@ module Aws::SSM
|
|
7759
8120
|
# Parameter Store offers a standard tier and an advanced tier for
|
7760
8121
|
# parameters. Standard parameters have a content size limit of 4 KB and
|
7761
8122
|
# can't be configured to use parameter policies. You can create a
|
7762
|
-
# maximum of 10,000 standard parameters for each Region in an
|
7763
|
-
#
|
8123
|
+
# maximum of 10,000 standard parameters for each Region in an account.
|
8124
|
+
# Standard parameters are offered at no additional cost.
|
7764
8125
|
#
|
7765
8126
|
# Advanced parameters have a content size limit of 8 KB and can be
|
7766
8127
|
# configured to use parameter policies. You can create a maximum of
|
7767
|
-
# 100,000 advanced parameters for each Region in an
|
7768
|
-
#
|
7769
|
-
#
|
7770
|
-
# 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*.
|
7771
8132
|
#
|
7772
8133
|
# You can change a standard parameter to an advanced parameter any time.
|
7773
8134
|
# But you can't revert an advanced parameter to a standard parameter.
|
@@ -7786,7 +8147,7 @@ module Aws::SSM
|
|
7786
8147
|
# In `PutParameter` requests, you can specify the tier to create the
|
7787
8148
|
# parameter in. Whenever you specify a tier in the request, Parameter
|
7788
8149
|
# Store creates or updates the parameter according to that request.
|
7789
|
-
# However, if you
|
8150
|
+
# However, if you don't specify a tier in a request, Parameter Store
|
7790
8151
|
# assigns the tier based on the current Parameter Store default tier
|
7791
8152
|
# configuration.
|
7792
8153
|
#
|
@@ -7817,12 +8178,12 @@ module Aws::SSM
|
|
7817
8178
|
#
|
7818
8179
|
# * The parameter uses a parameter policy.
|
7819
8180
|
#
|
7820
|
-
# * More than 10,000 parameters already exist in your
|
8181
|
+
# * More than 10,000 parameters already exist in your account in the
|
7821
8182
|
# current Region.
|
7822
8183
|
#
|
7823
8184
|
# For more information about configuring the default tier option, see
|
7824
|
-
# [Specifying a default parameter tier][2] in the *
|
7825
|
-
# User Guide*.
|
8185
|
+
# [Specifying a default parameter tier][2] in the *Amazon Web Services
|
8186
|
+
# Systems Manager User Guide*.
|
7826
8187
|
#
|
7827
8188
|
#
|
7828
8189
|
#
|
@@ -7830,13 +8191,14 @@ module Aws::SSM
|
|
7830
8191
|
# [2]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html
|
7831
8192
|
#
|
7832
8193
|
# @option params [String] :policies
|
7833
|
-
# One or more policies to apply to a parameter. This
|
7834
|
-
# 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:
|
7835
8197
|
#
|
7836
8198
|
# Expiration: This policy deletes the parameter after it expires. When
|
7837
8199
|
# you create the policy, you specify the expiration date. You can update
|
7838
8200
|
# the expiration date and time by updating the policy. Updating the
|
7839
|
-
# *parameter*
|
8201
|
+
# *parameter* doesn't affect the expiration date and time. When the
|
7840
8202
|
# expiration time is reached, Parameter Store deletes the parameter.
|
7841
8203
|
#
|
7842
8204
|
# ExpirationNotification: This policy triggers an event in Amazon
|
@@ -7844,10 +8206,10 @@ module Aws::SSM
|
|
7844
8206
|
# this policy, you can receive notification before or after the
|
7845
8207
|
# expiration time is reached, in units of days or hours.
|
7846
8208
|
#
|
7847
|
-
# NoChangeNotification: This policy triggers a CloudWatch event
|
7848
|
-
# parameter
|
7849
|
-
# policy type is useful when, for example, a secret needs to be
|
7850
|
-
# 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.
|
7851
8213
|
#
|
7852
8214
|
# All existing policies are preserved until you send new policies or an
|
7853
8215
|
# empty policy. For more information about parameter policies, see
|
@@ -7859,7 +8221,7 @@ module Aws::SSM
|
|
7859
8221
|
#
|
7860
8222
|
# @option params [String] :data_type
|
7861
8223
|
# The data type for a `String` parameter. Supported data types include
|
7862
|
-
# plain text and Amazon Machine Image IDs.
|
8224
|
+
# plain text and Amazon Machine Image (AMI) IDs.
|
7863
8225
|
#
|
7864
8226
|
# **The following data type values are supported.**
|
7865
8227
|
#
|
@@ -7868,15 +8230,15 @@ module Aws::SSM
|
|
7868
8230
|
# * `aws:ec2:image`
|
7869
8231
|
#
|
7870
8232
|
# When you create a `String` parameter and specify `aws:ec2:image`,
|
7871
|
-
# Systems Manager validates the parameter value is
|
7872
|
-
# format, such as `ami-12345abcdeEXAMPLE`, and that the
|
7873
|
-
# available in your
|
7874
|
-
# parameter support for Amazon Machine Image IDs][1] in
|
7875
|
-
# 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*.
|
7876
8238
|
#
|
7877
8239
|
#
|
7878
8240
|
#
|
7879
|
-
# [1]:
|
8241
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html
|
7880
8242
|
#
|
7881
8243
|
# @return [Types::PutParameterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7882
8244
|
#
|
@@ -7920,9 +8282,9 @@ module Aws::SSM
|
|
7920
8282
|
|
7921
8283
|
# Defines the default patch baseline for the relevant operating system.
|
7922
8284
|
#
|
7923
|
-
# To reset the
|
7924
|
-
#
|
7925
|
-
# 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
|
7926
8288
|
# `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed`
|
7927
8289
|
# instead of `pb-0574b43a65ea646ed`.
|
7928
8290
|
#
|
@@ -7956,11 +8318,10 @@ module Aws::SSM
|
|
7956
8318
|
# Registers a patch baseline for a patch group.
|
7957
8319
|
#
|
7958
8320
|
# @option params [required, String] :baseline_id
|
7959
|
-
# The ID of the patch baseline to register the patch group
|
8321
|
+
# The ID of the patch baseline to register with the patch group.
|
7960
8322
|
#
|
7961
8323
|
# @option params [required, String] :patch_group
|
7962
|
-
# The name of the patch group
|
7963
|
-
# baseline.
|
8324
|
+
# The name of the patch group to be registered with the patch baseline.
|
7964
8325
|
#
|
7965
8326
|
# @return [Types::RegisterPatchBaselineForPatchGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7966
8327
|
#
|
@@ -8042,16 +8403,17 @@ module Aws::SSM
|
|
8042
8403
|
#
|
8043
8404
|
# For more information about these examples formats, including the best
|
8044
8405
|
# use case for each one, see [Examples: Register targets with a
|
8045
|
-
# maintenance window][1] in the *
|
8406
|
+
# maintenance window][1] in the *Amazon Web Services Systems Manager
|
8407
|
+
# User Guide*.
|
8046
8408
|
#
|
8047
8409
|
#
|
8048
8410
|
#
|
8049
8411
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
|
8050
8412
|
#
|
8051
8413
|
# @option params [String] :owner_information
|
8052
|
-
# User-provided value that will be included in any CloudWatch
|
8053
|
-
# raised while running tasks for these targets in this
|
8054
|
-
# 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.
|
8055
8417
|
#
|
8056
8418
|
# @option params [String] :name
|
8057
8419
|
# An optional name for the target.
|
@@ -8109,10 +8471,10 @@ module Aws::SSM
|
|
8109
8471
|
#
|
8110
8472
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
8111
8473
|
# Command-type tasks. Depending on the task, targets are optional for
|
8112
|
-
# other maintenance window task types (Automation,
|
8113
|
-
#
|
8474
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
8475
|
+
# Functions). For more information about running tasks that don't
|
8114
8476
|
# specify targets, see [Registering maintenance window tasks without
|
8115
|
-
# targets][1] in the *
|
8477
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
8116
8478
|
#
|
8117
8479
|
# </note>
|
8118
8480
|
#
|
@@ -8132,14 +8494,15 @@ module Aws::SSM
|
|
8132
8494
|
# The ARN of the task to run.
|
8133
8495
|
#
|
8134
8496
|
# @option params [String] :service_role_arn
|
8135
|
-
# The ARN of the IAM service role for
|
8136
|
-
#
|
8137
|
-
#
|
8138
|
-
#
|
8139
|
-
# 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`.
|
8140
8503
|
#
|
8141
|
-
# For more information, see the following topics in the in the *
|
8142
|
-
# Systems Manager User Guide*\:
|
8504
|
+
# For more information, see the following topics in the in the *Amazon
|
8505
|
+
# Web Services Systems Manager User Guide*\:
|
8143
8506
|
#
|
8144
8507
|
# * [Using service-linked roles for Systems Manager][1]
|
8145
8508
|
#
|
@@ -8179,9 +8542,9 @@ module Aws::SSM
|
|
8179
8542
|
# @option params [String] :max_concurrency
|
8180
8543
|
# The maximum number of targets this task can be run for in parallel.
|
8181
8544
|
#
|
8182
|
-
# <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
|
8183
8546
|
# supply a value for this option. Instead, the system inserts a
|
8184
|
-
# placeholder value of `1`. This value
|
8547
|
+
# placeholder value of `1`. This value doesn't affect the running of
|
8185
8548
|
# your task.
|
8186
8549
|
#
|
8187
8550
|
# </note>
|
@@ -8190,21 +8553,22 @@ module Aws::SSM
|
|
8190
8553
|
# The maximum number of errors allowed before this task stops being
|
8191
8554
|
# scheduled.
|
8192
8555
|
#
|
8193
|
-
# <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
|
8194
8557
|
# supply a value for this option. Instead, the system inserts a
|
8195
|
-
# placeholder value of `1`. This value
|
8558
|
+
# placeholder value of `1`. This value doesn't affect the running of
|
8196
8559
|
# your task.
|
8197
8560
|
#
|
8198
8561
|
# </note>
|
8199
8562
|
#
|
8200
8563
|
# @option params [Types::LoggingInfo] :logging_info
|
8201
|
-
# A structure containing information about an
|
8202
|
-
# instance-level logs to.
|
8203
|
-
#
|
8204
|
-
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an
|
8205
|
-
# logs, instead use the
|
8206
|
-
#
|
8207
|
-
#
|
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
|
8208
8572
|
# maintenance window task types, see
|
8209
8573
|
# MaintenanceWindowTaskInvocationParameters.
|
8210
8574
|
#
|
@@ -8314,9 +8678,10 @@ module Aws::SSM
|
|
8314
8678
|
# @option params [required, String] :resource_type
|
8315
8679
|
# The type of resource from which you want to remove a tag.
|
8316
8680
|
#
|
8317
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
8318
|
-
# managed instances. Specify the name of the managed
|
8319
|
-
# 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`.
|
8320
8685
|
#
|
8321
8686
|
# </note>
|
8322
8687
|
#
|
@@ -8340,9 +8705,10 @@ module Aws::SSM
|
|
8340
8705
|
#
|
8341
8706
|
# For the Document and Parameter values, use the name of the resource.
|
8342
8707
|
#
|
8343
|
-
# <note markdown="1"> The ManagedInstance type for this API
|
8344
|
-
# managed instances. Specify the name of the managed
|
8345
|
-
# 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.
|
8346
8712
|
#
|
8347
8713
|
# </note>
|
8348
8714
|
#
|
@@ -8368,32 +8734,41 @@ module Aws::SSM
|
|
8368
8734
|
req.send_request(options)
|
8369
8735
|
end
|
8370
8736
|
|
8371
|
-
# `ServiceSetting` is an account-level setting for an
|
8372
|
-
# setting defines how a user interacts with or
|
8373
|
-
# feature of a service. For example, if an
|
8374
|
-
# the account based on feature or
|
8375
|
-
#
|
8376
|
-
#
|
8377
|
-
#
|
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.
|
8378
8745
|
#
|
8379
|
-
# Services map a `SettingId` object to a setting value.
|
8380
|
-
# teams define the default value for a `SettingId`.
|
8381
|
-
# new `SettingId`, but you can overwrite the default
|
8382
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
8383
|
-
# GetServiceSetting API
|
8384
|
-
# 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.
|
8385
8753
|
#
|
8386
8754
|
# Reset the service setting for the account to the default value as
|
8387
|
-
# provisioned by the
|
8755
|
+
# provisioned by the Amazon Web Services service team.
|
8388
8756
|
#
|
8389
8757
|
# @option params [required, String] :setting_id
|
8390
8758
|
# The Amazon Resource Name (ARN) of the service setting to reset. The
|
8391
|
-
# setting ID can be
|
8392
|
-
#
|
8393
|
-
# `/ssm/
|
8394
|
-
#
|
8395
|
-
# `/ssm/
|
8396
|
-
#
|
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`
|
8397
8772
|
#
|
8398
8773
|
# @return [Types::ResetServiceSettingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8399
8774
|
#
|
@@ -8428,7 +8803,7 @@ module Aws::SSM
|
|
8428
8803
|
# terminated sessions.
|
8429
8804
|
#
|
8430
8805
|
# <note markdown="1"> This command is primarily for use by client machines to automatically
|
8431
|
-
# reconnect during intermittent network issues. It
|
8806
|
+
# reconnect during intermittent network issues. It isn't intended for
|
8432
8807
|
# any other use.
|
8433
8808
|
#
|
8434
8809
|
# </note>
|
@@ -8527,8 +8902,8 @@ module Aws::SSM
|
|
8527
8902
|
# tens, hundreds, or thousands of instances at once.
|
8528
8903
|
#
|
8529
8904
|
# For more information about how to use targets, see [Using targets and
|
8530
|
-
# rate controls to send commands to a fleet][1] in the *
|
8531
|
-
# Manager User Guide*.
|
8905
|
+
# rate controls to send commands to a fleet][1] in the *Amazon Web
|
8906
|
+
# Services Systems Manager User Guide*.
|
8532
8907
|
#
|
8533
8908
|
#
|
8534
8909
|
#
|
@@ -8546,18 +8921,20 @@ module Aws::SSM
|
|
8546
8921
|
# `InstanceIds` option instead.
|
8547
8922
|
#
|
8548
8923
|
# For more information about how to use targets, see [Sending commands
|
8549
|
-
# to a fleet][1] in the *
|
8924
|
+
# to a fleet][1] in the *Amazon Web Services Systems Manager User
|
8925
|
+
# Guide*.
|
8550
8926
|
#
|
8551
8927
|
#
|
8552
8928
|
#
|
8553
8929
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
8554
8930
|
#
|
8555
8931
|
# @option params [required, String] :document_name
|
8556
|
-
# The name of the Systems Manager document
|
8557
|
-
# document
|
8558
|
-
#
|
8559
|
-
# how to use shared documents,
|
8560
|
-
# 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*.
|
8561
8938
|
#
|
8562
8939
|
#
|
8563
8940
|
#
|
@@ -8566,9 +8943,10 @@ module Aws::SSM
|
|
8566
8943
|
# @option params [String] :document_version
|
8567
8944
|
# The SSM document version to use in the request. You can specify
|
8568
8945
|
# $DEFAULT, $LATEST, or a specific version number. If you run commands
|
8569
|
-
# by using the
|
8570
|
-
#
|
8571
|
-
# 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:
|
8572
8950
|
#
|
8573
8951
|
# --document-version "\\$DEFAULT"
|
8574
8952
|
#
|
@@ -8592,8 +8970,8 @@ module Aws::SSM
|
|
8592
8970
|
# </note>
|
8593
8971
|
#
|
8594
8972
|
# @option params [Integer] :timeout_seconds
|
8595
|
-
# If this time is reached and the command
|
8596
|
-
# running, it
|
8973
|
+
# If this time is reached and the command hasn't already started
|
8974
|
+
# running, it won't run.
|
8597
8975
|
#
|
8598
8976
|
# @option params [String] :comment
|
8599
8977
|
# User-specified information about the command, such as a brief
|
@@ -8619,9 +8997,9 @@ module Aws::SSM
|
|
8619
8997
|
# @option params [String] :max_concurrency
|
8620
8998
|
# (Optional) The maximum number of instances that are allowed to run the
|
8621
8999
|
# command at the same time. You can specify a number such as 10 or a
|
8622
|
-
# percentage such as 10%. The default value is 50
|
8623
|
-
# about how to use MaxConcurrency
|
8624
|
-
# 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*.
|
8625
9003
|
#
|
8626
9004
|
#
|
8627
9005
|
#
|
@@ -8629,27 +9007,29 @@ module Aws::SSM
|
|
8629
9007
|
#
|
8630
9008
|
# @option params [String] :max_errors
|
8631
9009
|
# The maximum number of errors allowed without the command failing. When
|
8632
|
-
# the command fails one more time beyond the value of MaxErrors
|
9010
|
+
# the command fails one more time beyond the value of `MaxErrors`, the
|
8633
9011
|
# systems stops sending the command to additional targets. You can
|
8634
9012
|
# specify a number like 10 or a percentage like 10%. The default value
|
8635
|
-
# is 0
|
8636
|
-
# 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*.
|
8637
9016
|
#
|
8638
9017
|
#
|
8639
9018
|
#
|
8640
9019
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors
|
8641
9020
|
#
|
8642
9021
|
# @option params [String] :service_role_arn
|
8643
|
-
# The ARN of the IAM service role to
|
8644
|
-
# Notification Service (Amazon SNS)
|
8645
|
-
# 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.
|
8646
9025
|
#
|
8647
9026
|
# @option params [Types::NotificationConfig] :notification_config
|
8648
9027
|
# Configurations for sending notifications.
|
8649
9028
|
#
|
8650
9029
|
# @option params [Types::CloudWatchOutputConfig] :cloud_watch_output_config
|
8651
|
-
# Enables Systems Manager to send Run Command output
|
8652
|
-
# 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.
|
8653
9033
|
#
|
8654
9034
|
# @return [Types::SendCommandResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8655
9035
|
#
|
@@ -8737,8 +9117,8 @@ module Aws::SSM
|
|
8737
9117
|
req.send_request(options)
|
8738
9118
|
end
|
8739
9119
|
|
8740
|
-
#
|
8741
|
-
#
|
9120
|
+
# Runs an association immediately and only one time. This operation can
|
9121
|
+
# be helpful when troubleshooting associations.
|
8742
9122
|
#
|
8743
9123
|
# @option params [required, Array<String>] :association_ids
|
8744
9124
|
# The association IDs that you want to run immediately and only one
|
@@ -8761,25 +9141,25 @@ module Aws::SSM
|
|
8761
9141
|
req.send_request(options)
|
8762
9142
|
end
|
8763
9143
|
|
8764
|
-
# Initiates execution of an Automation
|
9144
|
+
# Initiates execution of an Automation runbook.
|
8765
9145
|
#
|
8766
9146
|
# @option params [required, String] :document_name
|
8767
|
-
# The name of the
|
8768
|
-
#
|
8769
|
-
#
|
8770
|
-
#
|
8771
|
-
#
|
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*.
|
8772
9152
|
#
|
8773
9153
|
#
|
8774
9154
|
#
|
8775
9155
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
8776
9156
|
#
|
8777
9157
|
# @option params [String] :document_version
|
8778
|
-
# The version of the Automation
|
9158
|
+
# The version of the Automation runbook to use for this execution.
|
8779
9159
|
#
|
8780
9160
|
# @option params [Hash<String,Array>] :parameters
|
8781
9161
|
# A key-value map of execution parameters, which match the declared
|
8782
|
-
# parameters in the Automation
|
9162
|
+
# parameters in the Automation runbook.
|
8783
9163
|
#
|
8784
9164
|
# @option params [String] :client_token
|
8785
9165
|
# User-provided idempotency token. The token must be unique, is case
|
@@ -8799,12 +9179,12 @@ module Aws::SSM
|
|
8799
9179
|
#
|
8800
9180
|
# @option params [Array<Hash>] :target_maps
|
8801
9181
|
# A key-value mapping of document parameters to target resources. Both
|
8802
|
-
# Targets and TargetMaps
|
9182
|
+
# Targets and TargetMaps can't be specified together.
|
8803
9183
|
#
|
8804
9184
|
# @option params [String] :max_concurrency
|
8805
9185
|
# The maximum number of targets allowed to run this task in parallel.
|
8806
9186
|
# You can specify a number, such as 10, or a percentage, such as 10%.
|
8807
|
-
# The default value is 10
|
9187
|
+
# The default value is `10`.
|
8808
9188
|
#
|
8809
9189
|
# @option params [String] :max_errors
|
8810
9190
|
# The number of errors that are allowed before the system stops running
|
@@ -8825,11 +9205,11 @@ module Aws::SSM
|
|
8825
9205
|
# executions proceed one at a time.
|
8826
9206
|
#
|
8827
9207
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
8828
|
-
# A location is a combination of
|
8829
|
-
#
|
8830
|
-
#
|
8831
|
-
# [Running Automation workflows in multiple
|
8832
|
-
#
|
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*.
|
8833
9213
|
#
|
8834
9214
|
#
|
8835
9215
|
#
|
@@ -8841,14 +9221,14 @@ module Aws::SSM
|
|
8841
9221
|
# a resource in different ways, such as by purpose, owner, or
|
8842
9222
|
# environment. For example, you might want to tag an automation to
|
8843
9223
|
# identify an environment or operating system. In this case, you could
|
8844
|
-
# specify the following key
|
9224
|
+
# specify the following key-value pairs:
|
8845
9225
|
#
|
8846
9226
|
# * `Key=environment,Value=test`
|
8847
9227
|
#
|
8848
9228
|
# * `Key=OS,Value=Windows`
|
8849
9229
|
#
|
8850
9230
|
# <note markdown="1"> To add tags to an existing patch baseline, use the AddTagsToResource
|
8851
|
-
#
|
9231
|
+
# operation.
|
8852
9232
|
#
|
8853
9233
|
# </note>
|
8854
9234
|
#
|
@@ -8910,9 +9290,9 @@ module Aws::SSM
|
|
8910
9290
|
req.send_request(options)
|
8911
9291
|
end
|
8912
9292
|
|
8913
|
-
# Creates a change request for Change Manager. The runbooks
|
8914
|
-
#
|
8915
|
-
#
|
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.
|
8916
9296
|
#
|
8917
9297
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
8918
9298
|
# The date and time specified in the change request to run the
|
@@ -8945,8 +9325,8 @@ module Aws::SSM
|
|
8945
9325
|
# insensitive, enforces the UUID format, and can't be reused.
|
8946
9326
|
#
|
8947
9327
|
# @option params [required, Array<Types::Runbook>] :runbooks
|
8948
|
-
# Information about the Automation runbooks
|
8949
|
-
#
|
9328
|
+
# Information about the Automation runbooks that are run during the
|
9329
|
+
# runbook workflow.
|
8950
9330
|
#
|
8951
9331
|
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
8952
9332
|
# until all required approvals for the change request have been
|
@@ -8959,7 +9339,7 @@ module Aws::SSM
|
|
8959
9339
|
# maximum of five tags for a change request. Tags enable you to
|
8960
9340
|
# categorize a resource in different ways, such as by purpose, owner, or
|
8961
9341
|
# environment. For example, you might want to tag a change request to
|
8962
|
-
# identify an environment or target
|
9342
|
+
# identify an environment or target Region. In this case, you could
|
8963
9343
|
# specify the following key-value pairs:
|
8964
9344
|
#
|
8965
9345
|
# * `Key=Environment,Value=Production`
|
@@ -9045,13 +9425,15 @@ module Aws::SSM
|
|
9045
9425
|
# Session Manager session. Returns a URL and token that can be used to
|
9046
9426
|
# open a WebSocket connection for sending input and receiving outputs.
|
9047
9427
|
#
|
9048
|
-
# <note markdown="1">
|
9049
|
-
# the Session Manager plugin to be installed on
|
9050
|
-
# making the call. For information, see [Install the
|
9051
|
-
# 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*.
|
9052
9433
|
#
|
9053
|
-
#
|
9054
|
-
# 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.
|
9055
9437
|
#
|
9056
9438
|
# </note>
|
9057
9439
|
#
|
@@ -9132,7 +9514,7 @@ module Aws::SSM
|
|
9132
9514
|
|
9133
9515
|
# Permanently ends a session and closes the data connection between the
|
9134
9516
|
# Session Manager client and SSM Agent on the instance. A terminated
|
9135
|
-
# session
|
9517
|
+
# session isn't be resumed.
|
9136
9518
|
#
|
9137
9519
|
# @option params [required, String] :session_id
|
9138
9520
|
# The ID of the session to terminate.
|
@@ -9163,11 +9545,12 @@ module Aws::SSM
|
|
9163
9545
|
# Remove a label or labels from a parameter.
|
9164
9546
|
#
|
9165
9547
|
# @option params [required, String] :name
|
9166
|
-
# The
|
9548
|
+
# The name of the parameter from which you want to delete one or more
|
9549
|
+
# labels.
|
9167
9550
|
#
|
9168
9551
|
# @option params [required, Integer] :parameter_version
|
9169
9552
|
# The specific version of the parameter which you want to delete one or
|
9170
|
-
# more labels from. If it
|
9553
|
+
# more labels from. If it isn't present, the call will fail.
|
9171
9554
|
#
|
9172
9555
|
# @option params [required, Array<String>] :labels
|
9173
9556
|
# One or more labels to delete from the specified parameter version.
|
@@ -9202,16 +9585,17 @@ module Aws::SSM
|
|
9202
9585
|
end
|
9203
9586
|
|
9204
9587
|
# Updates an association. You can update the association name and
|
9205
|
-
# version, the document version, schedule, parameters, and Amazon
|
9206
|
-
# output.
|
9207
|
-
#
|
9208
|
-
# In order to call this API
|
9209
|
-
# role must be configured with
|
9210
|
-
# DescribeAssociation API
|
9211
|
-
#
|
9212
|
-
# occurred (AccessDeniedException) when
|
9213
|
-
# operation: User: <user_arn>
|
9214
|
-
# 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>`
|
9215
9599
|
#
|
9216
9600
|
# When you update an association, the association immediately runs
|
9217
9601
|
# against the specified targets.
|
@@ -9221,8 +9605,9 @@ module Aws::SSM
|
|
9221
9605
|
#
|
9222
9606
|
# @option params [Hash<String,Array>] :parameters
|
9223
9607
|
# The parameters you want to update for the association. If you create a
|
9224
|
-
# parameter using Parameter Store,
|
9225
|
-
#
|
9608
|
+
# parameter using Parameter Store, a capability of Amazon Web Services
|
9609
|
+
# Systems Manager, you can reference the parameter using
|
9610
|
+
# `\{\{ssm:parameter-name\}\}`.
|
9226
9611
|
#
|
9227
9612
|
# @option params [String] :document_version
|
9228
9613
|
# The document version you want update for the association.
|
@@ -9235,16 +9620,16 @@ module Aws::SSM
|
|
9235
9620
|
# An S3 bucket where you want to store the results of this request.
|
9236
9621
|
#
|
9237
9622
|
# @option params [String] :name
|
9238
|
-
# The name of the SSM document
|
9239
|
-
# information for the instance.
|
9240
|
-
# documents.
|
9623
|
+
# The name of the SSM Command document or Automation runbook that
|
9624
|
+
# contains the configuration information for the instance.
|
9241
9625
|
#
|
9242
|
-
# You can specify
|
9243
|
-
# 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.
|
9244
9629
|
#
|
9245
|
-
# For SSM
|
9246
|
-
# you must specify the complete SSM document ARN,
|
9247
|
-
# 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:
|
9248
9633
|
#
|
9249
9634
|
# `arn:aws:ssm:region:account-id:document/document-name `
|
9250
9635
|
#
|
@@ -9252,9 +9637,9 @@ module Aws::SSM
|
|
9252
9637
|
#
|
9253
9638
|
# `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
|
9254
9639
|
#
|
9255
|
-
# For
|
9256
|
-
# account, you only need to specify the document name.
|
9257
|
-
# `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`.
|
9258
9643
|
#
|
9259
9644
|
# @option params [Array<Types::Target>] :targets
|
9260
9645
|
# The targets of the association.
|
@@ -9270,8 +9655,9 @@ module Aws::SSM
|
|
9270
9655
|
#
|
9271
9656
|
# @option params [String] :automation_target_parameter_name
|
9272
9657
|
# Specify the target for the association. This target is required for
|
9273
|
-
# associations that use an Automation
|
9274
|
-
# 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.
|
9275
9661
|
#
|
9276
9662
|
# @option params [String] :max_errors
|
9277
9663
|
# The number of errors that are allowed before the system stops sending
|
@@ -9281,13 +9667,13 @@ module Aws::SSM
|
|
9281
9667
|
# system stops sending requests when the fourth error is received. If
|
9282
9668
|
# you specify 0, then the system stops sending requests after the first
|
9283
9669
|
# error is returned. If you run an association on 50 instances and set
|
9284
|
-
# 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
|
9285
9671
|
# sixth error is received.
|
9286
9672
|
#
|
9287
|
-
# Executions that are already running an association when MaxErrors is
|
9673
|
+
# Executions that are already running an association when `MaxErrors` is
|
9288
9674
|
# reached are allowed to complete, but some of these executions may fail
|
9289
9675
|
# as well. If you need to ensure that there won't be more than
|
9290
|
-
# max-errors failed executions, set MaxConcurrency to 1 so that
|
9676
|
+
# max-errors failed executions, set `MaxConcurrency` to 1 so that
|
9291
9677
|
# executions proceed one at a time.
|
9292
9678
|
#
|
9293
9679
|
# @option params [String] :max_concurrency
|
@@ -9297,10 +9683,10 @@ module Aws::SSM
|
|
9297
9683
|
# means all targets run the association at the same time.
|
9298
9684
|
#
|
9299
9685
|
# If a new instance starts and attempts to run an association while
|
9300
|
-
# Systems Manager is running MaxConcurrency associations, the
|
9686
|
+
# Systems Manager is running `MaxConcurrency` associations, the
|
9301
9687
|
# association is allowed to run. During the next association interval,
|
9302
9688
|
# the new instance will process its association within the limit
|
9303
|
-
# specified for MaxConcurrency
|
9689
|
+
# specified for `MaxConcurrency`.
|
9304
9690
|
#
|
9305
9691
|
# @option params [String] :compliance_severity
|
9306
9692
|
# The severity level to assign to the association.
|
@@ -9314,9 +9700,10 @@ module Aws::SSM
|
|
9314
9700
|
# the association is `NON-COMPLIANT`.
|
9315
9701
|
#
|
9316
9702
|
# In `MANUAL` mode, you must specify the `AssociationId` as a parameter
|
9317
|
-
# for the PutComplianceItems API
|
9318
|
-
#
|
9319
|
-
#
|
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.
|
9320
9707
|
#
|
9321
9708
|
# By default, all associations use `AUTO` mode.
|
9322
9709
|
#
|
@@ -9324,7 +9711,7 @@ module Aws::SSM
|
|
9324
9711
|
# By default, when you update an association, the system runs it
|
9325
9712
|
# immediately after it is updated and then according to the schedule you
|
9326
9713
|
# specified. Specify this option if you don't want an association to
|
9327
|
-
# run immediately after you update it. This parameter
|
9714
|
+
# run immediately after you update it. This parameter isn't supported
|
9328
9715
|
# for rate expressions.
|
9329
9716
|
#
|
9330
9717
|
# Also, if you specified this option when you created the association,
|
@@ -9334,10 +9721,20 @@ module Aws::SSM
|
|
9334
9721
|
# association to run immediately after updating it and according to the
|
9335
9722
|
# interval specified.
|
9336
9723
|
#
|
9724
|
+
# @option params [Array<String>] :calendar_names
|
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].
|
9729
|
+
#
|
9730
|
+
#
|
9731
|
+
#
|
9732
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
9733
|
+
#
|
9337
9734
|
# @option params [Array<Types::TargetLocation>] :target_locations
|
9338
|
-
# A location is a combination of
|
9339
|
-
#
|
9340
|
-
#
|
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.
|
9341
9738
|
#
|
9342
9739
|
# @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9343
9740
|
#
|
@@ -9374,6 +9771,7 @@ module Aws::SSM
|
|
9374
9771
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
9375
9772
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
9376
9773
|
# apply_only_at_cron_interval: false,
|
9774
|
+
# calendar_names: ["CalendarNameOrARN"],
|
9377
9775
|
# target_locations: [
|
9378
9776
|
# {
|
9379
9777
|
# accounts: ["Account"],
|
@@ -9422,6 +9820,8 @@ module Aws::SSM
|
|
9422
9820
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
9423
9821
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
9424
9822
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
9823
|
+
# resp.association_description.calendar_names #=> Array
|
9824
|
+
# resp.association_description.calendar_names[0] #=> String
|
9425
9825
|
# resp.association_description.target_locations #=> Array
|
9426
9826
|
# resp.association_description.target_locations[0].accounts #=> Array
|
9427
9827
|
# resp.association_description.target_locations[0].accounts[0] #=> String
|
@@ -9440,11 +9840,11 @@ module Aws::SSM
|
|
9440
9840
|
req.send_request(options)
|
9441
9841
|
end
|
9442
9842
|
|
9443
|
-
# Updates the status of the Systems Manager document
|
9444
|
-
# specified instance.
|
9843
|
+
# Updates the status of the Amazon Web Services Systems Manager document
|
9844
|
+
# (SSM document) associated with the specified instance.
|
9445
9845
|
#
|
9446
9846
|
# @option params [required, String] :name
|
9447
|
-
# The name of the
|
9847
|
+
# The name of the SSM document.
|
9448
9848
|
#
|
9449
9849
|
# @option params [required, String] :instance_id
|
9450
9850
|
# The ID of the instance.
|
@@ -9506,6 +9906,8 @@ module Aws::SSM
|
|
9506
9906
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
9507
9907
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
9508
9908
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
9909
|
+
# resp.association_description.calendar_names #=> Array
|
9910
|
+
# resp.association_description.calendar_names[0] #=> String
|
9509
9911
|
# resp.association_description.target_locations #=> Array
|
9510
9912
|
# resp.association_description.target_locations[0].accounts #=> Array
|
9511
9913
|
# resp.association_description.target_locations[0].accounts[0] #=> String
|
@@ -9530,16 +9932,22 @@ module Aws::SSM
|
|
9530
9932
|
# A valid JSON or YAML string.
|
9531
9933
|
#
|
9532
9934
|
# @option params [Array<Types::AttachmentsSource>] :attachments
|
9533
|
-
# A list of key
|
9534
|
-
#
|
9935
|
+
# A list of key-value pairs that describe attachments to a version of a
|
9936
|
+
# document.
|
9535
9937
|
#
|
9536
9938
|
# @option params [required, String] :name
|
9537
|
-
# 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.
|
9538
9946
|
#
|
9539
9947
|
# @option params [String] :version_name
|
9540
9948
|
# An optional field specifying the version of the artifact you are
|
9541
9949
|
# updating with the document. For example, "Release 12, Update 6".
|
9542
|
-
# 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
|
9543
9951
|
# changed.
|
9544
9952
|
#
|
9545
9953
|
# @option params [String] :document_version
|
@@ -9571,6 +9979,7 @@ module Aws::SSM
|
|
9571
9979
|
# },
|
9572
9980
|
# ],
|
9573
9981
|
# name: "DocumentName", # required
|
9982
|
+
# display_name: "DocumentDisplayName",
|
9574
9983
|
# version_name: "DocumentVersionName",
|
9575
9984
|
# document_version: "DocumentVersion",
|
9576
9985
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
@@ -9583,6 +9992,7 @@ module Aws::SSM
|
|
9583
9992
|
# resp.document_description.hash #=> String
|
9584
9993
|
# resp.document_description.hash_type #=> String, one of "Sha256", "Sha1"
|
9585
9994
|
# resp.document_description.name #=> String
|
9995
|
+
# resp.document_description.display_name #=> String
|
9586
9996
|
# resp.document_description.version_name #=> String
|
9587
9997
|
# resp.document_description.owner #=> String
|
9588
9998
|
# resp.document_description.created_date #=> Time
|
@@ -9597,7 +10007,7 @@ module Aws::SSM
|
|
9597
10007
|
# resp.document_description.parameters[0].default_value #=> String
|
9598
10008
|
# resp.document_description.platform_types #=> Array
|
9599
10009
|
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
9600
|
-
# 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"
|
9601
10011
|
# resp.document_description.schema_version #=> String
|
9602
10012
|
# resp.document_description.latest_version #=> String
|
9603
10013
|
# resp.document_description.default_version #=> String
|
@@ -9738,7 +10148,7 @@ module Aws::SSM
|
|
9738
10148
|
#
|
9739
10149
|
# @option params [String] :end_date
|
9740
10150
|
# The date and time, in ISO-8601 Extended format, for when you want the
|
9741
|
-
# maintenance window to become inactive. EndDate allows you to set a
|
10151
|
+
# maintenance window to become inactive. `EndDate` allows you to set a
|
9742
10152
|
# date and time in the future when the maintenance window will no longer
|
9743
10153
|
# run.
|
9744
10154
|
#
|
@@ -9757,7 +10167,7 @@ module Aws::SSM
|
|
9757
10167
|
# [1]: https://www.iana.org/time-zones
|
9758
10168
|
#
|
9759
10169
|
# @option params [Integer] :schedule_offset
|
9760
|
-
# 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
|
9761
10171
|
# expression before running the maintenance window.
|
9762
10172
|
#
|
9763
10173
|
# For example, the following cron expression schedules a maintenance
|
@@ -9773,7 +10183,8 @@ module Aws::SSM
|
|
9773
10183
|
#
|
9774
10184
|
# @option params [Integer] :cutoff
|
9775
10185
|
# The number of hours before the end of the maintenance window that
|
9776
|
-
# Systems Manager stops scheduling new tasks for
|
10186
|
+
# Amazon Web Services Systems Manager stops scheduling new tasks for
|
10187
|
+
# execution.
|
9777
10188
|
#
|
9778
10189
|
# @option params [Boolean] :allow_unassociated_targets
|
9779
10190
|
# Whether targets must be registered with the maintenance window before
|
@@ -9783,9 +10194,9 @@ module Aws::SSM
|
|
9783
10194
|
# Whether the maintenance window is enabled.
|
9784
10195
|
#
|
9785
10196
|
# @option params [Boolean] :replace
|
9786
|
-
# If True
|
9787
|
-
# CreateMaintenanceWindow
|
9788
|
-
# 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.
|
9789
10200
|
#
|
9790
10201
|
# @return [Types::UpdateMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9791
10202
|
#
|
@@ -9861,7 +10272,7 @@ module Aws::SSM
|
|
9861
10272
|
# types are ID target, Tag target, and resource group. For more
|
9862
10273
|
# information, see Target.
|
9863
10274
|
#
|
9864
|
-
# <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.
|
9865
10276
|
#
|
9866
10277
|
# </note>
|
9867
10278
|
#
|
@@ -9875,9 +10286,9 @@ module Aws::SSM
|
|
9875
10286
|
# The targets to add or replace.
|
9876
10287
|
#
|
9877
10288
|
# @option params [String] :owner_information
|
9878
|
-
# User-provided value that will be included in any CloudWatch
|
9879
|
-
# raised while running tasks for these targets in this
|
9880
|
-
# 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.
|
9881
10292
|
#
|
9882
10293
|
# @option params [String] :name
|
9883
10294
|
# A name for the update.
|
@@ -9886,9 +10297,10 @@ module Aws::SSM
|
|
9886
10297
|
# An optional description for the update.
|
9887
10298
|
#
|
9888
10299
|
# @option params [Boolean] :replace
|
9889
|
-
# If True
|
9890
|
-
# RegisterTargetWithMaintenanceWindow
|
9891
|
-
# 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.
|
9892
10304
|
#
|
9893
10305
|
# @return [Types::UpdateMaintenanceWindowTargetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9894
10306
|
#
|
@@ -9940,38 +10352,38 @@ module Aws::SSM
|
|
9940
10352
|
# Modifies a task assigned to a maintenance window. You can't change
|
9941
10353
|
# the task type, but you can change the following values:
|
9942
10354
|
#
|
9943
|
-
# * TaskARN
|
9944
|
-
# AWS-RunPowerShellScript to AWS-RunShellScript
|
10355
|
+
# * `TaskARN`. For example, you can change a `RUN_COMMAND` task from
|
10356
|
+
# `AWS-RunPowerShellScript` to `AWS-RunShellScript`.
|
9945
10357
|
#
|
9946
|
-
# * ServiceRoleArn
|
10358
|
+
# * `ServiceRoleArn`
|
9947
10359
|
#
|
9948
|
-
# * TaskInvocationParameters
|
10360
|
+
# * `TaskInvocationParameters`
|
9949
10361
|
#
|
9950
|
-
# * Priority
|
10362
|
+
# * `Priority`
|
9951
10363
|
#
|
9952
|
-
# * MaxConcurrency
|
10364
|
+
# * `MaxConcurrency`
|
9953
10365
|
#
|
9954
|
-
# * MaxErrors
|
10366
|
+
# * `MaxErrors`
|
9955
10367
|
#
|
9956
10368
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
9957
10369
|
# Command-type tasks. Depending on the task, targets are optional for
|
9958
|
-
# other maintenance window task types (Automation,
|
9959
|
-
#
|
10370
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
10371
|
+
# Functions). For more information about running tasks that don't
|
9960
10372
|
# specify targets, see [Registering maintenance window tasks without
|
9961
|
-
# targets][1] in the *
|
10373
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
9962
10374
|
#
|
9963
10375
|
# </note>
|
9964
10376
|
#
|
9965
10377
|
# If the value for a parameter in `UpdateMaintenanceWindowTask` is null,
|
9966
|
-
# then the corresponding field
|
10378
|
+
# then the corresponding field isn't modified. If you set `Replace` to
|
9967
10379
|
# true, then all fields required by the
|
9968
|
-
# RegisterTaskWithMaintenanceWindow
|
10380
|
+
# RegisterTaskWithMaintenanceWindow operation are required for this
|
9969
10381
|
# request. Optional fields that aren't specified are set to null.
|
9970
10382
|
#
|
9971
10383
|
# When you update a maintenance window task that has options specified
|
9972
10384
|
# in `TaskInvocationParameters`, you must provide again all the
|
9973
10385
|
# `TaskInvocationParameters` values that you want to retain. The values
|
9974
|
-
# you
|
10386
|
+
# you don't specify again are removed. For example, suppose that when
|
9975
10387
|
# you registered a Run Command task, you specified
|
9976
10388
|
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
9977
10389
|
# and `OutputS3BucketName`. If you update the maintenance window task
|
@@ -9990,15 +10402,16 @@ module Aws::SSM
|
|
9990
10402
|
#
|
9991
10403
|
# @option params [Array<Types::Target>] :targets
|
9992
10404
|
# The targets (either instances or tags) to modify. Instances are
|
9993
|
-
# specified using
|
9994
|
-
# 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`.
|
9995
10408
|
#
|
9996
10409
|
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
9997
10410
|
# Command-type tasks. Depending on the task, targets are optional for
|
9998
|
-
# other maintenance window task types (Automation,
|
9999
|
-
#
|
10411
|
+
# other maintenance window task types (Automation, Lambda, and Step
|
10412
|
+
# Functions). For more information about running tasks that don't
|
10000
10413
|
# specify targets, see [Registering maintenance window tasks without
|
10001
|
-
# targets][1] in the *
|
10414
|
+
# targets][1] in the *Amazon Web Services Systems Manager User Guide*.
|
10002
10415
|
#
|
10003
10416
|
# </note>
|
10004
10417
|
#
|
@@ -10010,14 +10423,15 @@ module Aws::SSM
|
|
10010
10423
|
# The task ARN to modify.
|
10011
10424
|
#
|
10012
10425
|
# @option params [String] :service_role_arn
|
10013
|
-
# The ARN of the IAM service role for
|
10014
|
-
#
|
10015
|
-
#
|
10016
|
-
#
|
10017
|
-
# 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`.
|
10018
10432
|
#
|
10019
|
-
# For more information, see the following topics in the in the *
|
10020
|
-
# Systems Manager User Guide*\:
|
10433
|
+
# For more information, see the following topics in the in the *Amazon
|
10434
|
+
# Web Services Systems Manager User Guide*\:
|
10021
10435
|
#
|
10022
10436
|
# * [Using service-linked roles for Systems Manager][1]
|
10023
10437
|
#
|
@@ -10055,7 +10469,7 @@ module Aws::SSM
|
|
10055
10469
|
# When you update a maintenance window task that has options specified
|
10056
10470
|
# in `TaskInvocationParameters`, you must provide again all the
|
10057
10471
|
# `TaskInvocationParameters` values that you want to retain. The values
|
10058
|
-
# you
|
10472
|
+
# you don't specify again are removed. For example, suppose that when
|
10059
10473
|
# you registered a Run Command task, you specified
|
10060
10474
|
# `TaskInvocationParameters` values for `Comment`, `NotificationConfig`,
|
10061
10475
|
# and `OutputS3BucketName`. If you update the maintenance window task
|
@@ -10071,10 +10485,10 @@ module Aws::SSM
|
|
10071
10485
|
# is the number of targets that are allowed to run this task in
|
10072
10486
|
# parallel.
|
10073
10487
|
#
|
10074
|
-
# <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
|
10075
10489
|
# supply a value for this option. Instead, the system inserts a
|
10076
10490
|
# placeholder value of `1`, which may be reported in the response to
|
10077
|
-
# this command. This value
|
10491
|
+
# this command. This value doesn't affect the running of your task and
|
10078
10492
|
# can be ignored.
|
10079
10493
|
#
|
10080
10494
|
# </note>
|
@@ -10084,10 +10498,10 @@ module Aws::SSM
|
|
10084
10498
|
# number of errors that are allowed before the task stops being
|
10085
10499
|
# scheduled.
|
10086
10500
|
#
|
10087
|
-
# <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
|
10088
10502
|
# supply a value for this option. Instead, the system inserts a
|
10089
10503
|
# placeholder value of `1`, which may be reported in the response to
|
10090
|
-
# this command. This value
|
10504
|
+
# this command. This value doesn't affect the running of your task and
|
10091
10505
|
# can be ignored.
|
10092
10506
|
#
|
10093
10507
|
# </note>
|
@@ -10095,10 +10509,11 @@ module Aws::SSM
|
|
10095
10509
|
# @option params [Types::LoggingInfo] :logging_info
|
10096
10510
|
# The new logging location in Amazon S3 to specify.
|
10097
10511
|
#
|
10098
|
-
# <note markdown="1"> `LoggingInfo` has been deprecated. To specify an
|
10099
|
-
# logs, instead use the
|
10100
|
-
#
|
10101
|
-
#
|
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
|
10102
10517
|
# maintenance window task types, see
|
10103
10518
|
# MaintenanceWindowTaskInvocationParameters.
|
10104
10519
|
#
|
@@ -10112,8 +10527,8 @@ module Aws::SSM
|
|
10112
10527
|
#
|
10113
10528
|
# @option params [Boolean] :replace
|
10114
10529
|
# If True, then all fields that are required by the
|
10115
|
-
# RegisterTaskWithMaintenanceWindow
|
10116
|
-
# 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.
|
10117
10532
|
#
|
10118
10533
|
# @return [Types::UpdateMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10119
10534
|
#
|
@@ -10258,10 +10673,10 @@ module Aws::SSM
|
|
10258
10673
|
req.send_request(options)
|
10259
10674
|
end
|
10260
10675
|
|
10261
|
-
# Changes the
|
10262
|
-
#
|
10263
|
-
#
|
10264
|
-
#
|
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.
|
10265
10680
|
#
|
10266
10681
|
# @option params [required, String] :instance_id
|
10267
10682
|
# The ID of the managed instance where you want to update the role.
|
@@ -10287,16 +10702,17 @@ module Aws::SSM
|
|
10287
10702
|
req.send_request(options)
|
10288
10703
|
end
|
10289
10704
|
|
10290
|
-
# Edit or change an OpsItem. You must have permission in
|
10291
|
-
#
|
10292
|
-
#
|
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
|
10293
10708
|
# Systems Manager User Guide*.
|
10294
10709
|
#
|
10295
|
-
# Operations engineers and IT professionals use
|
10296
|
-
# investigate, and remediate
|
10297
|
-
# performance and health of their
|
10298
|
-
#
|
10299
|
-
# 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*.
|
10300
10716
|
#
|
10301
10717
|
#
|
10302
10718
|
#
|
@@ -10318,22 +10734,23 @@ module Aws::SSM
|
|
10318
10734
|
# You enter operational data as key-value pairs. The key has a maximum
|
10319
10735
|
# length of 128 characters. The value has a maximum size of 20 KB.
|
10320
10736
|
#
|
10321
|
-
# Operational data keys *can't* begin with the following: amazon
|
10322
|
-
# amzn
|
10737
|
+
# Operational data keys *can't* begin with the following: `amazon`,
|
10738
|
+
# `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
|
10323
10739
|
#
|
10324
10740
|
# You can choose to make the data searchable by other users in the
|
10325
10741
|
# account or you can restrict search access. Searchable data means that
|
10326
10742
|
# all users with access to the OpsItem Overview page (as provided by the
|
10327
|
-
# DescribeOpsItems API
|
10328
|
-
# 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
|
10329
10745
|
# users who have access to the OpsItem (as provided by the GetOpsItem
|
10330
|
-
# API
|
10746
|
+
# API operation).
|
10331
10747
|
#
|
10332
10748
|
# Use the `/aws/resources` key in OperationalData to specify a related
|
10333
10749
|
# resource in the request. Use the `/aws/automations` key in
|
10334
10750
|
# OperationalData to associate an Automation runbook with the OpsItem.
|
10335
|
-
# To view
|
10336
|
-
# 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*.
|
10337
10754
|
#
|
10338
10755
|
#
|
10339
10756
|
#
|
@@ -10359,7 +10776,7 @@ module Aws::SSM
|
|
10359
10776
|
# @option params [String] :status
|
10360
10777
|
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
10361
10778
|
# `Resolved`. For more information, see [Editing OpsItem details][1] in
|
10362
|
-
# the *
|
10779
|
+
# the *Amazon Web Services Systems Manager User Guide*.
|
10363
10780
|
#
|
10364
10781
|
#
|
10365
10782
|
#
|
@@ -10419,7 +10836,7 @@ module Aws::SSM
|
|
10419
10836
|
# ops_item_id: "String", # required
|
10420
10837
|
# },
|
10421
10838
|
# ],
|
10422
|
-
# 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
|
10423
10840
|
# ops_item_id: "OpsItemId", # required
|
10424
10841
|
# title: "OpsItemTitle",
|
10425
10842
|
# category: "OpsItemCategory",
|
@@ -10439,8 +10856,8 @@ module Aws::SSM
|
|
10439
10856
|
req.send_request(options)
|
10440
10857
|
end
|
10441
10858
|
|
10442
|
-
# Systems Manager calls this API
|
10443
|
-
# Application Manager.
|
10859
|
+
# Amazon Web Services Systems Manager calls this API operation when you
|
10860
|
+
# edit OpsMetadata in Application Manager.
|
10444
10861
|
#
|
10445
10862
|
# @option params [required, String] :ops_metadata_arn
|
10446
10863
|
# The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
|
@@ -10483,15 +10900,11 @@ module Aws::SSM
|
|
10483
10900
|
# Modifies an existing patch baseline. Fields not specified in the
|
10484
10901
|
# request are left unchanged.
|
10485
10902
|
#
|
10486
|
-
# <note markdown="1"> For information about valid key
|
10487
|
-
#
|
10903
|
+
# <note markdown="1"> For information about valid key-value pairs in `PatchFilters` for each
|
10904
|
+
# supported operating system type, see PatchFilter.
|
10488
10905
|
#
|
10489
10906
|
# </note>
|
10490
10907
|
#
|
10491
|
-
#
|
10492
|
-
#
|
10493
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
|
10494
|
-
#
|
10495
10908
|
# @option params [required, String] :baseline_id
|
10496
10909
|
# The ID of the patch baseline to update.
|
10497
10910
|
#
|
@@ -10509,7 +10922,8 @@ module Aws::SSM
|
|
10509
10922
|
#
|
10510
10923
|
# For information about accepted formats for lists of approved patches
|
10511
10924
|
# and rejected patches, see [About package name formats for approved and
|
10512
|
-
# rejected patch lists][1] in the *
|
10925
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
10926
|
+
# User Guide*.
|
10513
10927
|
#
|
10514
10928
|
#
|
10515
10929
|
#
|
@@ -10521,14 +10935,15 @@ module Aws::SSM
|
|
10521
10935
|
# @option params [Boolean] :approved_patches_enable_non_security
|
10522
10936
|
# Indicates whether the list of approved patches includes non-security
|
10523
10937
|
# updates that should be applied to the instances. The default value is
|
10524
|
-
#
|
10938
|
+
# `false`. Applies to Linux instances only.
|
10525
10939
|
#
|
10526
10940
|
# @option params [Array<String>] :rejected_patches
|
10527
10941
|
# A list of explicitly rejected patches for the baseline.
|
10528
10942
|
#
|
10529
10943
|
# For information about accepted formats for lists of approved patches
|
10530
10944
|
# and rejected patches, see [About package name formats for approved and
|
10531
|
-
# rejected patch lists][1] in the *
|
10945
|
+
# rejected patch lists][1] in the *Amazon Web Services Systems Manager
|
10946
|
+
# User Guide*.
|
10532
10947
|
#
|
10533
10948
|
#
|
10534
10949
|
#
|
@@ -10536,19 +10951,20 @@ module Aws::SSM
|
|
10536
10951
|
#
|
10537
10952
|
# @option params [String] :rejected_patches_action
|
10538
10953
|
# The action for Patch Manager to take on patches included in the
|
10539
|
-
# RejectedPackages list.
|
10954
|
+
# `RejectedPackages` list.
|
10540
10955
|
#
|
10541
|
-
# *
|
10542
|
-
# is installed only if it is a dependency of
|
10543
|
-
# considered compliant with the patch baseline,
|
10544
|
-
# reported as
|
10545
|
-
# 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.
|
10546
10961
|
#
|
10547
|
-
# *
|
10548
|
-
# include them as dependencies,
|
10549
|
-
# circumstances. If a package was installed before
|
10550
|
-
# Rejected patches list, it is considered
|
10551
|
-
# 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`.
|
10552
10968
|
#
|
10553
10969
|
# @option params [String] :description
|
10554
10970
|
# A description of the patch baseline.
|
@@ -10560,8 +10976,8 @@ module Aws::SSM
|
|
10560
10976
|
#
|
10561
10977
|
# @option params [Boolean] :replace
|
10562
10978
|
# If True, then all fields that are required by the CreatePatchBaseline
|
10563
|
-
#
|
10564
|
-
#
|
10979
|
+
# operation are also required for this API request. Optional fields that
|
10980
|
+
# aren't specified are set to null.
|
10565
10981
|
#
|
10566
10982
|
# @return [Types::UpdatePatchBaselineResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10567
10983
|
#
|
@@ -10673,12 +11089,12 @@ module Aws::SSM
|
|
10673
11089
|
# Update a resource data sync. After you create a resource data sync for
|
10674
11090
|
# a Region, you can't change the account options for that sync. For
|
10675
11091
|
# example, if you create a sync in the us-east-2 (Ohio) Region and you
|
10676
|
-
# choose the Include only the current account option, you can't edit
|
10677
|
-
# that sync later and choose the Include all accounts from my
|
10678
|
-
# Organizations configuration option. Instead, you must delete the
|
10679
|
-
# 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.
|
10680
11096
|
#
|
10681
|
-
# <note markdown="1"> This API
|
11097
|
+
# <note markdown="1"> This API operation only supports a resource data sync that was created
|
10682
11098
|
# with a SyncFromSource `SyncType`.
|
10683
11099
|
#
|
10684
11100
|
# </note>
|
@@ -10725,21 +11141,22 @@ module Aws::SSM
|
|
10725
11141
|
req.send_request(options)
|
10726
11142
|
end
|
10727
11143
|
|
10728
|
-
# `ServiceSetting` is an account-level setting for an
|
10729
|
-
# setting defines how a user interacts with or
|
10730
|
-
# feature of a service. For example, if an
|
10731
|
-
# the account based on feature or
|
10732
|
-
#
|
10733
|
-
#
|
10734
|
-
#
|
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.
|
10735
11152
|
#
|
10736
|
-
# Services map a `SettingId` object to a setting value.
|
10737
|
-
# teams define the default value for a `SettingId`.
|
10738
|
-
# new `SettingId`, but you can overwrite the default
|
10739
|
-
# the `ssm:UpdateServiceSetting` permission for the
|
10740
|
-
# GetServiceSetting API
|
10741
|
-
# ResetServiceSetting to change the value back to the
|
10742
|
-
# 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.
|
10743
11160
|
#
|
10744
11161
|
# Update the service setting for the account.
|
10745
11162
|
#
|
@@ -10753,6 +11170,8 @@ module Aws::SSM
|
|
10753
11170
|
#
|
10754
11171
|
# * `/ssm/automation/customer-script-log-group-name`
|
10755
11172
|
#
|
11173
|
+
# * `/ssm/documents/console/public-sharing-permission`
|
11174
|
+
#
|
10756
11175
|
# * `/ssm/parameter-store/default-parameter-tier`
|
10757
11176
|
#
|
10758
11177
|
# * `/ssm/parameter-store/high-throughput-enabled`
|
@@ -10775,10 +11194,14 @@ module Aws::SSM
|
|
10775
11194
|
# can be true or false.
|
10776
11195
|
#
|
10777
11196
|
# For the `/ssm/automation/customer-script-log-destination` setting ID,
|
10778
|
-
# the setting value can be CloudWatch
|
11197
|
+
# the setting value can be `CloudWatch`.
|
10779
11198
|
#
|
10780
11199
|
# For the `/ssm/automation/customer-script-log-group-name` setting ID,
|
10781
|
-
# 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`.
|
10782
11205
|
#
|
10783
11206
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
10784
11207
|
#
|
@@ -10811,7 +11234,7 @@ module Aws::SSM
|
|
10811
11234
|
params: params,
|
10812
11235
|
config: config)
|
10813
11236
|
context[:gem_name] = 'aws-sdk-ssm'
|
10814
|
-
context[:gem_version] = '1.
|
11237
|
+
context[:gem_version] = '1.112.0'
|
10815
11238
|
Seahorse::Client::Request.new(handlers, context)
|
10816
11239
|
end
|
10817
11240
|
|