pub struct CreateBatchInferenceJobFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateBatchInferenceJob.
Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.
To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.
For more information, see Creating a batch inference job .
If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.
For more information about generating themes, see Batch recommendations with themes from Content Generator .
You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
Implementations§
Source§impl CreateBatchInferenceJobFluentBuilder
impl CreateBatchInferenceJobFluentBuilder
Sourcepub fn as_input(&self) -> &CreateBatchInferenceJobInputBuilder
pub fn as_input(&self) -> &CreateBatchInferenceJobInputBuilder
Access the CreateBatchInferenceJob as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateBatchInferenceJobOutput, SdkError<CreateBatchInferenceJobError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateBatchInferenceJobOutput, SdkError<CreateBatchInferenceJobError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateBatchInferenceJobOutput, CreateBatchInferenceJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateBatchInferenceJobOutput, CreateBatchInferenceJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn job_name(self, input: impl Into<String>) -> Self
pub fn job_name(self, input: impl Into<String>) -> Self
The name of the batch inference job to create.
Sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The name of the batch inference job to create.
Sourcepub fn get_job_name(&self) -> &Option<String>
pub fn get_job_name(&self) -> &Option<String>
The name of the batch inference job to create.
Sourcepub fn solution_version_arn(self, input: impl Into<String>) -> Self
pub fn solution_version_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
Sourcepub fn set_solution_version_arn(self, input: Option<String>) -> Self
pub fn set_solution_version_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
Sourcepub fn get_solution_version_arn(&self) -> &Option<String>
pub fn get_solution_version_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
Sourcepub fn filter_arn(self, input: impl Into<String>) -> Self
pub fn filter_arn(self, input: impl Into<String>) -> Self
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
Sourcepub fn set_filter_arn(self, input: Option<String>) -> Self
pub fn set_filter_arn(self, input: Option<String>) -> Self
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
Sourcepub fn get_filter_arn(&self) -> &Option<String>
pub fn get_filter_arn(&self) -> &Option<String>
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
Sourcepub fn num_results(self, input: i32) -> Self
pub fn num_results(self, input: i32) -> Self
The number of recommendations to retrieve.
Sourcepub fn set_num_results(self, input: Option<i32>) -> Self
pub fn set_num_results(self, input: Option<i32>) -> Self
The number of recommendations to retrieve.
Sourcepub fn get_num_results(&self) -> &Option<i32>
pub fn get_num_results(&self) -> &Option<i32>
The number of recommendations to retrieve.
Sourcepub fn job_input(self, input: BatchInferenceJobInput) -> Self
pub fn job_input(self, input: BatchInferenceJobInput) -> Self
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
Sourcepub fn set_job_input(self, input: Option<BatchInferenceJobInput>) -> Self
pub fn set_job_input(self, input: Option<BatchInferenceJobInput>) -> Self
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
Sourcepub fn get_job_input(&self) -> &Option<BatchInferenceJobInput>
pub fn get_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.
Sourcepub fn job_output(self, input: BatchInferenceJobOutput) -> Self
pub fn job_output(self, input: BatchInferenceJobOutput) -> Self
The path to the Amazon S3 bucket where the job's output will be stored.
Sourcepub fn set_job_output(self, input: Option<BatchInferenceJobOutput>) -> Self
pub fn set_job_output(self, input: Option<BatchInferenceJobOutput>) -> Self
The path to the Amazon S3 bucket where the job's output will be stored.
Sourcepub fn get_job_output(&self) -> &Option<BatchInferenceJobOutput>
pub fn get_job_output(&self) -> &Option<BatchInferenceJobOutput>
The path to the Amazon S3 bucket where the job's output will be stored.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &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.
Sourcepub fn batch_inference_job_config(self, input: BatchInferenceJobConfig) -> Self
pub fn batch_inference_job_config(self, input: BatchInferenceJobConfig) -> Self
The configuration details of a batch inference job.
Sourcepub fn set_batch_inference_job_config(
self,
input: Option<BatchInferenceJobConfig>,
) -> Self
pub fn set_batch_inference_job_config( self, input: Option<BatchInferenceJobConfig>, ) -> Self
The configuration details of a batch inference job.
Sourcepub fn get_batch_inference_job_config(&self) -> &Option<BatchInferenceJobConfig>
pub fn get_batch_inference_job_config(&self) -> &Option<BatchInferenceJobConfig>
The configuration details of a batch inference job.
A list of tags to apply to the batch inference job.
A list of tags to apply to the batch inference job.
Sourcepub fn batch_inference_job_mode(self, input: BatchInferenceJobMode) -> Self
pub fn batch_inference_job_mode(self, input: BatchInferenceJobMode) -> Self
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.
Sourcepub fn set_batch_inference_job_mode(
self,
input: Option<BatchInferenceJobMode>,
) -> Self
pub fn set_batch_inference_job_mode( self, input: Option<BatchInferenceJobMode>, ) -> Self
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.
Sourcepub fn get_batch_inference_job_mode(&self) -> &Option<BatchInferenceJobMode>
pub fn get_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.
Sourcepub fn theme_generation_config(self, input: ThemeGenerationConfig) -> Self
pub fn theme_generation_config(self, input: ThemeGenerationConfig) -> Self
For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
Sourcepub fn set_theme_generation_config(
self,
input: Option<ThemeGenerationConfig>,
) -> Self
pub fn set_theme_generation_config( self, input: Option<ThemeGenerationConfig>, ) -> Self
For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
Sourcepub fn get_theme_generation_config(&self) -> &Option<ThemeGenerationConfig>
pub fn get_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.
Trait Implementations§
Source§impl Clone for CreateBatchInferenceJobFluentBuilder
impl Clone for CreateBatchInferenceJobFluentBuilder
Source§fn clone(&self) -> CreateBatchInferenceJobFluentBuilder
fn clone(&self) -> CreateBatchInferenceJobFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateBatchInferenceJobFluentBuilder
impl !RefUnwindSafe for CreateBatchInferenceJobFluentBuilder
impl Send for CreateBatchInferenceJobFluentBuilder
impl Sync for CreateBatchInferenceJobFluentBuilder
impl Unpin for CreateBatchInferenceJobFluentBuilder
impl !UnwindSafe for CreateBatchInferenceJobFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);