Skip to content

/AWS1/CL_PZZDATASETEXPORTJOB

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_jobname TYPE /AWS1/PZZNAME /AWS1/PZZNAME

The name of the export job.

iv_datasetexportjobarn TYPE /AWS1/PZZARN /AWS1/PZZARN

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

iv_datasetarn TYPE /AWS1/PZZARN /AWS1/PZZARN

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

iv_ingestionmode TYPE /AWS1/PZZINGESTIONMODE /AWS1/PZZINGESTIONMODE

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.

iv_rolearn TYPE /AWS1/PZZARN /AWS1/PZZARN

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

iv_status TYPE /AWS1/PZZSTATUS /AWS1/PZZSTATUS

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

io_joboutput TYPE REF TO /AWS1/CL_PZZDSEXPORTJOBOUTPUT /AWS1/CL_PZZDSEXPORTJOBOUTPUT

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

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

iv_creationdatetime TYPE /AWS1/PZZDATE /AWS1/PZZDATE

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

iv_lastupdateddatetime TYPE /AWS1/PZZDATE /AWS1/PZZDATE

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

iv_failurereason TYPE /AWS1/PZZFAILUREREASON /AWS1/PZZFAILUREREASON

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


Queryable Attributes

jobName

The name of the export job.

Accessible with the following methods

Method Description
GET_JOBNAME() Getter for JOBNAME, with configurable default
ASK_JOBNAME() Getter for JOBNAME w/ exceptions if field has no value
HAS_JOBNAME() Determine if JOBNAME has a value

datasetExportJobArn

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

Accessible with the following methods

Method Description
GET_DATASETEXPORTJOBARN() Getter for DATASETEXPORTJOBARN, with configurable default
ASK_DATASETEXPORTJOBARN() Getter for DATASETEXPORTJOBARN w/ exceptions if field has no
HAS_DATASETEXPORTJOBARN() Determine if DATASETEXPORTJOBARN has a value

datasetArn

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

Accessible with the following methods

Method Description
GET_DATASETARN() Getter for DATASETARN, with configurable default
ASK_DATASETARN() Getter for DATASETARN w/ exceptions if field has no value
HAS_DATASETARN() Determine if DATASETARN has a value

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.

Accessible with the following methods

Method Description
GET_INGESTIONMODE() Getter for INGESTIONMODE, with configurable default
ASK_INGESTIONMODE() Getter for INGESTIONMODE w/ exceptions if field has no value
HAS_INGESTIONMODE() Determine if INGESTIONMODE has a value

roleArn

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

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value

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

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

jobOutput

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

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

Accessible with the following methods

Method Description
GET_JOBOUTPUT() Getter for JOBOUTPUT

creationDateTime

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

Accessible with the following methods

Method Description
GET_CREATIONDATETIME() Getter for CREATIONDATETIME, with configurable default
ASK_CREATIONDATETIME() Getter for CREATIONDATETIME w/ exceptions if field has no va
HAS_CREATIONDATETIME() Determine if CREATIONDATETIME has a value

lastUpdatedDateTime

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

Accessible with the following methods

Method Description
GET_LASTUPDATEDDATETIME() Getter for LASTUPDATEDDATETIME, with configurable default
ASK_LASTUPDATEDDATETIME() Getter for LASTUPDATEDDATETIME w/ exceptions if field has no
HAS_LASTUPDATEDDATETIME() Determine if LASTUPDATEDDATETIME has a value

failureReason

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

Accessible with the following methods

Method Description
GET_FAILUREREASON() Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON() Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON() Determine if FAILUREREASON has a value