[ aws . iotdeviceadvisor ]

list-suite-runs

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-suite-runs
[--suite-definition-id <value>]
[--suite-definition-version <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--suite-definition-id (string)

Lists the test suite runs of the specified test suite based on suite definition Id.

--suite-definition-version (string)

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

--max-results (integer)

The maximum number of results to return at once.

--next-token (string)

A token to retrieve the next set of results.

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

suiteRunsList -> (list)

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

(structure)

Information about the suite run.

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

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

startedAt -> (timestamp)

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

endAt -> (timestamp)

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

status -> (string)

Status of the suite run.

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.