Skip to content

ComprehendClient

Index > Comprehend > ComprehendClient

Auto-generated documentation for Comprehend type annotations stubs module mypy-boto3-comprehend.

ComprehendClient

Type annotations and code completion for boto3.client("comprehend"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_comprehend.client import ComprehendClient

def get_comprehend_client() -> ComprehendClient:
    return Session().client("comprehend")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("comprehend").exceptions structure.

Usage example
client = boto3.client("comprehend")

try:
    do_something(client)
except (
    client.BatchSizeLimitExceededException,
    client.ClientError,
    client.ConcurrentModificationException,
    client.InternalServerException,
    client.InvalidFilterException,
    client.InvalidRequestException,
    client.JobNotFoundException,
    client.KmsKeyValidationException,
    client.ResourceInUseException,
    client.ResourceLimitExceededException,
    client.ResourceNotFoundException,
    client.ResourceUnavailableException,
    client.TextSizeLimitExceededException,
    client.TooManyRequestsException,
    client.TooManyTagKeysException,
    client.TooManyTagsException,
    client.UnsupportedLanguageException,
) as e:
    print(e)
Type checking example
from mypy_boto3_comprehend.client import Exceptions

def handle_error(exc: Exceptions.BatchSizeLimitExceededException) -> None:
    ...

Methods

batch_detect_dominant_language

Determines the dominant language of the input text for a batch of documents.

Type annotations and code completion for boto3.client("comprehend").batch_detect_dominant_language method. boto3 documentation

Method definition
def batch_detect_dominant_language(
    self,
    *,
    TextList: Sequence[str],
) -> BatchDetectDominantLanguageResponseTypeDef:  # (1)
    ...
  1. See BatchDetectDominantLanguageResponseTypeDef
Usage example with kwargs
kwargs: BatchDetectDominantLanguageRequestRequestTypeDef = {  # (1)
    "TextList": ...,
}

parent.batch_detect_dominant_language(**kwargs)
  1. See BatchDetectDominantLanguageRequestRequestTypeDef

batch_detect_entities

Inspects the text of a batch of documents for named entities and returns information about them.

Type annotations and code completion for boto3.client("comprehend").batch_detect_entities method. boto3 documentation

Method definition
def batch_detect_entities(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectEntitiesResponseTypeDef
Usage example with kwargs
kwargs: BatchDetectEntitiesRequestRequestTypeDef = {  # (1)
    "TextList": ...,
    "LanguageCode": ...,
}

parent.batch_detect_entities(**kwargs)
  1. See BatchDetectEntitiesRequestRequestTypeDef

batch_detect_key_phrases

Detects the key noun phrases found in a batch of documents.

Type annotations and code completion for boto3.client("comprehend").batch_detect_key_phrases method. boto3 documentation

Method definition
def batch_detect_key_phrases(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectKeyPhrasesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectKeyPhrasesResponseTypeDef
Usage example with kwargs
kwargs: BatchDetectKeyPhrasesRequestRequestTypeDef = {  # (1)
    "TextList": ...,
    "LanguageCode": ...,
}

parent.batch_detect_key_phrases(**kwargs)
  1. See BatchDetectKeyPhrasesRequestRequestTypeDef

batch_detect_sentiment

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE , NEUTRAL , MIXED , or NEGATIVE , in each one.

Type annotations and code completion for boto3.client("comprehend").batch_detect_sentiment method. boto3 documentation

Method definition
def batch_detect_sentiment(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectSentimentResponseTypeDef
Usage example with kwargs
kwargs: BatchDetectSentimentRequestRequestTypeDef = {  # (1)
    "TextList": ...,
    "LanguageCode": ...,
}

parent.batch_detect_sentiment(**kwargs)
  1. See BatchDetectSentimentRequestRequestTypeDef

batch_detect_syntax

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them.

Type annotations and code completion for boto3.client("comprehend").batch_detect_syntax method. boto3 documentation

Method definition
def batch_detect_syntax(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: SyntaxLanguageCodeType,  # (1)
) -> BatchDetectSyntaxResponseTypeDef:  # (2)
    ...
  1. See SyntaxLanguageCodeType
  2. See BatchDetectSyntaxResponseTypeDef
Usage example with kwargs
kwargs: BatchDetectSyntaxRequestRequestTypeDef = {  # (1)
    "TextList": ...,
    "LanguageCode": ...,
}

parent.batch_detect_syntax(**kwargs)
  1. See BatchDetectSyntaxRequestRequestTypeDef

batch_detect_targeted_sentiment

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

Type annotations and code completion for boto3.client("comprehend").batch_detect_targeted_sentiment method. boto3 documentation

Method definition
def batch_detect_targeted_sentiment(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectTargetedSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectTargetedSentimentResponseTypeDef
Usage example with kwargs
kwargs: BatchDetectTargetedSentimentRequestRequestTypeDef = {  # (1)
    "TextList": ...,
    "LanguageCode": ...,
}

parent.batch_detect_targeted_sentiment(**kwargs)
  1. See BatchDetectTargetedSentimentRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("comprehend").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

classify_document

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

Type annotations and code completion for boto3.client("comprehend").classify_document method. boto3 documentation

Method definition
def classify_document(
    self,
    *,
    Text: str,
    EndpointArn: str,
) -> ClassifyDocumentResponseTypeDef:  # (1)
    ...
  1. See ClassifyDocumentResponseTypeDef
Usage example with kwargs
kwargs: ClassifyDocumentRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "EndpointArn": ...,
}

parent.classify_document(**kwargs)
  1. See ClassifyDocumentRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("comprehend").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

contains_pii_entities

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

Type annotations and code completion for boto3.client("comprehend").contains_pii_entities method. boto3 documentation

Method definition
def contains_pii_entities(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> ContainsPiiEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See ContainsPiiEntitiesResponseTypeDef
Usage example with kwargs
kwargs: ContainsPiiEntitiesRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

parent.contains_pii_entities(**kwargs)
  1. See ContainsPiiEntitiesRequestRequestTypeDef

create_document_classifier

Creates a new document classifier that you can use to categorize documents.

Type annotations and code completion for boto3.client("comprehend").create_document_classifier method. boto3 documentation

Method definition
def create_document_classifier(
    self,
    *,
    DocumentClassifierName: str,
    DataAccessRoleArn: str,
    InputDataConfig: DocumentClassifierInputDataConfigTypeDef,  # (1)
    LanguageCode: LanguageCodeType,  # (2)
    VersionName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    OutputDataConfig: DocumentClassifierOutputDataConfigTypeDef = ...,  # (4)
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (5)
    Mode: DocumentClassifierModeType = ...,  # (6)
    ModelKmsKeyId: str = ...,
    ModelPolicy: str = ...,
) -> CreateDocumentClassifierResponseTypeDef:  # (7)
    ...
  1. See DocumentClassifierInputDataConfigTypeDef
  2. See LanguageCodeType
  3. See TagTypeDef
  4. See DocumentClassifierOutputDataConfigTypeDef
  5. See VpcConfigTypeDef
  6. See DocumentClassifierModeType
  7. See CreateDocumentClassifierResponseTypeDef
Usage example with kwargs
kwargs: CreateDocumentClassifierRequestRequestTypeDef = {  # (1)
    "DocumentClassifierName": ...,
    "DataAccessRoleArn": ...,
    "InputDataConfig": ...,
    "LanguageCode": ...,
}

parent.create_document_classifier(**kwargs)
  1. See CreateDocumentClassifierRequestRequestTypeDef

create_endpoint

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints_ .

Type annotations and code completion for boto3.client("comprehend").create_endpoint method. boto3 documentation

Method definition
def create_endpoint(
    self,
    *,
    EndpointName: str,
    ModelArn: str,
    DesiredInferenceUnits: int,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    DataAccessRoleArn: str = ...,
) -> CreateEndpointResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateEndpointResponseTypeDef
Usage example with kwargs
kwargs: CreateEndpointRequestRequestTypeDef = {  # (1)
    "EndpointName": ...,
    "ModelArn": ...,
    "DesiredInferenceUnits": ...,
}

parent.create_endpoint(**kwargs)
  1. See CreateEndpointRequestRequestTypeDef

create_entity_recognizer

Creates an entity recognizer using submitted files.

Type annotations and code completion for boto3.client("comprehend").create_entity_recognizer method. boto3 documentation

Method definition
def create_entity_recognizer(
    self,
    *,
    RecognizerName: str,
    DataAccessRoleArn: str,
    InputDataConfig: EntityRecognizerInputDataConfigTypeDef,  # (1)
    LanguageCode: LanguageCodeType,  # (2)
    VersionName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (4)
    ModelKmsKeyId: str = ...,
    ModelPolicy: str = ...,
) -> CreateEntityRecognizerResponseTypeDef:  # (5)
    ...
  1. See EntityRecognizerInputDataConfigTypeDef
  2. See LanguageCodeType
  3. See TagTypeDef
  4. See VpcConfigTypeDef
  5. See CreateEntityRecognizerResponseTypeDef
Usage example with kwargs
kwargs: CreateEntityRecognizerRequestRequestTypeDef = {  # (1)
    "RecognizerName": ...,
    "DataAccessRoleArn": ...,
    "InputDataConfig": ...,
    "LanguageCode": ...,
}

parent.create_entity_recognizer(**kwargs)
  1. See CreateEntityRecognizerRequestRequestTypeDef

delete_document_classifier

Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.

Type annotations and code completion for boto3.client("comprehend").delete_document_classifier method. boto3 documentation

Method definition
def delete_document_classifier(
    self,
    *,
    DocumentClassifierArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDocumentClassifierRequestRequestTypeDef = {  # (1)
    "DocumentClassifierArn": ...,
}

parent.delete_document_classifier(**kwargs)
  1. See DeleteDocumentClassifierRequestRequestTypeDef

delete_endpoint

Deletes a model-specific endpoint for a previously-trained custom model.

Type annotations and code completion for boto3.client("comprehend").delete_endpoint method. boto3 documentation

Method definition
def delete_endpoint(
    self,
    *,
    EndpointArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEndpointRequestRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.delete_endpoint(**kwargs)
  1. See DeleteEndpointRequestRequestTypeDef

delete_entity_recognizer

Deletes an entity recognizer.

Type annotations and code completion for boto3.client("comprehend").delete_entity_recognizer method. boto3 documentation

Method definition
def delete_entity_recognizer(
    self,
    *,
    EntityRecognizerArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEntityRecognizerRequestRequestTypeDef = {  # (1)
    "EntityRecognizerArn": ...,
}

parent.delete_entity_recognizer(**kwargs)
  1. See DeleteEntityRecognizerRequestRequestTypeDef

delete_resource_policy

Deletes a resource-based policy that is attached to a custom model.

Type annotations and code completion for boto3.client("comprehend").delete_resource_policy method. boto3 documentation

Method definition
def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
    PolicyRevisionId: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestRequestTypeDef

describe_document_classification_job

Gets the properties associated with a document classification job.

Type annotations and code completion for boto3.client("comprehend").describe_document_classification_job method. boto3 documentation

Method definition
def describe_document_classification_job(
    self,
    *,
    JobId: str,
) -> DescribeDocumentClassificationJobResponseTypeDef:  # (1)
    ...
  1. See DescribeDocumentClassificationJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeDocumentClassificationJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_document_classification_job(**kwargs)
  1. See DescribeDocumentClassificationJobRequestRequestTypeDef

describe_document_classifier

Gets the properties associated with a document classifier.

Type annotations and code completion for boto3.client("comprehend").describe_document_classifier method. boto3 documentation

Method definition
def describe_document_classifier(
    self,
    *,
    DocumentClassifierArn: str,
) -> DescribeDocumentClassifierResponseTypeDef:  # (1)
    ...
  1. See DescribeDocumentClassifierResponseTypeDef
Usage example with kwargs
kwargs: DescribeDocumentClassifierRequestRequestTypeDef = {  # (1)
    "DocumentClassifierArn": ...,
}

parent.describe_document_classifier(**kwargs)
  1. See DescribeDocumentClassifierRequestRequestTypeDef

describe_dominant_language_detection_job

Gets the properties associated with a dominant language detection job.

Type annotations and code completion for boto3.client("comprehend").describe_dominant_language_detection_job method. boto3 documentation

Method definition
def describe_dominant_language_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeDominantLanguageDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeDominantLanguageDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeDominantLanguageDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_dominant_language_detection_job(**kwargs)
  1. See DescribeDominantLanguageDetectionJobRequestRequestTypeDef

describe_endpoint

Gets the properties associated with a specific endpoint.

Type annotations and code completion for boto3.client("comprehend").describe_endpoint method. boto3 documentation

Method definition
def describe_endpoint(
    self,
    *,
    EndpointArn: str,
) -> DescribeEndpointResponseTypeDef:  # (1)
    ...
  1. See DescribeEndpointResponseTypeDef
Usage example with kwargs
kwargs: DescribeEndpointRequestRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.describe_endpoint(**kwargs)
  1. See DescribeEndpointRequestRequestTypeDef

describe_entities_detection_job

Gets the properties associated with an entities detection job.

Type annotations and code completion for boto3.client("comprehend").describe_entities_detection_job method. boto3 documentation

Method definition
def describe_entities_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeEntitiesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeEntitiesDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeEntitiesDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_entities_detection_job(**kwargs)
  1. See DescribeEntitiesDetectionJobRequestRequestTypeDef

describe_entity_recognizer

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Type annotations and code completion for boto3.client("comprehend").describe_entity_recognizer method. boto3 documentation

Method definition
def describe_entity_recognizer(
    self,
    *,
    EntityRecognizerArn: str,
) -> DescribeEntityRecognizerResponseTypeDef:  # (1)
    ...
  1. See DescribeEntityRecognizerResponseTypeDef
Usage example with kwargs
kwargs: DescribeEntityRecognizerRequestRequestTypeDef = {  # (1)
    "EntityRecognizerArn": ...,
}

parent.describe_entity_recognizer(**kwargs)
  1. See DescribeEntityRecognizerRequestRequestTypeDef

describe_events_detection_job

Gets the status and details of an events detection job.

Type annotations and code completion for boto3.client("comprehend").describe_events_detection_job method. boto3 documentation

Method definition
def describe_events_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeEventsDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeEventsDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeEventsDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_events_detection_job(**kwargs)
  1. See DescribeEventsDetectionJobRequestRequestTypeDef

describe_key_phrases_detection_job

Gets the properties associated with a key phrases detection job.

Type annotations and code completion for boto3.client("comprehend").describe_key_phrases_detection_job method. boto3 documentation

Method definition
def describe_key_phrases_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeKeyPhrasesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeKeyPhrasesDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeKeyPhrasesDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_key_phrases_detection_job(**kwargs)
  1. See DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

describe_pii_entities_detection_job

Gets the properties associated with a PII entities detection job.

Type annotations and code completion for boto3.client("comprehend").describe_pii_entities_detection_job method. boto3 documentation

Method definition
def describe_pii_entities_detection_job(
    self,
    *,
    JobId: str,
) -> DescribePiiEntitiesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribePiiEntitiesDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribePiiEntitiesDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_pii_entities_detection_job(**kwargs)
  1. See DescribePiiEntitiesDetectionJobRequestRequestTypeDef

describe_resource_policy

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

Type annotations and code completion for boto3.client("comprehend").describe_resource_policy method. boto3 documentation

Method definition
def describe_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See DescribeResourcePolicyResponseTypeDef
Usage example with kwargs
kwargs: DescribeResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.describe_resource_policy(**kwargs)
  1. See DescribeResourcePolicyRequestRequestTypeDef

describe_sentiment_detection_job

Gets the properties associated with a sentiment detection job.

Type annotations and code completion for boto3.client("comprehend").describe_sentiment_detection_job method. boto3 documentation

Method definition
def describe_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeSentimentDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeSentimentDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeSentimentDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_sentiment_detection_job(**kwargs)
  1. See DescribeSentimentDetectionJobRequestRequestTypeDef

describe_targeted_sentiment_detection_job

Gets the properties associated with a targeted sentiment detection job.

Type annotations and code completion for boto3.client("comprehend").describe_targeted_sentiment_detection_job method. boto3 documentation

Method definition
def describe_targeted_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeTargetedSentimentDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeTargetedSentimentDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeTargetedSentimentDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_targeted_sentiment_detection_job(**kwargs)
  1. See DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

describe_topics_detection_job

Gets the properties associated with a topic detection job.

Type annotations and code completion for boto3.client("comprehend").describe_topics_detection_job method. boto3 documentation

Method definition
def describe_topics_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeTopicsDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeTopicsDetectionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeTopicsDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_topics_detection_job(**kwargs)
  1. See DescribeTopicsDetectionJobRequestRequestTypeDef

detect_dominant_language

Determines the dominant language of the input text.

Type annotations and code completion for boto3.client("comprehend").detect_dominant_language method. boto3 documentation

Method definition
def detect_dominant_language(
    self,
    *,
    Text: str,
) -> DetectDominantLanguageResponseTypeDef:  # (1)
    ...
  1. See DetectDominantLanguageResponseTypeDef
Usage example with kwargs
kwargs: DetectDominantLanguageRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.detect_dominant_language(**kwargs)
  1. See DetectDominantLanguageRequestRequestTypeDef

detect_entities

Inspects text for named entities, and returns information about them.

Type annotations and code completion for boto3.client("comprehend").detect_entities method. boto3 documentation

Method definition
def detect_entities(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType = ...,  # (1)
    EndpointArn: str = ...,
) -> DetectEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectEntitiesResponseTypeDef
Usage example with kwargs
kwargs: DetectEntitiesRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.detect_entities(**kwargs)
  1. See DetectEntitiesRequestRequestTypeDef

detect_key_phrases

Detects the key noun phrases found in the text.

Type annotations and code completion for boto3.client("comprehend").detect_key_phrases method. boto3 documentation

Method definition
def detect_key_phrases(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectKeyPhrasesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectKeyPhrasesResponseTypeDef
Usage example with kwargs
kwargs: DetectKeyPhrasesRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

parent.detect_key_phrases(**kwargs)
  1. See DetectKeyPhrasesRequestRequestTypeDef

detect_pii_entities

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Type annotations and code completion for boto3.client("comprehend").detect_pii_entities method. boto3 documentation

Method definition
def detect_pii_entities(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectPiiEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectPiiEntitiesResponseTypeDef
Usage example with kwargs
kwargs: DetectPiiEntitiesRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

parent.detect_pii_entities(**kwargs)
  1. See DetectPiiEntitiesRequestRequestTypeDef

detect_sentiment

Inspects text and returns an inference of the prevailing sentiment (POSITIVE , NEUTRAL , MIXED , or NEGATIVE ).

Type annotations and code completion for boto3.client("comprehend").detect_sentiment method. boto3 documentation

Method definition
def detect_sentiment(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectSentimentResponseTypeDef
Usage example with kwargs
kwargs: DetectSentimentRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

parent.detect_sentiment(**kwargs)
  1. See DetectSentimentRequestRequestTypeDef

detect_syntax

Inspects text for syntax and the part of speech of words in the document.

Type annotations and code completion for boto3.client("comprehend").detect_syntax method. boto3 documentation

Method definition
def detect_syntax(
    self,
    *,
    Text: str,
    LanguageCode: SyntaxLanguageCodeType,  # (1)
) -> DetectSyntaxResponseTypeDef:  # (2)
    ...
  1. See SyntaxLanguageCodeType
  2. See DetectSyntaxResponseTypeDef
Usage example with kwargs
kwargs: DetectSyntaxRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

parent.detect_syntax(**kwargs)
  1. See DetectSyntaxRequestRequestTypeDef

detect_targeted_sentiment

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

Type annotations and code completion for boto3.client("comprehend").detect_targeted_sentiment method. boto3 documentation

Method definition
def detect_targeted_sentiment(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectTargetedSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectTargetedSentimentResponseTypeDef
Usage example with kwargs
kwargs: DetectTargetedSentimentRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

parent.detect_targeted_sentiment(**kwargs)
  1. See DetectTargetedSentimentRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("comprehend").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

import_model

Creates a new custom model that replicates a source custom model that you import.

Type annotations and code completion for boto3.client("comprehend").import_model method. boto3 documentation

Method definition
def import_model(
    self,
    *,
    SourceModelArn: str,
    ModelName: str = ...,
    VersionName: str = ...,
    ModelKmsKeyId: str = ...,
    DataAccessRoleArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ImportModelResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ImportModelResponseTypeDef
Usage example with kwargs
kwargs: ImportModelRequestRequestTypeDef = {  # (1)
    "SourceModelArn": ...,
}

parent.import_model(**kwargs)
  1. See ImportModelRequestRequestTypeDef

list_document_classification_jobs

Gets a list of the documentation classification jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_document_classification_jobs method. boto3 documentation

Method definition
def list_document_classification_jobs(
    self,
    *,
    Filter: DocumentClassificationJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentClassificationJobsResponseTypeDef:  # (2)
    ...
  1. See DocumentClassificationJobFilterTypeDef
  2. See ListDocumentClassificationJobsResponseTypeDef
Usage example with kwargs
kwargs: ListDocumentClassificationJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_document_classification_jobs(**kwargs)
  1. See ListDocumentClassificationJobsRequestRequestTypeDef

list_document_classifier_summaries

Gets a list of summaries of the document classifiers that you have created See also: AWS API Documentation.

Type annotations and code completion for boto3.client("comprehend").list_document_classifier_summaries method. boto3 documentation

Method definition
def list_document_classifier_summaries(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentClassifierSummariesResponseTypeDef:  # (1)
    ...
  1. See ListDocumentClassifierSummariesResponseTypeDef
Usage example with kwargs
kwargs: ListDocumentClassifierSummariesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_document_classifier_summaries(**kwargs)
  1. See ListDocumentClassifierSummariesRequestRequestTypeDef

list_document_classifiers

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

Type annotations and code completion for boto3.client("comprehend").list_document_classifiers method. boto3 documentation

Method definition
def list_document_classifiers(
    self,
    *,
    Filter: DocumentClassifierFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentClassifiersResponseTypeDef:  # (2)
    ...
  1. See DocumentClassifierFilterTypeDef
  2. See ListDocumentClassifiersResponseTypeDef
Usage example with kwargs
kwargs: ListDocumentClassifiersRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_document_classifiers(**kwargs)
  1. See ListDocumentClassifiersRequestRequestTypeDef

list_dominant_language_detection_jobs

Gets a list of the dominant language detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_dominant_language_detection_jobs method. boto3 documentation

Method definition
def list_dominant_language_detection_jobs(
    self,
    *,
    Filter: DominantLanguageDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDominantLanguageDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See DominantLanguageDetectionJobFilterTypeDef
  2. See ListDominantLanguageDetectionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListDominantLanguageDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_dominant_language_detection_jobs(**kwargs)
  1. See ListDominantLanguageDetectionJobsRequestRequestTypeDef

list_endpoints

Gets a list of all existing endpoints that you've created.

Type annotations and code completion for boto3.client("comprehend").list_endpoints method. boto3 documentation

Method definition
def list_endpoints(
    self,
    *,
    Filter: EndpointFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEndpointsResponseTypeDef:  # (2)
    ...
  1. See EndpointFilterTypeDef
  2. See ListEndpointsResponseTypeDef
Usage example with kwargs
kwargs: ListEndpointsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_endpoints(**kwargs)
  1. See ListEndpointsRequestRequestTypeDef

list_entities_detection_jobs

Gets a list of the entity detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_entities_detection_jobs method. boto3 documentation

Method definition
def list_entities_detection_jobs(
    self,
    *,
    Filter: EntitiesDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntitiesDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See EntitiesDetectionJobFilterTypeDef
  2. See ListEntitiesDetectionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListEntitiesDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_entities_detection_jobs(**kwargs)
  1. See ListEntitiesDetectionJobsRequestRequestTypeDef

list_entity_recognizer_summaries

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

Type annotations and code completion for boto3.client("comprehend").list_entity_recognizer_summaries method. boto3 documentation

Method definition
def list_entity_recognizer_summaries(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntityRecognizerSummariesResponseTypeDef:  # (1)
    ...
  1. See ListEntityRecognizerSummariesResponseTypeDef
Usage example with kwargs
kwargs: ListEntityRecognizerSummariesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_entity_recognizer_summaries(**kwargs)
  1. See ListEntityRecognizerSummariesRequestRequestTypeDef

list_entity_recognizers

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training.

Type annotations and code completion for boto3.client("comprehend").list_entity_recognizers method. boto3 documentation

Method definition
def list_entity_recognizers(
    self,
    *,
    Filter: EntityRecognizerFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntityRecognizersResponseTypeDef:  # (2)
    ...
  1. See EntityRecognizerFilterTypeDef
  2. See ListEntityRecognizersResponseTypeDef
Usage example with kwargs
kwargs: ListEntityRecognizersRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_entity_recognizers(**kwargs)
  1. See ListEntityRecognizersRequestRequestTypeDef

list_events_detection_jobs

Gets a list of the events detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_events_detection_jobs method. boto3 documentation

Method definition
def list_events_detection_jobs(
    self,
    *,
    Filter: EventsDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEventsDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See EventsDetectionJobFilterTypeDef
  2. See ListEventsDetectionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListEventsDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_events_detection_jobs(**kwargs)
  1. See ListEventsDetectionJobsRequestRequestTypeDef

list_key_phrases_detection_jobs

Get a list of key phrase detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_key_phrases_detection_jobs method. boto3 documentation

Method definition
def list_key_phrases_detection_jobs(
    self,
    *,
    Filter: KeyPhrasesDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListKeyPhrasesDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See KeyPhrasesDetectionJobFilterTypeDef
  2. See ListKeyPhrasesDetectionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListKeyPhrasesDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_key_phrases_detection_jobs(**kwargs)
  1. See ListKeyPhrasesDetectionJobsRequestRequestTypeDef

list_pii_entities_detection_jobs

Gets a list of the PII entity detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_pii_entities_detection_jobs method. boto3 documentation

Method definition
def list_pii_entities_detection_jobs(
    self,
    *,
    Filter: PiiEntitiesDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPiiEntitiesDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See PiiEntitiesDetectionJobFilterTypeDef
  2. See ListPiiEntitiesDetectionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListPiiEntitiesDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_pii_entities_detection_jobs(**kwargs)
  1. See ListPiiEntitiesDetectionJobsRequestRequestTypeDef

list_sentiment_detection_jobs

Gets a list of sentiment detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_sentiment_detection_jobs method. boto3 documentation

Method definition
def list_sentiment_detection_jobs(
    self,
    *,
    Filter: SentimentDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSentimentDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See SentimentDetectionJobFilterTypeDef
  2. See ListSentimentDetectionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListSentimentDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_sentiment_detection_jobs(**kwargs)
  1. See ListSentimentDetectionJobsRequestRequestTypeDef

list_tags_for_resource

Lists all tags associated with a given Amazon Comprehend resource.

Type annotations and code completion for boto3.client("comprehend").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_targeted_sentiment_detection_jobs

Gets a list of targeted sentiment detection jobs that you have submitted.

Type annotations and code completion for boto3.client("comprehend").list_targeted_sentiment_detection_jobs method.