DescribeEntityRecognizer
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
Request Syntax
{
"EntityRecognizerArn": "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.
- EntityRecognizerArn
-
The Amazon Resource Name (ARN) that identifies the entity recognizer.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?Required: Yes
Response Syntax
{
"EntityRecognizerProperties": {
"DataAccessRoleArn": "string",
"EndTime": number,
"EntityRecognizerArn": "string",
"FlywheelArn": "string",
"InputDataConfig": {
"Annotations": {
"S3Uri": "string",
"TestS3Uri": "string"
},
"AugmentedManifests": [
{
"AnnotationDataS3Uri": "string",
"AttributeNames": [ "string" ],
"DocumentType": "string",
"S3Uri": "string",
"SourceDocumentsS3Uri": "string",
"Split": "string"
}
],
"DataFormat": "string",
"Documents": {
"InputFormat": "string",
"S3Uri": "string",
"TestS3Uri": "string"
},
"EntityList": {
"S3Uri": "string"
},
"EntityTypes": [
{
"Type": "string"
}
]
},
"LanguageCode": "string",
"Message": "string",
"ModelKmsKeyId": "string",
"OutputDataConfig": {
"FlywheelStatsS3Prefix": "string"
},
"RecognizerMetadata": {
"EntityTypes": [
{
"EvaluationMetrics": {
"F1Score": number,
"Precision": number,
"Recall": number
},
"NumberOfTrainMentions": number,
"Type": "string"
}
],
"EvaluationMetrics": {
"F1Score": number,
"Precision": number,
"Recall": number
},
"NumberOfTestDocuments": number,
"NumberOfTrainedDocuments": number
},
"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.
- EntityRecognizerProperties
-
Describes information associated with an entity recognizer.
Type: EntityRecognizerProperties 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
