[ aws . iotdeviceadvisor ]

get-suite-definition

Description

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--suite-definition-id (string)

Suite definition ID of the test suite to get.

--suite-definition-version (string)

Suite definition version of the test suite to get.

--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 of the suite definition.

suiteDefinitionArn -> (string)

The ARN of the suite definition.

suiteDefinitionVersion -> (string)

Suite definition version of the suite definition.

latestVersion -> (string)

Latest suite definition version of the suite definition.

suiteDefinitionConfiguration -> (structure)

Suite configuration of the suite definition.

suiteDefinitionName -> (string)

Gets Suite Definition Configuration name.

devices -> (list)

Gets the devices configured.

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

Gets the tests intended for qualification in a suite.

isLongDurationTest -> (boolean)

Verifies if the test suite is a long duration test.

rootGroup -> (string)

Gets test suite root group.

devicePermissionRoleArn -> (string)

Gets the device permission ARN.

protocol -> (string)

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

createdAt -> (timestamp)

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

lastModifiedAt -> (timestamp)

Date (in Unix epoch time) when the suite definition was last modified.

tags -> (map)

Tags attached to the suite definition.

key -> (string)

value -> (string)