StartSuiteRun - AWS IoT

StartSuiteRun

Starts a Device Advisor test suite run.

Request Syntax

POST /suiteDefinitions/suiteDefinitionId/suiteRuns HTTP/1.1 Content-type: application/json { "suiteDefinitionVersion": "string", "suiteRunConfiguration": { "primaryDevice": { "certificateArn": "string", "thingArn": "string" }, "secondaryDevice": { "certificateArn": "string", "thingArn": "string" }, "selectedTestList": [ "string" ] }, "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

suiteDefinitionId

Request to start suite run based on suite definition Id.

Length Constraints: Fixed length of 36.

Required: Yes

Request Body

The request accepts the following data in JSON format.

suiteDefinitionVersion

Request to start suite run based on suite definition version.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 255.

Required: No

suiteRunConfiguration

Request to start suite run based on suite configuration.

Type: SuiteRunConfiguration object

Required: No

tags

The tags to be attached to the suite run.

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, "suiteRunArn": "string", "suiteRunId": "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

Starts a Device Advisor test suite run based on suite create time.

Type: Timestamp

suiteRunArn

Starts a Device Advisor test suite run based on suite run arn.

Type: String

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

suiteRunId

Starts a Device Advisor test suite run based on suite Run Id.

Type: String

Length Constraints: Fixed length of 36.

Errors

ConflictException

Sends Conflict Exception.

HTTP Status Code: 400

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: