aws-sdk-ssm 1.84.0 → 1.90.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.
@@ -1643,6 +1643,11 @@ module Aws::SSM
1643
1643
 
1644
1644
  # Describes a command filter.
1645
1645
  #
1646
+ # <note markdown="1"> An instance ID can't be specified when a command status is `Pending`
1647
+ # because the command hasn't run on the instance yet.
1648
+ #
1649
+ # </note>
1650
+ #
1646
1651
  # @note When making an API call, you may pass CommandFilter
1647
1652
  # data as a hash:
1648
1653
  #
@@ -3691,12 +3696,12 @@ module Aws::SSM
3691
3696
  # type_name: "InventoryItemTypeName", # required
3692
3697
  # schema_delete_option: "DisableSchema", # accepts DisableSchema, DeleteSchema
3693
3698
  # dry_run: false,
3694
- # client_token: "ClientToken",
3699
+ # client_token: "UUID",
3695
3700
  # }
3696
3701
  #
3697
3702
  # @!attribute [rw] type_name
3698
3703
  # The name of the custom inventory type for which you want to delete
3699
- # either all previously collected data, or the inventory type itself.
3704
+ # either all previously collected data or the inventory type itself.
3700
3705
  # @return [String]
3701
3706
  #
3702
3707
  # @!attribute [rw] schema_delete_option
@@ -5079,7 +5084,7 @@ module Aws::SSM
5079
5084
  # data as a hash:
5080
5085
  #
5081
5086
  # {
5082
- # deletion_id: "InventoryDeletionId",
5087
+ # deletion_id: "UUID",
5083
5088
  # next_token: "NextToken",
5084
5089
  # max_results: 1,
5085
5090
  # }
@@ -6029,6 +6034,22 @@ module Aws::SSM
6029
6034
  # @!attribute [rw] filters
6030
6035
  # One or more filters. Use a filter to return a more specific list of
6031
6036
  # results.
6037
+ #
6038
+ # For `DescribePatchGroups`,valid filter keys include the following:
6039
+ #
6040
+ # * `NAME_PREFIX`\: The name of the patch group. Wildcards (*) are
6041
+ # accepted.
6042
+ #
6043
+ # * `OPERATING_SYSTEM`\: The supported operating system type to return
6044
+ # results for. For valid operating system values, see
6045
+ # GetDefaultPatchBaselineRequest$OperatingSystem in
6046
+ # CreatePatchBaseline.
6047
+ #
6048
+ # Examples:
6049
+ #
6050
+ # * `--filters Key=NAME_PREFIX,Values=MyPatchGroup*`
6051
+ #
6052
+ # * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
6032
6053
  # @return [Array<Types::PatchOrchestratorFilter>]
6033
6054
  #
6034
6055
  # @!attribute [rw] next_token
@@ -6489,18 +6510,60 @@ module Aws::SSM
6489
6510
  # For keys, you can specify one or more tags that have been applied to a
6490
6511
  # document.
6491
6512
  #
6492
- # Other valid values include `Owner`, `Name`, `PlatformTypes`,
6493
- # `DocumentType`, and `TargetType`.
6513
+ # You can also use AWS-provided keys, some of which have specific
6514
+ # allowed values. These keys and their associated values are as follows:
6515
+ #
6516
+ # DocumentType
6517
+ # : * ApplicationConfiguration
6518
+ #
6519
+ # * ApplicationConfigurationSchema
6520
+ #
6521
+ # * Automation
6522
+ #
6523
+ # * ChangeCalendar
6524
+ #
6525
+ # * Command
6526
+ #
6527
+ # * DeploymentStrategy
6528
+ #
6529
+ # * Package
6530
+ #
6531
+ # * Policy
6532
+ #
6533
+ # * Session
6534
+ #
6535
+ # Owner
6494
6536
  #
6495
- # Note that only one Owner can be specified in a request. For example:
6496
- # `Key=Owner,Values=Self`.
6537
+ # : Note that only one `Owner` can be specified in a request. For
6538
+ # example: `Key=Owner,Values=Self`.
6497
6539
  #
6498
- # If you use Name as a key, you can use a name prefix to return a list
6499
- # of documents. For example, in the AWS CLI, to return a list of all
6500
- # documents that begin with `Te`, run the following command:
6540
+ # * Amazon
6541
+ #
6542
+ # * Private
6543
+ #
6544
+ # * Public
6545
+ #
6546
+ # * Self
6547
+ #
6548
+ # * ThirdParty
6549
+ #
6550
+ # PlatformTypes
6551
+ # : * Linux
6552
+ #
6553
+ # * Windows
6554
+ #
6555
+ # `Name` is another AWS-provided key. If you use `Name` as a key, you
6556
+ # can use a name prefix to return a list of documents. For example, in
6557
+ # the AWS CLI, to return a list of all documents that begin with `Te`,
6558
+ # run the following command:
6501
6559
  #
6502
6560
  # `aws ssm list-documents --filters Key=Name,Values=Te`
6503
6561
  #
6562
+ # You can also use the `TargetType` AWS-provided key. For a list of
6563
+ # valid resource type values that can be used with this key, see [AWS
6564
+ # resource and property types reference][1] in the *AWS CloudFormation
6565
+ # User Guide*.
6566
+ #
6504
6567
  # If you specify more than two keys, only documents that are identified
6505
6568
  # by all the tags are returned in the results. If you specify more than
6506
6569
  # two values for a key, documents that are identified by any of the
@@ -6509,12 +6572,16 @@ module Aws::SSM
6509
6572
  # To specify a custom key and value pair, use the format
6510
6573
  # `Key=tag:tagName,Values=valueName`.
6511
6574
  #
6512
- # For example, if you created a Key called region and are using the AWS
6575
+ # For example, if you created a key called region and are using the AWS
6513
6576
  # CLI to call the `list-documents` command:
6514
6577
  #
6515
6578
  # `aws ssm list-documents --filters Key=tag:region,Values=east,west
6516
6579
  # Key=Owner,Values=Self`
6517
6580
  #
6581
+ #
6582
+ #
6583
+ # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
6584
+ #
6518
6585
  # @note When making an API call, you may pass DocumentKeyValuesFilter
6519
6586
  # data as a hash:
6520
6587
  #
@@ -6974,6 +7041,9 @@ module Aws::SSM
6974
7041
  # (Optional) The name of the plugin for which you want detailed
6975
7042
  # results. If the document contains only one plugin, the name can be
6976
7043
  # omitted and the details will be returned.
7044
+ #
7045
+ # Plugin names are also referred to as step names in Systems Manager
7046
+ # documents.
6977
7047
  # @return [String]
6978
7048
  #
6979
7049
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocationRequest AWS API Documentation
@@ -8356,6 +8426,14 @@ module Aws::SSM
8356
8426
  #
8357
8427
  # @!attribute [rw] parameter_filters
8358
8428
  # Filters to limit the request results.
8429
+ #
8430
+ # <note markdown="1"> For `GetParametersByPath`, the following filter `Key` names are
8431
+ # supported: `Type`, `KeyId`, `Label`, and `DataType`.
8432
+ #
8433
+ # The following `Key` values are not supported for
8434
+ # `GetParametersByPath`\: `tag`, `Name`, `Path`, and `Tier`.
8435
+ #
8436
+ # </note>
8359
8437
  # @return [Array<Types::ParameterStringFilter>]
8360
8438
  #
8361
8439
  # @!attribute [rw] with_decryption
@@ -8927,8 +9005,17 @@ module Aws::SSM
8927
9005
  #
8928
9006
  # @!attribute [rw] iam_role
8929
9007
  # The Amazon Identity and Access Management (IAM) role assigned to the
8930
- # on-premises Systems Manager managed instances. This call does not
8931
- # return the IAM role for EC2 instances.
9008
+ # on-premises Systems Manager managed instance. This call does not
9009
+ # return the IAM role for EC2 instances. To retrieve the IAM role for
9010
+ # an EC2 instance, use the Amazon EC2 `DescribeInstances` action. For
9011
+ # information, see [DescribeInstances][1] in the *Amazon EC2 API
9012
+ # Reference* or [describe-instances][2] in the *AWS CLI Command
9013
+ # Reference*.
9014
+ #
9015
+ #
9016
+ #
9017
+ # [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
9018
+ # [2]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
8932
9019
  # @return [String]
8933
9020
  #
8934
9021
  # @!attribute [rw] registration_date
@@ -8942,7 +9029,25 @@ module Aws::SSM
8942
9029
  # @return [String]
8943
9030
  #
8944
9031
  # @!attribute [rw] name
8945
- # The name of the managed instance.
9032
+ # The name assigned to an on-premises server or virtual machine (VM)
9033
+ # when it is activated as a Systems Manager managed instance. The name
9034
+ # is specified as the `DefaultInstanceName` property using the
9035
+ # CreateActivation command. It is applied to the managed instance by
9036
+ # specifying the Activation Code and Activation ID when you install
9037
+ # SSM Agent on the instance, as explained in [Install SSM Agent for a
9038
+ # hybrid environment (Linux)][1] and [Install SSM Agent for a hybrid
9039
+ # environment (Windows)][2]. To retrieve the Name tag of an EC2
9040
+ # instance, use the Amazon EC2 `DescribeInstances` action. For
9041
+ # information, see [DescribeInstances][3] in the *Amazon EC2 API
9042
+ # Reference* or [describe-instances][4] in the *AWS CLI Command
9043
+ # Reference*.
9044
+ #
9045
+ #
9046
+ #
9047
+ # [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html
9048
+ # [2]: http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html
9049
+ # [3]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
9050
+ # [4]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
8946
9051
  # @return [String]
8947
9052
  #
8948
9053
  # @!attribute [rw] ip_address
@@ -9120,14 +9225,14 @@ module Aws::SSM
9120
9225
  # @return [Integer]
9121
9226
  #
9122
9227
  # @!attribute [rw] installed_rejected_count
9123
- # The number of instances with patches installed that are specified in
9124
- # a RejectedPatches list. Patches with a status of *InstalledRejected*
9125
- # were typically installed before they were added to a RejectedPatches
9126
- # list.
9228
+ # The number of patches installed on an instance that are specified in
9229
+ # a `RejectedPatches` list. Patches with a status of
9230
+ # *InstalledRejected* were typically installed before they were added
9231
+ # to a `RejectedPatches` list.
9127
9232
  #
9128
- # <note markdown="1"> If ALLOW\_AS\_DEPENDENCY is the specified option for
9129
- # RejectedPatchesAction, the value of InstalledRejectedCount will
9130
- # always be 0 (zero).
9233
+ # <note markdown="1"> If `ALLOW_AS_DEPENDENCY` is the specified option for
9234
+ # `RejectedPatchesAction`, the value of `InstalledRejectedCount` will
9235
+ # always be `0` (zero).
9131
9236
  #
9132
9237
  # </note>
9133
9238
  # @return [Integer]
@@ -9168,8 +9273,8 @@ module Aws::SSM
9168
9273
  # @return [Time]
9169
9274
  #
9170
9275
  # @!attribute [rw] operation
9171
- # The type of patching operation that was performed: SCAN (assess
9172
- # patch compliance state) or INSTALL (install missing patches).
9276
+ # The type of patching operation that was performed: `SCAN` (assess
9277
+ # patch compliance state) or `INSTALL` (install missing patches).
9173
9278
  # @return [String]
9174
9279
  #
9175
9280
  # @!attribute [rw] last_no_reboot_install_operation_time
@@ -10636,6 +10741,12 @@ module Aws::SSM
10636
10741
  #
10637
10742
  # @!attribute [rw] instance_id
10638
10743
  # (Optional) Lists commands issued against this instance ID.
10744
+ #
10745
+ # <note markdown="1"> You can't specify an instance ID in the same command that you
10746
+ # specify `Status` = `Pending`. This is because the command has not
10747
+ # reached the instance yet.
10748
+ #
10749
+ # </note>
10639
10750
  # @return [String]
10640
10751
  #
10641
10752
  # @!attribute [rw] max_results
@@ -13092,25 +13203,6 @@ module Aws::SSM
13092
13203
  # One or more filters. Use a filter to return a more specific list of
13093
13204
  # results.
13094
13205
  #
13095
- # The `ParameterStringFilter` object is used by the DescribeParameters
13096
- # and GetParametersByPath API actions. However, not all of the pattern
13097
- # values listed for `Key` can be used with both actions.
13098
- #
13099
- # For `DescribeActions`, all of the listed patterns are valid, with the
13100
- # exception of `Label`.
13101
- #
13102
- # For `GetParametersByPath`, the following patterns listed for `Key`
13103
- # are
13104
- # not valid: `Name`, `Path`, and `Tier`.
13105
- #
13106
- # For examples of CLI commands demonstrating valid parameter filter
13107
- # constructions, see [Searching for Systems Manager parameters][1] in
13108
- # the *AWS Systems Manager User Guide*.
13109
- #
13110
- #
13111
- #
13112
- # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
13113
- #
13114
13206
  # @note When making an API call, you may pass ParameterStringFilter
13115
13207
  # data as a hash:
13116
13208
  #
@@ -13122,6 +13214,26 @@ module Aws::SSM
13122
13214
  #
13123
13215
  # @!attribute [rw] key
13124
13216
  # The name of the filter.
13217
+ #
13218
+ # <note markdown="1"> The `ParameterStringFilter` object is used by the DescribeParameters
13219
+ # and GetParametersByPath API actions. However, not all of the pattern
13220
+ # values listed for `Key` can be used with both actions.
13221
+ #
13222
+ # For `DescribeActions`, all of the listed patterns are valid, with
13223
+ # the exception of `Label`.
13224
+ #
13225
+ # For `GetParametersByPath`, the following patterns listed for `Key`
13226
+ # are not valid: `tag`, `Name`, `Path`, and `Tier`.
13227
+ #
13228
+ # For examples of CLI commands demonstrating valid parameter filter
13229
+ # constructions, see [Searching for Systems Manager parameters][1] in
13230
+ # the *AWS Systems Manager User Guide*.
13231
+ #
13232
+ # </note>
13233
+ #
13234
+ #
13235
+ #
13236
+ # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
13125
13237
  # @return [String]
13126
13238
  #
13127
13239
  # @!attribute [rw] option
@@ -13131,8 +13243,8 @@ module Aws::SSM
13131
13243
  # valid options include `Recursive` and `OneLevel`.)
13132
13244
  #
13133
13245
  # For filters used with GetParametersByPath, valid options include
13134
- # `Equals` and `BeginsWith`. (Exception: For filters using the key
13135
- # `Label`, the only valid option is `Equals`.)
13246
+ # `Equals` and `BeginsWith`. (Exception: For filters using `Label` as
13247
+ # the Key name, the only valid option is `Equals`.)
13136
13248
  # @return [String]
13137
13249
  #
13138
13250
  # @!attribute [rw] values
@@ -13942,6 +14054,12 @@ module Aws::SSM
13942
14054
  # The parameter value that you want to add to the system. Standard
13943
14055
  # parameters have a value limit of 4 KB. Advanced parameters have a
13944
14056
  # value limit of 8 KB.
14057
+ #
14058
+ # <note markdown="1"> Parameters can't be referenced or nested in the values of other
14059
+ # parameters. You can't include `\{\{\}\}` or
14060
+ # `\{\{ssm:parameter-name\}\}` in a parameter value.
14061
+ #
14062
+ # </note>
13945
14063
  # @return [String]
13946
14064
  #
13947
14065
  # @!attribute [rw] type
@@ -15458,13 +15576,19 @@ module Aws::SSM
15458
15576
  # }
15459
15577
  #
15460
15578
  # @!attribute [rw] instance_ids
15461
- # The instance IDs where the command should run. You can specify a
15462
- # maximum of 50 IDs. If you prefer not to list individual instance
15463
- # IDs, you can instead send commands to a fleet of instances using the
15464
- # Targets parameter, which accepts EC2 tags. For more information
15465
- # about how to use targets, see [Using targets and rate controls to
15466
- # send commands to a fleet][1] in the *AWS Systems Manager User
15467
- # Guide*.
15579
+ # The IDs of the instances where the command should run. Specifying
15580
+ # instance IDs is most useful when you are targeting a limited number
15581
+ # of instances, though you can specify up to 50 IDs.
15582
+ #
15583
+ # To target a larger number of instances, or if you prefer not to list
15584
+ # individual instance IDs, we recommend using the `Targets` option
15585
+ # instead. Using `Targets`, which accepts tag key-value pairs to
15586
+ # identify the instances to send commands to, you can a send command
15587
+ # to tens, hundreds, or thousands of instances at once.
15588
+ #
15589
+ # For more information about how to use targets, see [Using targets
15590
+ # and rate controls to send commands to a fleet][1] in the *AWS
15591
+ # Systems Manager User Guide*.
15468
15592
  #
15469
15593
  #
15470
15594
  #
@@ -15472,11 +15596,18 @@ module Aws::SSM
15472
15596
  # @return [Array<String>]
15473
15597
  #
15474
15598
  # @!attribute [rw] targets
15475
- # (Optional) An array of search criteria that targets instances using
15476
- # a Key,Value combination that you specify. Targets is required if you
15477
- # don't provide one or more instance IDs in the call. For more
15478
- # information about how to use targets, see [Sending commands to a
15479
- # fleet][1] in the *AWS Systems Manager User Guide*.
15599
+ # An array of search criteria that targets instances using a
15600
+ # `Key,Value` combination that you specify. Specifying targets is most
15601
+ # useful when you want to send a command to a large number of
15602
+ # instances at once. Using `Targets`, which accepts tag key-value
15603
+ # pairs to identify instances, you can send a command to tens,
15604
+ # hundreds, or thousands of instances at once.
15605
+ #
15606
+ # To send a command to a smaller number of instances, you can use the
15607
+ # `InstanceIds` option instead.
15608
+ #
15609
+ # For more information about how to use targets, see [Sending commands
15610
+ # to a fleet][1] in the *AWS Systems Manager User Guide*.
15480
15611
  #
15481
15612
  #
15482
15613
  #
@@ -16413,13 +16544,16 @@ module Aws::SSM
16413
16544
  #
16414
16545
  # * `Key=tag-key,Values=my-tag-key-1,my-tag-key-2 `
16415
16546
  #
16416
- # * (Maintenance window targets only)
16547
+ # * **Run Command and Maintenance window targets only**\:
16417
16548
  # `Key=resource-groups:Name,Values=resource-group-name `
16418
16549
  #
16419
- # * (Maintenance window targets only)
16550
+ # * **Maintenance window targets only**\:
16420
16551
  # `Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
16421
16552
  # `
16422
16553
  #
16554
+ # * **Automation targets only**\:
16555
+ # `Key=ResourceGroup;Values=resource-group-name `
16556
+ #
16423
16557
  # For example:
16424
16558
  #
16425
16559
  # * `Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE`
@@ -16428,28 +16562,32 @@ module Aws::SSM
16428
16562
  #
16429
16563
  # * `Key=tag-key,Values=Name,Instance-Type,CostCenter`
16430
16564
  #
16431
- # * (Maintenance window targets only)
16565
+ # * **Run Command and Maintenance window targets only**\:
16432
16566
  # `Key=resource-groups:Name,Values=ProductionResourceGroup`
16433
16567
  #
16434
16568
  # This example demonstrates how to target all resources in the
16435
16569
  # resource group **ProductionResourceGroup** in your maintenance
16436
16570
  # window.
16437
16571
  #
16438
- # * (Maintenance window targets only)
16572
+ # * **Maintenance window targets only**\:
16439
16573
  # `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
16440
16574
  # `
16441
16575
  #
16442
16576
  # This example demonstrates how to target only EC2 instances and VPCs
16443
16577
  # in your maintenance window.
16444
16578
  #
16445
- # * (State Manager association targets only) `Key=InstanceIds,Values=* `
16579
+ # * **Automation targets only**\:
16580
+ # `Key=ResourceGroup,Values=MyResourceGroup`
16581
+ #
16582
+ # * **State Manager association targets only**\:
16583
+ # `Key=InstanceIds,Values=* `
16446
16584
  #
16447
16585
  # This example demonstrates how to target all managed instances in the
16448
16586
  # AWS Region where the association was created.
16449
16587
  #
16450
- # For information about how to send commands that target instances using
16451
- # `Key,Value` parameters, see [Targeting multiple instances][1] in the
16452
- # *AWS Systems Manager User Guide*.
16588
+ # For more information about how to send commands that target instances
16589
+ # using `Key,Value` parameters, see [Targeting multiple instances][1] in
16590
+ # the *AWS Systems Manager User Guide*.
16453
16591
  #
16454
16592
  #
16455
16593
  #
@@ -16705,8 +16843,7 @@ module Aws::SSM
16705
16843
  end
16706
16844
 
16707
16845
  # The operating systems you specified is not supported, or the operation
16708
- # is not supported for the operating system. Valid operating systems
16709
- # include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.
16846
+ # is not supported for the operating system.
16710
16847
  #
16711
16848
  # @!attribute [rw] message
16712
16849
  # @return [String]
@@ -17560,6 +17697,17 @@ module Aws::SSM
17560
17697
  # The parameters that the task should use during execution. Populate
17561
17698
  # only the fields that match the task type. All other fields should be
17562
17699
  # empty.
17700
+ #
17701
+ # When you update a maintenance window task that has options specified
17702
+ # in `TaskInvocationParameters`, you must provide again all the
17703
+ # `TaskInvocationParameters` values that you want to retain. The
17704
+ # values you do not specify again are removed. For example, suppose
17705
+ # that when you registered a Run Command task, you specified
17706
+ # `TaskInvocationParameters` values for `Comment`,
17707
+ # `NotificationConfig`, and `OutputS3BucketName`. If you update the
17708
+ # maintenance window task and specify only a different
17709
+ # `OutputS3BucketName` value, the values for `Comment` and
17710
+ # `NotificationConfig` are removed.
17563
17711
  # @return [Types::MaintenanceWindowTaskInvocationParameters]
17564
17712
  #
17565
17713
  # @!attribute [rw] priority
@@ -17603,7 +17751,7 @@ module Aws::SSM
17603
17751
  #
17604
17752
  # @!attribute [rw] replace
17605
17753
  # If True, then all fields that are required by the
17606
- # RegisterTaskWithMaintenanceWndow action are also required for this
17754
+ # RegisterTaskWithMaintenanceWindow action are also required for this
17607
17755
  # API request. Optional fields that are not specified are set to null.
17608
17756
  # @return [Boolean]
17609
17757
  #