dataset_export_jobs

Creates, updates, deletes, gets or lists a dataset_export_jobs resource.

Overview

Name	dataset_export_jobs
Type	Resource
Id	aws.personalize.dataset_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_dataset_export_job

Name	Datatype	Description
creation_date_time	string (date-time)	The creation date and time (in Unix time) of the dataset export job.
dataset_arn	string	The Amazon Resource Name (ARN) of the dataset to export. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
dataset_export_job_arn	string	The Amazon Resource Name (ARN) of the dataset export job. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
failure_reason	string	If a dataset export job fails, provides the reason why.
ingestion_mode	string	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. (BULK, PUT, ALL)
job_name	string	The name of the export job. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
job_output	object	The path to the Amazon S3 bucket where the job's output is stored. For example: s3:​//bucket-name/folder-name/
last_updated_date_time	string (date-time)	The date and time (in Unix time) the status of the dataset export job was last updated.
role_arn	string	The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
status	string	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

list_dataset_export_jobs

Name	Datatype	Description
creation_date_time	string (date-time)	The date and time (in Unix time) that the dataset export job was created.
dataset_export_job_arn	string	The Amazon Resource Name (ARN) of the dataset export job. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
failure_reason	string	If a dataset export job fails, the reason behind the failure.
job_name	string	The name of the dataset export job. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
last_updated_date_time	string (date-time)	The date and time (in Unix time) that the dataset export job status was last updated.
status	string	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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dataset_export_job	select	region		Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
list_dataset_export_jobs	select	region		Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
create_dataset_export_job	insert	region, jobName, datasetArn, roleArn, jobOutput		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_dataset_export_job

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

SELECT
creation_date_time,
dataset_arn,
dataset_export_job_arn,
failure_reason,
ingestion_mode,
job_name,
job_output,
last_updated_date_time,
role_arn,
status
FROM aws.personalize.dataset_export_jobs
WHERE region = '{{ region }}' -- required
;

list_dataset_export_jobs

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

SELECT
creation_date_time,
dataset_export_job_arn,
failure_reason,
job_name,
last_updated_date_time,
status
FROM aws.personalize.dataset_export_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_dataset_export_job

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.

INSERT INTO aws.personalize.dataset_export_jobs (
jobName,
datasetArn,
ingestionMode,
roleArn,
jobOutput,
tags,
region
)
SELECT 
'{{ jobName }}' /* required */,
'{{ datasetArn }}' /* required */,
'{{ ingestionMode }}',
'{{ roleArn }}' /* required */,
'{{ jobOutput }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
dataset_export_job_arn
;

Manifest

# Description fields are for documentation purposes
- name: dataset_export_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dataset_export_jobs resource.
  - name: jobName
    value: "{{ jobName }}"
    description: |
      The name for the dataset export job.
  - name: datasetArn
    value: "{{ datasetArn }}"
    description: |
      The Amazon Resource Name (ARN) of the dataset that contains the data to export.
  - name: ingestionMode
    value: "{{ ingestionMode }}"
    description: |
      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.
    valid_values: ['BULK', 'PUT', 'ALL']
  - name: roleArn
    value: "{{ roleArn }}"
    description: |
      The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
  - name: jobOutput
    description: |
      The path to the Amazon S3 bucket where the job's output is stored.
    value:
      s3DataDestination:
        path: "{{ path }}"
        kmsKeyArn: "{{ kmsKeyArn }}"
  - name: tags
    description: |
      A list of tags to apply to the dataset export job.
    value:
      - tagKey: "{{ tagKey }}"
        tagValue: "{{ tagValue }}"