CreateSuiteDefinition - AWS IoT

CreateSuiteDefinition

Creates a Device Advisor test suite.

Request Syntax

POST /suiteDefinitions HTTP/1.1 Content-type: application/json { "suiteDefinitionConfiguration": { "devicePermissionRoleArn": "string", "devices": [ { "certificateArn": "string", "thingArn": "string" } ], "intendedForQualification": boolean, "rootGroup": "string", "suiteDefinitionName": "string" }, "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

suiteDefinitionConfiguration

Creates a Device Advisor test suite with suite definition configuration.

Type: SuiteDefinitionConfiguration object

Required: No

tags

The tags to be attached to the suite definition.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdAt": number, "suiteDefinitionArn": "string", "suiteDefinitionId": "string", "suiteDefinitionName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

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

Type: Timestamp

suiteDefinitionArn

Creates a Device Advisor test suite with Amazon Resource name.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

suiteDefinitionId

Creates a Device Advisor test suite with suite UUID.

Type: String

Length Constraints: Fixed length of 36.

suiteDefinitionName

Creates a Device Advisor test suite with suite definition name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

InternalServerException

Sends Internal Failure Exception.

HTTP Status Code: 500

ValidationException

Sends invalid request exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: