UpdateSession
Updates a session.
Request Syntax
PATCH /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/sessions/sessionId HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"targetLifecycleStatus": "string"
}URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
The unique token which the server uses to recognize retries of the same request.
Length Constraints: Minimum length of 1. Maximum length of 64.
- farmId
-
The farm ID to update in the session.
Pattern:
farm-[0-9a-f]{32}Required: Yes
- jobId
-
The job ID to update in the session.
Pattern:
job-[0-9a-f]{32}Required: Yes
- queueId
-
The queue ID to update in the session.
Pattern:
queue-[0-9a-f]{32}Required: Yes
- sessionId
-
The session ID to update.
Pattern:
session-[0-9a-f]{32}Required: Yes
Request Body
The request accepts the following data in JSON format.
- targetLifecycleStatus
-
The life cycle status to update in the session.
Type: String
Valid Values:
ENDEDRequired: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
HTTP Status Code: 409
- 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:
