Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotdeviceadvisor ]



Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--suite-definition-id <value>
[--suite-definition-version <value>]
[--suite-run-configuration <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--suite-definition-id (string)

Suite definition ID of the test suite.

--suite-definition-version (string)

Suite definition version of the test suite.

--suite-run-configuration (structure)

Suite run configuration.

primaryDevice -> (structure)

Gets the primary device for suite run.

thingArn -> (string)

Lists devices thing ARN.

certificateArn -> (string)

Lists devices certificate ARN.

selectedTestList -> (list)

Gets test case list.


parallelRun -> (boolean)

TRUE if multiple test suites run in parallel.

Shorthand Syntax:


JSON Syntax:

  "primaryDevice": {
    "thingArn": "string",
    "certificateArn": "string"
  "selectedTestList": ["string", ...],
  "parallelRun": true|false

--tags (map)

The tags to be attached to the suite run.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


suiteRunId -> (string)

Suite Run ID of the started suite run.

suiteRunArn -> (string)

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

createdAt -> (timestamp)

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