ListModelInvocationJobs
Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
Request Syntax
GET /model-invocation-jobs?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals&submitTimeAfter=submitTimeAfter&submitTimeBefore=submitTimeBefore HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return. If there are more results than the number that you specify, a
nextTokenvalue is returned. Use thenextTokenin a request to return the next batch of results.Valid Range: Minimum value of 1. Maximum value of 1000.
- nameContains
-
Specify a string to filter for batch inference jobs whose names contain the string.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}$ - nextToken
-
If there were more results than the value you specified in the
maxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue. To see the next batch of results, send thenextTokenvalue in another request.Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$ - sortBy
-
An attribute by which to sort the results.
Valid Values:
CreationTime - sortOrder
-
Specifies whether to sort the results by ascending or descending order.
Valid Values:
Ascending | Descending - statusEquals
-
Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Support Center
. -
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
Valid Values:
Submitted | InProgress | Completed | Failed | Stopping | Stopped | PartiallyCompleted | Expired | Validating | Scheduled -
- submitTimeAfter
-
Specify a time to filter for batch inference jobs that were submitted after the time you specify.
- submitTimeBefore
-
Specify a time to filter for batch inference jobs that were submitted before the time you specify.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"invocationJobSummaries": [
{
"clientRequestToken": "string",
"endTime": "string",
"inputDataConfig": { ... },
"jobArn": "string",
"jobExpirationTime": "string",
"jobName": "string",
"lastModifiedTime": "string",
"message": "string",
"modelId": "string",
"outputDataConfig": { ... },
"roleArn": "string",
"status": "string",
"submitTime": "string",
"timeoutDurationInHours": number,
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "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.
- invocationJobSummaries
-
A list of items, each of which contains a summary about a batch inference job.
Type: Array of ModelInvocationJobSummary objects
- nextToken
-
If there are more results than can fit in the response, a
nextTokenis returned. Use thenextTokenin a request 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 up to ten model invocation jobs
This example illustrates one usage of ListModelInvocationJobs.
GET /model-invocation-jobs?maxResults=10&sortBy=CreationTime&sortOrder=Descending HTTP/1.1See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
