ListEvaluators
Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.
Request Syntax
POST /evaluators?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of evaluators to return in a single response.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The pagination token from a previous request to retrieve the next page of results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"evaluators": [
{
"createdAt": number,
"description": "string",
"evaluatorArn": "string",
"evaluatorId": "string",
"evaluatorName": "string",
"evaluatorType": "string",
"level": "string",
"lockedForModification": boolean,
"status": "string",
"updatedAt": number
}
],
"nextToken": "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.
- evaluators
-
The list of evaluator summaries containing basic information about each evaluator.
Type: Array of EvaluatorSummary objects
- nextToken
-
The pagination token to use in a subsequent request to retrieve the next page of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This exception is thrown when a request is denied per access permissions
HTTP Status Code: 403
- InternalServerException
-
This exception is thrown if there was an unexpected error during processing of request
HTTP Status Code: 500
- ThrottlingException
-
This exception is thrown when the number of requests exceeds the limit
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
