DeadlineCloud / Client / update_session

update_session

DeadlineCloud.Client.update_session(**kwargs)

Updates a session.

See also: AWS API Documentation

Request Syntax

response = client.update_session(
    clientToken='string',
    farmId='string',
    queueId='string',
    jobId='string',
    sessionId='string',
    targetLifecycleStatus='ENDED'
)

Parameters:

• clientToken (string) –

  The unique token which the server uses to recognize retries of the same request.

  This field is autopopulated if not provided.

• farmId (string) –

  [REQUIRED]

  The farm ID to update in the session.

• queueId (string) –

  [REQUIRED]

  The queue ID to update in the session.

• jobId (string) –

  [REQUIRED]

  The job ID to update in the session.

• sessionId (string) –

  [REQUIRED]

  The session ID to update.

• targetLifecycleStatus (string) –

  [REQUIRED]

  The life cycle status to update in the session.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ConflictException

• DeadlineCloud.Client.exceptions.ValidationException