aws-sdk-ssm 1.83.0 → 1.89.0

data/lib/aws-sdk-ssm/types.rb

@@ -1643,6 +1643,11 @@ module Aws::SSM
 
     # Describes a command filter.
     #
+    # <note markdown="1"> An instance ID can't be specified when a command status is `Pending`
+    # because the command hasn't run on the instance yet.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass CommandFilter
     #   data as a hash:
     #
@@ -3691,12 +3696,12 @@ module Aws::SSM
     #         type_name: "InventoryItemTypeName", # required
     #         schema_delete_option: "DisableSchema", # accepts DisableSchema, DeleteSchema
     #         dry_run: false,
-    #         client_token: "ClientToken",
+    #         client_token: "UUID",
     #       }
     #
     # @!attribute [rw] type_name
     #   The name of the custom inventory type for which you want to delete
-    #   either all previously collected data, or the inventory type itself.
+    #   either all previously collected data or the inventory type itself.
     #   @return [String]
     #
     # @!attribute [rw] schema_delete_option
@@ -5079,7 +5084,7 @@ module Aws::SSM
     #   data as a hash:
     #
     #       {
-    #         deletion_id: "InventoryDeletionId",
+    #         deletion_id: "UUID",
     #         next_token: "NextToken",
     #         max_results: 1,
     #       }
@@ -6029,6 +6034,22 @@ module Aws::SSM
     # @!attribute [rw] filters
     #   One or more filters. Use a filter to return a more specific list of
     #   results.
+    #
+    #   For `DescribePatchGroups`,valid filter keys include the following:
+    #
+    #   * `NAME_PREFIX`\: The name of the patch group. Wildcards (*) are
+    #     accepted.
+    #
+    #   * `OPERATING_SYSTEM`\: The supported operating system type to return
+    #     results for. For valid operating system values, see
+    #     GetDefaultPatchBaselineRequest$OperatingSystem in
+    #     CreatePatchBaseline.
+    #
+    #     Examples:
+    #
+    #     * `--filters Key=NAME_PREFIX,Values=MyPatchGroup*`
+    #
+    #     * `--filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2`
     #   @return [Array<Types::PatchOrchestratorFilter>]
     #
     # @!attribute [rw] next_token
@@ -6489,18 +6510,60 @@ module Aws::SSM
     # For keys, you can specify one or more tags that have been applied to a
     # document.
     #
-    # Other valid values include `Owner`, `Name`, `PlatformTypes`,
-    # `DocumentType`, and `TargetType`.
+    # You can also use AWS-provided keys, some of which have specific
+    # allowed values. These keys and their associated values are as follows:
+    #
+    # DocumentType
+    # : * ApplicationConfiguration
+    #
+    #   * ApplicationConfigurationSchema
+    #
+    #   * Automation
+    #
+    #   * ChangeCalendar
+    #
+    #   * Command
+    #
+    #   * DeploymentStrategy
+    #
+    #   * Package
+    #
+    #   * Policy
+    #
+    #   * Session
+    #
+    # Owner
     #
-    # Note that only one Owner can be specified in a request. For example:
-    # `Key=Owner,Values=Self`.
+    # : Note that only one `Owner` can be specified in a request. For
+    #   example: `Key=Owner,Values=Self`.
     #
-    # If you use Name as a key, you can use a name prefix to return a list
-    # of documents. For example, in the AWS CLI, to return a list of all
-    # documents that begin with `Te`, run the following command:
+    #   * Amazon
+    #
+    #   * Private
+    #
+    #   * Public
+    #
+    #   * Self
+    #
+    #   * ThirdParty
+    #
+    # PlatformTypes
+    # : * Linux
+    #
+    #   * Windows
+    #
+    # `Name` is another AWS-provided key. If you use `Name` as a key, you
+    # can use a name prefix to return a list of documents. For example, in
+    # the AWS CLI, to return a list of all documents that begin with `Te`,
+    # run the following command:
     #
     # `aws ssm list-documents --filters Key=Name,Values=Te`
     #
+    # You can also use the `TargetType` AWS-provided key. For a list of
+    # valid resource type values that can be used with this key, see [AWS
+    # resource and property types reference][1] in the *AWS CloudFormation
+    # User Guide*.
+    #
     # If you specify more than two keys, only documents that are identified
     # by all the tags are returned in the results. If you specify more than
     # two values for a key, documents that are identified by any of the
@@ -6509,12 +6572,16 @@ module Aws::SSM
     # To specify a custom key and value pair, use the format
     # `Key=tag:tagName,Values=valueName`.
     #
-    # For example, if you created a Key called region and are using the AWS
+    # For example, if you created a key called region and are using the AWS
     # CLI to call the `list-documents` command:
     #
     # `aws ssm list-documents --filters Key=tag:region,Values=east,west
     # Key=Owner,Values=Self`
     #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
+    #
     # @note When making an API call, you may pass DocumentKeyValuesFilter
     #   data as a hash:
     #
@@ -6974,6 +7041,9 @@ module Aws::SSM
     #   (Optional) The name of the plugin for which you want detailed
     #   results. If the document contains only one plugin, the name can be
     #   omitted and the details will be returned.
+    #
+    #   Plugin names are also referred to as step names in Systems Manager
+    #   documents.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocationRequest AWS API Documentation
@@ -8356,6 +8426,14 @@ module Aws::SSM
     #
     # @!attribute [rw] parameter_filters
     #   Filters to limit the request results.
+    #
+    #   <note markdown="1"> For `GetParametersByPath`, the following filter `Key` names are
+    #   supported: `Type`, `KeyId`, `Label`, and `DataType`.
+    #
+    #    The following `Key` values are not supported for
+    #   `GetParametersByPath`\: `tag`, `Name`, `Path`, and `Tier`.
+    #
+    #    </note>
     #   @return [Array<Types::ParameterStringFilter>]
     #
     # @!attribute [rw] with_decryption
@@ -8927,8 +9005,17 @@ module Aws::SSM
     #
     # @!attribute [rw] iam_role
     #   The Amazon Identity and Access Management (IAM) role assigned to the
-    #   on-premises Systems Manager managed instances. This call does not
-    #   return the IAM role for EC2 instances.
+    #   on-premises Systems Manager managed instance. This call does not
+    #   return the IAM role for EC2 instances. To retrieve the IAM role for
+    #   an EC2 instance, use the Amazon EC2 `DescribeInstances` action. For
+    #   information, see [DescribeInstances][1] in the *Amazon EC2 API
+    #   Reference* or [describe-instances][2] in the *AWS CLI Command
+    #   Reference*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
+    #   [2]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
     #   @return [String]
     #
     # @!attribute [rw] registration_date
@@ -8942,7 +9029,25 @@ module Aws::SSM
     #   @return [String]
     #
     # @!attribute [rw] name
-    #   The name of the managed instance.
+    #   The name assigned to an on-premises server or virtual machine (VM)
+    #   when it is activated as a Systems Manager managed instance. The name
+    #   is specified as the `DefaultInstanceName` property using the
+    #   CreateActivation command. It is applied to the managed instance by
+    #   specifying the Activation Code and Activation ID when you install
+    #   SSM Agent on the instance, as explained in [Install SSM Agent for a
+    #   hybrid environment (Linux)][1] and [Install SSM Agent for a hybrid
+    #   environment (Windows)][2]. To retrieve the Name tag of an EC2
+    #   instance, use the Amazon EC2 `DescribeInstances` action. For
+    #   information, see [DescribeInstances][3] in the *Amazon EC2 API
+    #   Reference* or [describe-instances][4] in the *AWS CLI Command
+    #   Reference*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html
+    #   [2]: http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html
+    #   [3]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
+    #   [4]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
     #   @return [String]
     #
     # @!attribute [rw] ip_address
@@ -9120,14 +9225,14 @@ module Aws::SSM
     #   @return [Integer]
     #
     # @!attribute [rw] installed_rejected_count
-    #   The number of instances with patches installed that are specified in
-    #   a RejectedPatches list. Patches with a status of *InstalledRejected*
-    #   were typically installed before they were added to a RejectedPatches
-    #   list.
+    #   The number of patches installed on an instance that are specified in
+    #   a `RejectedPatches` list. Patches with a status of
+    #   *InstalledRejected* were typically installed before they were added
+    #   to a `RejectedPatches` list.
     #
-    #   <note markdown="1"> If ALLOW\_AS\_DEPENDENCY is the specified option for
-    #   RejectedPatchesAction, the value of InstalledRejectedCount will
-    #   always be 0 (zero).
+    #   <note markdown="1"> If `ALLOW_AS_DEPENDENCY` is the specified option for
+    #   `RejectedPatchesAction`, the value of `InstalledRejectedCount` will
+    #   always be `0` (zero).
     #
     #    </note>
     #   @return [Integer]
@@ -9168,8 +9273,8 @@ module Aws::SSM
     #   @return [Time]
     #
     # @!attribute [rw] operation
-    #   The type of patching operation that was performed: SCAN (assess
-    #   patch compliance state) or INSTALL (install missing patches).
+    #   The type of patching operation that was performed: `SCAN` (assess
+    #   patch compliance state) or `INSTALL` (install missing patches).
     #   @return [String]
     #
     # @!attribute [rw] last_no_reboot_install_operation_time
@@ -10636,6 +10741,12 @@ module Aws::SSM
     #
     # @!attribute [rw] instance_id
     #   (Optional) Lists commands issued against this instance ID.
+    #
+    #   <note markdown="1"> You can't specify an instance ID in the same command that you
+    #   specify `Status` = `Pending`. This is because the command has not
+    #   reached the instance yet.
+    #
+    #    </note>
     #   @return [String]
     #
     # @!attribute [rw] max_results
@@ -13092,25 +13203,6 @@ module Aws::SSM
     # One or more filters. Use a filter to return a more specific list of
     # results.
     #
-    # The `ParameterStringFilter` object is used by the DescribeParameters
-    # and GetParametersByPath API actions. However, not all of the pattern
-    # values listed for `Key` can be used with both actions.
-    #
-    #  For `DescribeActions`, all of the listed patterns are valid, with the
-    # exception of `Label`.
-    #
-    #  For `GetParametersByPath`, the following patterns listed for `Key`
-    # are
-    # not valid: `Name`, `Path`, and `Tier`.
-    #
-    #  For examples of CLI commands demonstrating valid parameter filter
-    # constructions, see [Searching for Systems Manager parameters][1] in
-    # the *AWS Systems Manager User Guide*.
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
-    #
     # @note When making an API call, you may pass ParameterStringFilter
     #   data as a hash:
     #
@@ -13122,6 +13214,26 @@ module Aws::SSM
     #
     # @!attribute [rw] key
     #   The name of the filter.
+    #
+    #   <note markdown="1"> The `ParameterStringFilter` object is used by the DescribeParameters
+    #   and GetParametersByPath API actions. However, not all of the pattern
+    #   values listed for `Key` can be used with both actions.
+    #
+    #    For `DescribeActions`, all of the listed patterns are valid, with
+    #   the exception of `Label`.
+    #
+    #    For `GetParametersByPath`, the following patterns listed for `Key`
+    #   are not valid: `tag`, `Name`, `Path`, and `Tier`.
+    #
+    #    For examples of CLI commands demonstrating valid parameter filter
+    #   constructions, see [Searching for Systems Manager parameters][1] in
+    #   the *AWS Systems Manager User Guide*.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
     #   @return [String]
     #
     # @!attribute [rw] option
@@ -13131,8 +13243,8 @@ module Aws::SSM
     #   valid options include `Recursive` and `OneLevel`.)
     #
     #   For filters used with GetParametersByPath, valid options include
-    #   `Equals` and `BeginsWith`. (Exception: For filters using the key
-    #   `Label`, the only valid option is `Equals`.)
+    #   `Equals` and `BeginsWith`. (Exception: For filters using `Label` as
+    #   the Key name, the only valid option is `Equals`.)
     #   @return [String]
     #
     # @!attribute [rw] values
@@ -13942,6 +14054,12 @@ module Aws::SSM
     #   The parameter value that you want to add to the system. Standard
     #   parameters have a value limit of 4 KB. Advanced parameters have a
     #   value limit of 8 KB.
+    #
+    #   <note markdown="1"> Parameters can't be referenced or nested in the values of other
+    #   parameters. You can't include `\{\{\}\}` or
+    #   `\{\{ssm:parameter-name\}\}` in a parameter value.
+    #
+    #    </note>
     #   @return [String]
     #
     # @!attribute [rw] type
@@ -15458,13 +15576,19 @@ module Aws::SSM
     #       }
     #
     # @!attribute [rw] instance_ids
-    #   The instance IDs where the command should run. You can specify a
-    #   maximum of 50 IDs. If you prefer not to list individual instance
-    #   IDs, you can instead send commands to a fleet of instances using the
-    #   Targets parameter, which accepts EC2 tags. For more information
-    #   about how to use targets, see [Using targets and rate controls to
-    #   send commands to a fleet][1] in the *AWS Systems Manager User
-    #   Guide*.
+    #   The IDs of the instances where the command should run. Specifying
+    #   instance IDs is most useful when you are targeting a limited number
+    #   of instances, though you can specify up to 50 IDs.
+    #
+    #   To target a larger number of instances, or if you prefer not to list
+    #   individual instance IDs, we recommend using the `Targets` option
+    #   instead. Using `Targets`, which accepts tag key-value pairs to
+    #   identify the instances to send commands to, you can a send command
+    #   to tens, hundreds, or thousands of instances at once.
+    #
+    #   For more information about how to use targets, see [Using targets
+    #   and rate controls to send commands to a fleet][1] in the *AWS
+    #   Systems Manager User Guide*.
     #
     #
     #
@@ -15472,11 +15596,18 @@ module Aws::SSM
     #   @return [Array<String>]
     #
     # @!attribute [rw] targets
-    #   (Optional) An array of search criteria that targets instances using
-    #   a Key,Value combination that you specify. Targets is required if you
-    #   don't provide one or more instance IDs in the call. For more
-    #   information about how to use targets, see [Sending commands to a
-    #   fleet][1] in the *AWS Systems Manager User Guide*.
+    #   An array of search criteria that targets instances using a
+    #   `Key,Value` combination that you specify. Specifying targets is most
+    #   useful when you want to send a command to a large number of
+    #   instances at once. Using `Targets`, which accepts tag key-value
+    #   pairs to identify instances, you can send a command to tens,
+    #   hundreds, or thousands of instances at once.
+    #
+    #   To send a command to a smaller number of instances, you can use the
+    #   `InstanceIds` option instead.
+    #
+    #   For more information about how to use targets, see [Sending commands
+    #   to a fleet][1] in the *AWS Systems Manager User Guide*.
     #
     #
     #
@@ -16413,13 +16544,16 @@ module Aws::SSM
     #
     # * `Key=tag-key,Values=my-tag-key-1,my-tag-key-2 `
     #
-    # * (Maintenance window targets only)
+    # * **Run Command and Maintenance window targets only**\:
     #   `Key=resource-groups:Name,Values=resource-group-name `
     #
-    # * (Maintenance window targets only)
+    # * **Maintenance window targets only**\:
     #   `Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
     #   `
     #
+    # * **Automation targets only**\:
+    #   `Key=ResourceGroup;Values=resource-group-name `
+    #
     # For example:
     #
     # * `Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE`
@@ -16428,28 +16562,32 @@ module Aws::SSM
     #
     # * `Key=tag-key,Values=Name,Instance-Type,CostCenter`
     #
-    # * (Maintenance window targets only)
+    # * **Run Command and Maintenance window targets only**\:
     #   `Key=resource-groups:Name,Values=ProductionResourceGroup`
     #
     #   This example demonstrates how to target all resources in the
     #   resource group **ProductionResourceGroup** in your maintenance
     #   window.
     #
-    # * (Maintenance window targets only)
+    # * **Maintenance window targets only**\:
     #   `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
     #   `
     #
     #   This example demonstrates how to target only EC2 instances and VPCs
     #   in your maintenance window.
     #
-    # * (State Manager association targets only) `Key=InstanceIds,Values=* `
+    # * **Automation targets only**\:
+    #   `Key=ResourceGroup,Values=MyResourceGroup`
+    #
+    # * **State Manager association targets only**\:
+    #   `Key=InstanceIds,Values=* `
     #
     #   This example demonstrates how to target all managed instances in the
     #   AWS Region where the association was created.
     #
-    # For information about how to send commands that target instances using
-    # `Key,Value` parameters, see [Targeting multiple instances][1] in the
-    # *AWS Systems Manager User Guide*.
+    # For more information about how to send commands that target instances
+    # using `Key,Value` parameters, see [Targeting multiple instances][1] in
+    # the *AWS Systems Manager User Guide*.
     #
     #
     #
@@ -16705,8 +16843,7 @@ module Aws::SSM
     end
 
     # The operating systems you specified is not supported, or the operation
-    # is not supported for the operating system. Valid operating systems
-    # include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.
+    # is not supported for the operating system.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -17560,6 +17697,17 @@ module Aws::SSM
     #   The parameters that the task should use during execution. Populate
     #   only the fields that match the task type. All other fields should be
     #   empty.
+    #
+    #   When you update a maintenance window task that has options specified
+    #   in `TaskInvocationParameters`, you must provide again all the
+    #   `TaskInvocationParameters` values that you want to retain. The
+    #   values you do not specify again are removed. For example, suppose
+    #   that when you registered a Run Command task, you specified
+    #   `TaskInvocationParameters` values for `Comment`,
+    #   `NotificationConfig`, and `OutputS3BucketName`. If you update the
+    #   maintenance window task and specify only a different
+    #   `OutputS3BucketName` value, the values for `Comment` and
+    #   `NotificationConfig` are removed.
     #   @return [Types::MaintenanceWindowTaskInvocationParameters]
     #
     # @!attribute [rw] priority
@@ -17603,7 +17751,7 @@ module Aws::SSM
     #
     # @!attribute [rw] replace
     #   If True, then all fields that are required by the
-    #   RegisterTaskWithMaintenanceWndow action are also required for this
+    #   RegisterTaskWithMaintenanceWindow action are also required for this
     #   API request. Optional fields that are not specified are set to null.
     #   @return [Boolean]
     #