Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466276261.1 KB

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.

post/#X-Amz-Target=AmazonPersonalize.CreateDatasetExportJob

Headers

X-Amz-Target'AmazonPersonalize.CreateDatasetExportJob' required

Request body

jobNamestring required

The name for the dataset export job.

datasetArnstring required

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

ingestionMode'BULK' | 'PUT' | 'ALL'

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

roleArnstring required

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

Response

Success

datasetExportJobArnstring

The Amazon Resource Name (ARN) of the dataset export job.