[ aws . iotdeviceadvisor ]

start-suite-run

Description

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.

Synopsis

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

Options

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

(string)

parallelRun -> (boolean)

TRUE if multiple test suites run in parallel.

Shorthand Syntax:

primaryDevice={thingArn=string,certificateArn=string},selectedTestList=string,string,parallelRun=boolean

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:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

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.