Documentation

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

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

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

See: newDatasetExportJob smart constructor.

Create a value of DatasetExportJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureReason:DatasetExportJob', datasetExportJob_failureReason - If a dataset export job fails, provides the reason why.

$sel:status:DatasetExportJob', datasetExportJob_status - The status of the dataset export job.

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

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

$sel:datasetExportJobArn:DatasetExportJob', datasetExportJob_datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.

$sel:datasetArn:DatasetExportJob', datasetExportJob_datasetArn - The Amazon Resource Name (ARN) of the dataset to export.

$sel:jobOutput:DatasetExportJob', datasetExportJob_jobOutput - The path to the Amazon S3 bucket where the job's output is stored. For example:

s3://bucket-name/folder-name/

$sel:jobName:DatasetExportJob', datasetExportJob_jobName - The name of the export job.

$sel:lastUpdatedDateTime:DatasetExportJob', datasetExportJob_lastUpdatedDateTime - The date and time (in Unix time) the status of the dataset export job was last updated.

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

$sel:creationDateTime:DatasetExportJob', datasetExportJob_creationDateTime - The creation date and time (in Unix time) of the dataset export job.

$sel:roleArn:DatasetExportJob', datasetExportJob_roleArn - The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

If a dataset export job fails, provides the reason why.

The status of the dataset export job.

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

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

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

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

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

s3://bucket-name/folder-name/

The name of the export job.

The date and time (in Unix time) the status of the dataset export job was last updated.

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

The creation date and time (in Unix time) of the dataset export job.

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