Skip to content

Typed dictionaries

Index > Comprehend > Typed dictionaries

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

AugmentedManifestsListItemTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import AugmentedManifestsListItemTypeDef

def get_value() -> AugmentedManifestsListItemTypeDef:
    return {
        "S3Uri": ...,
        "AttributeNames": ...,
    }
Definition
class AugmentedManifestsListItemTypeDef(TypedDict):
    S3Uri: str,
    AttributeNames: Sequence[str],
    Split: NotRequired[SplitType],  # (1)
    AnnotationDataS3Uri: NotRequired[str],
    SourceDocumentsS3Uri: NotRequired[str],
    DocumentType: NotRequired[AugmentedManifestsDocumentTypeFormatType],  # (2)
  1. See SplitType
  2. See AugmentedManifestsDocumentTypeFormatType

DominantLanguageTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DominantLanguageTypeDef

def get_value() -> DominantLanguageTypeDef:
    return {
        "LanguageCode": ...,
    }
Definition
class DominantLanguageTypeDef(TypedDict):
    LanguageCode: NotRequired[str],
    Score: NotRequired[float],

BatchDetectDominantLanguageRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageRequestRequestTypeDef

def get_value() -> BatchDetectDominantLanguageRequestRequestTypeDef:
    return {
        "TextList": ...,
    }
Definition
class BatchDetectDominantLanguageRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],

BatchItemErrorTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchItemErrorTypeDef

def get_value() -> BatchItemErrorTypeDef:
    return {
        "Index": ...,
    }
Definition
class BatchItemErrorTypeDef(TypedDict):
    Index: NotRequired[int],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

EntityTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityTypeDef

def get_value() -> EntityTypeDef:
    return {
        "Score": ...,
    }
Definition
class EntityTypeDef(TypedDict):
    Score: NotRequired[float],
    Type: NotRequired[EntityTypeType],  # (1)
    Text: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
  1. See EntityTypeType

BatchDetectEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectEntitiesRequestRequestTypeDef

def get_value() -> BatchDetectEntitiesRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }
Definition
class BatchDetectEntitiesRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

KeyPhraseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import KeyPhraseTypeDef

def get_value() -> KeyPhraseTypeDef:
    return {
        "Score": ...,
    }
Definition
class KeyPhraseTypeDef(TypedDict):
    Score: NotRequired[float],
    Text: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

BatchDetectKeyPhrasesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectKeyPhrasesRequestRequestTypeDef

def get_value() -> BatchDetectKeyPhrasesRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }
Definition
class BatchDetectKeyPhrasesRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

SentimentScoreTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import SentimentScoreTypeDef

def get_value() -> SentimentScoreTypeDef:
    return {
        "Positive": ...,
    }
Definition
class SentimentScoreTypeDef(TypedDict):
    Positive: NotRequired[float],
    Negative: NotRequired[float],
    Neutral: NotRequired[float],
    Mixed: NotRequired[float],

BatchDetectSentimentRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectSentimentRequestRequestTypeDef

def get_value() -> BatchDetectSentimentRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }
Definition
class BatchDetectSentimentRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

BatchDetectSyntaxRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectSyntaxRequestRequestTypeDef

def get_value() -> BatchDetectSyntaxRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }
Definition
class BatchDetectSyntaxRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: SyntaxLanguageCodeType,  # (1)
  1. See SyntaxLanguageCodeType

BatchDetectTargetedSentimentRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectTargetedSentimentRequestRequestTypeDef

def get_value() -> BatchDetectTargetedSentimentRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }
Definition
class BatchDetectTargetedSentimentRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

ClassifierEvaluationMetricsTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ClassifierEvaluationMetricsTypeDef

def get_value() -> ClassifierEvaluationMetricsTypeDef:
    return {
        "Accuracy": ...,
    }
Definition
class ClassifierEvaluationMetricsTypeDef(TypedDict):
    Accuracy: NotRequired[float],
    Precision: NotRequired[float],
    Recall: NotRequired[float],
    F1Score: NotRequired[float],
    MicroPrecision: NotRequired[float],
    MicroRecall: NotRequired[float],
    MicroF1Score: NotRequired[float],
    HammingLoss: NotRequired[float],

ClassifyDocumentRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ClassifyDocumentRequestRequestTypeDef

def get_value() -> ClassifyDocumentRequestRequestTypeDef:
    return {
        "Text": ...,
        "EndpointArn": ...,
    }
Definition
class ClassifyDocumentRequestRequestTypeDef(TypedDict):
    Text: str,
    EndpointArn: str,

DocumentClassTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassTypeDef

def get_value() -> DocumentClassTypeDef:
    return {
        "Name": ...,
    }
Definition
class DocumentClassTypeDef(TypedDict):
    Name: NotRequired[str],
    Score: NotRequired[float],

DocumentLabelTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentLabelTypeDef

def get_value() -> DocumentLabelTypeDef:
    return {
        "Name": ...,
    }
Definition
class DocumentLabelTypeDef(TypedDict):
    Name: NotRequired[str],
    Score: NotRequired[float],

ContainsPiiEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ContainsPiiEntitiesRequestRequestTypeDef

def get_value() -> ContainsPiiEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }
Definition
class ContainsPiiEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

EntityLabelTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityLabelTypeDef

def get_value() -> EntityLabelTypeDef:
    return {
        "Name": ...,
    }
Definition
class EntityLabelTypeDef(TypedDict):
    Name: NotRequired[PiiEntityTypeType],  # (1)
    Score: NotRequired[float],
  1. See PiiEntityTypeType

DocumentClassifierOutputDataConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierOutputDataConfigTypeDef

def get_value() -> DocumentClassifierOutputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class DocumentClassifierOutputDataConfigTypeDef(TypedDict):
    S3Uri: NotRequired[str],
    KmsKeyId: NotRequired[str],

TagTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

VpcConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import VpcConfigTypeDef

def get_value() -> VpcConfigTypeDef:
    return {
        "SecurityGroupIds": ...,
        "Subnets": ...,
    }
Definition
class VpcConfigTypeDef(TypedDict):
    SecurityGroupIds: Sequence[str],
    Subnets: Sequence[str],

DeleteDocumentClassifierRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DeleteDocumentClassifierRequestRequestTypeDef

def get_value() -> DeleteDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
    }
Definition
class DeleteDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DeleteEndpointRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DeleteEndpointRequestRequestTypeDef

def get_value() -> DeleteEndpointRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }
Definition
class DeleteEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

DeleteEntityRecognizerRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DeleteEntityRecognizerRequestRequestTypeDef

def get_value() -> DeleteEntityRecognizerRequestRequestTypeDef:
    return {
        "EntityRecognizerArn": ...,
    }
Definition
class DeleteEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DeleteResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DeleteResourcePolicyRequestRequestTypeDef

def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    PolicyRevisionId: NotRequired[str],

DescribeDocumentClassificationJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeDocumentClassificationJobRequestRequestTypeDef

def get_value() -> DescribeDocumentClassificationJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeDocumentClassificationJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeDocumentClassifierRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeDocumentClassifierRequestRequestTypeDef

def get_value() -> DescribeDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
    }
Definition
class DescribeDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DescribeDominantLanguageDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeDominantLanguageDetectionJobRequestRequestTypeDef

def get_value() -> DescribeDominantLanguageDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEndpointRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEndpointRequestRequestTypeDef

def get_value() -> DescribeEndpointRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }
Definition
class DescribeEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

EndpointPropertiesTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EndpointPropertiesTypeDef

def get_value() -> EndpointPropertiesTypeDef:
    return {
        "EndpointArn": ...,
    }
Definition
class EndpointPropertiesTypeDef(TypedDict):
    EndpointArn: NotRequired[str],
    Status: NotRequired[EndpointStatusType],  # (1)
    Message: NotRequired[str],
    ModelArn: NotRequired[str],
    DesiredModelArn: NotRequired[str],
    DesiredInferenceUnits: NotRequired[int],
    CurrentInferenceUnits: NotRequired[int],
    CreationTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    DataAccessRoleArn: NotRequired[str],
    DesiredDataAccessRoleArn: NotRequired[str],
  1. See EndpointStatusType

DescribeEntitiesDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> DescribeEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEntityRecognizerRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEntityRecognizerRequestRequestTypeDef

def get_value() -> DescribeEntityRecognizerRequestRequestTypeDef:
    return {
        "EntityRecognizerArn": ...,
    }
Definition
class DescribeEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DescribeEventsDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEventsDetectionJobRequestRequestTypeDef

def get_value() -> DescribeEventsDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

def get_value() -> DescribeKeyPhrasesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePiiEntitiesDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribePiiEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> DescribePiiEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribePiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeResourcePolicyRequestRequestTypeDef

def get_value() -> DescribeResourcePolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class DescribeResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DescribeSentimentDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeSentimentDetectionJobRequestRequestTypeDef

def get_value() -> DescribeSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

def get_value() -> DescribeTargetedSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTopicsDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeTopicsDetectionJobRequestRequestTypeDef

def get_value() -> DescribeTopicsDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class DescribeTopicsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DetectDominantLanguageRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectDominantLanguageRequestRequestTypeDef

def get_value() -> DetectDominantLanguageRequestRequestTypeDef:
    return {
        "Text": ...,
    }
Definition
class DetectDominantLanguageRequestRequestTypeDef(TypedDict):
    Text: str,

DetectEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectEntitiesRequestRequestTypeDef

def get_value() -> DetectEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
    }
Definition
class DetectEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    EndpointArn: NotRequired[str],
  1. See LanguageCodeType

DetectKeyPhrasesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectKeyPhrasesRequestRequestTypeDef

def get_value() -> DetectKeyPhrasesRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }
Definition
class DetectKeyPhrasesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

DetectPiiEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectPiiEntitiesRequestRequestTypeDef

def get_value() -> DetectPiiEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }
Definition
class DetectPiiEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

PiiEntityTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PiiEntityTypeDef

def get_value() -> PiiEntityTypeDef:
    return {
        "Score": ...,
    }
Definition
class PiiEntityTypeDef(TypedDict):
    Score: NotRequired[float],
    Type: NotRequired[PiiEntityTypeType],  # (1)
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
  1. See PiiEntityTypeType

DetectSentimentRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectSentimentRequestRequestTypeDef

def get_value() -> DetectSentimentRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }
Definition
class DetectSentimentRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

DetectSyntaxRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectSyntaxRequestRequestTypeDef

def get_value() -> DetectSyntaxRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }
Definition
class DetectSyntaxRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: SyntaxLanguageCodeType,  # (1)
  1. See SyntaxLanguageCodeType

DetectTargetedSentimentRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectTargetedSentimentRequestRequestTypeDef

def get_value() -> DetectTargetedSentimentRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }
Definition
class DetectTargetedSentimentRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)
  1. See LanguageCodeType

DocumentClassificationJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassificationJobFilterTypeDef

def get_value() -> DocumentClassificationJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class DocumentClassificationJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

OutputDataConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import OutputDataConfigTypeDef

def get_value() -> OutputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class OutputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: NotRequired[str],

DocumentClassifierFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierFilterTypeDef

def get_value() -> DocumentClassifierFilterTypeDef:
    return {
        "Status": ...,
    }
Definition
class DocumentClassifierFilterTypeDef(TypedDict):
    Status: NotRequired[ModelStatusType],  # (1)
    DocumentClassifierName: NotRequired[str],
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See ModelStatusType

DocumentClassifierSummaryTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierSummaryTypeDef

def get_value() -> DocumentClassifierSummaryTypeDef:
    return {
        "DocumentClassifierName": ...,
    }
Definition
class DocumentClassifierSummaryTypeDef(TypedDict):
    DocumentClassifierName: NotRequired[str],
    NumberOfVersions: NotRequired[int],
    LatestVersionCreatedAt: NotRequired[datetime],
    LatestVersionName: NotRequired[str],
    LatestVersionStatus: NotRequired[ModelStatusType],  # (1)
  1. See ModelStatusType

DocumentReaderConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentReaderConfigTypeDef

def get_value() -> DocumentReaderConfigTypeDef:
    return {
        "DocumentReadAction": ...,
    }
Definition
class DocumentReaderConfigTypeDef(TypedDict):
    DocumentReadAction: DocumentReadActionType,  # (1)
    DocumentReadMode: NotRequired[DocumentReadModeType],  # (2)
    FeatureTypes: NotRequired[List[DocumentReadFeatureTypesType]],  # (3)
  1. See DocumentReadActionType
  2. See DocumentReadModeType
  3. See DocumentReadFeatureTypesType

DominantLanguageDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DominantLanguageDetectionJobFilterTypeDef

def get_value() -> DominantLanguageDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class DominantLanguageDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

EndpointFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EndpointFilterTypeDef

def get_value() -> EndpointFilterTypeDef:
    return {
        "ModelArn": ...,
    }
Definition
class EndpointFilterTypeDef(TypedDict):
    ModelArn: NotRequired[str],
    Status: NotRequired[EndpointStatusType],  # (1)
    CreationTimeBefore: NotRequired[Union[datetime, str]],
    CreationTimeAfter: NotRequired[Union[datetime, str]],
  1. See EndpointStatusType

EntitiesDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntitiesDetectionJobFilterTypeDef

def get_value() -> EntitiesDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class EntitiesDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

EntityRecognizerAnnotationsTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerAnnotationsTypeDef

def get_value() -> EntityRecognizerAnnotationsTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class EntityRecognizerAnnotationsTypeDef(TypedDict):
    S3Uri: str,
    TestS3Uri: NotRequired[str],

EntityRecognizerDocumentsTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerDocumentsTypeDef

def get_value() -> EntityRecognizerDocumentsTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class EntityRecognizerDocumentsTypeDef(TypedDict):
    S3Uri: str,
    TestS3Uri: NotRequired[str],
    InputFormat: NotRequired[InputFormatType],  # (1)
  1. See InputFormatType

EntityRecognizerEntityListTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerEntityListTypeDef

def get_value() -> EntityRecognizerEntityListTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class EntityRecognizerEntityListTypeDef(TypedDict):
    S3Uri: str,

EntityRecognizerEvaluationMetricsTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerEvaluationMetricsTypeDef

def get_value() -> EntityRecognizerEvaluationMetricsTypeDef:
    return {
        "Precision": ...,
    }
Definition
class EntityRecognizerEvaluationMetricsTypeDef(TypedDict):
    Precision: NotRequired[float],
    Recall: NotRequired[float],
    F1Score: NotRequired[float],

EntityRecognizerFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerFilterTypeDef

def get_value() -> EntityRecognizerFilterTypeDef:
    return {
        "Status": ...,
    }
Definition
class EntityRecognizerFilterTypeDef(TypedDict):
    Status: NotRequired[ModelStatusType],  # (1)
    RecognizerName: NotRequired[str],
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See ModelStatusType

EntityTypesListItemTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityTypesListItemTypeDef

def get_value() -> EntityTypesListItemTypeDef:
    return {
        "Type": ...,
    }
Definition
class EntityTypesListItemTypeDef(TypedDict):
    Type: str,

EntityTypesEvaluationMetricsTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityTypesEvaluationMetricsTypeDef

def get_value() -> EntityTypesEvaluationMetricsTypeDef:
    return {
        "Precision": ...,
    }
Definition
class EntityTypesEvaluationMetricsTypeDef(TypedDict):
    Precision: NotRequired[float],
    Recall: NotRequired[float],
    F1Score: NotRequired[float],

EntityRecognizerSummaryTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerSummaryTypeDef

def get_value() -> EntityRecognizerSummaryTypeDef:
    return {
        "RecognizerName": ...,
    }
Definition
class EntityRecognizerSummaryTypeDef(TypedDict):
    RecognizerName: NotRequired[str],
    NumberOfVersions: NotRequired[int],
    LatestVersionCreatedAt: NotRequired[datetime],
    LatestVersionName: NotRequired[str],
    LatestVersionStatus: NotRequired[ModelStatusType],  # (1)
  1. See ModelStatusType

EventsDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import EventsDetectionJobFilterTypeDef

def get_value() -> EventsDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class EventsDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

KeyPhrasesDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import KeyPhrasesDetectionJobFilterTypeDef

def get_value() -> KeyPhrasesDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class KeyPhrasesDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDocumentClassifierSummariesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ListDocumentClassifierSummariesRequestRequestTypeDef

def get_value() -> ListDocumentClassifierSummariesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListDocumentClassifierSummariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListEntityRecognizerSummariesRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ListEntityRecognizerSummariesRequestRequestTypeDef

def get_value() -> ListEntityRecognizerSummariesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListEntityRecognizerSummariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PiiEntitiesDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PiiEntitiesDetectionJobFilterTypeDef

def get_value() -> PiiEntitiesDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class PiiEntitiesDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

SentimentDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import SentimentDetectionJobFilterTypeDef

def get_value() -> SentimentDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class SentimentDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TargetedSentimentDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import TargetedSentimentDetectionJobFilterTypeDef

def get_value() -> TargetedSentimentDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class TargetedSentimentDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

TopicsDetectionJobFilterTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import TopicsDetectionJobFilterTypeDef

def get_value() -> TopicsDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }
Definition
class TopicsDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

PartOfSpeechTagTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PartOfSpeechTagTypeDef

def get_value() -> PartOfSpeechTagTypeDef:
    return {
        "Tag": ...,
    }
Definition
class PartOfSpeechTagTypeDef(TypedDict):
    Tag: NotRequired[PartOfSpeechTagTypeType],  # (1)
    Score: NotRequired[float],
  1. See PartOfSpeechTagTypeType

PiiOutputDataConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PiiOutputDataConfigTypeDef

def get_value() -> PiiOutputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class PiiOutputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: NotRequired[str],

RedactionConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import RedactionConfigTypeDef

def get_value() -> RedactionConfigTypeDef:
    return {
        "PiiEntityTypes": ...,
    }
Definition
class RedactionConfigTypeDef(TypedDict):
    PiiEntityTypes: NotRequired[List[PiiEntityTypeType]],  # (1)
    MaskMode: NotRequired[PiiEntitiesDetectionMaskModeType],  # (2)
    MaskCharacter: NotRequired[str],
  1. See PiiEntityTypeType
  2. See PiiEntitiesDetectionMaskModeType

PutResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PutResourcePolicyRequestRequestTypeDef

def get_value() -> PutResourcePolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "ResourcePolicy": ...,
    }
Definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    ResourcePolicy: str,
    PolicyRevisionId: NotRequired[str],

StopDominantLanguageDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopDominantLanguageDetectionJobRequestRequestTypeDef

def get_value() -> StopDominantLanguageDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEntitiesDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> StopEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEventsDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopEventsDetectionJobRequestRequestTypeDef

def get_value() -> StopEventsDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopKeyPhrasesDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopKeyPhrasesDetectionJobRequestRequestTypeDef

def get_value() -> StopKeyPhrasesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopPiiEntitiesDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopPiiEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> StopPiiEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopPiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopSentimentDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopSentimentDetectionJobRequestRequestTypeDef

def get_value() -> StopSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTargetedSentimentDetectionJobRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopTargetedSentimentDetectionJobRequestRequestTypeDef

def get_value() -> StopTargetedSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }
Definition
class StopTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTrainingDocumentClassifierRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopTrainingDocumentClassifierRequestRequestTypeDef

def get_value() -> StopTrainingDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
    }
Definition
class StopTrainingDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

StopTrainingEntityRecognizerRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopTrainingEntityRecognizerRequestRequestTypeDef

def get_value() -> StopTrainingEntityRecognizerRequestRequestTypeDef:
    return {
        "EntityRecognizerArn": ...,
    }
Definition
class StopTrainingEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateEndpointRequestRequestTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import UpdateEndpointRequestRequestTypeDef

def get_value() -> UpdateEndpointRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }
Definition
class UpdateEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,
    DesiredModelArn: NotRequired[str],
    DesiredInferenceUnits: NotRequired[int],
    DesiredDataAccessRoleArn: NotRequired[str],

DocumentClassifierInputDataConfigTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierInputDataConfigTypeDef

def get_value() -> DocumentClassifierInputDataConfigTypeDef:
    return {
        "DataFormat": ...,
    }
Definition
class DocumentClassifierInputDataConfigTypeDef(TypedDict):
    DataFormat: NotRequired[DocumentClassifierDataFormatType],  # (1)
    S3Uri: NotRequired[str],
    TestS3Uri: NotRequired[str],
    LabelDelimiter: NotRequired[str],
    AugmentedManifests: NotRequired[Sequence[AugmentedManifestsListItemTypeDef]],  # (2)
  1. See DocumentClassifierDataFormatType
  2. See AugmentedManifestsListItemTypeDef

BatchDetectDominantLanguageItemResultTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageItemResultTypeDef

def get_value() -> BatchDetectDominantLanguageItemResultTypeDef:
    return {
        "Index": ...,
    }
Definition
class BatchDetectDominantLanguageItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Languages: NotRequired[List[DominantLanguageTypeDef]],  # (1)
  1. See DominantLanguageTypeDef

CreateDocumentClassifierResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import CreateDocumentClassifierResponseTypeDef

def get_value() -> CreateDocumentClassifierResponseTypeDef:
    return {
        "DocumentClassifierArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateDocumentClassifierResponseTypeDef(TypedDict):
    DocumentClassifierArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEndpointResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import CreateEndpointResponseTypeDef

def get_value() -> CreateEndpointResponseTypeDef:
    return {
        "EndpointArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateEndpointResponseTypeDef(TypedDict):
    EndpointArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEntityRecognizerResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import CreateEntityRecognizerResponseTypeDef

def get_value() -> CreateEntityRecognizerResponseTypeDef:
    return {
        "EntityRecognizerArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateEntityRecognizerResponseTypeDef(TypedDict):
    EntityRecognizerArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeResourcePolicyResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DescribeResourcePolicyResponseTypeDef

def get_value() -> DescribeResourcePolicyResponseTypeDef:
    return {
        "ResourcePolicy": ...,
        "CreationTime": ...,
        "LastModifiedTime": ...,
        "PolicyRevisionId": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeResourcePolicyResponseTypeDef(TypedDict):
    ResourcePolicy: str,
    CreationTime: datetime,
    LastModifiedTime: datetime,
    PolicyRevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DetectDominantLanguageResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectDominantLanguageResponseTypeDef

def get_value() -> DetectDominantLanguageResponseTypeDef:
    return {
        "Languages": ...,
        "ResponseMetadata": ...,
    }
Definition
class DetectDominantLanguageResponseTypeDef(TypedDict):
    Languages: List[DominantLanguageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DominantLanguageTypeDef
  2. See ResponseMetadataTypeDef

ImportModelResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import ImportModelResponseTypeDef

def get_value() -> ImportModelResponseTypeDef:
    return {
        "ModelArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class ImportModelResponseTypeDef(TypedDict):
    ModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import PutResourcePolicyResponseTypeDef

def get_value() -> PutResourcePolicyResponseTypeDef:
    return {
        "PolicyRevisionId": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutResourcePolicyResponseTypeDef(TypedDict):
    PolicyRevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartDocumentClassificationJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartDocumentClassificationJobResponseTypeDef

def get_value() -> StartDocumentClassificationJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartDocumentClassificationJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartDominantLanguageDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartDominantLanguageDetectionJobResponseTypeDef

def get_value() -> StartDominantLanguageDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartDominantLanguageDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartEntitiesDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartEntitiesDetectionJobResponseTypeDef

def get_value() -> StartEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartEventsDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartEventsDetectionJobResponseTypeDef

def get_value() -> StartEventsDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartEventsDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartKeyPhrasesDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartKeyPhrasesDetectionJobResponseTypeDef

def get_value() -> StartKeyPhrasesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartKeyPhrasesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartPiiEntitiesDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartPiiEntitiesDetectionJobResponseTypeDef

def get_value() -> StartPiiEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartPiiEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartSentimentDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartSentimentDetectionJobResponseTypeDef

def get_value() -> StartSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartTargetedSentimentDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartTargetedSentimentDetectionJobResponseTypeDef

def get_value() -> StartTargetedSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartTargetedSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartTopicsDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StartTopicsDetectionJobResponseTypeDef

def get_value() -> StartTopicsDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartTopicsDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopDominantLanguageDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopDominantLanguageDetectionJobResponseTypeDef

def get_value() -> StopDominantLanguageDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopDominantLanguageDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopEntitiesDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopEntitiesDetectionJobResponseTypeDef

def get_value() -> StopEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopEventsDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopEventsDetectionJobResponseTypeDef

def get_value() -> StopEventsDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopEventsDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopKeyPhrasesDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopKeyPhrasesDetectionJobResponseTypeDef

def get_value() -> StopKeyPhrasesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopKeyPhrasesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopPiiEntitiesDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopPiiEntitiesDetectionJobResponseTypeDef

def get_value() -> StopPiiEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopPiiEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopSentimentDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopSentimentDetectionJobResponseTypeDef

def get_value() -> StopSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StopTargetedSentimentDetectionJobResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import StopTargetedSentimentDetectionJobResponseTypeDef

def get_value() -> StopTargetedSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }
Definition
class StopTargetedSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

BatchDetectEntitiesItemResultTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectEntitiesItemResultTypeDef

def get_value() -> BatchDetectEntitiesItemResultTypeDef:
    return {
        "Index": ...,
    }
Definition
class BatchDetectEntitiesItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Entities: NotRequired[List[EntityTypeDef]],  # (1)
  1. See EntityTypeDef

DetectEntitiesResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectEntitiesResponseTypeDef

def get_value() -> DetectEntitiesResponseTypeDef:
    return {
        "Entities": ...,
        "ResponseMetadata": ...,
    }
Definition
class DetectEntitiesResponseTypeDef(TypedDict):
    Entities: List[EntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EntityTypeDef
  2. See ResponseMetadataTypeDef

BatchDetectKeyPhrasesItemResultTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectKeyPhrasesItemResultTypeDef

def get_value() -> BatchDetectKeyPhrasesItemResultTypeDef:
    return {
        "Index": ...,
    }
Definition
class BatchDetectKeyPhrasesItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    KeyPhrases: NotRequired[List[KeyPhraseTypeDef]],  # (1)
  1. See KeyPhraseTypeDef

DetectKeyPhrasesResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectKeyPhrasesResponseTypeDef

def get_value() -> DetectKeyPhrasesResponseTypeDef:
    return {
        "KeyPhrases": ...,
        "ResponseMetadata": ...,
    }
Definition
class DetectKeyPhrasesResponseTypeDef(TypedDict):
    KeyPhrases: List[KeyPhraseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyPhraseTypeDef
  2. See ResponseMetadataTypeDef

BatchDetectSentimentItemResultTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectSentimentItemResultTypeDef

def get_value() -> BatchDetectSentimentItemResultTypeDef:
    return {
        "Index": ...,
    }
Definition
class BatchDetectSentimentItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Sentiment: NotRequired[SentimentTypeType],  # (1)
    SentimentScore: NotRequired[SentimentScoreTypeDef],  # (2)
  1. See SentimentTypeType
  2. See SentimentScoreTypeDef

DetectSentimentResponseTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import DetectSentimentResponseTypeDef

def get_value() -> DetectSentimentResponseTypeDef:
    return {
        "Sentiment": ...,
        "SentimentScore": ...,
        "ResponseMetadata": ...,
    }
Definition
class DetectSentimentResponseTypeDef(TypedDict):
    Sentiment: SentimentTypeType,  # (1)
    SentimentScore: SentimentScoreTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SentimentTypeType
  2. See SentimentScoreTypeDef
  3. See ResponseMetadataTypeDef

MentionSentimentTypeDef

Usage Example
from mypy_boto3_comprehend.type_defs import MentionSentimentTypeDef

def get_value() -> MentionSentimentTypeDef:
    return {
        "Sentiment": ...,
    }
Definition
class MentionSentimentTypeDef(TypedDict):