Skip to content

DatasetExportJob

Source code in docs_src/capo_personalize/types/dataset_export_job.py
class DatasetExportJob(TypedDict, closed=True):
    job_name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the export job.</p>"""
    dataset_export_job_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset export job.</p>"""
    dataset_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset to export.</p>"""
    ingestion_mode: NotRequired["capo_personalize.types.ingestion_mode.IngestionMode"]
    """<p>The data to export, based on how you imported the data. You can choose to export <code>BULK</code> data that you imported using a dataset import job, <code>PUT</code> data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or <code>ALL</code> for both types. The default value is <code>PUT</code>. </p>"""
    role_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the dataset export job.</p> <p>A dataset export 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>"""
    job_output: NotRequired[
        "capo_personalize.types.dataset_export_job_output.DatasetExportJobOutput"
    ]
    """<p>The path to the Amazon S3 bucket where the job's output is stored. For example:</p> <p> <code>s3://bucket-name/folder-name/</code> </p>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The creation date and time (in Unix time) of the dataset export job.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix time) the status of the dataset export job was last updated.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If a dataset export job fails, provides the reason why.</p>"""

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

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

dataset_arn instance-attribute

dataset_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the dataset to export.

dataset_export_job_arn instance-attribute

dataset_export_job_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the dataset export job.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

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

ingestion_mode instance-attribute

ingestion_mode: NotRequired[IngestionMode]

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.

job_name instance-attribute

job_name: NotRequired[Name]

The name of the export job.

job_output instance-attribute

job_output: NotRequired[DatasetExportJobOutput]

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 instance-attribute

last_updated_date_time: NotRequired[Date]

The date and time (in Unix time) the status of the dataset export job was last updated.

role_arn instance-attribute

role_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

status instance-attribute

status: NotRequired[Status]

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