Struct aws_sdk_personalize::client::fluent_builders::CreateDatasetImportJob

pub struct CreateDatasetImportJob { /* private fields */ }

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

• ListDatasetImportJobs

• DescribeDatasetImportJob

Implementations

impl CreateDatasetImportJob

pub async fn send(
    self
) -> Result<CreateDatasetImportJobOutput, SdkError<CreateDatasetImportJobError>>

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.

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

The name for the dataset import job.

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

The name for the dataset import job.

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

The ARN of the dataset that receives the imported data.

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

The ARN of the dataset that receives the imported data.

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

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

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

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

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.

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.

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.

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

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

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.

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.

Trait Implementations

impl Clone for CreateDatasetImportJob

fn clone(&self) -> CreateDatasetImportJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDatasetImportJob

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

Formats the value using the given formatter.