ListPromptRouters
Retrieves a list of prompt routers.
Request Syntax
GET /prompt-routers?maxResults=maxResults&nextToken=nextToken&type=type HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of prompt routers to return in one page of results.
Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
Specify the pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$ - type
-
The type of the prompt routers, such as whether it's default or custom.
Valid Values:
custom | default
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"promptRouterSummaries": [
{
"createdAt": "string",
"description": "string",
"fallbackModel": {
"modelArn": "string"
},
"models": [
{
"modelArn": "string"
}
],
"promptRouterArn": "string",
"promptRouterName": "string",
"routingCriteria": {
"responseQualityDifference": number
},
"status": "string",
"type": "string",
"updatedAt": "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
-
Specify the pagination token from a previous request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$ - promptRouterSummaries
-
A list of prompt router summaries.
Type: Array of PromptRouterSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
