[ aws . iotdeviceadvisor ]

get-suite-run

Description

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-suite-run
--suite-definition-id <value>
--suite-run-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--suite-definition-id (string)

Suite definition ID for the test suite run.

--suite-run-id (string)

Suite run ID for the test suite run.

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

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

Suite run configuration for the test suite run.

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.

testResult -> (structure)

Test results for the test suite run.

groups -> (list)

Show each group of test results.

(structure)

Show Group Result.

groupId -> (string)

Group result ID.

groupName -> (string)

Group Result Name.

tests -> (list)

Tests under Group Result.

(structure)

Provides the test case run.

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.

startTime -> (timestamp)

Provides test case run start time.

endTime -> (timestamp)

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

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

endTime -> (timestamp)

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

status -> (string)

Status for the test suite run.

errorReason -> (string)

Error reason for any test suite run failure.

tags -> (map)

The tags attached to the suite run.

key -> (string)

value -> (string)