Table of Contents
IoTDeviceAdvisor.Client¶A low-level client representing AWS IoT Core Device Advisor (oTDeviceAdvisor)
Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the Amazon Web Services Partner Network to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in and wait for it to be tested.
import boto3
client = boto3.client('iotdeviceadvisor')
These are the available methods:
can_paginate()close()create_suite_definition()delete_suite_definition()get_endpoint()get_paginator()get_suite_definition()get_suite_run()get_suite_run_report()get_waiter()list_suite_definitions()list_suite_runs()list_tags_for_resource()start_suite_run()stop_suite_run()tag_resource()untag_resource()update_suite_definition()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_suite_definition(**kwargs)¶Creates a Device Advisor test suite.
Requires permission to access the CreateSuiteDefinition action.
See also: AWS API Documentation
Request Syntax
response = client.create_suite_definition(
suiteDefinitionConfiguration={
'suiteDefinitionName': 'string',
'devices': [
{
'thingArn': 'string',
'certificateArn': 'string'
},
],
'intendedForQualification': True|False,
'isLongDurationTest': True|False,
'rootGroup': 'string',
'devicePermissionRoleArn': 'string',
'protocol': 'MqttV3_1_1'|'MqttV5'
},
tags={
'string': 'string'
}
)
[REQUIRED]
Creates a Device Advisor test suite with suite definition configuration.
Gets the suite definition name. This is a required parameter.
Gets the devices configured.
Information of a test device. A thing ARN or a certificate ARN is required.
Lists devices thing ARN.
Lists devices certificate ARN.
Gets the tests intended for qualification in a suite.
Verifies if the test suite is a long duration test.
Gets the test suite root group. This is a required parameter.
Gets the device permission ARN. This is a required parameter.
Sets the MQTT protocol that is configured in the suite definition.
The tags to be attached to the suite definition.
dict
Response Syntax
{
'suiteDefinitionId': 'string',
'suiteDefinitionArn': 'string',
'suiteDefinitionName': 'string',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
suiteDefinitionId (string) --
The UUID of the test suite created.
suiteDefinitionArn (string) --
The Amazon Resource Name (ARN) of the test suite.
suiteDefinitionName (string) --
The suite definition name of the test suite. This is a required parameter.
createdAt (datetime) --
The timestamp of when the test suite was created.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptiondelete_suite_definition(**kwargs)¶Deletes a Device Advisor test suite.
Requires permission to access the DeleteSuiteDefinition action.
See also: AWS API Documentation
Request Syntax
response = client.delete_suite_definition(
suiteDefinitionId='string'
)
[REQUIRED]
Suite definition ID of the test suite to be deleted.
{}
Response Structure
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionget_endpoint(**kwargs)¶Gets information about an Device Advisor endpoint.
See also: AWS API Documentation
Request Syntax
response = client.get_endpoint(
thingArn='string',
certificateArn='string'
)
dict
Response Syntax
{
'endpoint': 'string'
}
Response Structure
(dict) --
endpoint (string) --
The response of an Device Advisor endpoint.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_suite_definition(**kwargs)¶Gets information about a Device Advisor test suite.
Requires permission to access the GetSuiteDefinition action.
See also: AWS API Documentation
Request Syntax
response = client.get_suite_definition(
suiteDefinitionId='string',
suiteDefinitionVersion='string'
)
[REQUIRED]
Suite definition ID of the test suite to get.
dict
Response Syntax
{
'suiteDefinitionId': 'string',
'suiteDefinitionArn': 'string',
'suiteDefinitionVersion': 'string',
'latestVersion': 'string',
'suiteDefinitionConfiguration': {
'suiteDefinitionName': 'string',
'devices': [
{
'thingArn': 'string',
'certificateArn': 'string'
},
],
'intendedForQualification': True|False,
'isLongDurationTest': True|False,
'rootGroup': 'string',
'devicePermissionRoleArn': 'string',
'protocol': 'MqttV3_1_1'|'MqttV5'
},
'createdAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
suiteDefinitionId (string) --
Suite definition ID of the suite definition.
suiteDefinitionArn (string) --
The ARN of the suite definition.
suiteDefinitionVersion (string) --
Suite definition version of the suite definition.
latestVersion (string) --
Latest suite definition version of the suite definition.
suiteDefinitionConfiguration (dict) --
Suite configuration of the suite definition.
suiteDefinitionName (string) --
Gets the suite definition name. This is a required parameter.
devices (list) --
Gets the devices configured.
(dict) --
Information of a test device. A thing ARN or a certificate ARN is required.
thingArn (string) --
Lists devices thing ARN.
certificateArn (string) --
Lists devices certificate ARN.
intendedForQualification (boolean) --
Gets the tests intended for qualification in a suite.
isLongDurationTest (boolean) --
Verifies if the test suite is a long duration test.
rootGroup (string) --
Gets the test suite root group. This is a required parameter.
devicePermissionRoleArn (string) --
Gets the device permission ARN. This is a required parameter.
protocol (string) --
Sets the MQTT protocol that is configured in the suite definition.
createdAt (datetime) --
Date (in Unix epoch time) when the suite definition was created.
lastModifiedAt (datetime) --
Date (in Unix epoch time) when the suite definition was last modified.
tags (dict) --
Tags attached to the suite definition.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionget_suite_run(**kwargs)¶Gets information about a Device Advisor test suite run.
Requires permission to access the GetSuiteRun action.
See also: AWS API Documentation
Request Syntax
response = client.get_suite_run(
suiteDefinitionId='string',
suiteRunId='string'
)
[REQUIRED]
Suite definition ID for the test suite run.
[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',
],
'parallelRun': True|False
},
'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',
'testScenarios': [
{
'testCaseScenarioId': 'string',
'testCaseScenarioType': 'Advanced'|'Basic',
'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
'failure': 'string',
'systemMessage': '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) --
Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.
thingArn (string) --
Lists devices thing ARN.
certificateArn (string) --
Lists devices certificate ARN.
selectedTestList (list) --
Sets test case list.
parallelRun (boolean) --
TRUE if multiple test suites run in parallel.
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 the test case run.
testCaseRunId (string) --
Provides the test case run ID.
testCaseDefinitionId (string) --
Provides the test case run definition ID.
testCaseDefinitionName (string) --
Provides the test case run definition name.
status (string) --
Provides the test case run status. Status is one of the following:
PASS : Test passed.FAIL : Test failed.PENDING : Test has not started running but is scheduled.RUNNING : Test is running.STOPPING : Test is performing cleanup steps. You will see this status only if you stop a suite run.STOPPED Test is stopped. You will see this status only if you stop a suite run.PASS_WITH_WARNINGS : Test passed with warnings.ERORR : Test faced an error when running due to an internal issue.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.
testScenarios (list) --
Provides the test scenarios for the test case run.
(dict) --
Provides test case scenario.
testCaseScenarioId (string) --
Provides test case scenario ID.
testCaseScenarioType (string) --
Provides test case scenario type. Type is one of the following:
status (string) --
Provides the test case scenario status. Status is one of the following:
PASS : Test passed.FAIL : Test failed.PENDING : Test has not started running but is scheduled.RUNNING : Test is running.STOPPING : Test is performing cleanup steps. You will see this status only if you stop a suite run.STOPPED Test is stopped. You will see this status only if you stop a suite run.PASS_WITH_WARNINGS : Test passed with warnings.ERORR : Test faced an error when running due to an internal issue.failure (string) --
Provides test case scenario failure result.
systemMessage (string) --
startTime (datetime) --
Date (in Unix epoch time) when the test suite run 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.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionget_suite_run_report(**kwargs)¶Gets a report download link for a successful Device Advisor qualifying test suite run.
Requires permission to access the GetSuiteRunReport action.
See also: AWS API Documentation
Request Syntax
response = client.get_suite_run_report(
suiteDefinitionId='string',
suiteRunId='string'
)
[REQUIRED]
Suite definition ID of the test suite.
[REQUIRED]
Suite run ID of the test suite run.
dict
Response Syntax
{
'qualificationReportDownloadUrl': 'string'
}
Response Structure
(dict) --
qualificationReportDownloadUrl (string) --
Download URL of the qualification report.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_suite_definitions(**kwargs)¶Lists the Device Advisor test suites you have created.
Requires permission to access the ListSuiteDefinitions action.
See also: AWS API Documentation
Request Syntax
response = client.list_suite_definitions(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'suiteDefinitionInformationList': [
{
'suiteDefinitionId': 'string',
'suiteDefinitionName': 'string',
'defaultDevices': [
{
'thingArn': 'string',
'certificateArn': 'string'
},
],
'intendedForQualification': True|False,
'isLongDurationTest': True|False,
'protocol': 'MqttV3_1_1'|'MqttV5',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
suiteDefinitionInformationList (list) --
An array of objects that provide summaries of information about the suite definitions in the list.
(dict) --
Information about the suite definition.
suiteDefinitionId (string) --
Suite definition ID of the test suite.
suiteDefinitionName (string) --
Suite name of the test suite.
defaultDevices (list) --
Specifies the devices that are under test for the test suite.
(dict) --
Information of a test device. A thing ARN or a certificate ARN is required.
thingArn (string) --
Lists devices thing ARN.
certificateArn (string) --
Lists devices certificate ARN.
intendedForQualification (boolean) --
Specifies if the test suite is intended for qualification.
isLongDurationTest (boolean) --
Verifies if the test suite is a long duration test.
protocol (string) --
Gets the MQTT protocol that is configured in the suite definition.
createdAt (datetime) --
Date (in Unix epoch time) when the test suite was created.
nextToken (string) --
A token used to get the next set of results.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionlist_suite_runs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_suite_runs(
suiteDefinitionId='string',
suiteDefinitionVersion='string',
maxResults=123,
nextToken='string'
)
suiteDefinitionId . Lists the test suite runs of the specified test suite based on suite definition version.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.
Requires permission to access the SuiteRunInformation action.
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.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionLists the tags attached to an IoT Device Advisor resource.
Requires permission to access the ListTagsForResource action.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags attached to the IoT Device Advisor resource.
Exceptions
IoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionstart_suite_run(**kwargs)¶Starts a Device Advisor test suite run.
Requires permission to access the StartSuiteRun action.
See also: AWS API Documentation
Request Syntax
response = client.start_suite_run(
suiteDefinitionId='string',
suiteDefinitionVersion='string',
suiteRunConfiguration={
'primaryDevice': {
'thingArn': 'string',
'certificateArn': 'string'
},
'selectedTestList': [
'string',
],
'parallelRun': True|False
},
tags={
'string': 'string'
}
)
[REQUIRED]
Suite definition ID of the test suite.
[REQUIRED]
Suite run configuration.
Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.
Lists devices thing ARN.
Lists devices certificate ARN.
Sets test case list.
TRUE if multiple test suites run in parallel.
The tags to be attached to the suite run.
dict
Response Syntax
{
'suiteRunId': 'string',
'suiteRunArn': 'string',
'createdAt': datetime(2015, 1, 1),
'endpoint': 'string'
}
Response Structure
(dict) --
suiteRunId (string) --
Suite Run ID of the started suite run.
suiteRunArn (string) --
Amazon Resource Name (ARN) of the started suite run.
createdAt (datetime) --
Starts a Device Advisor test suite run based on suite create time.
endpoint (string) --
The response of an Device Advisor test endpoint.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ConflictExceptionstop_suite_run(**kwargs)¶Stops a Device Advisor test suite run that is currently running.
Requires permission to access the StopSuiteRun action.
See also: AWS API Documentation
Request Syntax
response = client.stop_suite_run(
suiteDefinitionId='string',
suiteRunId='string'
)
[REQUIRED]
Suite definition ID of the test suite run to be stopped.
[REQUIRED]
Suite run ID of the test suite run to be stopped.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Adds to and modifies existing tags of an IoT Device Advisor resource.
Requires permission to access the TagResource action.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.
[REQUIRED]
The tags to be attached to the IoT Device Advisor resource.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes tags from an IoT Device Advisor resource.
Requires permission to access the UntagResource action.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.
[REQUIRED]
List of tag keys to remove from the IoT Device Advisor resource.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTDeviceAdvisor.Client.exceptions.InternalServerExceptionIoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.ResourceNotFoundExceptionupdate_suite_definition(**kwargs)¶Updates a Device Advisor test suite.
Requires permission to access the UpdateSuiteDefinition action.
See also: AWS API Documentation
Request Syntax
response = client.update_suite_definition(
suiteDefinitionId='string',
suiteDefinitionConfiguration={
'suiteDefinitionName': 'string',
'devices': [
{
'thingArn': 'string',
'certificateArn': 'string'
},
],
'intendedForQualification': True|False,
'isLongDurationTest': True|False,
'rootGroup': 'string',
'devicePermissionRoleArn': 'string',
'protocol': 'MqttV3_1_1'|'MqttV5'
}
)
[REQUIRED]
Suite definition ID of the test suite to be updated.
[REQUIRED]
Updates a Device Advisor test suite with suite definition configuration.
Gets the suite definition name. This is a required parameter.
Gets the devices configured.
Information of a test device. A thing ARN or a certificate ARN is required.
Lists devices thing ARN.
Lists devices certificate ARN.
Gets the tests intended for qualification in a suite.
Verifies if the test suite is a long duration test.
Gets the test suite root group. This is a required parameter.
Gets the device permission ARN. This is a required parameter.
Sets the MQTT protocol that is configured in the suite definition.
dict
Response Syntax
{
'suiteDefinitionId': 'string',
'suiteDefinitionArn': 'string',
'suiteDefinitionName': 'string',
'suiteDefinitionVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
suiteDefinitionId (string) --
Suite definition ID of the updated test suite.
suiteDefinitionArn (string) --
Amazon Resource Name (ARN) of the updated test suite.
suiteDefinitionName (string) --
Updates the suite definition name. This is a required parameter.
suiteDefinitionVersion (string) --
Suite definition version of the updated test suite.
createdAt (datetime) --
Timestamp of when the test suite was created.
lastUpdatedAt (datetime) --
Timestamp of when the test suite was updated.
Exceptions
IoTDeviceAdvisor.Client.exceptions.ValidationExceptionIoTDeviceAdvisor.Client.exceptions.InternalServerExceptionThe available paginators are: