Skip to content

Create Dataset Export Job

personalize_create_dataset_export_job R Documentation

Creates a job that exports data from your dataset to an Amazon S3 bucket

Description

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 describe_dataset_export_job, 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.

Usage

personalize_create_dataset_export_job(jobName, datasetArn,
  ingestionMode, roleArn, jobOutput, tags)

Arguments

jobName

[required] The name for the dataset export job.

datasetArn

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

ingestionMode

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.

roleArn

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

jobOutput

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

tags

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

Value

A list with the following syntax: 

list(
  datasetExportJobArn = "string"
)

Request syntax

svc$create_dataset_export_job(
  jobName = "string",
  datasetArn = "string",
  ingestionMode = "BULK"|"PUT"|"ALL",
  roleArn = "string",
  jobOutput = list(
    s3DataDestination = list(
      path = "string",
      kmsKeyArn = "string"
    )
  ),
  tags = list(
    list(
      tagKey = "string",
      tagValue = "string"
    )
  )
)