suite_runs

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

Overview

Name	suite_runs
Type	Resource
Id	aws.iotdeviceadvisor.suite_runs

Fields

The following fields are returned by SELECT queries:

get_suite_run

Name	Datatype	Description
end_time	string (date-time)	Date (in Unix epoch time) when the test suite run ended.
error_reason	string	Error reason for any test suite run failure.
start_time	string (date-time)	Date (in Unix epoch time) when the test suite run started.
status	string	Status for the test suite run. (PASS, FAIL, CANCELED, PENDING, RUNNING, STOPPING, STOPPED, PASS_WITH_WARNINGS, ERROR)
suite_definition_id	string	Suite definition ID for the test suite run.
suite_definition_version	string	Suite definition version for the test suite run.
suite_run_arn	string	The ARN of the suite run.
suite_run_configuration	object	Suite run configuration for the test suite run.
suite_run_id	string	Suite run ID for the test suite run.
tags	object	The tags attached to the suite run.
test_result	object	Test results for the test suite run.

list_suite_runs

Name	Datatype	Description
next_token	string	A token to retrieve the next set of results.
suite_runs_list	array	An array of objects that provide summaries of information about the suite runs in the list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_suite_run	select	suite_definition_id, suite_run_id, region		Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.
list_suite_runs	select	region	suiteDefinitionId, suiteDefinitionVersion, maxResults, nextToken	Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite. Requires permission to access the ListSuiteRuns action.

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)
suite_definition_id	string	Suite definition ID for the test suite run.
suite_run_id	string	Suite run ID for the test suite run.
maxResults	integer	The maximum number of results to return at once.
nextToken	string	A token to retrieve the next set of results.
suiteDefinitionId	string	Lists the test suite runs of the specified test suite based on suite definition ID.
suiteDefinitionVersion	string	Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

SELECT examples

get_suite_run

Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.

SELECT
end_time,
error_reason,
start_time,
status,
suite_definition_id,
suite_definition_version,
suite_run_arn,
suite_run_configuration,
suite_run_id,
tags,
test_result
FROM aws.iotdeviceadvisor.suite_runs
WHERE suite_definition_id = '{{ suite_definition_id }}' -- required
AND suite_run_id = '{{ suite_run_id }}' -- required
AND region = '{{ region }}' -- required
;

list_suite_runs

Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite. Requires permission to access the ListSuiteRuns action.

SELECT
next_token,
suite_runs_list
FROM aws.iotdeviceadvisor.suite_runs
WHERE region = '{{ region }}' -- required
AND suiteDefinitionId = '{{ suiteDefinitionId }}'
AND suiteDefinitionVersion = '{{ suiteDefinitionVersion }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;