aws_sdk_personalize/client/
create_batch_inference_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateBatchInferenceJob`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_name(impl Into<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_job_name):<br>required: **true**<br><p>The name of the batch inference job to create.</p><br>
7    ///   - [`solution_version_arn(impl Into<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::solution_version_arn) / [`set_solution_version_arn(Option<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_solution_version_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.</p><br>
8    ///   - [`filter_arn(impl Into<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::filter_arn) / [`set_filter_arn(Option<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_filter_arn):<br>required: **false**<br><p>The ARN of the filter to apply to the batch inference job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</p><br>
9    ///   - [`num_results(i32)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::num_results) / [`set_num_results(Option<i32>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_num_results):<br>required: **false**<br><p>The number of recommendations to retrieve.</p><br>
10    ///   - [`job_input(BatchInferenceJobInput)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::job_input) / [`set_job_input(Option<BatchInferenceJobInput>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_job_input):<br>required: **true**<br><p>The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.</p><br>
11    ///   - [`job_output(BatchInferenceJobOutput)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::job_output) / [`set_job_output(Option<BatchInferenceJobOutput>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_job_output):<br>required: **true**<br><p>The path to the Amazon S3 bucket where the job's output will be stored.</p><br>
12    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</p><br>
13    ///   - [`batch_inference_job_config(BatchInferenceJobConfig)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::batch_inference_job_config) / [`set_batch_inference_job_config(Option<BatchInferenceJobConfig>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_batch_inference_job_config):<br>required: **false**<br><p>The configuration details of a batch inference job.</p><br>
14    ///   - [`tags(Tag)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_tags):<br>required: **false**<br><p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch inference job.</p><br>
15    ///   - [`batch_inference_job_mode(BatchInferenceJobMode)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::batch_inference_job_mode) / [`set_batch_inference_job_mode(Option<BatchInferenceJobMode>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_batch_inference_job_mode):<br>required: **false**<br><p>The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to <code>THEME_GENERATION</code>. If you don't want to generate themes, use the default <code>BATCH_INFERENCE</code>.</p> <p>When you get batch recommendations with themes, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>.</p><br>
16    ///   - [`theme_generation_config(ThemeGenerationConfig)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::theme_generation_config) / [`set_theme_generation_config(Option<ThemeGenerationConfig>)`](crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::set_theme_generation_config):<br>required: **false**<br><p>For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.</p><br>
17    /// - On success, responds with [`CreateBatchInferenceJobOutput`](crate::operation::create_batch_inference_job::CreateBatchInferenceJobOutput) with field(s):
18    ///   - [`batch_inference_job_arn(Option<String>)`](crate::operation::create_batch_inference_job::CreateBatchInferenceJobOutput::batch_inference_job_arn): <p>The ARN of the batch inference job.</p>
19    /// - On failure, responds with [`SdkError<CreateBatchInferenceJobError>`](crate::operation::create_batch_inference_job::CreateBatchInferenceJobError)
20    pub fn create_batch_inference_job(&self) -> crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder {
21        crate::operation::create_batch_inference_job::builders::CreateBatchInferenceJobFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_personalize/client/create_batch_inference_job.rs

aws_sdk_personalize/client/
create_batch_inference_job.rs
