DescribeDocumentClassificationJob
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
Request Syntax
{
"JobId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobId
-
The identifier that Amazon Comprehend generated for the job. The
StartDocumentClassificationJoboperation returns this identifier in its response.Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: Yes
Response Syntax
{
"DocumentClassificationJobProperties": {
"DataAccessRoleArn": "string",
"DocumentClassifierArn": "string",
"EndTime": number,
"FlywheelArn": "string",
"InputDataConfig": {
"DocumentReaderConfig": {
"DocumentReadAction": "string",
"DocumentReadMode": "string",
"FeatureTypes": [ "string" ]
},
"InputFormat": "string",
"S3Uri": "string"
},
"JobArn": "string",
"JobId": "string",
"JobName": "string",
"JobStatus": "string",
"Message": "string",
"OutputDataConfig": {
"KmsKeyId": "string",
"S3Uri": "string"
},
"SubmitTime": number,
"VolumeKmsKeyId": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DocumentClassificationJobProperties
-
An object that describes the properties associated with the document classification job.
Type: DocumentClassificationJobProperties object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- InvalidRequestException
-
The request is invalid.
HTTP Status Code: 400
- JobNotFoundException
-
The specified job was not found. Check the job ID and try again.
HTTP Status Code: 400
- TooManyRequestsException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
