aws-sdk-batch 1.26.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d4f9c9f764e3dad31d4a65fd300728eed93eb12d
-  data.tar.gz: 5db3c7cd6a024c380e8127df499f81b415d480f2
+SHA256:
+  metadata.gz: 409fb6859a04ce826dcc57ba02fdac27e0364b9b429f1791878dab39d7775f90
+  data.tar.gz: c78c86d9f79a96594d826cb569b351b1b4a73457251ea1a193a91f655a4e3a6d
 SHA512:
-  metadata.gz: bf5084553b16e6ce6566d6b6a0536a087aa1bb141483e72d8c811583e635966e0568f72697986676ce65d8ecd735cc7363cc5a22ad79ca095e5885f026bfeefa
-  data.tar.gz: 5a84626d1766586b42216727b72a065176c1e05caae5533e1e7eff0b3ef195fb0fa8096073f54334749c36869b5518323c0a90beddcf00f8d07d53d122a1fc6a
+  metadata.gz: 4a3a5c4463196fa448131179cd3770b4c565c9ae1a380138267e4360f711b3a603c66fcd41250901aa67615510e2009e504247623380b9b009dd497d734c9c50
+  data.tar.gz: 6927c0a689319311dbc008aba769ce125431f3d9090b0d8e00416cf79d270412ac2a4df8bc6ab40f923682c0a29638f05760b90b4351544bad65a12549bc99f6

data/lib/aws-sdk-batch.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-batch/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     batch = Aws::Batch::Client.new
+#     resp = batch.cancel_job(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from AWS Batch all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS Batch are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::Batch::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all AWS Batch API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-batch/customizations'
 # @service
 module Aws::Batch
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.31.0'
 
 end

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:batch)
 
 module Aws::Batch
+  # An API client for Batch.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::Batch::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
@@ -93,7 +105,7 @@ module Aws::Batch
     #   @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 +120,12 @@ module Aws::Batch
     #     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 +150,10 @@ module Aws::Batch
     #     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 +161,7 @@ module Aws::Batch
     #   @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
@@ -154,7 +176,7 @@ module Aws::Batch
     #     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 +188,29 @@ module Aws::Batch
     #     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 +218,30 @@ module Aws::Batch
     #     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 +264,15 @@ module Aws::Batch
     #     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 +281,7 @@ module Aws::Batch
     #     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`.
@@ -734,7 +788,8 @@ module Aws::Batch
       req.send_request(options)
     end
 
-    # Deregisters an AWS Batch job definition.
+    # Deregisters an AWS Batch job definition. Job definitions will be
+    # permanently deleted after 180 days.
     #
     # @option params [required, String] :job_definition
     #   The name and revision (`name:revision`) or full Amazon Resource Name
@@ -810,6 +865,8 @@ module Aws::Batch
     #   * {Types::DescribeComputeEnvironmentsResponse#compute_environments #compute_environments} => Array&lt;Types::ComputeEnvironmentDetail&gt;
     #   * {Types::DescribeComputeEnvironmentsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To describe a compute environment
     #
@@ -953,6 +1010,8 @@ module Aws::Batch
     #   * {Types::DescribeJobDefinitionsResponse#job_definitions #job_definitions} => Array&lt;Types::JobDefinition&gt;
     #   * {Types::DescribeJobDefinitionsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To describe active job definitions
     #
@@ -1127,6 +1186,8 @@ module Aws::Batch
     #   * {Types::DescribeJobQueuesResponse#job_queues #job_queues} => Array&lt;Types::JobQueueDetail&gt;
     #   * {Types::DescribeJobQueuesResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To describe a job queue
     #
@@ -1438,6 +1499,8 @@ module Aws::Batch
     #   * {Types::ListJobsResponse#job_summary_list #job_summary_list} => Array&lt;Types::JobSummary&gt;
     #   * {Types::ListJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To list running jobs
     #
@@ -1781,9 +1844,10 @@ module Aws::Batch
     #   child of each dependency to complete before it can begin.
     #
     # @option params [required, String] :job_definition
-    #   The job definition used by this job. This value can be either a
-    #   `name:revision` or the Amazon Resource Name (ARN) for the job
-    #   definition.
+    #   The job definition used by this job. This value can be one of `name`,
+    #   `name:revision`, or the Amazon Resource Name (ARN) for the job
+    #   definition. If `name` is specified without a revision then the latest
+    #   active revision is used.
     #
     # @option params [Hash<String,String>] :parameters
     #   Additional parameters passed to the job that replace parameter
@@ -2141,7 +2205,7 @@ module Aws::Batch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-batch'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.31.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,30 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Batch
+
+  # When Batch returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Batch::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Batch errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Batch::Errors::ServiceError
+  #       # rescues all Batch 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
+  # * {ClientException}
+  # * {ServerException}
+  #
+  # 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 +47,6 @@ module Aws::Batch
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServerException < ServiceError
@@ -39,7 +62,6 @@ module Aws::Batch
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Batch
+
   class Resource
 
     # @param options ({})

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

@@ -342,19 +342,22 @@ module Aws::Batch
     #   or [Amazon EC2 service limits][1]. If this is not specified, the
     #   default is `BEST_FIT`, which will use only the best fitting instance
     #   type, waiting for additional capacity if it's not available. This
-    #   allocation strategy keeps costs lower but can limit scaling.
-    #   `BEST_FIT_PROGRESSIVE` will select an additional instance type that
-    #   is large enough to meet the requirements of the jobs in the queue,
-    #   with a preference for an instance type with a lower cost.
-    #   `SPOT_CAPACITY_OPTIMIZED` is only available for Spot Instance
-    #   compute resources and will select an additional instance type that
-    #   is large enough to meet the requirements of the jobs in the queue,
-    #   with a preference for an instance type that is less likely to be
-    #   interrupted.
+    #   allocation strategy keeps costs lower but can limit scaling. If you
+    #   are using Spot Fleets with `BEST_FIT` then the Spot Fleet IAM Role
+    #   must be specified. `BEST_FIT_PROGRESSIVE` will select additional
+    #   instance types that are large enough to meet the requirements of the
+    #   jobs in the queue, with a preference for instance types with a lower
+    #   cost per vCPU. `SPOT_CAPACITY_OPTIMIZED` is only available for Spot
+    #   Instance compute resources and will select additional instance types
+    #   that are large enough to meet the requirements of the jobs in the
+    #   queue, with a preference for instance types that are less likely to
+    #   be interrupted. For more information, see [Allocation Strategies][2]
+    #   in the *AWS Batch User Guide*.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html
+    #   [2]: https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html
     #   @return [String]
     #
     # @!attribute [rw] minv_cpus
@@ -459,8 +462,10 @@ module Aws::Batch
     #
     # @!attribute [rw] spot_iam_fleet_role
     #   The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
-    #   applied to a `SPOT` compute environment. For more information, see
-    #   [Amazon EC2 Spot Fleet Role][1] in the *AWS Batch User Guide*.
+    #   applied to a `SPOT` compute environment. This role is required if
+    #   the allocation strategy set to `BEST_FIT` or if the allocation
+    #   strategy is not specified. For more information, see [Amazon EC2
+    #   Spot Fleet Role][1] in the *AWS Batch User Guide*.
     #
     #
     #
@@ -1762,7 +1767,7 @@ module Aws::Batch
     #   @return [Integer]
     #
     # @!attribute [rw] depends_on
-    #   A list of job names or IDs on which this job depends.
+    #   A list of job IDs on which this job depends.
     #   @return [Array<Types::JobDependency>]
     #
     # @!attribute [rw] job_definition
@@ -2944,9 +2949,10 @@ module Aws::Batch
     #   @return [Array<Types::JobDependency>]
     #
     # @!attribute [rw] job_definition
-    #   The job definition used by this job. This value can be either a
-    #   `name:revision` or the Amazon Resource Name (ARN) for the job
-    #   definition.
+    #   The job definition used by this job. This value can be one of
+    #   `name`, `name:revision`, or the Amazon Resource Name (ARN) for the
+    #   job definition. If `name` is specified without a revision then the
+    #   latest active revision is used.
     #   @return [String]
     #
     # @!attribute [rw] parameters

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-batch
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.31.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.71.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,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 - AWS Batch