| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Personalize.CreateDatasetImportJob
Description
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.
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
Synopsis
- data CreateDatasetImportJob = CreateDatasetImportJob' {
- importMode :: Maybe ImportMode
- publishAttributionMetricsToS3 :: Maybe Bool
- tags :: Maybe [Tag]
- jobName :: Text
- datasetArn :: Text
- dataSource :: DataSource
- roleArn :: Text
- newCreateDatasetImportJob :: Text -> Text -> DataSource -> Text -> CreateDatasetImportJob
- createDatasetImportJob_importMode :: Lens' CreateDatasetImportJob (Maybe ImportMode)
- createDatasetImportJob_publishAttributionMetricsToS3 :: Lens' CreateDatasetImportJob (Maybe Bool)
- createDatasetImportJob_tags :: Lens' CreateDatasetImportJob (Maybe [Tag])
- createDatasetImportJob_jobName :: Lens' CreateDatasetImportJob Text
- createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text
- createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob DataSource
- createDatasetImportJob_roleArn :: Lens' CreateDatasetImportJob Text
- data CreateDatasetImportJobResponse = CreateDatasetImportJobResponse' {}
- newCreateDatasetImportJobResponse :: Int -> CreateDatasetImportJobResponse
- createDatasetImportJobResponse_datasetImportJobArn :: Lens' CreateDatasetImportJobResponse (Maybe Text)
- createDatasetImportJobResponse_httpStatus :: Lens' CreateDatasetImportJobResponse Int
Creating a Request
data CreateDatasetImportJob Source #
See: newCreateDatasetImportJob smart constructor.
Constructors
| CreateDatasetImportJob' | |
Fields
| |
Instances
newCreateDatasetImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> DataSource | |
| -> Text | |
| -> CreateDatasetImportJob |
Create a value of CreateDatasetImportJob 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:
CreateDatasetImportJob, createDatasetImportJob_importMode - 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
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. - Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
CreateDatasetImportJob, createDatasetImportJob_publishAttributionMetricsToS3 - If you created a metric attribution, specify whether to publish metrics
for this import job to Amazon S3
$sel:tags:CreateDatasetImportJob', createDatasetImportJob_tags - A list of
tags
to apply to the dataset import job.
CreateDatasetImportJob, createDatasetImportJob_jobName - The name for the dataset import job.
CreateDatasetImportJob, createDatasetImportJob_datasetArn - The ARN of the dataset that receives the imported data.
CreateDatasetImportJob, createDatasetImportJob_dataSource - The Amazon S3 bucket that contains the training data to import.
CreateDatasetImportJob, createDatasetImportJob_roleArn - The ARN of the IAM role that has permissions to read from the Amazon S3
data source.
Request Lenses
createDatasetImportJob_importMode :: Lens' CreateDatasetImportJob (Maybe ImportMode) Source #
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
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. - Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
createDatasetImportJob_publishAttributionMetricsToS3 :: Lens' CreateDatasetImportJob (Maybe Bool) Source #
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
createDatasetImportJob_tags :: Lens' CreateDatasetImportJob (Maybe [Tag]) Source #
A list of tags to apply to the dataset import job.
createDatasetImportJob_jobName :: Lens' CreateDatasetImportJob Text Source #
The name for the dataset import job.
createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text Source #
The ARN of the dataset that receives the imported data.
createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob DataSource Source #
The Amazon S3 bucket that contains the training data to import.
createDatasetImportJob_roleArn :: Lens' CreateDatasetImportJob Text Source #
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
Destructuring the Response
data CreateDatasetImportJobResponse Source #
See: newCreateDatasetImportJobResponse smart constructor.
Constructors
| CreateDatasetImportJobResponse' | |
Fields
| |
Instances
newCreateDatasetImportJobResponse Source #
Create a value of CreateDatasetImportJobResponse 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:
CreateDatasetImportJobResponse, createDatasetImportJobResponse_datasetImportJobArn - The ARN of the dataset import job.
$sel:httpStatus:CreateDatasetImportJobResponse', createDatasetImportJobResponse_httpStatus - The response's http status code.
Response Lenses
createDatasetImportJobResponse_datasetImportJobArn :: Lens' CreateDatasetImportJobResponse (Maybe Text) Source #
The ARN of the dataset import job.
createDatasetImportJobResponse_httpStatus :: Lens' CreateDatasetImportJobResponse Int Source #
The response's http status code.