session_actions

Creates, updates, deletes, gets or lists a session_actions resource.

Overview

Name	session_actions
Type	Resource
Id	aws.deadline.session_actions

Fields

The following fields are returned by SELECT queries:

get_session_action

Name	Datatype	Description
acquired_limits	array	The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.
definition	object	The session action definition.
ended_at	string (date-time)	The date and time the resource ended running.
manifests	array	The list of manifest properties that describe file attachments for the task run.
process_exit_code	integer	The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
progress_message	string	The message that communicates the progress of the session action.
progress_percent	number (float)	The percentage completed for a session action.
session_action_id	string	The session action ID. (pattern: <code>sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))</code>)
session_id	string	The session ID for the session action. (pattern: <code>session-[0-9a-f]{32}</code>)
started_at	string (date-time)	The date and time the resource started running.
status	string	The status of the session action. (ASSIGNED, RUNNING, CANCELING, SUCCEEDED, FAILED, INTERRUPTED, CANCELED, NEVER_ATTEMPTED, SCHEDULED, RECLAIMING, RECLAIMED)
worker_updated_at	string (date-time)	The Linux timestamp of the date and time the session action was last updated.

list_session_actions

Name	Datatype	Description
definition	object	The session action definition.
ended_at	string (date-time)	The date and time the resource ended running.
manifests	array	The list of manifest properties that describe file attachments for the task run.
progress_percent	number (float)	The completion percentage for the session action.
session_action_id	string	The session action ID. (pattern: <code>sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))</code>)
started_at	string (date-time)	The date and time the resource started running.
status	string	The status of the session action. (ASSIGNED, RUNNING, CANCELING, SUCCEEDED, FAILED, INTERRUPTED, CANCELED, NEVER_ATTEMPTED, SCHEDULED, RECLAIMING, RECLAIMED)
worker_updated_at	string (date-time)	The Linux timestamp of the last date and time that the session action was updated.

batch_get_session_action

Name	Datatype	Description
errors	array	A list of errors for session actions that could not be retrieved.
session_actions	array	A list of session actions that were successfully retrieved.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_session_action	select	farm_id, queue_id, job_id, session_action_id, region		Gets a session action for the job.
list_session_actions	select	farm_id, queue_id, job_id, region	nextToken, maxResults, sessionId, taskId	Lists session actions.
batch_get_session_action	select	region		Retrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API. The result of getting each session action is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
farm_id	string	The farm ID for the session actions list.
job_id	string	The job ID for the session actions list.
queue_id	string	The queue ID for the session actions list.
region	string	AWS region (default: us-east-1)
session_action_id	string	The session action ID for the session.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.
sessionId	string	The session ID to include on the sessions action list.
taskId	string	The task ID for the session actions list.

SELECT examples

get_session_action

Gets a session action for the job.

SELECT
acquired_limits,
definition,
ended_at,
manifests,
process_exit_code,
progress_message,
progress_percent,
session_action_id,
session_id,
started_at,
status,
worker_updated_at
FROM aws.deadline.session_actions
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND session_action_id = '{{ session_action_id }}' -- required
AND region = '{{ region }}' -- required
;

list_session_actions

Lists session actions.

SELECT
definition,
ended_at,
manifests,
progress_percent,
session_action_id,
started_at,
status,
worker_updated_at
FROM aws.deadline.session_actions
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND sessionId = '{{ sessionId }}'
AND taskId = '{{ taskId }}'
;

batch_get_session_action

Retrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API. The result of getting each session action is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

SELECT
errors,
session_actions
FROM aws.deadline.session_actions
WHERE region = '{{ region }}' -- required
;