aws-sdk-ssm 1.85.0 → 1.91.0

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

@@ -924,12 +924,12 @@ module Aws::SSM
     #   * For the key *SourceUrl*, the value is an S3 bucket location. For
     #     example:
     #
-    #     `"Values": [ "s3://my-bucket/my-folder" ]`
+    #     `"Values": [ "s3://doc-example-bucket/my-folder" ]`
     #
     #   * For the key *S3FileUrl*, the value is a file in an S3 bucket. For
     #     example:
     #
-    #     `"Values": [ "s3://my-bucket/my-folder/my-file.py" ]`
+    #     `"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]`
     #
     #   * For the key *AttachmentReference*, the value is constructed from
     #     the name of another SSM document in your account, a version number
@@ -1974,14 +1974,14 @@ module Aws::SSM
     #   be stored. This was requested when issuing the command. For example,
     #   in the following response:
     #
-    #   test\_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
+    #   doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
     #
-    #   test\_folder is the name of the S3 bucket;
+    #   doc-example-bucket is the name of the S3 bucket;
     #
     #   ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3
     #   prefix;
     #
-    #   i-1234567876543 is the instance ID;
+    #   i-02573cafcfEXAMPLE is the instance ID;
     #
     #   awsrunShellScript is the name of the plugin.
     #   @return [String]
@@ -1991,14 +1991,14 @@ module Aws::SSM
     #   command executions should be stored. This was requested when issuing
     #   the command. For example, in the following response:
     #
-    #   test\_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
+    #   doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
     #
-    #   test\_folder is the name of the S3 bucket;
+    #   doc-example-bucket is the name of the S3 bucket;
     #
     #   ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3
     #   prefix;
     #
-    #   i-1234567876543 is the instance ID;
+    #   i-02573cafcfEXAMPLE is the instance ID;
     #
     #   awsrunShellScript is the name of the plugin.
     #   @return [String]
@@ -2164,8 +2164,9 @@ module Aws::SSM
     #   @return [String]
     #
     # @!attribute [rw] status
-    #   The status of the compliance item. An item is either COMPLIANT or
-    #   NON\_COMPLIANT.
+    #   The status of the compliance item. An item is either COMPLIANT,
+    #   NON\_COMPLIANT, or an empty string (for Windows patches that aren't
+    #   applicable).
     #   @return [String]
     #
     # @!attribute [rw] details
@@ -3696,12 +3697,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
@@ -5084,7 +5085,7 @@ module Aws::SSM
     #   data as a hash:
     #
     #       {
-    #         deletion_id: "InventoryDeletionId",
+    #         deletion_id: "UUID",
     #         next_token: "NextToken",
     #         max_results: 1,
     #       }
@@ -6510,18 +6511,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`.
+    #   * Amazon
     #
-    # 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:
+    #   * 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
@@ -6530,12 +6573,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:
     #
@@ -8380,6 +8427,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
@@ -9171,14 +9226,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]
@@ -9219,8 +9274,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
@@ -11170,9 +11225,9 @@ module Aws::SSM
     # @!attribute [rw] sync_type
     #   View a list of resource data syncs according to the sync type.
     #   Specify `SyncToDestination` to view resource data syncs that
-    #   synchronize data to an Amazon S3 buckets. Specify `SyncFromSource`
-    #   to view resource data syncs from AWS Organizations or from multiple
-    #   AWS Regions.
+    #   synchronize data to an Amazon S3 bucket. Specify `SyncFromSource` to
+    #   view resource data syncs from AWS Organizations or from multiple AWS
+    #   Regions.
     #   @return [String]
     #
     # @!attribute [rw] next_token
@@ -13149,25 +13204,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:
     #
@@ -13179,6 +13215,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
@@ -13188,8 +13244,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
@@ -13999,6 +14055,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
@@ -16782,8 +16844,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]
@@ -17637,6 +17698,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
@@ -17680,7 +17752,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]
     #

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

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::SSM
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  # | waiter_name      | params                          | :delay   | :max_attempts |
+  # | ---------------- | ------------------------------- | -------- | ------------- |
+  # | command_executed | {Client#get_command_invocation} | 5        | 20            |
+  #
+  module Waiters
+
+    class CommandExecuted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Integer] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 20,
+          delay: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_command_invocation,
+            acceptors: [
+              {
+                "expected" => "Pending",
+                "matcher" => "path",
+                "state" => "retry",
+                "argument" => "status"
+              },
+              {
+                "expected" => "InProgress",
+                "matcher" => "path",
+                "state" => "retry",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Delayed",
+                "matcher" => "path",
+                "state" => "retry",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Success",
+                "matcher" => "path",
+                "state" => "success",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Cancelled",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              },
+              {
+                "expected" => "TimedOut",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Failed",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Cancelling",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_command_invocation)
+      # @return (see Client#get_command_invocation)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+  end
+end