GetPromptRouter
Retrieves details about a prompt router.
Request Syntax
GET /prompt-routers/promptRouterArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- promptRouterArn
-
The prompt router's ARN
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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.
- createdAt
-
When the router was created.
Type: Timestamp
- description
-
The router's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^([0-9a-zA-Z:.][ _-]?)+$ - fallbackModel
-
The router's fallback model.
Type: PromptRouterTargetModel object
- models
-
The router's models.
Type: Array of PromptRouterTargetModel objects
- promptRouterArn
-
The prompt router's ARN
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+$ - promptRouterName
-
The router's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^([0-9a-zA-Z][ _-]?)+$ - routingCriteria
-
The router's routing criteria.
Type: RoutingCriteria object
- status
-
The router's status.
Type: String
Valid Values:
AVAILABLE - type
-
The router's type.
Type: String
Valid Values:
custom | default - updatedAt
-
When the router was updated.
Type: Timestamp
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
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- 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:
