aws-sdk-elastictranscoder 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 946bca39875624fba00c971d84f0c0dd38b49d68
-  data.tar.gz: 81bb48481ad9af4ec90dd8ced27ae08570d00e45
+SHA256:
+  metadata.gz: 16d297ea7614b7d70a39669c4dd9a13006940291af9718276f10f14cda8514f7
+  data.tar.gz: 5e37493416ec3269ad5a235f48616c5a81b5185c42830b40ea6a59d926c83c9b
 SHA512:
-  metadata.gz: 1a0dcb8ed3c130c76ca50e80ab32386c14be58d87c1472996ae6005d71d7b8fca4023d337a676922c66a5e8591cf7ddf89083a4f5b629afb27cc8aedf0fca09c
-  data.tar.gz: 9612d596b1599417bd179a99f227e17f8782eedf658dab46f9fba0427c801bf1861c31caa7cd77caa4aebd5fd4f771a2dab83d319c91b58cd64cb358196dbedc
+  metadata.gz: 2f5b73d622e8296785cc5668b3473d43a2d2e3fbbc5fef09c2e45ed54212c62389066ac480929cc97a5467a7a8c8afe7b615aaa7ca7a3ab131248e2ed5e094f5
+  data.tar.gz: bb126494554aca83f823711cd02b7f25dd63fd6555f6f30a2be1de98e570de6235795d403d57b7bfc6c203eb9e9684e191a3f35e66a8458d2b4bc8f206d4a36f

data/lib/aws-sdk-elastictranscoder.rb

@@ -46,6 +46,6 @@ require_relative 'aws-sdk-elastictranscoder/customizations'
 # @service
 module Aws::ElasticTranscoder
 
-  GEM_VERSION = '1.19.0'
+  GEM_VERSION = '1.20.0'
 
 end

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

@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:elastictranscoder)
 module Aws::ElasticTranscoder
   # An API client for ElasticTranscoder.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::ElasticTranscoder::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::ElasticTranscoder::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).
@@ -105,7 +105,7 @@ module Aws::ElasticTranscoder
     #   @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']`
@@ -161,7 +161,7 @@ module Aws::ElasticTranscoder
     #   @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 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
@@ -229,15 +229,19 @@ module Aws::ElasticTranscoder
     #
     #   @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.
+    #
+    #     * `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
     #
@@ -265,8 +269,7 @@ module Aws::ElasticTranscoder
     #
     #   @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 yielded 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 idle before it is
@@ -278,7 +281,7 @@ module Aws::ElasticTranscoder
     #     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 yielded 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`.
@@ -1460,6 +1463,8 @@ module Aws::ElasticTranscoder
     #   * {Types::ListJobsByPipelineResponse#jobs #jobs} => Array<Types::Job>
     #   * {Types::ListJobsByPipelineResponse#next_page_token #next_page_token} => 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.list_jobs_by_pipeline({
@@ -1713,6 +1718,8 @@ module Aws::ElasticTranscoder
     #   * {Types::ListJobsByStatusResponse#jobs #jobs} => Array<Types::Job>
     #   * {Types::ListJobsByStatusResponse#next_page_token #next_page_token} => 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.list_jobs_by_status({
@@ -1960,6 +1967,8 @@ module Aws::ElasticTranscoder
     #   * {Types::ListPipelinesResponse#pipelines #pipelines} => Array<Types::Pipeline>
     #   * {Types::ListPipelinesResponse#next_page_token #next_page_token} => 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.list_pipelines({
@@ -2024,6 +2033,8 @@ module Aws::ElasticTranscoder
     #   * {Types::ListPresetsResponse#presets #presets} => Array<Types::Preset>
     #   * {Types::ListPresetsResponse#next_page_token #next_page_token} => 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.list_presets({
@@ -2320,6 +2331,11 @@ module Aws::ElasticTranscoder
     #   resp.job.timing.start_time_millis #=> Integer
     #   resp.job.timing.finish_time_millis #=> Integer
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * job_complete
+    #
     # @overload read_job(params = {})
     # @param [Hash] params ({})
     def read_job(params = {}, options = {})
@@ -2956,7 +2972,7 @@ module Aws::ElasticTranscoder
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-elastictranscoder'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.20.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -3022,9 +3038,9 @@ module Aws::ElasticTranscoder
     # 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 |
-    # | ------------ | ----------- | -------- | ------------- |
-    # | job_complete | {#read_job} | 30       | 120           |
+    # | waiter_name  | params            | :delay   | :max_attempts |
+    # | ------------ | ----------------- | -------- | ------------- |
+    # | job_complete | {Client#read_job} | 30       | 120           |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

data/lib/aws-sdk-elastictranscoder/resource.rb

@@ -6,13 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::ElasticTranscoder
-  # This class provides a resource oriented interface for ElasticTranscoder.
-  # To create a resource object:
-  #     resource = Aws::ElasticTranscoder::Resource.new(region: 'us-west-2')
-  # You can supply a client object with custom configuration that will be used for all resource operations.
-  # If you do not pass +:client+, a default client will be constructed.
-  #     client = Aws::ElasticTranscoder::Client.new(region: 'us-west-2')
-  #     resource = Aws::ElasticTranscoder::Resource.new(client: client)
+
   class Resource
 
     # @param options ({})

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

@@ -8,6 +8,67 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::ElasticTranscoder
+  # 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 |
+  # | ------------ | ----------------- | -------- | ------------- |
+  # | job_complete | {Client#read_job} | 30       | 120           |
+  #
   module Waiters
 
     class JobComplete

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-elastictranscoder
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Elastic Transcoder