Personalize / Client / create_dataset_import_job

create_dataset_import_job#

Personalize.Client.create_dataset_import_job(**kwargs)#

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.

Warning

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.

Note

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

Related APIs

See also: AWS API Documentation

Request Syntax

response = client.create_dataset_import_job(
    jobName='string',
    datasetArn='string',
    dataSource={
        'dataLocation': 'string'
    },
    roleArn='string',
    tags=[
        {
            'tagKey': 'string',
            'tagValue': 'string'
        },
    ],
    importMode='FULL'|'INCREMENTAL',
    publishAttributionMetricsToS3=True|False
)
Parameters:

  • jobName (string) –

    [REQUIRED]

    The name for the dataset import job.

  • datasetArn (string) –

    [REQUIRED]

    The ARN of the dataset that receives the imported data.

  • dataSource (dict) –

    [REQUIRED]

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

    • dataLocation (string) –

      The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:

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

  • roleArn (string) –

    [REQUIRED]

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

  • tags (list) –

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

    • (dict) –

      The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize resources.

      • tagKey (string) – [REQUIRED]

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • tagValue (string) – [REQUIRED]

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

  • importMode (string) –

    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.

  • publishAttributionMetricsToS3 (boolean) – If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3

Return type:

dict

Returns:

Response Syntax

{
    'datasetImportJobArn': 'string'
}

Response Structure

  • (dict) –

    • datasetImportJobArn (string) –

      The ARN of the dataset import job.

Exceptions