[ aws . iotdeviceadvisor ]

start-suite-run

Description

Starts a Device Advisor test suite run.

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)

Request to start suite run based on suite definition Id.

--suite-definition-version (string)

Request to start suite run based on suite definition version.

--suite-run-configuration (structure)

Request to start suite run based on suite configuration.

primaryDevice -> (structure)

Gets the primary device for suite run.

thingArn -> (string)

Lists devices thing arn

certificateArn -> (string)

Lists devices certificate arn

secondaryDevice -> (structure)

Gets the secondary device for suite run.

thingArn -> (string)

Lists devices thing arn

certificateArn -> (string)

Lists devices certificate arn

selectedTestList -> (list)

Gets test case list.

(string)

Shorthand Syntax:

primaryDevice={thingArn=string,certificateArn=string},secondaryDevice={thingArn=string,certificateArn=string},selectedTestList=string,string

JSON Syntax:

{
  "primaryDevice": {
    "thingArn": "string",
    "certificateArn": "string"
  },
  "secondaryDevice": {
    "thingArn": "string",
    "certificateArn": "string"
  },
  "selectedTestList": ["string", ...]
}

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

See ‘aws help’ for descriptions of global parameters.

Output

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

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