Comprehend / Client / list_entity_recognizer_summaries

list_entity_recognizer_summaries

Comprehend.Client.list_entity_recognizer_summaries(**kwargs)

Gets a list of summaries for the entity recognizers that you have created.

See also: AWS API Documentation

Request Syntax

response = client.list_entity_recognizer_summaries(
    NextToken='string',
    MaxResults=123
)

Parameters:

• NextToken (string) – Identifies the next page of results to return.

• MaxResults (integer) – The maximum number of results to return on each page. The default is 100.

Return type:

dict

Returns:

Response Syntax

{
    'EntityRecognizerSummariesList': [
        {
            'RecognizerName': 'string',
            'NumberOfVersions': 123,
            'LatestVersionCreatedAt': datetime(2015, 1, 1),
            'LatestVersionName': 'string',
            'LatestVersionStatus': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • EntityRecognizerSummariesList (list) –

    The list entity recognizer summaries.

    • (dict) –

      Describes the information about an entity recognizer and its versions.

      • RecognizerName (string) –

        The name that you assigned the entity recognizer.

      • NumberOfVersions (integer) –

        The number of versions you created.

      • LatestVersionCreatedAt (datetime) –

        The time that the latest entity recognizer version was submitted for processing.

      • LatestVersionName (string) –

        The version name you assigned to the latest entity recognizer version.

      • LatestVersionStatus (string) –

        Provides the status of the latest entity recognizer version.

  • NextToken (string) –

    Identifies the next page of results to return.

Exceptions

• Comprehend.Client.exceptions.InvalidRequestException

• Comprehend.Client.exceptions.TooManyRequestsException

• Comprehend.Client.exceptions.InternalServerException