aws_sdk_sagemaker/client/

create_inference_recommendations_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateInferenceRecommendationsJob`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_name(impl Into<String>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_job_name):<br>required: **true**<br><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><br>
    ///   - [`job_type(RecommendationJobType)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::job_type) / [`set_job_type(Option<RecommendationJobType>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_job_type):<br>required: **true**<br><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><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p><br>
    ///   - [`input_config(RecommendationJobInputConfig)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::input_config) / [`set_input_config(Option<RecommendationJobInputConfig>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_input_config):<br>required: **true**<br><p>Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.</p><br>
    ///   - [`job_description(impl Into<String>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::job_description) / [`set_job_description(Option<String>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_job_description):<br>required: **false**<br><p>Description of the recommendation job.</p><br>
    ///   - [`stopping_conditions(RecommendationJobStoppingConditions)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::stopping_conditions) / [`set_stopping_conditions(Option<RecommendationJobStoppingConditions>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_stopping_conditions):<br>required: **false**<br><p>A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.</p><br>
    ///   - [`output_config(RecommendationJobOutputConfig)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::output_config) / [`set_output_config(Option<RecommendationJobOutputConfig>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_output_config):<br>required: **false**<br><p>Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::set_tags):<br>required: **false**<br><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><br>
    /// - On success, responds with [`CreateInferenceRecommendationsJobOutput`](crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobOutput) with field(s):
    ///   - [`job_arn(Option<String>)`](crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the recommendation job.</p>
    /// - On failure, responds with [`SdkError<CreateInferenceRecommendationsJobError>`](crate::operation::create_inference_recommendations_job::CreateInferenceRecommendationsJobError)
    pub fn create_inference_recommendations_job(
        &self,
    ) -> crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder {
        crate::operation::create_inference_recommendations_job::builders::CreateInferenceRecommendationsJobFluentBuilder::new(self.handle.clone())
    }
}