ListCustomModels
Returns a list of the custom models that you have created with the CreateModelCustomizationJob
operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
Request Syntax
GET /custom-models?baseModelArnEquals=baseModelArnEquals
&creationTimeAfter=creationTimeAfter
&creationTimeBefore=creationTimeBefore
&foundationModelArnEquals=foundationModelArnEquals
&maxResults=maxResults
&nameContains=nameContains
&nextToken=nextToken
&sortBy=sortBy
&sortOrder=sortOrder
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- baseModelArnEquals
-
Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$
- creationTimeAfter
-
Return custom models created after the specified time.
- creationTimeBefore
-
Return custom models created before the specified time.
- foundationModelArnEquals
-
Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$
- maxResults
-
Maximum number of results to return in the response.
Valid Range: Minimum value of 1. Maximum value of 1000.
- nameContains
-
Return custom models only if the job name contains these characters.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^([0-9a-zA-Z][_-]?)+$
- nextToken
-
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$
- sortBy
-
The field to sort by in the returned list of models.
Valid Values:
CreationTime
- sortOrder
-
The sort order of the results.
Valid Values:
Ascending | Descending
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"modelSummaries": [
{
"baseModelArn": "string",
"baseModelName": "string",
"creationTime": "string",
"customizationType": "string",
"modelArn": "string",
"modelName": "string"
}
],
"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.
- modelSummaries
-
Model summaries.
Type: Array of CustomModelSummary objects
- nextToken
-
Continuation token for the next request to list the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$
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: