amazonka-personalize-2.0: Amazon Personalize SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Personalize.Types.DatasetExportJob

Description

 
Synopsis

Documentation

data DatasetExportJob Source #

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

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

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

See: newDatasetExportJob smart constructor.

Constructors

DatasetExportJob' 

Fields

  • creationDateTime :: Maybe POSIX

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

  • datasetArn :: Maybe Text

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

  • datasetExportJobArn :: Maybe Text

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

  • failureReason :: Maybe Text

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

  • ingestionMode :: Maybe 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.

  • jobName :: Maybe Text

    The name of the export job.

  • jobOutput :: Maybe DatasetExportJobOutput

    The path to the Amazon S3 bucket where the job's output is stored. For example:

    s3://bucket-name/folder-name/
  • lastUpdatedDateTime :: Maybe POSIX

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

  • roleArn :: Maybe Text

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

  • status :: Maybe Text

    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

Instances

Instances details
FromJSON DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

Generic DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

Associated Types

type Rep DatasetExportJob :: Type -> Type #

Read DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

Show DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

NFData DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

Methods

rnf :: DatasetExportJob -> () #

Eq DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

Hashable DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

type Rep DatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetExportJob

newDatasetExportJob :: DatasetExportJob Source #

Create a value of DatasetExportJob 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:

$sel:creationDateTime:DatasetExportJob', datasetExportJob_creationDateTime - The creation date and time (in Unix time) of the dataset export job.

$sel:datasetArn:DatasetExportJob', datasetExportJob_datasetArn - The Amazon Resource Name (ARN) of the dataset to export.

$sel:datasetExportJobArn:DatasetExportJob', datasetExportJob_datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.

$sel:failureReason:DatasetExportJob', datasetExportJob_failureReason - If a dataset export job fails, provides the reason why.

$sel:ingestionMode:DatasetExportJob', datasetExportJob_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.

$sel:jobName:DatasetExportJob', datasetExportJob_jobName - The name of the export job.

$sel:jobOutput:DatasetExportJob', datasetExportJob_jobOutput - The path to the Amazon S3 bucket where the job's output is stored. For example:

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

$sel:lastUpdatedDateTime:DatasetExportJob', datasetExportJob_lastUpdatedDateTime - The date and time (in Unix time) the status of the dataset export job was last updated.

$sel:roleArn:DatasetExportJob', datasetExportJob_roleArn - The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

$sel:status:DatasetExportJob', datasetExportJob_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

datasetExportJob_creationDateTime :: Lens' DatasetExportJob (Maybe UTCTime) Source #

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

datasetExportJob_datasetArn :: Lens' DatasetExportJob (Maybe Text) Source #

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

datasetExportJob_datasetExportJobArn :: Lens' DatasetExportJob (Maybe Text) Source #

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

datasetExportJob_failureReason :: Lens' DatasetExportJob (Maybe Text) Source #

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

datasetExportJob_ingestionMode :: Lens' DatasetExportJob (Maybe IngestionMode) Source #

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.

datasetExportJob_jobOutput :: Lens' DatasetExportJob (Maybe DatasetExportJobOutput) Source #

The path to the Amazon S3 bucket where the job's output is stored. For example:

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

datasetExportJob_lastUpdatedDateTime :: Lens' DatasetExportJob (Maybe UTCTime) Source #

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

datasetExportJob_roleArn :: Lens' DatasetExportJob (Maybe Text) Source #

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

datasetExportJob_status :: Lens' DatasetExportJob (Maybe Text) Source #

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