ListSuiteDefinitions
Lists the Device Advisor test suites you have created.
Requires permission to access the ListSuiteDefinitions action.
Request Syntax
GET /suiteDefinitions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return at once.
Valid Range: Minimum value of 1. Maximum value of 50.
- nextToken
-
A token used to get the next set of results.
Length Constraints: Maximum length of 2000.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"suiteDefinitionInformationList": [
{
"createdAt": number,
"defaultDevices": [
{
"certificateArn": "string",
"deviceRoleArn": "string",
"thingArn": "string"
}
],
"intendedForQualification": boolean,
"isLongDurationTest": boolean,
"protocol": "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.
- nextToken
-
A token used to get the next set of results.
Type: String
Length Constraints: Maximum length of 2000.
- suiteDefinitionInformationList
-
An array of objects that provide summaries of information about the suite definitions in the list.
Type: Array of SuiteDefinitionInformation objects
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 Amazon SDKs, see the following: