sessions_for_workers

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

Overview

Name	sessions_for_workers
Type	Resource
Id	aws.deadline.sessions_for_workers

Fields

The following fields are returned by SELECT queries:

list_sessions_for_worker

Name	Datatype	Description
ended_at	string (date-time)	The date and time the resource ended running.
job_id	string	The job ID for the job associated with the worker's session. (pattern: <code>job-[0-9a-f]{32}</code>)
lifecycle_status	string	The life cycle status for the worker's session. (STARTED, UPDATE_IN_PROGRESS, UPDATE_SUCCEEDED, UPDATE_FAILED, ENDED)
queue_id	string	The queue ID for the queue associated to the worker. (pattern: <code>queue-[0-9a-f]{32}</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.
target_lifecycle_status	string	The life cycle status (ENDED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_sessions_for_worker	select	farm_id, fleet_id, worker_id, region	nextToken, maxResults	Lists sessions for a worker.

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.
fleet_id	string	The fleet ID for the session.
region	string	AWS region (default: us-east-1)
worker_id	string	The worker 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.

SELECT examples

list_sessions_for_worker

Lists sessions for a worker.

SELECT
ended_at,
job_id,
lifecycle_status,
queue_id,
session_id,
started_at,
target_lifecycle_status
FROM aws.deadline.sessions_for_workers
WHERE farm_id = '{{ farm_id }}' -- required
AND fleet_id = '{{ fleet_id }}' -- required
AND worker_id = '{{ worker_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;