ListModels
Lists all available AI models that can be used for workflow execution, including their status and compatibility information.
Request Syntax
POST /models?clientCompatibilityVersion=clientCompatibilityVersion HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- clientCompatibilityVersion
-
The client compatibility version to filter models by compatibility.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"compatibilityInformation": {
"clientCompatibilityVersion": number,
"message": "string",
"supportedModelIds": [ "string" ]
},
"modelAliases": [
{
"aliasName": "string",
"latestModelId": "string",
"resolvedModelId": "string"
}
],
"modelSummaries": [
{
"minimumCompatibilityVersion": number,
"modelId": "string",
"modelLifecycle": {
"status": "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.
- compatibilityInformation
-
Information about client compatibility and supported models.
Type: CompatibilityInformation object
- modelAliases
-
A list of model aliases that provide stable references to model versions.
Type: Array of ModelAlias objects
- modelSummaries
-
A list of available AI models with their status and compatibility information.
Type: Array of ModelSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permissions to perform this action.
- message
-
You don't have sufficient permissions to perform this action. Verify your IAM permissions and try again.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Please try again later.
- message
-
The service encountered an internal error. Try again later.
- reason
-
The reason for the internal server error.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
HTTP Status Code: 500
- ThrottlingException
-
The request was throttled due to too many requests. Please try again later.
- message
-
The request was denied due to request throttling.
- quotaCode
-
The quota code related to the throttling.
- retryAfterSeconds
-
The number of seconds to wait before retrying the throttled request.
- serviceCode
-
The service code where throttling occurred.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
