Struct aws_sdk_personalize::client::fluent_builders::CreateDatasetExportJob

pub struct CreateDatasetExportJob<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateDatasetExportJob.

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

A dataset export job can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export 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.

Implementations

impl<C, M, R> CreateDatasetExportJob<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateDatasetExportJobOutput, SdkError<CreateDatasetExportJobError>> where
    R::Policy: SmithyRetryPolicy<CreateDatasetExportJobInputOperationOutputAlias, CreateDatasetExportJobOutput, CreateDatasetExportJobError, CreateDatasetExportJobInputOperationRetryAlias>, 

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, inp: impl Into<String>) -> Self

The name for the dataset export job.

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

The name for the dataset export job.

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

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

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

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

pub fn ingestion_mode(self, inp: IngestionMode) -> Self

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

pub fn set_ingestion_mode(self, input: Option<IngestionMode>) -> Self

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

pub fn role_arn(self, inp: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

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

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

pub fn job_output(self, inp: DatasetExportJobOutput) -> Self

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

pub fn set_job_output(self, input: Option<DatasetExportJobOutput>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateDatasetExportJob<C, M, R>

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

Formats the value using the given formatter.