jobs

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

Overview

Name	jobs
Type	Resource
Id	aws.devicefarm.jobs

Fields

The following fields are returned by SELECT queries:

get_job

Name	Datatype	Description
name	string	The job's name.
arn	string	The job's ARN. (pattern: <code>^arn:aws:devicefarm:.+</code>)
counters	object	The job's result counters.
created	string (date-time)	When the job was created.
device	object	The device (phone or tablet).
device_minutes	object	Represents the total (metered or unmetered) minutes used by the job.
insights	object	The insights for the job, including the report status and test-level metrics. This field contains data only if you specified insightsTypes when you scheduled the run.
instance_arn	string	The ARN of the instance. (pattern: <code>^arn:aws:devicefarm:.+</code>)
message	string	A message about the job's result.
result	string	The job's result. Allowed values include: PENDING PASSED WARNED FAILED SKIPPED ERRORED STOPPED (PENDING, PASSED, WARNED, FAILED, SKIPPED, ERRORED, STOPPED)
started	string (date-time)	The job's start time.
status	string	The job's status. Allowed values include: PENDING PENDING_CONCURRENCY PENDING_DEVICE PROCESSING SCHEDULING PREPARING RUNNING COMPLETED STOPPING (PENDING, PENDING_CONCURRENCY, PENDING_DEVICE, PROCESSING, SCHEDULING, PREPARING, RUNNING, COMPLETED, STOPPING)
stopped	string (date-time)	The job's stop time.
type_	string	The job's type. Allowed values include the following: BUILTIN_FUZZ APPIUM_JAVA_JUNIT APPIUM_JAVA_TESTNG APPIUM_PYTHON APPIUM_NODE APPIUM_RUBY APPIUM_WEB_JAVA_JUNIT APPIUM_WEB_JAVA_TESTNG APPIUM_WEB_PYTHON APPIUM_WEB_NODE APPIUM_WEB_RUBY INSTRUMENTATION XCTEST XCTEST_UI (BUILTIN_FUZZ, APPIUM_JAVA_JUNIT, APPIUM_JAVA_TESTNG, APPIUM_PYTHON, APPIUM_NODE, APPIUM_RUBY, APPIUM_WEB_JAVA_JUNIT, APPIUM_WEB_JAVA_TESTNG, APPIUM_WEB_PYTHON, APPIUM_WEB_NODE, APPIUM_WEB_RUBY, INSTRUMENTATION, XCTEST, XCTEST_UI)
video_capture	boolean	This value is set to true if video capture is enabled. Otherwise, it is set to false.
video_endpoint	string	The endpoint for streaming device video.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job	select	region		Gets information about a job.
list_jobs	exec	region, arn		Gets information about jobs for a given test run.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_job

Gets information about a job.

SELECT
name,
arn,
counters,
created,
device,
device_minutes,
insights,
instance_arn,
message,
result,
started,
status,
stopped,
type_,
video_capture,
video_endpoint
FROM aws.devicefarm.jobs
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

list_jobs

Gets information about jobs for a given test run.

EXEC aws.devicefarm.jobs.list_jobs 
@region='{{ region }}' --required 
@@json=
'{
"arn": "{{ arn }}", 
"nextToken": "{{ nextToken }}"
}'
;