Class: Aws::Comprehend::Types::StartEntitiesDetectionJobResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_arnString

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

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Returns:

  • (String)


5727
5728
5729
5730
5731
5732
5733
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5727

class StartEntitiesDetectionJobResponse < Struct.new(
  :job_id,
  :job_arn,
  :job_status)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


5727
5728
5729
5730
5731
5732
5733
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5727

class StartEntitiesDetectionJobResponse < Struct.new(
  :job_id,
  :job_arn,
  :job_status)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

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

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

Returns:

  • (String)


5727
5728
5729
5730
5731
5732
5733
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5727

class StartEntitiesDetectionJobResponse < Struct.new(
  :job_id,
  :job_arn,
  :job_status)
  SENSITIVE = []
  include Aws::Structure
end