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.

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

source

pub fn as_input(&self) -> &CreateDatasetImportJobInputBuilder

Access the CreateDatasetImportJob as a reference.

source

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.

source

pub fn customize( self ) -> CustomizableOperation<CreateDatasetImportJobOutput, CreateDatasetImportJobError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

pub fn job_name(self, input: impl Into<String>) -> Self

The name for the dataset import job.

source

pub fn set_job_name(self, input: Option<String>) -> Self

The name for the dataset import job.

source

pub fn get_job_name(&self) -> &Option<String>

The name for the dataset import job.

source

pub fn dataset_arn(self, input: impl Into<String>) -> Self

The ARN of the dataset that receives the imported data.

source

pub fn set_dataset_arn(self, input: Option<String>) -> Self

The ARN of the dataset that receives the imported data.

source

pub fn get_dataset_arn(&self) -> &Option<String>

The ARN of the dataset that receives the imported data.

source

pub fn data_source(self, input: DataSource) -> Self

The Amazon S3 bucket that contains the training data to import.

source

pub fn set_data_source(self, input: Option<DataSource>) -> Self

The Amazon S3 bucket that contains the training data to import.

source

pub fn get_data_source(&self) -> &Option<DataSource>

The Amazon S3 bucket that contains the training data to import.

source

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.

source

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.

source

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.

source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of tags to apply to the dataset import job.

source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags to apply to the dataset import job.

source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A list of tags to apply to the dataset import job.

source

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 FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.

  • Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.

source

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 FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.

  • Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.

source

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 FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.

  • Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.

source

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

source

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

source

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

source§

fn clone(&self) -> CreateDatasetImportJobFluentBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CreateDatasetImportJobFluentBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more