aws_sdk_personalize/client/
create_batch_segment_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 [`CreateBatchSegmentJob`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_name(impl Into<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::set_job_name):<br>required: **true**<br><p>The name of the batch segment job to create.</p><br>
7    ///   - [`solution_version_arn(impl Into<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::solution_version_arn) / [`set_solution_version_arn(Option<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::set_solution_version_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.</p><br>
8    ///   - [`filter_arn(impl Into<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::filter_arn) / [`set_filter_arn(Option<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::set_filter_arn):<br>required: **false**<br><p>The ARN of the filter to apply to the batch segment 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_segment_job::builders::CreateBatchSegmentJobFluentBuilder::num_results) / [`set_num_results(Option<i32>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::set_num_results):<br>required: **false**<br><p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p><br>
10    ///   - [`job_input(BatchSegmentJobInput)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::job_input) / [`set_job_input(Option<BatchSegmentJobInput>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::set_job_input):<br>required: **true**<br><p>The Amazon S3 path for the input data used to generate the batch segment job.</p><br>
11    ///   - [`job_output(BatchSegmentJobOutput)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::job_output) / [`set_job_output(Option<BatchSegmentJobOutput>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::set_job_output):<br>required: **true**<br><p>The Amazon S3 path for the bucket where the job's output will be stored.</p><br>
12    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::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    ///   - [`tags(Tag)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::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 segment job.</p><br>
14    /// - On success, responds with [`CreateBatchSegmentJobOutput`](crate::operation::create_batch_segment_job::CreateBatchSegmentJobOutput) with field(s):
15    ///   - [`batch_segment_job_arn(Option<String>)`](crate::operation::create_batch_segment_job::CreateBatchSegmentJobOutput::batch_segment_job_arn): <p>The ARN of the batch segment job.</p>
16    /// - On failure, responds with [`SdkError<CreateBatchSegmentJobError>`](crate::operation::create_batch_segment_job::CreateBatchSegmentJobError)
17    pub fn create_batch_segment_job(&self) -> crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder {
18        crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_personalize/client/create_batch_segment_job.rs

aws_sdk_personalize/client/
create_batch_segment_job.rs
