/AWS1/IF_PZZ=>CREATEDATASETIMPORTJOB()

About CreateDatasetImportJob

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.

By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.

Status

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

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

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import 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.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

• ListDatasetImportJobs

• DescribeDatasetImportJob

Method Signature

METHODS /AWS1/IF_PZZ~CREATEDATASETIMPORTJOB
  IMPORTING
    !IV_JOBNAME TYPE /AWS1/PZZNAME OPTIONAL
    !IV_DATASETARN TYPE /AWS1/PZZARN OPTIONAL
    !IO_DATASOURCE TYPE REF TO /AWS1/CL_PZZDATASOURCE OPTIONAL
    !IV_ROLEARN TYPE /AWS1/PZZROLEARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_PZZTAG=>TT_TAGS OPTIONAL
    !IV_IMPORTMODE TYPE /AWS1/PZZIMPORTMODE OPTIONAL
    !IV_PUBLISHATTRIBUTIONMETTOS3 TYPE /AWS1/PZZBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pzzcreatedsimpjobrsp
  RAISING
    /AWS1/CX_PZZINVALIDINPUTEX
    /AWS1/CX_PZZLIMITEXCEEDEDEX
    /AWS1/CX_PZZRESRCALRDYEXISTSEX
    /AWS1/CX_PZZRESOURCEINUSEEX
    /AWS1/CX_PZZRESOURCENOTFOUNDEX
    /AWS1/CX_PZZTOOMANYTAGSEX
    /AWS1/CX_PZZCLIENTEXC
    /AWS1/CX_PZZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobname TYPE /AWS1/PZZNAME /AWS1/PZZNAME

The name for the dataset import job.

iv_datasetarn TYPE /AWS1/PZZARN /AWS1/PZZARN

The ARN of the dataset that receives the imported data.

io_datasource TYPE REF TO /AWS1/CL_PZZDATASOURCE /AWS1/CL_PZZDATASOURCE

The Amazon S3 bucket that contains the training data to import.

Optional arguments:

iv_rolearn TYPE /AWS1/PZZROLEARN /AWS1/PZZROLEARN

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

it_tags TYPE /AWS1/CL_PZZTAG=>TT_TAGS TT_TAGS

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

iv_importmode TYPE /AWS1/PZZIMPORTMODE /AWS1/PZZIMPORTMODE

Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL.

• Specify FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.

• Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.

iv_publishattributionmettos3 TYPE /AWS1/PZZBOOLEAN /AWS1/PZZBOOLEAN

If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3

RETURNING

oo_output TYPE REF TO /aws1/cl_pzzcreatedsimpjobrsp /AWS1/CL_PZZCREATEDSIMPJOBRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createdatasetimportjob(
  io_datasource = new /aws1/cl_pzzdatasource( |string| )
  it_tags = VALUE /aws1/cl_pzztag=>tt_tags(
    (
      new /aws1/cl_pzztag(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
    )
  )
  iv_datasetarn = |string|
  iv_importmode = |string|
  iv_jobname = |string|
  iv_publishattributionmettos3 = ABAP_TRUE
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_datasetimportjobarn( ).
ENDIF.