GetSession
Gets a session.
Request Syntax
GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/sessions/sessionId 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
- jobId
-
The job ID for the session.
Pattern:
job-[0-9a-f]{32}Required: Yes
- queueId
-
The queue ID for the session.
Pattern:
queue-[0-9a-f]{32}Required: Yes
- sessionId
-
The session ID.
Pattern:
session-[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
{
"endedAt": "string",
"fleetId": "string",
"hostProperties": {
"ec2InstanceArn": "string",
"ec2InstanceType": "string",
"hostName": "string",
"ipAddresses": {
"ipV4Addresses": [ "string" ],
"ipV6Addresses": [ "string" ]
}
},
"lifecycleStatus": "string",
"log": {
"error": "string",
"logDriver": "string",
"options": {
"string" : "string"
},
"parameters": {
"string" : "string"
}
},
"sessionId": "string",
"startedAt": "string",
"targetLifecycleStatus": "string",
"updatedAt": "string",
"updatedBy": "string",
"workerId": "string",
"workerLog": {
"error": "string",
"logDriver": "string",
"options": {
"string" : "string"
},
"parameters": {
"string" : "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.
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
- fleetId
-
The fleet ID for the session.
Type: String
Pattern:
fleet-[0-9a-f]{32} - hostProperties
-
Provides the Amazon EC2 properties of the host.
Type: HostPropertiesResponse object
- lifecycleStatus
-
The life cycle status of the session.
Type: String
Valid Values:
STARTED | UPDATE_IN_PROGRESS | UPDATE_SUCCEEDED | UPDATE_FAILED | ENDED - log
-
The session log.
Type: LogConfiguration object
- sessionId
-
The session ID.
Type: String
Pattern:
session-[0-9a-f]{32} - startedAt
-
The date and time the resource started running.
Type: Timestamp
- targetLifecycleStatus
-
The life cycle status with which the session started.
Type: String
Valid Values:
ENDED - updatedAt
-
The date and time the resource was updated.
Type: Timestamp
- updatedBy
-
The user or system that updated this resource.
Type: String
- workerId
-
The worker ID for the session.
Type: String
Pattern:
worker-[0-9a-f]{32} - workerLog
-
The worker log for the session.
Type: LogConfiguration object
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:
