Typed dictionaries#

Index > Comprehend > Typed dictionaries

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

AugmentedManifestsListItemTypeDef#

# AugmentedManifestsListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import AugmentedManifestsListItemTypeDef

def get_value() -> AugmentedManifestsListItemTypeDef:
    return {
        "S3Uri": ...,
        "AttributeNames": ...,
    }

# AugmentedManifestsListItemTypeDef definition

class AugmentedManifestsListItemTypeDef(TypedDict):
    S3Uri: str,
    AttributeNames: Sequence[str],
    Split: NotRequired[SplitType],  # (1)
    AnnotationDataS3Uri: NotRequired[str],
    SourceDocumentsS3Uri: NotRequired[str],
    DocumentType: NotRequired[AugmentedManifestsDocumentTypeFormatType],  # (2)

See SplitType
See AugmentedManifestsDocumentTypeFormatType

DominantLanguageTypeDef#

# DominantLanguageTypeDef usage example

from mypy_boto3_comprehend.type_defs import DominantLanguageTypeDef

def get_value() -> DominantLanguageTypeDef:
    return {
        "LanguageCode": ...,
    }

# DominantLanguageTypeDef definition

class DominantLanguageTypeDef(TypedDict):
    LanguageCode: NotRequired[str],
    Score: NotRequired[float],

BatchDetectDominantLanguageRequestRequestTypeDef#

# BatchDetectDominantLanguageRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageRequestRequestTypeDef

def get_value() -> BatchDetectDominantLanguageRequestRequestTypeDef:
    return {
        "TextList": ...,
    }

# BatchDetectDominantLanguageRequestRequestTypeDef definition

class BatchDetectDominantLanguageRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],

BatchItemErrorTypeDef#

# BatchItemErrorTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchItemErrorTypeDef

def get_value() -> BatchItemErrorTypeDef:
    return {
        "Index": ...,
    }

# BatchItemErrorTypeDef definition

class BatchItemErrorTypeDef(TypedDict):
    Index: NotRequired[int],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

BatchDetectEntitiesRequestRequestTypeDef#

# BatchDetectEntitiesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectEntitiesRequestRequestTypeDef

def get_value() -> BatchDetectEntitiesRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }

# BatchDetectEntitiesRequestRequestTypeDef definition

class BatchDetectEntitiesRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

KeyPhraseTypeDef#

# KeyPhraseTypeDef usage example

from mypy_boto3_comprehend.type_defs import KeyPhraseTypeDef

def get_value() -> KeyPhraseTypeDef:
    return {
        "Score": ...,
    }

# KeyPhraseTypeDef definition

class KeyPhraseTypeDef(TypedDict):
    Score: NotRequired[float],
    Text: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

BatchDetectKeyPhrasesRequestRequestTypeDef#

# BatchDetectKeyPhrasesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectKeyPhrasesRequestRequestTypeDef

def get_value() -> BatchDetectKeyPhrasesRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }

# BatchDetectKeyPhrasesRequestRequestTypeDef definition

class BatchDetectKeyPhrasesRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

SentimentScoreTypeDef#

# SentimentScoreTypeDef usage example

from mypy_boto3_comprehend.type_defs import SentimentScoreTypeDef

def get_value() -> SentimentScoreTypeDef:
    return {
        "Positive": ...,
    }

# SentimentScoreTypeDef definition

class SentimentScoreTypeDef(TypedDict):
    Positive: NotRequired[float],
    Negative: NotRequired[float],
    Neutral: NotRequired[float],
    Mixed: NotRequired[float],

BatchDetectSentimentRequestRequestTypeDef#

# BatchDetectSentimentRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectSentimentRequestRequestTypeDef

def get_value() -> BatchDetectSentimentRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }

# BatchDetectSentimentRequestRequestTypeDef definition

class BatchDetectSentimentRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

BatchDetectSyntaxRequestRequestTypeDef#

# BatchDetectSyntaxRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectSyntaxRequestRequestTypeDef

def get_value() -> BatchDetectSyntaxRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }

# BatchDetectSyntaxRequestRequestTypeDef definition

class BatchDetectSyntaxRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: SyntaxLanguageCodeType,  # (1)

See SyntaxLanguageCodeType

BatchDetectTargetedSentimentRequestRequestTypeDef#

# BatchDetectTargetedSentimentRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectTargetedSentimentRequestRequestTypeDef

def get_value() -> BatchDetectTargetedSentimentRequestRequestTypeDef:
    return {
        "TextList": ...,
        "LanguageCode": ...,
    }

# BatchDetectTargetedSentimentRequestRequestTypeDef definition

class BatchDetectTargetedSentimentRequestRequestTypeDef(TypedDict):
    TextList: Sequence[str],
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

ChildBlockTypeDef#

# ChildBlockTypeDef usage example

from mypy_boto3_comprehend.type_defs import ChildBlockTypeDef

def get_value() -> ChildBlockTypeDef:
    return {
        "ChildBlockId": ...,
    }

# ChildBlockTypeDef definition

class ChildBlockTypeDef(TypedDict):
    ChildBlockId: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

RelationshipsListItemTypeDef#

# RelationshipsListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import RelationshipsListItemTypeDef

def get_value() -> RelationshipsListItemTypeDef:
    return {
        "Ids": ...,
    }

# RelationshipsListItemTypeDef definition

class RelationshipsListItemTypeDef(TypedDict):
    Ids: NotRequired[List[str]],
    Type: NotRequired[RelationshipTypeType],  # (1)

See RelationshipTypeType

BoundingBoxTypeDef#

# BoundingBoxTypeDef usage example

from mypy_boto3_comprehend.type_defs import BoundingBoxTypeDef

def get_value() -> BoundingBoxTypeDef:
    return {
        "Height": ...,
    }

# BoundingBoxTypeDef definition

class BoundingBoxTypeDef(TypedDict):
    Height: NotRequired[float],
    Left: NotRequired[float],
    Top: NotRequired[float],
    Width: NotRequired[float],

ClassifierEvaluationMetricsTypeDef#

# ClassifierEvaluationMetricsTypeDef usage example

from mypy_boto3_comprehend.type_defs import ClassifierEvaluationMetricsTypeDef

def get_value() -> ClassifierEvaluationMetricsTypeDef:
    return {
        "Accuracy": ...,
    }

# ClassifierEvaluationMetricsTypeDef 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],

DocumentReaderConfigTypeDef#

# DocumentReaderConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentReaderConfigTypeDef

def get_value() -> DocumentReaderConfigTypeDef:
    return {
        "DocumentReadAction": ...,
    }

# DocumentReaderConfigTypeDef definition

class DocumentReaderConfigTypeDef(TypedDict):
    DocumentReadAction: DocumentReadActionType,  # (1)
    DocumentReadMode: NotRequired[DocumentReadModeType],  # (2)
    FeatureTypes: NotRequired[Sequence[DocumentReadFeatureTypesType]],  # (3)

DocumentClassTypeDef#

# DocumentClassTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassTypeDef

def get_value() -> DocumentClassTypeDef:
    return {
        "Name": ...,
    }

# DocumentClassTypeDef definition

class DocumentClassTypeDef(TypedDict):
    Name: NotRequired[str],
    Score: NotRequired[float],
    Page: NotRequired[int],

DocumentLabelTypeDef#

# DocumentLabelTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentLabelTypeDef

def get_value() -> DocumentLabelTypeDef:
    return {
        "Name": ...,
    }

# DocumentLabelTypeDef definition

class DocumentLabelTypeDef(TypedDict):
    Name: NotRequired[str],
    Score: NotRequired[float],
    Page: NotRequired[int],

DocumentTypeListItemTypeDef#

# DocumentTypeListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentTypeListItemTypeDef

def get_value() -> DocumentTypeListItemTypeDef:
    return {
        "Page": ...,
    }

# DocumentTypeListItemTypeDef definition

class DocumentTypeListItemTypeDef(TypedDict):
    Page: NotRequired[int],
    Type: NotRequired[DocumentTypeType],  # (1)

See DocumentTypeType

ErrorsListItemTypeDef#

# ErrorsListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import ErrorsListItemTypeDef

def get_value() -> ErrorsListItemTypeDef:
    return {
        "Page": ...,
    }

# ErrorsListItemTypeDef definition

class ErrorsListItemTypeDef(TypedDict):
    Page: NotRequired[int],
    ErrorCode: NotRequired[PageBasedErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],

See PageBasedErrorCodeType

WarningsListItemTypeDef#

# WarningsListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import WarningsListItemTypeDef

def get_value() -> WarningsListItemTypeDef:
    return {
        "Page": ...,
    }

# WarningsListItemTypeDef definition

class WarningsListItemTypeDef(TypedDict):
    Page: NotRequired[int],
    WarnCode: NotRequired[PageBasedWarningCodeType],  # (1)
    WarnMessage: NotRequired[str],

See PageBasedWarningCodeType

ContainsPiiEntitiesRequestRequestTypeDef#

# ContainsPiiEntitiesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ContainsPiiEntitiesRequestRequestTypeDef

def get_value() -> ContainsPiiEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }

# ContainsPiiEntitiesRequestRequestTypeDef definition

class ContainsPiiEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

EntityLabelTypeDef#

# EntityLabelTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityLabelTypeDef

def get_value() -> EntityLabelTypeDef:
    return {
        "Name": ...,
    }

# EntityLabelTypeDef definition

class EntityLabelTypeDef(TypedDict):
    Name: NotRequired[PiiEntityTypeType],  # (1)
    Score: NotRequired[float],

See PiiEntityTypeType

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_comprehend.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import CreateDatasetResponseTypeDef

def get_value() -> CreateDatasetResponseTypeDef:
    return {
        "DatasetArn": ...,
        "ResponseMetadata": ...,
    }

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    DatasetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

DocumentClassifierOutputDataConfigTypeDef#

# DocumentClassifierOutputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassifierOutputDataConfigTypeDef

def get_value() -> DocumentClassifierOutputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }

# DocumentClassifierOutputDataConfigTypeDef definition

class DocumentClassifierOutputDataConfigTypeDef(TypedDict):
    S3Uri: NotRequired[str],
    KmsKeyId: NotRequired[str],
    FlywheelStatsS3Prefix: NotRequired[str],

VpcConfigTypeDef#

# VpcConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import VpcConfigTypeDef

def get_value() -> VpcConfigTypeDef:
    return {
        "SecurityGroupIds": ...,
        "Subnets": ...,
    }

# VpcConfigTypeDef definition

class VpcConfigTypeDef(TypedDict):
    SecurityGroupIds: Sequence[str],
    Subnets: Sequence[str],

CreateDocumentClassifierResponseTypeDef#

# CreateDocumentClassifierResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import CreateDocumentClassifierResponseTypeDef

def get_value() -> CreateDocumentClassifierResponseTypeDef:
    return {
        "DocumentClassifierArn": ...,
        "ResponseMetadata": ...,
    }

# CreateDocumentClassifierResponseTypeDef definition

class CreateDocumentClassifierResponseTypeDef(TypedDict):
    DocumentClassifierArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateEndpointResponseTypeDef#

# CreateEndpointResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import CreateEndpointResponseTypeDef

def get_value() -> CreateEndpointResponseTypeDef:
    return {
        "EndpointArn": ...,
        "ModelArn": ...,
        "ResponseMetadata": ...,
    }

# CreateEndpointResponseTypeDef definition

class CreateEndpointResponseTypeDef(TypedDict):
    EndpointArn: str,
    ModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateEntityRecognizerResponseTypeDef#

# CreateEntityRecognizerResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import CreateEntityRecognizerResponseTypeDef

def get_value() -> CreateEntityRecognizerResponseTypeDef:
    return {
        "EntityRecognizerArn": ...,
        "ResponseMetadata": ...,
    }

# CreateEntityRecognizerResponseTypeDef definition

class CreateEntityRecognizerResponseTypeDef(TypedDict):
    EntityRecognizerArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateFlywheelResponseTypeDef#

# CreateFlywheelResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import CreateFlywheelResponseTypeDef

def get_value() -> CreateFlywheelResponseTypeDef:
    return {
        "FlywheelArn": ...,
        "ActiveModelArn": ...,
        "ResponseMetadata": ...,
    }

# CreateFlywheelResponseTypeDef definition

class CreateFlywheelResponseTypeDef(TypedDict):
    FlywheelArn: str,
    ActiveModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

DatasetAugmentedManifestsListItemTypeDef#

# DatasetAugmentedManifestsListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetAugmentedManifestsListItemTypeDef

def get_value() -> DatasetAugmentedManifestsListItemTypeDef:
    return {
        "AttributeNames": ...,
        "S3Uri": ...,
    }

# DatasetAugmentedManifestsListItemTypeDef definition

class DatasetAugmentedManifestsListItemTypeDef(TypedDict):
    AttributeNames: Sequence[str],
    S3Uri: str,
    AnnotationDataS3Uri: NotRequired[str],
    SourceDocumentsS3Uri: NotRequired[str],
    DocumentType: NotRequired[AugmentedManifestsDocumentTypeFormatType],  # (1)

See AugmentedManifestsDocumentTypeFormatType

DatasetDocumentClassifierInputDataConfigTypeDef#

# DatasetDocumentClassifierInputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetDocumentClassifierInputDataConfigTypeDef

def get_value() -> DatasetDocumentClassifierInputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }

# DatasetDocumentClassifierInputDataConfigTypeDef definition

class DatasetDocumentClassifierInputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    LabelDelimiter: NotRequired[str],

DatasetEntityRecognizerAnnotationsTypeDef#

# DatasetEntityRecognizerAnnotationsTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetEntityRecognizerAnnotationsTypeDef

def get_value() -> DatasetEntityRecognizerAnnotationsTypeDef:
    return {
        "S3Uri": ...,
    }

# DatasetEntityRecognizerAnnotationsTypeDef definition

class DatasetEntityRecognizerAnnotationsTypeDef(TypedDict):
    S3Uri: str,

DatasetEntityRecognizerDocumentsTypeDef#

# DatasetEntityRecognizerDocumentsTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetEntityRecognizerDocumentsTypeDef

def get_value() -> DatasetEntityRecognizerDocumentsTypeDef:
    return {
        "S3Uri": ...,
    }

# DatasetEntityRecognizerDocumentsTypeDef definition

class DatasetEntityRecognizerDocumentsTypeDef(TypedDict):
    S3Uri: str,
    InputFormat: NotRequired[InputFormatType],  # (1)

See InputFormatType

DatasetEntityRecognizerEntityListTypeDef#

# DatasetEntityRecognizerEntityListTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetEntityRecognizerEntityListTypeDef

def get_value() -> DatasetEntityRecognizerEntityListTypeDef:
    return {
        "S3Uri": ...,
    }

# DatasetEntityRecognizerEntityListTypeDef definition

class DatasetEntityRecognizerEntityListTypeDef(TypedDict):
    S3Uri: str,

DatasetFilterTypeDef#

# DatasetFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetFilterTypeDef

def get_value() -> DatasetFilterTypeDef:
    return {
        "Status": ...,
    }

# DatasetFilterTypeDef definition

class DatasetFilterTypeDef(TypedDict):
    Status: NotRequired[DatasetStatusType],  # (1)
    DatasetType: NotRequired[DatasetTypeType],  # (2)
    CreationTimeAfter: NotRequired[Union[datetime, str]],
    CreationTimeBefore: NotRequired[Union[datetime, str]],

See DatasetStatusType
See DatasetTypeType

DatasetPropertiesTypeDef#

# DatasetPropertiesTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetPropertiesTypeDef

def get_value() -> DatasetPropertiesTypeDef:
    return {
        "DatasetArn": ...,
    }

# DatasetPropertiesTypeDef definition

class DatasetPropertiesTypeDef(TypedDict):
    DatasetArn: NotRequired[str],
    DatasetName: NotRequired[str],
    DatasetType: NotRequired[DatasetTypeType],  # (1)
    DatasetS3Uri: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[DatasetStatusType],  # (2)
    Message: NotRequired[str],
    NumberOfDocuments: NotRequired[int],
    CreationTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],

See DatasetTypeType
See DatasetStatusType

DeleteDocumentClassifierRequestRequestTypeDef#

# DeleteDocumentClassifierRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DeleteDocumentClassifierRequestRequestTypeDef

def get_value() -> DeleteDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
    }

# DeleteDocumentClassifierRequestRequestTypeDef definition

class DeleteDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DeleteEndpointRequestRequestTypeDef#

# DeleteEndpointRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DeleteEndpointRequestRequestTypeDef

def get_value() -> DeleteEndpointRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }

# DeleteEndpointRequestRequestTypeDef definition

class DeleteEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

DeleteEntityRecognizerRequestRequestTypeDef#

# DeleteEntityRecognizerRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DeleteEntityRecognizerRequestRequestTypeDef

def get_value() -> DeleteEntityRecognizerRequestRequestTypeDef:
    return {
        "EntityRecognizerArn": ...,
    }

# DeleteEntityRecognizerRequestRequestTypeDef definition

class DeleteEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DeleteFlywheelRequestRequestTypeDef#

# DeleteFlywheelRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DeleteFlywheelRequestRequestTypeDef

def get_value() -> DeleteFlywheelRequestRequestTypeDef:
    return {
        "FlywheelArn": ...,
    }

# DeleteFlywheelRequestRequestTypeDef definition

class DeleteFlywheelRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DeleteResourcePolicyRequestRequestTypeDef

def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    PolicyRevisionId: NotRequired[str],

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeDatasetRequestRequestTypeDef

def get_value() -> DescribeDatasetRequestRequestTypeDef:
    return {
        "DatasetArn": ...,
    }

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    DatasetArn: str,

DescribeDocumentClassificationJobRequestRequestTypeDef#

# DescribeDocumentClassificationJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeDocumentClassificationJobRequestRequestTypeDef

def get_value() -> DescribeDocumentClassificationJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeDocumentClassificationJobRequestRequestTypeDef definition

class DescribeDocumentClassificationJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeDocumentClassifierRequestRequestTypeDef#

# DescribeDocumentClassifierRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeDocumentClassifierRequestRequestTypeDef

def get_value() -> DescribeDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
    }

# DescribeDocumentClassifierRequestRequestTypeDef definition

class DescribeDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DescribeDominantLanguageDetectionJobRequestRequestTypeDef#

# DescribeDominantLanguageDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeDominantLanguageDetectionJobRequestRequestTypeDef

def get_value() -> DescribeDominantLanguageDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeDominantLanguageDetectionJobRequestRequestTypeDef definition

class DescribeDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEndpointRequestRequestTypeDef#

# DescribeEndpointRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeEndpointRequestRequestTypeDef

def get_value() -> DescribeEndpointRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }

# DescribeEndpointRequestRequestTypeDef definition

class DescribeEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

EndpointPropertiesTypeDef#

# EndpointPropertiesTypeDef usage example

from mypy_boto3_comprehend.type_defs import EndpointPropertiesTypeDef

def get_value() -> EndpointPropertiesTypeDef:
    return {
        "EndpointArn": ...,
    }

# EndpointPropertiesTypeDef 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],
    FlywheelArn: NotRequired[str],

See EndpointStatusType

DescribeEntitiesDetectionJobRequestRequestTypeDef#

# DescribeEntitiesDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> DescribeEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeEntitiesDetectionJobRequestRequestTypeDef definition

class DescribeEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEntityRecognizerRequestRequestTypeDef#

# DescribeEntityRecognizerRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeEntityRecognizerRequestRequestTypeDef

def get_value() -> DescribeEntityRecognizerRequestRequestTypeDef:
    return {
        "EntityRecognizerArn": ...,
    }

# DescribeEntityRecognizerRequestRequestTypeDef definition

class DescribeEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DescribeEventsDetectionJobRequestRequestTypeDef#

# DescribeEventsDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeEventsDetectionJobRequestRequestTypeDef

def get_value() -> DescribeEventsDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeEventsDetectionJobRequestRequestTypeDef definition

class DescribeEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeFlywheelIterationRequestRequestTypeDef#

# DescribeFlywheelIterationRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeFlywheelIterationRequestRequestTypeDef

def get_value() -> DescribeFlywheelIterationRequestRequestTypeDef:
    return {
        "FlywheelArn": ...,
        "FlywheelIterationId": ...,
    }

# DescribeFlywheelIterationRequestRequestTypeDef definition

class DescribeFlywheelIterationRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,
    FlywheelIterationId: str,

DescribeFlywheelRequestRequestTypeDef#

# DescribeFlywheelRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeFlywheelRequestRequestTypeDef

def get_value() -> DescribeFlywheelRequestRequestTypeDef:
    return {
        "FlywheelArn": ...,
    }

# DescribeFlywheelRequestRequestTypeDef definition

class DescribeFlywheelRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,

DescribeKeyPhrasesDetectionJobRequestRequestTypeDef#

# DescribeKeyPhrasesDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

def get_value() -> DescribeKeyPhrasesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeKeyPhrasesDetectionJobRequestRequestTypeDef definition

class DescribeKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePiiEntitiesDetectionJobRequestRequestTypeDef#

# DescribePiiEntitiesDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribePiiEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> DescribePiiEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribePiiEntitiesDetectionJobRequestRequestTypeDef definition

class DescribePiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeResourcePolicyRequestRequestTypeDef#

# DescribeResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeResourcePolicyRequestRequestTypeDef

def get_value() -> DescribeResourcePolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

# DescribeResourcePolicyRequestRequestTypeDef definition

class DescribeResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DescribeResourcePolicyResponseTypeDef#

# DescribeResourcePolicyResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeResourcePolicyResponseTypeDef

def get_value() -> DescribeResourcePolicyResponseTypeDef:
    return {
        "ResourcePolicy": ...,
        "CreationTime": ...,
        "LastModifiedTime": ...,
        "PolicyRevisionId": ...,
        "ResponseMetadata": ...,
    }

# DescribeResourcePolicyResponseTypeDef definition

class DescribeResourcePolicyResponseTypeDef(TypedDict):
    ResourcePolicy: str,
    CreationTime: datetime,
    LastModifiedTime: datetime,
    PolicyRevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

DescribeSentimentDetectionJobRequestRequestTypeDef#

# DescribeSentimentDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeSentimentDetectionJobRequestRequestTypeDef

def get_value() -> DescribeSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeSentimentDetectionJobRequestRequestTypeDef definition

class DescribeSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTargetedSentimentDetectionJobRequestRequestTypeDef#

# DescribeTargetedSentimentDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

def get_value() -> DescribeTargetedSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeTargetedSentimentDetectionJobRequestRequestTypeDef definition

class DescribeTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTopicsDetectionJobRequestRequestTypeDef#

# DescribeTopicsDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeTopicsDetectionJobRequestRequestTypeDef

def get_value() -> DescribeTopicsDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# DescribeTopicsDetectionJobRequestRequestTypeDef definition

class DescribeTopicsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DetectDominantLanguageRequestRequestTypeDef#

# DetectDominantLanguageRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectDominantLanguageRequestRequestTypeDef

def get_value() -> DetectDominantLanguageRequestRequestTypeDef:
    return {
        "Text": ...,
    }

# DetectDominantLanguageRequestRequestTypeDef definition

class DetectDominantLanguageRequestRequestTypeDef(TypedDict):
    Text: str,

DetectKeyPhrasesRequestRequestTypeDef#

# DetectKeyPhrasesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectKeyPhrasesRequestRequestTypeDef

def get_value() -> DetectKeyPhrasesRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }

# DetectKeyPhrasesRequestRequestTypeDef definition

class DetectKeyPhrasesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

DetectPiiEntitiesRequestRequestTypeDef#

# DetectPiiEntitiesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectPiiEntitiesRequestRequestTypeDef

def get_value() -> DetectPiiEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }

# DetectPiiEntitiesRequestRequestTypeDef definition

class DetectPiiEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

PiiEntityTypeDef#

# PiiEntityTypeDef usage example

from mypy_boto3_comprehend.type_defs import PiiEntityTypeDef

def get_value() -> PiiEntityTypeDef:
    return {
        "Score": ...,
    }

# PiiEntityTypeDef definition

class PiiEntityTypeDef(TypedDict):
    Score: NotRequired[float],
    Type: NotRequired[PiiEntityTypeType],  # (1)
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

See PiiEntityTypeType

DetectSentimentRequestRequestTypeDef#

# DetectSentimentRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectSentimentRequestRequestTypeDef

def get_value() -> DetectSentimentRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }

# DetectSentimentRequestRequestTypeDef definition

class DetectSentimentRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

DetectSyntaxRequestRequestTypeDef#

# DetectSyntaxRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectSyntaxRequestRequestTypeDef

def get_value() -> DetectSyntaxRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }

# DetectSyntaxRequestRequestTypeDef definition

class DetectSyntaxRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: SyntaxLanguageCodeType,  # (1)

See SyntaxLanguageCodeType

DetectTargetedSentimentRequestRequestTypeDef#

# DetectTargetedSentimentRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectTargetedSentimentRequestRequestTypeDef

def get_value() -> DetectTargetedSentimentRequestRequestTypeDef:
    return {
        "Text": ...,
        "LanguageCode": ...,
    }

# DetectTargetedSentimentRequestRequestTypeDef definition

class DetectTargetedSentimentRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: LanguageCodeType,  # (1)

See LanguageCodeType

DocumentClassificationConfigTypeDef#

# DocumentClassificationConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassificationConfigTypeDef

def get_value() -> DocumentClassificationConfigTypeDef:
    return {
        "Mode": ...,
    }

# DocumentClassificationConfigTypeDef definition

class DocumentClassificationConfigTypeDef(TypedDict):
    Mode: DocumentClassifierModeType,  # (1)
    Labels: NotRequired[Sequence[str]],

See DocumentClassifierModeType

DocumentClassificationJobFilterTypeDef#

# DocumentClassificationJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassificationJobFilterTypeDef

def get_value() -> DocumentClassificationJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# DocumentClassificationJobFilterTypeDef definition

class DocumentClassificationJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

OutputDataConfigTypeDef#

# OutputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import OutputDataConfigTypeDef

def get_value() -> OutputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }

# OutputDataConfigTypeDef definition

class OutputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: NotRequired[str],

DocumentClassifierDocumentsTypeDef#

# DocumentClassifierDocumentsTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassifierDocumentsTypeDef

def get_value() -> DocumentClassifierDocumentsTypeDef:
    return {
        "S3Uri": ...,
    }

# DocumentClassifierDocumentsTypeDef definition

class DocumentClassifierDocumentsTypeDef(TypedDict):
    S3Uri: str,
    TestS3Uri: NotRequired[str],

DocumentClassifierFilterTypeDef#

# DocumentClassifierFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassifierFilterTypeDef

def get_value() -> DocumentClassifierFilterTypeDef:
    return {
        "Status": ...,
    }

# DocumentClassifierFilterTypeDef definition

class DocumentClassifierFilterTypeDef(TypedDict):
    Status: NotRequired[ModelStatusType],  # (1)
    DocumentClassifierName: NotRequired[str],
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See ModelStatusType

DocumentClassifierSummaryTypeDef#

# DocumentClassifierSummaryTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassifierSummaryTypeDef

def get_value() -> DocumentClassifierSummaryTypeDef:
    return {
        "DocumentClassifierName": ...,
    }

# DocumentClassifierSummaryTypeDef definition

class DocumentClassifierSummaryTypeDef(TypedDict):
    DocumentClassifierName: NotRequired[str],
    NumberOfVersions: NotRequired[int],
    LatestVersionCreatedAt: NotRequired[datetime],
    LatestVersionName: NotRequired[str],
    LatestVersionStatus: NotRequired[ModelStatusType],  # (1)

See ModelStatusType

ExtractedCharactersListItemTypeDef#

# ExtractedCharactersListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import ExtractedCharactersListItemTypeDef

def get_value() -> ExtractedCharactersListItemTypeDef:
    return {
        "Page": ...,
    }

# ExtractedCharactersListItemTypeDef definition

class ExtractedCharactersListItemTypeDef(TypedDict):
    Page: NotRequired[int],
    Count: NotRequired[int],

DominantLanguageDetectionJobFilterTypeDef#

# DominantLanguageDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import DominantLanguageDetectionJobFilterTypeDef

def get_value() -> DominantLanguageDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# DominantLanguageDetectionJobFilterTypeDef definition

class DominantLanguageDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

EndpointFilterTypeDef#

# EndpointFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import EndpointFilterTypeDef

def get_value() -> EndpointFilterTypeDef:
    return {
        "ModelArn": ...,
    }

# EndpointFilterTypeDef definition

class EndpointFilterTypeDef(TypedDict):
    ModelArn: NotRequired[str],
    Status: NotRequired[EndpointStatusType],  # (1)
    CreationTimeBefore: NotRequired[Union[datetime, str]],
    CreationTimeAfter: NotRequired[Union[datetime, str]],

See EndpointStatusType

EntitiesDetectionJobFilterTypeDef#

# EntitiesDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntitiesDetectionJobFilterTypeDef

def get_value() -> EntitiesDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# EntitiesDetectionJobFilterTypeDef definition

class EntitiesDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

EntityTypesListItemTypeDef#

# EntityTypesListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityTypesListItemTypeDef

def get_value() -> EntityTypesListItemTypeDef:
    return {
        "Type": ...,
    }

# EntityTypesListItemTypeDef definition

class EntityTypesListItemTypeDef(TypedDict):
    Type: str,

EntityRecognizerAnnotationsTypeDef#

# EntityRecognizerAnnotationsTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerAnnotationsTypeDef

def get_value() -> EntityRecognizerAnnotationsTypeDef:
    return {
        "S3Uri": ...,
    }

# EntityRecognizerAnnotationsTypeDef definition

class EntityRecognizerAnnotationsTypeDef(TypedDict):
    S3Uri: str,
    TestS3Uri: NotRequired[str],

EntityRecognizerDocumentsTypeDef#

# EntityRecognizerDocumentsTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerDocumentsTypeDef

def get_value() -> EntityRecognizerDocumentsTypeDef:
    return {
        "S3Uri": ...,
    }

# EntityRecognizerDocumentsTypeDef definition

class EntityRecognizerDocumentsTypeDef(TypedDict):
    S3Uri: str,
    TestS3Uri: NotRequired[str],
    InputFormat: NotRequired[InputFormatType],  # (1)

See InputFormatType

EntityRecognizerEntityListTypeDef#

# EntityRecognizerEntityListTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerEntityListTypeDef

def get_value() -> EntityRecognizerEntityListTypeDef:
    return {
        "S3Uri": ...,
    }

# EntityRecognizerEntityListTypeDef definition

class EntityRecognizerEntityListTypeDef(TypedDict):
    S3Uri: str,

EntityRecognizerEvaluationMetricsTypeDef#

# EntityRecognizerEvaluationMetricsTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerEvaluationMetricsTypeDef

def get_value() -> EntityRecognizerEvaluationMetricsTypeDef:
    return {
        "Precision": ...,
    }

# EntityRecognizerEvaluationMetricsTypeDef definition

class EntityRecognizerEvaluationMetricsTypeDef(TypedDict):
    Precision: NotRequired[float],
    Recall: NotRequired[float],
    F1Score: NotRequired[float],

EntityRecognizerFilterTypeDef#

# EntityRecognizerFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerFilterTypeDef

def get_value() -> EntityRecognizerFilterTypeDef:
    return {
        "Status": ...,
    }

# EntityRecognizerFilterTypeDef definition

class EntityRecognizerFilterTypeDef(TypedDict):
    Status: NotRequired[ModelStatusType],  # (1)
    RecognizerName: NotRequired[str],
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See ModelStatusType

EntityTypesEvaluationMetricsTypeDef#

# EntityTypesEvaluationMetricsTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityTypesEvaluationMetricsTypeDef

def get_value() -> EntityTypesEvaluationMetricsTypeDef:
    return {
        "Precision": ...,
    }

# EntityTypesEvaluationMetricsTypeDef definition

class EntityTypesEvaluationMetricsTypeDef(TypedDict):
    Precision: NotRequired[float],
    Recall: NotRequired[float],
    F1Score: NotRequired[float],

EntityRecognizerOutputDataConfigTypeDef#

# EntityRecognizerOutputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerOutputDataConfigTypeDef

def get_value() -> EntityRecognizerOutputDataConfigTypeDef:
    return {
        "FlywheelStatsS3Prefix": ...,
    }

# EntityRecognizerOutputDataConfigTypeDef definition

class EntityRecognizerOutputDataConfigTypeDef(TypedDict):
    FlywheelStatsS3Prefix: NotRequired[str],

EntityRecognizerSummaryTypeDef#

# EntityRecognizerSummaryTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerSummaryTypeDef

def get_value() -> EntityRecognizerSummaryTypeDef:
    return {
        "RecognizerName": ...,
    }

# EntityRecognizerSummaryTypeDef definition

class EntityRecognizerSummaryTypeDef(TypedDict):
    RecognizerName: NotRequired[str],
    NumberOfVersions: NotRequired[int],
    LatestVersionCreatedAt: NotRequired[datetime],
    LatestVersionName: NotRequired[str],
    LatestVersionStatus: NotRequired[ModelStatusType],  # (1)

See ModelStatusType

EventsDetectionJobFilterTypeDef#

# EventsDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import EventsDetectionJobFilterTypeDef

def get_value() -> EventsDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# EventsDetectionJobFilterTypeDef definition

class EventsDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

FlywheelFilterTypeDef#

# FlywheelFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import FlywheelFilterTypeDef

def get_value() -> FlywheelFilterTypeDef:
    return {
        "Status": ...,
    }

# FlywheelFilterTypeDef definition

class FlywheelFilterTypeDef(TypedDict):
    Status: NotRequired[FlywheelStatusType],  # (1)
    CreationTimeAfter: NotRequired[Union[datetime, str]],
    CreationTimeBefore: NotRequired[Union[datetime, str]],

See FlywheelStatusType

FlywheelIterationFilterTypeDef#

# FlywheelIterationFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import FlywheelIterationFilterTypeDef

def get_value() -> FlywheelIterationFilterTypeDef:
    return {
        "CreationTimeAfter": ...,
    }

# FlywheelIterationFilterTypeDef definition

class FlywheelIterationFilterTypeDef(TypedDict):
    CreationTimeAfter: NotRequired[Union[datetime, str]],
    CreationTimeBefore: NotRequired[Union[datetime, str]],

FlywheelModelEvaluationMetricsTypeDef#

# FlywheelModelEvaluationMetricsTypeDef usage example

from mypy_boto3_comprehend.type_defs import FlywheelModelEvaluationMetricsTypeDef

def get_value() -> FlywheelModelEvaluationMetricsTypeDef:
    return {
        "AverageF1Score": ...,
    }

# FlywheelModelEvaluationMetricsTypeDef definition

class FlywheelModelEvaluationMetricsTypeDef(TypedDict):
    AverageF1Score: NotRequired[float],
    AveragePrecision: NotRequired[float],
    AverageRecall: NotRequired[float],
    AverageAccuracy: NotRequired[float],

FlywheelSummaryTypeDef#

# FlywheelSummaryTypeDef usage example

from mypy_boto3_comprehend.type_defs import FlywheelSummaryTypeDef

def get_value() -> FlywheelSummaryTypeDef:
    return {
        "FlywheelArn": ...,
    }

# FlywheelSummaryTypeDef definition

class FlywheelSummaryTypeDef(TypedDict):
    FlywheelArn: NotRequired[str],
    ActiveModelArn: NotRequired[str],
    DataLakeS3Uri: NotRequired[str],
    Status: NotRequired[FlywheelStatusType],  # (1)
    ModelType: NotRequired[ModelTypeType],  # (2)
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    LatestFlywheelIteration: NotRequired[str],

See FlywheelStatusType
See ModelTypeType

PointTypeDef#

# PointTypeDef usage example

from mypy_boto3_comprehend.type_defs import PointTypeDef

def get_value() -> PointTypeDef:
    return {
        "X": ...,
    }

# PointTypeDef definition

class PointTypeDef(TypedDict):
    X: NotRequired[float],
    Y: NotRequired[float],

ImportModelResponseTypeDef#

# ImportModelResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ImportModelResponseTypeDef

def get_value() -> ImportModelResponseTypeDef:
    return {
        "ModelArn": ...,
        "ResponseMetadata": ...,
    }

# ImportModelResponseTypeDef definition

class ImportModelResponseTypeDef(TypedDict):
    ModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

KeyPhrasesDetectionJobFilterTypeDef#

# KeyPhrasesDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import KeyPhrasesDetectionJobFilterTypeDef

def get_value() -> KeyPhrasesDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# KeyPhrasesDetectionJobFilterTypeDef definition

class KeyPhrasesDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

ListDocumentClassifierSummariesRequestRequestTypeDef#

# ListDocumentClassifierSummariesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDocumentClassifierSummariesRequestRequestTypeDef

def get_value() -> ListDocumentClassifierSummariesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

# ListDocumentClassifierSummariesRequestRequestTypeDef definition

class ListDocumentClassifierSummariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListEntityRecognizerSummariesRequestRequestTypeDef#

# ListEntityRecognizerSummariesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEntityRecognizerSummariesRequestRequestTypeDef

def get_value() -> ListEntityRecognizerSummariesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

# ListEntityRecognizerSummariesRequestRequestTypeDef definition

class ListEntityRecognizerSummariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PiiEntitiesDetectionJobFilterTypeDef#

# PiiEntitiesDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import PiiEntitiesDetectionJobFilterTypeDef

def get_value() -> PiiEntitiesDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# PiiEntitiesDetectionJobFilterTypeDef definition

class PiiEntitiesDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

SentimentDetectionJobFilterTypeDef#

# SentimentDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import SentimentDetectionJobFilterTypeDef

def get_value() -> SentimentDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# SentimentDetectionJobFilterTypeDef definition

class SentimentDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TargetedSentimentDetectionJobFilterTypeDef#

# TargetedSentimentDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import TargetedSentimentDetectionJobFilterTypeDef

def get_value() -> TargetedSentimentDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# TargetedSentimentDetectionJobFilterTypeDef definition

class TargetedSentimentDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

TopicsDetectionJobFilterTypeDef#

# TopicsDetectionJobFilterTypeDef usage example

from mypy_boto3_comprehend.type_defs import TopicsDetectionJobFilterTypeDef

def get_value() -> TopicsDetectionJobFilterTypeDef:
    return {
        "JobName": ...,
    }

# TopicsDetectionJobFilterTypeDef definition

class TopicsDetectionJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],

See JobStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PartOfSpeechTagTypeDef#

# PartOfSpeechTagTypeDef usage example

from mypy_boto3_comprehend.type_defs import PartOfSpeechTagTypeDef

def get_value() -> PartOfSpeechTagTypeDef:
    return {
        "Tag": ...,
    }

# PartOfSpeechTagTypeDef definition

class PartOfSpeechTagTypeDef(TypedDict):
    Tag: NotRequired[PartOfSpeechTagTypeType],  # (1)
    Score: NotRequired[float],

See PartOfSpeechTagTypeType

PiiOutputDataConfigTypeDef#

# PiiOutputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import PiiOutputDataConfigTypeDef

def get_value() -> PiiOutputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }

# PiiOutputDataConfigTypeDef definition

class PiiOutputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: NotRequired[str],

RedactionConfigTypeDef#

# RedactionConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import RedactionConfigTypeDef

def get_value() -> RedactionConfigTypeDef:
    return {
        "PiiEntityTypes": ...,
    }

# RedactionConfigTypeDef definition

class RedactionConfigTypeDef(TypedDict):
    PiiEntityTypes: NotRequired[List[PiiEntityTypeType]],  # (1)
    MaskMode: NotRequired[PiiEntitiesDetectionMaskModeType],  # (2)
    MaskCharacter: NotRequired[str],

See PiiEntityTypeType
See PiiEntitiesDetectionMaskModeType

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import PutResourcePolicyRequestRequestTypeDef

def get_value() -> PutResourcePolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "ResourcePolicy": ...,
    }

# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    ResourcePolicy: str,
    PolicyRevisionId: NotRequired[str],

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import PutResourcePolicyResponseTypeDef

def get_value() -> PutResourcePolicyResponseTypeDef:
    return {
        "PolicyRevisionId": ...,
        "ResponseMetadata": ...,
    }

# PutResourcePolicyResponseTypeDef definition

class PutResourcePolicyResponseTypeDef(TypedDict):
    PolicyRevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_comprehend.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

StartDocumentClassificationJobResponseTypeDef#

# StartDocumentClassificationJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartDocumentClassificationJobResponseTypeDef

def get_value() -> StartDocumentClassificationJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "DocumentClassifierArn": ...,
        "ResponseMetadata": ...,
    }

# StartDocumentClassificationJobResponseTypeDef definition

class StartDocumentClassificationJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    DocumentClassifierArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartDominantLanguageDetectionJobResponseTypeDef#

# StartDominantLanguageDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartDominantLanguageDetectionJobResponseTypeDef

def get_value() -> StartDominantLanguageDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartDominantLanguageDetectionJobResponseTypeDef definition

class StartDominantLanguageDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartEntitiesDetectionJobResponseTypeDef#

# StartEntitiesDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartEntitiesDetectionJobResponseTypeDef

def get_value() -> StartEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "EntityRecognizerArn": ...,
        "ResponseMetadata": ...,
    }

# StartEntitiesDetectionJobResponseTypeDef definition

class StartEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    EntityRecognizerArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartEventsDetectionJobResponseTypeDef#

# StartEventsDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartEventsDetectionJobResponseTypeDef

def get_value() -> StartEventsDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartEventsDetectionJobResponseTypeDef definition

class StartEventsDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartFlywheelIterationRequestRequestTypeDef#

# StartFlywheelIterationRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartFlywheelIterationRequestRequestTypeDef

def get_value() -> StartFlywheelIterationRequestRequestTypeDef:
    return {
        "FlywheelArn": ...,
    }

# StartFlywheelIterationRequestRequestTypeDef definition

class StartFlywheelIterationRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,
    ClientRequestToken: NotRequired[str],

StartFlywheelIterationResponseTypeDef#

# StartFlywheelIterationResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartFlywheelIterationResponseTypeDef

def get_value() -> StartFlywheelIterationResponseTypeDef:
    return {
        "FlywheelArn": ...,
        "FlywheelIterationId": ...,
        "ResponseMetadata": ...,
    }

# StartFlywheelIterationResponseTypeDef definition

class StartFlywheelIterationResponseTypeDef(TypedDict):
    FlywheelArn: str,
    FlywheelIterationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

StartKeyPhrasesDetectionJobResponseTypeDef#

# StartKeyPhrasesDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartKeyPhrasesDetectionJobResponseTypeDef

def get_value() -> StartKeyPhrasesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartKeyPhrasesDetectionJobResponseTypeDef definition

class StartKeyPhrasesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartPiiEntitiesDetectionJobResponseTypeDef#

# StartPiiEntitiesDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartPiiEntitiesDetectionJobResponseTypeDef

def get_value() -> StartPiiEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartPiiEntitiesDetectionJobResponseTypeDef definition

class StartPiiEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartSentimentDetectionJobResponseTypeDef#

# StartSentimentDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartSentimentDetectionJobResponseTypeDef

def get_value() -> StartSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartSentimentDetectionJobResponseTypeDef definition

class StartSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartTargetedSentimentDetectionJobResponseTypeDef#

# StartTargetedSentimentDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartTargetedSentimentDetectionJobResponseTypeDef

def get_value() -> StartTargetedSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartTargetedSentimentDetectionJobResponseTypeDef definition

class StartTargetedSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StartTopicsDetectionJobResponseTypeDef#

# StartTopicsDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StartTopicsDetectionJobResponseTypeDef

def get_value() -> StartTopicsDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobArn": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StartTopicsDetectionJobResponseTypeDef definition

class StartTopicsDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobArn: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopDominantLanguageDetectionJobRequestRequestTypeDef#

# StopDominantLanguageDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopDominantLanguageDetectionJobRequestRequestTypeDef

def get_value() -> StopDominantLanguageDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopDominantLanguageDetectionJobRequestRequestTypeDef definition

class StopDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopDominantLanguageDetectionJobResponseTypeDef#

# StopDominantLanguageDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopDominantLanguageDetectionJobResponseTypeDef

def get_value() -> StopDominantLanguageDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopDominantLanguageDetectionJobResponseTypeDef definition

class StopDominantLanguageDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopEntitiesDetectionJobRequestRequestTypeDef#

# StopEntitiesDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> StopEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopEntitiesDetectionJobRequestRequestTypeDef definition

class StopEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEntitiesDetectionJobResponseTypeDef#

# StopEntitiesDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopEntitiesDetectionJobResponseTypeDef

def get_value() -> StopEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopEntitiesDetectionJobResponseTypeDef definition

class StopEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopEventsDetectionJobRequestRequestTypeDef#

# StopEventsDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopEventsDetectionJobRequestRequestTypeDef

def get_value() -> StopEventsDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopEventsDetectionJobRequestRequestTypeDef definition

class StopEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEventsDetectionJobResponseTypeDef#

# StopEventsDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopEventsDetectionJobResponseTypeDef

def get_value() -> StopEventsDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopEventsDetectionJobResponseTypeDef definition

class StopEventsDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopKeyPhrasesDetectionJobRequestRequestTypeDef#

# StopKeyPhrasesDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopKeyPhrasesDetectionJobRequestRequestTypeDef

def get_value() -> StopKeyPhrasesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopKeyPhrasesDetectionJobRequestRequestTypeDef definition

class StopKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopKeyPhrasesDetectionJobResponseTypeDef#

# StopKeyPhrasesDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopKeyPhrasesDetectionJobResponseTypeDef

def get_value() -> StopKeyPhrasesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopKeyPhrasesDetectionJobResponseTypeDef definition

class StopKeyPhrasesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopPiiEntitiesDetectionJobRequestRequestTypeDef#

# StopPiiEntitiesDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopPiiEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> StopPiiEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopPiiEntitiesDetectionJobRequestRequestTypeDef definition

class StopPiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopPiiEntitiesDetectionJobResponseTypeDef#

# StopPiiEntitiesDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopPiiEntitiesDetectionJobResponseTypeDef

def get_value() -> StopPiiEntitiesDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopPiiEntitiesDetectionJobResponseTypeDef definition

class StopPiiEntitiesDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopSentimentDetectionJobRequestRequestTypeDef#

# StopSentimentDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopSentimentDetectionJobRequestRequestTypeDef

def get_value() -> StopSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopSentimentDetectionJobRequestRequestTypeDef definition

class StopSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopSentimentDetectionJobResponseTypeDef#

# StopSentimentDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopSentimentDetectionJobResponseTypeDef

def get_value() -> StopSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopSentimentDetectionJobResponseTypeDef definition

class StopSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopTargetedSentimentDetectionJobRequestRequestTypeDef#

# StopTargetedSentimentDetectionJobRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopTargetedSentimentDetectionJobRequestRequestTypeDef

def get_value() -> StopTargetedSentimentDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

# StopTargetedSentimentDetectionJobRequestRequestTypeDef definition

class StopTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTargetedSentimentDetectionJobResponseTypeDef#

# StopTargetedSentimentDetectionJobResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopTargetedSentimentDetectionJobResponseTypeDef

def get_value() -> StopTargetedSentimentDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "ResponseMetadata": ...,
    }

# StopTargetedSentimentDetectionJobResponseTypeDef definition

class StopTargetedSentimentDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See JobStatusType
See ResponseMetadataTypeDef

StopTrainingDocumentClassifierRequestRequestTypeDef#

# StopTrainingDocumentClassifierRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopTrainingDocumentClassifierRequestRequestTypeDef

def get_value() -> StopTrainingDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
    }

# StopTrainingDocumentClassifierRequestRequestTypeDef definition

class StopTrainingDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

StopTrainingEntityRecognizerRequestRequestTypeDef#

# StopTrainingEntityRecognizerRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import StopTrainingEntityRecognizerRequestRequestTypeDef

def get_value() -> StopTrainingEntityRecognizerRequestRequestTypeDef:
    return {
        "EntityRecognizerArn": ...,
    }

# StopTrainingEntityRecognizerRequestRequestTypeDef definition

class StopTrainingEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateEndpointRequestRequestTypeDef#

# UpdateEndpointRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import UpdateEndpointRequestRequestTypeDef

def get_value() -> UpdateEndpointRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }

# UpdateEndpointRequestRequestTypeDef definition

class UpdateEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,
    DesiredModelArn: NotRequired[str],
    DesiredInferenceUnits: NotRequired[int],
    DesiredDataAccessRoleArn: NotRequired[str],
    FlywheelArn: NotRequired[str],

UpdateEndpointResponseTypeDef#

# UpdateEndpointResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import UpdateEndpointResponseTypeDef

def get_value() -> UpdateEndpointResponseTypeDef:
    return {
        "DesiredModelArn": ...,
        "ResponseMetadata": ...,
    }

# UpdateEndpointResponseTypeDef definition

class UpdateEndpointResponseTypeDef(TypedDict):
    DesiredModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

BatchDetectDominantLanguageItemResultTypeDef#

# BatchDetectDominantLanguageItemResultTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageItemResultTypeDef

def get_value() -> BatchDetectDominantLanguageItemResultTypeDef:
    return {
        "Index": ...,
    }

# BatchDetectDominantLanguageItemResultTypeDef definition

class BatchDetectDominantLanguageItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Languages: NotRequired[List[DominantLanguageTypeDef]],  # (1)

See DominantLanguageTypeDef

DetectDominantLanguageResponseTypeDef#

# DetectDominantLanguageResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectDominantLanguageResponseTypeDef

def get_value() -> DetectDominantLanguageResponseTypeDef:
    return {
        "Languages": ...,
        "ResponseMetadata": ...,
    }

# DetectDominantLanguageResponseTypeDef definition

class DetectDominantLanguageResponseTypeDef(TypedDict):
    Languages: List[DominantLanguageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DominantLanguageTypeDef
See ResponseMetadataTypeDef

BatchDetectKeyPhrasesItemResultTypeDef#

# BatchDetectKeyPhrasesItemResultTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectKeyPhrasesItemResultTypeDef

def get_value() -> BatchDetectKeyPhrasesItemResultTypeDef:
    return {
        "Index": ...,
    }

# BatchDetectKeyPhrasesItemResultTypeDef definition

class BatchDetectKeyPhrasesItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    KeyPhrases: NotRequired[List[KeyPhraseTypeDef]],  # (1)

See KeyPhraseTypeDef

DetectKeyPhrasesResponseTypeDef#

# DetectKeyPhrasesResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectKeyPhrasesResponseTypeDef

def get_value() -> DetectKeyPhrasesResponseTypeDef:
    return {
        "KeyPhrases": ...,
        "ResponseMetadata": ...,
    }

# DetectKeyPhrasesResponseTypeDef definition

class DetectKeyPhrasesResponseTypeDef(TypedDict):
    KeyPhrases: List[KeyPhraseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See KeyPhraseTypeDef
See ResponseMetadataTypeDef

BatchDetectSentimentItemResultTypeDef#

# BatchDetectSentimentItemResultTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectSentimentItemResultTypeDef

def get_value() -> BatchDetectSentimentItemResultTypeDef:
    return {
        "Index": ...,
    }

# BatchDetectSentimentItemResultTypeDef definition

class BatchDetectSentimentItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Sentiment: NotRequired[SentimentTypeType],  # (1)
    SentimentScore: NotRequired[SentimentScoreTypeDef],  # (2)

See SentimentTypeType
See SentimentScoreTypeDef

DetectSentimentResponseTypeDef#

# DetectSentimentResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectSentimentResponseTypeDef

def get_value() -> DetectSentimentResponseTypeDef:
    return {
        "Sentiment": ...,
        "SentimentScore": ...,
        "ResponseMetadata": ...,
    }

# DetectSentimentResponseTypeDef definition

class DetectSentimentResponseTypeDef(TypedDict):
    Sentiment: SentimentTypeType,  # (1)
    SentimentScore: SentimentScoreTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

MentionSentimentTypeDef#

# MentionSentimentTypeDef usage example

from mypy_boto3_comprehend.type_defs import MentionSentimentTypeDef

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

# MentionSentimentTypeDef definition

class MentionSentimentTypeDef(TypedDict):
    Sentiment: NotRequired[SentimentTypeType],  # (1)
    SentimentScore: NotRequired[SentimentScoreTypeDef],  # (2)

See SentimentTypeType
See SentimentScoreTypeDef

BlockReferenceTypeDef#

# BlockReferenceTypeDef usage example

from mypy_boto3_comprehend.type_defs import BlockReferenceTypeDef

def get_value() -> BlockReferenceTypeDef:
    return {
        "BlockId": ...,
    }

# BlockReferenceTypeDef definition

class BlockReferenceTypeDef(TypedDict):
    BlockId: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    ChildBlocks: NotRequired[List[ChildBlockTypeDef]],  # (1)

See ChildBlockTypeDef

ClassifierMetadataTypeDef#

# ClassifierMetadataTypeDef usage example

from mypy_boto3_comprehend.type_defs import ClassifierMetadataTypeDef

def get_value() -> ClassifierMetadataTypeDef:
    return {
        "NumberOfLabels": ...,
    }

# ClassifierMetadataTypeDef definition

class ClassifierMetadataTypeDef(TypedDict):
    NumberOfLabels: NotRequired[int],
    NumberOfTrainedDocuments: NotRequired[int],
    NumberOfTestDocuments: NotRequired[int],
    EvaluationMetrics: NotRequired[ClassifierEvaluationMetricsTypeDef],  # (1)

See ClassifierEvaluationMetricsTypeDef

ClassifyDocumentRequestRequestTypeDef#

# ClassifyDocumentRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ClassifyDocumentRequestRequestTypeDef

def get_value() -> ClassifyDocumentRequestRequestTypeDef:
    return {
        "EndpointArn": ...,
    }

# ClassifyDocumentRequestRequestTypeDef definition

class ClassifyDocumentRequestRequestTypeDef(TypedDict):
    EndpointArn: str,
    Text: NotRequired[str],
    Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    DocumentReaderConfig: NotRequired[DocumentReaderConfigTypeDef],  # (1)

See DocumentReaderConfigTypeDef

DetectEntitiesRequestRequestTypeDef#

# DetectEntitiesRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectEntitiesRequestRequestTypeDef

def get_value() -> DetectEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
    }

# DetectEntitiesRequestRequestTypeDef definition

class DetectEntitiesRequestRequestTypeDef(TypedDict):
    Text: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    EndpointArn: NotRequired[str],
    Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    DocumentReaderConfig: NotRequired[DocumentReaderConfigTypeDef],  # (2)

See LanguageCodeType
See DocumentReaderConfigTypeDef

InputDataConfigTypeDef#

# InputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import InputDataConfigTypeDef

def get_value() -> InputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }

# InputDataConfigTypeDef definition

class InputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    InputFormat: NotRequired[InputFormatType],  # (1)
    DocumentReaderConfig: NotRequired[DocumentReaderConfigTypeDef],  # (2)

See InputFormatType
See DocumentReaderConfigTypeDef

ContainsPiiEntitiesResponseTypeDef#

# ContainsPiiEntitiesResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ContainsPiiEntitiesResponseTypeDef

def get_value() -> ContainsPiiEntitiesResponseTypeDef:
    return {
        "Labels": ...,
        "ResponseMetadata": ...,
    }

# ContainsPiiEntitiesResponseTypeDef definition

class ContainsPiiEntitiesResponseTypeDef(TypedDict):
    Labels: List[EntityLabelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EntityLabelTypeDef
See ResponseMetadataTypeDef

CreateEndpointRequestRequestTypeDef#

# CreateEndpointRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import CreateEndpointRequestRequestTypeDef

def get_value() -> CreateEndpointRequestRequestTypeDef:
    return {
        "EndpointName": ...,
        "DesiredInferenceUnits": ...,
    }

# CreateEndpointRequestRequestTypeDef definition

class CreateEndpointRequestRequestTypeDef(TypedDict):
    EndpointName: str,
    DesiredInferenceUnits: int,
    ModelArn: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    DataAccessRoleArn: NotRequired[str],
    FlywheelArn: NotRequired[str],

See TagTypeDef

ImportModelRequestRequestTypeDef#

# ImportModelRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ImportModelRequestRequestTypeDef

def get_value() -> ImportModelRequestRequestTypeDef:
    return {
        "SourceModelArn": ...,
    }

# ImportModelRequestRequestTypeDef definition

class ImportModelRequestRequestTypeDef(TypedDict):
    SourceModelArn: str,
    ModelName: NotRequired[str],
    VersionName: NotRequired[str],
    ModelKmsKeyId: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)

See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    ResourceArn: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See TagTypeDef
See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)

See TagTypeDef

DataSecurityConfigTypeDef#

# DataSecurityConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DataSecurityConfigTypeDef

def get_value() -> DataSecurityConfigTypeDef:
    return {
        "ModelKmsKeyId": ...,
    }

# DataSecurityConfigTypeDef definition

class DataSecurityConfigTypeDef(TypedDict):
    ModelKmsKeyId: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    DataLakeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (1)

See VpcConfigTypeDef

UpdateDataSecurityConfigTypeDef#

# UpdateDataSecurityConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import UpdateDataSecurityConfigTypeDef

def get_value() -> UpdateDataSecurityConfigTypeDef:
    return {
        "ModelKmsKeyId": ...,
    }

# UpdateDataSecurityConfigTypeDef definition

class UpdateDataSecurityConfigTypeDef(TypedDict):
    ModelKmsKeyId: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (1)

See VpcConfigTypeDef

DatasetEntityRecognizerInputDataConfigTypeDef#

# DatasetEntityRecognizerInputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DatasetEntityRecognizerInputDataConfigTypeDef

def get_value() -> DatasetEntityRecognizerInputDataConfigTypeDef:
    return {
        "Documents": ...,
    }

# DatasetEntityRecognizerInputDataConfigTypeDef definition

class DatasetEntityRecognizerInputDataConfigTypeDef(TypedDict):
    Documents: DatasetEntityRecognizerDocumentsTypeDef,  # (2)
    Annotations: NotRequired[DatasetEntityRecognizerAnnotationsTypeDef],  # (1)
    EntityList: NotRequired[DatasetEntityRecognizerEntityListTypeDef],  # (3)

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDatasetsRequestRequestTypeDef

def get_value() -> ListDatasetsRequestRequestTypeDef:
    return {
        "FlywheelArn": ...,
    }

# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    FlywheelArn: NotRequired[str],
    Filter: NotRequired[DatasetFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See DatasetFilterTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeDatasetResponseTypeDef

def get_value() -> DescribeDatasetResponseTypeDef:
    return {
        "DatasetProperties": ...,
        "ResponseMetadata": ...,
    }

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    DatasetProperties: DatasetPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DatasetPropertiesTypeDef
See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDatasetsResponseTypeDef

def get_value() -> ListDatasetsResponseTypeDef:
    return {
        "DatasetPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListDatasetsResponseTypeDef definition

class ListDatasetsResponseTypeDef(TypedDict):
    DatasetPropertiesList: List[DatasetPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DatasetPropertiesTypeDef
See ResponseMetadataTypeDef

DescribeEndpointResponseTypeDef#

# DescribeEndpointResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DescribeEndpointResponseTypeDef

def get_value() -> DescribeEndpointResponseTypeDef:
    return {
        "EndpointProperties": ...,
        "ResponseMetadata": ...,
    }

# DescribeEndpointResponseTypeDef definition

class DescribeEndpointResponseTypeDef(TypedDict):
    EndpointProperties: EndpointPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EndpointPropertiesTypeDef
See ResponseMetadataTypeDef

ListEndpointsResponseTypeDef#

# ListEndpointsResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEndpointsResponseTypeDef

def get_value() -> ListEndpointsResponseTypeDef:
    return {
        "EndpointPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListEndpointsResponseTypeDef definition

class ListEndpointsResponseTypeDef(TypedDict):
    EndpointPropertiesList: List[EndpointPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EndpointPropertiesTypeDef
See ResponseMetadataTypeDef

DetectPiiEntitiesResponseTypeDef#

# DetectPiiEntitiesResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import DetectPiiEntitiesResponseTypeDef

def get_value() -> DetectPiiEntitiesResponseTypeDef:
    return {
        "Entities": ...,
        "ResponseMetadata": ...,
    }

# DetectPiiEntitiesResponseTypeDef definition

class DetectPiiEntitiesResponseTypeDef(TypedDict):
    Entities: List[PiiEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See PiiEntityTypeDef
See ResponseMetadataTypeDef

ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef#

# ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef

def get_value() -> ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef definition

class ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[DocumentClassificationJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

ListDocumentClassificationJobsRequestRequestTypeDef#

# ListDocumentClassificationJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDocumentClassificationJobsRequestRequestTypeDef

def get_value() -> ListDocumentClassificationJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListDocumentClassificationJobsRequestRequestTypeDef definition

class ListDocumentClassificationJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[DocumentClassificationJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See DocumentClassificationJobFilterTypeDef

DocumentClassifierInputDataConfigTypeDef#

# DocumentClassifierInputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentClassifierInputDataConfigTypeDef

def get_value() -> DocumentClassifierInputDataConfigTypeDef:
    return {
        "DataFormat": ...,
    }

# DocumentClassifierInputDataConfigTypeDef definition

class DocumentClassifierInputDataConfigTypeDef(TypedDict):
    DataFormat: NotRequired[DocumentClassifierDataFormatType],  # (1)
    S3Uri: NotRequired[str],
    TestS3Uri: NotRequired[str],
    LabelDelimiter: NotRequired[str],
    AugmentedManifests: NotRequired[Sequence[AugmentedManifestsListItemTypeDef]],  # (2)
    DocumentType: NotRequired[DocumentClassifierDocumentTypeFormatType],  # (3)
    Documents: NotRequired[DocumentClassifierDocumentsTypeDef],  # (4)
    DocumentReaderConfig: NotRequired[DocumentReaderConfigTypeDef],  # (5)

ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef#

# ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef

def get_value() -> ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef definition

class ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef(TypedDict):
    Filter: NotRequired[DocumentClassifierFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See DocumentClassifierFilterTypeDef
See PaginatorConfigTypeDef

ListDocumentClassifiersRequestRequestTypeDef#

# ListDocumentClassifiersRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDocumentClassifiersRequestRequestTypeDef

def get_value() -> ListDocumentClassifiersRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListDocumentClassifiersRequestRequestTypeDef definition

class ListDocumentClassifiersRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[DocumentClassifierFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See DocumentClassifierFilterTypeDef

ListDocumentClassifierSummariesResponseTypeDef#

# ListDocumentClassifierSummariesResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDocumentClassifierSummariesResponseTypeDef

def get_value() -> ListDocumentClassifierSummariesResponseTypeDef:
    return {
        "DocumentClassifierSummariesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListDocumentClassifierSummariesResponseTypeDef definition

class ListDocumentClassifierSummariesResponseTypeDef(TypedDict):
    DocumentClassifierSummariesList: List[DocumentClassifierSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DocumentClassifierSummaryTypeDef
See ResponseMetadataTypeDef

DocumentMetadataTypeDef#

# DocumentMetadataTypeDef usage example

from mypy_boto3_comprehend.type_defs import DocumentMetadataTypeDef

def get_value() -> DocumentMetadataTypeDef:
    return {
        "Pages": ...,
    }

# DocumentMetadataTypeDef definition

class DocumentMetadataTypeDef(TypedDict):
    Pages: NotRequired[int],
    ExtractedCharacters: NotRequired[List[ExtractedCharactersListItemTypeDef]],  # (1)

See ExtractedCharactersListItemTypeDef

ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef#

# ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef

def get_value() -> ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef definition

class ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[DominantLanguageDetectionJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

ListDominantLanguageDetectionJobsRequestRequestTypeDef#

# ListDominantLanguageDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListDominantLanguageDetectionJobsRequestRequestTypeDef

def get_value() -> ListDominantLanguageDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListDominantLanguageDetectionJobsRequestRequestTypeDef definition

class ListDominantLanguageDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[DominantLanguageDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See DominantLanguageDetectionJobFilterTypeDef

ListEndpointsRequestListEndpointsPaginateTypeDef#

# ListEndpointsRequestListEndpointsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEndpointsRequestListEndpointsPaginateTypeDef

def get_value() -> ListEndpointsRequestListEndpointsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListEndpointsRequestListEndpointsPaginateTypeDef definition

class ListEndpointsRequestListEndpointsPaginateTypeDef(TypedDict):
    Filter: NotRequired[EndpointFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See EndpointFilterTypeDef
See PaginatorConfigTypeDef

ListEndpointsRequestRequestTypeDef#

# ListEndpointsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEndpointsRequestRequestTypeDef

def get_value() -> ListEndpointsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListEndpointsRequestRequestTypeDef definition

class ListEndpointsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[EndpointFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See EndpointFilterTypeDef

ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef#

# ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef

def get_value() -> ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef definition

class ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[EntitiesDetectionJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See EntitiesDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListEntitiesDetectionJobsRequestRequestTypeDef#

# ListEntitiesDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEntitiesDetectionJobsRequestRequestTypeDef

def get_value() -> ListEntitiesDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListEntitiesDetectionJobsRequestRequestTypeDef definition

class ListEntitiesDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[EntitiesDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See EntitiesDetectionJobFilterTypeDef

EntityRecognitionConfigTypeDef#

# EntityRecognitionConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognitionConfigTypeDef

def get_value() -> EntityRecognitionConfigTypeDef:
    return {
        "EntityTypes": ...,
    }

# EntityRecognitionConfigTypeDef definition

class EntityRecognitionConfigTypeDef(TypedDict):
    EntityTypes: Sequence[EntityTypesListItemTypeDef],  # (1)

See EntityTypesListItemTypeDef

EntityRecognizerInputDataConfigTypeDef#

# EntityRecognizerInputDataConfigTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerInputDataConfigTypeDef

def get_value() -> EntityRecognizerInputDataConfigTypeDef:
    return {
        "EntityTypes": ...,
    }

# EntityRecognizerInputDataConfigTypeDef definition

class EntityRecognizerInputDataConfigTypeDef(TypedDict):
    EntityTypes: Sequence[EntityTypesListItemTypeDef],  # (2)
    DataFormat: NotRequired[EntityRecognizerDataFormatType],  # (1)
    Documents: NotRequired[EntityRecognizerDocumentsTypeDef],  # (3)
    Annotations: NotRequired[EntityRecognizerAnnotationsTypeDef],  # (4)
    EntityList: NotRequired[EntityRecognizerEntityListTypeDef],  # (5)
    AugmentedManifests: NotRequired[Sequence[AugmentedManifestsListItemTypeDef]],  # (6)

ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef#

# ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef

def get_value() -> ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef definition

class ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef(TypedDict):
    Filter: NotRequired[EntityRecognizerFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See EntityRecognizerFilterTypeDef
See PaginatorConfigTypeDef

ListEntityRecognizersRequestRequestTypeDef#

# ListEntityRecognizersRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEntityRecognizersRequestRequestTypeDef

def get_value() -> ListEntityRecognizersRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListEntityRecognizersRequestRequestTypeDef definition

class ListEntityRecognizersRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[EntityRecognizerFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See EntityRecognizerFilterTypeDef

EntityRecognizerMetadataEntityTypesListItemTypeDef#

# EntityRecognizerMetadataEntityTypesListItemTypeDef usage example

from mypy_boto3_comprehend.type_defs import EntityRecognizerMetadataEntityTypesListItemTypeDef

def get_value() -> EntityRecognizerMetadataEntityTypesListItemTypeDef:
    return {
        "Type": ...,
    }

# EntityRecognizerMetadataEntityTypesListItemTypeDef definition

class EntityRecognizerMetadataEntityTypesListItemTypeDef(TypedDict):
    Type: NotRequired[str],
    EvaluationMetrics: NotRequired[EntityTypesEvaluationMetricsTypeDef],  # (1)
    NumberOfTrainMentions: NotRequired[int],

See EntityTypesEvaluationMetricsTypeDef

ListEntityRecognizerSummariesResponseTypeDef#

# ListEntityRecognizerSummariesResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEntityRecognizerSummariesResponseTypeDef

def get_value() -> ListEntityRecognizerSummariesResponseTypeDef:
    return {
        "EntityRecognizerSummariesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListEntityRecognizerSummariesResponseTypeDef definition

class ListEntityRecognizerSummariesResponseTypeDef(TypedDict):
    EntityRecognizerSummariesList: List[EntityRecognizerSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EntityRecognizerSummaryTypeDef
See ResponseMetadataTypeDef

ListEventsDetectionJobsRequestRequestTypeDef#

# ListEventsDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListEventsDetectionJobsRequestRequestTypeDef

def get_value() -> ListEventsDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListEventsDetectionJobsRequestRequestTypeDef definition

class ListEventsDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[EventsDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See EventsDetectionJobFilterTypeDef

ListFlywheelsRequestRequestTypeDef#

# ListFlywheelsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListFlywheelsRequestRequestTypeDef

def get_value() -> ListFlywheelsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListFlywheelsRequestRequestTypeDef definition

class ListFlywheelsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[FlywheelFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See FlywheelFilterTypeDef

ListFlywheelIterationHistoryRequestRequestTypeDef#

# ListFlywheelIterationHistoryRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListFlywheelIterationHistoryRequestRequestTypeDef

def get_value() -> ListFlywheelIterationHistoryRequestRequestTypeDef:
    return {
        "FlywheelArn": ...,
    }

# ListFlywheelIterationHistoryRequestRequestTypeDef definition

class ListFlywheelIterationHistoryRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,
    Filter: NotRequired[FlywheelIterationFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See FlywheelIterationFilterTypeDef

FlywheelIterationPropertiesTypeDef#

# FlywheelIterationPropertiesTypeDef usage example

from mypy_boto3_comprehend.type_defs import FlywheelIterationPropertiesTypeDef

def get_value() -> FlywheelIterationPropertiesTypeDef:
    return {
        "FlywheelArn": ...,
    }

# FlywheelIterationPropertiesTypeDef definition

class FlywheelIterationPropertiesTypeDef(TypedDict):
    FlywheelArn: NotRequired[str],
    FlywheelIterationId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    Status: NotRequired[FlywheelIterationStatusType],  # (1)
    Message: NotRequired[str],
    EvaluatedModelArn: NotRequired[str],
    EvaluatedModelMetrics: NotRequired[FlywheelModelEvaluationMetricsTypeDef],  # (2)
    TrainedModelArn: NotRequired[str],
    TrainedModelMetrics: NotRequired[FlywheelModelEvaluationMetricsTypeDef],  # (2)
    EvaluationManifestS3Prefix: NotRequired[str],

ListFlywheelsResponseTypeDef#

# ListFlywheelsResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListFlywheelsResponseTypeDef

def get_value() -> ListFlywheelsResponseTypeDef:
    return {
        "FlywheelSummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListFlywheelsResponseTypeDef definition

class ListFlywheelsResponseTypeDef(TypedDict):
    FlywheelSummaryList: List[FlywheelSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See FlywheelSummaryTypeDef
See ResponseMetadataTypeDef

GeometryTypeDef#

# GeometryTypeDef usage example

from mypy_boto3_comprehend.type_defs import GeometryTypeDef

def get_value() -> GeometryTypeDef:
    return {
        "BoundingBox": ...,
    }

# GeometryTypeDef definition

class GeometryTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Polygon: NotRequired[List[PointTypeDef]],  # (2)

See BoundingBoxTypeDef
See PointTypeDef

ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef#

# ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef

def get_value() -> ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef definition

class ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[KeyPhrasesDetectionJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

ListKeyPhrasesDetectionJobsRequestRequestTypeDef#

# ListKeyPhrasesDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListKeyPhrasesDetectionJobsRequestRequestTypeDef

def get_value() -> ListKeyPhrasesDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListKeyPhrasesDetectionJobsRequestRequestTypeDef definition

class ListKeyPhrasesDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[KeyPhrasesDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See KeyPhrasesDetectionJobFilterTypeDef

ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef#

# ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef

def get_value() -> ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef definition

class ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[PiiEntitiesDetectionJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

ListPiiEntitiesDetectionJobsRequestRequestTypeDef#

# ListPiiEntitiesDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListPiiEntitiesDetectionJobsRequestRequestTypeDef

def get_value() -> ListPiiEntitiesDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListPiiEntitiesDetectionJobsRequestRequestTypeDef definition

class ListPiiEntitiesDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[PiiEntitiesDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See PiiEntitiesDetectionJobFilterTypeDef

ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef#

# ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef

def get_value() -> ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef definition

class ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[SentimentDetectionJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See SentimentDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListSentimentDetectionJobsRequestRequestTypeDef#

# ListSentimentDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListSentimentDetectionJobsRequestRequestTypeDef

def get_value() -> ListSentimentDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListSentimentDetectionJobsRequestRequestTypeDef definition

class ListSentimentDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[SentimentDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See SentimentDetectionJobFilterTypeDef

ListTargetedSentimentDetectionJobsRequestRequestTypeDef#

# ListTargetedSentimentDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListTargetedSentimentDetectionJobsRequestRequestTypeDef

def get_value() -> ListTargetedSentimentDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListTargetedSentimentDetectionJobsRequestRequestTypeDef definition

class ListTargetedSentimentDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[TargetedSentimentDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See TargetedSentimentDetectionJobFilterTypeDef

ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef#

# ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef

def get_value() -> ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef:
    return {
        "Filter": ...,
    }

# ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef definition

class ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef(TypedDict):
    Filter: NotRequired[TopicsDetectionJobFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See TopicsDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListTopicsDetectionJobsRequestRequestTypeDef#

# ListTopicsDetectionJobsRequestRequestTypeDef usage example

from mypy_boto3_comprehend.type_defs import ListTopicsDetectionJobsRequestRequestTypeDef

def get_value() -> ListTopicsDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

# ListTopicsDetectionJobsRequestRequestTypeDef definition

class ListTopicsDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[TopicsDetectionJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

See TopicsDetectionJobFilterTypeDef

SyntaxTokenTypeDef#

# SyntaxTokenTypeDef usage example

from mypy_boto3_comprehend.type_defs import SyntaxTokenTypeDef

def get_value() -> SyntaxTokenTypeDef:
    return {
        "TokenId": ...,
    }

# SyntaxTokenTypeDef definition

class SyntaxTokenTypeDef(TypedDict):
    TokenId: NotRequired[int],
    Text: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    PartOfSpeech: NotRequired[PartOfSpeechTagTypeDef],  # (1)

See PartOfSpeechTagTypeDef

BatchDetectDominantLanguageResponseTypeDef#

# BatchDetectDominantLanguageResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageResponseTypeDef

def get_value() -> BatchDetectDominantLanguageResponseTypeDef:
    return {
        "ResultList": ...,
        "ErrorList": ...,
        "ResponseMetadata": ...,
    }

# BatchDetectDominantLanguageResponseTypeDef definition

class BatchDetectDominantLanguageResponseTypeDef(TypedDict):
    ResultList: List[BatchDetectDominantLanguageItemResultTypeDef],  # (1)
    ErrorList: List[BatchItemErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

See BatchDetectDominantLanguageItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

BatchDetectKeyPhrasesResponseTypeDef#

# BatchDetectKeyPhrasesResponseTypeDef usage example

from mypy_boto3_comprehend.type_defs import BatchDetectKeyPhrasesResponseTypeDef

def get_value() -> BatchDetectKeyPhrasesResponseTypeDef:
    return {
        "ResultList": ...,
        "ErrorList": ...,
        "ResponseMetadata": ...,
    }

# BatchDetectKeyPhrasesResponseTypeDef definition

class BatchDetectKeyPhrasesResponseTypeDef(TypedDict):
    ResultList: List[BatchDetectKeyPhrasesItemResultTypeDef],  # (1)
    ErrorList: List[BatchItemErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

See BatchDetectKeyPhrasesItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef