Type definitions#

Index > Comprehend > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AugmentedManifestsListItemUnionTypeDef#

# AugmentedManifestsListItemUnionTypeDef definition

AugmentedManifestsListItemUnionTypeDef = Union[
    AugmentedManifestsListItemTypeDef,  # (1)
    AugmentedManifestsListItemOutputTypeDef,  # (2)
]

VpcConfigUnionTypeDef#

# VpcConfigUnionTypeDef definition

VpcConfigUnionTypeDef = Union[
    VpcConfigTypeDef,  # (1)
    VpcConfigOutputTypeDef,  # (2)
]

See VpcConfigTypeDef
See VpcConfigOutputTypeDef

DocumentClassificationConfigUnionTypeDef#

# DocumentClassificationConfigUnionTypeDef definition

DocumentClassificationConfigUnionTypeDef = Union[
    DocumentClassificationConfigTypeDef,  # (1)
    DocumentClassificationConfigOutputTypeDef,  # (2)
]

DocumentReaderConfigUnionTypeDef#

# DocumentReaderConfigUnionTypeDef definition

DocumentReaderConfigUnionTypeDef = Union[
    DocumentReaderConfigTypeDef,  # (1)
    DocumentReaderConfigOutputTypeDef,  # (2)
]

EntityRecognitionConfigUnionTypeDef#

# EntityRecognitionConfigUnionTypeDef definition

EntityRecognitionConfigUnionTypeDef = Union[
    EntityRecognitionConfigTypeDef,  # (1)
    EntityRecognitionConfigOutputTypeDef,  # (2)
]

AugmentedManifestsListItemOutputTypeDef#

# AugmentedManifestsListItemOutputTypeDef definition

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

See SplitType
See AugmentedManifestsDocumentTypeFormatType

AugmentedManifestsListItemTypeDef#

# AugmentedManifestsListItemTypeDef definition

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

See SplitType
See AugmentedManifestsDocumentTypeFormatType

DominantLanguageTypeDef#

# DominantLanguageTypeDef definition

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

BatchDetectDominantLanguageRequestRequestTypeDef#

# BatchDetectDominantLanguageRequestRequestTypeDef definition

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

BatchItemErrorTypeDef#

# BatchItemErrorTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BatchDetectEntitiesRequestRequestTypeDef#

# BatchDetectEntitiesRequestRequestTypeDef definition

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

See LanguageCodeType

KeyPhraseTypeDef#

# KeyPhraseTypeDef definition

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

BatchDetectKeyPhrasesRequestRequestTypeDef#

# BatchDetectKeyPhrasesRequestRequestTypeDef definition

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

See LanguageCodeType

SentimentScoreTypeDef#

# SentimentScoreTypeDef definition

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

BatchDetectSentimentRequestRequestTypeDef#

# BatchDetectSentimentRequestRequestTypeDef definition

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

See LanguageCodeType

BatchDetectSyntaxRequestRequestTypeDef#

# BatchDetectSyntaxRequestRequestTypeDef definition

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

See SyntaxLanguageCodeType

BatchDetectTargetedSentimentRequestRequestTypeDef#

# BatchDetectTargetedSentimentRequestRequestTypeDef definition

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

See LanguageCodeType

ChildBlockTypeDef#

# ChildBlockTypeDef definition

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

RelationshipsListItemTypeDef#

# RelationshipsListItemTypeDef definition

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

See RelationshipTypeType

BoundingBoxTypeDef#

# BoundingBoxTypeDef definition

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

ClassifierEvaluationMetricsTypeDef#

# ClassifierEvaluationMetricsTypeDef definition

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

DocumentReaderConfigTypeDef#

# DocumentReaderConfigTypeDef definition

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

DocumentClassTypeDef#

# DocumentClassTypeDef definition

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

DocumentLabelTypeDef#

# DocumentLabelTypeDef definition

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

DocumentTypeListItemTypeDef#

# DocumentTypeListItemTypeDef definition

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

See DocumentTypeType

ErrorsListItemTypeDef#

# ErrorsListItemTypeDef definition

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

See PageBasedErrorCodeType

WarningsListItemTypeDef#

# WarningsListItemTypeDef definition

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

See PageBasedWarningCodeType

ContainsPiiEntitiesRequestRequestTypeDef#

# ContainsPiiEntitiesRequestRequestTypeDef definition

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

See LanguageCodeType

EntityLabelTypeDef#

# EntityLabelTypeDef definition

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

See PiiEntityTypeType

TagTypeDef#

# TagTypeDef definition

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

DocumentClassifierOutputDataConfigTypeDef#

# DocumentClassifierOutputDataConfigTypeDef definition

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

VpcConfigTypeDef#

# VpcConfigTypeDef definition

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

VpcConfigOutputTypeDef#

# VpcConfigOutputTypeDef definition

class VpcConfigOutputTypeDef(TypedDict):
    SecurityGroupIds: list[str],
    Subnets: list[str],

DatasetAugmentedManifestsListItemTypeDef#

# DatasetAugmentedManifestsListItemTypeDef definition

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

See AugmentedManifestsDocumentTypeFormatType

DatasetDocumentClassifierInputDataConfigTypeDef#

# DatasetDocumentClassifierInputDataConfigTypeDef definition

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

DatasetEntityRecognizerAnnotationsTypeDef#

# DatasetEntityRecognizerAnnotationsTypeDef definition

class DatasetEntityRecognizerAnnotationsTypeDef(TypedDict):
    S3Uri: str,

DatasetEntityRecognizerDocumentsTypeDef#

# DatasetEntityRecognizerDocumentsTypeDef definition

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

See InputFormatType

DatasetEntityRecognizerEntityListTypeDef#

# DatasetEntityRecognizerEntityListTypeDef definition

class DatasetEntityRecognizerEntityListTypeDef(TypedDict):
    S3Uri: str,

DatasetPropertiesTypeDef#

# DatasetPropertiesTypeDef definition

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

See DatasetTypeType
See DatasetStatusType

DeleteDocumentClassifierRequestRequestTypeDef#

# DeleteDocumentClassifierRequestRequestTypeDef definition

class DeleteDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DeleteEndpointRequestRequestTypeDef#

# DeleteEndpointRequestRequestTypeDef definition

class DeleteEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

DeleteEntityRecognizerRequestRequestTypeDef#

# DeleteEntityRecognizerRequestRequestTypeDef definition

class DeleteEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DeleteFlywheelRequestRequestTypeDef#

# DeleteFlywheelRequestRequestTypeDef definition

class DeleteFlywheelRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

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

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    DatasetArn: str,

DescribeDocumentClassificationJobRequestRequestTypeDef#

# DescribeDocumentClassificationJobRequestRequestTypeDef definition

class DescribeDocumentClassificationJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeDocumentClassifierRequestRequestTypeDef#

# DescribeDocumentClassifierRequestRequestTypeDef definition

class DescribeDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

DescribeDominantLanguageDetectionJobRequestRequestTypeDef#

# DescribeDominantLanguageDetectionJobRequestRequestTypeDef definition

class DescribeDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEndpointRequestRequestTypeDef#

# DescribeEndpointRequestRequestTypeDef definition

class DescribeEndpointRequestRequestTypeDef(TypedDict):
    EndpointArn: str,

EndpointPropertiesTypeDef#

# EndpointPropertiesTypeDef definition

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

See EndpointStatusType

DescribeEntitiesDetectionJobRequestRequestTypeDef#

# DescribeEntitiesDetectionJobRequestRequestTypeDef definition

class DescribeEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeEntityRecognizerRequestRequestTypeDef#

# DescribeEntityRecognizerRequestRequestTypeDef definition

class DescribeEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

DescribeEventsDetectionJobRequestRequestTypeDef#

# DescribeEventsDetectionJobRequestRequestTypeDef definition

class DescribeEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeFlywheelIterationRequestRequestTypeDef#

# DescribeFlywheelIterationRequestRequestTypeDef definition

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

DescribeFlywheelRequestRequestTypeDef#

# DescribeFlywheelRequestRequestTypeDef definition

class DescribeFlywheelRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,

DescribeKeyPhrasesDetectionJobRequestRequestTypeDef#

# DescribeKeyPhrasesDetectionJobRequestRequestTypeDef definition

class DescribeKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePiiEntitiesDetectionJobRequestRequestTypeDef#

# DescribePiiEntitiesDetectionJobRequestRequestTypeDef definition

class DescribePiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeResourcePolicyRequestRequestTypeDef#

# DescribeResourcePolicyRequestRequestTypeDef definition

class DescribeResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DescribeSentimentDetectionJobRequestRequestTypeDef#

# DescribeSentimentDetectionJobRequestRequestTypeDef definition

class DescribeSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTargetedSentimentDetectionJobRequestRequestTypeDef#

# DescribeTargetedSentimentDetectionJobRequestRequestTypeDef definition

class DescribeTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeTopicsDetectionJobRequestRequestTypeDef#

# DescribeTopicsDetectionJobRequestRequestTypeDef definition

class DescribeTopicsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DetectDominantLanguageRequestRequestTypeDef#

# DetectDominantLanguageRequestRequestTypeDef definition

class DetectDominantLanguageRequestRequestTypeDef(TypedDict):
    Text: str,

DetectKeyPhrasesRequestRequestTypeDef#

# DetectKeyPhrasesRequestRequestTypeDef definition

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

See LanguageCodeType

DetectPiiEntitiesRequestRequestTypeDef#

# DetectPiiEntitiesRequestRequestTypeDef definition

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

See LanguageCodeType

PiiEntityTypeDef#

# PiiEntityTypeDef definition

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

See PiiEntityTypeType

DetectSentimentRequestRequestTypeDef#

# DetectSentimentRequestRequestTypeDef definition

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

See LanguageCodeType

DetectSyntaxRequestRequestTypeDef#

# DetectSyntaxRequestRequestTypeDef definition

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

See SyntaxLanguageCodeType

DetectTargetedSentimentRequestRequestTypeDef#

# DetectTargetedSentimentRequestRequestTypeDef definition

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

See LanguageCodeType

TextSegmentTypeDef#

# TextSegmentTypeDef definition

class TextSegmentTypeDef(TypedDict):
    Text: str,

DocumentClassificationConfigOutputTypeDef#

# DocumentClassificationConfigOutputTypeDef definition

class DocumentClassificationConfigOutputTypeDef(TypedDict):
    Mode: DocumentClassifierModeType,  # (1)
    Labels: NotRequired[list[str]],

See DocumentClassifierModeType

DocumentClassificationConfigTypeDef#

# DocumentClassificationConfigTypeDef definition

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

See DocumentClassifierModeType

OutputDataConfigTypeDef#

# OutputDataConfigTypeDef definition

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

DocumentClassifierDocumentsTypeDef#

# DocumentClassifierDocumentsTypeDef definition

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

DocumentReaderConfigOutputTypeDef#

# DocumentReaderConfigOutputTypeDef definition

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

DocumentClassifierSummaryTypeDef#

# DocumentClassifierSummaryTypeDef definition

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

See ModelStatusType

ExtractedCharactersListItemTypeDef#

# ExtractedCharactersListItemTypeDef definition

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

EntityTypesListItemTypeDef#

# EntityTypesListItemTypeDef definition

class EntityTypesListItemTypeDef(TypedDict):
    Type: str,

EntityRecognizerAnnotationsTypeDef#

# EntityRecognizerAnnotationsTypeDef definition

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

EntityRecognizerDocumentsTypeDef#

# EntityRecognizerDocumentsTypeDef definition

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

See InputFormatType

EntityRecognizerEntityListTypeDef#

# EntityRecognizerEntityListTypeDef definition

class EntityRecognizerEntityListTypeDef(TypedDict):
    S3Uri: str,

EntityRecognizerEvaluationMetricsTypeDef#

# EntityRecognizerEvaluationMetricsTypeDef definition

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

EntityTypesEvaluationMetricsTypeDef#

# EntityTypesEvaluationMetricsTypeDef definition

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

EntityRecognizerOutputDataConfigTypeDef#

# EntityRecognizerOutputDataConfigTypeDef definition

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

EntityRecognizerSummaryTypeDef#

# EntityRecognizerSummaryTypeDef definition

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

See ModelStatusType

FlywheelModelEvaluationMetricsTypeDef#

# FlywheelModelEvaluationMetricsTypeDef definition

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

FlywheelSummaryTypeDef#

# FlywheelSummaryTypeDef definition

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

See FlywheelStatusType
See ModelTypeType

PointTypeDef#

# PointTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListDocumentClassifierSummariesRequestRequestTypeDef#

# ListDocumentClassifierSummariesRequestRequestTypeDef definition

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

ListEntityRecognizerSummariesRequestRequestTypeDef#

# ListEntityRecognizerSummariesRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

PartOfSpeechTagTypeDef#

# PartOfSpeechTagTypeDef definition

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

See PartOfSpeechTagTypeType

PiiOutputDataConfigTypeDef#

# PiiOutputDataConfigTypeDef definition

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

RedactionConfigOutputTypeDef#

# RedactionConfigOutputTypeDef definition

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

See PiiEntityTypeType
See PiiEntitiesDetectionMaskModeType

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef definition

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

RedactionConfigTypeDef#

# RedactionConfigTypeDef definition

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

See PiiEntityTypeType
See PiiEntitiesDetectionMaskModeType

StartFlywheelIterationRequestRequestTypeDef#

# StartFlywheelIterationRequestRequestTypeDef definition

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

StopDominantLanguageDetectionJobRequestRequestTypeDef#

# StopDominantLanguageDetectionJobRequestRequestTypeDef definition

class StopDominantLanguageDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEntitiesDetectionJobRequestRequestTypeDef#

# StopEntitiesDetectionJobRequestRequestTypeDef definition

class StopEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopEventsDetectionJobRequestRequestTypeDef#

# StopEventsDetectionJobRequestRequestTypeDef definition

class StopEventsDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopKeyPhrasesDetectionJobRequestRequestTypeDef#

# StopKeyPhrasesDetectionJobRequestRequestTypeDef definition

class StopKeyPhrasesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopPiiEntitiesDetectionJobRequestRequestTypeDef#

# StopPiiEntitiesDetectionJobRequestRequestTypeDef definition

class StopPiiEntitiesDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopSentimentDetectionJobRequestRequestTypeDef#

# StopSentimentDetectionJobRequestRequestTypeDef definition

class StopSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTargetedSentimentDetectionJobRequestRequestTypeDef#

# StopTargetedSentimentDetectionJobRequestRequestTypeDef definition

class StopTargetedSentimentDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopTrainingDocumentClassifierRequestRequestTypeDef#

# StopTrainingDocumentClassifierRequestRequestTypeDef definition

class StopTrainingDocumentClassifierRequestRequestTypeDef(TypedDict):
    DocumentClassifierArn: str,

StopTrainingEntityRecognizerRequestRequestTypeDef#

# StopTrainingEntityRecognizerRequestRequestTypeDef definition

class StopTrainingEntityRecognizerRequestRequestTypeDef(TypedDict):
    EntityRecognizerArn: str,

ToxicContentTypeDef#

# ToxicContentTypeDef definition

class ToxicContentTypeDef(TypedDict):
    Name: NotRequired[ToxicContentTypeType],  # (1)
    Score: NotRequired[float],

See ToxicContentTypeType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateEndpointRequestRequestTypeDef#

# UpdateEndpointRequestRequestTypeDef definition

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

BatchDetectDominantLanguageItemResultTypeDef#

# BatchDetectDominantLanguageItemResultTypeDef definition

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

See DominantLanguageTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateDocumentClassifierResponseTypeDef#

# CreateDocumentClassifierResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateEndpointResponseTypeDef#

# CreateEndpointResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateEntityRecognizerResponseTypeDef#

# CreateEntityRecognizerResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateFlywheelResponseTypeDef#

# CreateFlywheelResponseTypeDef definition

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

See ResponseMetadataTypeDef

DescribeResourcePolicyResponseTypeDef#

# DescribeResourcePolicyResponseTypeDef definition

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

See ResponseMetadataTypeDef

DetectDominantLanguageResponseTypeDef#

# DetectDominantLanguageResponseTypeDef definition

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

See DominantLanguageTypeDef
See ResponseMetadataTypeDef

ImportModelResponseTypeDef#

# ImportModelResponseTypeDef definition

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

See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef definition

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

See ResponseMetadataTypeDef

StartDocumentClassificationJobResponseTypeDef#

# StartDocumentClassificationJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartDominantLanguageDetectionJobResponseTypeDef#

# StartDominantLanguageDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartEntitiesDetectionJobResponseTypeDef#

# StartEntitiesDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartEventsDetectionJobResponseTypeDef#

# StartEventsDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartFlywheelIterationResponseTypeDef#

# StartFlywheelIterationResponseTypeDef definition

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

See ResponseMetadataTypeDef

StartKeyPhrasesDetectionJobResponseTypeDef#

# StartKeyPhrasesDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartPiiEntitiesDetectionJobResponseTypeDef#

# StartPiiEntitiesDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartSentimentDetectionJobResponseTypeDef#

# StartSentimentDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartTargetedSentimentDetectionJobResponseTypeDef#

# StartTargetedSentimentDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StartTopicsDetectionJobResponseTypeDef#

# StartTopicsDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopDominantLanguageDetectionJobResponseTypeDef#

# StopDominantLanguageDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopEntitiesDetectionJobResponseTypeDef#

# StopEntitiesDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopEventsDetectionJobResponseTypeDef#

# StopEventsDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopKeyPhrasesDetectionJobResponseTypeDef#

# StopKeyPhrasesDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopPiiEntitiesDetectionJobResponseTypeDef#

# StopPiiEntitiesDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopSentimentDetectionJobResponseTypeDef#

# StopSentimentDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

StopTargetedSentimentDetectionJobResponseTypeDef#

# StopTargetedSentimentDetectionJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

UpdateEndpointResponseTypeDef#

# UpdateEndpointResponseTypeDef definition

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

See ResponseMetadataTypeDef

BatchDetectKeyPhrasesItemResultTypeDef#

# BatchDetectKeyPhrasesItemResultTypeDef definition

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

See KeyPhraseTypeDef

DetectKeyPhrasesResponseTypeDef#

# DetectKeyPhrasesResponseTypeDef definition

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

See KeyPhraseTypeDef
See ResponseMetadataTypeDef

BatchDetectSentimentItemResultTypeDef#

# BatchDetectSentimentItemResultTypeDef definition

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

See SentimentTypeType
See SentimentScoreTypeDef

DetectSentimentResponseTypeDef#

# DetectSentimentResponseTypeDef definition

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

MentionSentimentTypeDef#

# MentionSentimentTypeDef definition

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

See SentimentTypeType
See SentimentScoreTypeDef

BlockReferenceTypeDef#

# BlockReferenceTypeDef definition

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

See ChildBlockTypeDef

ClassifierMetadataTypeDef#

# ClassifierMetadataTypeDef definition

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

See ClassifierEvaluationMetricsTypeDef

ClassifyDocumentRequestRequestTypeDef#

# ClassifyDocumentRequestRequestTypeDef definition

class ClassifyDocumentRequestRequestTypeDef(TypedDict):
    EndpointArn: str,
    Text: NotRequired[str],
    Bytes: NotRequired[BlobTypeDef],
    DocumentReaderConfig: NotRequired[DocumentReaderConfigTypeDef],  # (1)

See DocumentReaderConfigTypeDef

DetectEntitiesRequestRequestTypeDef#

# DetectEntitiesRequestRequestTypeDef definition

class DetectEntitiesRequestRequestTypeDef(TypedDict):
    Text: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    EndpointArn: NotRequired[str],
    Bytes: NotRequired[BlobTypeDef],
    DocumentReaderConfig: NotRequired[DocumentReaderConfigTypeDef],  # (2)

See LanguageCodeType
See DocumentReaderConfigTypeDef

ContainsPiiEntitiesResponseTypeDef#

# ContainsPiiEntitiesResponseTypeDef definition

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

See EntityLabelTypeDef
See ResponseMetadataTypeDef

CreateEndpointRequestRequestTypeDef#

# CreateEndpointRequestRequestTypeDef definition

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

See TagTypeDef

ImportModelRequestRequestTypeDef#

# ImportModelRequestRequestTypeDef definition

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

See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

See TagTypeDef
See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

See TagTypeDef

DataSecurityConfigOutputTypeDef#

# DataSecurityConfigOutputTypeDef definition

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

See VpcConfigOutputTypeDef

DatasetEntityRecognizerInputDataConfigTypeDef#

# DatasetEntityRecognizerInputDataConfigTypeDef definition

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

DatasetFilterTypeDef#

# DatasetFilterTypeDef definition

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

See DatasetStatusType
See DatasetTypeType

DocumentClassificationJobFilterTypeDef#

# DocumentClassificationJobFilterTypeDef definition

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

See JobStatusType

DocumentClassifierFilterTypeDef#

# DocumentClassifierFilterTypeDef definition

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

See ModelStatusType

DominantLanguageDetectionJobFilterTypeDef#

# DominantLanguageDetectionJobFilterTypeDef definition

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

See JobStatusType

EndpointFilterTypeDef#

# EndpointFilterTypeDef definition

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

See EndpointStatusType

EntitiesDetectionJobFilterTypeDef#

# EntitiesDetectionJobFilterTypeDef definition

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

See JobStatusType

EntityRecognizerFilterTypeDef#

# EntityRecognizerFilterTypeDef definition

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

See ModelStatusType

EventsDetectionJobFilterTypeDef#

# EventsDetectionJobFilterTypeDef definition

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

See JobStatusType

FlywheelFilterTypeDef#

# FlywheelFilterTypeDef definition

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

See FlywheelStatusType

FlywheelIterationFilterTypeDef#

# FlywheelIterationFilterTypeDef definition

class FlywheelIterationFilterTypeDef(TypedDict):
    CreationTimeAfter: NotRequired[TimestampTypeDef],
    CreationTimeBefore: NotRequired[TimestampTypeDef],

KeyPhrasesDetectionJobFilterTypeDef#

# KeyPhrasesDetectionJobFilterTypeDef definition

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

See JobStatusType

PiiEntitiesDetectionJobFilterTypeDef#

# PiiEntitiesDetectionJobFilterTypeDef definition

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

See JobStatusType

SentimentDetectionJobFilterTypeDef#

# SentimentDetectionJobFilterTypeDef definition

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

See JobStatusType

TargetedSentimentDetectionJobFilterTypeDef#

# TargetedSentimentDetectionJobFilterTypeDef definition

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

See JobStatusType

TopicsDetectionJobFilterTypeDef#

# TopicsDetectionJobFilterTypeDef definition

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

See JobStatusType

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

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

See DatasetPropertiesTypeDef
See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef definition

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

See DatasetPropertiesTypeDef
See ResponseMetadataTypeDef

DescribeEndpointResponseTypeDef#

# DescribeEndpointResponseTypeDef definition

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

See EndpointPropertiesTypeDef
See ResponseMetadataTypeDef

ListEndpointsResponseTypeDef#

# ListEndpointsResponseTypeDef definition

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

See EndpointPropertiesTypeDef
See ResponseMetadataTypeDef

DetectPiiEntitiesResponseTypeDef#

# DetectPiiEntitiesResponseTypeDef definition

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

See PiiEntityTypeDef
See ResponseMetadataTypeDef

DetectToxicContentRequestRequestTypeDef#

# DetectToxicContentRequestRequestTypeDef definition

class DetectToxicContentRequestRequestTypeDef(TypedDict):
    TextSegments: Sequence[TextSegmentTypeDef],  # (1)
    LanguageCode: LanguageCodeType,  # (2)

See TextSegmentTypeDef
See LanguageCodeType

DocumentClassifierInputDataConfigOutputTypeDef#

# DocumentClassifierInputDataConfigOutputTypeDef definition

class DocumentClassifierInputDataConfigOutputTypeDef(TypedDict):
    DataFormat: NotRequired[DocumentClassifierDataFormatType],  # (1)
    S3Uri: NotRequired[str],
    TestS3Uri: NotRequired[str],
    LabelDelimiter: NotRequired[str],
    AugmentedManifests: NotRequired[list[AugmentedManifestsListItemOutputTypeDef]],  # (2)
    DocumentType: NotRequired[DocumentClassifierDocumentTypeFormatType],  # (3)
    Documents: NotRequired[DocumentClassifierDocumentsTypeDef],  # (4)
    DocumentReaderConfig: NotRequired[DocumentReaderConfigOutputTypeDef],  # (5)

InputDataConfigOutputTypeDef#

# InputDataConfigOutputTypeDef definition

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

See InputFormatType
See DocumentReaderConfigOutputTypeDef

ListDocumentClassifierSummariesResponseTypeDef#

# ListDocumentClassifierSummariesResponseTypeDef definition

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

See DocumentClassifierSummaryTypeDef
See ResponseMetadataTypeDef

DocumentMetadataTypeDef#

# DocumentMetadataTypeDef definition

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

See ExtractedCharactersListItemTypeDef

EntityRecognitionConfigOutputTypeDef#

# EntityRecognitionConfigOutputTypeDef definition

class EntityRecognitionConfigOutputTypeDef(TypedDict):
    EntityTypes: list[EntityTypesListItemTypeDef],  # (1)

See EntityTypesListItemTypeDef

EntityRecognitionConfigTypeDef#

# EntityRecognitionConfigTypeDef definition

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

See EntityTypesListItemTypeDef

EntityRecognizerInputDataConfigOutputTypeDef#

# EntityRecognizerInputDataConfigOutputTypeDef definition

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

EntityRecognizerMetadataEntityTypesListItemTypeDef#

# EntityRecognizerMetadataEntityTypesListItemTypeDef definition

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

See EntityTypesEvaluationMetricsTypeDef

ListEntityRecognizerSummariesResponseTypeDef#

# ListEntityRecognizerSummariesResponseTypeDef definition

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

See EntityRecognizerSummaryTypeDef
See ResponseMetadataTypeDef

FlywheelIterationPropertiesTypeDef#

# FlywheelIterationPropertiesTypeDef definition

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

ListFlywheelsResponseTypeDef#

# ListFlywheelsResponseTypeDef definition

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

See FlywheelSummaryTypeDef
See ResponseMetadataTypeDef

GeometryTypeDef#

# GeometryTypeDef definition

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

See BoundingBoxTypeDef
See PointTypeDef

SyntaxTokenTypeDef#

# SyntaxTokenTypeDef definition

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

See PartOfSpeechTagTypeDef

ToxicLabelsTypeDef#

# ToxicLabelsTypeDef definition

class ToxicLabelsTypeDef(TypedDict):
    Labels: NotRequired[list[ToxicContentTypeDef]],  # (1)
    Toxicity: NotRequired[float],

See ToxicContentTypeDef

EntityRecognizerInputDataConfigTypeDef#

# EntityRecognizerInputDataConfigTypeDef definition

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

BatchDetectDominantLanguageResponseTypeDef#

# BatchDetectDominantLanguageResponseTypeDef definition

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

See BatchDetectDominantLanguageItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

BatchDetectKeyPhrasesResponseTypeDef#

# BatchDetectKeyPhrasesResponseTypeDef definition

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

See BatchDetectKeyPhrasesItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

BatchDetectSentimentResponseTypeDef#

# BatchDetectSentimentResponseTypeDef definition

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

See BatchDetectSentimentItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

TargetedSentimentMentionTypeDef#

# TargetedSentimentMentionTypeDef definition

class TargetedSentimentMentionTypeDef(TypedDict):
    Score: NotRequired[float],
    GroupScore: NotRequired[float],
    Text: NotRequired[str],
    Type: NotRequired[TargetedSentimentEntityTypeType],  # (1)
    MentionSentiment: NotRequired[MentionSentimentTypeDef],  # (2)
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

See TargetedSentimentEntityTypeType
See MentionSentimentTypeDef

EntityTypeDef#

# EntityTypeDef definition

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

See EntityTypeType
See BlockReferenceTypeDef

DataSecurityConfigTypeDef#

# DataSecurityConfigTypeDef definition

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

See VpcConfigTypeDef VpcConfigOutputTypeDef

UpdateDataSecurityConfigTypeDef#

# UpdateDataSecurityConfigTypeDef definition

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

See VpcConfigTypeDef VpcConfigOutputTypeDef

DatasetInputDataConfigTypeDef#

# DatasetInputDataConfigTypeDef definition

class DatasetInputDataConfigTypeDef(TypedDict):
    AugmentedManifests: NotRequired[Sequence[DatasetAugmentedManifestsListItemTypeDef]],  # (1)
    DataFormat: NotRequired[DatasetDataFormatType],  # (2)
    DocumentClassifierInputDataConfig: NotRequired[DatasetDocumentClassifierInputDataConfigTypeDef],  # (3)
    EntityRecognizerInputDataConfig: NotRequired[DatasetEntityRecognizerInputDataConfigTypeDef],  # (4)

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef definition

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

See DatasetFilterTypeDef

ListDocumentClassificationJobsRequestPaginateTypeDef#

# ListDocumentClassificationJobsRequestPaginateTypeDef definition

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

ListDocumentClassificationJobsRequestRequestTypeDef#

# ListDocumentClassificationJobsRequestRequestTypeDef definition

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

See DocumentClassificationJobFilterTypeDef

ListDocumentClassifiersRequestPaginateTypeDef#

# ListDocumentClassifiersRequestPaginateTypeDef definition

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

See DocumentClassifierFilterTypeDef
See PaginatorConfigTypeDef

ListDocumentClassifiersRequestRequestTypeDef#

# ListDocumentClassifiersRequestRequestTypeDef definition

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

See DocumentClassifierFilterTypeDef

ListDominantLanguageDetectionJobsRequestPaginateTypeDef#

# ListDominantLanguageDetectionJobsRequestPaginateTypeDef definition

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

ListDominantLanguageDetectionJobsRequestRequestTypeDef#

# ListDominantLanguageDetectionJobsRequestRequestTypeDef definition

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

See DominantLanguageDetectionJobFilterTypeDef

ListEndpointsRequestPaginateTypeDef#

# ListEndpointsRequestPaginateTypeDef definition

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

See EndpointFilterTypeDef
See PaginatorConfigTypeDef

ListEndpointsRequestRequestTypeDef#

# ListEndpointsRequestRequestTypeDef definition

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

See EndpointFilterTypeDef

ListEntitiesDetectionJobsRequestPaginateTypeDef#

# ListEntitiesDetectionJobsRequestPaginateTypeDef definition

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

See EntitiesDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListEntitiesDetectionJobsRequestRequestTypeDef#

# ListEntitiesDetectionJobsRequestRequestTypeDef definition

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

See EntitiesDetectionJobFilterTypeDef

ListEntityRecognizersRequestPaginateTypeDef#

# ListEntityRecognizersRequestPaginateTypeDef definition

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

See EntityRecognizerFilterTypeDef
See PaginatorConfigTypeDef

ListEntityRecognizersRequestRequestTypeDef#

# ListEntityRecognizersRequestRequestTypeDef definition

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

See EntityRecognizerFilterTypeDef

ListEventsDetectionJobsRequestRequestTypeDef#

# ListEventsDetectionJobsRequestRequestTypeDef definition

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

See EventsDetectionJobFilterTypeDef

ListFlywheelsRequestRequestTypeDef#

# ListFlywheelsRequestRequestTypeDef definition

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

See FlywheelFilterTypeDef

ListFlywheelIterationHistoryRequestRequestTypeDef#

# ListFlywheelIterationHistoryRequestRequestTypeDef definition

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

See FlywheelIterationFilterTypeDef

ListKeyPhrasesDetectionJobsRequestPaginateTypeDef#

# ListKeyPhrasesDetectionJobsRequestPaginateTypeDef definition

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

ListKeyPhrasesDetectionJobsRequestRequestTypeDef#

# ListKeyPhrasesDetectionJobsRequestRequestTypeDef definition

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

See KeyPhrasesDetectionJobFilterTypeDef

ListPiiEntitiesDetectionJobsRequestPaginateTypeDef#

# ListPiiEntitiesDetectionJobsRequestPaginateTypeDef definition

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

ListPiiEntitiesDetectionJobsRequestRequestTypeDef#

# ListPiiEntitiesDetectionJobsRequestRequestTypeDef definition

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

See PiiEntitiesDetectionJobFilterTypeDef

ListSentimentDetectionJobsRequestPaginateTypeDef#

# ListSentimentDetectionJobsRequestPaginateTypeDef definition

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

See SentimentDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListSentimentDetectionJobsRequestRequestTypeDef#

# ListSentimentDetectionJobsRequestRequestTypeDef definition

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

See SentimentDetectionJobFilterTypeDef

ListTargetedSentimentDetectionJobsRequestRequestTypeDef#

# ListTargetedSentimentDetectionJobsRequestRequestTypeDef definition

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

See TargetedSentimentDetectionJobFilterTypeDef

ListTopicsDetectionJobsRequestPaginateTypeDef#

# ListTopicsDetectionJobsRequestPaginateTypeDef definition

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

See TopicsDetectionJobFilterTypeDef
See PaginatorConfigTypeDef

ListTopicsDetectionJobsRequestRequestTypeDef#

# ListTopicsDetectionJobsRequestRequestTypeDef definition

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

See TopicsDetectionJobFilterTypeDef

DocumentClassifierPropertiesTypeDef#

# DocumentClassifierPropertiesTypeDef 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[DocumentClassifierInputDataConfigOutputTypeDef],  # (3)
    OutputDataConfig: NotRequired[DocumentClassifierOutputDataConfigTypeDef],  # (4)
    ClassifierMetadata: NotRequired[ClassifierMetadataTypeDef],  # (5)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (6)
    Mode: NotRequired[DocumentClassifierModeType],  # (7)
    ModelKmsKeyId: NotRequired[str],
    VersionName: NotRequired[str],
    SourceModelArn: NotRequired[str],
    FlywheelArn: NotRequired[str],

See LanguageCodeType
See ModelStatusType
See DocumentClassifierInputDataConfigOutputTypeDef
See DocumentClassifierOutputDataConfigTypeDef
See ClassifierMetadataTypeDef
See VpcConfigOutputTypeDef
See DocumentClassifierModeType

DocumentClassifierInputDataConfigTypeDef#

# DocumentClassifierInputDataConfigTypeDef definition

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

InputDataConfigTypeDef#

# InputDataConfigTypeDef definition

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

DocumentClassificationJobPropertiesTypeDef#

# DocumentClassificationJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (4)
    FlywheelArn: NotRequired[str],

DominantLanguageDetectionJobPropertiesTypeDef#

# DominantLanguageDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (4)

EntitiesDetectionJobPropertiesTypeDef#

# EntitiesDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (5)
    FlywheelArn: NotRequired[str],

EventsDetectionJobPropertiesTypeDef#

# EventsDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    TargetEventTypes: NotRequired[list[str]],

KeyPhrasesDetectionJobPropertiesTypeDef#

# KeyPhrasesDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (5)

PiiEntitiesDetectionJobPropertiesTypeDef#

# PiiEntitiesDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[PiiOutputDataConfigTypeDef],  # (3)
    RedactionConfig: NotRequired[RedactionConfigOutputTypeDef],  # (4)
    LanguageCode: NotRequired[LanguageCodeType],  # (5)
    DataAccessRoleArn: NotRequired[str],
    Mode: NotRequired[PiiEntitiesDetectionModeType],  # (6)

SentimentDetectionJobPropertiesTypeDef#

# SentimentDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (5)

TargetedSentimentDetectionJobPropertiesTypeDef#

# TargetedSentimentDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (5)

TopicsDetectionJobPropertiesTypeDef#

# TopicsDetectionJobPropertiesTypeDef 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[InputDataConfigOutputTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    NumberOfTopics: NotRequired[int],
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (4)

ClassifyDocumentResponseTypeDef#

# ClassifyDocumentResponseTypeDef definition

class ClassifyDocumentResponseTypeDef(TypedDict):
    Classes: list[DocumentClassTypeDef],  # (1)
    Labels: list[DocumentLabelTypeDef],  # (2)
    DocumentMetadata: DocumentMetadataTypeDef,  # (3)
    DocumentType: list[DocumentTypeListItemTypeDef],  # (4)
    Errors: list[ErrorsListItemTypeDef],  # (5)
    Warnings: list[WarningsListItemTypeDef],  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

TaskConfigOutputTypeDef#

# TaskConfigOutputTypeDef definition

class TaskConfigOutputTypeDef(TypedDict):
    LanguageCode: LanguageCodeType,  # (1)
    DocumentClassificationConfig: NotRequired[DocumentClassificationConfigOutputTypeDef],  # (2)
    EntityRecognitionConfig: NotRequired[EntityRecognitionConfigOutputTypeDef],  # (3)

EntityRecognizerMetadataTypeDef#

# EntityRecognizerMetadataTypeDef definition

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

DescribeFlywheelIterationResponseTypeDef#

# DescribeFlywheelIterationResponseTypeDef definition

class DescribeFlywheelIterationResponseTypeDef(TypedDict):
    FlywheelIterationProperties: FlywheelIterationPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

ListFlywheelIterationHistoryResponseTypeDef#

# ListFlywheelIterationHistoryResponseTypeDef definition

class ListFlywheelIterationHistoryResponseTypeDef(TypedDict):
    FlywheelIterationPropertiesList: list[FlywheelIterationPropertiesTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

BlockTypeDef#

# BlockTypeDef definition

class BlockTypeDef(TypedDict):
    Id: NotRequired[str],
    BlockType: NotRequired[BlockTypeType],  # (1)
    Text: NotRequired[str],
    Page: NotRequired[int],
    Geometry: NotRequired[GeometryTypeDef],  # (2)
    Relationships: NotRequired[list[RelationshipsListItemTypeDef]],  # (3)

BatchDetectSyntaxItemResultTypeDef#

# BatchDetectSyntaxItemResultTypeDef definition

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

See SyntaxTokenTypeDef

DetectSyntaxResponseTypeDef#

# DetectSyntaxResponseTypeDef definition

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

See SyntaxTokenTypeDef
See ResponseMetadataTypeDef

DetectToxicContentResponseTypeDef#

# DetectToxicContentResponseTypeDef definition

class DetectToxicContentResponseTypeDef(TypedDict):
    ResultList: list[ToxicLabelsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ToxicLabelsTypeDef
See ResponseMetadataTypeDef

CreateEntityRecognizerRequestRequestTypeDef#

# CreateEntityRecognizerRequestRequestTypeDef 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

TargetedSentimentEntityTypeDef#

# TargetedSentimentEntityTypeDef definition

class TargetedSentimentEntityTypeDef(TypedDict):
    DescriptiveMentionIndex: NotRequired[list[int]],
    Mentions: NotRequired[list[TargetedSentimentMentionTypeDef]],  # (1)

See TargetedSentimentMentionTypeDef

BatchDetectEntitiesItemResultTypeDef#

# BatchDetectEntitiesItemResultTypeDef definition

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

See EntityTypeDef

UpdateFlywheelRequestRequestTypeDef#

# UpdateFlywheelRequestRequestTypeDef definition

class UpdateFlywheelRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,
    ActiveModelArn: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],
    DataSecurityConfig: NotRequired[UpdateDataSecurityConfigTypeDef],  # (1)

See UpdateDataSecurityConfigTypeDef

CreateDatasetRequestRequestTypeDef#

# CreateDatasetRequestRequestTypeDef definition

class CreateDatasetRequestRequestTypeDef(TypedDict):
    FlywheelArn: str,
    DatasetName: str,
    InputDataConfig: DatasetInputDataConfigTypeDef,  # (1)
    DatasetType: NotRequired[DatasetTypeType],  # (2)
    Description: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)

DescribeDocumentClassifierResponseTypeDef#

# DescribeDocumentClassifierResponseTypeDef definition

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

ListDocumentClassifiersResponseTypeDef#

# ListDocumentClassifiersResponseTypeDef definition

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

CreateDocumentClassifierRequestRequestTypeDef#

# CreateDocumentClassifierRequestRequestTypeDef 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

StartDocumentClassificationJobRequestRequestTypeDef#

# StartDocumentClassificationJobRequestRequestTypeDef definition

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

StartDominantLanguageDetectionJobRequestRequestTypeDef#

# StartDominantLanguageDetectionJobRequestRequestTypeDef 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#

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

StartEventsDetectionJobRequestRequestTypeDef#

# StartEventsDetectionJobRequestRequestTypeDef 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#

# StartKeyPhrasesDetectionJobRequestRequestTypeDef 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#

# StartPiiEntitiesDetectionJobRequestRequestTypeDef 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#

# StartSentimentDetectionJobRequestRequestTypeDef 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#

# StartTargetedSentimentDetectionJobRequestRequestTypeDef 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#

# StartTopicsDetectionJobRequestRequestTypeDef 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)

DescribeDocumentClassificationJobResponseTypeDef#

# DescribeDocumentClassificationJobResponseTypeDef definition

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

ListDocumentClassificationJobsResponseTypeDef#

# ListDocumentClassificationJobsResponseTypeDef definition

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

DescribeDominantLanguageDetectionJobResponseTypeDef#

# DescribeDominantLanguageDetectionJobResponseTypeDef definition

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

ListDominantLanguageDetectionJobsResponseTypeDef#

# ListDominantLanguageDetectionJobsResponseTypeDef definition

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

DescribeEntitiesDetectionJobResponseTypeDef#

# DescribeEntitiesDetectionJobResponseTypeDef definition

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

ListEntitiesDetectionJobsResponseTypeDef#

# ListEntitiesDetectionJobsResponseTypeDef definition

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

DescribeEventsDetectionJobResponseTypeDef#

# DescribeEventsDetectionJobResponseTypeDef definition

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

ListEventsDetectionJobsResponseTypeDef#

# ListEventsDetectionJobsResponseTypeDef definition

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

DescribeKeyPhrasesDetectionJobResponseTypeDef#

# DescribeKeyPhrasesDetectionJobResponseTypeDef definition

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

ListKeyPhrasesDetectionJobsResponseTypeDef#

# ListKeyPhrasesDetectionJobsResponseTypeDef definition

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

DescribePiiEntitiesDetectionJobResponseTypeDef#

# DescribePiiEntitiesDetectionJobResponseTypeDef definition

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

ListPiiEntitiesDetectionJobsResponseTypeDef#

# ListPiiEntitiesDetectionJobsResponseTypeDef definition

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

DescribeSentimentDetectionJobResponseTypeDef#

# DescribeSentimentDetectionJobResponseTypeDef definition

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

ListSentimentDetectionJobsResponseTypeDef#

# ListSentimentDetectionJobsResponseTypeDef definition

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

DescribeTargetedSentimentDetectionJobResponseTypeDef#

# DescribeTargetedSentimentDetectionJobResponseTypeDef definition

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

ListTargetedSentimentDetectionJobsResponseTypeDef#

# ListTargetedSentimentDetectionJobsResponseTypeDef definition

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

DescribeTopicsDetectionJobResponseTypeDef#

# DescribeTopicsDetectionJobResponseTypeDef definition

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

ListTopicsDetectionJobsResponseTypeDef#

# ListTopicsDetectionJobsResponseTypeDef definition

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

FlywheelPropertiesTypeDef#

# FlywheelPropertiesTypeDef definition

class FlywheelPropertiesTypeDef(TypedDict):
    FlywheelArn: NotRequired[str],
    ActiveModelArn: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],
    TaskConfig: NotRequired[TaskConfigOutputTypeDef],  # (1)
    DataLakeS3Uri: NotRequired[str],
    DataSecurityConfig: NotRequired[DataSecurityConfigOutputTypeDef],  # (2)
    Status: NotRequired[FlywheelStatusType],  # (3)
    ModelType: NotRequired[ModelTypeType],  # (4)
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    LatestFlywheelIteration: NotRequired[str],

TaskConfigTypeDef#

# TaskConfigTypeDef definition

class TaskConfigTypeDef(TypedDict):
    LanguageCode: LanguageCodeType,  # (1)
    DocumentClassificationConfig: NotRequired[DocumentClassificationConfigUnionTypeDef],  # (2)
    EntityRecognitionConfig: NotRequired[EntityRecognitionConfigUnionTypeDef],  # (3)

EntityRecognizerPropertiesTypeDef#

# EntityRecognizerPropertiesTypeDef 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[EntityRecognizerInputDataConfigOutputTypeDef],  # (3)
    RecognizerMetadata: NotRequired[EntityRecognizerMetadataTypeDef],  # (4)
    DataAccessRoleArn: NotRequired[str],
    VolumeKmsKeyId: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (5)
    ModelKmsKeyId: NotRequired[str],
    VersionName: NotRequired[str],
    SourceModelArn: NotRequired[str],
    FlywheelArn: NotRequired[str],
    OutputDataConfig: NotRequired[EntityRecognizerOutputDataConfigTypeDef],  # (6)

See LanguageCodeType
See ModelStatusType
See EntityRecognizerInputDataConfigOutputTypeDef
See EntityRecognizerMetadataTypeDef
See VpcConfigOutputTypeDef
See EntityRecognizerOutputDataConfigTypeDef

DetectEntitiesResponseTypeDef#

# DetectEntitiesResponseTypeDef definition

class DetectEntitiesResponseTypeDef(TypedDict):
    Entities: list[EntityTypeDef],  # (1)
    DocumentMetadata: DocumentMetadataTypeDef,  # (2)
    DocumentType: list[DocumentTypeListItemTypeDef],  # (3)
    Blocks: list[BlockTypeDef],  # (4)
    Errors: list[ErrorsListItemTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

BatchDetectSyntaxResponseTypeDef#

# BatchDetectSyntaxResponseTypeDef definition

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

BatchDetectTargetedSentimentItemResultTypeDef#

# BatchDetectTargetedSentimentItemResultTypeDef definition

class BatchDetectTargetedSentimentItemResultTypeDef(TypedDict):
    Index: NotRequired[int],
    Entities: NotRequired[list[TargetedSentimentEntityTypeDef]],  # (1)

See TargetedSentimentEntityTypeDef

DetectTargetedSentimentResponseTypeDef#

# DetectTargetedSentimentResponseTypeDef definition

class DetectTargetedSentimentResponseTypeDef(TypedDict):
    Entities: list[TargetedSentimentEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See TargetedSentimentEntityTypeDef
See ResponseMetadataTypeDef

BatchDetectEntitiesResponseTypeDef#

# BatchDetectEntitiesResponseTypeDef definition

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

See BatchDetectEntitiesItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef

DescribeFlywheelResponseTypeDef#

# DescribeFlywheelResponseTypeDef definition

class DescribeFlywheelResponseTypeDef(TypedDict):
    FlywheelProperties: FlywheelPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See FlywheelPropertiesTypeDef
See ResponseMetadataTypeDef

UpdateFlywheelResponseTypeDef#

# UpdateFlywheelResponseTypeDef definition

class UpdateFlywheelResponseTypeDef(TypedDict):
    FlywheelProperties: FlywheelPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See FlywheelPropertiesTypeDef
See ResponseMetadataTypeDef

CreateFlywheelRequestRequestTypeDef#

# CreateFlywheelRequestRequestTypeDef definition

class CreateFlywheelRequestRequestTypeDef(TypedDict):
    FlywheelName: str,
    DataAccessRoleArn: str,
    DataLakeS3Uri: str,
    ActiveModelArn: NotRequired[str],
    TaskConfig: NotRequired[TaskConfigTypeDef],  # (1)
    ModelType: NotRequired[ModelTypeType],  # (2)
    DataSecurityConfig: NotRequired[DataSecurityConfigTypeDef],  # (3)
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)

DescribeEntityRecognizerResponseTypeDef#

# DescribeEntityRecognizerResponseTypeDef definition

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

See EntityRecognizerPropertiesTypeDef
See ResponseMetadataTypeDef

ListEntityRecognizersResponseTypeDef#

# ListEntityRecognizersResponseTypeDef definition

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

See EntityRecognizerPropertiesTypeDef
See ResponseMetadataTypeDef

BatchDetectTargetedSentimentResponseTypeDef#

# BatchDetectTargetedSentimentResponseTypeDef definition

class BatchDetectTargetedSentimentResponseTypeDef(TypedDict):
    ResultList: list[BatchDetectTargetedSentimentItemResultTypeDef],  # (1)
    ErrorList: list[BatchItemErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

See BatchDetectTargetedSentimentItemResultTypeDef
See BatchItemErrorTypeDef
See ResponseMetadataTypeDef