aws-sdk-batch 1.87.0 → 1.88.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98c78439dc785ba7eb0b1cb948a2c4e679f2aeaed4da4681641b750356c4bd0a
-  data.tar.gz: 6bcfb28b6d2ae2a397470749248d6d49e16a71be5102dd6a42716d59adae3829
+  metadata.gz: 38b5257ca4fdc54345c4d2fd65ce8ece2f11a777a5374f44dcb0f2c03fdd334a
+  data.tar.gz: 6f0b3a1d89cfd41cb077488a62bce20db5ab6eb506ae00f7ed414a2213288c31
 SHA512:
-  metadata.gz: eb8989b8c329731f52c67f606a16fd367d9718ca1482f8081041506a38b58d86c986d4bf1509e1a4d37af4d0625171b8a0b3eb165ee354b52d29469d416c16a1
-  data.tar.gz: 8128d0dd0b2f85f344c3093b21beff540c59a060888c3289f9419590b0950cb5ea992635db8b6c76c8c16196dd45f5c6bc1f8f31cd0d700f917c1fe1b108b98d
+  metadata.gz: 46f7e2cd285f19cbd8add1705c57027a0b926b3aeac0d95813e9a2bec0b4f5cbe0ec8f67973ec829bb1cd4f57416a980201c5d048b48f23aea24216b0369b38a
+  data.tar.gz: 0f1ea81a5b72d8cf8bcc5a853637ef13dbb1b14aebab85b20265d42ea2f500900535f9acfb119e645a79fdb0d583e07e15118a27cfbf79c661ec1e603241094b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.88.0 (2024-06-03)
+------------------
+
+* Feature - This release adds support for the AWS Batch GetJobQueueSnapshot API operation.
+
 1.87.0 (2024-05-13)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.87.0
+1.88.0

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

@@ -2517,6 +2517,38 @@ module Aws::Batch
       req.send_request(options)
     end
 
+    # Provides a list of the first 100 `RUNNABLE` jobs associated to a
+    # single job queue.
+    #
+    # @option params [required, String] :job_queue
+    #   The job queue’s name or full queue Amazon Resource Name (ARN).
+    #
+    # @return [Types::GetJobQueueSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetJobQueueSnapshotResponse#front_of_queue #front_of_queue} => Types::FrontOfQueueDetail
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_job_queue_snapshot({
+    #     job_queue: "String", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.front_of_queue.jobs #=> Array
+    #   resp.front_of_queue.jobs[0].job_arn #=> String
+    #   resp.front_of_queue.jobs[0].earliest_time_at_position #=> Integer
+    #   resp.front_of_queue.last_updated_at #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/GetJobQueueSnapshot AWS API Documentation
+    #
+    # @overload get_job_queue_snapshot(params = {})
+    # @param [Hash] params ({})
+    def get_job_queue_snapshot(params = {}, options = {})
+      req = build_request(:get_job_queue_snapshot, params)
+      req.send_request(options)
+    end
+
     # Returns a list of Batch jobs.
     #
     # You must specify only one of the following items:
@@ -2551,14 +2583,24 @@ module Aws::Batch
     #   only `RUNNING` jobs are returned.
     #
     # @option params [Integer] :max_results
-    #   The maximum number of results returned by `ListJobs` in paginated
-    #   output. When this parameter is used, `ListJobs` only returns
+    #   The maximum number of results returned by `ListJobs` in a paginated
+    #   output. When this parameter is used, `ListJobs` returns up to
     #   `maxResults` results in a single page and a `nextToken` response
-    #   element. The remaining results of the initial request can be seen by
-    #   sending another `ListJobs` request with the returned `nextToken`
-    #   value. This value can be between 1 and 100. If this parameter isn't
-    #   used, then `ListJobs` returns up to 100 results and a `nextToken`
-    #   value if applicable.
+    #   element, if applicable. The remaining results of the initial request
+    #   can be seen by sending another `ListJobs` request with the returned
+    #   `nextToken` value.
+    #
+    #   The following outlines key parameters and limitations:
+    #
+    #   * The minimum value is 1.
+    #
+    #   * When `--job-status` is used, Batch returns up to 1000 values.
+    #
+    #   * When `--filters` is used, Batch returns up to 100 values.
+    #
+    #   * If neither parameter is used, then `ListJobs` returns up to 1000
+    #     results (jobs that are in the `RUNNING` status) and a `nextToken`
+    #     value, if applicable.
     #
     # @option params [String] :next_token
     #   The `nextToken` value returned from a previous paginated `ListJobs`
@@ -4519,7 +4561,7 @@ module Aws::Batch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-batch'
-      context[:gem_version] = '1.87.0'
+      context[:gem_version] = '1.88.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -122,6 +122,11 @@ module Aws::Batch
     FairsharePolicy = Shapes::StructureShape.new(name: 'FairsharePolicy')
     FargatePlatformConfiguration = Shapes::StructureShape.new(name: 'FargatePlatformConfiguration')
     Float = Shapes::FloatShape.new(name: 'Float')
+    FrontOfQueueDetail = Shapes::StructureShape.new(name: 'FrontOfQueueDetail')
+    FrontOfQueueJobSummary = Shapes::StructureShape.new(name: 'FrontOfQueueJobSummary')
+    FrontOfQueueJobSummaryList = Shapes::ListShape.new(name: 'FrontOfQueueJobSummaryList')
+    GetJobQueueSnapshotRequest = Shapes::StructureShape.new(name: 'GetJobQueueSnapshotRequest')
+    GetJobQueueSnapshotResponse = Shapes::StructureShape.new(name: 'GetJobQueueSnapshotResponse')
     Host = Shapes::StructureShape.new(name: 'Host')
     ImageIdOverride = Shapes::StringShape.new(name: 'ImageIdOverride')
     ImagePullSecret = Shapes::StructureShape.new(name: 'ImagePullSecret')
@@ -761,6 +766,22 @@ module Aws::Batch
     FargatePlatformConfiguration.add_member(:platform_version, Shapes::ShapeRef.new(shape: String, location_name: "platformVersion"))
     FargatePlatformConfiguration.struct_class = Types::FargatePlatformConfiguration
 
+    FrontOfQueueDetail.add_member(:jobs, Shapes::ShapeRef.new(shape: FrontOfQueueJobSummaryList, location_name: "jobs"))
+    FrontOfQueueDetail.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: Long, location_name: "lastUpdatedAt"))
+    FrontOfQueueDetail.struct_class = Types::FrontOfQueueDetail
+
+    FrontOfQueueJobSummary.add_member(:job_arn, Shapes::ShapeRef.new(shape: String, location_name: "jobArn"))
+    FrontOfQueueJobSummary.add_member(:earliest_time_at_position, Shapes::ShapeRef.new(shape: Long, location_name: "earliestTimeAtPosition"))
+    FrontOfQueueJobSummary.struct_class = Types::FrontOfQueueJobSummary
+
+    FrontOfQueueJobSummaryList.member = Shapes::ShapeRef.new(shape: FrontOfQueueJobSummary)
+
+    GetJobQueueSnapshotRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobQueue"))
+    GetJobQueueSnapshotRequest.struct_class = Types::GetJobQueueSnapshotRequest
+
+    GetJobQueueSnapshotResponse.add_member(:front_of_queue, Shapes::ShapeRef.new(shape: FrontOfQueueDetail, location_name: "frontOfQueue"))
+    GetJobQueueSnapshotResponse.struct_class = Types::GetJobQueueSnapshotResponse
+
     Host.add_member(:source_path, Shapes::ShapeRef.new(shape: String, location_name: "sourcePath"))
     Host.struct_class = Types::Host
 
@@ -1237,6 +1258,7 @@ module Aws::Batch
         "endpointPrefix" => "batch",
         "jsonVersion" => "1.1",
         "protocol" => "rest-json",
+        "protocols" => ["rest-json"],
         "serviceAbbreviation" => "AWS Batch",
         "serviceFullName" => "AWS Batch",
         "serviceId" => "Batch",
@@ -1392,6 +1414,16 @@ module Aws::Batch
         o.errors << Shapes::ShapeRef.new(shape: ServerException)
       end)
 
+      api.add_operation(:get_job_queue_snapshot, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetJobQueueSnapshot"
+        o.http_method = "POST"
+        o.http_request_uri = "/v1/getjobqueuesnapshot"
+        o.input = Shapes::ShapeRef.new(shape: GetJobQueueSnapshotRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetJobQueueSnapshotResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ClientException)
+        o.errors << Shapes::ShapeRef.new(shape: ServerException)
+      end)
+
       api.add_operation(:list_jobs, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListJobs"
         o.http_method = "POST"

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

@@ -194,6 +194,20 @@ module Aws::Batch
       end
     end
 
+    class GetJobQueueSnapshot
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Batch::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class ListJobs
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-batch/plugins/endpoints.rb

@@ -84,6 +84,8 @@ module Aws::Batch
             Aws::Batch::Endpoints::DescribeJobs.build(context)
           when :describe_scheduling_policies
             Aws::Batch::Endpoints::DescribeSchedulingPolicies.build(context)
+          when :get_job_queue_snapshot
+            Aws::Batch::Endpoints::GetJobQueueSnapshot.build(context)
           when :list_jobs
             Aws::Batch::Endpoints::ListJobs.build(context)
           when :list_scheduling_policies

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

@@ -4609,6 +4609,79 @@ module Aws::Batch
       include Aws::Structure
     end
 
+    # Contains a list of the first 100 `RUNNABLE` jobs associated to a
+    # single job queue.
+    #
+    # @!attribute [rw] jobs
+    #   The Amazon Resource Names (ARNs) of the first 100 `RUNNABLE` jobs in
+    #   a named job queue. For first-in-first-out (FIFO) job queues, jobs
+    #   are ordered based on their submission time. For fair share
+    #   scheduling (FSS) job queues, jobs are ordered based on their job
+    #   priority and share usage.
+    #   @return [Array<Types::FrontOfQueueJobSummary>]
+    #
+    # @!attribute [rw] last_updated_at
+    #   The Unix timestamp (in milliseconds) for when each of the first 100
+    #   `RUNNABLE` jobs were last updated.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FrontOfQueueDetail AWS API Documentation
+    #
+    class FrontOfQueueDetail < Struct.new(
+      :jobs,
+      :last_updated_at)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An object that represents summary details for the first 100 `RUNNABLE`
+    # jobs in a job queue.
+    #
+    # @!attribute [rw] job_arn
+    #   The ARN for a job in a named job queue.
+    #   @return [String]
+    #
+    # @!attribute [rw] earliest_time_at_position
+    #   The Unix timestamp (in milliseconds) for when the job transitioned
+    #   to its current position in the job queue.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FrontOfQueueJobSummary AWS API Documentation
+    #
+    class FrontOfQueueJobSummary < Struct.new(
+      :job_arn,
+      :earliest_time_at_position)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_queue
+    #   The job queue’s name or full queue Amazon Resource Name (ARN).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/GetJobQueueSnapshotRequest AWS API Documentation
+    #
+    class GetJobQueueSnapshotRequest < Struct.new(
+      :job_queue)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] front_of_queue
+    #   The list of the first 100 `RUNNABLE` jobs in each job queue. For
+    #   first-in-first-out (FIFO) job queues, jobs are ordered based on
+    #   their submission time. For fair share scheduling (FSS) job queues,
+    #   jobs are ordered based on their job priority and share usage.
+    #   @return [Types::FrontOfQueueDetail]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/GetJobQueueSnapshotResponse AWS API Documentation
+    #
+    class GetJobQueueSnapshotResponse < Struct.new(
+      :front_of_queue)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Determine whether your data volume persists on the host container
     # instance and where it's stored. If this parameter is empty, then the
     # Docker daemon assigns a host path for your data volume. However, the
@@ -5543,14 +5616,24 @@ module Aws::Batch
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   The maximum number of results returned by `ListJobs` in paginated
-    #   output. When this parameter is used, `ListJobs` only returns
+    #   The maximum number of results returned by `ListJobs` in a paginated
+    #   output. When this parameter is used, `ListJobs` returns up to
     #   `maxResults` results in a single page and a `nextToken` response
-    #   element. The remaining results of the initial request can be seen by
-    #   sending another `ListJobs` request with the returned `nextToken`
-    #   value. This value can be between 1 and 100. If this parameter isn't
-    #   used, then `ListJobs` returns up to 100 results and a `nextToken`
-    #   value if applicable.
+    #   element, if applicable. The remaining results of the initial request
+    #   can be seen by sending another `ListJobs` request with the returned
+    #   `nextToken` value.
+    #
+    #   The following outlines key parameters and limitations:
+    #
+    #   * The minimum value is 1.
+    #
+    #   * When `--job-status` is used, Batch returns up to 1000 values.
+    #
+    #   * When `--filters` is used, Batch returns up to 100 values.
+    #
+    #   * If neither parameter is used, then `ListJobs` returns up to 1000
+    #     results (jobs that are in the `RUNNING` status) and a `nextToken`
+    #     value, if applicable.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token

data/lib/aws-sdk-batch.rb

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

data/sig/client.rbs

@@ -279,6 +279,16 @@ module Aws
                                         ) -> _DescribeSchedulingPoliciesResponseSuccess
                                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeSchedulingPoliciesResponseSuccess
 
+      interface _GetJobQueueSnapshotResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetJobQueueSnapshotResponse]
+        def front_of_queue: () -> Types::FrontOfQueueDetail
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Batch/Client.html#get_job_queue_snapshot-instance_method
+      def get_job_queue_snapshot: (
+                                    job_queue: ::String
+                                  ) -> _GetJobQueueSnapshotResponseSuccess
+                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetJobQueueSnapshotResponseSuccess
+
       interface _ListJobsResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListJobsResponse]
         def job_summary_list: () -> ::Array[Types::JobSummary]

data/sig/types.rbs

@@ -629,6 +629,28 @@ module Aws::Batch
       SENSITIVE: []
     end
 
+    class FrontOfQueueDetail
+      attr_accessor jobs: ::Array[Types::FrontOfQueueJobSummary]
+      attr_accessor last_updated_at: ::Integer
+      SENSITIVE: []
+    end
+
+    class FrontOfQueueJobSummary
+      attr_accessor job_arn: ::String
+      attr_accessor earliest_time_at_position: ::Integer
+      SENSITIVE: []
+    end
+
+    class GetJobQueueSnapshotRequest
+      attr_accessor job_queue: ::String
+      SENSITIVE: []
+    end
+
+    class GetJobQueueSnapshotResponse
+      attr_accessor front_of_queue: Types::FrontOfQueueDetail
+      SENSITIVE: []
+    end
+
     class Host
       attr_accessor source_path: ::String
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-batch
 version: !ruby/object:Gem::Version
-  version: 1.87.0
+  version: 1.88.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core