Skip to content

Bedrock  >  Operations  >  list_model_invocation_jobs

list_model_invocation_jobs

Operation

list_model_invocation_jobs async 

list_model_invocation_jobs(input: ListModelInvocationJobsInput, plugins: list[Plugin] | None = None) -> ListModelInvocationJobsOutput

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

Parameters:

Name Type Description Default
input ListModelInvocationJobsInput

An instance of ListModelInvocationJobsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListModelInvocationJobsOutput

An instance of ListModelInvocationJobsOutput.

Input

ListModelInvocationJobsInput dataclass

Dataclass for ListModelInvocationJobsInput structure.

Attributes

max_results class-attribute instance-attribute 
max_results: int | None = None

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

name_contains class-attribute instance-attribute 
name_contains: str | None = None

Specify a string to filter for batch inference jobs whose names contain the string.

next_token class-attribute instance-attribute 
next_token: str | None = None

If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

sort_by class-attribute instance-attribute 
sort_by: SortJobsBy | None = None

An attribute by which to sort the results.

sort_order class-attribute instance-attribute 
sort_order: SortOrder | None = None

Specifies whether to sort the results by ascending or descending order.

status_equals class-attribute instance-attribute 
status_equals: ModelInvocationJobStatus | None = None

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 modelInput value 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 Amazon Web Services Support Center.

  • Stopped -- This job was stopped by a user.

  • Stopping -- This job is being stopped by a user.

submit_time_after class-attribute instance-attribute 
submit_time_after: datetime | None = None

Specify a time to filter for batch inference jobs that were submitted after the time you specify.

submit_time_before class-attribute instance-attribute 
submit_time_before: datetime | None = None

Specify a time to filter for batch inference jobs that were submitted before the time you specify.

Output

ListModelInvocationJobsOutput dataclass

Dataclass for ListModelInvocationJobsOutput structure.

Attributes

invocation_job_summaries class-attribute instance-attribute 
invocation_job_summaries: list[ModelInvocationJobSummary] | None = None

A list of items, each of which contains a summary about a batch inference job.

next_token class-attribute instance-attribute 
next_token: str | None = None

If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.