ListSessionsForWorker
Lists sessions for a worker.
Request Syntax
GET /2023-10-12/farms/farmId
/fleets/fleetId
/workers/workerId
/sessions?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- farmId
-
The farm ID for the session.
Pattern:
farm-[0-9a-f]{32}
Required: Yes
- fleetId
-
The fleet ID for the session.
Pattern:
fleet-[0-9a-f]{32}
Required: Yes
- maxResults
-
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The token for the next set of results, or
null
to start from the beginning. - workerId
-
The worker ID for the session.
Pattern:
worker-[0-9a-f]{32}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"sessions": [
{
"endedAt": "string",
"jobId": "string",
"lifecycleStatus": "string",
"queueId": "string",
"sessionId": "string",
"startedAt": "string",
"targetLifecycleStatus": "string"
}
]
}
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.
- nextToken
-
The token for the next set of results, or
null
to start from the beginning.Type: String
- sessions
-
The sessions in the response.
Type: Array of WorkerSessionSummary 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: