Amazon Web Services, Inc.

AWS IoT Core Device Advisor

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development.…

IoT & devices#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 14

  • GETList suite definitions/suiteDefinitions?maxResults=0&nextToken=stringLists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.
  • POSTCreate suite definition/suiteDefinitionsCreates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.
  • GETGet suite definition/suiteDefinitions/:suiteDefinitionId?suiteDefinitionVersion=stringGets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.
  • DELETEDelete suite definition/suiteDefinitions/:suiteDefinitionIdDeletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.
  • PATCHUpdate suite definition/suiteDefinitions/:suiteDefinitionIdUpdates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.
  • GETGet endpoint/endpoint?thingArn=string&certificateArn=string&deviceRoleArn=string&authenticationMethod=stringGets information about an Device Advisor endpoint.
  • GETGet suite run/suiteDefinitions/:suiteDefinitionId/suiteRuns/:suiteRunIdGets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.
  • GETGet suite run report/suiteDefinitions/:suiteDefinitionId/suiteRuns/:suiteRunId/reportGets a report download link for a successful Device Advisor qualifying test suite run. Requires permission to access the GetSuiteRunReport action.
  • GETList suite runs/suiteRuns?suiteDefinitionId=string&suiteDefinitionVersion=string&maxResults=0&nextToken=stringLists 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…
  • GETList tags for resource/tags/:resourceArnLists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.
  • POSTTag resource/tags/:resourceArnAdds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.
  • POSTStart suite run/suiteDefinitions/:suiteDefinitionId/suiteRunsStarts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.
  • POSTStop suite run/suiteDefinitions/:suiteDefinitionId/suiteRuns/:suiteRunId/stopStops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.

API details

Base URL
https://api.iotdeviceadvisor.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
14 operations on 9 pathsGET 7POST 4DELETE 2PATCH 1
Description format
AWS Smithy model, API version 2020-09-18

How to test the AWS IoT Core Device Advisor in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT Core Device Advisor collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List suite definitions” (GET /suiteDefinitions?maxResults=0&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT Core Device Advisor?

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development.… It is listed under IoT & devices and has 14 endpoints.

Who publishes the AWS IoT Core Device Advisor?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT Core Device Advisor?

Requests go to https://api.iotdeviceadvisor.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT Core Device Advisor?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT Core Device Advisor have?

14 operations on 9 paths (7 GET, 4 POST, 2 DELETE, 1 PATCH).

Is forking the AWS IoT Core Device Advisor free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.