Skip to content

DatasetImportJob

Source code in docs_src/capo_personalize/types/dataset_import_job.py
class DatasetImportJob(TypedDict, closed=True):
    job_name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the import job.</p>"""
    dataset_import_job_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the dataset import job.</p>"""
    dataset_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset that receives the imported data.</p>"""
    data_source: NotRequired["capo_personalize.types.data_source.DataSource"]
    """<p>The Amazon S3 bucket that contains the training data to import.</p>"""
    role_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the IAM role that has permissions to read from the Amazon S3 data source.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the dataset import job.</p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The creation date and time (in Unix time) of the dataset import job.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix time) the dataset was last updated.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If a dataset import job fails, provides the reason why.</p>"""
    import_mode: NotRequired["capo_personalize.types.import_mode.ImportMode"]
    """<p>The import mode used by the dataset import job to import new records.</p>"""
    publish_attribution_metrics_to_s3: NotRequired[
        "capo_personalize.types.boolean.Boolean"
    ]
    """<p>Whether the job publishes metrics to Amazon S3 for a metric attribution.</p>"""

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

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

data_source instance-attribute

data_source: NotRequired[DataSource]

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

dataset_arn instance-attribute

dataset_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

dataset_import_job_arn instance-attribute

dataset_import_job_arn: NotRequired[Arn]

The ARN of the dataset import job.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

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

import_mode instance-attribute

import_mode: NotRequired[ImportMode]

The import mode used by the dataset import job to import new records.

job_name instance-attribute

job_name: NotRequired[Name]

The name of the import job.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

The date and time (in Unix time) the dataset was last updated.

publish_attribution_metrics_to_s3 instance-attribute

publish_attribution_metrics_to_s3: NotRequired[Boolean]

Whether the job publishes metrics to Amazon S3 for a metric attribution.

role_arn instance-attribute

role_arn: NotRequired[Arn]

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

status instance-attribute

status: NotRequired[Status]

The status of the dataset import job.

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

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