2021/05/17 - AWS IoT Core Device Advisor - 1 new 2 updated api methods
Changes AWS IoT Core Device Advisor is fully managed test capability for IoT devices. Device manufacturers can use Device Advisor to test their IoT devices for reliable and secure connectivity with AWS IoT.
Stops a Device Advisor test suite run that is currently running.
See also: AWS API Documentation
Request Syntax
client.stop_suite_run(
suiteDefinitionId='string',
suiteRunId='string'
)
string
[REQUIRED]
Suite definition Id of the test suite run to be stopped.
string
[REQUIRED]
Suite run Id of the test suite run to be stopped.
dict
Response Syntax
{}
Response Structure
(dict) --
{'status': {'STOPPED', 'STOPPING'},
'testResult': {'groups': {'tests': {'status': {'STOPPED', 'STOPPING'}}}}}
Gets information about a Device Advisor test suite run.
See also: AWS API Documentation
Request Syntax
client.get_suite_run(
suiteDefinitionId='string',
suiteRunId='string'
)
string
[REQUIRED]
Suite definition Id for the test suite run.
string
[REQUIRED]
Suite run Id for the test suite run.
dict
Response Syntax
{
'suiteDefinitionId': 'string',
'suiteDefinitionVersion': 'string',
'suiteRunId': 'string',
'suiteRunArn': 'string',
'suiteRunConfiguration': {
'primaryDevice': {
'thingArn': 'string',
'certificateArn': 'string'
},
'selectedTestList': [
'string',
]
},
'testResult': {
'groups': [
{
'groupId': 'string',
'groupName': 'string',
'tests': [
{
'testCaseRunId': 'string',
'testCaseDefinitionId': 'string',
'testCaseDefinitionName': 'string',
'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'logUrl': 'string',
'warnings': 'string',
'failure': 'string'
},
]
},
]
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
'errorReason': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
suiteDefinitionId (string) --
Suite definition Id for the test suite run.
suiteDefinitionVersion (string) --
Suite definition version for the test suite run.
suiteRunId (string) --
Suite run Id for the test suite run.
suiteRunArn (string) --
The ARN of the suite run.
suiteRunConfiguration (dict) --
Suite run configuration for the test suite run.
primaryDevice (dict) --
Gets the primary device for suite run.
thingArn (string) --
Lists devices thing arn
certificateArn (string) --
Lists devices certificate arn
selectedTestList (list) --
Gets test case list.
(string) --
testResult (dict) --
Test results for the test suite run.
groups (list) --
Show each group of test results.
(dict) --
Show Group Result.
groupId (string) --
Group result Id.
groupName (string) --
Group Result Name.
tests (list) --
Tests under Group Result.
(dict) --
Provides test case run.
testCaseRunId (string) --
Provides test case run Id.
testCaseDefinitionId (string) --
Provides test case run definition Id.
testCaseDefinitionName (string) --
Provides test case run definition Name.
status (string) --
Provides test case run status.
startTime (datetime) --
Provides test case run start time.
endTime (datetime) --
Provides test case run end time.
logUrl (string) --
Provides test case run log Url.
warnings (string) --
Provides test case run warnings.
failure (string) --
Provides test case run failure result.
startTime (datetime) --
Date (in Unix epoch time) when the test suite run was started.
endTime (datetime) --
Date (in Unix epoch time) when the test suite run ended.
status (string) --
Status for the test suite run.
errorReason (string) --
Error reason for any test suite run failure.
tags (dict) --
The tags attached to the suite run.
(string) --
(string) --
{'suiteRunsList': {'status': {'STOPPED', 'STOPPING'}}}
Lists the 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.
See also: AWS API Documentation
Request Syntax
client.list_suite_runs(
suiteDefinitionId='string',
suiteDefinitionVersion='string',
maxResults=123,
nextToken='string'
)
string
Lists the test suite runs of the specified test suite based on suite definition Id.
string
Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.
integer
The maximum number of results to return at once.
string
A token to retrieve the next set of results.
dict
Response Syntax
{
'suiteRunsList': [
{
'suiteDefinitionId': 'string',
'suiteDefinitionVersion': 'string',
'suiteDefinitionName': 'string',
'suiteRunId': 'string',
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'endAt': datetime(2015, 1, 1),
'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
'passed': 123,
'failed': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
suiteRunsList (list) --
An array of objects that provide summaries of information about the suite runs in the list.
(dict) --
Information about the suite run.
suiteDefinitionId (string) --
Suite definition Id of the suite run.
suiteDefinitionVersion (string) --
Suite definition version of the suite run.
suiteDefinitionName (string) --
Suite definition name of the suite run.
suiteRunId (string) --
Suite run Id of the suite run.
createdAt (datetime) --
Date (in Unix epoch time) when the suite run was created.
startedAt (datetime) --
Date (in Unix epoch time) when the suite run was started.
endAt (datetime) --
Date (in Unix epoch time) when the suite run ended.
status (string) --
Status of the suite run.
passed (integer) --
Number of test cases that passed in the suite run.
failed (integer) --
Number of test cases that failed in the suite run.
nextToken (string) --
A token to retrieve the next set of results.