AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.IotDeviceAdvisor

Inherits:
AWS.Service show all
Identifier:
iotdeviceadvisor
API Version:
2020-09-18
Defined in:
(unknown)

Overview

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

Service Description

AWS 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 AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS 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 AWS Partner Network to get your device qualified for the AWS 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();

Version:

  • 2020-09-18

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a IotDeviceAdvisor object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.IotDeviceAdvisor.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.IotDeviceAdvisor.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IotDeviceAdvisor.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a Device Advisor test suite.

Service Reference:

Examples:

Calling the createSuiteDefinition operation

var params = {
  suiteDefinitionConfiguration: {
    devicePermissionRoleArn: 'STRING_VALUE',
    devices: [
      {
        certificateArn: 'STRING_VALUE',
        thingArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    intendedForQualification: true || false,
    rootGroup: 'STRING_VALUE',
    suiteDefinitionName: 'STRING_VALUE'
  },
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
iotdeviceadvisor.createSuiteDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionConfiguration — (map)

      Creates a Device Advisor test suite with suite definition configuration.

      • suiteDefinitionName — (String)

        Gets Suite Definition Configuration name.

      • devices — (Array<map>)

        Gets the devices configured.

        • thingArn — (String)

          Lists devices thing arn

        • certificateArn — (String)

          Lists devices certificate arn

      • intendedForQualification — (Boolean)

        Gets the tests intended for qualification in a suite.

      • rootGroup — (String)

        Gets test suite root group.

      • devicePermissionRoleArn — (String)

        Gets device permission arn.

    • tags — (map<String>)

      The tags to be attached to the suite definition.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteDefinitionId — (String)

        Creates a Device Advisor test suite with suite UUID.

      • suiteDefinitionArn — (String)

        Creates a Device Advisor test suite with Amazon Resource name.

      • suiteDefinitionName — (String)

        Creates a Device Advisor test suite with suite definition name.

      • createdAt — (Date)

        Creates a Device Advisor test suite with TimeStamp of when it was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a Device Advisor test suite.

Service Reference:

Examples:

Calling the deleteSuiteDefinition operation

var params = {
  suiteDefinitionId: 'STRING_VALUE' /* required */
};
iotdeviceadvisor.deleteSuiteDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Deletes a Device Advisor test suite with defined suite Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets information about a Device Advisor test suite.

Service Reference:

Examples:

Calling the getSuiteDefinition operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteDefinitionVersion: 'STRING_VALUE'
};
iotdeviceadvisor.getSuiteDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Requests suite definition Id with GetSuiteDefinition API call.

    • suiteDefinitionVersion — (String)

      Requests the suite definition version of a test suite.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteDefinitionId — (String)

        Gets suite definition Id with GetSuiteDefinition API call.

      • suiteDefinitionArn — (String)

        The ARN of the suite definition.

      • suiteDefinitionVersion — (String)

        Gets suite definition version with GetSuiteDefinition API call.

      • latestVersion — (String)

        Gets latest suite definition version with GetSuiteDefinition API call.

      • suiteDefinitionConfiguration — (map)

        Gets the suite configuration with GetSuiteDefinition API call.

        • suiteDefinitionName — (String)

          Gets Suite Definition Configuration name.

        • devices — (Array<map>)

          Gets the devices configured.

          • thingArn — (String)

            Lists devices thing arn

          • certificateArn — (String)

            Lists devices certificate arn

        • intendedForQualification — (Boolean)

          Gets the tests intended for qualification in a suite.

        • rootGroup — (String)

          Gets test suite root group.

        • devicePermissionRoleArn — (String)

          Gets device permission arn.

      • createdAt — (Date)

        Gets the timestamp of the time suite was created with GetSuiteDefinition API call.

      • lastModifiedAt — (Date)

        Gets the timestamp of the time suite was modified with GetSuiteDefinition API call.

      • tags — (map<String>)

        Tags attached to the suite definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets information about a Device Advisor test suite run.

Service Reference:

Examples:

Calling the getSuiteRun operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteRunId: 'STRING_VALUE' /* required */
};
iotdeviceadvisor.getSuiteRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Requests the information about Device Advisor test suite run based on suite definition Id.

    • suiteRunId — (String)

      Requests the information about Device Advisor test suite run based on suite run Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteDefinitionId — (String)

        Gets the information about Device Advisor test suite run based on suite definition Id.

      • suiteDefinitionVersion — (String)

        Gets the information about Device Advisor test suite run based on suite definition version.

      • suiteRunId — (String)

        Gets the information about Device Advisor test suite run based on suite run Id.

      • suiteRunArn — (String)

        The ARN of the suite run.

      • suiteRunConfiguration — (map)

        Gets the information about Device Advisor test suite run based on suite configuration.

        • primaryDevice — (map)

          Gets the primary device for suite run.

          • thingArn — (String)

            Lists devices thing arn

          • certificateArn — (String)

            Lists devices certificate arn

        • secondaryDevice — (map)

          Gets the secondary device for suite run.

          • thingArn — (String)

            Lists devices thing arn

          • certificateArn — (String)

            Lists devices certificate arn

        • selectedTestList — (Array<String>)

          Gets test case list.

      • testResult — (map)

        Gets the information about Device Advisor test suite run based on test case runs.

        • groups — (Array<map>)

          Show each group of test results.

          • groupId — (String)

            Show Group Result Id.

          • groupName — (String)

            Show Group Result Name.

          • tests — (Array<map>)

            Show Group Result.

            • 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.

              Possible values include:
              • "PASS"
              • "FAIL"
              • "CANCELED"
              • "PENDING"
              • "RUNNING"
              • "PASS_WITH_WARNINGS"
              • "ERROR"
            • startTime — (Date)

              Provides test case run start time.

            • endTime — (Date)

              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 — (Date)

        Gets the information about Device Advisor test suite run based on start time.

      • endTime — (Date)

        Gets the information about Device Advisor test suite run based on end time.

      • status — (String)

        Gets the information about Device Advisor test suite run based on its status.

        Possible values include:
        • "PASS"
        • "FAIL"
        • "CANCELED"
        • "PENDING"
        • "RUNNING"
        • "PASS_WITH_WARNINGS"
        • "ERROR"
      • errorReason — (String)

        Gets the information about Device Advisor test suite run based on error.

      • tags — (map<String>)

        The tags attached to the suite run.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the getSuiteRunReport operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteRunId: 'STRING_VALUE' /* required */
};
iotdeviceadvisor.getSuiteRunReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Device Advisor suite definition Id.

    • suiteRunId — (String)

      Device Advisor suite run Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • qualificationReportDownloadUrl — (String)

        Gets the download URL of the qualification report.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the Device Advisor test suites you have created.

Service Reference:

Examples:

Calling the listSuiteDefinitions operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotdeviceadvisor.listSuiteDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      Request the list of all the Device Advisor test suites.

    • nextToken — (String)

      Requests the Device Advisor test suites next token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteDefinitionInformationList — (Array<map>)

        Lists test suite information using List suite definition.

        • suiteDefinitionId — (String)

          Get suite definition Id.

        • suiteDefinitionName — (String)

          Get test suite name.

        • defaultDevices — (Array<map>)

          Specifies the devices under test.

          • thingArn — (String)

            Lists devices thing arn

          • certificateArn — (String)

            Lists devices certificate arn

        • intendedForQualification — (Boolean)

          Gets the test suites which will be used for qualification.

        • createdAt — (Date)

          Gets the information of when the test suite was created.

      • nextToken — (String)

        Creates a Device Advisor test suite.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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.

Service Reference:

Examples:

Calling the listSuiteRuns operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  suiteDefinitionId: 'STRING_VALUE',
  suiteDefinitionVersion: 'STRING_VALUE'
};
iotdeviceadvisor.listSuiteRuns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Lists the runs of the specified Device Advisor test suite based on suite definition Id.

    • suiteDefinitionVersion — (String)

      Lists the runs of the specified Device Advisor test suite based on suite definition version.

    • maxResults — (Integer)

      MaxResults for list suite run API request.

    • nextToken — (String)

      Next pagination token for list suite run request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteRunsList — (Array<map>)

        Lists the runs of the specified Device Advisor test suite.

        • suiteDefinitionId — (String)

          Get suite run information based on suite definition Id.

        • suiteDefinitionVersion — (String)

          Get suite run information based on suite definition version.

        • suiteDefinitionName — (String)

          Get suite run information based on suite definition name.

        • suiteRunId — (String)

          Get suite run information based on suite run Id.

        • createdAt — (Date)

          Get suite run information based on time suite was created.

        • startedAt — (Date)

          Get suite run information based on start time of the run.

        • endAt — (Date)

          Get suite run information based on end time of the run.

        • status — (String)

          Get suite run information based on test run status.

          Possible values include:
          • "PASS"
          • "FAIL"
          • "CANCELED"
          • "PENDING"
          • "RUNNING"
          • "PASS_WITH_WARNINGS"
          • "ERROR"
        • passed — (Integer)

          Get suite run information based on result of the test suite run.

        • failed — (Integer)

          Get suite run information based on result of the test suite run.

      • nextToken — (String)

        Next pagination token for list suite run response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the tags attached to an IoT Device Advisor resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
iotdeviceadvisor.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the IoT Device Advisor resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags attached to the IoT Device Advisor resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists all the test cases in the test suite.

Service Reference:

Examples:

Calling the listTestCases operation

var params = {
  intendedForQualification: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotdeviceadvisor.listTestCases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • intendedForQualification — (Boolean)

      Lists all the qualification test cases in the test suite.

    • maxResults — (Integer)

      Requests the test cases max results.

    • nextToken — (String)

      Requests the test cases next token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • categories — (Array<map>)

        Gets the category of test case.

        • name — (String)

          Lists all the tests name in the specified category.

        • tests — (Array<map>)

          Lists all the tests in the specified category.

          • name — (String)

            Shows test case name.

          • configuration — (map<String>)

            Shows test case configuration.

          • test — (map)

            Specifies a test.

            • id — (String)

              Provides test case definition Id.

            • testCaseVersion — (String)

              Provides test case definition version.

      • rootGroupConfiguration — (map<String>)

        Gets the configuration of root test group.

      • groupConfiguration — (map<String>)

        Gets the configuration of test group.

      • nextToken — (String)

        Test cases next token response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Starts a Device Advisor test suite run.

Service Reference:

Examples:

Calling the startSuiteRun operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteDefinitionVersion: 'STRING_VALUE',
  suiteRunConfiguration: {
    primaryDevice: {
      certificateArn: 'STRING_VALUE',
      thingArn: 'STRING_VALUE'
    },
    secondaryDevice: {
      certificateArn: 'STRING_VALUE',
      thingArn: 'STRING_VALUE'
    },
    selectedTestList: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
iotdeviceadvisor.startSuiteRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Request to start suite run based on suite definition Id.

    • suiteDefinitionVersion — (String)

      Request to start suite run based on suite definition version.

    • suiteRunConfiguration — (map)

      Request to start suite run based on suite configuration.

      • primaryDevice — (map)

        Gets the primary device for suite run.

        • thingArn — (String)

          Lists devices thing arn

        • certificateArn — (String)

          Lists devices certificate arn

      • secondaryDevice — (map)

        Gets the secondary device for suite run.

        • thingArn — (String)

          Lists devices thing arn

        • certificateArn — (String)

          Lists devices certificate arn

      • selectedTestList — (Array<String>)

        Gets test case list.

    • tags — (map<String>)

      The tags to be attached to the suite run.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteRunId — (String)

        Starts a Device Advisor test suite run based on suite Run Id.

      • suiteRunArn — (String)

        Starts a Device Advisor test suite run based on suite run arn.

      • createdAt — (Date)

        Starts a Device Advisor test suite run based on suite create time.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
iotdeviceadvisor.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The resource ARN of an IoT Device Advisor resource.

    • tags — (map<String>)

      The tags to be attached to the IoT Device Advisor resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes tags from an IoT Device Advisor resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iotdeviceadvisor.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The resource ARN of an IoT Device Advisor resource.

    • tagKeys — (Array<String>)

      List of tag keys to remove from the IoT Device Advisor resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates a Device Advisor test suite.

Service Reference:

Examples:

Calling the updateSuiteDefinition operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteDefinitionConfiguration: {
    devicePermissionRoleArn: 'STRING_VALUE',
    devices: [
      {
        certificateArn: 'STRING_VALUE',
        thingArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    intendedForQualification: true || false,
    rootGroup: 'STRING_VALUE',
    suiteDefinitionName: 'STRING_VALUE'
  }
};
iotdeviceadvisor.updateSuiteDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • suiteDefinitionId — (String)

      Updates a Device Advisor test suite with suite definition id.

    • suiteDefinitionConfiguration — (map)

      Updates a Device Advisor test suite with suite definition configuration.

      • suiteDefinitionName — (String)

        Gets Suite Definition Configuration name.

      • devices — (Array<map>)

        Gets the devices configured.

        • thingArn — (String)

          Lists devices thing arn

        • certificateArn — (String)

          Lists devices certificate arn

      • intendedForQualification — (Boolean)

        Gets the tests intended for qualification in a suite.

      • rootGroup — (String)

        Gets test suite root group.

      • devicePermissionRoleArn — (String)

        Gets device permission arn.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • suiteDefinitionId — (String)

        Updates a Device Advisor test suite with suite UUID.

      • suiteDefinitionArn — (String)

        Updates a Device Advisor test suite with Amazon Resource name.

      • suiteDefinitionName — (String)

        Updates a Device Advisor test suite with suite definition name.

      • suiteDefinitionVersion — (String)

        Updates a Device Advisor test suite with suite definition version.

      • createdAt — (Date)

        Updates a Device Advisor test suite with TimeStamp of when it was created.

      • lastUpdatedAt — (Date)

        Updates a Device Advisor test suite with TimeStamp of when it was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.