Skip to content

/AWS1/CL_CPDSTRTTPCSDETJOBRSP

StartTopicsDetectionJobResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_jobid TYPE /AWS1/CPDJOBID /AWS1/CPDJOBID

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

iv_jobarn TYPE /AWS1/CPDCOMPREHENDARN /AWS1/CPDCOMPREHENDARN

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn::comprehend:::topics-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

iv_jobstatus TYPE /AWS1/CPDJOBSTATUS /AWS1/CPDJOBSTATUS

The status of the job:

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

Queryable Attributes

JobId

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

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

JobArn

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn::comprehend:::topics-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Accessible with the following methods

Method Description
GET_JOBARN() Getter for JOBARN, with configurable default
ASK_JOBARN() Getter for JOBARN w/ exceptions if field has no value
HAS_JOBARN() Determine if JOBARN has a value

JobStatus

The status of the job:

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

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