pub struct CreateDatasetImportJobFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateDatasetImportJob.
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
Status
A dataset import job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
Implementations§
Source§impl CreateDatasetImportJobFluentBuilder
impl CreateDatasetImportJobFluentBuilder
Sourcepub fn as_input(&self) -> &CreateDatasetImportJobInputBuilder
pub fn as_input(&self) -> &CreateDatasetImportJobInputBuilder
Access the CreateDatasetImportJob as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateDatasetImportJobOutput, SdkError<CreateDatasetImportJobError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateDatasetImportJobOutput, SdkError<CreateDatasetImportJobError, 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<CreateDatasetImportJobOutput, CreateDatasetImportJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateDatasetImportJobOutput, CreateDatasetImportJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The name for the dataset import job.
Sourcepub fn get_job_name(&self) -> &Option<String>
pub fn get_job_name(&self) -> &Option<String>
The name for the dataset import job.
Sourcepub fn dataset_arn(self, input: impl Into<String>) -> Self
pub fn dataset_arn(self, input: impl Into<String>) -> Self
The ARN of the dataset that receives the imported data.
Sourcepub fn set_dataset_arn(self, input: Option<String>) -> Self
pub fn set_dataset_arn(self, input: Option<String>) -> Self
The ARN of the dataset that receives the imported data.
Sourcepub fn get_dataset_arn(&self) -> &Option<String>
pub fn get_dataset_arn(&self) -> &Option<String>
The ARN of the dataset that receives the imported data.
Sourcepub fn data_source(self, input: DataSource) -> Self
pub fn data_source(self, input: DataSource) -> Self
The Amazon S3 bucket that contains the training data to import.
Sourcepub fn set_data_source(self, input: Option<DataSource>) -> Self
pub fn set_data_source(self, input: Option<DataSource>) -> Self
The Amazon S3 bucket that contains the training data to import.
Sourcepub fn get_data_source(&self) -> &Option<DataSource>
pub fn get_data_source(&self) -> &Option<DataSource>
The Amazon S3 bucket that contains the training data to import.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
A list of tags to apply to the dataset import job.
A list of tags to apply to the dataset import job.
Sourcepub fn import_mode(self, input: ImportMode) -> Self
pub fn import_mode(self, input: ImportMode) -> Self
Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL.
-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
Sourcepub fn set_import_mode(self, input: Option<ImportMode>) -> Self
pub fn set_import_mode(self, input: Option<ImportMode>) -> Self
Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL.
-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
Sourcepub fn get_import_mode(&self) -> &Option<ImportMode>
pub fn get_import_mode(&self) -> &Option<ImportMode>
Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL.
-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
Sourcepub fn publish_attribution_metrics_to_s3(self, input: bool) -> Self
pub fn publish_attribution_metrics_to_s3(self, input: bool) -> Self
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
Sourcepub fn set_publish_attribution_metrics_to_s3(self, input: Option<bool>) -> Self
pub fn set_publish_attribution_metrics_to_s3(self, input: Option<bool>) -> Self
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
Sourcepub fn get_publish_attribution_metrics_to_s3(&self) -> &Option<bool>
pub fn get_publish_attribution_metrics_to_s3(&self) -> &Option<bool>
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
Trait Implementations§
Source§impl Clone for CreateDatasetImportJobFluentBuilder
impl Clone for CreateDatasetImportJobFluentBuilder
Source§fn clone(&self) -> CreateDatasetImportJobFluentBuilder
fn clone(&self) -> CreateDatasetImportJobFluentBuilder
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 CreateDatasetImportJobFluentBuilder
impl !RefUnwindSafe for CreateDatasetImportJobFluentBuilder
impl Send for CreateDatasetImportJobFluentBuilder
impl Sync for CreateDatasetImportJobFluentBuilder
impl Unpin for CreateDatasetImportJobFluentBuilder
impl !UnwindSafe for CreateDatasetImportJobFluentBuilder
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);