There are more AWS SDK examples available in the AWS Doc SDK Examples
Use DescribeDocumentClassificationJob
with an AWS SDK or CLI
The following code examples show how to use DescribeDocumentClassificationJob
.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
- AWS CLI
-
To describe a document classification job
The following
describe-document-classification-job
example gets the properties of an asynchronous document classification job.aws comprehend describe-document-classification-job \ --job-id
123456abcdeb0e11022f22a11EXAMPLE
Output:
{ "DocumentClassificationJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "exampleclassificationjob", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:09:51.788000+00:00", "EndTime": "2023-06-14T17:15:58.582000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/1", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-CLN-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } }
For more information, see Custom Classification in the Amazon Comprehend Developer Guide.
-
For API details, see DescribeDocumentClassificationJob
in AWS CLI Command Reference.
-