Skip to content

/AWS1/CL_IOSDSCENRCHJOBRSP

DescribeEnrichmentJobResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_jobid TYPE /AWS1/IOSID /AWS1/IOSID

The unique identifier of the enrichment job.

iv_status TYPE /AWS1/IOSENRICHMENTJOBSTATUS /AWS1/IOSENRICHMENTJOBSTATUS

Current status of the enrichment job. Possible values:

  • PENDING: Job is waiting to start processing
  • RUNNING: Job is actively processing video data
  • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
  • FAILED: Job encountered an error; see failureMessage for details
  • TIMED_OUT: Job exceeded maximum processing time limit
  • CANCELLED: Job was cancelled by user request

iv_workspacename TYPE /AWS1/IOSWORKSPACENAME /AWS1/IOSWORKSPACENAME

The name of the IoT SiteWise workspace containing the job.

iv_jobtype TYPE /AWS1/IOSJOBTYPE /AWS1/IOSJOBTYPE

The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

io_jobconfiguration TYPE REF TO /AWS1/CL_IOSENRICHMENTJOBCONF /AWS1/CL_IOSENRICHMENTJOBCONF

The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

iv_createdat TYPE /AWS1/IOSTIMESTAMP00 /AWS1/IOSTIMESTAMP00

Timestamp when the enrichment job was created in ISO 8601 format.

Optional arguments:

iv_updatedat TYPE /AWS1/IOSTIMESTAMP00 /AWS1/IOSTIMESTAMP00

Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

iv_completedat TYPE /AWS1/IOSTIMESTAMP00 /AWS1/IOSTIMESTAMP00

Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

iv_cancelledat TYPE /AWS1/IOSTIMESTAMP00 /AWS1/IOSTIMESTAMP00

Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

iv_failuremessage TYPE /AWS1/IOSSTRING00 /AWS1/IOSSTRING00

Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

Queryable Attributes

jobId

The unique identifier of the enrichment 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

status

Current status of the enrichment job. Possible values:

  • PENDING: Job is waiting to start processing
  • RUNNING: Job is actively processing video data
  • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
  • FAILED: Job encountered an error; see failureMessage for details
  • TIMED_OUT: Job exceeded maximum processing time limit
  • CANCELLED: Job was cancelled by user request

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

workspaceName

The name of the IoT SiteWise workspace containing the job.

Accessible with the following methods

Method Description
GET_WORKSPACENAME() Getter for WORKSPACENAME, with configurable default
ASK_WORKSPACENAME() Getter for WORKSPACENAME w/ exceptions if field has no value
HAS_WORKSPACENAME() Determine if WORKSPACENAME has a value

jobType

The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

Accessible with the following methods

Method Description
GET_JOBTYPE() Getter for JOBTYPE, with configurable default
ASK_JOBTYPE() Getter for JOBTYPE w/ exceptions if field has no value
HAS_JOBTYPE() Determine if JOBTYPE has a value

jobConfiguration

The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

Accessible with the following methods

Method Description
GET_JOBCONFIGURATION() Getter for JOBCONFIGURATION

createdAt

Timestamp when the enrichment job was created in ISO 8601 format.

Accessible with the following methods

Method Description
GET_CREATEDAT() Getter for CREATEDAT, with configurable default
ASK_CREATEDAT() Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT() Determine if CREATEDAT has a value

updatedAt

Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

Accessible with the following methods

Method Description
GET_UPDATEDAT() Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT() Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT() Determine if UPDATEDAT has a value

completedAt

Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

Accessible with the following methods

Method Description
GET_COMPLETEDAT() Getter for COMPLETEDAT, with configurable default
ASK_COMPLETEDAT() Getter for COMPLETEDAT w/ exceptions if field has no value
HAS_COMPLETEDAT() Determine if COMPLETEDAT has a value

cancelledAt

Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

Accessible with the following methods

Method Description
GET_CANCELLEDAT() Getter for CANCELLEDAT, with configurable default
ASK_CANCELLEDAT() Getter for CANCELLEDAT w/ exceptions if field has no value
HAS_CANCELLEDAT() Determine if CANCELLEDAT has a value

failureMessage

Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

Accessible with the following methods

Method Description
GET_FAILUREMESSAGE() Getter for FAILUREMESSAGE, with configurable default
ASK_FAILUREMESSAGE() Getter for FAILUREMESSAGE w/ exceptions if field has no valu
HAS_FAILUREMESSAGE() Determine if FAILUREMESSAGE has a value