Typed dictionaries

Index > Comprehend > Typed dictionaries

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

AugmentedManifestsListItemTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import AugmentedManifestsListItemTypeDef

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

Definition

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

See SplitType
See AugmentedManifestsDocumentTypeFormatType

DominantLanguageTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DominantLanguageTypeDef

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

Definition

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

BatchDetectDominantLanguageRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectDominantLanguageRequestRequestTypeDef

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

Definition

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

BatchItemErrorTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchItemErrorTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ResponseMetadataTypeDef

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

Definition

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

EntityTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityTypeDef

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

Definition

class EntityTypeDef(TypedDict):
    Score: NotRequired[float],
    Type: NotRequired[EntityTypeType],  # (1)
    Text: NotRequired[str],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

See EntityTypeType

BatchDetectEntitiesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectEntitiesRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

KeyPhraseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import KeyPhraseTypeDef

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

Definition

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

BatchDetectKeyPhrasesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectKeyPhrasesRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

SentimentScoreTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import SentimentScoreTypeDef

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

Definition

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

BatchDetectSentimentRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectSentimentRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

BatchDetectSyntaxRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectSyntaxRequestRequestTypeDef

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

Definition

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

See SyntaxLanguageCodeType

ClassifierEvaluationMetricsTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ClassifierEvaluationMetricsTypeDef

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

Definition

class ClassifierEvaluationMetricsTypeDef(TypedDict):
    Accuracy: NotRequired[float],
    Precision: NotRequired[float],
    Recall: NotRequired[float],
    F1Score: NotRequired[float],
    MicroPrecision: NotRequired[float],
    MicroRecall: NotRequired[float],
    MicroF1Score: NotRequired[float],
    HammingLoss: NotRequired[float],

ClassifyDocumentRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ClassifyDocumentRequestRequestTypeDef

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

Definition

class ClassifyDocumentRequestRequestTypeDef(TypedDict):
    Text: str,
    EndpointArn: str,

DocumentClassTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassTypeDef

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

Definition

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

DocumentLabelTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentLabelTypeDef

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

Definition

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

ContainsPiiEntitiesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ContainsPiiEntitiesRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

EntityLabelTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityLabelTypeDef

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

Definition

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

See PiiEntityTypeType

DocumentClassifierOutputDataConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassifierOutputDataConfigTypeDef

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

Definition

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

TagTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import TagTypeDef

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

Definition

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

VpcConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import VpcConfigTypeDef

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

Definition

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

DeleteDocumentClassifierRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DeleteDocumentClassifierRequestRequestTypeDef

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

Definition

class DeleteDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DeleteEndpointRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DeleteEndpointRequestRequestTypeDef

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

Definition

class DeleteEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

DeleteEntityRecognizerRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DeleteEntityRecognizerRequestRequestTypeDef

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

Definition

class DeleteEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DeleteResourcePolicyRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DeleteResourcePolicyRequestRequestTypeDef

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

Definition

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

DescribeDocumentClassificationJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeDocumentClassificationJobRequestRequestTypeDef

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

Definition

class DescribeDocumentClassificationJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeDocumentClassifierRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeDocumentClassifierRequestRequestTypeDef

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

Definition

class DescribeDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DescribeDominantLanguageDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeDominantLanguageDetectionJobRequestRequestTypeDef

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

Definition

class DescribeDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEndpointRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEndpointRequestRequestTypeDef

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

Definition

class DescribeEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

EndpointPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EndpointPropertiesTypeDef

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

Definition

class EndpointPropertiesTypeDef(TypedDict):
    EndpointArn: NotRequired[str],
    Status: NotRequired[EndpointStatusType],  # (1)
    Message: NotRequired[str],
    ModelArn: NotRequired[str],
    DesiredModelArn: NotRequired[str],
    DesiredInferenceUnits: NotRequired[int],
    CurrentInferenceUnits: NotRequired[int],
    CreationTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    DataAccessRoleArn: NotRequired[str],
    DesiredDataAccessRoleArn: NotRequired[str],

See EndpointStatusType

DescribeEntitiesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEntitiesDetectionJobRequestRequestTypeDef

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

Definition

class DescribeEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEntityRecognizerRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEntityRecognizerRequestRequestTypeDef

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

Definition

class DescribeEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DescribeEventsDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEventsDetectionJobRequestRequestTypeDef

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

Definition

class DescribeEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

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

Definition

class DescribeKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePiiEntitiesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribePiiEntitiesDetectionJobRequestRequestTypeDef

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

Definition

class DescribePiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeResourcePolicyRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeResourcePolicyRequestRequestTypeDef

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

Definition

class DescribeResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DescribeSentimentDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeSentimentDetectionJobRequestRequestTypeDef

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

Definition

class DescribeSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

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

Definition

class DescribeTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTopicsDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeTopicsDetectionJobRequestRequestTypeDef

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

Definition

class DescribeTopicsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DetectDominantLanguageRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectDominantLanguageRequestRequestTypeDef

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

Definition

class DetectDominantLanguageRequestRequestTypeDef(TypedDict):
    Text: str,

DetectEntitiesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectEntitiesRequestRequestTypeDef

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

Definition

class DetectEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    EndpointArn: NotRequired[str],

See LanguageCodeType

DetectKeyPhrasesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectKeyPhrasesRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

DetectPiiEntitiesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectPiiEntitiesRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

PiiEntityTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PiiEntityTypeDef

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

Definition

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

See PiiEntityTypeType

DetectSentimentRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectSentimentRequestRequestTypeDef

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

Definition

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

See LanguageCodeType

DetectSyntaxRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectSyntaxRequestRequestTypeDef

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

Definition

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

See SyntaxLanguageCodeType

DocumentClassificationJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassificationJobFilterTypeDef

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

Definition

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

See JobStatusType

OutputDataConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import OutputDataConfigTypeDef

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

Definition

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

DocumentClassifierFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassifierFilterTypeDef

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

Definition

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

See ModelStatusType

DocumentClassifierSummaryTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassifierSummaryTypeDef

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

Definition

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

See ModelStatusType

DocumentReaderConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentReaderConfigTypeDef

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

Definition

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

DominantLanguageDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DominantLanguageDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

EndpointFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EndpointFilterTypeDef

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

Definition

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

See EndpointStatusType

EntitiesDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntitiesDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

EntityRecognizerAnnotationsTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerAnnotationsTypeDef

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

Definition

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

EntityRecognizerDocumentsTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerDocumentsTypeDef

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

Definition

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

See InputFormatType

EntityRecognizerEntityListTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerEntityListTypeDef

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

Definition

class EntityRecognizerEntityListTypeDef(TypedDict):
    S3Uri: str,

EntityRecognizerEvaluationMetricsTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerEvaluationMetricsTypeDef

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

Definition

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

EntityRecognizerFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerFilterTypeDef

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

Definition

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

See ModelStatusType

EntityTypesListItemTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityTypesListItemTypeDef

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

Definition

class EntityTypesListItemTypeDef(TypedDict):
    Type: str,

EntityTypesEvaluationMetricsTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityTypesEvaluationMetricsTypeDef

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

Definition

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

EntityRecognizerSummaryTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerSummaryTypeDef

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

Definition

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

See ModelStatusType

EventsDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EventsDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

KeyPhrasesDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import KeyPhrasesDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

PaginatorConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PaginatorConfigTypeDef

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

Definition

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

ListDocumentClassifierSummariesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassifierSummariesRequestRequestTypeDef

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

Definition

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

ListEntityRecognizerSummariesRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntityRecognizerSummariesRequestRequestTypeDef

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

Definition

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

PiiEntitiesDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PiiEntitiesDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

SentimentDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import SentimentDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

ListTagsForResourceRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTagsForResourceRequestRequestTypeDef

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

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TargetedSentimentDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import TargetedSentimentDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

TopicsDetectionJobFilterTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import TopicsDetectionJobFilterTypeDef

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

Definition

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

See JobStatusType

PartOfSpeechTagTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PartOfSpeechTagTypeDef

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

Definition

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

See PartOfSpeechTagTypeType

PiiOutputDataConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PiiOutputDataConfigTypeDef

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

Definition

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

RedactionConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import RedactionConfigTypeDef

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

Definition

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

See PiiEntityTypeType
See PiiEntitiesDetectionMaskModeType

PutResourcePolicyRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PutResourcePolicyRequestRequestTypeDef

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

Definition

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

StopDominantLanguageDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopDominantLanguageDetectionJobRequestRequestTypeDef

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

Definition

class StopDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEntitiesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopEntitiesDetectionJobRequestRequestTypeDef

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

Definition

class StopEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEventsDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopEventsDetectionJobRequestRequestTypeDef

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

Definition

class StopEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopKeyPhrasesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopKeyPhrasesDetectionJobRequestRequestTypeDef

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

Definition

class StopKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopPiiEntitiesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopPiiEntitiesDetectionJobRequestRequestTypeDef

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

Definition

class StopPiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopSentimentDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopSentimentDetectionJobRequestRequestTypeDef

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

Definition

class StopSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTargetedSentimentDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopTargetedSentimentDetectionJobRequestRequestTypeDef

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

Definition

class StopTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTrainingDocumentClassifierRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopTrainingDocumentClassifierRequestRequestTypeDef

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

Definition

class StopTrainingDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

StopTrainingEntityRecognizerRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopTrainingEntityRecognizerRequestRequestTypeDef

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

Definition

class StopTrainingEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

UntagResourceRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import UntagResourceRequestRequestTypeDef

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

Definition

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

UpdateEndpointRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import UpdateEndpointRequestRequestTypeDef

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

Definition

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

DocumentClassifierInputDataConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassifierInputDataConfigTypeDef

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

Definition

class DocumentClassifierInputDataConfigTypeDef(TypedDict):
    DataFormat: NotRequired[DocumentClassifierDataFormatType],  # (1)
    S3Uri: NotRequired[str],
    TestS3Uri: NotRequired[str],
    LabelDelimiter: NotRequired[str],
    AugmentedManifests: NotRequired[Sequence[AugmentedManifestsListItemTypeDef]],  # (2)

BatchDetectDominantLanguageItemResultTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectDominantLanguageItemResultTypeDef

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

Definition

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

See DominantLanguageTypeDef

CreateDocumentClassifierResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import CreateDocumentClassifierResponseTypeDef

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

Definition

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

See ResponseMetadataTypeDef

CreateEndpointResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import CreateEndpointResponseTypeDef

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

Definition

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

See ResponseMetadataTypeDef

CreateEntityRecognizerResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import CreateEntityRecognizerResponseTypeDef

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

Definition

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

See ResponseMetadataTypeDef

DescribeResourcePolicyResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeResourcePolicyResponseTypeDef

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

Definition

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

See ResponseMetadataTypeDef

DetectDominantLanguageResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectDominantLanguageResponseTypeDef

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

Definition

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

See DominantLanguageTypeDef
See ResponseMetadataTypeDef

ImportModelResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ImportModelResponseTypeDef

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

Definition

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

See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PutResourcePolicyResponseTypeDef

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

Definition

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

See ResponseMetadataTypeDef

StartDocumentClassificationJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartDocumentClassificationJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartDominantLanguageDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartDominantLanguageDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartEntitiesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartEntitiesDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartEventsDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartEventsDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartKeyPhrasesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartKeyPhrasesDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartPiiEntitiesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartPiiEntitiesDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartSentimentDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartSentimentDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartTargetedSentimentDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartTargetedSentimentDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartTopicsDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartTopicsDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopDominantLanguageDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopDominantLanguageDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopEntitiesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopEntitiesDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopEventsDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopEventsDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopKeyPhrasesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopKeyPhrasesDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopPiiEntitiesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopPiiEntitiesDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopSentimentDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopSentimentDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopTargetedSentimentDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StopTargetedSentimentDetectionJobResponseTypeDef

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

Definition

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

See JobStatusType
See ResponseMetadataTypeDef

BatchDetectEntitiesItemResultTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectEntitiesItemResultTypeDef

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

Definition

class BatchDetectEntitiesItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Entities: NotRequired[List[EntityTypeDef]],  # (1)

See EntityTypeDef

DetectEntitiesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectEntitiesResponseTypeDef

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

Definition

class DetectEntitiesResponseTypeDef(TypedDict):
    Entities: List[EntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EntityTypeDef
See ResponseMetadataTypeDef

BatchDetectKeyPhrasesItemResultTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectKeyPhrasesItemResultTypeDef

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

Definition

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

See KeyPhraseTypeDef

DetectKeyPhrasesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectKeyPhrasesResponseTypeDef

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

Definition

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

See KeyPhraseTypeDef
See ResponseMetadataTypeDef

BatchDetectSentimentItemResultTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectSentimentItemResultTypeDef

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

Definition

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

See SentimentTypeType
See SentimentScoreTypeDef

DetectSentimentResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectSentimentResponseTypeDef

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

Definition

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

ClassifierMetadataTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ClassifierMetadataTypeDef

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

Definition

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

See ClassifierEvaluationMetricsTypeDef

ClassifyDocumentResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ClassifyDocumentResponseTypeDef

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

Definition

class ClassifyDocumentResponseTypeDef(TypedDict):
    Classes: List[DocumentClassTypeDef],  # (1)
    Labels: List[DocumentLabelTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

ContainsPiiEntitiesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ContainsPiiEntitiesResponseTypeDef

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

Definition

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

See EntityLabelTypeDef
See ResponseMetadataTypeDef

CreateEndpointRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import CreateEndpointRequestRequestTypeDef

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

Definition

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

See TagTypeDef

ImportModelRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ImportModelRequestRequestTypeDef

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

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

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTagsForResourceResponseTypeDef

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

Definition

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

See TagTypeDef
See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import TagResourceRequestRequestTypeDef

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

Definition

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

See TagTypeDef

DescribeEndpointResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEndpointResponseTypeDef

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

Definition

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

See EndpointPropertiesTypeDef
See ResponseMetadataTypeDef

ListEndpointsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEndpointsResponseTypeDef

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

Definition

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

See EndpointPropertiesTypeDef
See ResponseMetadataTypeDef

DetectPiiEntitiesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectPiiEntitiesResponseTypeDef

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

Definition

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

See PiiEntityTypeDef
See ResponseMetadataTypeDef

ListDocumentClassificationJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassificationJobsRequestRequestTypeDef

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

Definition

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

See DocumentClassificationJobFilterTypeDef

ListDocumentClassifiersRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassifiersRequestRequestTypeDef

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

Definition

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

See DocumentClassifierFilterTypeDef

ListDocumentClassifierSummariesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassifierSummariesResponseTypeDef

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

Definition

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

See DocumentClassifierSummaryTypeDef
See ResponseMetadataTypeDef

InputDataConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import InputDataConfigTypeDef

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

Definition

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

See InputFormatType
See DocumentReaderConfigTypeDef

ListDominantLanguageDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDominantLanguageDetectionJobsRequestRequestTypeDef

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

Definition

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

See DominantLanguageDetectionJobFilterTypeDef

ListEndpointsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEndpointsRequestRequestTypeDef

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

Definition

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

See EndpointFilterTypeDef

ListEntitiesDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntitiesDetectionJobsRequestRequestTypeDef

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

Definition

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

See EntitiesDetectionJobFilterTypeDef

ListEntityRecognizersRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntityRecognizersRequestRequestTypeDef

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

Definition

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

See EntityRecognizerFilterTypeDef

EntityRecognizerInputDataConfigTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerInputDataConfigTypeDef

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

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)

EntityRecognizerMetadataEntityTypesListItemTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerMetadataEntityTypesListItemTypeDef

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

Definition

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

See EntityTypesEvaluationMetricsTypeDef

ListEntityRecognizerSummariesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntityRecognizerSummariesResponseTypeDef

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

Definition

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

See EntityRecognizerSummaryTypeDef
See ResponseMetadataTypeDef

ListEventsDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEventsDetectionJobsRequestRequestTypeDef

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

Definition

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

See EventsDetectionJobFilterTypeDef

ListKeyPhrasesDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListKeyPhrasesDetectionJobsRequestRequestTypeDef

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

Definition

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

See KeyPhrasesDetectionJobFilterTypeDef

ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef

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

Definition

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

ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef

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

Definition

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

See DocumentClassifierFilterTypeDef
See PaginatorConfigTypeDef

ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef

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

Definition

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

ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef

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

Definition

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

See EntitiesDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef

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

Definition

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

See EntityRecognizerFilterTypeDef
See PaginatorConfigTypeDef

ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef

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

Definition

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

ListPiiEntitiesDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListPiiEntitiesDetectionJobsRequestRequestTypeDef

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

Definition

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

See PiiEntitiesDetectionJobFilterTypeDef

ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef

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

Definition

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

See SentimentDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListSentimentDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListSentimentDetectionJobsRequestRequestTypeDef

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

Definition

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

See SentimentDetectionJobFilterTypeDef

ListTargetedSentimentDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTargetedSentimentDetectionJobsRequestRequestTypeDef

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

Definition

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

See TargetedSentimentDetectionJobFilterTypeDef

ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef

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

Definition

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

See TopicsDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListTopicsDetectionJobsRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTopicsDetectionJobsRequestRequestTypeDef

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

Definition

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

See TopicsDetectionJobFilterTypeDef

SyntaxTokenTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import SyntaxTokenTypeDef

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

Definition

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

See PartOfSpeechTagTypeDef

CreateDocumentClassifierRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import CreateDocumentClassifierRequestRequestTypeDef

def get_value() -> CreateDocumentClassifierRequestRequestTypeDef:
    return {
        "DocumentClassifierName": ...,
        "DataAccessRoleArn": ...,
        "InputDataConfig": ...,
        "LanguageCode": ...,
    }

Definition

class CreateDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierName: str,
    DataAccessRoleArn: str,
    InputDataConfig: DocumentClassifierInputDataConfigTypeDef,  # (1)
    LanguageCode: LanguageCodeType,  # (2)
    VersionName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    OutputDataConfig: NotRequired[DocumentClassifierOutputDataConfigTypeDef],  # (4)
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (5)
    Mode: NotRequired[DocumentClassifierModeType],  # (6)
    ModelKmsKeyId: NotRequired[str],
    ModelPolicy: NotRequired[str],

See DocumentClassifierInputDataConfigTypeDef
See LanguageCodeType
See TagTypeDef
See DocumentClassifierOutputDataConfigTypeDef
See VpcConfigTypeDef
See DocumentClassifierModeType

BatchDetectDominantLanguageResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectDominantLanguageResponseTypeDef

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

Definition

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

See BatchDetectDominantLanguageItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

BatchDetectEntitiesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectEntitiesResponseTypeDef

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

Definition

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

See BatchDetectEntitiesItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

BatchDetectKeyPhrasesResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectKeyPhrasesResponseTypeDef

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

Definition

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

See BatchDetectKeyPhrasesItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

BatchDetectSentimentResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectSentimentResponseTypeDef

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

Definition

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

See BatchDetectSentimentItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

DocumentClassifierPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassifierPropertiesTypeDef

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

Definition

class DocumentClassifierPropertiesTypeDef(TypedDict):
    DocumentClassifierArn: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    Status: NotRequired[ModelStatusType],  # (2)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    TrainingStartTime: NotRequired[datetime],
    TrainingEndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[DocumentClassifierInputDataConfigTypeDef],  # (3)
    OutputDataConfig: NotRequired[DocumentClassifierOutputDataConfigTypeDef],  # (4)
    ClassifierMetadata: NotRequired[ClassifierMetadataTypeDef],  # (5)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (6)
    Mode: NotRequired[DocumentClassifierModeType],  # (7)
    ModelKmsKeyId: NotRequired[str],
    VersionName: NotRequired[str],
    SourceModelArn: NotRequired[str],

See LanguageCodeType
See ModelStatusType
See DocumentClassifierInputDataConfigTypeDef
See DocumentClassifierOutputDataConfigTypeDef
See ClassifierMetadataTypeDef
See VpcConfigTypeDef
See DocumentClassifierModeType

DocumentClassificationJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DocumentClassificationJobPropertiesTypeDef

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

Definition

class DocumentClassificationJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    DocumentClassifierArn: NotRequired[str],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)

DominantLanguageDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DominantLanguageDetectionJobPropertiesTypeDef

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

Definition

class DominantLanguageDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)

EntitiesDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntitiesDetectionJobPropertiesTypeDef

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

Definition

class EntitiesDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    EntityRecognizerArn: NotRequired[str],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (5)

EventsDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EventsDetectionJobPropertiesTypeDef

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

Definition

class EventsDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    TargetEventTypes: NotRequired[List[str]],

KeyPhrasesDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import KeyPhrasesDetectionJobPropertiesTypeDef

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

Definition

class KeyPhrasesDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (5)

PiiEntitiesDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import PiiEntitiesDetectionJobPropertiesTypeDef

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

Definition

class PiiEntitiesDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[PiiOutputDataConfigTypeDef],  # (3)
    RedactionConfig: NotRequired[RedactionConfigTypeDef],  # (4)
    LanguageCode: NotRequired[LanguageCodeType],  # (5)
    DataAccessRoleArn: NotRequired[str],
    Mode: NotRequired[PiiEntitiesDetectionModeType],  # (6)

SentimentDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import SentimentDetectionJobPropertiesTypeDef

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

Definition

class SentimentDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (5)

StartDocumentClassificationJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartDocumentClassificationJobRequestRequestTypeDef

def get_value() -> StartDocumentClassificationJobRequestRequestTypeDef:
    return {
        "DocumentClassifierArn": ...,
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
    }

Definition

class StartDocumentClassificationJobRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)

StartDominantLanguageDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartDominantLanguageDetectionJobRequestRequestTypeDef

def get_value() -> StartDominantLanguageDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
    }

Definition

class StartDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)

StartEntitiesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> StartEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

Definition

class StartEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    EntityRecognizerArn: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)

StartEventsDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartEventsDetectionJobRequestRequestTypeDef

def get_value() -> StartEventsDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
        "TargetEventTypes": ...,
    }

Definition

class StartEventsDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    TargetEventTypes: Sequence[str],
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)

StartKeyPhrasesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartKeyPhrasesDetectionJobRequestRequestTypeDef

def get_value() -> StartKeyPhrasesDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

Definition

class StartKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)

StartPiiEntitiesDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartPiiEntitiesDetectionJobRequestRequestTypeDef

def get_value() -> StartPiiEntitiesDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "Mode": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

Definition

class StartPiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    Mode: PiiEntitiesDetectionModeType,  # (3)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (4)
    RedactionConfig: NotRequired[RedactionConfigTypeDef],  # (5)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (6)

StartSentimentDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartSentimentDetectionJobRequestRequestTypeDef

def get_value() -> StartSentimentDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

Definition

class StartSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)

StartTargetedSentimentDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartTargetedSentimentDetectionJobRequestRequestTypeDef

def get_value() -> StartTargetedSentimentDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

Definition

class StartTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)

StartTopicsDetectionJobRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import StartTopicsDetectionJobRequestRequestTypeDef

def get_value() -> StartTopicsDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
    }

Definition

class StartTopicsDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    JobName: NotRequired[str],
    NumberOfTopics: NotRequired[int],
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)

TargetedSentimentDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import TargetedSentimentDetectionJobPropertiesTypeDef

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

Definition

class TargetedSentimentDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (5)

TopicsDetectionJobPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import TopicsDetectionJobPropertiesTypeDef

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

Definition

class TopicsDetectionJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobArn: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    NumberOfTopics: NotRequired[int],
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)

CreateEntityRecognizerRequestRequestTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import CreateEntityRecognizerRequestRequestTypeDef

def get_value() -> CreateEntityRecognizerRequestRequestTypeDef:
    return {
        "RecognizerName": ...,
        "DataAccessRoleArn": ...,
        "InputDataConfig": ...,
        "LanguageCode": ...,
    }

Definition

class CreateEntityRecognizerRequestRequestTypeDef(TypedDict):
    RecognizerName: str,
    DataAccessRoleArn: str,
    InputDataConfig: EntityRecognizerInputDataConfigTypeDef,  # (1)
    LanguageCode: LanguageCodeType,  # (2)
    VersionName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    ClientRequestToken: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (4)
    ModelKmsKeyId: NotRequired[str],
    ModelPolicy: NotRequired[str],

See EntityRecognizerInputDataConfigTypeDef
See LanguageCodeType
See TagTypeDef
See VpcConfigTypeDef

EntityRecognizerMetadataTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerMetadataTypeDef

def get_value() -> EntityRecognizerMetadataTypeDef:
    return {
        "NumberOfTrainedDocuments": ...,
    }

Definition

class EntityRecognizerMetadataTypeDef(TypedDict):
    NumberOfTrainedDocuments: NotRequired[int],
    NumberOfTestDocuments: NotRequired[int],
    EvaluationMetrics: NotRequired[EntityRecognizerEvaluationMetricsTypeDef],  # (1)
    EntityTypes: NotRequired[List[EntityRecognizerMetadataEntityTypesListItemTypeDef]],  # (2)

BatchDetectSyntaxItemResultTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectSyntaxItemResultTypeDef

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

Definition

class BatchDetectSyntaxItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    SyntaxTokens: NotRequired[List[SyntaxTokenTypeDef]],  # (1)

See SyntaxTokenTypeDef

DetectSyntaxResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DetectSyntaxResponseTypeDef

def get_value() -> DetectSyntaxResponseTypeDef:
    return {
        "SyntaxTokens": ...,
        "ResponseMetadata": ...,
    }

Definition

class DetectSyntaxResponseTypeDef(TypedDict):
    SyntaxTokens: List[SyntaxTokenTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See SyntaxTokenTypeDef
See ResponseMetadataTypeDef

DescribeDocumentClassifierResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeDocumentClassifierResponseTypeDef

def get_value() -> DescribeDocumentClassifierResponseTypeDef:
    return {
        "DocumentClassifierProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeDocumentClassifierResponseTypeDef(TypedDict):
    DocumentClassifierProperties: DocumentClassifierPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListDocumentClassifiersResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassifiersResponseTypeDef

def get_value() -> ListDocumentClassifiersResponseTypeDef:
    return {
        "DocumentClassifierPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListDocumentClassifiersResponseTypeDef(TypedDict):
    DocumentClassifierPropertiesList: List[DocumentClassifierPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeDocumentClassificationJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeDocumentClassificationJobResponseTypeDef

def get_value() -> DescribeDocumentClassificationJobResponseTypeDef:
    return {
        "DocumentClassificationJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeDocumentClassificationJobResponseTypeDef(TypedDict):
    DocumentClassificationJobProperties: DocumentClassificationJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListDocumentClassificationJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDocumentClassificationJobsResponseTypeDef

def get_value() -> ListDocumentClassificationJobsResponseTypeDef:
    return {
        "DocumentClassificationJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListDocumentClassificationJobsResponseTypeDef(TypedDict):
    DocumentClassificationJobPropertiesList: List[DocumentClassificationJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeDominantLanguageDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeDominantLanguageDetectionJobResponseTypeDef

def get_value() -> DescribeDominantLanguageDetectionJobResponseTypeDef:
    return {
        "DominantLanguageDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeDominantLanguageDetectionJobResponseTypeDef(TypedDict):
    DominantLanguageDetectionJobProperties: DominantLanguageDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListDominantLanguageDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListDominantLanguageDetectionJobsResponseTypeDef

def get_value() -> ListDominantLanguageDetectionJobsResponseTypeDef:
    return {
        "DominantLanguageDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListDominantLanguageDetectionJobsResponseTypeDef(TypedDict):
    DominantLanguageDetectionJobPropertiesList: List[DominantLanguageDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeEntitiesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEntitiesDetectionJobResponseTypeDef

def get_value() -> DescribeEntitiesDetectionJobResponseTypeDef:
    return {
        "EntitiesDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeEntitiesDetectionJobResponseTypeDef(TypedDict):
    EntitiesDetectionJobProperties: EntitiesDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListEntitiesDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntitiesDetectionJobsResponseTypeDef

def get_value() -> ListEntitiesDetectionJobsResponseTypeDef:
    return {
        "EntitiesDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListEntitiesDetectionJobsResponseTypeDef(TypedDict):
    EntitiesDetectionJobPropertiesList: List[EntitiesDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeEventsDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEventsDetectionJobResponseTypeDef

def get_value() -> DescribeEventsDetectionJobResponseTypeDef:
    return {
        "EventsDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeEventsDetectionJobResponseTypeDef(TypedDict):
    EventsDetectionJobProperties: EventsDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListEventsDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEventsDetectionJobsResponseTypeDef

def get_value() -> ListEventsDetectionJobsResponseTypeDef:
    return {
        "EventsDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListEventsDetectionJobsResponseTypeDef(TypedDict):
    EventsDetectionJobPropertiesList: List[EventsDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeKeyPhrasesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeKeyPhrasesDetectionJobResponseTypeDef

def get_value() -> DescribeKeyPhrasesDetectionJobResponseTypeDef:
    return {
        "KeyPhrasesDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeKeyPhrasesDetectionJobResponseTypeDef(TypedDict):
    KeyPhrasesDetectionJobProperties: KeyPhrasesDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListKeyPhrasesDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListKeyPhrasesDetectionJobsResponseTypeDef

def get_value() -> ListKeyPhrasesDetectionJobsResponseTypeDef:
    return {
        "KeyPhrasesDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListKeyPhrasesDetectionJobsResponseTypeDef(TypedDict):
    KeyPhrasesDetectionJobPropertiesList: List[KeyPhrasesDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribePiiEntitiesDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribePiiEntitiesDetectionJobResponseTypeDef

def get_value() -> DescribePiiEntitiesDetectionJobResponseTypeDef:
    return {
        "PiiEntitiesDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribePiiEntitiesDetectionJobResponseTypeDef(TypedDict):
    PiiEntitiesDetectionJobProperties: PiiEntitiesDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListPiiEntitiesDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListPiiEntitiesDetectionJobsResponseTypeDef

def get_value() -> ListPiiEntitiesDetectionJobsResponseTypeDef:
    return {
        "PiiEntitiesDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListPiiEntitiesDetectionJobsResponseTypeDef(TypedDict):
    PiiEntitiesDetectionJobPropertiesList: List[PiiEntitiesDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeSentimentDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeSentimentDetectionJobResponseTypeDef

def get_value() -> DescribeSentimentDetectionJobResponseTypeDef:
    return {
        "SentimentDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeSentimentDetectionJobResponseTypeDef(TypedDict):
    SentimentDetectionJobProperties: SentimentDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListSentimentDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListSentimentDetectionJobsResponseTypeDef

def get_value() -> ListSentimentDetectionJobsResponseTypeDef:
    return {
        "SentimentDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListSentimentDetectionJobsResponseTypeDef(TypedDict):
    SentimentDetectionJobPropertiesList: List[SentimentDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeTargetedSentimentDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeTargetedSentimentDetectionJobResponseTypeDef

def get_value() -> DescribeTargetedSentimentDetectionJobResponseTypeDef:
    return {
        "TargetedSentimentDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeTargetedSentimentDetectionJobResponseTypeDef(TypedDict):
    TargetedSentimentDetectionJobProperties: TargetedSentimentDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListTargetedSentimentDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTargetedSentimentDetectionJobsResponseTypeDef

def get_value() -> ListTargetedSentimentDetectionJobsResponseTypeDef:
    return {
        "TargetedSentimentDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTargetedSentimentDetectionJobsResponseTypeDef(TypedDict):
    TargetedSentimentDetectionJobPropertiesList: List[TargetedSentimentDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

DescribeTopicsDetectionJobResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeTopicsDetectionJobResponseTypeDef

def get_value() -> DescribeTopicsDetectionJobResponseTypeDef:
    return {
        "TopicsDetectionJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeTopicsDetectionJobResponseTypeDef(TypedDict):
    TopicsDetectionJobProperties: TopicsDetectionJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListTopicsDetectionJobsResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListTopicsDetectionJobsResponseTypeDef

def get_value() -> ListTopicsDetectionJobsResponseTypeDef:
    return {
        "TopicsDetectionJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTopicsDetectionJobsResponseTypeDef(TypedDict):
    TopicsDetectionJobPropertiesList: List[TopicsDetectionJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

EntityRecognizerPropertiesTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import EntityRecognizerPropertiesTypeDef

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

Definition

class EntityRecognizerPropertiesTypeDef(TypedDict):
    EntityRecognizerArn: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    Status: NotRequired[ModelStatusType],  # (2)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    TrainingStartTime: NotRequired[datetime],
    TrainingEndTime: NotRequired[datetime],
    InputDataConfig: NotRequired[EntityRecognizerInputDataConfigTypeDef],  # (3)
    RecognizerMetadata: NotRequired[EntityRecognizerMetadataTypeDef],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigTypeDef],  # (5)
    ModelKmsKeyId: NotRequired[str],
    VersionName: NotRequired[str],
    SourceModelArn: NotRequired[str],

See LanguageCodeType
See ModelStatusType
See EntityRecognizerInputDataConfigTypeDef
See EntityRecognizerMetadataTypeDef
See VpcConfigTypeDef

BatchDetectSyntaxResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import BatchDetectSyntaxResponseTypeDef

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

Definition

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

DescribeEntityRecognizerResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import DescribeEntityRecognizerResponseTypeDef

def get_value() -> DescribeEntityRecognizerResponseTypeDef:
    return {
        "EntityRecognizerProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeEntityRecognizerResponseTypeDef(TypedDict):
    EntityRecognizerProperties: EntityRecognizerPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EntityRecognizerPropertiesTypeDef
See ResponseMetadataTypeDef

ListEntityRecognizersResponseTypeDef

Usage Example

from types_aiobotocore_comprehend.type_defs import ListEntityRecognizersResponseTypeDef

def get_value() -> ListEntityRecognizersResponseTypeDef:
    return {
        "EntityRecognizerPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListEntityRecognizersResponseTypeDef(TypedDict):
    EntityRecognizerPropertiesList: List[EntityRecognizerPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See EntityRecognizerPropertiesTypeDef
See ResponseMetadataTypeDef