aws-sdk-batch 1.82.0 → 1.83.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f349833dbe27c2b4d504cc54aa22f577deccf0f0313403019cf99077d12c57b
-  data.tar.gz: ac61524af277388a42c549e35774eaccda4e146f11ca1df3644586a9ae66ff74
+  metadata.gz: 654afc632bf18f8dedf03e4ff615f316ae0efe3155596716fc222f619d6193cb
+  data.tar.gz: 5bf3361f366a51789403aedfb2a18a6ec52f8fac83f87a64b9f238bb54e420b2
 SHA512:
-  metadata.gz: b4e32a0ccc4ba9913f31335ebec4c2b3d863eb861e9f03a8fa48782ce7a300200f780be53bde26365e09852031bb62152baf93e98ab7589a1302d9092d163637
-  data.tar.gz: ad8a0c3c7b423095214d736744a5816dc41df2d034b8e603e8bed31831cde5a6080f1ffe0ba08e35808d3c13b12b649305b43a1d1b4b8f5a3dbbc8868962580f
+  metadata.gz: ceae264195f2513c9949279fa79df0b1b713f4113a0f93c73d308901a869eaae07b9dc5e4ba0184018860dace375e139f791340e7b325467fe2220c331844796
+  data.tar.gz: dcc23cda6e64b24e5bcb7523afec050aab42a25148738d8190e63a4320be94cdbb6907c9ab3c1e7d3e1de03805209f5304879c91cc6cda4b6c36e2fe6a0a2054

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.83.0 (2024-03-08)
+------------------
+
+* Feature - This release adds JobStateTimeLimitActions setting to the Job Queue API. It allows you to configure an action Batch can take for a blocking job in front of the queue after the defined period of time. The new parameter applies for ECS, EKS, and FARGATE Job Queues.
+
 1.82.0 (2024-02-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.82.0
+1.83.0

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

@@ -897,6 +897,11 @@ module Aws::Batch
     #
     #   [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
     #
+    # @option params [Array<Types::JobStateTimeLimitAction>] :job_state_time_limit_actions
+    #   The set of actions that Batch performs on jobs that remain at the head
+    #   of the job queue in the specified state longer than specified times.
+    #   Batch will perform each action after `maxTimeSeconds` has passed.
+    #
     # @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateJobQueueResponse#job_queue_name #job_queue_name} => String
@@ -968,6 +973,14 @@ module Aws::Batch
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
+    #     job_state_time_limit_actions: [
+    #       {
+    #         reason: "String", # required
+    #         state: "RUNNABLE", # required, accepts RUNNABLE
+    #         max_time_seconds: 1, # required
+    #         action: "CANCEL", # required, accepts CANCEL
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -1908,6 +1921,11 @@ module Aws::Batch
     #   resp.job_queues[0].compute_environment_order[0].compute_environment #=> String
     #   resp.job_queues[0].tags #=> Hash
     #   resp.job_queues[0].tags["TagKey"] #=> String
+    #   resp.job_queues[0].job_state_time_limit_actions #=> Array
+    #   resp.job_queues[0].job_state_time_limit_actions[0].reason #=> String
+    #   resp.job_queues[0].job_state_time_limit_actions[0].state #=> String, one of "RUNNABLE"
+    #   resp.job_queues[0].job_state_time_limit_actions[0].max_time_seconds #=> Integer
+    #   resp.job_queues[0].job_state_time_limit_actions[0].action #=> String, one of "CANCEL"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues AWS API Documentation
@@ -4336,6 +4354,11 @@ module Aws::Batch
     #
     #    </note>
     #
+    # @option params [Array<Types::JobStateTimeLimitAction>] :job_state_time_limit_actions
+    #   The set of actions that Batch perform on jobs that remain at the head
+    #   of the job queue in the specified state longer than specified times.
+    #   Batch will perform each action after `maxTimeSeconds` has passed.
+    #
     # @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateJobQueueResponse#job_queue_name #job_queue_name} => String
@@ -4370,6 +4393,14 @@ module Aws::Batch
     #         compute_environment: "String", # required
     #       },
     #     ],
+    #     job_state_time_limit_actions: [
+    #       {
+    #         reason: "String", # required
+    #         state: "RUNNABLE", # required, accepts RUNNABLE
+    #         max_time_seconds: 1, # required
+    #         action: "CANCEL", # required, accepts CANCEL
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -4434,7 +4465,7 @@ module Aws::Batch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-batch'
-      context[:gem_version] = '1.82.0'
+      context[:gem_version] = '1.83.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -136,6 +136,10 @@ module Aws::Batch
     JobExecutionTimeoutMinutes = Shapes::IntegerShape.new(name: 'JobExecutionTimeoutMinutes')
     JobQueueDetail = Shapes::StructureShape.new(name: 'JobQueueDetail')
     JobQueueDetailList = Shapes::ListShape.new(name: 'JobQueueDetailList')
+    JobStateTimeLimitAction = Shapes::StructureShape.new(name: 'JobStateTimeLimitAction')
+    JobStateTimeLimitActions = Shapes::ListShape.new(name: 'JobStateTimeLimitActions')
+    JobStateTimeLimitActionsAction = Shapes::StringShape.new(name: 'JobStateTimeLimitActionsAction')
+    JobStateTimeLimitActionsState = Shapes::StringShape.new(name: 'JobStateTimeLimitActionsState')
     JobStatus = Shapes::StringShape.new(name: 'JobStatus')
     JobSummary = Shapes::StructureShape.new(name: 'JobSummary')
     JobSummaryList = Shapes::ListShape.new(name: 'JobSummaryList')
@@ -424,6 +428,7 @@ module Aws::Batch
     CreateJobQueueRequest.add_member(:priority, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "priority"))
     CreateJobQueueRequest.add_member(:compute_environment_order, Shapes::ShapeRef.new(shape: ComputeEnvironmentOrders, required: true, location_name: "computeEnvironmentOrder"))
     CreateJobQueueRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagrisTagsMap, location_name: "tags"))
+    CreateJobQueueRequest.add_member(:job_state_time_limit_actions, Shapes::ShapeRef.new(shape: JobStateTimeLimitActions, location_name: "jobStateTimeLimitActions"))
     CreateJobQueueRequest.struct_class = Types::CreateJobQueueRequest
 
     CreateJobQueueResponse.add_member(:job_queue_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobQueueName"))
@@ -805,10 +810,19 @@ module Aws::Batch
     JobQueueDetail.add_member(:priority, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "priority"))
     JobQueueDetail.add_member(:compute_environment_order, Shapes::ShapeRef.new(shape: ComputeEnvironmentOrders, required: true, location_name: "computeEnvironmentOrder"))
     JobQueueDetail.add_member(:tags, Shapes::ShapeRef.new(shape: TagrisTagsMap, location_name: "tags"))
+    JobQueueDetail.add_member(:job_state_time_limit_actions, Shapes::ShapeRef.new(shape: JobStateTimeLimitActions, location_name: "jobStateTimeLimitActions"))
     JobQueueDetail.struct_class = Types::JobQueueDetail
 
     JobQueueDetailList.member = Shapes::ShapeRef.new(shape: JobQueueDetail)
 
+    JobStateTimeLimitAction.add_member(:reason, Shapes::ShapeRef.new(shape: String, required: true, location_name: "reason"))
+    JobStateTimeLimitAction.add_member(:state, Shapes::ShapeRef.new(shape: JobStateTimeLimitActionsState, required: true, location_name: "state"))
+    JobStateTimeLimitAction.add_member(:max_time_seconds, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "maxTimeSeconds"))
+    JobStateTimeLimitAction.add_member(:action, Shapes::ShapeRef.new(shape: JobStateTimeLimitActionsAction, required: true, location_name: "action"))
+    JobStateTimeLimitAction.struct_class = Types::JobStateTimeLimitAction
+
+    JobStateTimeLimitActions.member = Shapes::ShapeRef.new(shape: JobStateTimeLimitAction)
+
     JobSummary.add_member(:job_arn, Shapes::ShapeRef.new(shape: String, location_name: "jobArn"))
     JobSummary.add_member(:job_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobId"))
     JobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobName"))
@@ -1156,6 +1170,7 @@ module Aws::Batch
     UpdateJobQueueRequest.add_member(:scheduling_policy_arn, Shapes::ShapeRef.new(shape: String, location_name: "schedulingPolicyArn"))
     UpdateJobQueueRequest.add_member(:priority, Shapes::ShapeRef.new(shape: Integer, location_name: "priority"))
     UpdateJobQueueRequest.add_member(:compute_environment_order, Shapes::ShapeRef.new(shape: ComputeEnvironmentOrders, location_name: "computeEnvironmentOrder"))
+    UpdateJobQueueRequest.add_member(:job_state_time_limit_actions, Shapes::ShapeRef.new(shape: JobStateTimeLimitActions, location_name: "jobStateTimeLimitActions"))
     UpdateJobQueueRequest.struct_class = Types::UpdateJobQueueRequest
 
     UpdateJobQueueResponse.add_member(:job_queue_name, Shapes::ShapeRef.new(shape: String, location_name: "jobQueueName"))

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

@@ -2243,6 +2243,13 @@ module Aws::Batch
     #   [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] job_state_time_limit_actions
+    #   The set of actions that Batch performs on jobs that remain at the
+    #   head of the job queue in the specified state longer than specified
+    #   times. Batch will perform each action after `maxTimeSeconds` has
+    #   passed.
+    #   @return [Array<Types::JobStateTimeLimitAction>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueueRequest AWS API Documentation
     #
     class CreateJobQueueRequest < Struct.new(
@@ -2251,7 +2258,8 @@ module Aws::Batch
       :scheduling_policy_arn,
       :priority,
       :compute_environment_order,
-      :tags)
+      :tags,
+      :job_state_time_limit_actions)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4745,6 +4753,20 @@ module Aws::Batch
     # @!attribute [rw] status_reason
     #   A short, human-readable string to provide more details for the
     #   current status of the job.
+    #
+    #   * `CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY` - All compute
+    #     environments have insufficient capacity to service the job.
+    #
+    #   * `MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE` - All compute
+    #     environments have a `maxVcpu` setting that is smaller than the job
+    #     requirements.
+    #
+    #   * `MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT` - All compute
+    #     environments have no connected instances that meet the job
+    #     requirements.
+    #
+    #   * `MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS` - All compute
+    #     environments have problems with the service role permissions.
     #   @return [String]
     #
     # @!attribute [rw] created_at
@@ -4958,6 +4980,13 @@ module Aws::Batch
     #   [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] job_state_time_limit_actions
+    #   The set of actions that Batch perform on jobs that remain at the
+    #   head of the job queue in the specified state longer than specified
+    #   times. Batch will perform each action after `maxTimeSeconds` has
+    #   passed.
+    #   @return [Array<Types::JobStateTimeLimitAction>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobQueueDetail AWS API Documentation
     #
     class JobQueueDetail < Struct.new(
@@ -4969,7 +4998,45 @@ module Aws::Batch
       :status_reason,
       :priority,
       :compute_environment_order,
-      :tags)
+      :tags,
+      :job_state_time_limit_actions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specifies an action that Batch will take after the job has remained at
+    # the head of the queue in the specified state for longer than the
+    # specified time.
+    #
+    # @!attribute [rw] reason
+    #   The reason to log for the action being taken.
+    #   @return [String]
+    #
+    # @!attribute [rw] state
+    #   The state of the job needed to trigger the action. The only
+    #   supported value is "`RUNNABLE`".
+    #   @return [String]
+    #
+    # @!attribute [rw] max_time_seconds
+    #   The approximate amount of time, in seconds, that must pass with the
+    #   job in the specified state before the action is taken. The minimum
+    #   value is 600 (10 minutes) and the maximum value is 86,400 (24
+    #   hours).
+    #   @return [Integer]
+    #
+    # @!attribute [rw] action
+    #   The action to take when a job is at the head of the job queue in the
+    #   specified state for the specified period of time. The only supported
+    #   value is "`CANCEL`", which will cancel the job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobStateTimeLimitAction AWS API Documentation
+    #
+    class JobStateTimeLimitAction < Struct.new(
+      :reason,
+      :state,
+      :max_time_seconds,
+      :action)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -6903,7 +6970,7 @@ module Aws::Batch
     #   rest of the containers in a task. If this parameter is omitted, a
     #   container is assumed to be essential.
     #
-    #   All tasks must have at least one essential container. If you have an
+    #   All jobs must have at least one essential container. If you have an
     #   application that's composed of multiple containers, group
     #   containers that are used for a common purpose into components, and
     #   separate the different components into multiple task definitions.
@@ -7287,7 +7354,7 @@ module Aws::Batch
     #   rest of the containers in a task. If this parameter is omitted, a
     #   container is assumed to be essential.
     #
-    #   All tasks must have at least one essential container. If you have an
+    #   All jobs must have at least one essential container. If you have an
     #   application that's composed of multiple containers, group
     #   containers that are used for a common purpose into components, and
     #   separate the different components into multiple task definitions.
@@ -7871,6 +7938,13 @@ module Aws::Batch
     #    </note>
     #   @return [Array<Types::ComputeEnvironmentOrder>]
     #
+    # @!attribute [rw] job_state_time_limit_actions
+    #   The set of actions that Batch perform on jobs that remain at the
+    #   head of the job queue in the specified state longer than specified
+    #   times. Batch will perform each action after `maxTimeSeconds` has
+    #   passed.
+    #   @return [Array<Types::JobStateTimeLimitAction>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueueRequest AWS API Documentation
     #
     class UpdateJobQueueRequest < Struct.new(
@@ -7878,7 +7952,8 @@ module Aws::Batch
       :state,
       :scheduling_policy_arn,
       :priority,
-      :compute_environment_order)
+      :compute_environment_order,
+      :job_state_time_limit_actions)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-batch.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-batch/customizations'
 # @!group service
 module Aws::Batch
 
-  GEM_VERSION = '1.82.0'
+  GEM_VERSION = '1.83.0'
 
 end

data/sig/client.rbs

@@ -148,7 +148,15 @@ module Aws
                                   compute_environment: ::String
                                 },
                               ],
-                              ?tags: Hash[::String, ::String]
+                              ?tags: Hash[::String, ::String],
+                              ?job_state_time_limit_actions: Array[
+                                {
+                                  reason: ::String,
+                                  state: ("RUNNABLE"),
+                                  max_time_seconds: ::Integer,
+                                  action: ("CANCEL")
+                                },
+                              ]
                             ) -> _CreateJobQueueResponseSuccess
                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateJobQueueResponseSuccess
 
@@ -1179,6 +1187,14 @@ module Aws
                                   order: ::Integer,
                                   compute_environment: ::String
                                 },
+                              ],
+                              ?job_state_time_limit_actions: Array[
+                                {
+                                  reason: ::String,
+                                  state: ("RUNNABLE"),
+                                  max_time_seconds: ::Integer,
+                                  action: ("CANCEL")
+                                },
                               ]
                             ) -> _UpdateJobQueueResponseSuccess
                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateJobQueueResponseSuccess

data/sig/types.rbs

@@ -226,6 +226,7 @@ module Aws::Batch
       attr_accessor priority: ::Integer
       attr_accessor compute_environment_order: ::Array[Types::ComputeEnvironmentOrder]
       attr_accessor tags: ::Hash[::String, ::String]
+      attr_accessor job_state_time_limit_actions: ::Array[Types::JobStateTimeLimitAction]
       SENSITIVE: []
     end
 
@@ -682,6 +683,15 @@ module Aws::Batch
       attr_accessor priority: ::Integer
       attr_accessor compute_environment_order: ::Array[Types::ComputeEnvironmentOrder]
       attr_accessor tags: ::Hash[::String, ::String]
+      attr_accessor job_state_time_limit_actions: ::Array[Types::JobStateTimeLimitAction]
+      SENSITIVE: []
+    end
+
+    class JobStateTimeLimitAction
+      attr_accessor reason: ::String
+      attr_accessor state: ("RUNNABLE")
+      attr_accessor max_time_seconds: ::Integer
+      attr_accessor action: ("CANCEL")
       SENSITIVE: []
     end
 
@@ -1072,6 +1082,7 @@ module Aws::Batch
       attr_accessor scheduling_policy_arn: ::String
       attr_accessor priority: ::Integer
       attr_accessor compute_environment_order: ::Array[Types::ComputeEnvironmentOrder]
+      attr_accessor job_state_time_limit_actions: ::Array[Types::JobStateTimeLimitAction]
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-batch
 version: !ruby/object:Gem::Version
-  version: 1.82.0
+  version: 1.83.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core