UpdateSuiteDefinition
Updates a Device Advisor test suite.
Requires permission to access the UpdateSuiteDefinition action.
Request Syntax
PATCH /suiteDefinitions/suiteDefinitionId HTTP/1.1
Content-type: application/json
{
"suiteDefinitionConfiguration": {
"devicePermissionRoleArn": "string",
"devices": [
{
"certificateArn": "string",
"deviceRoleArn": "string",
"thingArn": "string"
}
],
"intendedForQualification": boolean,
"isLongDurationTest": boolean,
"protocol": "string",
"rootGroup": "string",
"suiteDefinitionName": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- suiteDefinitionId
-
Suite definition ID of the test suite to be updated.
Length Constraints: Minimum length of 12. Maximum length of 36.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- suiteDefinitionConfiguration
-
Updates a Device Advisor test suite with suite definition configuration.
Type: SuiteDefinitionConfiguration object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"lastUpdatedAt": number,
"suiteDefinitionArn": "string",
"suiteDefinitionId": "string",
"suiteDefinitionName": "string",
"suiteDefinitionVersion": "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
-
Timestamp of when the test suite was created.
Type: Timestamp
- lastUpdatedAt
-
Timestamp of when the test suite was updated.
Type: Timestamp
- suiteDefinitionArn
-
Amazon Resource Name (ARN) of the updated test suite.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- suiteDefinitionId
-
Suite definition ID of the updated test suite.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 36.
- suiteDefinitionName
-
Updates the suite definition name. This is a required parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- suiteDefinitionVersion
-
Suite definition version of the updated test suite.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 255.
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:
