[ aws . iotdeviceadvisor ]

create-suite-definition

Description

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-suite-definition
[--suite-definition-configuration <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--suite-definition-configuration (structure)

Creates a Device Advisor test suite with suite definition configuration.

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.

Shorthand Syntax:

suiteDefinitionName=string,devices=[{thingArn=string,certificateArn=string},{thingArn=string,certificateArn=string}],intendedForQualification=boolean,isLongDurationTest=boolean,rootGroup=string,devicePermissionRoleArn=string,protocol=string

JSON Syntax:

{
  "suiteDefinitionName": "string",
  "devices": [
    {
      "thingArn": "string",
      "certificateArn": "string"
    }
    ...
  ],
  "intendedForQualification": true|false,
  "isLongDurationTest": true|false,
  "rootGroup": "string",
  "devicePermissionRoleArn": "string",
  "protocol": "MqttV3_1_1"|"MqttV5"
}

--tags (map)

The tags to be attached to the suite definition.

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

suiteDefinitionId -> (string)

Creates a Device Advisor test suite with suite UUID.

suiteDefinitionArn -> (string)

Creates a Device Advisor test suite with Amazon Resource Name (ARN).

suiteDefinitionName -> (string)

Creates a Device Advisor test suite with suite definition name.

createdAt -> (timestamp)

Creates a Device Advisor test suite with TimeStamp of when it was created.