ComprehendClient

Index > Comprehend > ComprehendClient

Auto-generated documentation for Comprehend type annotations stubs module types-aiobotocore-comprehend.

ComprehendClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_comprehend.client import ComprehendClient

session = Session()
async with session.client("comprehend") as client:
    client: ComprehendClient

Exceptions

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

Usage example

async with session.client("comprehend") as client:
    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 types_aiobotocore_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 session.client("comprehend").batch_detect_dominant_language method. boto3 documentation

Method definition

await 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 session.client("comprehend").batch_detect_entities method. boto3 documentation

Method definition

await 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 session.client("comprehend").batch_detect_key_phrases method. boto3 documentation

Method definition

await 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 session.client("comprehend").batch_detect_sentiment method. boto3 documentation

Method definition

await 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 session.client("comprehend").batch_detect_syntax method. boto3 documentation

Method definition

await 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

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.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 session.client("comprehend").classify_document method. boto3 documentation

Method definition

await 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 session.client("comprehend").close method. boto3 documentation

Method definition

await 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 session.client("comprehend").contains_pii_entities method. boto3 documentation

Method definition

await 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 session.client("comprehend").create_document_classifier method. boto3 documentation

Method definition

await 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 session.client("comprehend").create_endpoint method. boto3 documentation

Method definition

await 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 session.client("comprehend").create_entity_recognizer method. boto3 documentation

Method definition

await 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 session.client("comprehend").delete_document_classifier method. boto3 documentation

Method definition

await 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 session.client("comprehend").delete_endpoint method. boto3 documentation

Method definition

await 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 session.client("comprehend").delete_entity_recognizer method. boto3 documentation

Method definition

await 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 session.client("comprehend").delete_resource_policy method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_document_classification_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_document_classifier method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_dominant_language_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_endpoint method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_entities_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_entity_recognizer method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_events_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_key_phrases_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_pii_entities_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_resource_policy method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_sentiment_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_targeted_sentiment_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").describe_topics_detection_job method. boto3 documentation

Method definition

await 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 session.client("comprehend").detect_dominant_language method. boto3 documentation

Method definition

await 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 session.client("comprehend").detect_entities method. boto3 documentation

Method definition

await 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 session.client("comprehend").detect_key_phrases method. boto3 documentation

Method definition

await 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 session.client("comprehend").detect_pii_entities method. boto3 documentation

Method definition

await 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 session.client("comprehend").detect_sentiment method. boto3 documentation

Method definition

await 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 session.client("comprehend").detect_syntax method. boto3 documentation

Method definition

await 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

generate_presigned_url

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

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

Method definition

await 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 session.client("comprehend").import_model method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_document_classification_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_document_classifier_summaries method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_document_classifiers method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_dominant_language_detection_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_endpoints method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_entities_detection_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_entity_recognizer_summaries method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_entity_recognizers method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_events_detection_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_key_phrases_detection_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_pii_entities_detection_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_sentiment_detection_jobs method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_tags_for_resource method. boto3 documentation

Method definition

await 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 session.client("comprehend").list_targeted_sentiment_detection_jobs method. boto3 documentation

Method definition

await def list_targeted_sentiment_detection_jobs(
    self,
    *,
    Filter: TargetedSentimentDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTargetedSentimentDetectionJobsResponseTypeDef:  # (2)
    ...

1. See TargetedSentimentDetectionJobFilterTypeDef
2. See ListTargetedSentimentDetectionJobsResponseTypeDef

Usage example with kwargs

kwargs: ListTargetedSentimentDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_targeted_sentiment_detection_jobs(**kwargs)

1. See ListTargetedSentimentDetectionJobsRequestRequestTypeDef

list_topics_detection_jobs

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

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

Method definition

await def list_topics_detection_jobs(
    self,
    *,
    Filter: TopicsDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTopicsDetectionJobsResponseTypeDef:  # (2)
    ...

1. See TopicsDetectionJobFilterTypeDef
2. See ListTopicsDetectionJobsResponseTypeDef

Usage example with kwargs

kwargs: ListTopicsDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_topics_detection_jobs(**kwargs)

1. See ListTopicsDetectionJobsRequestRequestTypeDef

put_resource_policy

Attaches a resource-based policy to a custom model.

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

Method definition

await def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    ResourcePolicy: str,
    PolicyRevisionId: str = ...,
) -> PutResourcePolicyResponseTypeDef:  # (1)
    ...

1. See PutResourcePolicyResponseTypeDef

Usage example with kwargs

kwargs: PutResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "ResourcePolicy": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyRequestRequestTypeDef

start_document_classification_job

Starts an asynchronous document classification job.

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

Method definition

await def start_document_classification_job(
    self,
    *,
    DocumentClassifierArn: str,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    JobName: str = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> StartDocumentClassificationJobResponseTypeDef:  # (5)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See VpcConfigTypeDef
4. See TagTypeDef
5. See StartDocumentClassificationJobResponseTypeDef

Usage example with kwargs

kwargs: StartDocumentClassificationJobRequestRequestTypeDef = {  # (1)
    "DocumentClassifierArn": ...,
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
}

parent.start_document_classification_job(**kwargs)

1. See StartDocumentClassificationJobRequestRequestTypeDef

start_dominant_language_detection_job

Starts an asynchronous dominant language detection job for a collection of documents.

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

Method definition

await def start_dominant_language_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    JobName: str = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> StartDominantLanguageDetectionJobResponseTypeDef:  # (5)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See VpcConfigTypeDef
4. See TagTypeDef
5. See StartDominantLanguageDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartDominantLanguageDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
}

parent.start_dominant_language_detection_job(**kwargs)

1. See StartDominantLanguageDetectionJobRequestRequestTypeDef

start_entities_detection_job

Starts an asynchronous entity detection job for a collection of documents.

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

Method definition

await def start_entities_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: str = ...,
    EntityRecognizerArn: str = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> StartEntitiesDetectionJobResponseTypeDef:  # (6)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See VpcConfigTypeDef
5. See TagTypeDef
6. See StartEntitiesDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartEntitiesDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_entities_detection_job(**kwargs)

1. See StartEntitiesDetectionJobRequestRequestTypeDef

start_events_detection_job

Starts an asynchronous event detection job for a collection of documents.

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

Method definition

await def start_events_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    TargetEventTypes: Sequence[str],
    JobName: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> StartEventsDetectionJobResponseTypeDef:  # (5)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See TagTypeDef
5. See StartEventsDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartEventsDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
    "TargetEventTypes": ...,
}

parent.start_events_detection_job(**kwargs)

1. See StartEventsDetectionJobRequestRequestTypeDef

start_key_phrases_detection_job

Starts an asynchronous key phrase detection job for a collection of documents.

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

Method definition

await def start_key_phrases_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: str = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> StartKeyPhrasesDetectionJobResponseTypeDef:  # (6)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See VpcConfigTypeDef
5. See TagTypeDef
6. See StartKeyPhrasesDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartKeyPhrasesDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_key_phrases_detection_job(**kwargs)

1. See StartKeyPhrasesDetectionJobRequestRequestTypeDef

start_pii_entities_detection_job

Starts an asynchronous PII entity detection job for a collection of documents.

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

Method definition

await def start_pii_entities_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    Mode: PiiEntitiesDetectionModeType,  # (3)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (4)
    RedactionConfig: RedactionConfigTypeDef = ...,  # (5)
    JobName: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
) -> StartPiiEntitiesDetectionJobResponseTypeDef:  # (7)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See PiiEntitiesDetectionModeType
4. See LanguageCodeType
5. See RedactionConfigTypeDef
6. See TagTypeDef
7. See StartPiiEntitiesDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartPiiEntitiesDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "Mode": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_pii_entities_detection_job(**kwargs)

1. See StartPiiEntitiesDetectionJobRequestRequestTypeDef

start_sentiment_detection_job

Starts an asynchronous sentiment detection job for a collection of documents.

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

Method definition

await def start_sentiment_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: str = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> StartSentimentDetectionJobResponseTypeDef:  # (6)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See VpcConfigTypeDef
5. See TagTypeDef
6. See StartSentimentDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartSentimentDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_sentiment_detection_job(**kwargs)

1. See StartSentimentDetectionJobRequestRequestTypeDef

start_targeted_sentiment_detection_job

Starts an asynchronous targeted sentiment detection job for a collection of documents.

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

Method definition

await def start_targeted_sentiment_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: str = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> StartTargetedSentimentDetectionJobResponseTypeDef:  # (6)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See VpcConfigTypeDef
5. See TagTypeDef
6. See StartTargetedSentimentDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartTargetedSentimentDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_targeted_sentiment_detection_job(**kwargs)

1. See StartTargetedSentimentDetectionJobRequestRequestTypeDef

start_topics_detection_job

Starts an asynchronous topic detection job.

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

Method definition

await def start_topics_detection_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    JobName: str = ...,
    NumberOfTopics: int = ...,
    ClientRequestToken: str = ...,
    VolumeKmsKeyId: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> StartTopicsDetectionJobResponseTypeDef:  # (5)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See VpcConfigTypeDef
4. See TagTypeDef
5. See StartTopicsDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartTopicsDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
}

parent.start_topics_detection_job(**kwargs)

1. See StartTopicsDetectionJobRequestRequestTypeDef

stop_dominant_language_detection_job

Stops a dominant language detection job in progress.

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

Method definition

await def stop_dominant_language_detection_job(
    self,
    *,
    JobId: str,
) -> StopDominantLanguageDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopDominantLanguageDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopDominantLanguageDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_dominant_language_detection_job(**kwargs)

1. See StopDominantLanguageDetectionJobRequestRequestTypeDef

stop_entities_detection_job

Stops an entities detection job in progress.

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

Method definition

await def stop_entities_detection_job(
    self,
    *,
    JobId: str,
) -> StopEntitiesDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopEntitiesDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopEntitiesDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_entities_detection_job(**kwargs)

1. See StopEntitiesDetectionJobRequestRequestTypeDef

stop_events_detection_job

Stops an events detection job in progress.

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

Method definition

await def stop_events_detection_job(
    self,
    *,
    JobId: str,
) -> StopEventsDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopEventsDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopEventsDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_events_detection_job(**kwargs)

1. See StopEventsDetectionJobRequestRequestTypeDef

stop_key_phrases_detection_job

Stops a key phrases detection job in progress.

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

Method definition

await def stop_key_phrases_detection_job(
    self,
    *,
    JobId: str,
) -> StopKeyPhrasesDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopKeyPhrasesDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopKeyPhrasesDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_key_phrases_detection_job(**kwargs)

1. See StopKeyPhrasesDetectionJobRequestRequestTypeDef

stop_pii_entities_detection_job

Stops a PII entities detection job in progress.

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

Method definition

await def stop_pii_entities_detection_job(
    self,
    *,
    JobId: str,
) -> StopPiiEntitiesDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopPiiEntitiesDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopPiiEntitiesDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_pii_entities_detection_job(**kwargs)

1. See StopPiiEntitiesDetectionJobRequestRequestTypeDef

stop_sentiment_detection_job

Stops a sentiment detection job in progress.

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

Method definition

await def stop_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> StopSentimentDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopSentimentDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopSentimentDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_sentiment_detection_job(**kwargs)

1. See StopSentimentDetectionJobRequestRequestTypeDef

stop_targeted_sentiment_detection_job

Stops a targeted sentiment detection job in progress.

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

Method definition

await def stop_targeted_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> StopTargetedSentimentDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopTargetedSentimentDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopTargetedSentimentDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_targeted_sentiment_detection_job(**kwargs)

1. See StopTargetedSentimentDetectionJobRequestRequestTypeDef

stop_training_document_classifier

Stops a document classifier training job while in progress.

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

Method definition

await def stop_training_document_classifier(
    self,
    *,
    DocumentClassifierArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StopTrainingDocumentClassifierRequestRequestTypeDef = {  # (1)
    "DocumentClassifierArn": ...,
}

parent.stop_training_document_classifier(**kwargs)

1. See StopTrainingDocumentClassifierRequestRequestTypeDef

stop_training_entity_recognizer

Stops an entity recognizer training job while in progress.

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

Method definition

await def stop_training_entity_recognizer(
    self,
    *,
    EntityRecognizerArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StopTrainingEntityRecognizerRequestRequestTypeDef = {  # (1)
    "EntityRecognizerArn": ...,
}

parent.stop_training_entity_recognizer(**kwargs)

1. See StopTrainingEntityRecognizerRequestRequestTypeDef

tag_resource

Associates a specific tag with an Amazon Comprehend resource.

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

Method definition

await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a specific tag associated with an Amazon Comprehend resource.

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

Method definition

await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_endpoint

Updates information about the specified endpoint.

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

Method definition

await def update_endpoint(
    self,
    *,
    EndpointArn: str,
    DesiredModelArn: str = ...,
    DesiredInferenceUnits: int = ...,
    DesiredDataAccessRoleArn: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateEndpointRequestRequestTypeDef = {  # (1)
    "EndpointArn": ...,
}

parent.update_endpoint(**kwargs)

1. See UpdateEndpointRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> ComprehendClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("comprehend").get_paginator method with overloads.

• client.get_paginator("list_document_classification_jobs") -> ListDocumentClassificationJobsPaginator
• client.get_paginator("list_document_classifiers") -> ListDocumentClassifiersPaginator
• client.get_paginator("list_dominant_language_detection_jobs") -> ListDominantLanguageDetectionJobsPaginator
• client.get_paginator("list_entities_detection_jobs") -> ListEntitiesDetectionJobsPaginator
• client.get_paginator("list_entity_recognizers") -> ListEntityRecognizersPaginator
• client.get_paginator("list_key_phrases_detection_jobs") -> ListKeyPhrasesDetectionJobsPaginator
• client.get_paginator("list_sentiment_detection_jobs") -> ListSentimentDetectionJobsPaginator
• client.get_paginator("list_topics_detection_jobs") -> ListTopicsDetectionJobsPaginator