suites

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

Overview

Name	suites
Type	Resource
Id	aws.devicefarm.suites

Fields

The following fields are returned by SELECT queries:

get_suite

Name	Datatype	Description
name	string	The suite's name.
arn	string	The suite's ARN. (pattern: <code>^arn:aws:devicefarm:.+</code>)
counters	object	The suite's result counters.
created	string (date-time)	When the suite was created.
device_minutes	object	Represents the total (metered or unmetered) minutes used by the test suite.
message	string	A message about the suite's result.
result	string	The suite's result. Allowed values include: PENDING PASSED WARNED FAILED SKIPPED ERRORED STOPPED (PENDING, PASSED, WARNED, FAILED, SKIPPED, ERRORED, STOPPED)
started	string (date-time)	The suite's start time.
status	string	The suite'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 suite's stop time.
type_	string	The suite'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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_suite	select	region		Gets information about a suite.
list_suites	exec	region, arn		Gets information about test suites for a given job.

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_suite

Gets information about a suite.

SELECT
name,
arn,
counters,
created,
device_minutes,
message,
result,
started,
status,
stopped,
type_
FROM aws.devicefarm.suites
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

list_suites

Gets information about test suites for a given job.

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