BatchGetJobEntity
Get batched job details for a worker.
Request Syntax
POST /2023-10-12/farms/farmId/fleets/fleetId/workers/workerId/batchGetJobEntity HTTP/1.1
Content-type: application/json
{
"identifiers": [
{ ... }
]
}URI Request Parameters
The request uses the following URI parameters.
- farmId
-
The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
Pattern:
farm-[0-9a-f]{32}Required: Yes
- fleetId
-
The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
Pattern:
fleet-[0-9a-f]{32}Required: Yes
- workerId
-
The worker ID of the worker containing the job details to get.
Pattern:
worker-[0-9a-f]{32}Required: Yes
Request Body
The request accepts the following data in JSON format.
- identifiers
-
The job identifiers to include within the job entity batch details.
Type: Array of JobEntityIdentifiersUnion objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"entities": [
{ ... }
],
"errors": [
{ ... }
]
}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.
- entities
-
A list of the job entities, or details, in the batch.
Type: Array of JobEntity objects
Array Members: Minimum number of 0 items. Maximum number of 25 items.
- errors
-
A list of errors from the job error logs for the batch.
Type: Array of GetJobEntityError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
HTTP Status Code: 403
- InternalServerErrorException
-
Deadline Cloud can't process your request right now. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a request rate quota.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
