aws_sdk_bedrock/client/

list_model_invocation_jobs.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListModelInvocationJobs`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`submit_time_after(DateTime)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::submit_time_after) / [`set_submit_time_after(Option<DateTime>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_submit_time_after):<br>required: **false**<br><p>Specify a time to filter for batch inference jobs that were submitted after the time you specify.</p><br>
    ///   - [`submit_time_before(DateTime)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::submit_time_before) / [`set_submit_time_before(Option<DateTime>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_submit_time_before):<br>required: **false**<br><p>Specify a time to filter for batch inference jobs that were submitted before the time you specify.</p><br>
    ///   - [`status_equals(ModelInvocationJobStatus)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::status_equals) / [`set_status_equals(Option<ModelInvocationJobStatus>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_status_equals):<br>required: **false**<br><p>Specify a status to filter for batch inference jobs whose statuses match the string you specify.</p> <p>The following statuses are possible:</p> <ul>  <li>   <p>Submitted – This job has been submitted to a queue for validation.</p></li>  <li>   <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p>   <ul>    <li>     <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p></li>    <li>     <p>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 <code>modelInput</code> value matches the request body for the model.</p></li>    <li>     <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p></li>   </ul></li>  <li>   <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p></li>  <li>   <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p></li>  <li>   <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p></li>  <li>   <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p></li>  <li>   <p>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.</p></li>  <li>   <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web ServicesSupport Center</a>.</p></li>  <li>   <p>Stopped – This job was stopped by a user.</p></li>  <li>   <p>Stopping – This job is being stopped by a user.</p></li> </ul><br>
    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_name_contains):<br>required: **false**<br><p>Specify a string to filter for batch inference jobs whose names contain the string.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return. If there are more results than the number that you specify, a <code>nextToken</code> value is returned. Use the <code>nextToken</code> in a request to return the next batch of results.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>If there were more results than the value you specified in the <code>maxResults</code> field in a previous <code>ListModelInvocationJobs</code> request, the response would have returned a <code>nextToken</code> value. To see the next batch of results, send the <code>nextToken</code> value in another request.</p><br>
    ///   - [`sort_by(SortJobsBy)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::sort_by) / [`set_sort_by(Option<SortJobsBy>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_sort_by):<br>required: **false**<br><p>An attribute by which to sort the results.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::set_sort_order):<br>required: **false**<br><p>Specifies whether to sort the results by ascending or descending order.</p><br>
    /// - On success, responds with [`ListModelInvocationJobsOutput`](crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput::next_token): <p>If there are more results than can fit in the response, a <code>nextToken</code> is returned. Use the <code>nextToken</code> in a request to return the next batch of results.</p>
    ///   - [`invocation_job_summaries(Option<Vec::<ModelInvocationJobSummary>>)`](crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput::invocation_job_summaries): <p>A list of items, each of which contains a summary about a batch inference job.</p>
    /// - On failure, responds with [`SdkError<ListModelInvocationJobsError>`](crate::operation::list_model_invocation_jobs::ListModelInvocationJobsError)
    pub fn list_model_invocation_jobs(&self) -> crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder {
        crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsFluentBuilder::new(self.handle.clone())
    }
}