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.CreateDatasetExportJob

Description

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

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

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

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export 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.

Synopsis

Creating a Request

data CreateDatasetExportJob Source #

See: newCreateDatasetExportJob smart constructor.

Constructors

CreateDatasetExportJob' 

Fields

  • ingestionMode :: Maybe IngestionMode

    The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

  • tags :: Maybe [Tag]

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

  • jobName :: Text

    The name for the dataset export job.

  • datasetArn :: Text

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

  • roleArn :: Text

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

  • jobOutput :: DatasetExportJobOutput

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

Instances

Instances details
ToJSON CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

ToHeaders CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

ToPath CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

ToQuery CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

AWSRequest CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Associated Types

type AWSResponse CreateDatasetExportJob #

Generic CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Associated Types

type Rep CreateDatasetExportJob :: Type -> Type #

Read CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Show CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

NFData CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Methods

rnf :: CreateDatasetExportJob -> () #

Eq CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Hashable CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

type AWSResponse CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

type Rep CreateDatasetExportJob Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

type Rep CreateDatasetExportJob = D1 ('MetaData "CreateDatasetExportJob" "Amazonka.Personalize.CreateDatasetExportJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateDatasetExportJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ingestionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionMode)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatasetExportJobOutput)))))

newCreateDatasetExportJob Source #

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

CreateDatasetExportJob, createDatasetExportJob_ingestionMode - The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only 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:tags:CreateDatasetExportJob', createDatasetExportJob_tags - A list of tags to apply to the dataset export job.

CreateDatasetExportJob, createDatasetExportJob_jobName - The name for the dataset export job.

CreateDatasetExportJob, createDatasetExportJob_datasetArn - The Amazon Resource Name (ARN) of the dataset that contains the data to export.

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

CreateDatasetExportJob, createDatasetExportJob_jobOutput - The path to the Amazon S3 bucket where the job's output is stored.

Request Lenses

createDatasetExportJob_ingestionMode :: Lens' CreateDatasetExportJob (Maybe IngestionMode) Source #

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

createDatasetExportJob_tags :: Lens' CreateDatasetExportJob (Maybe [Tag]) Source #

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

createDatasetExportJob_datasetArn :: Lens' CreateDatasetExportJob Text Source #

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

createDatasetExportJob_roleArn :: Lens' CreateDatasetExportJob Text Source #

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

createDatasetExportJob_jobOutput :: Lens' CreateDatasetExportJob DatasetExportJobOutput Source #

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

Destructuring the Response

data CreateDatasetExportJobResponse Source #

See: newCreateDatasetExportJobResponse smart constructor.

Constructors

CreateDatasetExportJobResponse' 

Fields

Instances

Instances details
Generic CreateDatasetExportJobResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Associated Types

type Rep CreateDatasetExportJobResponse :: Type -> Type #

Read CreateDatasetExportJobResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Show CreateDatasetExportJobResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

NFData CreateDatasetExportJobResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

Eq CreateDatasetExportJobResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

type Rep CreateDatasetExportJobResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateDatasetExportJob

type Rep CreateDatasetExportJobResponse = D1 ('MetaData "CreateDatasetExportJobResponse" "Amazonka.Personalize.CreateDatasetExportJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateDatasetExportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetExportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDatasetExportJobResponse Source #

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

CreateDatasetExportJobResponse, createDatasetExportJobResponse_datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.

$sel:httpStatus:CreateDatasetExportJobResponse', createDatasetExportJobResponse_httpStatus - The response's http status code.

Response Lenses

createDatasetExportJobResponse_datasetExportJobArn :: Lens' CreateDatasetExportJobResponse (Maybe Text) Source #

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