Lists all batch inference jobs in the account¶

Description¶

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

Usage¶

bedrock_list_model_invocation_jobs(submitTimeAfter, submitTimeBefore,
  statusEquals, nameContains, maxResults, nextToken, sortBy, sortOrder)

Arguments¶

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.
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 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.
nameContains

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

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.
nextToken

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

An attribute by which to sort the results.
sortOrder

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

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  invocationJobSummaries = list(
    list(
      jobArn = "string",
      jobName = "string",
      modelId = "string",
      clientRequestToken = "string",
      roleArn = "string",
      status = "Submitted"|"InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|"PartiallyCompleted"|"Expired"|"Validating"|"Scheduled",
      message = "string",
      submitTime = as.POSIXct(
        "2015-01-01"
      ),
      lastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      endTime = as.POSIXct(
        "2015-01-01"
      ),
      inputDataConfig = list(
        s3InputDataConfig = list(
          s3InputFormat = "JSONL",
          s3Uri = "string",
          s3BucketOwner = "string"
        )
      ),
      outputDataConfig = list(
        s3OutputDataConfig = list(
          s3Uri = "string",
          s3EncryptionKeyId = "string",
          s3BucketOwner = "string"
        )
      ),
      vpcConfig = list(
        subnetIds = list(
          "string"
        ),
        securityGroupIds = list(
          "string"
        )
      ),
      timeoutDurationInHours = 123,
      jobExpirationTime = as.POSIXct(
        "2015-01-01"
      ),
      modelInvocationType = "InvokeModel"|"Converse",
      totalRecordCount = 123,
      processedRecordCount = 123,
      successRecordCount = 123,
      errorRecordCount = 123
    )
  )
)

Request syntax¶

svc$list_model_invocation_jobs(
  submitTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  submitTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  statusEquals = "Submitted"|"InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|"PartiallyCompleted"|"Expired"|"Validating"|"Scheduled",
  nameContains = "string",
  maxResults = 123,
  nextToken = "string",
  sortBy = "CreationTime",
  sortOrder = "Ascending"|"Descending"
)