aws-sdk-bedrock 1.145.0

AWS SDK for Amazon Bedrock
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_model_invocation_jobs::_list_model_invocation_jobs_input::ListModelInvocationJobsInputBuilder;

pub use crate::operation::list_model_invocation_jobs::_list_model_invocation_jobs_output::ListModelInvocationJobsOutputBuilder;

impl crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_model_invocation_jobs::ListModelInvocationJobsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_model_invocation_jobs();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListModelInvocationJobs`.
///
/// <p>Lists all batch inference jobs in the account. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-view.html">View details about a batch inference job</a>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListModelInvocationJobsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput,
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobsError,
    > for ListModelInvocationJobsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput,
            crate::operation::list_model_invocation_jobs::ListModelInvocationJobsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListModelInvocationJobsFluentBuilder {
    /// Creates a new `ListModelInvocationJobsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the ListModelInvocationJobs as a reference.
    pub fn as_input(&self) -> &crate::operation::list_model_invocation_jobs::builders::ListModelInvocationJobsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_model_invocation_jobs::ListModelInvocationJobsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::list_model_invocation_jobs::ListModelInvocationJobs::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobs::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobsOutput,
        crate::operation::list_model_invocation_jobs::ListModelInvocationJobsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::list_model_invocation_jobs::paginator::ListModelInvocationJobsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_model_invocation_jobs::paginator::ListModelInvocationJobsPaginator {
        crate::operation::list_model_invocation_jobs::paginator::ListModelInvocationJobsPaginator::new(self.handle, self.inner)
    }
    /// <p>Specify a time to filter for batch inference jobs that were submitted after the time you specify.</p>
    pub fn submit_time_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.submit_time_after(input);
        self
    }
    /// <p>Specify a time to filter for batch inference jobs that were submitted after the time you specify.</p>
    pub fn set_submit_time_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_submit_time_after(input);
        self
    }
    /// <p>Specify a time to filter for batch inference jobs that were submitted after the time you specify.</p>
    pub fn get_submit_time_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_submit_time_after()
    }
    /// <p>Specify a time to filter for batch inference jobs that were submitted before the time you specify.</p>
    pub fn submit_time_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.submit_time_before(input);
        self
    }
    /// <p>Specify a time to filter for batch inference jobs that were submitted before the time you specify.</p>
    pub fn set_submit_time_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_submit_time_before(input);
        self
    }
    /// <p>Specify a time to filter for batch inference jobs that were submitted before the time you specify.</p>
    pub fn get_submit_time_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_submit_time_before()
    }
    /// <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 Services Support 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>
    pub fn status_equals(mut self, input: crate::types::ModelInvocationJobStatus) -> Self {
        self.inner = self.inner.status_equals(input);
        self
    }
    /// <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 Services Support 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>
    pub fn set_status_equals(mut self, input: ::std::option::Option<crate::types::ModelInvocationJobStatus>) -> Self {
        self.inner = self.inner.set_status_equals(input);
        self
    }
    /// <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 Services Support 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>
    pub fn get_status_equals(&self) -> &::std::option::Option<crate::types::ModelInvocationJobStatus> {
        self.inner.get_status_equals()
    }
    /// <p>Specify a string to filter for batch inference jobs whose names contain the string.</p>
    pub fn name_contains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.name_contains(input.into());
        self
    }
    /// <p>Specify a string to filter for batch inference jobs whose names contain the string.</p>
    pub fn set_name_contains(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_name_contains(input);
        self
    }
    /// <p>Specify a string to filter for batch inference jobs whose names contain the string.</p>
    pub fn get_name_contains(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_name_contains()
    }
    /// <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>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <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>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <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>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <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>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <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>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <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>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <p>An attribute by which to sort the results.</p>
    pub fn sort_by(mut self, input: crate::types::SortJobsBy) -> Self {
        self.inner = self.inner.sort_by(input);
        self
    }
    /// <p>An attribute by which to sort the results.</p>
    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::SortJobsBy>) -> Self {
        self.inner = self.inner.set_sort_by(input);
        self
    }
    /// <p>An attribute by which to sort the results.</p>
    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::SortJobsBy> {
        self.inner.get_sort_by()
    }
    /// <p>Specifies whether to sort the results by ascending or descending order.</p>
    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
        self.inner = self.inner.sort_order(input);
        self
    }
    /// <p>Specifies whether to sort the results by ascending or descending order.</p>
    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
        self.inner = self.inner.set_sort_order(input);
        self
    }
    /// <p>Specifies whether to sort the results by ascending or descending order.</p>
    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
        self.inner.get_sort_order()
    }
}