[ aws . iotdeviceadvisor ]

list-suite-definitions

Description

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-suite-definitions
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of results to return at once.

--next-token (string)

A token used to get 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. 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

suiteDefinitionInformationList -> (list)

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

(structure)

Information about the suite definition.

suiteDefinitionId -> (string)

Suite definition ID of the test suite.

suiteDefinitionName -> (string)

Suite name of the test suite.

defaultDevices -> (list)

Specifies the devices that are under test for the test suite.

(structure)

Information of a test device. A thing ARN or a certificate ARN is required.

thingArn -> (string)

Lists devices thing ARN.

certificateArn -> (string)

Lists devices certificate ARN.

intendedForQualification -> (boolean)

Specifies if the test suite is intended for qualification.

isLongDurationTest -> (boolean)

Verifies if the test suite is a long duration test.

protocol -> (string)

Gets the MQTT protocol that is configured in the suite definition.

createdAt -> (timestamp)

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

nextToken -> (string)

A token used to get the next set of results.