GetSuiteDefinition - AWS IoT

GetSuiteDefinition

Gets information about a Device Advisor test suite.

Request Syntax

GET /suiteDefinitions/suiteDefinitionId?suiteDefinitionVersion=suiteDefinitionVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

suiteDefinitionId

Requests suite definition Id with GetSuiteDefinition API call.

Length Constraints: Fixed length of 36.

Required: Yes

suiteDefinitionVersion

Requests the suite definition version of a test suite.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdAt": number, "lastModifiedAt": number, "latestVersion": "string", "suiteDefinitionArn": "string", "suiteDefinitionConfiguration": { "devicePermissionRoleArn": "string", "devices": [ { "certificateArn": "string", "thingArn": "string" } ], "intendedForQualification": boolean, "rootGroup": "string", "suiteDefinitionName": "string" }, "suiteDefinitionId": "string", "suiteDefinitionVersion": "string", "tags": { "string" : "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

Gets the timestamp of the time suite was created with GetSuiteDefinition API call.

Type: Timestamp

lastModifiedAt

Gets the timestamp of the time suite was modified with GetSuiteDefinition API call.

Type: Timestamp

latestVersion

Gets latest suite definition version with GetSuiteDefinition API call.

Type: String

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

suiteDefinitionArn

The ARN of the suite definition.

Type: String

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

suiteDefinitionConfiguration

Gets the suite configuration with GetSuiteDefinition API call.

Type: SuiteDefinitionConfiguration object

suiteDefinitionId

Gets suite definition Id with GetSuiteDefinition API call.

Type: String

Length Constraints: Fixed length of 36.

suiteDefinitionVersion

Gets suite definition version with GetSuiteDefinition API call.

Type: String

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

tags

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

Errors

InternalServerException

Sends Internal Failure Exception.

HTTP Status Code: 500

ResourceNotFoundException

Sends Resource Not Found Exception.

HTTP Status Code: 404

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: