Struct CreateBatchInferenceJobInput

#[non_exhaustive]
pub struct CreateBatchInferenceJobInput {
    pub job_name: Option<String>,
    pub solution_version_arn: Option<String>,
    pub filter_arn: Option<String>,
    pub num_results: Option<i32>,
    pub job_input: Option<BatchInferenceJobInput>,
    pub job_output: Option<BatchInferenceJobOutput>,
    pub role_arn: Option<String>,
    pub batch_inference_job_config: Option<BatchInferenceJobConfig>,
    pub tags: Option<Vec<Tag>>,
    pub batch_inference_job_mode: Option<BatchInferenceJobMode>,
    pub theme_generation_config: Option<ThemeGenerationConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_name: Option<String>

The name of the batch inference job to create.

solution_version_arn: Option<String>

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

filter_arn: Option<String>

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

num_results: Option<i32>

The number of recommendations to retrieve.

job_input: Option<BatchInferenceJobInput>

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

job_output: Option<BatchInferenceJobOutput>

The path to the Amazon S3 bucket where the job's output will be stored.

role_arn: Option<String>

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.

batch_inference_job_config: Option<BatchInferenceJobConfig>

The configuration details of a batch inference job.

tags: Option<Vec<Tag>>

A list of tags to apply to the batch inference job.

batch_inference_job_mode: Option<BatchInferenceJobMode>

The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

theme_generation_config: Option<ThemeGenerationConfig>

For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

Implementations

impl CreateBatchInferenceJobInput

pub fn job_name(&self) -> Option<&str>

The name of the batch inference job to create.

pub fn solution_version_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

pub fn filter_arn(&self) -> Option<&str>

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

pub fn num_results(&self) -> Option<i32>

The number of recommendations to retrieve.

pub fn job_input(&self) -> Option<&BatchInferenceJobInput>

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

pub fn job_output(&self) -> Option<&BatchInferenceJobOutput>

The path to the Amazon S3 bucket where the job's output will be stored.

pub fn role_arn(&self) -> Option<&str>

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.

pub fn batch_inference_job_config(&self) -> Option<&BatchInferenceJobConfig>

The configuration details of a batch inference job.

pub fn tags(&self) -> &[Tag]

A list of tags to apply to the batch inference job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn batch_inference_job_mode(&self) -> Option<&BatchInferenceJobMode>

The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

pub fn theme_generation_config(&self) -> Option<&ThemeGenerationConfig>

For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

impl CreateBatchInferenceJobInput

pub fn builder() -> CreateBatchInferenceJobInputBuilder

Creates a new builder-style object to manufacture CreateBatchInferenceJobInput.

Trait Implementations

impl Clone for CreateBatchInferenceJobInput

fn clone(&self) -> CreateBatchInferenceJobInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateBatchInferenceJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateBatchInferenceJobInput

fn eq(&self, other: &CreateBatchInferenceJobInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateBatchInferenceJobInput