CreateSuiteDefinition
Creates a Device Advisor test suite.
Requires permission to access the CreateSuiteDefinition action.
Request Syntax
POST /suiteDefinitions HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"suiteDefinitionConfiguration": {
"devicePermissionRoleArn": "string",
"devices": [
{
"certificateArn": "string",
"deviceRoleArn": "string",
"thingArn": "string"
}
],
"intendedForQualification": boolean,
"isLongDurationTest": boolean,
"protocol": "string",
"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.
- clientToken
-
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\u0021-\u007E]+$Required: No
- suiteDefinitionConfiguration
-
Creates a Device Advisor test suite with suite definition configuration.
Type: SuiteDefinitionConfiguration object
Required: Yes
-
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
-
The timestamp of when the test suite was created.
Type: Timestamp
- suiteDefinitionArn
-
The Amazon Resource Name (ARN) of the test suite.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- suiteDefinitionId
-
The UUID of the test suite created.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 36.
- suiteDefinitionName
-
The suite definition name of the test suite. This is a required parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
- InternalServerException
-
Sends an Internal Failure exception.
HTTP Status Code: 500
- ValidationException
-
Sends a validation 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:
