aws_sdk_machinelearning/operation/create_batch_prediction/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_batch_prediction::_create_batch_prediction_output::CreateBatchPredictionOutputBuilder;
3
4pub use crate::operation::create_batch_prediction::_create_batch_prediction_input::CreateBatchPredictionInputBuilder;
5
6impl crate::operation::create_batch_prediction::builders::CreateBatchPredictionInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_batch_prediction::CreateBatchPredictionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_batch_prediction::CreateBatchPredictionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_batch_prediction();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateBatchPrediction`.
24///
25/// <p>Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data files referenced by the <code>DataSource</code> as information sources.</p>
26/// <p><code>CreateBatchPrediction</code> is an asynchronous operation. In response to <code>CreateBatchPrediction</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>BatchPrediction</code> status to <code>PENDING</code>. After the <code>BatchPrediction</code> completes, Amazon ML sets the status to <code>COMPLETED</code>.</p>
27/// <p>You can poll for status updates by using the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter of the result. After the <code>COMPLETED</code> status appears, the results are available in the location specified by the <code>OutputUri</code> parameter.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct CreateBatchPredictionFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::create_batch_prediction::builders::CreateBatchPredictionInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::create_batch_prediction::CreateBatchPredictionOutput,
37        crate::operation::create_batch_prediction::CreateBatchPredictionError,
38    > for CreateBatchPredictionFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::create_batch_prediction::CreateBatchPredictionOutput,
46            crate::operation::create_batch_prediction::CreateBatchPredictionError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl CreateBatchPredictionFluentBuilder {
53    /// Creates a new `CreateBatchPredictionFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the CreateBatchPrediction as a reference.
62    pub fn as_input(&self) -> &crate::operation::create_batch_prediction::builders::CreateBatchPredictionInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::create_batch_prediction::CreateBatchPredictionOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::create_batch_prediction::CreateBatchPredictionError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::create_batch_prediction::CreateBatchPrediction::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::create_batch_prediction::CreateBatchPrediction::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::create_batch_prediction::CreateBatchPredictionOutput,
99        crate::operation::create_batch_prediction::CreateBatchPredictionError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
114    pub fn batch_prediction_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.batch_prediction_id(input.into());
116        self
117    }
118    /// <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
119    pub fn set_batch_prediction_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_batch_prediction_id(input);
121        self
122    }
123    /// <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
124    pub fn get_batch_prediction_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_batch_prediction_id()
126    }
127    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p>
128    pub fn batch_prediction_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.batch_prediction_name(input.into());
130        self
131    }
132    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p>
133    pub fn set_batch_prediction_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_batch_prediction_name(input);
135        self
136    }
137    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p>
138    pub fn get_batch_prediction_name(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_batch_prediction_name()
140    }
141    /// <p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations.</p>
142    pub fn ml_model_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.ml_model_id(input.into());
144        self
145    }
146    /// <p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations.</p>
147    pub fn set_ml_model_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_ml_model_id(input);
149        self
150    }
151    /// <p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations.</p>
152    pub fn get_ml_model_id(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_ml_model_id()
154    }
155    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
156    pub fn batch_prediction_data_source_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157        self.inner = self.inner.batch_prediction_data_source_id(input.into());
158        self
159    }
160    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
161    pub fn set_batch_prediction_data_source_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162        self.inner = self.inner.set_batch_prediction_data_source_id(input);
163        self
164    }
165    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
166    pub fn get_batch_prediction_data_source_id(&self) -> &::std::option::Option<::std::string::String> {
167        self.inner.get_batch_prediction_data_source_id()
168    }
169    /// <p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
170    /// <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
171    pub fn output_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
172        self.inner = self.inner.output_uri(input.into());
173        self
174    }
175    /// <p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
176    /// <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
177    pub fn set_output_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
178        self.inner = self.inner.set_output_uri(input);
179        self
180    }
181    /// <p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
182    /// <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
183    pub fn get_output_uri(&self) -> &::std::option::Option<::std::string::String> {
184        self.inner.get_output_uri()
185    }
186}
aws_sdk_machinelearning/operation/create_batch_prediction/builders.rs

aws_sdk_machinelearning/operation/create_batch_prediction/
builders.rs
