View Source AWS.IotDeviceAdvisor (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

create_suite_definition(client, input, options \\ [])

Creates a Device Advisor test suite.

delete_suite_definition(client, suite_definition_id, input, options \\ [])

Deletes a Device Advisor test suite.

get_endpoint(client, authentication_method \\ nil, certificate_arn \\ nil, device_role_arn \\ nil, thing_arn \\ nil, options \\ [])

Gets information about an Device Advisor endpoint.

get_suite_definition(client, suite_definition_id, suite_definition_version \\ nil, options \\ [])

Gets information about a Device Advisor test suite.

get_suite_run(client, suite_definition_id, suite_run_id, options \\ [])

Gets information about a Device Advisor test suite run.

get_suite_run_report(client, suite_definition_id, suite_run_id, options \\ [])

Gets a report download link for a successful Device Advisor qualifying test suite run.

list_suite_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Device Advisor test suites you have created.

list_suite_runs(client, max_results \\ nil, next_token \\ nil, suite_definition_id \\ nil, suite_definition_version \\ nil, options \\ [])

Lists runs of the specified Device Advisor test suite.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags attached to an IoT Device Advisor resource.

metadata()

start_suite_run(client, suite_definition_id, input, options \\ [])

Starts a Device Advisor test suite run.

stop_suite_run(client, suite_definition_id, suite_run_id, input, options \\ [])

Stops a Device Advisor test suite run that is currently running.

tag_resource(client, resource_arn, input, options \\ [])

Adds to and modifies existing tags of an IoT Device Advisor resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from an IoT Device Advisor resource.

update_suite_definition(client, suite_definition_id, input, options \\ [])

Updates a Device Advisor test suite.

Link to this section Functions

create_suite_definition(client, input, options \\ [])

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

delete_suite_definition(client, suite_definition_id, input, options \\ [])

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition action.

get_endpoint(client, authentication_method \\ nil, certificate_arn \\ nil, device_role_arn \\ nil, thing_arn \\ nil, options \\ [])

Gets information about an Device Advisor endpoint.

get_suite_definition(client, suite_definition_id, suite_definition_version \\ nil, options \\ [])

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

get_suite_run(client, suite_definition_id, suite_run_id, options \\ [])

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

get_suite_run_report(client, suite_definition_id, suite_run_id, options \\ [])

Gets a report download link for a successful Device Advisor qualifying test suite run.

Requires permission to access the GetSuiteRunReport action.

list_suite_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

list_suite_runs(client, max_results \\ nil, next_token \\ nil, suite_definition_id \\ nil, suite_definition_version \\ nil, options \\ [])

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.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource action.

metadata()

start_suite_run(client, suite_definition_id, input, options \\ [])

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

stop_suite_run(client, suite_definition_id, suite_run_id, input, options \\ [])

Stops a Device Advisor test suite run that is currently running.

Requires permission to access the StopSuiteRun action.

tag_resource(client, resource_arn, input, options \\ [])

Adds to and modifies existing tags of an IoT Device Advisor resource.

Requires permission to access the TagResource action.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource action.

update_suite_definition(client, suite_definition_id, input, options \\ [])

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.