Comprehend / Client / list_document_classifier_summaries

list_document_classifier_summaries#

Comprehend.Client.list_document_classifier_summaries(**kwargs)#

Gets a list of summaries of the document classifiers that you have created

See also: AWS API Documentation

Request Syntax

response = client.list_document_classifier_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

{
    'DocumentClassifierSummariesList': [
        {
            'DocumentClassifierName': '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) –

    • DocumentClassifierSummariesList (list) –

      The list of summaries of document classifiers.

      • (dict) –

        Describes information about a document classifier and its versions.

        • DocumentClassifierName (string) –

          The name that you assigned the document classifier.

        • NumberOfVersions (integer) –

          The number of versions you created.

        • LatestVersionCreatedAt (datetime) –

          The time that the latest document classifier version was submitted for processing.

        • LatestVersionName (string) –

          The version name you assigned to the latest document classifier version.

        • LatestVersionStatus (string) –

          Provides the status of the latest document classifier version.

    • NextToken (string) –

      Identifies the next page of results to return.

Exceptions

  • Comprehend.Client.exceptions.InvalidRequestException

  • Comprehend.Client.exceptions.TooManyRequestsException

  • Comprehend.Client.exceptions.InternalServerException