ListModelImportJobs
Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
Request Syntax
GET /model-import-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- creationTimeAfter
-
Return import jobs that were created after the specified time.
- creationTimeBefore
-
Return import jobs that were created before the specified time.
- maxResults
-
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.Valid Range: Minimum value of 1. Maximum value of 1000.
- nameContains
-
Return imported jobs only if the job name contains these characters.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*$ - nextToken
-
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch 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 imported jobs.
Valid Values:
CreationTime - sortOrder
-
Specifies whether to sort the results in ascending or descending order.
Valid Values:
Ascending | Descending - statusEquals
-
Return imported jobs with the specified status.
Valid Values:
InProgress | Completed | Failed
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"modelImportJobSummaries": [
{
"creationTime": "string",
"endTime": "string",
"importedModelArn": "string",
"importedModelName": "string",
"jobArn": "string",
"jobName": "string",
"lastModifiedTime": "string",
"status": "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.
- modelImportJobSummaries
-
Import job summaries.
Type: Array of ModelImportJobSummary objects
- nextToken
-
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch 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
Examples
List model import jobs
Gets a list of the import jobs that you have submitted.
GET /model-import-jobs/ HTTP/1.1 Content-type: application/json
Example response
Response for the above request.
HTTP/1.1 200 Content-type: application/json { "modelImportJobSummaries": [ { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml", "jobName": "MyImportedModelJobName", "status": "InProgress", "lastModifiedTime": "2024-08-13T23:40:47.517Z", "creationTime": "2024-08-13T23:38:42.457Z", "importedModelName": "ImportedModelName" }, { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/dchh9ny8e0dv", "jobName": "SomeJobName", "status": "Completed", "lastModifiedTime": "2024-08-13T19:36:33.674Z", "creationTime": "2024-08-13T19:20:14.058Z", "endTime": "2024-08-13T19:36:33.492Z", "importedModelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud", "importedModelName": "SomeImportedModelName" } ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
