Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartSuiteRun

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

Request Syntax


POST /suiteDefinitions/suiteDefinitionId/suiteRuns HTTP/1.1
Content-type: application/json

{
   "suiteDefinitionVersion": "string",
   "suiteRunConfiguration": { 
      "parallelRun": boolean,
      "primaryDevice": { 
         "certificateArn": "string",
         "deviceRoleArn": "string",
         "thingArn": "string"
      },
      "selectedTestList": [ "string" ]
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

suiteDefinitionId

Suite definition ID of the test suite.

Length Constraints: Minimum length of 12. Maximum length of 36.

Required: Yes

Request Body

The request accepts the following data in JSON format.

suiteDefinitionVersion

Suite definition version of the test suite.

Type: String

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

Required: No

suiteRunConfiguration

Suite run configuration.

Type: SuiteRunConfiguration object

Required: Yes

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

endpoint

The response of an Device Advisor test endpoint.

Type: String

Length Constraints: Minimum length of 45. Maximum length of 75.

suiteRunArn

Amazon Resource Name (ARN) of the started suite run.

Type: String

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

suiteRunId

Suite Run ID of the started suite run.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 36.

Errors

ConflictException

Sends a Conflict Exception.

HTTP Status Code: 400

InternalServerException

Sends an Internal Failure exception.

HTTP Status Code: 500

ValidationException

Sends a validation exception.

HTTP Status Code: 400