Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--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.

rootGroup -> (string)

Gets test suite root group.

devicePermissionRoleArn -> (string)

Gets the device permission ARN.

Shorthand Syntax:

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

JSON Syntax:

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

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

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.