Class: Aws::Comprehend::Types::StartDocumentClassificationJobResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_classifier_arn ⇒ String

The ARN of the custom classification model.

Returns:

  • (String) 


6865
6866
6867
6868
6869
6870
6871
6872
 
# File 'lib/aws-sdk-comprehend/types.rb', line 6865

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

#job_arn ⇒ String

The Amazon Resource Name (ARN) of the document classification 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:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`

The following is an example job ARN:

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

Returns:

  • (String) 


6865
6866
6867
6868
6869
6870
6871
6872
 
# File 'lib/aws-sdk-comprehend/types.rb', line 6865

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

#job_id ⇒ String

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

Returns:

  • (String) 


6865
6866
6867
6868
6869
6870
6871
6872
 
# File 'lib/aws-sdk-comprehend/types.rb', line 6865

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

#job_status ⇒ String

The status of the job:

  • SUBMITTED - The job has been received and 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. For details, use the ‘DescribeDocumentClassificationJob` 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) 


6865
6866
6867
6868
6869
6870
6871
6872
 
# File 'lib/aws-sdk-comprehend/types.rb', line 6865

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