Skip to content

Commit 9916698

Browse files
author
AWS
committed
AWS Batch Update: This release adds support for the AWS Batch GetJobQueueSnapshot API operation.
1 parent eda3c6a commit 9916698

File tree

2 files changed

+73
-1
lines changed

2 files changed

+73
-1
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Batch",
4+
"contributor": "",
5+
"description": "This release adds support for the AWS Batch GetJobQueueSnapshot API operation."
6+
}

services/batch/src/main/resources/codegen-resources/service-2.json

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"endpointPrefix":"batch",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceAbbreviation":"AWS Batch",
910
"serviceFullName":"AWS Batch",
1011
"serviceId":"Batch",
@@ -194,6 +195,20 @@
194195
],
195196
"documentation":"<p>Describes one or more of your scheduling policies.</p>"
196197
},
198+
"GetJobQueueSnapshot":{
199+
"name":"GetJobQueueSnapshot",
200+
"http":{
201+
"method":"POST",
202+
"requestUri":"/v1/getjobqueuesnapshot"
203+
},
204+
"input":{"shape":"GetJobQueueSnapshotRequest"},
205+
"output":{"shape":"GetJobQueueSnapshotResponse"},
206+
"errors":[
207+
{"shape":"ClientException"},
208+
{"shape":"ServerException"}
209+
],
210+
"documentation":"<p>Provides a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>"
211+
},
197212
"ListJobs":{
198213
"name":"ListJobs",
199214
"http":{
@@ -2318,6 +2333,57 @@
23182333
"documentation":"<p>The platform configuration for jobs that are running on Fargate resources. Jobs that run on Amazon EC2 resources must not specify this parameter.</p>"
23192334
},
23202335
"Float":{"type":"float"},
2336+
"FrontOfQueueDetail":{
2337+
"type":"structure",
2338+
"members":{
2339+
"jobs":{
2340+
"shape":"FrontOfQueueJobSummaryList",
2341+
"documentation":"<p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> 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.</p>"
2342+
},
2343+
"lastUpdatedAt":{
2344+
"shape":"Long",
2345+
"documentation":"<p>The Unix timestamp (in milliseconds) for when each of the first 100 <code>RUNNABLE</code> jobs were last updated. </p>"
2346+
}
2347+
},
2348+
"documentation":"<p>Contains a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>"
2349+
},
2350+
"FrontOfQueueJobSummary":{
2351+
"type":"structure",
2352+
"members":{
2353+
"jobArn":{
2354+
"shape":"String",
2355+
"documentation":"<p>The ARN for a job in a named job queue.</p>"
2356+
},
2357+
"earliestTimeAtPosition":{
2358+
"shape":"Long",
2359+
"documentation":"<p>The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.</p>"
2360+
}
2361+
},
2362+
"documentation":"<p>An object that represents summary details for the first 100 <code>RUNNABLE</code> jobs in a job queue.</p>"
2363+
},
2364+
"FrontOfQueueJobSummaryList":{
2365+
"type":"list",
2366+
"member":{"shape":"FrontOfQueueJobSummary"}
2367+
},
2368+
"GetJobQueueSnapshotRequest":{
2369+
"type":"structure",
2370+
"required":["jobQueue"],
2371+
"members":{
2372+
"jobQueue":{
2373+
"shape":"String",
2374+
"documentation":"<p>The job queue’s name or full queue Amazon Resource Name (ARN).</p>"
2375+
}
2376+
}
2377+
},
2378+
"GetJobQueueSnapshotResponse":{
2379+
"type":"structure",
2380+
"members":{
2381+
"frontOfQueue":{
2382+
"shape":"FrontOfQueueDetail",
2383+
"documentation":"<p>The list of the first 100 <code>RUNNABLE</code> 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.</p>"
2384+
}
2385+
}
2386+
},
23212387
"Host":{
23222388
"type":"structure",
23232389
"members":{
@@ -2923,7 +2989,7 @@
29232989
},
29242990
"maxResults":{
29252991
"shape":"Integer",
2926-
"documentation":"<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
2992+
"documentation":"<p>The maximum number of results returned by <code>ListJobs</code> in a paginated output. When this parameter is used, <code>ListJobs</code> returns up to <code>maxResults</code> results in a single page and a <code>nextToken</code> response element, if applicable. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value.</p> <p>The following outlines key parameters and limitations:</p> <ul> <li> <p>The minimum value is 1. </p> </li> <li> <p>When <code>--job-status</code> is used, Batch returns up to 1000 values. </p> </li> <li> <p>When <code>--filters</code> is used, Batch returns up to 100 values.</p> </li> <li> <p>If neither parameter is used, then <code>ListJobs</code> returns up to 1000 results (jobs that are in the <code>RUNNING</code> status) and a <code>nextToken</code> value, if applicable.</p> </li> </ul>"
29272993
},
29282994
"nextToken":{
29292995
"shape":"String",

0 commit comments

Comments
 (0)