GetSuiteDefinition - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GetSuiteDefinition

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

suiteDefinitionId

Suite definition ID of the test suite to get.

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

Required: Yes

suiteDefinitionVersion

Suite definition version of the test suite to get.

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

Date (in Unix epoch time) when the suite definition was created.

Type: Timestamp

lastModifiedAt

Date (in Unix epoch time) when the suite definition was last modified.

Type: Timestamp

latestVersion

Latest suite definition version of the suite definition.

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

Suite configuration of the suite definition.

Type: SuiteDefinitionConfiguration object

suiteDefinitionId

Suite definition ID of the suite definition.

Type: String

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

suiteDefinitionVersion

Suite definition version of the suite definition.

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 an Internal Failure exception.

HTTP Status Code: 500

ResourceNotFoundException

Sends a Resource Not Found exception.

HTTP Status Code: 404

ValidationException

Sends a validation exception.

HTTP Status Code: 400

See Also

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