runs

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

Overview

Name	runs
Type	Resource
Id	aws.devicefarm.runs

Fields

The following fields are returned by SELECT queries:

get_run

Name	Datatype	Description
name	string	The run's name.
app_upload	string	An app to upload or that has been uploaded. (pattern: <code>^arn:aws:devicefarm:.+</code>)
arn	string	The run's ARN. (pattern: <code>^arn:aws:devicefarm:.+</code>)
billing_method	string	Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered. If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes. (METERED, UNMETERED)
completed_jobs	integer	The total number of completed jobs.
counters	object	The run's result counters.
created	string (date-time)	When the run was created.
customer_artifact_paths	object	Output CustomerArtifactPaths object for the test run.
device_minutes	object	Represents the total (metered or unmetered) minutes used by the test run.
device_pool_arn	string	The ARN of the device pool for the run. (pattern: <code>^arn:aws:devicefarm:.+</code>)
device_proxy	object	The device proxy configured for the devices in the run.
device_selection_result	object	The results of a device filter used to select the devices for a test run.
environment_variables	array	Environment variables associated with the run.
event_count	integer	For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
execution_role_arn	string	The IAM role associated with the run. (pattern: <code>^arn:aws:iam::[0-9]{12}:role/.+</code>)
insights	object	The insights for the run, including the report status and job-level metrics. This field contains data only if you specified insightsTypes when you scheduled the run.
insights_types	array	The types of insights requested for the run.
job_timeout_minutes	integer	The number of minutes the job executes before it times out.
locale	string	Information about the locale that is used for the run.
location	object	Information about the location that is used for the run.
message	string	A message about the run's result.
network_profile	object	The network profile being used for a test run.
parsing_result_url	string	Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
platform	string	The run's platform. Allowed values include: ANDROID IOS (ANDROID, IOS)
radios	object	Information about the radio states for the run.
result	string	The run's result. Allowed values include: PENDING PASSED WARNED FAILED SKIPPED ERRORED STOPPED (PENDING, PASSED, WARNED, FAILED, SKIPPED, ERRORED, STOPPED)
result_code	string	Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure. (PARSING_FAILED, VPC_ENDPOINT_SETUP_FAILED)
seed	integer	For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
skip_app_resign	boolean	When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again. For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
started	string (date-time)	The run's start time.
status	string	The run'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 run's stop time.
test_spec_arn	string	The ARN of the YAML-formatted test specification for the run. (pattern: <code>^arn:aws:devicefarm:.+</code>)
total_jobs	integer	The total number of jobs for the run.
type_	string	The run's type. Must be one of the following values: 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)
vpc_config	object	The VPC security groups and subnets that are attached to a project.
web_url	string	The Device Farm console URL for the recording of the run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_run	select	region		Gets information about a run.
delete_run	delete	region		Deletes the run, given the run ARN. You cannot delete a run if it is still active. You cannot undo this operation.
list_runs	exec	region, arn		Gets information about runs, given an AWS Device Farm project ARN.

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_run

Gets information about a run.

SELECT
name,
app_upload,
arn,
billing_method,
completed_jobs,
counters,
created,
customer_artifact_paths,
device_minutes,
device_pool_arn,
device_proxy,
device_selection_result,
environment_variables,
event_count,
execution_role_arn,
insights,
insights_types,
job_timeout_minutes,
locale,
location,
message,
network_profile,
parsing_result_url,
platform,
radios,
result,
result_code,
seed,
skip_app_resign,
started,
status,
stopped,
test_spec_arn,
total_jobs,
type_,
vpc_config,
web_url
FROM aws.devicefarm.runs
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_run

Deletes the run, given the run ARN. You cannot delete a run if it is still active. You cannot undo this operation.

DELETE FROM aws.devicefarm.runs
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_runs

Gets information about runs, given an AWS Device Farm project ARN.

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