Skip to content

/AWS1/CL_IOSDESCRBULKIMPJOBRSP

DescribeBulkImportJobResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_jobid TYPE /AWS1/IOSID /AWS1/IOSID

The ID of the job.

iv_jobname TYPE /AWS1/IOSNAME /AWS1/IOSNAME

The unique name that helps identify the job request.

iv_jobstatus TYPE /AWS1/IOSJOBSTATUS /AWS1/IOSJOBSTATUS

The status of the bulk import job can be one of following values:

  • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

  • CANCELLED – The bulk import job has been canceled.

  • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

  • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

  • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

  • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

iv_jobrolearn TYPE /AWS1/IOSARN /AWS1/IOSARN

The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

it_files TYPE /AWS1/CL_IOSFILE=>TT_FILES TT_FILES

The files in the specified Amazon S3 bucket that contain your data.

io_errorreportlocation TYPE REF TO /AWS1/CL_IOSERRORREPORTLOC /AWS1/CL_IOSERRORREPORTLOC

The Amazon S3 destination where errors associated with the job creation request are saved.

io_jobconfiguration TYPE REF TO /AWS1/CL_IOSJOBCONFIGURATION /AWS1/CL_IOSJOBCONFIGURATION

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

iv_jobcreationdate TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

The date the job was created, in Unix epoch TIME.

iv_joblastupdatedate TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

The date the job was last updated, in Unix epoch time.

Optional arguments:

iv_adaptiveingestion TYPE /AWS1/IOSADAPTIVEINGESTION /AWS1/IOSADAPTIVEINGESTION

If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

iv_deletefilesafterimport TYPE /AWS1/IOSDELETEFILESAFTERIMP /AWS1/IOSDELETEFILESAFTERIMP

If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.


Queryable Attributes

jobId

The ID of the job.

Accessible with the following methods

Method Description
GET_JOBID() Getter for JOBID, with configurable default
ASK_JOBID() Getter for JOBID w/ exceptions if field has no value
HAS_JOBID() Determine if JOBID has a value

jobName

The unique name that helps identify the job request.

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

jobStatus

The status of the bulk import job can be one of following values:

  • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

  • CANCELLED – The bulk import job has been canceled.

  • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

  • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

  • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

  • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

Accessible with the following methods

Method Description
GET_JOBSTATUS() Getter for JOBSTATUS, with configurable default
ASK_JOBSTATUS() Getter for JOBSTATUS w/ exceptions if field has no value
HAS_JOBSTATUS() Determine if JOBSTATUS has a value

jobRoleArn

The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

Accessible with the following methods

Method Description
GET_JOBROLEARN() Getter for JOBROLEARN, with configurable default
ASK_JOBROLEARN() Getter for JOBROLEARN w/ exceptions if field has no value
HAS_JOBROLEARN() Determine if JOBROLEARN has a value

files

The files in the specified Amazon S3 bucket that contain your data.

Accessible with the following methods

Method Description
GET_FILES() Getter for FILES, with configurable default
ASK_FILES() Getter for FILES w/ exceptions if field has no value
HAS_FILES() Determine if FILES has a value

errorReportLocation

The Amazon S3 destination where errors associated with the job creation request are saved.

Accessible with the following methods

Method Description
GET_ERRORREPORTLOCATION() Getter for ERRORREPORTLOCATION

jobConfiguration

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

Accessible with the following methods

Method Description
GET_JOBCONFIGURATION() Getter for JOBCONFIGURATION

jobCreationDate

The date the job was created, in Unix epoch TIME.

Accessible with the following methods

Method Description
GET_JOBCREATIONDATE() Getter for JOBCREATIONDATE, with configurable default
ASK_JOBCREATIONDATE() Getter for JOBCREATIONDATE w/ exceptions if field has no val
HAS_JOBCREATIONDATE() Determine if JOBCREATIONDATE has a value

jobLastUpdateDate

The date the job was last updated, in Unix epoch time.

Accessible with the following methods

Method Description
GET_JOBLASTUPDATEDATE() Getter for JOBLASTUPDATEDATE, with configurable default
ASK_JOBLASTUPDATEDATE() Getter for JOBLASTUPDATEDATE w/ exceptions if field has no v
HAS_JOBLASTUPDATEDATE() Determine if JOBLASTUPDATEDATE has a value

adaptiveIngestion

If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

Accessible with the following methods

Method Description
GET_ADAPTIVEINGESTION() Getter for ADAPTIVEINGESTION, with configurable default
ASK_ADAPTIVEINGESTION() Getter for ADAPTIVEINGESTION w/ exceptions if field has no v
HAS_ADAPTIVEINGESTION() Determine if ADAPTIVEINGESTION has a value

deleteFilesAfterImport

If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

Accessible with the following methods

Method Description
GET_DELETEFILESAFTERIMPORT() Getter for DELETEFILESAFTERIMPORT, with configurable default
ASK_DELETEFILESAFTERIMPORT() Getter for DELETEFILESAFTERIMPORT w/ exceptions if field has
HAS_DELETEFILESAFTERIMPORT() Determine if DELETEFILESAFTERIMPORT has a value