Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeDocumentClassifier

Gets the properties associated with a document classifier.

Request Syntax


{
   "DocumentClassifierArn": "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.

DocumentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier. The CreateDocumentClassifier operation returns this identifier in its response.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Required: Yes

Response Syntax


{
   "DocumentClassifierProperties": { 
      "ClassifierMetadata": { 
         "EvaluationMetrics": { 
            "Accuracy": number,
            "F1Score": number,
            "HammingLoss": number,
            "MicroF1Score": number,
            "MicroPrecision": number,
            "MicroRecall": number,
            "Precision": number,
            "Recall": number
         },
         "NumberOfLabels": number,
         "NumberOfTestDocuments": number,
         "NumberOfTrainedDocuments": number
      },
      "DataAccessRoleArn": "string",
      "DocumentClassifierArn": "string",
      "EndTime": number,
      "FlywheelArn": "string",
      "InputDataConfig": { 
         "AugmentedManifests": [ 
            { 
               "AnnotationDataS3Uri": "string",
               "AttributeNames": [ "string" ],
               "DocumentType": "string",
               "S3Uri": "string",
               "SourceDocumentsS3Uri": "string",
               "Split": "string"
            }
         ],
         "DataFormat": "string",
         "DocumentReaderConfig": { 
            "DocumentReadAction": "string",
            "DocumentReadMode": "string",
            "FeatureTypes": [ "string" ]
         },
         "Documents": { 
            "S3Uri": "string",
            "TestS3Uri": "string"
         },
         "DocumentType": "string",
         "LabelDelimiter": "string",
         "S3Uri": "string",
         "TestS3Uri": "string"
      },
      "LanguageCode": "string",
      "Message": "string",
      "Mode": "string",
      "ModelKmsKeyId": "string",
      "OutputDataConfig": { 
         "FlywheelStatsS3Prefix": "string",
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "SourceModelArn": "string",
      "Status": "string",
      "SubmitTime": number,
      "TrainingEndTime": number,
      "TrainingStartTime": number,
      "VersionName": "string",
      "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.

DocumentClassifierProperties

An object that contains the properties associated with a document classifier.

Type: DocumentClassifierProperties 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

ResourceNotFoundException

The specified resource ARN was not found. Check the ARN and try your request again.

HTTP Status Code: 400

TooManyRequestsException

The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 400