Skip to content

ComprehendClient#

Index > Comprehend > ComprehendClient

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

ComprehendClient#

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

# ComprehendClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("comprehend")

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

from types_boto3_comprehend.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

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

# batch_detect_dominant_language method definition

def batch_detect_dominant_language(
    self,
    *,
    TextList: Sequence[str],
) -> BatchDetectDominantLanguageResponseTypeDef:  # (1)
    ...
  1. See BatchDetectDominantLanguageResponseTypeDef 
# batch_detect_dominant_language method usage example with argument unpacking

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

# batch_detect_entities method definition

def batch_detect_entities(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectEntitiesResponseTypeDef 
# batch_detect_entities method usage example with argument unpacking

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

# batch_detect_key_phrases method definition

def batch_detect_key_phrases(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectKeyPhrasesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectKeyPhrasesResponseTypeDef 
# batch_detect_key_phrases method usage example with argument unpacking

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

# batch_detect_sentiment method definition

def batch_detect_sentiment(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectSentimentResponseTypeDef 
# batch_detect_sentiment method usage example with argument unpacking

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

# batch_detect_syntax method definition

def batch_detect_syntax(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: SyntaxLanguageCodeType,  # (1)
) -> BatchDetectSyntaxResponseTypeDef:  # (2)
    ...
  1. See SyntaxLanguageCodeType
  2. See BatchDetectSyntaxResponseTypeDef 
# batch_detect_syntax method usage example with argument unpacking

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

# batch_detect_targeted_sentiment method definition

def batch_detect_targeted_sentiment(
    self,
    *,
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
) -> BatchDetectTargetedSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See BatchDetectTargetedSentimentResponseTypeDef 
# batch_detect_targeted_sentiment method usage example with argument unpacking

kwargs: BatchDetectTargetedSentimentRequestRequestTypeDef = {  # (1)
    "TextList": ...,
    "LanguageCode": ...,
}

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

classify_document#

Creates a classification request to analyze a single document in real-time.

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

# classify_document method definition

def classify_document(
    self,
    *,
    EndpointArn: str,
    Text: str = ...,
    Bytes: BlobTypeDef = ...,
    DocumentReaderConfig: DocumentReaderConfigTypeDef = ...,  # (1)
) -> ClassifyDocumentResponseTypeDef:  # (2)
    ...
  1. See DocumentReaderConfigTypeDef
  2. See ClassifyDocumentResponseTypeDef 
# classify_document method usage example with argument unpacking

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

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

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

# contains_pii_entities method definition

def contains_pii_entities(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> ContainsPiiEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See ContainsPiiEntitiesResponseTypeDef 
# contains_pii_entities method usage example with argument unpacking

kwargs: ContainsPiiEntitiesRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

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

create_dataset#

Creates a dataset to upload training or test data for a model associated with a flywheel.

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

# create_dataset method definition

def create_dataset(
    self,
    *,
    FlywheelArn: str,
    DatasetName: str,
    InputDataConfig: DatasetInputDataConfigTypeDef,  # (1)
    DatasetType: DatasetTypeType = ...,  # (2)
    Description: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDatasetResponseTypeDef:  # (4)
    ...
  1. See DatasetInputDataConfigTypeDef
  2. See DatasetTypeType
  3. See TagTypeDef
  4. See CreateDatasetResponseTypeDef 
# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
    "DatasetName": ...,
    "InputDataConfig": ...,
}

parent.create_dataset(**kwargs)
  1. See CreateDatasetRequestRequestTypeDef

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

# create_document_classifier 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 
# create_document_classifier method usage example with argument unpacking

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

# create_endpoint method definition

def create_endpoint(
    self,
    *,
    EndpointName: str,
    DesiredInferenceUnits: int,
    ModelArn: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    DataAccessRoleArn: str = ...,
    FlywheelArn: str = ...,
) -> CreateEndpointResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateEndpointResponseTypeDef 
# create_endpoint method usage example with argument unpacking

kwargs: CreateEndpointRequestRequestTypeDef = {  # (1)
    "EndpointName": ...,
    "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

# create_entity_recognizer 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 
# create_entity_recognizer method usage example with argument unpacking

kwargs: CreateEntityRecognizerRequestRequestTypeDef = {  # (1)
    "RecognizerName": ...,
    "DataAccessRoleArn": ...,
    "InputDataConfig": ...,
    "LanguageCode": ...,
}

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

create_flywheel#

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.

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

# create_flywheel method definition

def create_flywheel(
    self,
    *,
    FlywheelName: str,
    DataAccessRoleArn: str,
    DataLakeS3Uri: str,
    ActiveModelArn: str = ...,
    TaskConfig: TaskConfigTypeDef = ...,  # (1)
    ModelType: ModelTypeType = ...,  # (2)
    DataSecurityConfig: DataSecurityConfigTypeDef = ...,  # (3)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateFlywheelResponseTypeDef:  # (5)
    ...
  1. See TaskConfigTypeDef
  2. See ModelTypeType
  3. See DataSecurityConfigTypeDef
  4. See TagTypeDef
  5. See CreateFlywheelResponseTypeDef 
# create_flywheel method usage example with argument unpacking

kwargs: CreateFlywheelRequestRequestTypeDef = {  # (1)
    "FlywheelName": ...,
    "DataAccessRoleArn": ...,
    "DataLakeS3Uri": ...,
}

parent.create_flywheel(**kwargs)
  1. See CreateFlywheelRequestRequestTypeDef

delete_document_classifier#

Deletes a previously created document classifier.

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

# delete_document_classifier method definition

def delete_document_classifier(
    self,
    *,
    DocumentClassifierArn: str,
) -> dict[str, Any]:
    ...
# delete_document_classifier method usage example with argument unpacking

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

# delete_endpoint method definition

def delete_endpoint(
    self,
    *,
    EndpointArn: str,
) -> dict[str, Any]:
    ...
# delete_endpoint method usage example with argument unpacking

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

# delete_entity_recognizer method definition

def delete_entity_recognizer(
    self,
    *,
    EntityRecognizerArn: str,
) -> dict[str, Any]:
    ...
# delete_entity_recognizer method usage example with argument unpacking

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

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

delete_flywheel#

Deletes a flywheel.

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

# delete_flywheel method definition

def delete_flywheel(
    self,
    *,
    FlywheelArn: str,
) -> dict[str, Any]:
    ...
# delete_flywheel method usage example with argument unpacking

kwargs: DeleteFlywheelRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
}

parent.delete_flywheel(**kwargs)
  1. See DeleteFlywheelRequestRequestTypeDef

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
    PolicyRevisionId: str = ...,
) -> dict[str, Any]:
    ...
# delete_resource_policy method usage example with argument unpacking

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

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

describe_dataset#

Returns information about the dataset that you specify.

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

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    DatasetArn: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...
  1. See DescribeDatasetResponseTypeDef 
# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.describe_dataset(**kwargs)
  1. See DescribeDatasetRequestRequestTypeDef

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

# describe_document_classification_job method definition

def describe_document_classification_job(
    self,
    *,
    JobId: str,
) -> DescribeDocumentClassificationJobResponseTypeDef:  # (1)
    ...
  1. See DescribeDocumentClassificationJobResponseTypeDef 
# describe_document_classification_job method usage example with argument unpacking

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

# describe_document_classifier method definition

def describe_document_classifier(
    self,
    *,
    DocumentClassifierArn: str,
) -> DescribeDocumentClassifierResponseTypeDef:  # (1)
    ...
  1. See DescribeDocumentClassifierResponseTypeDef 
# describe_document_classifier method usage example with argument unpacking

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

# describe_dominant_language_detection_job method definition

def describe_dominant_language_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeDominantLanguageDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeDominantLanguageDetectionJobResponseTypeDef 
# describe_dominant_language_detection_job method usage example with argument unpacking

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

# describe_endpoint method definition

def describe_endpoint(
    self,
    *,
    EndpointArn: str,
) -> DescribeEndpointResponseTypeDef:  # (1)
    ...
  1. See DescribeEndpointResponseTypeDef 
# describe_endpoint method usage example with argument unpacking

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

# describe_entities_detection_job method definition

def describe_entities_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeEntitiesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeEntitiesDetectionJobResponseTypeDef 
# describe_entities_detection_job method usage example with argument unpacking

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

# describe_entity_recognizer method definition

def describe_entity_recognizer(
    self,
    *,
    EntityRecognizerArn: str,
) -> DescribeEntityRecognizerResponseTypeDef:  # (1)
    ...
  1. See DescribeEntityRecognizerResponseTypeDef 
# describe_entity_recognizer method usage example with argument unpacking

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

# describe_events_detection_job method definition

def describe_events_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeEventsDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeEventsDetectionJobResponseTypeDef 
# describe_events_detection_job method usage example with argument unpacking

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

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

describe_flywheel#

Provides configuration information about the flywheel.

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

# describe_flywheel method definition

def describe_flywheel(
    self,
    *,
    FlywheelArn: str,
) -> DescribeFlywheelResponseTypeDef:  # (1)
    ...
  1. See DescribeFlywheelResponseTypeDef 
# describe_flywheel method usage example with argument unpacking

kwargs: DescribeFlywheelRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
}

parent.describe_flywheel(**kwargs)
  1. See DescribeFlywheelRequestRequestTypeDef

describe_flywheel_iteration#

Retrieve the configuration properties of a flywheel iteration.

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

# describe_flywheel_iteration method definition

def describe_flywheel_iteration(
    self,
    *,
    FlywheelArn: str,
    FlywheelIterationId: str,
) -> DescribeFlywheelIterationResponseTypeDef:  # (1)
    ...
  1. See DescribeFlywheelIterationResponseTypeDef 
# describe_flywheel_iteration method usage example with argument unpacking

kwargs: DescribeFlywheelIterationRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
    "FlywheelIterationId": ...,
}

parent.describe_flywheel_iteration(**kwargs)
  1. See DescribeFlywheelIterationRequestRequestTypeDef

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

# describe_key_phrases_detection_job method definition

def describe_key_phrases_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeKeyPhrasesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeKeyPhrasesDetectionJobResponseTypeDef 
# describe_key_phrases_detection_job method usage example with argument unpacking

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

# describe_pii_entities_detection_job method definition

def describe_pii_entities_detection_job(
    self,
    *,
    JobId: str,
) -> DescribePiiEntitiesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribePiiEntitiesDetectionJobResponseTypeDef 
# describe_pii_entities_detection_job method usage example with argument unpacking

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

# describe_resource_policy method definition

def describe_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See DescribeResourcePolicyResponseTypeDef 
# describe_resource_policy method usage example with argument unpacking

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

# describe_sentiment_detection_job method definition

def describe_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeSentimentDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeSentimentDetectionJobResponseTypeDef 
# describe_sentiment_detection_job method usage example with argument unpacking

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

# describe_targeted_sentiment_detection_job method definition

def describe_targeted_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeTargetedSentimentDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeTargetedSentimentDetectionJobResponseTypeDef 
# describe_targeted_sentiment_detection_job method usage example with argument unpacking

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

# describe_topics_detection_job method definition

def describe_topics_detection_job(
    self,
    *,
    JobId: str,
) -> DescribeTopicsDetectionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeTopicsDetectionJobResponseTypeDef 
# describe_topics_detection_job method usage example with argument unpacking

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

# detect_dominant_language method definition

def detect_dominant_language(
    self,
    *,
    Text: str,
) -> DetectDominantLanguageResponseTypeDef:  # (1)
    ...
  1. See DetectDominantLanguageResponseTypeDef 
# detect_dominant_language method usage example with argument unpacking

kwargs: DetectDominantLanguageRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

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

detect_entities#

Detects named entities in input text when you use the pre-trained model.

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

# detect_entities method definition

def detect_entities(
    self,
    *,
    Text: str = ...,
    LanguageCode: LanguageCodeType = ...,  # (1)
    EndpointArn: str = ...,
    Bytes: BlobTypeDef = ...,
    DocumentReaderConfig: DocumentReaderConfigTypeDef = ...,  # (2)
) -> DetectEntitiesResponseTypeDef:  # (3)
    ...
  1. See LanguageCodeType
  2. See DocumentReaderConfigTypeDef
  3. See DetectEntitiesResponseTypeDef 
# detect_entities method usage example with argument unpacking

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

# detect_key_phrases method definition

def detect_key_phrases(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectKeyPhrasesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectKeyPhrasesResponseTypeDef 
# detect_key_phrases method usage example with argument unpacking

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

# detect_pii_entities method definition

def detect_pii_entities(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectPiiEntitiesResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectPiiEntitiesResponseTypeDef 
# detect_pii_entities method usage example with argument unpacking

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

# detect_sentiment method definition

def detect_sentiment(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectSentimentResponseTypeDef 
# detect_sentiment method usage example with argument unpacking

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

# detect_syntax method definition

def detect_syntax(
    self,
    *,
    Text: str,
    LanguageCode: SyntaxLanguageCodeType,  # (1)
) -> DetectSyntaxResponseTypeDef:  # (2)
    ...
  1. See SyntaxLanguageCodeType
  2. See DetectSyntaxResponseTypeDef 
# detect_syntax method usage example with argument unpacking

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

# detect_targeted_sentiment method definition

def detect_targeted_sentiment(
    self,
    *,
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
) -> DetectTargetedSentimentResponseTypeDef:  # (2)
    ...
  1. See LanguageCodeType
  2. See DetectTargetedSentimentResponseTypeDef 
# detect_targeted_sentiment method usage example with argument unpacking

kwargs: DetectTargetedSentimentRequestRequestTypeDef = {  # (1)
    "Text": ...,
    "LanguageCode": ...,
}

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

detect_toxic_content#

Performs toxicity analysis on the list of text strings that you provide as input.

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

# detect_toxic_content method definition

def detect_toxic_content(
    self,
    *,
    TextSegments: Sequence[TextSegmentTypeDef],  # (1)
    LanguageCode: LanguageCodeType,  # (2)
) -> DetectToxicContentResponseTypeDef:  # (3)
    ...
  1. See TextSegmentTypeDef
  2. See LanguageCodeType
  3. See DetectToxicContentResponseTypeDef 
# detect_toxic_content method usage example with argument unpacking

kwargs: DetectToxicContentRequestRequestTypeDef = {  # (1)
    "TextSegments": ...,
    "LanguageCode": ...,
}

parent.detect_toxic_content(**kwargs)
  1. See DetectToxicContentRequestRequestTypeDef

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

# import_model 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 
# import_model method usage example with argument unpacking

kwargs: ImportModelRequestRequestTypeDef = {  # (1)
    "SourceModelArn": ...,
}

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

list_datasets#

List the datasets that you have configured in this Region.

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

# list_datasets method definition

def list_datasets(
    self,
    *,
    FlywheelArn: str = ...,
    Filter: DatasetFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (2)
    ...
  1. See DatasetFilterTypeDef
  2. See ListDatasetsResponseTypeDef 
# list_datasets method usage example with argument unpacking

kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
}

parent.list_datasets(**kwargs)
  1. See ListDatasetsRequestRequestTypeDef

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

# list_document_classification_jobs method definition

def list_document_classification_jobs(
    self,
    *,
    Filter: DocumentClassificationJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentClassificationJobsResponseTypeDef:  # (2)
    ...
  1. See DocumentClassificationJobFilterTypeDef
  2. See ListDocumentClassificationJobsResponseTypeDef 
# list_document_classification_jobs method usage example with argument unpacking

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.

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

# list_document_classifier_summaries method definition

def list_document_classifier_summaries(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentClassifierSummariesResponseTypeDef:  # (1)
    ...
  1. See ListDocumentClassifierSummariesResponseTypeDef 
# list_document_classifier_summaries method usage example with argument unpacking

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

# list_document_classifiers method definition

def list_document_classifiers(
    self,
    *,
    Filter: DocumentClassifierFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentClassifiersResponseTypeDef:  # (2)
    ...
  1. See DocumentClassifierFilterTypeDef
  2. See ListDocumentClassifiersResponseTypeDef 
# list_document_classifiers method usage example with argument unpacking

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

# list_dominant_language_detection_jobs method definition

def list_dominant_language_detection_jobs(
    self,
    *,
    Filter: DominantLanguageDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDominantLanguageDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See DominantLanguageDetectionJobFilterTypeDef
  2. See ListDominantLanguageDetectionJobsResponseTypeDef 
# list_dominant_language_detection_jobs method usage example with argument unpacking

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

# list_endpoints method definition

def list_endpoints(
    self,
    *,
    Filter: EndpointFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEndpointsResponseTypeDef:  # (2)
    ...
  1. See EndpointFilterTypeDef
  2. See ListEndpointsResponseTypeDef 
# list_endpoints method usage example with argument unpacking

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

# list_entities_detection_jobs method definition

def list_entities_detection_jobs(
    self,
    *,
    Filter: EntitiesDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntitiesDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See EntitiesDetectionJobFilterTypeDef
  2. See ListEntitiesDetectionJobsResponseTypeDef 
# list_entities_detection_jobs method usage example with argument unpacking

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

# list_entity_recognizer_summaries method definition

def list_entity_recognizer_summaries(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntityRecognizerSummariesResponseTypeDef:  # (1)
    ...
  1. See ListEntityRecognizerSummariesResponseTypeDef 
# list_entity_recognizer_summaries method usage example with argument unpacking

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

# list_entity_recognizers method definition

def list_entity_recognizers(
    self,
    *,
    Filter: EntityRecognizerFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntityRecognizersResponseTypeDef:  # (2)
    ...
  1. See EntityRecognizerFilterTypeDef
  2. See ListEntityRecognizersResponseTypeDef 
# list_entity_recognizers method usage example with argument unpacking

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

# list_events_detection_jobs method definition

def list_events_detection_jobs(
    self,
    *,
    Filter: EventsDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEventsDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See EventsDetectionJobFilterTypeDef
  2. See ListEventsDetectionJobsResponseTypeDef 
# list_events_detection_jobs method usage example with argument unpacking

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

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

list_flywheel_iteration_history#

Information about the history of a flywheel iteration.

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

# list_flywheel_iteration_history method definition

def list_flywheel_iteration_history(
    self,
    *,
    FlywheelArn: str,
    Filter: FlywheelIterationFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFlywheelIterationHistoryResponseTypeDef:  # (2)
    ...
  1. See FlywheelIterationFilterTypeDef
  2. See ListFlywheelIterationHistoryResponseTypeDef 
# list_flywheel_iteration_history method usage example with argument unpacking

kwargs: ListFlywheelIterationHistoryRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
}

parent.list_flywheel_iteration_history(**kwargs)
  1. See ListFlywheelIterationHistoryRequestRequestTypeDef

list_flywheels#

Gets a list of the flywheels that you have created.

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

# list_flywheels method definition

def list_flywheels(
    self,
    *,
    Filter: FlywheelFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFlywheelsResponseTypeDef:  # (2)
    ...
  1. See FlywheelFilterTypeDef
  2. See ListFlywheelsResponseTypeDef 
# list_flywheels method usage example with argument unpacking

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

parent.list_flywheels(**kwargs)
  1. See ListFlywheelsRequestRequestTypeDef

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

# list_key_phrases_detection_jobs method definition

def list_key_phrases_detection_jobs(
    self,
    *,
    Filter: KeyPhrasesDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListKeyPhrasesDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See KeyPhrasesDetectionJobFilterTypeDef
  2. See ListKeyPhrasesDetectionJobsResponseTypeDef 
# list_key_phrases_detection_jobs method usage example with argument unpacking

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

# list_pii_entities_detection_jobs method definition

def list_pii_entities_detection_jobs(
    self,
    *,
    Filter: PiiEntitiesDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPiiEntitiesDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See PiiEntitiesDetectionJobFilterTypeDef
  2. See ListPiiEntitiesDetectionJobsResponseTypeDef 
# list_pii_entities_detection_jobs method usage example with argument unpacking

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

# list_sentiment_detection_jobs method definition

def list_sentiment_detection_jobs(
    self,
    *,
    Filter: SentimentDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSentimentDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See SentimentDetectionJobFilterTypeDef
  2. See ListSentimentDetectionJobsResponseTypeDef 
# list_sentiment_detection_jobs method usage example with argument unpacking

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

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. boto3 documentation

# list_targeted_sentiment_detection_jobs method definition

def list_targeted_sentiment_detection_jobs(
    self,
    *,
    Filter: TargetedSentimentDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTargetedSentimentDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See TargetedSentimentDetectionJobFilterTypeDef
  2. See ListTargetedSentimentDetectionJobsResponseTypeDef 
# list_targeted_sentiment_detection_jobs method usage example with argument unpacking

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

# list_topics_detection_jobs method definition

def list_topics_detection_jobs(
    self,
    *,
    Filter: TopicsDetectionJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTopicsDetectionJobsResponseTypeDef:  # (2)
    ...
  1. See TopicsDetectionJobFilterTypeDef
  2. See ListTopicsDetectionJobsResponseTypeDef 
# list_topics_detection_jobs method usage example with argument unpacking

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

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    ResourcePolicy: str,
    PolicyRevisionId: str = ...,
) -> PutResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See PutResourcePolicyResponseTypeDef 
# put_resource_policy method usage example with argument unpacking

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

parent.put_resource_policy(**kwargs)
  1. See PutResourcePolicyRequestRequestTypeDef

start_document_classification_job#

Starts an asynchronous document classification job using a custom classification model.

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

# start_document_classification_job method definition

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

kwargs: StartDocumentClassificationJobRequestRequestTypeDef = {  # (1)
    "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 boto3.client("comprehend").start_dominant_language_detection_job method. boto3 documentation

# start_dominant_language_detection_job method definition

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 
# start_dominant_language_detection_job method usage example with argument unpacking

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

# start_entities_detection_job method definition

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)
    FlywheelArn: str = ...,
) -> StartEntitiesDetectionJobResponseTypeDef:  # (6)
    ...
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See LanguageCodeType
  4. See VpcConfigTypeDef
  5. See TagTypeDef
  6. See StartEntitiesDetectionJobResponseTypeDef 
# start_entities_detection_job method usage example with argument unpacking

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

# start_events_detection_job method definition

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 
# start_events_detection_job method usage example with argument unpacking

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

parent.start_events_detection_job(**kwargs)
  1. See StartEventsDetectionJobRequestRequestTypeDef

start_flywheel_iteration#

Start the flywheel iteration.This operation uses any new datasets to train a new model version.

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

# start_flywheel_iteration method definition

def start_flywheel_iteration(
    self,
    *,
    FlywheelArn: str,
    ClientRequestToken: str = ...,
) -> StartFlywheelIterationResponseTypeDef:  # (1)
    ...
  1. See StartFlywheelIterationResponseTypeDef 
# start_flywheel_iteration method usage example with argument unpacking

kwargs: StartFlywheelIterationRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
}

parent.start_flywheel_iteration(**kwargs)
  1. See StartFlywheelIterationRequestRequestTypeDef

start_key_phrases_detection_job#

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

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

# start_key_phrases_detection_job method definition

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 
# start_key_phrases_detection_job method usage example with argument unpacking

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

# start_pii_entities_detection_job method definition

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 
# start_pii_entities_detection_job method usage example with argument unpacking

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

# start_sentiment_detection_job method definition

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 
# start_sentiment_detection_job method usage example with argument unpacking

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

# start_targeted_sentiment_detection_job method definition

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 
# start_targeted_sentiment_detection_job method usage example with argument unpacking

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

# start_topics_detection_job method definition

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 
# start_topics_detection_job method usage example with argument unpacking

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

# stop_dominant_language_detection_job method definition

def stop_dominant_language_detection_job(
    self,
    *,
    JobId: str,
) -> StopDominantLanguageDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopDominantLanguageDetectionJobResponseTypeDef 
# stop_dominant_language_detection_job method usage example with argument unpacking

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

# stop_entities_detection_job method definition

def stop_entities_detection_job(
    self,
    *,
    JobId: str,
) -> StopEntitiesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopEntitiesDetectionJobResponseTypeDef 
# stop_entities_detection_job method usage example with argument unpacking

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

# stop_events_detection_job method definition

def stop_events_detection_job(
    self,
    *,
    JobId: str,
) -> StopEventsDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopEventsDetectionJobResponseTypeDef 
# stop_events_detection_job method usage example with argument unpacking

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

# stop_key_phrases_detection_job method definition

def stop_key_phrases_detection_job(
    self,
    *,
    JobId: str,
) -> StopKeyPhrasesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopKeyPhrasesDetectionJobResponseTypeDef 
# stop_key_phrases_detection_job method usage example with argument unpacking

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

# stop_pii_entities_detection_job method definition

def stop_pii_entities_detection_job(
    self,
    *,
    JobId: str,
) -> StopPiiEntitiesDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopPiiEntitiesDetectionJobResponseTypeDef 
# stop_pii_entities_detection_job method usage example with argument unpacking

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

# stop_sentiment_detection_job method definition

def stop_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> StopSentimentDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopSentimentDetectionJobResponseTypeDef 
# stop_sentiment_detection_job method usage example with argument unpacking

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

# stop_targeted_sentiment_detection_job method definition

def stop_targeted_sentiment_detection_job(
    self,
    *,
    JobId: str,
) -> StopTargetedSentimentDetectionJobResponseTypeDef:  # (1)
    ...
  1. See StopTargetedSentimentDetectionJobResponseTypeDef 
# stop_targeted_sentiment_detection_job method usage example with argument unpacking

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

# stop_training_document_classifier method definition

def stop_training_document_classifier(
    self,
    *,
    DocumentClassifierArn: str,
) -> dict[str, Any]:
    ...
# stop_training_document_classifier method usage example with argument unpacking

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

# stop_training_entity_recognizer method definition

def stop_training_entity_recognizer(
    self,
    *,
    EntityRecognizerArn: str,
) -> dict[str, Any]:
    ...
# stop_training_entity_recognizer method usage example with argument unpacking

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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

# update_endpoint method definition

def update_endpoint(
    self,
    *,
    EndpointArn: str,
    DesiredModelArn: str = ...,
    DesiredInferenceUnits: int = ...,
    DesiredDataAccessRoleArn: str = ...,
    FlywheelArn: str = ...,
) -> UpdateEndpointResponseTypeDef:  # (1)
    ...
  1. See UpdateEndpointResponseTypeDef 
# update_endpoint method usage example with argument unpacking

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

parent.update_endpoint(**kwargs)
  1. See UpdateEndpointRequestRequestTypeDef

update_flywheel#

Update the configuration information for an existing flywheel.

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

# update_flywheel method definition

def update_flywheel(
    self,
    *,
    FlywheelArn: str,
    ActiveModelArn: str = ...,
    DataAccessRoleArn: str = ...,
    DataSecurityConfig: UpdateDataSecurityConfigTypeDef = ...,  # (1)
) -> UpdateFlywheelResponseTypeDef:  # (2)
    ...
  1. See UpdateDataSecurityConfigTypeDef
  2. See UpdateFlywheelResponseTypeDef 
# update_flywheel method usage example with argument unpacking

kwargs: UpdateFlywheelRequestRequestTypeDef = {  # (1)
    "FlywheelArn": ...,
}

parent.update_flywheel(**kwargs)
  1. See UpdateFlywheelRequestRequestTypeDef

get_paginator#

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