aws_sdk_sagemaker/operation/create_inference_recommendations_job/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_inference_recommendations_job::_create_inference_recommendations_job_output::CreateInferenceRecommendationsJobOutputBuilder;
3
4pub use crate::operation::create_inference_recommendations_job::_create_inference_recommendations_job_input::CreateInferenceRecommendationsJobInputBuilder;
5
6impl crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobInputBuilder {
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_inference_recommendations_job::CreateInferenceRecommendationsJobOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_inference_recommendations_job();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateInferenceRecommendationsJob`.
24///
25/// <p>Starts a recommendation job. You can create either an instance recommendation or load test job.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateInferenceRecommendationsJobFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobOutput,
35        crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobError,
36    > for CreateInferenceRecommendationsJobFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobOutput,
44            crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateInferenceRecommendationsJobFluentBuilder {
51    /// Creates a new `CreateInferenceRecommendationsJobFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateInferenceRecommendationsJob as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJob::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJob::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobOutput,
97        crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.</p>
112    pub fn job_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.job_name(input.into());
114        self
115    }
116    /// <p>A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.</p>
117    pub fn set_job_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_job_name(input);
119        self
120    }
121    /// <p>A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.</p>
122    pub fn get_job_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_job_name()
124    }
125    /// <p>Defines the type of recommendation job. Specify <code>Default</code> to initiate an instance recommendation and <code>Advanced</code> to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (<code>DEFAULT</code>) job.</p>
126    pub fn job_type(mut self, input: crate::types::RecommendationJobType) -> Self {
127        self.inner = self.inner.job_type(input);
128        self
129    }
130    /// <p>Defines the type of recommendation job. Specify <code>Default</code> to initiate an instance recommendation and <code>Advanced</code> to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (<code>DEFAULT</code>) job.</p>
131    pub fn set_job_type(mut self, input: ::std::option::Option<crate::types::RecommendationJobType>) -> Self {
132        self.inner = self.inner.set_job_type(input);
133        self
134    }
135    /// <p>Defines the type of recommendation job. Specify <code>Default</code> to initiate an instance recommendation and <code>Advanced</code> to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (<code>DEFAULT</code>) job.</p>
136    pub fn get_job_type(&self) -> &::std::option::Option<crate::types::RecommendationJobType> {
137        self.inner.get_job_type()
138    }
139    /// <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
140    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.role_arn(input.into());
142        self
143    }
144    /// <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
145    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_role_arn(input);
147        self
148    }
149    /// <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
150    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_role_arn()
152    }
153    /// <p>Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.</p>
154    pub fn input_config(mut self, input: crate::types::RecommendationJobInputConfig) -> Self {
155        self.inner = self.inner.input_config(input);
156        self
157    }
158    /// <p>Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.</p>
159    pub fn set_input_config(mut self, input: ::std::option::Option<crate::types::RecommendationJobInputConfig>) -> Self {
160        self.inner = self.inner.set_input_config(input);
161        self
162    }
163    /// <p>Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.</p>
164    pub fn get_input_config(&self) -> &::std::option::Option<crate::types::RecommendationJobInputConfig> {
165        self.inner.get_input_config()
166    }
167    /// <p>Description of the recommendation job.</p>
168    pub fn job_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.job_description(input.into());
170        self
171    }
172    /// <p>Description of the recommendation job.</p>
173    pub fn set_job_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_job_description(input);
175        self
176    }
177    /// <p>Description of the recommendation job.</p>
178    pub fn get_job_description(&self) -> &::std::option::Option<::std::string::String> {
179        self.inner.get_job_description()
180    }
181    /// <p>A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.</p>
182    pub fn stopping_conditions(mut self, input: crate::types::RecommendationJobStoppingConditions) -> Self {
183        self.inner = self.inner.stopping_conditions(input);
184        self
185    }
186    /// <p>A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.</p>
187    pub fn set_stopping_conditions(mut self, input: ::std::option::Option<crate::types::RecommendationJobStoppingConditions>) -> Self {
188        self.inner = self.inner.set_stopping_conditions(input);
189        self
190    }
191    /// <p>A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.</p>
192    pub fn get_stopping_conditions(&self) -> &::std::option::Option<crate::types::RecommendationJobStoppingConditions> {
193        self.inner.get_stopping_conditions()
194    }
195    /// <p>Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.</p>
196    pub fn output_config(mut self, input: crate::types::RecommendationJobOutputConfig) -> Self {
197        self.inner = self.inner.output_config(input);
198        self
199    }
200    /// <p>Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.</p>
201    pub fn set_output_config(mut self, input: ::std::option::Option<crate::types::RecommendationJobOutputConfig>) -> Self {
202        self.inner = self.inner.set_output_config(input);
203        self
204    }
205    /// <p>Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.</p>
206    pub fn get_output_config(&self) -> &::std::option::Option<crate::types::RecommendationJobOutputConfig> {
207        self.inner.get_output_config()
208    }
209    ///
210    /// Appends an item to `Tags`.
211    ///
212    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
213    ///
214    /// <p>The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference.</p>
215    pub fn tags(mut self, input: crate::types::Tag) -> Self {
216        self.inner = self.inner.tags(input);
217        self
218    }
219    /// <p>The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference.</p>
220    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
221        self.inner = self.inner.set_tags(input);
222        self
223    }
224    /// <p>The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference.</p>
225    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
226        self.inner.get_tags()
227    }
228}
aws_sdk_sagemaker/operation/create_inference_recommendations_job/builders.rs

aws_sdk_sagemaker/operation/create_inference_recommendations_job/
builders.rs
