aws-sdk-batch 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 660540f10f4b01f51f15f8ba707a1b8831790c2b
-  data.tar.gz: 98289444c3b798267f4f512a86f54bbe9a89adbd
+  metadata.gz: c6cec8aac28cdf503dc1884567175d278acb0fdf
+  data.tar.gz: 88d7664fee2b6ff704b5b697ab189862716c540a
 SHA512:
-  metadata.gz: f2fe01fe2f20a2eb89d53265827e7680ef954a173aa277a5520de285b6757ff612bc178143245056b8a79574f085108bb3a389e8e7b56cf25fe1f389eebac770
-  data.tar.gz: 074804531a19749e5bb5bc32224029d509600fca759046b980455233e214ac1b419b0305efa9f3e35ef772a7c17f553d8155fc13eaaa275e38f08888d84f2ad0
+  metadata.gz: 70f650e9cacd80136037c1b424b4b68a6553a3949117cb98214861f188a512e5414ec8ed54211adaadeb7e1d9884d14ef72cea6c83d8180fd14f826a56b8c805
+  data.tar.gz: b2ebb1d0639ef5327d7377bdea549f5ecd87d7cec5c72aa7ebe475edceab1bb292b5b8248180914fa8f5832b0901eef95275785d5be3826fb6f98b4d0c7fa28f

data/lib/aws-sdk-batch.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-batch/customizations'
 # @service
 module Aws::Batch
 
-  GEM_VERSION = '1.3.0'
+  GEM_VERSION = '1.4.0'
 
 end

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

@@ -881,6 +881,7 @@ module Aws::Batch
     #   resp.job_definitions[0].container_properties.ulimits[0].name #=> String
     #   resp.job_definitions[0].container_properties.ulimits[0].soft_limit #=> Integer
     #   resp.job_definitions[0].container_properties.user #=> String
+    #   resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
@@ -1112,6 +1113,7 @@ module Aws::Batch
     #   resp.jobs[0].array_properties.status_summary["String"] #=> Integer
     #   resp.jobs[0].array_properties.size #=> Integer
     #   resp.jobs[0].array_properties.index #=> Integer
+    #   resp.jobs[0].timeout.attempt_duration_seconds #=> Integer
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
     #
@@ -1262,7 +1264,22 @@ module Aws::Batch
     # @option params [Types::RetryStrategy] :retry_strategy
     #   The retry strategy to use for failed jobs that are submitted with this
     #   job definition. Any retry strategy that is specified during a
-    #   SubmitJob operation overrides the retry strategy defined here.
+    #   SubmitJob operation overrides the retry strategy defined here. If a
+    #   job is terminated due to a timeout, it is not retried.
+    #
+    # @option params [Types::JobTimeout] :timeout
+    #   The timeout configuration for jobs that are submitted with this job
+    #   definition, after which AWS Batch terminates your jobs if they have
+    #   not finished. If a job is terminated due to a timeout, it is not
+    #   retried. The minimum value for the timeout is 60 seconds. Any timeout
+    #   configuration that is specified during a SubmitJob operation overrides
+    #   the timeout configuration defined here. For more information, see [Job
+    #   Timeouts][1] in the *Amazon Elastic Container Service Developer
+    #   Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
     #
     # @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1345,6 +1362,9 @@ module Aws::Batch
     #     retry_strategy: {
     #       attempts: 1,
     #     },
+    #     timeout: {
+    #       attempt_duration_seconds: 1,
+    #     },
     #   })
     #
     # @example Response structure
@@ -1420,6 +1440,21 @@ module Aws::Batch
     #   operation. When a retry strategy is specified here, it overrides the
     #   retry strategy defined in the job definition.
     #
+    # @option params [Types::JobTimeout] :timeout
+    #   The timeout configuration for this SubmitJob operation. You can
+    #   specify a timeout duration after which AWS Batch terminates your jobs
+    #   if they have not finished. If a job is terminated due to a timeout, it
+    #   is not retried. The minimum value for the timeout is 60 seconds. This
+    #   configuration overrides any timeout configuration specified in the job
+    #   definition. For array jobs, child jobs have the same timeout
+    #   configuration as the parent job. For more information, see [Job
+    #   Timeouts][1] in the *Amazon Elastic Container Service Developer
+    #   Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
+    #
     # @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::SubmitJobResponse#job_name #job_name} => String
@@ -1474,6 +1509,9 @@ module Aws::Batch
     #     retry_strategy: {
     #       attempts: 1,
     #     },
+    #     timeout: {
+    #       attempt_duration_seconds: 1,
+    #     },
     #   })
     #
     # @example Response structure
@@ -1699,7 +1737,7 @@ module Aws::Batch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-batch'
-      context[:gem_version] = '1.3.0'
+      context[:gem_version] = '1.4.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -72,6 +72,7 @@ module Aws::Batch
     JobStatus = Shapes::StringShape.new(name: 'JobStatus')
     JobSummary = Shapes::StructureShape.new(name: 'JobSummary')
     JobSummaryList = Shapes::ListShape.new(name: 'JobSummaryList')
+    JobTimeout = Shapes::StructureShape.new(name: 'JobTimeout')
     KeyValuePair = Shapes::StructureShape.new(name: 'KeyValuePair')
     ListJobsRequest = Shapes::StructureShape.new(name: 'ListJobsRequest')
     ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
@@ -301,6 +302,7 @@ module Aws::Batch
     JobDefinition.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
     JobDefinition.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
     JobDefinition.add_member(:container_properties, Shapes::ShapeRef.new(shape: ContainerProperties, location_name: "containerProperties"))
+    JobDefinition.add_member(:timeout, Shapes::ShapeRef.new(shape: JobTimeout, location_name: "timeout"))
     JobDefinition.struct_class = Types::JobDefinition
 
     JobDefinitionList.member = Shapes::ShapeRef.new(shape: JobDefinition)
@@ -326,6 +328,7 @@ module Aws::Batch
     JobDetail.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
     JobDetail.add_member(:container, Shapes::ShapeRef.new(shape: ContainerDetail, location_name: "container"))
     JobDetail.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesDetail, location_name: "arrayProperties"))
+    JobDetail.add_member(:timeout, Shapes::ShapeRef.new(shape: JobTimeout, location_name: "timeout"))
     JobDetail.struct_class = Types::JobDetail
 
     JobDetailList.member = Shapes::ShapeRef.new(shape: JobDetail)
@@ -354,6 +357,9 @@ module Aws::Batch
 
     JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
 
+    JobTimeout.add_member(:attempt_duration_seconds, Shapes::ShapeRef.new(shape: Integer, location_name: "attemptDurationSeconds"))
+    JobTimeout.struct_class = Types::JobTimeout
+
     KeyValuePair.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
     KeyValuePair.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
     KeyValuePair.struct_class = Types::KeyValuePair
@@ -384,6 +390,7 @@ module Aws::Batch
     RegisterJobDefinitionRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
     RegisterJobDefinitionRequest.add_member(:container_properties, Shapes::ShapeRef.new(shape: ContainerProperties, location_name: "containerProperties"))
     RegisterJobDefinitionRequest.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
+    RegisterJobDefinitionRequest.add_member(:timeout, Shapes::ShapeRef.new(shape: JobTimeout, location_name: "timeout"))
     RegisterJobDefinitionRequest.struct_class = Types::RegisterJobDefinitionRequest
 
     RegisterJobDefinitionResponse.add_member(:job_definition_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobDefinitionName"))
@@ -404,6 +411,7 @@ module Aws::Batch
     SubmitJobRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
     SubmitJobRequest.add_member(:container_overrides, Shapes::ShapeRef.new(shape: ContainerOverrides, location_name: "containerOverrides"))
     SubmitJobRequest.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
+    SubmitJobRequest.add_member(:timeout, Shapes::ShapeRef.new(shape: JobTimeout, location_name: "timeout"))
     SubmitJobRequest.struct_class = Types::SubmitJobRequest
 
     SubmitJobResponse.add_member(:job_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobName"))

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

@@ -123,15 +123,16 @@ module Aws::Batch
     #   @return [Types::AttemptContainerDetail]
     #
     # @!attribute [rw] started_at
-    #   The Unix time stamp for when the attempt was started (when the
-    #   attempt transitioned from the `STARTING` state to the `RUNNING`
-    #   state).
+    #   The Unix time stamp (in seconds and milliseconds) for when the
+    #   attempt was started (when the attempt transitioned from the
+    #   `STARTING` state to the `RUNNING` state).
     #   @return [Integer]
     #
     # @!attribute [rw] stopped_at
-    #   The Unix time stamp for when the attempt was stopped (when the
-    #   attempt transitioned from the `RUNNING` state to a terminal state,
-    #   such as `SUCCEEDED` or `FAILED`).
+    #   The Unix time stamp (in seconds and milliseconds) for when the
+    #   attempt was stopped (when the attempt transitioned from the
+    #   `RUNNING` state to a terminal state, such as `SUCCEEDED` or
+    #   `FAILED`).
     #   @return [Integer]
     #
     # @!attribute [rw] status_reason
@@ -684,11 +685,18 @@ module Aws::Batch
     #   `--memory` option to [docker run][3]. You must specify at least 4
     #   MiB of memory for a job.
     #
+    #   <note markdown="1"> If you are trying to maximize your resource utilization by providing
+    #   your jobs as much memory as possible for a particular instance type,
+    #   see [Memory Management][4] in the *AWS Batch User Guide*.
+    #
+    #    </note>
+    #
     #
     #
     #   [1]: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container
     #   [2]: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/
     #   [3]: https://docs.docker.com/engine/reference/run/
+    #   [4]: http://docs.aws.amazon.com/batch/latest/userguide/memory-management.html
     #   @return [Integer]
     #
     # @!attribute [rw] command
@@ -1384,6 +1392,12 @@ module Aws::Batch
     #   An object with various properties specific to container-based jobs.
     #   @return [Types::ContainerProperties]
     #
+    # @!attribute [rw] timeout
+    #   The timeout configuration for jobs that are submitted with this job
+    #   definition. You can specify a timeout duration after which AWS Batch
+    #   terminates your jobs if they have not finished.
+    #   @return [Types::JobTimeout]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDefinition AWS API Documentation
     #
     class JobDefinition < Struct.new(
@@ -1394,7 +1408,8 @@ module Aws::Batch
       :type,
       :parameters,
       :retry_strategy,
-      :container_properties)
+      :container_properties,
+      :timeout)
       include Aws::Structure
     end
 
@@ -1453,11 +1468,11 @@ module Aws::Batch
     #   @return [String]
     #
     # @!attribute [rw] created_at
-    #   The Unix time stamp for when the job was created. For non-array jobs
-    #   and parent array jobs, this is when the job entered the `SUBMITTED`
-    #   state (at the time SubmitJob was called). For array child jobs, this
-    #   is when the child job was spawned by its parent and entered the
-    #   `PENDING` state.
+    #   The Unix time stamp (in seconds and milliseconds) for when the job
+    #   was created. For non-array jobs and parent array jobs, this is when
+    #   the job entered the `SUBMITTED` state (at the time SubmitJob was
+    #   called). For array child jobs, this is when the child job was
+    #   spawned by its parent and entered the `PENDING` state.
     #   @return [Integer]
     #
     # @!attribute [rw] retry_strategy
@@ -1465,14 +1480,15 @@ module Aws::Batch
     #   @return [Types::RetryStrategy]
     #
     # @!attribute [rw] started_at
-    #   The Unix time stamp for when the job was started (when the job
-    #   transitioned from the `STARTING` state to the `RUNNING` state).
+    #   The Unix time stamp (in seconds and milliseconds) for when the job
+    #   was started (when the job transitioned from the `STARTING` state to
+    #   the `RUNNING` state).
     #   @return [Integer]
     #
     # @!attribute [rw] stopped_at
-    #   The Unix time stamp for when the job was stopped (when the job
-    #   transitioned from the `RUNNING` state to a terminal state, such as
-    #   `SUCCEEDED` or `FAILED`).
+    #   The Unix time stamp (in seconds and milliseconds) for when the job
+    #   was stopped (when the job transitioned from the `RUNNING` state to a
+    #   terminal state, such as `SUCCEEDED` or `FAILED`).
     #   @return [Integer]
     #
     # @!attribute [rw] depends_on
@@ -1498,6 +1514,10 @@ module Aws::Batch
     #   The array properties of the job, if it is an array job.
     #   @return [Types::ArrayPropertiesDetail]
     #
+    # @!attribute [rw] timeout
+    #   The timeout configuration for the job.
+    #   @return [Types::JobTimeout]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
     #
     class JobDetail < Struct.new(
@@ -1515,7 +1535,8 @@ module Aws::Batch
       :job_definition,
       :parameters,
       :container,
-      :array_properties)
+      :array_properties,
+      :timeout)
       include Aws::Structure
     end
 
@@ -1627,6 +1648,28 @@ module Aws::Batch
       include Aws::Structure
     end
 
+    # An object representing a job timeout configuration.
+    #
+    # @note When making an API call, you may pass JobTimeout
+    #   data as a hash:
+    #
+    #       {
+    #         attempt_duration_seconds: 1,
+    #       }
+    #
+    # @!attribute [rw] attempt_duration_seconds
+    #   The time duration in seconds (measured from the job attempt's
+    #   `startedAt` timestamp) after which AWS Batch terminates your jobs if
+    #   they have not finished.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobTimeout AWS API Documentation
+    #
+    class JobTimeout < Struct.new(
+      :attempt_duration_seconds)
+      include Aws::Structure
+    end
+
     # A key-value pair object.
     #
     # @note When making an API call, you may pass KeyValuePair
@@ -1821,6 +1864,9 @@ module Aws::Batch
     #         retry_strategy: {
     #           attempts: 1,
     #         },
+    #         timeout: {
+    #           attempt_duration_seconds: 1,
+    #         },
     #       }
     #
     # @!attribute [rw] job_definition_name
@@ -1848,9 +1894,25 @@ module Aws::Batch
     # @!attribute [rw] retry_strategy
     #   The retry strategy to use for failed jobs that are submitted with
     #   this job definition. Any retry strategy that is specified during a
-    #   SubmitJob operation overrides the retry strategy defined here.
+    #   SubmitJob operation overrides the retry strategy defined here. If a
+    #   job is terminated due to a timeout, it is not retried.
     #   @return [Types::RetryStrategy]
     #
+    # @!attribute [rw] timeout
+    #   The timeout configuration for jobs that are submitted with this job
+    #   definition, after which AWS Batch terminates your jobs if they have
+    #   not finished. If a job is terminated due to a timeout, it is not
+    #   retried. The minimum value for the timeout is 60 seconds. Any
+    #   timeout configuration that is specified during a SubmitJob operation
+    #   overrides the timeout configuration defined here. For more
+    #   information, see [Job Timeouts][1] in the *Amazon Elastic Container
+    #   Service Developer Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
+    #   @return [Types::JobTimeout]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinitionRequest AWS API Documentation
     #
     class RegisterJobDefinitionRequest < Struct.new(
@@ -1858,7 +1920,8 @@ module Aws::Batch
       :type,
       :parameters,
       :container_properties,
-      :retry_strategy)
+      :retry_strategy,
+      :timeout)
       include Aws::Structure
     end
 
@@ -1939,6 +2002,9 @@ module Aws::Batch
     #         retry_strategy: {
     #           attempts: 1,
     #         },
+    #         timeout: {
+    #           attempt_duration_seconds: 1,
+    #         },
     #       }
     #
     # @!attribute [rw] job_name
@@ -2004,6 +2070,22 @@ module Aws::Batch
     #   retry strategy defined in the job definition.
     #   @return [Types::RetryStrategy]
     #
+    # @!attribute [rw] timeout
+    #   The timeout configuration for this SubmitJob operation. You can
+    #   specify a timeout duration after which AWS Batch terminates your
+    #   jobs if they have not finished. If a job is terminated due to a
+    #   timeout, it is not retried. The minimum value for the timeout is 60
+    #   seconds. This configuration overrides any timeout configuration
+    #   specified in the job definition. For array jobs, child jobs have the
+    #   same timeout configuration as the parent job. For more information,
+    #   see [Job Timeouts][1] in the *Amazon Elastic Container Service
+    #   Developer Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
+    #   @return [Types::JobTimeout]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJobRequest AWS API Documentation
     #
     class SubmitJobRequest < Struct.new(
@@ -2014,7 +2096,8 @@ module Aws::Batch
       :job_definition,
       :parameters,
       :container_overrides,
-      :retry_strategy)
+      :retry_strategy,
+      :timeout)
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-batch
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWS Batch