GetJobQueueSnapshot
Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.
Request Syntax
POST /v1/getjobqueuesnapshot HTTP/1.1
Content-type: application/json
{
"jobQueue": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- jobQueue
-
The job queue’s name or full queue Amazon Resource Name (ARN).
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"frontOfQueue": {
"jobs": [
{
"earliestTimeAtPosition": number,
"jobArn": "string"
}
],
"lastUpdatedAt": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- frontOfQueue
-
The list of the first 100
RUNNABLEjobs 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.Type: FrontOfQueueDetail object
Errors
- ClientException
-
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
