ListFoundationModels
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
Request Syntax
GET /foundation-models?byCustomizationType=byCustomizationType&byInferenceType=byInferenceType&byOutputModality=byOutputModality&byProvider=byProvider HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- byCustomizationType
-
Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
Valid Values:
FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION - byInferenceType
-
Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Valid Values:
ON_DEMAND | PROVISIONED - byOutputModality
-
Return models that support the output modality that you specify.
Valid Values:
TEXT | IMAGE | EMBEDDING - byProvider
-
Return models belonging to the model provider that you specify.
Pattern:
^[A-Za-z0-9- ]{1,63}$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"modelSummaries": [
{
"customizationsSupported": [ "string" ],
"inferenceTypesSupported": [ "string" ],
"inputModalities": [ "string" ],
"modelArn": "string",
"modelId": "string",
"modelLifecycle": {
"status": "string"
},
"modelName": "string",
"outputModalities": [ "string" ],
"providerName": "string",
"responseStreamingSupported": boolean
}
]
}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.
- modelSummaries
-
A list of Amazon Bedrock foundation models.
Type: Array of FoundationModelSummary 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:
