AWS.IotDeviceAdvisor — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using IotDeviceAdvisor

var iotdeviceadvisor = new AWS.IotDeviceAdvisor();
iotdeviceadvisor.createSuiteDefinition(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IotDeviceAdvisor object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotdeviceadvisor = new AWS.IotDeviceAdvisor({apiVersion: '2020-09-18'});

You can also set the API version globally in AWS.config.apiVersions using the iotdeviceadvisor service identifier:

AWS.config.apiVersions = {
  iotdeviceadvisor: '2020-09-18',
  // other service API versions
};

var iotdeviceadvisor = new AWS.IotDeviceAdvisor();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.IotDeviceAdvisor(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createSuiteDefinition(params = {}, callback) ⇒ AWS.Request

deleteSuiteDefinition(params = {}, callback) ⇒ AWS.Request

getEndpoint(params = {}, callback) ⇒ AWS.Request

Gets information about an Device Advisor endpoint.

getSuiteDefinition(params = {}, callback) ⇒ AWS.Request

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

getSuiteRun(params = {}, callback) ⇒ AWS.Request

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

getSuiteRunReport(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the GetSuiteRunReport action.

listSuiteDefinitions(params = {}, callback) ⇒ AWS.Request

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

listSuiteRuns(params = {}, callback) ⇒ AWS.Request

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.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource action.

startSuiteRun(params = {}, callback) ⇒ AWS.Request

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

stopSuiteRun(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the StopSuiteRun action.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Requires permission to access the TagResource action.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource action.

updateSuiteDefinition(params = {}, callback) ⇒ AWS.Request