GetSessionAction
Gets a session action for the job.
Request Syntax
GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/session-actions/sessionActionId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- farmId
-
The farm ID for the session action.
Pattern:
farm-[0-9a-f]{32}Required: Yes
- jobId
-
The job ID for the session.
Pattern:
job-[0-9a-f]{32}Required: Yes
- queueId
-
The queue ID for the session action.
Pattern:
queue-[0-9a-f]{32}Required: Yes
- sessionActionId
-
The session action ID for the session.
Pattern:
sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"definition": { ... },
"endedAt": "string",
"processExitCode": number,
"progressMessage": "string",
"progressPercent": number,
"sessionActionId": "string",
"sessionId": "string",
"startedAt": "string",
"status": "string",
"workerUpdatedAt": "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.
- definition
-
The session action definition.
Type: SessionActionDefinition object
Note: This object is a Union. Only one member of this object can be specified or returned.
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
- processExitCode
-
The exit code to exit the session.
Type: Integer
Valid Range: Minimum value of -2147483648. Maximum value of 2147483647.
- progressMessage
-
The message that communicates the progress of the session action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
- progressPercent
-
The percentage completed for a session action.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 100.
- sessionActionId
-
The session action ID.
Type: String
Pattern:
sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9})) - sessionId
-
The session ID for the session action.
Type: String
Pattern:
session-[0-9a-f]{32} - startedAt
-
The date and time the resource started running.
Type: Timestamp
- status
-
The status of the session action.
Type: String
Valid Values:
ASSIGNED | RUNNING | CANCELING | SUCCEEDED | FAILED | INTERRUPTED | CANCELED | NEVER_ATTEMPTED | SCHEDULED | RECLAIMING | RECLAIMED - workerUpdatedAt
-
The Linux timestamp of the date and time the session action was last updated.
Type: Timestamp
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:
