We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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.

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

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();

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

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.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.

Requires permission to access the CreateSuiteDefinition action.

Service Reference:

Examples:

Calling the createSuiteDefinition operation

var params = {
  suiteDefinitionConfiguration: { /* required */
    devicePermissionRoleArn: 'STRING_VALUE', /* required */
    rootGroup: 'STRING_VALUE', /* required */
    suiteDefinitionName: 'STRING_VALUE', /* required */
    devices: [
      {
        certificateArn: 'STRING_VALUE',
        deviceRoleArn: 'STRING_VALUE',
        thingArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    intendedForQualification: true || false,
    isLongDurationTest: true || false,
    protocol: MqttV3_1_1 | MqttV5 | MqttV3_1_1_OverWebSocket | MqttV5_OverWebSocket
  },
  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 — required — (String)

        Gets the suite definition name. This is a required parameter.

      • devices — (Array<map>)

        Gets the devices configured.

        • thingArn — (String)

          Lists device's thing ARN.

        • certificateArn — (String)

          Lists device's certificate ARN.

        • deviceRoleArn — (String)

          Lists device's role 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 — required — (String)

        Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

        For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

      • devicePermissionRoleArn — required — (String)

        Gets the device permission ARN. This is a required parameter.

      • protocol — (String)

        Sets the MQTT protocol that is configured in the suite definition.

        Possible values include:
        • "MqttV3_1_1"
        • "MqttV5"
        • "MqttV3_1_1_OverWebSocket"
        • "MqttV5_OverWebSocket"
    • 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)

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

        The timestamp of when the test suite 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.

Requires permission to access the DeleteSuiteDefinition action.

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)

      Suite definition ID of the test suite to be deleted.

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.

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

Gets information about an Device Advisor endpoint.

Service Reference:

Examples:

Calling the getEndpoint operation

var params = {
  authenticationMethod: X509ClientCertificate | SignatureVersion4,
  certificateArn: 'STRING_VALUE',
  deviceRoleArn: 'STRING_VALUE',
  thingArn: 'STRING_VALUE'
};
iotdeviceadvisor.getEndpoint(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: {}) —
    • thingArn — (String)

      The thing ARN of the device. This is an optional parameter.

    • certificateArn — (String)

      The certificate ARN of the device. This is an optional parameter.

    • deviceRoleArn — (String)

      The device role ARN of the device. This is an optional parameter.

    • authenticationMethod — (String)

      The authentication method used during the device connection.

      Possible values include:
      • "X509ClientCertificate"
      • "SignatureVersion4"

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:

      • endpoint — (String)

        The response of an Device Advisor endpoint.

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.

Requires permission to access the GetSuiteDefinition action.

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)

      Suite definition ID of the test suite to get.

    • suiteDefinitionVersion — (String)

      Suite definition version of the test suite to get.

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)

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

        Suite configuration of the suite definition.

        • suiteDefinitionName — required — (String)

          Gets the suite definition name. This is a required parameter.

        • devices — (Array<map>)

          Gets the devices configured.

          • thingArn — (String)

            Lists device's thing ARN.

          • certificateArn — (String)

            Lists device's certificate ARN.

          • deviceRoleArn — (String)

            Lists device's role 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 — required — (String)

          Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

          For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

        • devicePermissionRoleArn — required — (String)

          Gets the device permission ARN. This is a required parameter.

        • protocol — (String)

          Sets the MQTT protocol that is configured in the suite definition.

          Possible values include:
          • "MqttV3_1_1"
          • "MqttV5"
          • "MqttV3_1_1_OverWebSocket"
          • "MqttV5_OverWebSocket"
      • createdAt — (Date)

        Date (in Unix epoch time) when the suite definition was created.

      • lastModifiedAt — (Date)

        Date (in Unix epoch time) when the suite definition was last modified.

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

Requires permission to access the GetSuiteRun action.

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)

      Suite definition ID for the test suite run.

    • suiteRunId — (String)

      Suite run ID for the test 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:

      • 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 — (map)

        Suite run configuration for the test suite run.

        • primaryDevice — required — (map)

          Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.

          • thingArn — (String)

            Lists device's thing ARN.

          • certificateArn — (String)

            Lists device's certificate ARN.

          • deviceRoleArn — (String)

            Lists device's role ARN.

        • selectedTestList — (Array<String>)

          Sets test case list.

        • parallelRun — (Boolean)

          TRUE if multiple test suites run in parallel.

      • testResult — (map)

        Test results for the test suite run.

        • groups — (Array<map>)

          Show each group of test results.

          • groupId — (String)

            Group result ID.

          • groupName — (String)

            Group Result Name.

          • tests — (Array<map>)

            Tests under Group Result.

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

              Possible values include:
              • "PASS"
              • "FAIL"
              • "CANCELED"
              • "PENDING"
              • "RUNNING"
              • "STOPPING"
              • "STOPPED"
              • "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.

            • testScenarios — (Array<map>)

              Provides the test scenarios for the test case run.

              • testCaseScenarioId — (String)

                Provides test case scenario ID.

              • testCaseScenarioType — (String)

                Provides test case scenario type. Type is one of the following:

                • Advanced

                • Basic

                Possible values include:
                • "Advanced"
                • "Basic"
              • 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.

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

                Provides test case scenario failure result.

              • systemMessage — (String)

                Provides test case scenario system messages if any.

      • startTime — (Date)

        Date (in Unix epoch time) when the test suite run started.

      • endTime — (Date)

        Date (in Unix epoch time) when the test suite run ended.

      • status — (String)

        Status for the test suite run.

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

        Error reason for any test suite run failure.

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

Requires permission to access the GetSuiteRunReport action.

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)

      Suite definition ID of the test suite.

    • suiteRunId — (String)

      Suite run ID of the test 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:

      • qualificationReportDownloadUrl — (String)

        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.

Requires permission to access the ListSuiteDefinitions action.

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)

      The maximum number of results to return at once.

    • nextToken — (String)

      A token used to get the next set of results.

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>)

        An array of objects that provide summaries of information about the suite definitions in the list.

        • suiteDefinitionId — (String)

          Suite definition ID of the test suite.

        • suiteDefinitionName — (String)

          Suite name of the test suite.

        • defaultDevices — (Array<map>)

          Specifies the devices that are under test for the test suite.

          • thingArn — (String)

            Lists device's thing ARN.

          • certificateArn — (String)

            Lists device's certificate ARN.

          • deviceRoleArn — (String)

            Lists device's role 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.

          Possible values include:
          • "MqttV3_1_1"
          • "MqttV5"
          • "MqttV3_1_1_OverWebSocket"
          • "MqttV5_OverWebSocket"
        • createdAt — (Date)

          Date (in Unix epoch time) when the test suite was created.

      • nextToken — (String)

        A token used to get the next set of results.

Returns:

  • (AWS.Request) —

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

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.

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 test suite runs of the specified test suite based on suite definition ID.

    • suiteDefinitionVersion — (String)

      Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

    • maxResults — (Integer)

      The maximum number of results to return at once.

    • nextToken — (String)

      A token to retrieve the next set of results.

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>)

        An array of objects that provide summaries of information about the suite runs in the list.

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

          Date (in Unix epoch time) when the suite run was created.

        • startedAt — (Date)

          Date (in Unix epoch time) when the suite run was started.

        • endAt — (Date)

          Date (in Unix epoch time) when the suite run ended.

        • status — (String)

          Status of the suite run.

          Possible values include:
          • "PASS"
          • "FAIL"
          • "CANCELED"
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "PASS_WITH_WARNINGS"
          • "ERROR"
        • 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.

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.

Requires permission to access the ListTagsForResource action.

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 resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun 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:

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

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

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

Service Reference:

Examples:

Calling the startSuiteRun operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteRunConfiguration: { /* required */
    primaryDevice: { /* required */
      certificateArn: 'STRING_VALUE',
      deviceRoleArn: 'STRING_VALUE',
      thingArn: 'STRING_VALUE'
    },
    parallelRun: true || false,
    selectedTestList: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  suiteDefinitionVersion: 'STRING_VALUE',
  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)

      Suite definition ID of the test suite.

    • suiteDefinitionVersion — (String)

      Suite definition version of the test suite.

    • suiteRunConfiguration — (map)

      Suite run configuration.

      • primaryDevice — required — (map)

        Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.

        • thingArn — (String)

          Lists device's thing ARN.

        • certificateArn — (String)

          Lists device's certificate ARN.

        • deviceRoleArn — (String)

          Lists device's role ARN.

      • selectedTestList — (Array<String>)

        Sets test case list.

      • parallelRun — (Boolean)

        TRUE if multiple test suites run in parallel.

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

        Suite Run ID of the started suite run.

      • suiteRunArn — (String)

        Amazon Resource Name (ARN) of the started suite run.

      • createdAt — (Date)

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

      • endpoint — (String)

        The response of an Device Advisor test endpoint.

Returns:

  • (AWS.Request) —

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

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

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

Requires permission to access the StopSuiteRun action.

Service Reference:

Examples:

Calling the stopSuiteRun operation

var params = {
  suiteDefinitionId: 'STRING_VALUE', /* required */
  suiteRunId: 'STRING_VALUE' /* required */
};
iotdeviceadvisor.stopSuiteRun(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)

      Suite definition ID of the test suite run to be stopped.

    • suiteRunId — (String)

      Suite run ID of the test suite run to be stopped.

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.

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

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

Requires permission to access the TagResource action.

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. This can be SuiteDefinition ARN or SuiteRun ARN.

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

Requires permission to access the UntagResource action.

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. This can be SuiteDefinition ARN or SuiteRun ARN.

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

Requires permission to access the UpdateSuiteDefinition action.

Service Reference:

Examples:

Calling the updateSuiteDefinition operation

var params = {
  suiteDefinitionConfiguration: { /* required */
    devicePermissionRoleArn: 'STRING_VALUE', /* required */
    rootGroup: 'STRING_VALUE', /* required */
    suiteDefinitionName: 'STRING_VALUE', /* required */
    devices: [
      {
        certificateArn: 'STRING_VALUE',
        deviceRoleArn: 'STRING_VALUE',
        thingArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    intendedForQualification: true || false,
    isLongDurationTest: true || false,
    protocol: MqttV3_1_1 | MqttV5 | MqttV3_1_1_OverWebSocket | MqttV5_OverWebSocket
  },
  suiteDefinitionId: 'STRING_VALUE' /* required */
};
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)

      Suite definition ID of the test suite to be updated.

    • suiteDefinitionConfiguration — (map)

      Updates a Device Advisor test suite with suite definition configuration.

      • suiteDefinitionName — required — (String)

        Gets the suite definition name. This is a required parameter.

      • devices — (Array<map>)

        Gets the devices configured.

        • thingArn — (String)

          Lists device's thing ARN.

        • certificateArn — (String)

          Lists device's certificate ARN.

        • deviceRoleArn — (String)

          Lists device's role 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 — required — (String)

        Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

        For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

      • devicePermissionRoleArn — required — (String)

        Gets the device permission ARN. This is a required parameter.

      • protocol — (String)

        Sets the MQTT protocol that is configured in the suite definition.

        Possible values include:
        • "MqttV3_1_1"
        • "MqttV5"
        • "MqttV3_1_1_OverWebSocket"
        • "MqttV5_OverWebSocket"

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)

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

        Timestamp of when the test suite was created.

      • lastUpdatedAt — (Date)

        Timestamp of when the test suite was updated.

Returns:

  • (AWS.Request) —

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