aws-sdk-workdocs 1.20.1 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e571db84aef9c82687b7ab0da7228750d2ab771
-  data.tar.gz: b2b8d085a96be2c878c2eac8c6db02445006dece
+SHA256:
+  metadata.gz: 6d7e6fe8998b228d01c2beb99ba74235ddd56dc9a73b64774cb27a3ff028d2e5
+  data.tar.gz: 33aab2a444265f5631b13a013f07ad5bb6a5469be20bc39f599f341ab3b8c98e
 SHA512:
-  metadata.gz: a198e25b472226da847b537b382a5074e3a1f078c63dfc4ae45a0192e94219d35565cc5369530c3cee1d9bc0fe4524baef2d245c470f39fa2355938d4c522a0c
-  data.tar.gz: 5d7075c9ee7ee38c900d84b73bd665d9abe96b3901e9fd32593cea23b6b5426962f8545054d944eda34204ac41241b56b7e4cb3b0592719033c50f2baaabb785
+  metadata.gz: 2cc7e5aa2597b7ecc0f88627d50e9dc46c1e17981127422bc834653defbf8dc9903fa184988dce50f935f573c8bb949e53016ba653766e0f629ea79590013eaa
+  data.tar.gz: 5bef30e7a53ec1670d0fb951a393ef20166a81e03ce196cc1f0a5729d0e86cc09f3913a72a47a4f6d20a2fcef93b8255bfe86437207916b599be69cf0f0d5cd7

data/lib/aws-sdk-workdocs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,17 +26,20 @@ require_relative 'aws-sdk-workdocs/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     work_docs = Aws::WorkDocs::Client.new
+#     resp = work_docs.abort_document_version_upload(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon WorkDocs all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon WorkDocs are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::WorkDocs::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon WorkDocs API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +47,6 @@ require_relative 'aws-sdk-workdocs/customizations'
 # @service
 module Aws::WorkDocs
 
-  GEM_VERSION = '1.20.1'
+  GEM_VERSION = '1.25.0'
 
 end

data/lib/aws-sdk-workdocs/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,12 +26,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:workdocs)
 
 module Aws::WorkDocs
+  # An API client for WorkDocs.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::WorkDocs::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -57,6 +72,7 @@ module Aws::WorkDocs
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -93,7 +109,7 @@ module Aws::WorkDocs
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +124,12 @@ module Aws::WorkDocs
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +154,10 @@ module Aws::WorkDocs
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +165,7 @@ module Aws::WorkDocs
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +180,7 @@ module Aws::WorkDocs
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +192,29 @@ module Aws::WorkDocs
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +222,30 @@ module Aws::WorkDocs
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -209,16 +268,15 @@ module Aws::WorkDocs
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -227,7 +285,7 @@ module Aws::WorkDocs
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -1253,6 +1311,8 @@ module Aws::WorkDocs
     #   * {Types::DescribeDocumentVersionsResponse#document_versions #document_versions} => Array&lt;Types::DocumentVersionMetadata&gt;
     #   * {Types::DescribeDocumentVersionsResponse#marker #marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_document_versions({
@@ -1334,6 +1394,8 @@ module Aws::WorkDocs
     #   * {Types::DescribeFolderContentsResponse#documents #documents} => Array&lt;Types::DocumentMetadata&gt;
     #   * {Types::DescribeFolderContentsResponse#marker #marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_folder_contents({
@@ -1652,6 +1714,8 @@ module Aws::WorkDocs
     #   * {Types::DescribeUsersResponse#total_number_of_users #total_number_of_users} => Integer
     #   * {Types::DescribeUsersResponse#marker #marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_users({
@@ -2497,7 +2561,7 @@ module Aws::WorkDocs
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workdocs'
-      context[:gem_version] = '1.20.1'
+      context[:gem_version] = '1.25.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-workdocs/client_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

data/lib/aws-sdk-workdocs/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,53 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::WorkDocs
+
+  # When WorkDocs returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::WorkDocs::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all WorkDocs errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::WorkDocs::Errors::ServiceError
+  #       # rescues all WorkDocs API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {ConcurrentModificationException}
+  # * {ConflictingOperationException}
+  # * {CustomMetadataLimitExceededException}
+  # * {DeactivatingLastSystemUserException}
+  # * {DocumentLockedForCommentsException}
+  # * {DraftUploadOutOfSyncException}
+  # * {EntityAlreadyExistsException}
+  # * {EntityNotExistsException}
+  # * {FailedDependencyException}
+  # * {IllegalUserStateException}
+  # * {InvalidArgumentException}
+  # * {InvalidCommentOperationException}
+  # * {InvalidOperationException}
+  # * {InvalidPasswordException}
+  # * {LimitExceededException}
+  # * {ProhibitedStateException}
+  # * {RequestedEntityTooLargeException}
+  # * {ResourceAlreadyCheckedOutException}
+  # * {ServiceUnavailableException}
+  # * {StorageLimitExceededException}
+  # * {StorageLimitWillExceedException}
+  # * {TooManyLabelsException}
+  # * {TooManySubscriptionsException}
+  # * {UnauthorizedOperationException}
+  # * {UnauthorizedResourceAccessException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +72,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class ConflictingOperationException < ServiceError
@@ -39,7 +87,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class CustomMetadataLimitExceededException < ServiceError
@@ -55,7 +102,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class DeactivatingLastSystemUserException < ServiceError
@@ -66,7 +112,6 @@ module Aws::WorkDocs
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
-
     end
 
     class DocumentLockedForCommentsException < ServiceError
@@ -82,7 +127,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class DraftUploadOutOfSyncException < ServiceError
@@ -98,7 +142,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class EntityAlreadyExistsException < ServiceError
@@ -114,7 +157,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class EntityNotExistsException < ServiceError
@@ -135,7 +177,6 @@ module Aws::WorkDocs
       def entity_ids
         @data[:entity_ids]
       end
-
     end
 
     class FailedDependencyException < ServiceError
@@ -151,7 +192,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class IllegalUserStateException < ServiceError
@@ -167,7 +207,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidArgumentException < ServiceError
@@ -183,7 +222,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidCommentOperationException < ServiceError
@@ -199,7 +237,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidOperationException < ServiceError
@@ -215,7 +252,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidPasswordException < ServiceError
@@ -231,7 +267,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -247,7 +282,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class ProhibitedStateException < ServiceError
@@ -263,7 +297,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class RequestedEntityTooLargeException < ServiceError
@@ -279,7 +312,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceAlreadyCheckedOutException < ServiceError
@@ -295,7 +327,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServiceUnavailableException < ServiceError
@@ -311,7 +342,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class StorageLimitExceededException < ServiceError
@@ -327,7 +357,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class StorageLimitWillExceedException < ServiceError
@@ -343,7 +372,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyLabelsException < ServiceError
@@ -359,7 +387,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManySubscriptionsException < ServiceError
@@ -375,7 +402,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnauthorizedOperationException < ServiceError
@@ -386,7 +412,6 @@ module Aws::WorkDocs
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
-
     end
 
     class UnauthorizedResourceAccessException < ServiceError
@@ -402,7 +427,6 @@ module Aws::WorkDocs
       def message
         @message || @data[:message]
       end
-
     end
 
   end