Amazon Comprehend
Developer Guide

ListEntityRecognizers

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

Request Syntax

{ "Filter": { "Status": "string", "SubmitTimeAfter": number, "SubmitTimeBefore": number }, "MaxResults": number, "NextToken": "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.

Filter

Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

Type: EntityRecognizerFilter object

Required: No

MaxResults

The maximum number of results to return on each page. The default is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "EntityRecognizerPropertiesList": [ { "DataAccessRoleArn": "string", "EndTime": number, "EntityRecognizerArn": "string", "InputDataConfig": { "Annotations": { "S3Uri": "string" }, "Documents": { "S3Uri": "string" }, "EntityList": { "S3Uri": "string" }, "EntityTypes": [ { "Type": "string" } ] }, "LanguageCode": "string", "Message": "string", "RecognizerMetadata": { "EntityTypes": [ { "Type": "string" } ], "EvaluationMetrics": { "F1Score": number, "Precision": number, "Recall": number }, "NumberOfTestDocuments": number, "NumberOfTrainedDocuments": number }, "Status": "string", "SubmitTime": number, "TrainingEndTime": number, "TrainingStartTime": number, "VolumeKmsKeyId": "string" } ], "NextToken": "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.

EntityRecognizerPropertiesList

The list of properties of an entity recognizer.

Type: Array of EntityRecognizerProperties objects

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

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

InvalidFilterException

The filter specified for the operation is invalid. Specify a different filter.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

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: