Skip to content

Comprehend Classes

AugmentedManifestsListItemPaginatorTypeDef

S3Uri

  • Type:
  • Required: Yes

AttributeNames

  • Type: typing.List[str]
  • Required: Yes

Split

  • Type: typing.Optional[typing.Literal['TEST', 'TRAIN']]

AnnotationDataS3Uri

  • Type: typing.Optional[str]

SourceDocumentsS3Uri

  • Type: typing.Optional[str]

DocumentType

  • Type: typing.Optional[typing.Literal['PLAIN_TEXT_DOCUMENT', 'SEMI_STRUCTURED_DOCUMENT']]

AugmentedManifestsListItemTypeDef

S3Uri

  • Type:
  • Required: Yes

AttributeNames

  • Type: typing.Sequence[str]
  • Required: Yes

Split

  • Type: typing.Optional[typing.Literal['TEST', 'TRAIN']]

AnnotationDataS3Uri

  • Type: typing.Optional[str]

SourceDocumentsS3Uri

  • Type: typing.Optional[str]

DocumentType

  • Type: typing.Optional[typing.Literal['PLAIN_TEXT_DOCUMENT', 'SEMI_STRUCTURED_DOCUMENT']]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchDetectDominantLanguageItemResultTypeDef

Index

  • Type: typing.Optional[int]

Languages

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DominantLanguageTypeDef]]

BatchDetectDominantLanguageRequestRequestTypeDef

TextList

  • Type: typing.Sequence[str]
  • Required: Yes

BatchDetectDominantLanguageResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchDetectDominantLanguageItemResultTypeDef]
  • Required: Yes

ErrorList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchItemErrorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDetectEntitiesItemResultTypeDef

Index

  • Type: typing.Optional[int]

Entities

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityTypeDef]]

BatchDetectEntitiesRequestRequestTypeDef

TextList

  • Type: typing.Sequence[str]
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

BatchDetectEntitiesResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchDetectEntitiesItemResultTypeDef]
  • Required: Yes

ErrorList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchItemErrorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDetectKeyPhrasesItemResultTypeDef

Index

  • Type: typing.Optional[int]

KeyPhrases

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.KeyPhraseTypeDef]]

BatchDetectKeyPhrasesRequestRequestTypeDef

TextList

  • Type: typing.Sequence[str]
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

BatchDetectKeyPhrasesResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchDetectKeyPhrasesItemResultTypeDef]
  • Required: Yes

ErrorList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchItemErrorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDetectSentimentItemResultTypeDef

Index

  • Type: typing.Optional[int]

Sentiment

  • Type: typing.Optional[typing.Literal['MIXED', 'NEGATIVE', 'NEUTRAL', 'POSITIVE']]

SentimentScore

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.SentimentScoreTypeDef]

BatchDetectSentimentRequestRequestTypeDef

TextList

  • Type: typing.Sequence[str]
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

BatchDetectSentimentResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchDetectSentimentItemResultTypeDef]
  • Required: Yes

ErrorList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchItemErrorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDetectSyntaxItemResultTypeDef

Index

  • Type: typing.Optional[int]

SyntaxTokens

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.SyntaxTokenTypeDef]]

BatchDetectSyntaxRequestRequestTypeDef

TextList

  • Type: typing.Sequence[str]
  • Required: Yes

LanguageCode

  • Type: typing.Literal['de', 'en', 'es', 'fr', 'it', 'pt']
  • Required: Yes

BatchDetectSyntaxResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchDetectSyntaxItemResultTypeDef]
  • Required: Yes

ErrorList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchItemErrorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDetectTargetedSentimentItemResultTypeDef

Index

  • Type: typing.Optional[int]

Entities

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TargetedSentimentEntityTypeDef]]

BatchDetectTargetedSentimentRequestRequestTypeDef

TextList

  • Type: typing.Sequence[str]
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

BatchDetectTargetedSentimentResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchDetectTargetedSentimentItemResultTypeDef]
  • Required: Yes

ErrorList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BatchItemErrorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchItemErrorTypeDef

Index

  • Type: typing.Optional[int]

ErrorCode

  • Type: typing.Optional[str]

ErrorMessage

  • Type: typing.Optional[str]

BlockReferenceTypeDef

BlockId

  • Type: typing.Optional[str]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

ChildBlocks

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.ChildBlockTypeDef]]

BlockTypeDef

Id

  • Type: typing.Optional[str]

BlockType

  • Type: typing.Optional[typing.Literal['LINE', 'WORD']]

Text

  • Type: typing.Optional[str]

Page

  • Type: typing.Optional[int]

Geometry

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.GeometryTypeDef]

Relationships

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.RelationshipsListItemTypeDef]]

BoundingBoxTypeDef

Height

  • Type: typing.Optional[float]

Left

  • Type: typing.Optional[float]

Top

  • Type: typing.Optional[float]

Width

  • Type: typing.Optional[float]

ChildBlockTypeDef

ChildBlockId

  • Type: typing.Optional[str]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

ClassifierEvaluationMetricsTypeDef

Accuracy

  • Type: typing.Optional[float]

Precision

  • Type: typing.Optional[float]

Recall

  • Type: typing.Optional[float]

F1Score

  • Type: typing.Optional[float]

MicroPrecision

  • Type: typing.Optional[float]

MicroRecall

  • Type: typing.Optional[float]

MicroF1Score

  • Type: typing.Optional[float]

HammingLoss

  • Type: typing.Optional[float]

ClassifierMetadataTypeDef

NumberOfLabels

  • Type: typing.Optional[int]

NumberOfTrainedDocuments

  • Type: typing.Optional[int]

NumberOfTestDocuments

  • Type: typing.Optional[int]

EvaluationMetrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.ClassifierEvaluationMetricsTypeDef]

ClassifyDocumentRequestRequestTypeDef

EndpointArn

  • Type:
  • Required: Yes

Text

  • Type: typing.Optional[str]

Bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

DocumentReaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentReaderConfigTypeDef]

ClassifyDocumentResponseTypeDef

Classes

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassTypeDef]
  • Required: Yes

Labels

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentLabelTypeDef]
  • Required: Yes

DocumentMetadata

  • Type:
  • Required: Yes

DocumentType

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentTypeListItemTypeDef]
  • Required: Yes

Errors

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.ErrorsListItemTypeDef]
  • Required: Yes

Warnings

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.WarningsListItemTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ContainsPiiEntitiesRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

ContainsPiiEntitiesResponseTypeDef

Labels

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityLabelTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDatasetRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

DatasetName

  • Type:
  • Required: Yes

InputDataConfig

  • Type:
  • Required: Yes

DatasetType

  • Type: typing.Optional[typing.Literal['TEST', 'TRAIN']]

Description

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

CreateDatasetResponseTypeDef

DatasetArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDocumentClassifierRequestRequestTypeDef

DocumentClassifierName

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

InputDataConfig

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

VersionName

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierOutputDataConfigTypeDef]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Mode

  • Type: typing.Optional[typing.Literal['MULTI_CLASS', 'MULTI_LABEL']]

ModelKmsKeyId

  • Type: typing.Optional[str]

ModelPolicy

  • Type: typing.Optional[str]

CreateDocumentClassifierResponseTypeDef

DocumentClassifierArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateEndpointRequestRequestTypeDef

EndpointName

  • Type:
  • Required: Yes

DesiredInferenceUnits

  • Type:
  • Required: Yes

ModelArn

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

DataAccessRoleArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

CreateEndpointResponseTypeDef

EndpointArn

  • Type:
  • Required: Yes

ModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateEntityRecognizerRequestRequestTypeDef

RecognizerName

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

InputDataConfig

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

VersionName

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

ModelKmsKeyId

  • Type: typing.Optional[str]

ModelPolicy

  • Type: typing.Optional[str]

CreateEntityRecognizerResponseTypeDef

EntityRecognizerArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateFlywheelRequestRequestTypeDef

FlywheelName

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

DataLakeS3Uri

  • Type:
  • Required: Yes

ActiveModelArn

  • Type: typing.Optional[str]

TaskConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.TaskConfigTypeDef]

ModelType

  • Type: typing.Optional[typing.Literal['DOCUMENT_CLASSIFIER', 'ENTITY_RECOGNIZER']]

DataSecurityConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DataSecurityConfigTypeDef]

ClientRequestToken

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

CreateFlywheelResponseTypeDef

FlywheelArn

  • Type:
  • Required: Yes

ActiveModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DataSecurityConfigTypeDef

ModelKmsKeyId

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

DataLakeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

DatasetAugmentedManifestsListItemTypeDef

AttributeNames

  • Type: typing.Sequence[str]
  • Required: Yes

S3Uri

  • Type:
  • Required: Yes

AnnotationDataS3Uri

  • Type: typing.Optional[str]

SourceDocumentsS3Uri

  • Type: typing.Optional[str]

DocumentType

  • Type: typing.Optional[typing.Literal['PLAIN_TEXT_DOCUMENT', 'SEMI_STRUCTURED_DOCUMENT']]

DatasetDocumentClassifierInputDataConfigTypeDef

S3Uri

  • Type:
  • Required: Yes

LabelDelimiter

  • Type: typing.Optional[str]

DatasetEntityRecognizerAnnotationsTypeDef

S3Uri

  • Type:
  • Required: Yes

DatasetEntityRecognizerDocumentsTypeDef

S3Uri

  • Type:
  • Required: Yes

InputFormat

  • Type: typing.Optional[typing.Literal['ONE_DOC_PER_FILE', 'ONE_DOC_PER_LINE']]

DatasetEntityRecognizerEntityListTypeDef

S3Uri

  • Type:
  • Required: Yes

DatasetEntityRecognizerInputDataConfigTypeDef

Documents

  • Type:
  • Required: Yes

Annotations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DatasetEntityRecognizerAnnotationsTypeDef]

EntityList

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DatasetEntityRecognizerEntityListTypeDef]

DatasetFilterTypeDef

Status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'CREATING', 'FAILED']]

DatasetType

  • Type: typing.Optional[typing.Literal['TEST', 'TRAIN']]

CreationTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

CreationTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

DatasetInputDataConfigTypeDef

AugmentedManifests

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.DatasetAugmentedManifestsListItemTypeDef]]

DataFormat

  • Type: typing.Optional[typing.Literal['AUGMENTED_MANIFEST', 'COMPREHEND_CSV']]

DocumentClassifierInputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DatasetDocumentClassifierInputDataConfigTypeDef]

EntityRecognizerInputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DatasetEntityRecognizerInputDataConfigTypeDef]

DatasetPropertiesTypeDef

DatasetArn

  • Type: typing.Optional[str]

DatasetName

  • Type: typing.Optional[str]

DatasetType

  • Type: typing.Optional[typing.Literal['TEST', 'TRAIN']]

DatasetS3Uri

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'CREATING', 'FAILED']]

Message

  • Type: typing.Optional[str]

NumberOfDocuments

  • Type: typing.Optional[int]

CreationTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

DeleteDocumentClassifierRequestRequestTypeDef

DocumentClassifierArn

  • Type:
  • Required: Yes

DeleteEndpointRequestRequestTypeDef

EndpointArn

  • Type:
  • Required: Yes

DeleteEntityRecognizerRequestRequestTypeDef

EntityRecognizerArn

  • Type:
  • Required: Yes

DeleteFlywheelRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

DeleteResourcePolicyRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

PolicyRevisionId

  • Type: typing.Optional[str]

DescribeDatasetRequestRequestTypeDef

DatasetArn

  • Type:
  • Required: Yes

DescribeDatasetResponseTypeDef

DatasetProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDocumentClassificationJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeDocumentClassificationJobResponseTypeDef

DocumentClassificationJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDocumentClassifierRequestRequestTypeDef

DocumentClassifierArn

  • Type:
  • Required: Yes

DescribeDocumentClassifierResponseTypeDef

DocumentClassifierProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDominantLanguageDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeDominantLanguageDetectionJobResponseTypeDef

DominantLanguageDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeEndpointRequestRequestTypeDef

EndpointArn

  • Type:
  • Required: Yes

DescribeEndpointResponseTypeDef

EndpointProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeEntitiesDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeEntitiesDetectionJobResponseTypeDef

EntitiesDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeEntityRecognizerRequestRequestTypeDef

EntityRecognizerArn

  • Type:
  • Required: Yes

DescribeEntityRecognizerResponseTypeDef

EntityRecognizerProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeEventsDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeEventsDetectionJobResponseTypeDef

EventsDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeFlywheelIterationRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

FlywheelIterationId

  • Type:
  • Required: Yes

DescribeFlywheelIterationResponseTypeDef

FlywheelIterationProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeFlywheelRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

DescribeFlywheelResponseTypeDef

FlywheelProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeKeyPhrasesDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeKeyPhrasesDetectionJobResponseTypeDef

KeyPhrasesDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribePiiEntitiesDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribePiiEntitiesDetectionJobResponseTypeDef

PiiEntitiesDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeResourcePolicyRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

DescribeResourcePolicyResponseTypeDef

ResourcePolicy

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

LastModifiedTime

  • Type:
  • Required: Yes

PolicyRevisionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeSentimentDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeSentimentDetectionJobResponseTypeDef

SentimentDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeTargetedSentimentDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeTargetedSentimentDetectionJobResponseTypeDef

TargetedSentimentDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeTopicsDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

DescribeTopicsDetectionJobResponseTypeDef

TopicsDetectionJobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectDominantLanguageRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

DetectDominantLanguageResponseTypeDef

Languages

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DominantLanguageTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectEntitiesRequestRequestTypeDef

Text

  • Type: typing.Optional[str]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

EndpointArn

  • Type: typing.Optional[str]

Bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

DocumentReaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentReaderConfigTypeDef]

DetectEntitiesResponseTypeDef

Entities

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityTypeDef]
  • Required: Yes

DocumentMetadata

  • Type:
  • Required: Yes

DocumentType

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentTypeListItemTypeDef]
  • Required: Yes

Blocks

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BlockTypeDef]
  • Required: Yes

Errors

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.ErrorsListItemTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectKeyPhrasesRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

DetectKeyPhrasesResponseTypeDef

KeyPhrases

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.KeyPhraseTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectPiiEntitiesRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

DetectPiiEntitiesResponseTypeDef

Entities

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.PiiEntityTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectSentimentRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

DetectSentimentResponseTypeDef

Sentiment

  • Type: typing.Literal['MIXED', 'NEGATIVE', 'NEUTRAL', 'POSITIVE']
  • Required: Yes

SentimentScore

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectSyntaxRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['de', 'en', 'es', 'fr', 'it', 'pt']
  • Required: Yes

DetectSyntaxResponseTypeDef

SyntaxTokens

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.SyntaxTokenTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectTargetedSentimentRequestRequestTypeDef

Text

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

DetectTargetedSentimentResponseTypeDef

Entities

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TargetedSentimentEntityTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DetectToxicContentRequestRequestTypeDef

TextSegments

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TextSegmentTypeDef]
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

DetectToxicContentResponseTypeDef

ResultList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.ToxicLabelsTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DocumentClassTypeDef

Name

  • Type: typing.Optional[str]

Score

  • Type: typing.Optional[float]

Page

  • Type: typing.Optional[int]

DocumentClassificationConfigTypeDef

Mode

  • Type: typing.Literal['MULTI_CLASS', 'MULTI_LABEL']
  • Required: Yes

Labels

  • Type: typing.Optional[typing.Sequence[str]]

DocumentClassificationJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

DocumentClassificationJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

DocumentClassifierArn

  • Type: typing.Optional[str]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

FlywheelArn

  • Type: typing.Optional[str]

DocumentClassificationJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

DocumentClassifierArn

  • Type: typing.Optional[str]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

FlywheelArn

  • Type: typing.Optional[str]

DocumentClassifierDocumentsTypeDef

S3Uri

  • Type:
  • Required: Yes

TestS3Uri

  • Type: typing.Optional[str]

DocumentClassifierFilterTypeDef

Status

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

DocumentClassifierName

  • Type: typing.Optional[str]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

DocumentClassifierInputDataConfigPaginatorTypeDef

DataFormat

  • Type: typing.Optional[typing.Literal['AUGMENTED_MANIFEST', 'COMPREHEND_CSV']]

S3Uri

  • Type: typing.Optional[str]

TestS3Uri

  • Type: typing.Optional[str]

LabelDelimiter

  • Type: typing.Optional[str]

AugmentedManifests

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.AugmentedManifestsListItemPaginatorTypeDef]]

DocumentType

  • Type: typing.Optional[typing.Literal['PLAIN_TEXT_DOCUMENT', 'SEMI_STRUCTURED_DOCUMENT']]

Documents

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierDocumentsTypeDef]

DocumentReaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentReaderConfigPaginatorTypeDef]

DocumentClassifierInputDataConfigTypeDef

DataFormat

  • Type: typing.Optional[typing.Literal['AUGMENTED_MANIFEST', 'COMPREHEND_CSV']]

S3Uri

  • Type: typing.Optional[str]

TestS3Uri

  • Type: typing.Optional[str]

LabelDelimiter

  • Type: typing.Optional[str]

AugmentedManifests

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.AugmentedManifestsListItemTypeDef]]

DocumentType

  • Type: typing.Optional[typing.Literal['PLAIN_TEXT_DOCUMENT', 'SEMI_STRUCTURED_DOCUMENT']]

Documents

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierDocumentsTypeDef]

DocumentReaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentReaderConfigTypeDef]

DocumentClassifierOutputDataConfigTypeDef

S3Uri

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

FlywheelStatsS3Prefix

  • Type: typing.Optional[str]

DocumentClassifierPropertiesPaginatorTypeDef

DocumentClassifierArn

  • Type: typing.Optional[str]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

Status

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

TrainingStartTime

  • Type: typing.Optional[datetime.datetime]

TrainingEndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierInputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierOutputDataConfigTypeDef]

ClassifierMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.ClassifierMetadataTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

Mode

  • Type: typing.Optional[typing.Literal['MULTI_CLASS', 'MULTI_LABEL']]

ModelKmsKeyId

  • Type: typing.Optional[str]

VersionName

  • Type: typing.Optional[str]

SourceModelArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

DocumentClassifierPropertiesTypeDef

DocumentClassifierArn

  • Type: typing.Optional[str]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

Status

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

TrainingStartTime

  • Type: typing.Optional[datetime.datetime]

TrainingEndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierInputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierOutputDataConfigTypeDef]

ClassifierMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.ClassifierMetadataTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Mode

  • Type: typing.Optional[typing.Literal['MULTI_CLASS', 'MULTI_LABEL']]

ModelKmsKeyId

  • Type: typing.Optional[str]

VersionName

  • Type: typing.Optional[str]

SourceModelArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

DocumentClassifierSummaryTypeDef

DocumentClassifierName

  • Type: typing.Optional[str]

NumberOfVersions

  • Type: typing.Optional[int]

LatestVersionCreatedAt

  • Type: typing.Optional[datetime.datetime]

LatestVersionName

  • Type: typing.Optional[str]

LatestVersionStatus

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

DocumentLabelTypeDef

Name

  • Type: typing.Optional[str]

Score

  • Type: typing.Optional[float]

Page

  • Type: typing.Optional[int]

DocumentMetadataTypeDef

Pages

  • Type: typing.Optional[int]

ExtractedCharacters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.ExtractedCharactersListItemTypeDef]]

DocumentReaderConfigPaginatorTypeDef

DocumentReadAction

  • Type: typing.Literal['TEXTRACT_ANALYZE_DOCUMENT', 'TEXTRACT_DETECT_DOCUMENT_TEXT']
  • Required: Yes

DocumentReadMode

  • Type: typing.Optional[typing.Literal['FORCE_DOCUMENT_READ_ACTION', 'SERVICE_DEFAULT']]

FeatureTypes

  • Type: typing.Optional[typing.List[typing.Literal['FORMS', 'TABLES']]]

DocumentReaderConfigTypeDef

DocumentReadAction

  • Type: typing.Literal['TEXTRACT_ANALYZE_DOCUMENT', 'TEXTRACT_DETECT_DOCUMENT_TEXT']
  • Required: Yes

DocumentReadMode

  • Type: typing.Optional[typing.Literal['FORCE_DOCUMENT_READ_ACTION', 'SERVICE_DEFAULT']]

FeatureTypes

  • Type: typing.Optional[typing.Sequence[typing.Literal['FORMS', 'TABLES']]]

DocumentTypeListItemTypeDef

Page

  • Type: typing.Optional[int]

Type

  • Type: typing.Optional[typing.Literal['IMAGE', 'MS_WORD', 'NATIVE_PDF', 'PLAIN_TEXT', 'SCANNED_PDF', 'TEXTRACT_ANALYZE_DOCUMENT_JSON', 'TEXTRACT_DETECT_DOCUMENT_TEXT_JSON']]

DominantLanguageDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

DominantLanguageDetectionJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

DominantLanguageDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

DominantLanguageTypeDef

LanguageCode

  • Type: typing.Optional[str]

Score

  • Type: typing.Optional[float]

EndpointFilterTypeDef

ModelArn

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['CREATING', 'DELETING', 'FAILED', 'IN_SERVICE', 'UPDATING']]

CreationTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

CreationTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

EndpointPropertiesTypeDef

EndpointArn

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['CREATING', 'DELETING', 'FAILED', 'IN_SERVICE', 'UPDATING']]

Message

  • Type: typing.Optional[str]

ModelArn

  • Type: typing.Optional[str]

DesiredModelArn

  • Type: typing.Optional[str]

DesiredInferenceUnits

  • Type: typing.Optional[int]

CurrentInferenceUnits

  • Type: typing.Optional[int]

CreationTime

  • Type: typing.Optional[datetime.datetime]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

DataAccessRoleArn

  • Type: typing.Optional[str]

DesiredDataAccessRoleArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

EntitiesDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

EntitiesDetectionJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

EntityRecognizerArn

  • Type: typing.Optional[str]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

FlywheelArn

  • Type: typing.Optional[str]

EntitiesDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

EntityRecognizerArn

  • Type: typing.Optional[str]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

FlywheelArn

  • Type: typing.Optional[str]

EntityLabelTypeDef

Name

  • Type: typing.Optional[typing.Literal['ADDRESS', 'AGE', 'ALL', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'BANK_ACCOUNT_NUMBER', 'BANK_ROUTING', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CVV', 'CREDIT_DEBIT_EXPIRY', 'CREDIT_DEBIT_NUMBER', 'DATE_TIME', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IN_AADHAAR', 'IN_NREGA', 'IN_PERMANENT_ACCOUNT_NUMBER', 'IN_VOTER_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSPORT_NUMBER', 'PASSWORD', 'PHONE', 'PIN', 'SSN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER']]

Score

  • Type: typing.Optional[float]

EntityRecognitionConfigTypeDef

EntityTypes

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.EntityTypesListItemTypeDef]
  • Required: Yes

EntityRecognizerAnnotationsTypeDef

S3Uri

  • Type:
  • Required: Yes

TestS3Uri

  • Type: typing.Optional[str]

EntityRecognizerDocumentsTypeDef

S3Uri

  • Type:
  • Required: Yes

TestS3Uri

  • Type: typing.Optional[str]

InputFormat

  • Type: typing.Optional[typing.Literal['ONE_DOC_PER_FILE', 'ONE_DOC_PER_LINE']]

EntityRecognizerEntityListTypeDef

S3Uri

  • Type:
  • Required: Yes

EntityRecognizerEvaluationMetricsTypeDef

Precision

  • Type: typing.Optional[float]

Recall

  • Type: typing.Optional[float]

F1Score

  • Type: typing.Optional[float]

EntityRecognizerFilterTypeDef

Status

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

RecognizerName

  • Type: typing.Optional[str]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

EntityRecognizerInputDataConfigPaginatorTypeDef

EntityTypes

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityTypesListItemTypeDef]
  • Required: Yes

DataFormat

  • Type: typing.Optional[typing.Literal['AUGMENTED_MANIFEST', 'COMPREHEND_CSV']]

Documents

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerDocumentsTypeDef]

Annotations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerAnnotationsTypeDef]

EntityList

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerEntityListTypeDef]

AugmentedManifests

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.AugmentedManifestsListItemPaginatorTypeDef]]

EntityRecognizerInputDataConfigTypeDef

EntityTypes

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.EntityTypesListItemTypeDef]
  • Required: Yes

DataFormat

  • Type: typing.Optional[typing.Literal['AUGMENTED_MANIFEST', 'COMPREHEND_CSV']]

Documents

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerDocumentsTypeDef]

Annotations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerAnnotationsTypeDef]

EntityList

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerEntityListTypeDef]

AugmentedManifests

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.AugmentedManifestsListItemTypeDef]]

EntityRecognizerMetadataEntityTypesListItemTypeDef

Type

  • Type: typing.Optional[str]

EvaluationMetrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityTypesEvaluationMetricsTypeDef]

NumberOfTrainMentions

  • Type: typing.Optional[int]

EntityRecognizerMetadataTypeDef

NumberOfTrainedDocuments

  • Type: typing.Optional[int]

NumberOfTestDocuments

  • Type: typing.Optional[int]

EvaluationMetrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerEvaluationMetricsTypeDef]

EntityTypes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerMetadataEntityTypesListItemTypeDef]]

EntityRecognizerOutputDataConfigTypeDef

FlywheelStatsS3Prefix

  • Type: typing.Optional[str]

EntityRecognizerPropertiesPaginatorTypeDef

EntityRecognizerArn

  • Type: typing.Optional[str]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

Status

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

TrainingStartTime

  • Type: typing.Optional[datetime.datetime]

TrainingEndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerInputDataConfigPaginatorTypeDef]

RecognizerMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerMetadataTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

ModelKmsKeyId

  • Type: typing.Optional[str]

VersionName

  • Type: typing.Optional[str]

SourceModelArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerOutputDataConfigTypeDef]

EntityRecognizerPropertiesTypeDef

EntityRecognizerArn

  • Type: typing.Optional[str]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

Status

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

TrainingStartTime

  • Type: typing.Optional[datetime.datetime]

TrainingEndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerInputDataConfigTypeDef]

RecognizerMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerMetadataTypeDef]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

ModelKmsKeyId

  • Type: typing.Optional[str]

VersionName

  • Type: typing.Optional[str]

SourceModelArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerOutputDataConfigTypeDef]

EntityRecognizerSummaryTypeDef

RecognizerName

  • Type: typing.Optional[str]

NumberOfVersions

  • Type: typing.Optional[int]

LatestVersionCreatedAt

  • Type: typing.Optional[datetime.datetime]

LatestVersionName

  • Type: typing.Optional[str]

LatestVersionStatus

  • Type: typing.Optional[typing.Literal['DELETING', 'IN_ERROR', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED', 'TRAINED', 'TRAINED_WITH_WARNING', 'TRAINING']]

EntityTypeDef

Score

  • Type: typing.Optional[float]

Type

  • Type: typing.Optional[typing.Literal['COMMERCIAL_ITEM', 'DATE', 'EVENT', 'LOCATION', 'ORGANIZATION', 'OTHER', 'PERSON', 'QUANTITY', 'TITLE']]

Text

  • Type: typing.Optional[str]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

BlockReferences

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.BlockReferenceTypeDef]]

EntityTypesEvaluationMetricsTypeDef

Precision

  • Type: typing.Optional[float]

Recall

  • Type: typing.Optional[float]

F1Score

  • Type: typing.Optional[float]

EntityTypesListItemTypeDef

Type

  • Type:
  • Required: Yes

ErrorsListItemTypeDef

Page

  • Type: typing.Optional[int]

ErrorCode

  • Type: typing.Optional[typing.Literal['INTERNAL_SERVER_ERROR', 'PAGE_CHARACTERS_EXCEEDED', 'PAGE_SIZE_EXCEEDED', 'TEXTRACT_BAD_PAGE', 'TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED']]

ErrorMessage

  • Type: typing.Optional[str]

EventsDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

EventsDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

TargetEventTypes

  • Type: typing.Optional[typing.List[str]]

ExtractedCharactersListItemTypeDef

Page

  • Type: typing.Optional[int]

Count

  • Type: typing.Optional[int]

FlywheelFilterTypeDef

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

CreationTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

CreationTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

FlywheelIterationFilterTypeDef

CreationTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

CreationTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

FlywheelIterationPropertiesTypeDef

FlywheelArn

  • Type: typing.Optional[str]

FlywheelIterationId

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

Status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'EVALUATING', 'FAILED', 'STOPPED', 'STOP_REQUESTED', 'TRAINING']]

Message

  • Type: typing.Optional[str]

EvaluatedModelArn

  • Type: typing.Optional[str]

EvaluatedModelMetrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.FlywheelModelEvaluationMetricsTypeDef]

TrainedModelArn

  • Type: typing.Optional[str]

TrainedModelMetrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.FlywheelModelEvaluationMetricsTypeDef]

EvaluationManifestS3Prefix

  • Type: typing.Optional[str]

FlywheelModelEvaluationMetricsTypeDef

AverageF1Score

  • Type: typing.Optional[float]

AveragePrecision

  • Type: typing.Optional[float]

AverageRecall

  • Type: typing.Optional[float]

AverageAccuracy

  • Type: typing.Optional[float]

FlywheelPropertiesTypeDef

FlywheelArn

  • Type: typing.Optional[str]

ActiveModelArn

  • Type: typing.Optional[str]

DataAccessRoleArn

  • Type: typing.Optional[str]

TaskConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.TaskConfigTypeDef]

DataLakeS3Uri

  • Type: typing.Optional[str]

DataSecurityConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DataSecurityConfigTypeDef]

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

ModelType

  • Type: typing.Optional[typing.Literal['DOCUMENT_CLASSIFIER', 'ENTITY_RECOGNIZER']]

Message

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

LatestFlywheelIteration

  • Type: typing.Optional[str]

FlywheelSummaryTypeDef

FlywheelArn

  • Type: typing.Optional[str]

ActiveModelArn

  • Type: typing.Optional[str]

DataLakeS3Uri

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

ModelType

  • Type: typing.Optional[typing.Literal['DOCUMENT_CLASSIFIER', 'ENTITY_RECOGNIZER']]

Message

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

LatestFlywheelIteration

  • Type: typing.Optional[str]

GeometryTypeDef

BoundingBox

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.BoundingBoxTypeDef]

Polygon

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.PointTypeDef]]

ImportModelRequestRequestTypeDef

SourceModelArn

  • Type:
  • Required: Yes

ModelName

  • Type: typing.Optional[str]

VersionName

  • Type: typing.Optional[str]

ModelKmsKeyId

  • Type: typing.Optional[str]

DataAccessRoleArn

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

ImportModelResponseTypeDef

ModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

InputDataConfigPaginatorTypeDef

S3Uri

  • Type:
  • Required: Yes

InputFormat

  • Type: typing.Optional[typing.Literal['ONE_DOC_PER_FILE', 'ONE_DOC_PER_LINE']]

DocumentReaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentReaderConfigPaginatorTypeDef]

InputDataConfigTypeDef

S3Uri

  • Type:
  • Required: Yes

InputFormat

  • Type: typing.Optional[typing.Literal['ONE_DOC_PER_FILE', 'ONE_DOC_PER_LINE']]

DocumentReaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentReaderConfigTypeDef]

KeyPhraseTypeDef

Score

  • Type: typing.Optional[float]

Text

  • Type: typing.Optional[str]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

KeyPhrasesDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

KeyPhrasesDetectionJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

KeyPhrasesDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

ListDatasetsRequestRequestTypeDef

FlywheelArn

  • Type: typing.Optional[str]

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DatasetFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListDatasetsResponseTypeDef

DatasetPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DatasetPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassificationJobFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListDocumentClassificationJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassificationJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListDocumentClassificationJobsResponsePaginatorTypeDef

DocumentClassificationJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassificationJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDocumentClassificationJobsResponseTypeDef

DocumentClassificationJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassificationJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDocumentClassifierSummariesRequestRequestTypeDef

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListDocumentClassifierSummariesResponseTypeDef

DocumentClassifierSummariesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierSummaryTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListDocumentClassifiersRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListDocumentClassifiersResponsePaginatorTypeDef

DocumentClassifierPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDocumentClassifiersResponseTypeDef

DocumentClassifierPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassifierPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDominantLanguageDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DominantLanguageDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListDominantLanguageDetectionJobsResponsePaginatorTypeDef

DominantLanguageDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DominantLanguageDetectionJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDominantLanguageDetectionJobsResponseTypeDef

DominantLanguageDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.DominantLanguageDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEndpointsRequestListEndpointsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EndpointFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListEndpointsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EndpointFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListEndpointsResponseTypeDef

EndpointPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EndpointPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntitiesDetectionJobFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListEntitiesDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntitiesDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListEntitiesDetectionJobsResponsePaginatorTypeDef

EntitiesDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntitiesDetectionJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEntitiesDetectionJobsResponseTypeDef

EntitiesDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntitiesDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEntityRecognizerSummariesRequestRequestTypeDef

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListEntityRecognizerSummariesResponseTypeDef

EntityRecognizerSummariesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerSummaryTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListEntityRecognizersRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListEntityRecognizersResponsePaginatorTypeDef

EntityRecognizerPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEntityRecognizersResponseTypeDef

EntityRecognizerPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognizerPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEventsDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EventsDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListEventsDetectionJobsResponseTypeDef

EventsDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.EventsDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListFlywheelIterationHistoryRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.FlywheelIterationFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListFlywheelIterationHistoryResponseTypeDef

FlywheelIterationPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.FlywheelIterationPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListFlywheelsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.FlywheelFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListFlywheelsResponseTypeDef

FlywheelSummaryList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.FlywheelSummaryTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.KeyPhrasesDetectionJobFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListKeyPhrasesDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.KeyPhrasesDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListKeyPhrasesDetectionJobsResponsePaginatorTypeDef

KeyPhrasesDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.KeyPhrasesDetectionJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListKeyPhrasesDetectionJobsResponseTypeDef

KeyPhrasesDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.KeyPhrasesDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PiiEntitiesDetectionJobFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListPiiEntitiesDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PiiEntitiesDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListPiiEntitiesDetectionJobsResponsePaginatorTypeDef

PiiEntitiesDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.PiiEntitiesDetectionJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListPiiEntitiesDetectionJobsResponseTypeDef

PiiEntitiesDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.PiiEntitiesDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.SentimentDetectionJobFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListSentimentDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.SentimentDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListSentimentDetectionJobsResponsePaginatorTypeDef

SentimentDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.SentimentDetectionJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListSentimentDetectionJobsResponseTypeDef

SentimentDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.SentimentDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTargetedSentimentDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.TargetedSentimentDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListTargetedSentimentDetectionJobsResponseTypeDef

TargetedSentimentDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TargetedSentimentDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.TopicsDetectionJobFilterTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PaginatorConfigTypeDef]

ListTopicsDetectionJobsRequestRequestTypeDef

Filter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.TopicsDetectionJobFilterTypeDef]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListTopicsDetectionJobsResponsePaginatorTypeDef

TopicsDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TopicsDetectionJobPropertiesPaginatorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTopicsDetectionJobsResponseTypeDef

TopicsDetectionJobPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TopicsDetectionJobPropertiesTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MentionSentimentTypeDef

Sentiment

  • Type: typing.Optional[typing.Literal['MIXED', 'NEGATIVE', 'NEUTRAL', 'POSITIVE']]

SentimentScore

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.SentimentScoreTypeDef]

OutputDataConfigTypeDef

S3Uri

  • Type:
  • Required: Yes

KmsKeyId

  • Type: typing.Optional[str]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PartOfSpeechTagTypeDef

Tag

  • Type: typing.Optional[typing.Literal['ADJ', 'ADP', 'ADV', 'AUX', 'CCONJ', 'CONJ', 'DET', 'INTJ', 'NOUN', 'NUM', 'O', 'PART', 'PRON', 'PROPN', 'PUNCT', 'SCONJ', 'SYM', 'VERB']]

Score

  • Type: typing.Optional[float]

PiiEntitiesDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

PiiEntitiesDetectionJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PiiOutputDataConfigTypeDef]

RedactionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.RedactionConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

Mode

  • Type: typing.Optional[typing.Literal['ONLY_OFFSETS', 'ONLY_REDACTION']]

PiiEntitiesDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PiiOutputDataConfigTypeDef]

RedactionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.RedactionConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

Mode

  • Type: typing.Optional[typing.Literal['ONLY_OFFSETS', 'ONLY_REDACTION']]

PiiEntityTypeDef

Score

  • Type: typing.Optional[float]

Type

  • Type: typing.Optional[typing.Literal['ADDRESS', 'AGE', 'ALL', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'BANK_ACCOUNT_NUMBER', 'BANK_ROUTING', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CVV', 'CREDIT_DEBIT_EXPIRY', 'CREDIT_DEBIT_NUMBER', 'DATE_TIME', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IN_AADHAAR', 'IN_NREGA', 'IN_PERMANENT_ACCOUNT_NUMBER', 'IN_VOTER_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSPORT_NUMBER', 'PASSWORD', 'PHONE', 'PIN', 'SSN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER']]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

PiiOutputDataConfigTypeDef

S3Uri

  • Type:
  • Required: Yes

KmsKeyId

  • Type: typing.Optional[str]

PointTypeDef

X

  • Type: typing.Optional[float]

Y

  • Type: typing.Optional[float]

PutResourcePolicyRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

ResourcePolicy

  • Type:
  • Required: Yes

PolicyRevisionId

  • Type: typing.Optional[str]

PutResourcePolicyResponseTypeDef

PolicyRevisionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RedactionConfigTypeDef

PiiEntityTypes

  • Type: typing.Optional[typing.List[typing.Literal['ADDRESS', 'AGE', 'ALL', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'BANK_ACCOUNT_NUMBER', 'BANK_ROUTING', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CVV', 'CREDIT_DEBIT_EXPIRY', 'CREDIT_DEBIT_NUMBER', 'DATE_TIME', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IN_AADHAAR', 'IN_NREGA', 'IN_PERMANENT_ACCOUNT_NUMBER', 'IN_VOTER_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSPORT_NUMBER', 'PASSWORD', 'PHONE', 'PIN', 'SSN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER']]]

MaskMode

  • Type: typing.Optional[typing.Literal['MASK', 'REPLACE_WITH_PII_ENTITY_TYPE']]

MaskCharacter

  • Type: typing.Optional[str]

RelationshipsListItemTypeDef

Ids

  • Type: typing.Optional[typing.List[str]]

Type

  • Type: typing.Optional[typing.Literal['CHILD']]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

SentimentDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

SentimentDetectionJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

SentimentDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

SentimentScoreTypeDef

Positive

  • Type: typing.Optional[float]

Negative

  • Type: typing.Optional[float]

Neutral

  • Type: typing.Optional[float]

Mixed

  • Type: typing.Optional[float]

StartDocumentClassificationJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

JobName

  • Type: typing.Optional[str]

DocumentClassifierArn

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

FlywheelArn

  • Type: typing.Optional[str]

StartDocumentClassificationJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

DocumentClassifierArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartDominantLanguageDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

JobName

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartDominantLanguageDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartEntitiesDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

JobName

  • Type: typing.Optional[str]

EntityRecognizerArn

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

FlywheelArn

  • Type: typing.Optional[str]

StartEntitiesDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

EntityRecognizerArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartEventsDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

TargetEventTypes

  • Type: typing.Sequence[str]
  • Required: Yes

JobName

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartEventsDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartFlywheelIterationRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

StartFlywheelIterationResponseTypeDef

FlywheelArn

  • Type:
  • Required: Yes

FlywheelIterationId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartKeyPhrasesDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

JobName

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartKeyPhrasesDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartPiiEntitiesDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

Mode

  • Type: typing.Literal['ONLY_OFFSETS', 'ONLY_REDACTION']
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

RedactionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.RedactionConfigTypeDef]

JobName

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartPiiEntitiesDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartSentimentDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

JobName

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartSentimentDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartTargetedSentimentDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

JobName

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartTargetedSentimentDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartTopicsDetectionJobRequestRequestTypeDef

InputDataConfig

  • Type:
  • Required: Yes

OutputDataConfig

  • Type:
  • Required: Yes

DataAccessRoleArn

  • Type:
  • Required: Yes

JobName

  • Type: typing.Optional[str]

NumberOfTopics

  • Type: typing.Optional[int]

ClientRequestToken

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]]

StartTopicsDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobArn

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopDominantLanguageDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopDominantLanguageDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopEntitiesDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopEntitiesDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopEventsDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopEventsDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopKeyPhrasesDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopKeyPhrasesDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopPiiEntitiesDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopPiiEntitiesDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopSentimentDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopSentimentDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopTargetedSentimentDetectionJobRequestRequestTypeDef

JobId

  • Type:
  • Required: Yes

StopTargetedSentimentDetectionJobResponseTypeDef

JobId

  • Type:
  • Required: Yes

JobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopTrainingDocumentClassifierRequestRequestTypeDef

DocumentClassifierArn

  • Type:
  • Required: Yes

StopTrainingEntityRecognizerRequestRequestTypeDef

EntityRecognizerArn

  • Type:
  • Required: Yes

SyntaxTokenTypeDef

TokenId

  • Type: typing.Optional[int]

Text

  • Type: typing.Optional[str]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

PartOfSpeech

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.PartOfSpeechTagTypeDef]

TagResourceRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.comprehend_classes.TagTypeDef]
  • Required: Yes

TagTypeDef

Key

  • Type:
  • Required: Yes

Value

  • Type: typing.Optional[str]

TargetedSentimentDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

TargetedSentimentDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

LanguageCode

  • Type: typing.Optional[typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

TargetedSentimentEntityTypeDef

DescriptiveMentionIndex

  • Type: typing.Optional[typing.List[int]]

Mentions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.TargetedSentimentMentionTypeDef]]

TargetedSentimentMentionTypeDef

Score

  • Type: typing.Optional[float]

GroupScore

  • Type: typing.Optional[float]

Text

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[typing.Literal['ATTRIBUTE', 'BOOK', 'BRAND', 'COMMERCIAL_ITEM', 'DATE', 'EVENT', 'FACILITY', 'GAME', 'LOCATION', 'MOVIE', 'MUSIC', 'ORGANIZATION', 'OTHER', 'PERSON', 'PERSONAL_TITLE', 'QUANTITY', 'SOFTWARE']]

MentionSentiment

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.MentionSentimentTypeDef]

BeginOffset

  • Type: typing.Optional[int]

EndOffset

  • Type: typing.Optional[int]

TaskConfigTypeDef

LanguageCode

  • Type: typing.Literal['ar', 'de', 'en', 'es', 'fr', 'hi', 'it', 'ja', 'ko', 'pt', 'zh', 'zh-TW']
  • Required: Yes

DocumentClassificationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.DocumentClassificationConfigTypeDef]

EntityRecognitionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.EntityRecognitionConfigTypeDef]

TextSegmentTypeDef

Text

  • Type:
  • Required: Yes

TopicsDetectionJobFilterTypeDef

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

SubmitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

SubmitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

TopicsDetectionJobPropertiesPaginatorTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigPaginatorTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

NumberOfTopics

  • Type: typing.Optional[int]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigPaginatorTypeDef]

TopicsDetectionJobPropertiesTypeDef

JobId

  • Type: typing.Optional[str]

JobArn

  • Type: typing.Optional[str]

JobName

  • Type: typing.Optional[str]

JobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'STOPPED', 'STOP_REQUESTED', 'SUBMITTED']]

Message

  • Type: typing.Optional[str]

SubmitTime

  • Type: typing.Optional[datetime.datetime]

EndTime

  • Type: typing.Optional[datetime.datetime]

InputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.InputDataConfigTypeDef]

OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.OutputDataConfigTypeDef]

NumberOfTopics

  • Type: typing.Optional[int]

DataAccessRoleArn

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

ToxicContentTypeDef

Name

  • Type: typing.Optional[typing.Literal['GRAPHIC', 'HARASSMENT_OR_ABUSE', 'HATE_SPEECH', 'INSULT', 'PROFANITY', 'SEXUAL', 'VIOLENCE_OR_THREAT']]

Score

  • Type: typing.Optional[float]

ToxicLabelsTypeDef

Labels

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.comprehend_classes.ToxicContentTypeDef]]

Toxicity

  • Type: typing.Optional[float]

UntagResourceRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateDataSecurityConfigTypeDef

ModelKmsKeyId

  • Type: typing.Optional[str]

VolumeKmsKeyId

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.VpcConfigTypeDef]

UpdateEndpointRequestRequestTypeDef

EndpointArn

  • Type:
  • Required: Yes

DesiredModelArn

  • Type: typing.Optional[str]

DesiredInferenceUnits

  • Type: typing.Optional[int]

DesiredDataAccessRoleArn

  • Type: typing.Optional[str]

FlywheelArn

  • Type: typing.Optional[str]

UpdateEndpointResponseTypeDef

DesiredModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateFlywheelRequestRequestTypeDef

FlywheelArn

  • Type:
  • Required: Yes

ActiveModelArn

  • Type: typing.Optional[str]

DataAccessRoleArn

  • Type: typing.Optional[str]

DataSecurityConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.comprehend_classes.UpdateDataSecurityConfigTypeDef]

UpdateFlywheelResponseTypeDef

FlywheelProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VpcConfigPaginatorTypeDef

SecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

Subnets

  • Type: typing.List[str]
  • Required: Yes

VpcConfigTypeDef

SecurityGroupIds

  • Type: typing.Sequence[str]
  • Required: Yes

Subnets

  • Type: typing.Sequence[str]
  • Required: Yes

WarningsListItemTypeDef

Page

  • Type: typing.Optional[int]

WarnCode

  • Type: typing.Optional[typing.Literal['INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL', 'INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL']]

WarnMessage

  • Type: typing.Optional[str]