

**********
Comprehend
**********



======
Client
======



.. py:class:: Comprehend.Client

  A low-level client representing Amazon Comprehend
  

  Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

  ::

    
    import boto3
    
    client = boto3.client('comprehend')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  comprehend/client/batch_detect_dominant_language
  comprehend/client/batch_detect_entities
  comprehend/client/batch_detect_key_phrases
  comprehend/client/batch_detect_sentiment
  comprehend/client/batch_detect_syntax
  comprehend/client/batch_detect_targeted_sentiment
  comprehend/client/can_paginate
  comprehend/client/classify_document
  comprehend/client/close
  comprehend/client/contains_pii_entities
  comprehend/client/create_dataset
  comprehend/client/create_document_classifier
  comprehend/client/create_endpoint
  comprehend/client/create_entity_recognizer
  comprehend/client/create_flywheel
  comprehend/client/delete_document_classifier
  comprehend/client/delete_endpoint
  comprehend/client/delete_entity_recognizer
  comprehend/client/delete_flywheel
  comprehend/client/delete_resource_policy
  comprehend/client/describe_dataset
  comprehend/client/describe_document_classification_job
  comprehend/client/describe_document_classifier
  comprehend/client/describe_dominant_language_detection_job
  comprehend/client/describe_endpoint
  comprehend/client/describe_entities_detection_job
  comprehend/client/describe_entity_recognizer
  comprehend/client/describe_events_detection_job
  comprehend/client/describe_flywheel
  comprehend/client/describe_flywheel_iteration
  comprehend/client/describe_key_phrases_detection_job
  comprehend/client/describe_pii_entities_detection_job
  comprehend/client/describe_resource_policy
  comprehend/client/describe_sentiment_detection_job
  comprehend/client/describe_targeted_sentiment_detection_job
  comprehend/client/describe_topics_detection_job
  comprehend/client/detect_dominant_language
  comprehend/client/detect_entities
  comprehend/client/detect_key_phrases
  comprehend/client/detect_pii_entities
  comprehend/client/detect_sentiment
  comprehend/client/detect_syntax
  comprehend/client/detect_targeted_sentiment
  comprehend/client/detect_toxic_content
  comprehend/client/get_paginator
  comprehend/client/get_waiter
  comprehend/client/import_model
  comprehend/client/list_datasets
  comprehend/client/list_document_classification_jobs
  comprehend/client/list_document_classifier_summaries
  comprehend/client/list_document_classifiers
  comprehend/client/list_dominant_language_detection_jobs
  comprehend/client/list_endpoints
  comprehend/client/list_entities_detection_jobs
  comprehend/client/list_entity_recognizer_summaries
  comprehend/client/list_entity_recognizers
  comprehend/client/list_events_detection_jobs
  comprehend/client/list_flywheel_iteration_history
  comprehend/client/list_flywheels
  comprehend/client/list_key_phrases_detection_jobs
  comprehend/client/list_pii_entities_detection_jobs
  comprehend/client/list_sentiment_detection_jobs
  comprehend/client/list_tags_for_resource
  comprehend/client/list_targeted_sentiment_detection_jobs
  comprehend/client/list_topics_detection_jobs
  comprehend/client/put_resource_policy
  comprehend/client/start_document_classification_job
  comprehend/client/start_dominant_language_detection_job
  comprehend/client/start_entities_detection_job
  comprehend/client/start_events_detection_job
  comprehend/client/start_flywheel_iteration
  comprehend/client/start_key_phrases_detection_job
  comprehend/client/start_pii_entities_detection_job
  comprehend/client/start_sentiment_detection_job
  comprehend/client/start_targeted_sentiment_detection_job
  comprehend/client/start_topics_detection_job
  comprehend/client/stop_dominant_language_detection_job
  comprehend/client/stop_entities_detection_job
  comprehend/client/stop_events_detection_job
  comprehend/client/stop_key_phrases_detection_job
  comprehend/client/stop_pii_entities_detection_job
  comprehend/client/stop_sentiment_detection_job
  comprehend/client/stop_targeted_sentiment_detection_job
  comprehend/client/stop_training_document_classifier
  comprehend/client/stop_training_entity_recognizer
  comprehend/client/tag_resource
  comprehend/client/untag_resource
  comprehend/client/update_endpoint
  comprehend/client/update_flywheel


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  comprehend/paginator/ListDocumentClassificationJobs
  comprehend/paginator/ListDocumentClassifiers
  comprehend/paginator/ListDominantLanguageDetectionJobs
  comprehend/paginator/ListEndpoints
  comprehend/paginator/ListEntitiesDetectionJobs
  comprehend/paginator/ListEntityRecognizers
  comprehend/paginator/ListKeyPhrasesDetectionJobs
  comprehend/paginator/ListPiiEntitiesDetectionJobs
  comprehend/paginator/ListSentimentDetectionJobs
  comprehend/paginator/ListTopicsDetectionJobs
