Typed dictionaries
Index > Comprehend > Typed dictionaries
Auto-generated documentation for Comprehend type annotations stubs module mypy-boto3-comprehend.
AugmentedManifestsListItemTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import AugmentedManifestsListItemTypeDef
def get_value() -> AugmentedManifestsListItemTypeDef:
return {
"S3Uri": ...,
"AttributeNames": ...,
}
Definition
class AugmentedManifestsListItemTypeDef(TypedDict):
S3Uri: str,
AttributeNames: Sequence[str],
Split: NotRequired[SplitType], # (1)
AnnotationDataS3Uri: NotRequired[str],
SourceDocumentsS3Uri: NotRequired[str],
DocumentType: NotRequired[AugmentedManifestsDocumentTypeFormatType], # (2)
DominantLanguageTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DominantLanguageTypeDef
def get_value() -> DominantLanguageTypeDef:
return {
"LanguageCode": ...,
}
Definition
class DominantLanguageTypeDef(TypedDict):
LanguageCode: NotRequired[str],
Score: NotRequired[float],
BatchDetectDominantLanguageRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageRequestRequestTypeDef
def get_value() -> BatchDetectDominantLanguageRequestRequestTypeDef:
return {
"TextList": ...,
}
Definition
class BatchDetectDominantLanguageRequestRequestTypeDef(TypedDict):
TextList: Sequence[str],
BatchItemErrorTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchItemErrorTypeDef
def get_value() -> BatchItemErrorTypeDef:
return {
"Index": ...,
}
Definition
class BatchItemErrorTypeDef(TypedDict):
Index: NotRequired[int],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchDetectEntitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectEntitiesRequestRequestTypeDef
def get_value() -> BatchDetectEntitiesRequestRequestTypeDef:
return {
"TextList": ...,
"LanguageCode": ...,
}
Definition
class BatchDetectEntitiesRequestRequestTypeDef(TypedDict):
TextList: Sequence[str],
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
KeyPhraseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import KeyPhraseTypeDef
def get_value() -> KeyPhraseTypeDef:
return {
"Score": ...,
}
Definition
class KeyPhraseTypeDef(TypedDict):
Score: NotRequired[float],
Text: NotRequired[str],
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],
BatchDetectKeyPhrasesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectKeyPhrasesRequestRequestTypeDef
def get_value() -> BatchDetectKeyPhrasesRequestRequestTypeDef:
return {
"TextList": ...,
"LanguageCode": ...,
}
Definition
class BatchDetectKeyPhrasesRequestRequestTypeDef(TypedDict):
TextList: Sequence[str],
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
SentimentScoreTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import SentimentScoreTypeDef
def get_value() -> SentimentScoreTypeDef:
return {
"Positive": ...,
}
Definition
class SentimentScoreTypeDef(TypedDict):
Positive: NotRequired[float],
Negative: NotRequired[float],
Neutral: NotRequired[float],
Mixed: NotRequired[float],
BatchDetectSentimentRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectSentimentRequestRequestTypeDef
def get_value() -> BatchDetectSentimentRequestRequestTypeDef:
return {
"TextList": ...,
"LanguageCode": ...,
}
Definition
class BatchDetectSentimentRequestRequestTypeDef(TypedDict):
TextList: Sequence[str],
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
BatchDetectSyntaxRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectSyntaxRequestRequestTypeDef
def get_value() -> BatchDetectSyntaxRequestRequestTypeDef:
return {
"TextList": ...,
"LanguageCode": ...,
}
Definition
class BatchDetectSyntaxRequestRequestTypeDef(TypedDict):
TextList: Sequence[str],
LanguageCode: SyntaxLanguageCodeType, # (1)
BatchDetectTargetedSentimentRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectTargetedSentimentRequestRequestTypeDef
def get_value() -> BatchDetectTargetedSentimentRequestRequestTypeDef:
return {
"TextList": ...,
"LanguageCode": ...,
}
Definition
class BatchDetectTargetedSentimentRequestRequestTypeDef(TypedDict):
TextList: Sequence[str],
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
ChildBlockTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ChildBlockTypeDef
def get_value() -> ChildBlockTypeDef:
return {
"ChildBlockId": ...,
}
Definition
class ChildBlockTypeDef(TypedDict):
ChildBlockId: NotRequired[str],
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],
RelationshipsListItemTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import RelationshipsListItemTypeDef
def get_value() -> RelationshipsListItemTypeDef:
return {
"Ids": ...,
}
Definition
class RelationshipsListItemTypeDef(TypedDict):
Ids: NotRequired[List[str]],
Type: NotRequired[RelationshipTypeType], # (1)
BoundingBoxTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BoundingBoxTypeDef
def get_value() -> BoundingBoxTypeDef:
return {
"Height": ...,
}
Definition
class BoundingBoxTypeDef(TypedDict):
Height: NotRequired[float],
Left: NotRequired[float],
Top: NotRequired[float],
Width: NotRequired[float],
ClassifierEvaluationMetricsTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ClassifierEvaluationMetricsTypeDef
def get_value() -> ClassifierEvaluationMetricsTypeDef:
return {
"Accuracy": ...,
}
Definition
class ClassifierEvaluationMetricsTypeDef(TypedDict):
Accuracy: NotRequired[float],
Precision: NotRequired[float],
Recall: NotRequired[float],
F1Score: NotRequired[float],
MicroPrecision: NotRequired[float],
MicroRecall: NotRequired[float],
MicroF1Score: NotRequired[float],
HammingLoss: NotRequired[float],
DocumentReaderConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentReaderConfigTypeDef
def get_value() -> DocumentReaderConfigTypeDef:
return {
"DocumentReadAction": ...,
}
Definition
class DocumentReaderConfigTypeDef(TypedDict):
DocumentReadAction: DocumentReadActionType, # (1)
DocumentReadMode: NotRequired[DocumentReadModeType], # (2)
FeatureTypes: NotRequired[Sequence[DocumentReadFeatureTypesType]], # (3)
DocumentClassTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassTypeDef
def get_value() -> DocumentClassTypeDef:
return {
"Name": ...,
}
Definition
class DocumentClassTypeDef(TypedDict):
Name: NotRequired[str],
Score: NotRequired[float],
Page: NotRequired[int],
DocumentLabelTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentLabelTypeDef
def get_value() -> DocumentLabelTypeDef:
return {
"Name": ...,
}
Definition
class DocumentLabelTypeDef(TypedDict):
Name: NotRequired[str],
Score: NotRequired[float],
Page: NotRequired[int],
DocumentTypeListItemTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentTypeListItemTypeDef
def get_value() -> DocumentTypeListItemTypeDef:
return {
"Page": ...,
}
Definition
class DocumentTypeListItemTypeDef(TypedDict):
Page: NotRequired[int],
Type: NotRequired[DocumentTypeType], # (1)
- See DocumentTypeType
ErrorsListItemTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ErrorsListItemTypeDef
def get_value() -> ErrorsListItemTypeDef:
return {
"Page": ...,
}
Definition
class ErrorsListItemTypeDef(TypedDict):
Page: NotRequired[int],
ErrorCode: NotRequired[PageBasedErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
ContainsPiiEntitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ContainsPiiEntitiesRequestRequestTypeDef
def get_value() -> ContainsPiiEntitiesRequestRequestTypeDef:
return {
"Text": ...,
"LanguageCode": ...,
}
Definition
class ContainsPiiEntitiesRequestRequestTypeDef(TypedDict):
Text: str,
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
EntityLabelTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityLabelTypeDef
def get_value() -> EntityLabelTypeDef:
return {
"Name": ...,
}
Definition
class EntityLabelTypeDef(TypedDict):
Name: NotRequired[PiiEntityTypeType], # (1)
Score: NotRequired[float],
DocumentClassifierOutputDataConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierOutputDataConfigTypeDef
def get_value() -> DocumentClassifierOutputDataConfigTypeDef:
return {
"S3Uri": ...,
}
Definition
class DocumentClassifierOutputDataConfigTypeDef(TypedDict):
S3Uri: NotRequired[str],
KmsKeyId: NotRequired[str],
TagTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
VpcConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import VpcConfigTypeDef
def get_value() -> VpcConfigTypeDef:
return {
"SecurityGroupIds": ...,
"Subnets": ...,
}
Definition
class VpcConfigTypeDef(TypedDict):
SecurityGroupIds: Sequence[str],
Subnets: Sequence[str],
DeleteDocumentClassifierRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DeleteDocumentClassifierRequestRequestTypeDef
def get_value() -> DeleteDocumentClassifierRequestRequestTypeDef:
return {
"DocumentClassifierArn": ...,
}
Definition
class DeleteDocumentClassifierRequestRequestTypeDef(TypedDict):
DocumentClassifierArn: str,
DeleteEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DeleteEndpointRequestRequestTypeDef
def get_value() -> DeleteEndpointRequestRequestTypeDef:
return {
"EndpointArn": ...,
}
DeleteEntityRecognizerRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DeleteEntityRecognizerRequestRequestTypeDef
def get_value() -> DeleteEntityRecognizerRequestRequestTypeDef:
return {
"EntityRecognizerArn": ...,
}
DeleteResourcePolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DeleteResourcePolicyRequestRequestTypeDef
def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
ResourceArn: str,
PolicyRevisionId: NotRequired[str],
DescribeDocumentClassificationJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeDocumentClassificationJobRequestRequestTypeDef
def get_value() -> DescribeDocumentClassificationJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeDocumentClassifierRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeDocumentClassifierRequestRequestTypeDef
def get_value() -> DescribeDocumentClassifierRequestRequestTypeDef:
return {
"DocumentClassifierArn": ...,
}
Definition
class DescribeDocumentClassifierRequestRequestTypeDef(TypedDict):
DocumentClassifierArn: str,
DescribeDominantLanguageDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeDominantLanguageDetectionJobRequestRequestTypeDef
def get_value() -> DescribeDominantLanguageDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEndpointRequestRequestTypeDef
def get_value() -> DescribeEndpointRequestRequestTypeDef:
return {
"EndpointArn": ...,
}
EndpointPropertiesTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EndpointPropertiesTypeDef
def get_value() -> EndpointPropertiesTypeDef:
return {
"EndpointArn": ...,
}
Definition
class EndpointPropertiesTypeDef(TypedDict):
EndpointArn: NotRequired[str],
Status: NotRequired[EndpointStatusType], # (1)
Message: NotRequired[str],
ModelArn: NotRequired[str],
DesiredModelArn: NotRequired[str],
DesiredInferenceUnits: NotRequired[int],
CurrentInferenceUnits: NotRequired[int],
CreationTime: NotRequired[datetime],
LastModifiedTime: NotRequired[datetime],
DataAccessRoleArn: NotRequired[str],
DesiredDataAccessRoleArn: NotRequired[str],
DescribeEntitiesDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEntitiesDetectionJobRequestRequestTypeDef
def get_value() -> DescribeEntitiesDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeEntityRecognizerRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEntityRecognizerRequestRequestTypeDef
def get_value() -> DescribeEntityRecognizerRequestRequestTypeDef:
return {
"EntityRecognizerArn": ...,
}
DescribeEventsDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeEventsDetectionJobRequestRequestTypeDef
def get_value() -> DescribeEventsDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeKeyPhrasesDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeKeyPhrasesDetectionJobRequestRequestTypeDef
def get_value() -> DescribeKeyPhrasesDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribePiiEntitiesDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribePiiEntitiesDetectionJobRequestRequestTypeDef
def get_value() -> DescribePiiEntitiesDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeResourcePolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeResourcePolicyRequestRequestTypeDef
def get_value() -> DescribeResourcePolicyRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
DescribeSentimentDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeSentimentDetectionJobRequestRequestTypeDef
def get_value() -> DescribeSentimentDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeTargetedSentimentDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeTargetedSentimentDetectionJobRequestRequestTypeDef
def get_value() -> DescribeTargetedSentimentDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DescribeTopicsDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeTopicsDetectionJobRequestRequestTypeDef
def get_value() -> DescribeTopicsDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
DetectDominantLanguageRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectDominantLanguageRequestRequestTypeDef
def get_value() -> DetectDominantLanguageRequestRequestTypeDef:
return {
"Text": ...,
}
DetectKeyPhrasesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectKeyPhrasesRequestRequestTypeDef
def get_value() -> DetectKeyPhrasesRequestRequestTypeDef:
return {
"Text": ...,
"LanguageCode": ...,
}
Definition
class DetectKeyPhrasesRequestRequestTypeDef(TypedDict):
Text: str,
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
DetectPiiEntitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectPiiEntitiesRequestRequestTypeDef
def get_value() -> DetectPiiEntitiesRequestRequestTypeDef:
return {
"Text": ...,
"LanguageCode": ...,
}
Definition
class DetectPiiEntitiesRequestRequestTypeDef(TypedDict):
Text: str,
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
PiiEntityTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PiiEntityTypeDef
def get_value() -> PiiEntityTypeDef:
return {
"Score": ...,
}
Definition
class PiiEntityTypeDef(TypedDict):
Score: NotRequired[float],
Type: NotRequired[PiiEntityTypeType], # (1)
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],
DetectSentimentRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectSentimentRequestRequestTypeDef
def get_value() -> DetectSentimentRequestRequestTypeDef:
return {
"Text": ...,
"LanguageCode": ...,
}
Definition
class DetectSentimentRequestRequestTypeDef(TypedDict):
Text: str,
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
DetectSyntaxRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectSyntaxRequestRequestTypeDef
def get_value() -> DetectSyntaxRequestRequestTypeDef:
return {
"Text": ...,
"LanguageCode": ...,
}
Definition
class DetectSyntaxRequestRequestTypeDef(TypedDict):
Text: str,
LanguageCode: SyntaxLanguageCodeType, # (1)
DetectTargetedSentimentRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectTargetedSentimentRequestRequestTypeDef
def get_value() -> DetectTargetedSentimentRequestRequestTypeDef:
return {
"Text": ...,
"LanguageCode": ...,
}
Definition
class DetectTargetedSentimentRequestRequestTypeDef(TypedDict):
Text: str,
LanguageCode: LanguageCodeType, # (1)
- See LanguageCodeType
DocumentClassificationJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassificationJobFilterTypeDef
def get_value() -> DocumentClassificationJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class DocumentClassificationJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
OutputDataConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import OutputDataConfigTypeDef
def get_value() -> OutputDataConfigTypeDef:
return {
"S3Uri": ...,
}
DocumentClassifierFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierFilterTypeDef
def get_value() -> DocumentClassifierFilterTypeDef:
return {
"Status": ...,
}
Definition
class DocumentClassifierFilterTypeDef(TypedDict):
Status: NotRequired[ModelStatusType], # (1)
DocumentClassifierName: NotRequired[str],
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See ModelStatusType
DocumentClassifierSummaryTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierSummaryTypeDef
def get_value() -> DocumentClassifierSummaryTypeDef:
return {
"DocumentClassifierName": ...,
}
Definition
class DocumentClassifierSummaryTypeDef(TypedDict):
DocumentClassifierName: NotRequired[str],
NumberOfVersions: NotRequired[int],
LatestVersionCreatedAt: NotRequired[datetime],
LatestVersionName: NotRequired[str],
LatestVersionStatus: NotRequired[ModelStatusType], # (1)
- See ModelStatusType
ExtractedCharactersListItemTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ExtractedCharactersListItemTypeDef
def get_value() -> ExtractedCharactersListItemTypeDef:
return {
"Page": ...,
}
Definition
class ExtractedCharactersListItemTypeDef(TypedDict):
Page: NotRequired[int],
Count: NotRequired[int],
DominantLanguageDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DominantLanguageDetectionJobFilterTypeDef
def get_value() -> DominantLanguageDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class DominantLanguageDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
EndpointFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EndpointFilterTypeDef
def get_value() -> EndpointFilterTypeDef:
return {
"ModelArn": ...,
}
Definition
class EndpointFilterTypeDef(TypedDict):
ModelArn: NotRequired[str],
Status: NotRequired[EndpointStatusType], # (1)
CreationTimeBefore: NotRequired[Union[datetime, str]],
CreationTimeAfter: NotRequired[Union[datetime, str]],
EntitiesDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntitiesDetectionJobFilterTypeDef
def get_value() -> EntitiesDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class EntitiesDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
EntityRecognizerAnnotationsTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerAnnotationsTypeDef
def get_value() -> EntityRecognizerAnnotationsTypeDef:
return {
"S3Uri": ...,
}
Definition
class EntityRecognizerAnnotationsTypeDef(TypedDict):
S3Uri: str,
TestS3Uri: NotRequired[str],
EntityRecognizerDocumentsTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerDocumentsTypeDef
def get_value() -> EntityRecognizerDocumentsTypeDef:
return {
"S3Uri": ...,
}
Definition
class EntityRecognizerDocumentsTypeDef(TypedDict):
S3Uri: str,
TestS3Uri: NotRequired[str],
InputFormat: NotRequired[InputFormatType], # (1)
- See InputFormatType
EntityRecognizerEntityListTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerEntityListTypeDef
def get_value() -> EntityRecognizerEntityListTypeDef:
return {
"S3Uri": ...,
}
EntityRecognizerEvaluationMetricsTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerEvaluationMetricsTypeDef
def get_value() -> EntityRecognizerEvaluationMetricsTypeDef:
return {
"Precision": ...,
}
Definition
class EntityRecognizerEvaluationMetricsTypeDef(TypedDict):
Precision: NotRequired[float],
Recall: NotRequired[float],
F1Score: NotRequired[float],
EntityRecognizerFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerFilterTypeDef
def get_value() -> EntityRecognizerFilterTypeDef:
return {
"Status": ...,
}
Definition
class EntityRecognizerFilterTypeDef(TypedDict):
Status: NotRequired[ModelStatusType], # (1)
RecognizerName: NotRequired[str],
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See ModelStatusType
EntityTypesListItemTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityTypesListItemTypeDef
def get_value() -> EntityTypesListItemTypeDef:
return {
"Type": ...,
}
EntityTypesEvaluationMetricsTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityTypesEvaluationMetricsTypeDef
def get_value() -> EntityTypesEvaluationMetricsTypeDef:
return {
"Precision": ...,
}
Definition
class EntityTypesEvaluationMetricsTypeDef(TypedDict):
Precision: NotRequired[float],
Recall: NotRequired[float],
F1Score: NotRequired[float],
EntityRecognizerSummaryTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EntityRecognizerSummaryTypeDef
def get_value() -> EntityRecognizerSummaryTypeDef:
return {
"RecognizerName": ...,
}
Definition
class EntityRecognizerSummaryTypeDef(TypedDict):
RecognizerName: NotRequired[str],
NumberOfVersions: NotRequired[int],
LatestVersionCreatedAt: NotRequired[datetime],
LatestVersionName: NotRequired[str],
LatestVersionStatus: NotRequired[ModelStatusType], # (1)
- See ModelStatusType
EventsDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import EventsDetectionJobFilterTypeDef
def get_value() -> EventsDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class EventsDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
PointTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PointTypeDef
def get_value() -> PointTypeDef:
return {
"X": ...,
}
KeyPhrasesDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import KeyPhrasesDetectionJobFilterTypeDef
def get_value() -> KeyPhrasesDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class KeyPhrasesDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListDocumentClassifierSummariesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ListDocumentClassifierSummariesRequestRequestTypeDef
def get_value() -> ListDocumentClassifierSummariesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDocumentClassifierSummariesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListEntityRecognizerSummariesRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ListEntityRecognizerSummariesRequestRequestTypeDef
def get_value() -> ListEntityRecognizerSummariesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListEntityRecognizerSummariesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PiiEntitiesDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PiiEntitiesDetectionJobFilterTypeDef
def get_value() -> PiiEntitiesDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class PiiEntitiesDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
SentimentDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import SentimentDetectionJobFilterTypeDef
def get_value() -> SentimentDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class SentimentDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
TargetedSentimentDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import TargetedSentimentDetectionJobFilterTypeDef
def get_value() -> TargetedSentimentDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class TargetedSentimentDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
TopicsDetectionJobFilterTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import TopicsDetectionJobFilterTypeDef
def get_value() -> TopicsDetectionJobFilterTypeDef:
return {
"JobName": ...,
}
Definition
class TopicsDetectionJobFilterTypeDef(TypedDict):
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmitTimeBefore: NotRequired[Union[datetime, str]],
SubmitTimeAfter: NotRequired[Union[datetime, str]],
- See JobStatusType
PartOfSpeechTagTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PartOfSpeechTagTypeDef
def get_value() -> PartOfSpeechTagTypeDef:
return {
"Tag": ...,
}
Definition
class PartOfSpeechTagTypeDef(TypedDict):
Tag: NotRequired[PartOfSpeechTagTypeType], # (1)
Score: NotRequired[float],
PiiOutputDataConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PiiOutputDataConfigTypeDef
def get_value() -> PiiOutputDataConfigTypeDef:
return {
"S3Uri": ...,
}
RedactionConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import RedactionConfigTypeDef
def get_value() -> RedactionConfigTypeDef:
return {
"PiiEntityTypes": ...,
}
Definition
class RedactionConfigTypeDef(TypedDict):
PiiEntityTypes: NotRequired[List[PiiEntityTypeType]], # (1)
MaskMode: NotRequired[PiiEntitiesDetectionMaskModeType], # (2)
MaskCharacter: NotRequired[str],
PutResourcePolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PutResourcePolicyRequestRequestTypeDef
def get_value() -> PutResourcePolicyRequestRequestTypeDef:
return {
"ResourceArn": ...,
"ResourcePolicy": ...,
}
Definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ResourcePolicy: str,
PolicyRevisionId: NotRequired[str],
StopDominantLanguageDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopDominantLanguageDetectionJobRequestRequestTypeDef
def get_value() -> StopDominantLanguageDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopEntitiesDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopEntitiesDetectionJobRequestRequestTypeDef
def get_value() -> StopEntitiesDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopEventsDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopEventsDetectionJobRequestRequestTypeDef
def get_value() -> StopEventsDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopKeyPhrasesDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopKeyPhrasesDetectionJobRequestRequestTypeDef
def get_value() -> StopKeyPhrasesDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopPiiEntitiesDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopPiiEntitiesDetectionJobRequestRequestTypeDef
def get_value() -> StopPiiEntitiesDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopSentimentDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopSentimentDetectionJobRequestRequestTypeDef
def get_value() -> StopSentimentDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopTargetedSentimentDetectionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopTargetedSentimentDetectionJobRequestRequestTypeDef
def get_value() -> StopTargetedSentimentDetectionJobRequestRequestTypeDef:
return {
"JobId": ...,
}
StopTrainingDocumentClassifierRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopTrainingDocumentClassifierRequestRequestTypeDef
def get_value() -> StopTrainingDocumentClassifierRequestRequestTypeDef:
return {
"DocumentClassifierArn": ...,
}
Definition
class StopTrainingDocumentClassifierRequestRequestTypeDef(TypedDict):
DocumentClassifierArn: str,
StopTrainingEntityRecognizerRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StopTrainingEntityRecognizerRequestRequestTypeDef
def get_value() -> StopTrainingEntityRecognizerRequestRequestTypeDef:
return {
"EntityRecognizerArn": ...,
}
Definition
class StopTrainingEntityRecognizerRequestRequestTypeDef(TypedDict):
EntityRecognizerArn: str,
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import UpdateEndpointRequestRequestTypeDef
def get_value() -> UpdateEndpointRequestRequestTypeDef:
return {
"EndpointArn": ...,
}
Definition
class UpdateEndpointRequestRequestTypeDef(TypedDict):
EndpointArn: str,
DesiredModelArn: NotRequired[str],
DesiredInferenceUnits: NotRequired[int],
DesiredDataAccessRoleArn: NotRequired[str],
DocumentClassifierInputDataConfigTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DocumentClassifierInputDataConfigTypeDef
def get_value() -> DocumentClassifierInputDataConfigTypeDef:
return {
"DataFormat": ...,
}
Definition
class DocumentClassifierInputDataConfigTypeDef(TypedDict):
DataFormat: NotRequired[DocumentClassifierDataFormatType], # (1)
S3Uri: NotRequired[str],
TestS3Uri: NotRequired[str],
LabelDelimiter: NotRequired[str],
AugmentedManifests: NotRequired[Sequence[AugmentedManifestsListItemTypeDef]], # (2)
BatchDetectDominantLanguageItemResultTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageItemResultTypeDef
def get_value() -> BatchDetectDominantLanguageItemResultTypeDef:
return {
"Index": ...,
}
Definition
class BatchDetectDominantLanguageItemResultTypeDef(TypedDict):
Index: NotRequired[int],
Languages: NotRequired[List[DominantLanguageTypeDef]], # (1)
CreateDocumentClassifierResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import CreateDocumentClassifierResponseTypeDef
def get_value() -> CreateDocumentClassifierResponseTypeDef:
return {
"DocumentClassifierArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDocumentClassifierResponseTypeDef(TypedDict):
DocumentClassifierArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateEndpointResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import CreateEndpointResponseTypeDef
def get_value() -> CreateEndpointResponseTypeDef:
return {
"EndpointArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateEndpointResponseTypeDef(TypedDict):
EndpointArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateEntityRecognizerResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import CreateEntityRecognizerResponseTypeDef
def get_value() -> CreateEntityRecognizerResponseTypeDef:
return {
"EntityRecognizerArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateEntityRecognizerResponseTypeDef(TypedDict):
EntityRecognizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeResourcePolicyResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DescribeResourcePolicyResponseTypeDef
def get_value() -> DescribeResourcePolicyResponseTypeDef:
return {
"ResourcePolicy": ...,
"CreationTime": ...,
"LastModifiedTime": ...,
"PolicyRevisionId": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeResourcePolicyResponseTypeDef(TypedDict):
ResourcePolicy: str,
CreationTime: datetime,
LastModifiedTime: datetime,
PolicyRevisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DetectDominantLanguageResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import DetectDominantLanguageResponseTypeDef
def get_value() -> DetectDominantLanguageResponseTypeDef:
return {
"Languages": ...,
"ResponseMetadata": ...,
}
Definition
class DetectDominantLanguageResponseTypeDef(TypedDict):
Languages: List[DominantLanguageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportModelResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import ImportModelResponseTypeDef
def get_value() -> ImportModelResponseTypeDef:
return {
"ModelArn": ...,
"ResponseMetadata": ...,
}
Definition
class ImportModelResponseTypeDef(TypedDict):
ModelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutResourcePolicyResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import PutResourcePolicyResponseTypeDef
def get_value() -> PutResourcePolicyResponseTypeDef:
return {
"PolicyRevisionId": ...,
"ResponseMetadata": ...,
}
Definition
class PutResourcePolicyResponseTypeDef(TypedDict):
PolicyRevisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartDocumentClassificationJobResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StartDocumentClassificationJobResponseTypeDef
def get_value() -> StartDocumentClassificationJobResponseTypeDef:
return {
"JobId": ...,
"JobArn": ...,
"JobStatus": ...,
"ResponseMetadata": ...,
}
Definition
class StartDocumentClassificationJobResponseTypeDef(TypedDict):
JobId: str,
JobArn: str,
JobStatus: JobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
StartDominantLanguageDetectionJobResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StartDominantLanguageDetectionJobResponseTypeDef
def get_value() -> StartDominantLanguageDetectionJobResponseTypeDef:
return {
"JobId": ...,
"JobArn": ...,
"JobStatus": ...,
"ResponseMetadata": ...,
}
Definition
class StartDominantLanguageDetectionJobResponseTypeDef(TypedDict):
JobId: str,
JobArn: str,
JobStatus: JobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
StartEntitiesDetectionJobResponseTypeDef
Usage Example
from mypy_boto3_comprehend.type_defs import StartEntitiesDetectionJobResponseTypeDef
def get_value() -> StartEntitiesDetectionJobResponseTypeDef:
return {
"JobId": ...,
"JobArn": ...,
"JobStatus": ...,
"ResponseMetadata": ...,
}
Definition
class StartEntitiesDetectionJobResponseTypeDef(TypedDict):
JobId: str,
JobArn: str,
JobStatus: JobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef