Typed dictionaries#
Index > Rekognition > Typed dictionaries
Auto-generated documentation for Rekognition type annotations stubs module mypy-boto3-rekognition.
AgeRangeTypeDef#
# AgeRangeTypeDef usage example
from mypy_boto3_rekognition.type_defs import AgeRangeTypeDef
def get_value() -> AgeRangeTypeDef:
return {
"Low": ...,
}
# AgeRangeTypeDef definition
class AgeRangeTypeDef(TypedDict):
Low: NotRequired[int],
High: NotRequired[int],
AudioMetadataTypeDef#
# AudioMetadataTypeDef usage example
from mypy_boto3_rekognition.type_defs import AudioMetadataTypeDef
def get_value() -> AudioMetadataTypeDef:
return {
"Codec": ...,
}
# AudioMetadataTypeDef definition
class AudioMetadataTypeDef(TypedDict):
Codec: NotRequired[str],
DurationMillis: NotRequired[int],
SampleRate: NotRequired[int],
NumberOfChannels: NotRequired[int],
BoundingBoxTypeDef#
# BoundingBoxTypeDef usage example
from mypy_boto3_rekognition.type_defs import BoundingBoxTypeDef
def get_value() -> BoundingBoxTypeDef:
return {
"Width": ...,
}
# BoundingBoxTypeDef definition
class BoundingBoxTypeDef(TypedDict):
Width: NotRequired[float],
Height: NotRequired[float],
Left: NotRequired[float],
Top: NotRequired[float],
S3ObjectTypeDef#
# S3ObjectTypeDef usage example
from mypy_boto3_rekognition.type_defs import S3ObjectTypeDef
def get_value() -> S3ObjectTypeDef:
return {
"Bucket": ...,
}
# S3ObjectTypeDef definition
class S3ObjectTypeDef(TypedDict):
Bucket: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[str],
BeardTypeDef#
# BeardTypeDef usage example
from mypy_boto3_rekognition.type_defs import BeardTypeDef
def get_value() -> BeardTypeDef:
return {
"Value": ...,
}
# BeardTypeDef definition
class BeardTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
BlackFrameTypeDef#
# BlackFrameTypeDef usage example
from mypy_boto3_rekognition.type_defs import BlackFrameTypeDef
def get_value() -> BlackFrameTypeDef:
return {
"MaxPixelThreshold": ...,
}
# BlackFrameTypeDef definition
class BlackFrameTypeDef(TypedDict):
MaxPixelThreshold: NotRequired[float],
MinCoveragePercentage: NotRequired[float],
KnownGenderTypeDef#
# KnownGenderTypeDef usage example
from mypy_boto3_rekognition.type_defs import KnownGenderTypeDef
def get_value() -> KnownGenderTypeDef:
return {
"Type": ...,
}
# KnownGenderTypeDef definition
class KnownGenderTypeDef(TypedDict):
Type: NotRequired[KnownGenderTypeType], # (1)
EmotionTypeDef#
# EmotionTypeDef usage example
from mypy_boto3_rekognition.type_defs import EmotionTypeDef
def get_value() -> EmotionTypeDef:
return {
"Type": ...,
}
# EmotionTypeDef definition
class EmotionTypeDef(TypedDict):
Type: NotRequired[EmotionNameType], # (1)
Confidence: NotRequired[float],
- See EmotionNameType
ImageQualityTypeDef#
# ImageQualityTypeDef usage example
from mypy_boto3_rekognition.type_defs import ImageQualityTypeDef
def get_value() -> ImageQualityTypeDef:
return {
"Brightness": ...,
}
# ImageQualityTypeDef definition
class ImageQualityTypeDef(TypedDict):
Brightness: NotRequired[float],
Sharpness: NotRequired[float],
LandmarkTypeDef#
# LandmarkTypeDef usage example
from mypy_boto3_rekognition.type_defs import LandmarkTypeDef
def get_value() -> LandmarkTypeDef:
return {
"Type": ...,
}
# LandmarkTypeDef definition
class LandmarkTypeDef(TypedDict):
Type: NotRequired[LandmarkTypeType], # (1)
X: NotRequired[float],
Y: NotRequired[float],
- See LandmarkTypeType
PoseTypeDef#
# PoseTypeDef usage example
from mypy_boto3_rekognition.type_defs import PoseTypeDef
def get_value() -> PoseTypeDef:
return {
"Roll": ...,
}
# PoseTypeDef definition
class PoseTypeDef(TypedDict):
Roll: NotRequired[float],
Yaw: NotRequired[float],
Pitch: NotRequired[float],
SmileTypeDef#
# SmileTypeDef usage example
from mypy_boto3_rekognition.type_defs import SmileTypeDef
def get_value() -> SmileTypeDef:
return {
"Value": ...,
}
# SmileTypeDef definition
class SmileTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
ConnectedHomeSettingsForUpdateTypeDef#
# ConnectedHomeSettingsForUpdateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ConnectedHomeSettingsForUpdateTypeDef
def get_value() -> ConnectedHomeSettingsForUpdateTypeDef:
return {
"Labels": ...,
}
# ConnectedHomeSettingsForUpdateTypeDef definition
class ConnectedHomeSettingsForUpdateTypeDef(TypedDict):
Labels: NotRequired[Sequence[str]],
MinConfidence: NotRequired[float],
ConnectedHomeSettingsTypeDef#
# ConnectedHomeSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import ConnectedHomeSettingsTypeDef
def get_value() -> ConnectedHomeSettingsTypeDef:
return {
"Labels": ...,
}
# ConnectedHomeSettingsTypeDef definition
class ConnectedHomeSettingsTypeDef(TypedDict):
Labels: Sequence[str],
MinConfidence: NotRequired[float],
ModerationLabelTypeDef#
# ModerationLabelTypeDef usage example
from mypy_boto3_rekognition.type_defs import ModerationLabelTypeDef
def get_value() -> ModerationLabelTypeDef:
return {
"Confidence": ...,
}
# ModerationLabelTypeDef definition
class ModerationLabelTypeDef(TypedDict):
Confidence: NotRequired[float],
Name: NotRequired[str],
ParentName: NotRequired[str],
OutputConfigTypeDef#
# OutputConfigTypeDef usage example
from mypy_boto3_rekognition.type_defs import OutputConfigTypeDef
def get_value() -> OutputConfigTypeDef:
return {
"S3Bucket": ...,
}
# OutputConfigTypeDef definition
class OutputConfigTypeDef(TypedDict):
S3Bucket: NotRequired[str],
S3KeyPrefix: NotRequired[str],
CopyProjectVersionResponseTypeDef#
# CopyProjectVersionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CopyProjectVersionResponseTypeDef
def get_value() -> CopyProjectVersionResponseTypeDef:
return {
"ProjectVersionArn": ...,
"ResponseMetadata": ...,
}
# CopyProjectVersionResponseTypeDef definition
class CopyProjectVersionResponseTypeDef(TypedDict):
ProjectVersionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CoversBodyPartTypeDef#
# CoversBodyPartTypeDef usage example
from mypy_boto3_rekognition.type_defs import CoversBodyPartTypeDef
def get_value() -> CoversBodyPartTypeDef:
return {
"Confidence": ...,
}
# CoversBodyPartTypeDef definition
class CoversBodyPartTypeDef(TypedDict):
Confidence: NotRequired[float],
Value: NotRequired[bool],
CreateCollectionRequestRequestTypeDef#
# CreateCollectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateCollectionRequestRequestTypeDef
def get_value() -> CreateCollectionRequestRequestTypeDef:
return {
"CollectionId": ...,
}
# CreateCollectionRequestRequestTypeDef definition
class CreateCollectionRequestRequestTypeDef(TypedDict):
CollectionId: str,
Tags: NotRequired[Mapping[str, str]],
CreateCollectionResponseTypeDef#
# CreateCollectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateCollectionResponseTypeDef
def get_value() -> CreateCollectionResponseTypeDef:
return {
"StatusCode": ...,
"CollectionArn": ...,
"FaceModelVersion": ...,
"ResponseMetadata": ...,
}
# CreateCollectionResponseTypeDef definition
class CreateCollectionResponseTypeDef(TypedDict):
StatusCode: int,
CollectionArn: str,
FaceModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDatasetResponseTypeDef#
# CreateDatasetResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateDatasetResponseTypeDef
def get_value() -> CreateDatasetResponseTypeDef:
return {
"DatasetArn": ...,
"ResponseMetadata": ...,
}
# CreateDatasetResponseTypeDef definition
class CreateDatasetResponseTypeDef(TypedDict):
DatasetArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
LivenessOutputConfigTypeDef#
# LivenessOutputConfigTypeDef usage example
from mypy_boto3_rekognition.type_defs import LivenessOutputConfigTypeDef
def get_value() -> LivenessOutputConfigTypeDef:
return {
"S3Bucket": ...,
}
# LivenessOutputConfigTypeDef definition
class LivenessOutputConfigTypeDef(TypedDict):
S3Bucket: str,
S3KeyPrefix: NotRequired[str],
CreateFaceLivenessSessionResponseTypeDef#
# CreateFaceLivenessSessionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateFaceLivenessSessionResponseTypeDef
def get_value() -> CreateFaceLivenessSessionResponseTypeDef:
return {
"SessionId": ...,
"ResponseMetadata": ...,
}
# CreateFaceLivenessSessionResponseTypeDef definition
class CreateFaceLivenessSessionResponseTypeDef(TypedDict):
SessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProjectRequestRequestTypeDef#
# CreateProjectRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateProjectRequestRequestTypeDef
def get_value() -> CreateProjectRequestRequestTypeDef:
return {
"ProjectName": ...,
}
# CreateProjectRequestRequestTypeDef definition
class CreateProjectRequestRequestTypeDef(TypedDict):
ProjectName: str,
CreateProjectResponseTypeDef#
# CreateProjectResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateProjectResponseTypeDef
def get_value() -> CreateProjectResponseTypeDef:
return {
"ProjectArn": ...,
"ResponseMetadata": ...,
}
# CreateProjectResponseTypeDef definition
class CreateProjectResponseTypeDef(TypedDict):
ProjectArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProjectVersionResponseTypeDef#
# CreateProjectVersionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateProjectVersionResponseTypeDef
def get_value() -> CreateProjectVersionResponseTypeDef:
return {
"ProjectVersionArn": ...,
"ResponseMetadata": ...,
}
# CreateProjectVersionResponseTypeDef definition
class CreateProjectVersionResponseTypeDef(TypedDict):
ProjectVersionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StreamProcessorDataSharingPreferenceTypeDef#
# StreamProcessorDataSharingPreferenceTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorDataSharingPreferenceTypeDef
def get_value() -> StreamProcessorDataSharingPreferenceTypeDef:
return {
"OptIn": ...,
}
# StreamProcessorDataSharingPreferenceTypeDef definition
class StreamProcessorDataSharingPreferenceTypeDef(TypedDict):
OptIn: bool,
StreamProcessorNotificationChannelTypeDef#
# StreamProcessorNotificationChannelTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorNotificationChannelTypeDef
def get_value() -> StreamProcessorNotificationChannelTypeDef:
return {
"SNSTopicArn": ...,
}
# StreamProcessorNotificationChannelTypeDef definition
class StreamProcessorNotificationChannelTypeDef(TypedDict):
SNSTopicArn: str,
CreateStreamProcessorResponseTypeDef#
# CreateStreamProcessorResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateStreamProcessorResponseTypeDef
def get_value() -> CreateStreamProcessorResponseTypeDef:
return {
"StreamProcessorArn": ...,
"ResponseMetadata": ...,
}
# CreateStreamProcessorResponseTypeDef definition
class CreateStreamProcessorResponseTypeDef(TypedDict):
StreamProcessorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DatasetChangesTypeDef#
# DatasetChangesTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetChangesTypeDef
def get_value() -> DatasetChangesTypeDef:
return {
"GroundTruth": ...,
}
# DatasetChangesTypeDef definition
class DatasetChangesTypeDef(TypedDict):
GroundTruth: Union[str, bytes, IO[Any], StreamingBody],
DatasetStatsTypeDef#
# DatasetStatsTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetStatsTypeDef
def get_value() -> DatasetStatsTypeDef:
return {
"LabeledEntries": ...,
}
# DatasetStatsTypeDef definition
class DatasetStatsTypeDef(TypedDict):
LabeledEntries: NotRequired[int],
TotalEntries: NotRequired[int],
TotalLabels: NotRequired[int],
ErrorEntries: NotRequired[int],
DatasetLabelStatsTypeDef#
# DatasetLabelStatsTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetLabelStatsTypeDef
def get_value() -> DatasetLabelStatsTypeDef:
return {
"EntryCount": ...,
}
# DatasetLabelStatsTypeDef definition
class DatasetLabelStatsTypeDef(TypedDict):
EntryCount: NotRequired[int],
BoundingBoxCount: NotRequired[int],
DatasetMetadataTypeDef#
# DatasetMetadataTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetMetadataTypeDef
def get_value() -> DatasetMetadataTypeDef:
return {
"CreationTimestamp": ...,
}
# DatasetMetadataTypeDef definition
class DatasetMetadataTypeDef(TypedDict):
CreationTimestamp: NotRequired[datetime],
DatasetType: NotRequired[DatasetTypeType], # (1)
DatasetArn: NotRequired[str],
Status: NotRequired[DatasetStatusType], # (2)
StatusMessage: NotRequired[str],
StatusMessageCode: NotRequired[DatasetStatusMessageCodeType], # (3)
DeleteCollectionRequestRequestTypeDef#
# DeleteCollectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteCollectionRequestRequestTypeDef
def get_value() -> DeleteCollectionRequestRequestTypeDef:
return {
"CollectionId": ...,
}
# DeleteCollectionRequestRequestTypeDef definition
class DeleteCollectionRequestRequestTypeDef(TypedDict):
CollectionId: str,
DeleteCollectionResponseTypeDef#
# DeleteCollectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteCollectionResponseTypeDef
def get_value() -> DeleteCollectionResponseTypeDef:
return {
"StatusCode": ...,
"ResponseMetadata": ...,
}
# DeleteCollectionResponseTypeDef definition
class DeleteCollectionResponseTypeDef(TypedDict):
StatusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDatasetRequestRequestTypeDef#
# DeleteDatasetRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteDatasetRequestRequestTypeDef
def get_value() -> DeleteDatasetRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
# DeleteDatasetRequestRequestTypeDef definition
class DeleteDatasetRequestRequestTypeDef(TypedDict):
DatasetArn: str,
DeleteFacesRequestRequestTypeDef#
# DeleteFacesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteFacesRequestRequestTypeDef
def get_value() -> DeleteFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
"FaceIds": ...,
}
# DeleteFacesRequestRequestTypeDef definition
class DeleteFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
FaceIds: Sequence[str],
DeleteFacesResponseTypeDef#
# DeleteFacesResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteFacesResponseTypeDef
def get_value() -> DeleteFacesResponseTypeDef:
return {
"DeletedFaces": ...,
"ResponseMetadata": ...,
}
# DeleteFacesResponseTypeDef definition
class DeleteFacesResponseTypeDef(TypedDict):
DeletedFaces: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProjectPolicyRequestRequestTypeDef#
# DeleteProjectPolicyRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteProjectPolicyRequestRequestTypeDef
def get_value() -> DeleteProjectPolicyRequestRequestTypeDef:
return {
"ProjectArn": ...,
"PolicyName": ...,
}
# DeleteProjectPolicyRequestRequestTypeDef definition
class DeleteProjectPolicyRequestRequestTypeDef(TypedDict):
ProjectArn: str,
PolicyName: str,
PolicyRevisionId: NotRequired[str],
DeleteProjectRequestRequestTypeDef#
# DeleteProjectRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteProjectRequestRequestTypeDef
def get_value() -> DeleteProjectRequestRequestTypeDef:
return {
"ProjectArn": ...,
}
# DeleteProjectRequestRequestTypeDef definition
class DeleteProjectRequestRequestTypeDef(TypedDict):
ProjectArn: str,
DeleteProjectResponseTypeDef#
# DeleteProjectResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteProjectResponseTypeDef
def get_value() -> DeleteProjectResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
# DeleteProjectResponseTypeDef definition
class DeleteProjectResponseTypeDef(TypedDict):
Status: ProjectStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteProjectVersionRequestRequestTypeDef#
# DeleteProjectVersionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteProjectVersionRequestRequestTypeDef
def get_value() -> DeleteProjectVersionRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
}
# DeleteProjectVersionRequestRequestTypeDef definition
class DeleteProjectVersionRequestRequestTypeDef(TypedDict):
ProjectVersionArn: str,
DeleteProjectVersionResponseTypeDef#
# DeleteProjectVersionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteProjectVersionResponseTypeDef
def get_value() -> DeleteProjectVersionResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
# DeleteProjectVersionResponseTypeDef definition
class DeleteProjectVersionResponseTypeDef(TypedDict):
Status: ProjectVersionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteStreamProcessorRequestRequestTypeDef#
# DeleteStreamProcessorRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DeleteStreamProcessorRequestRequestTypeDef
def get_value() -> DeleteStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
# DeleteStreamProcessorRequestRequestTypeDef definition
class DeleteStreamProcessorRequestRequestTypeDef(TypedDict):
Name: str,
DescribeCollectionRequestRequestTypeDef#
# DescribeCollectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeCollectionRequestRequestTypeDef
def get_value() -> DescribeCollectionRequestRequestTypeDef:
return {
"CollectionId": ...,
}
# DescribeCollectionRequestRequestTypeDef definition
class DescribeCollectionRequestRequestTypeDef(TypedDict):
CollectionId: str,
DescribeCollectionResponseTypeDef#
# DescribeCollectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeCollectionResponseTypeDef
def get_value() -> DescribeCollectionResponseTypeDef:
return {
"FaceCount": ...,
"FaceModelVersion": ...,
"CollectionARN": ...,
"CreationTimestamp": ...,
"ResponseMetadata": ...,
}
# DescribeCollectionResponseTypeDef definition
class DescribeCollectionResponseTypeDef(TypedDict):
FaceCount: int,
FaceModelVersion: str,
CollectionARN: str,
CreationTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeDatasetRequestRequestTypeDef#
# DescribeDatasetRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeDatasetRequestRequestTypeDef
def get_value() -> DescribeDatasetRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
# DescribeDatasetRequestRequestTypeDef definition
class DescribeDatasetRequestRequestTypeDef(TypedDict):
DatasetArn: str,
DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef#
# DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef
def get_value() -> DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef:
return {
"ProjectArn": ...,
}
# DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef definition
class DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
WaiterConfigTypeDef#
# WaiterConfigTypeDef usage example
from mypy_boto3_rekognition.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeProjectVersionsRequestRequestTypeDef#
# DescribeProjectVersionsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestRequestTypeDef
def get_value() -> DescribeProjectVersionsRequestRequestTypeDef:
return {
"ProjectArn": ...,
}
# DescribeProjectVersionsRequestRequestTypeDef definition
class DescribeProjectVersionsRequestRequestTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeProjectsRequestDescribeProjectsPaginateTypeDef#
# DescribeProjectsRequestDescribeProjectsPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectsRequestDescribeProjectsPaginateTypeDef
def get_value() -> DescribeProjectsRequestDescribeProjectsPaginateTypeDef:
return {
"ProjectNames": ...,
}
# DescribeProjectsRequestDescribeProjectsPaginateTypeDef definition
class DescribeProjectsRequestDescribeProjectsPaginateTypeDef(TypedDict):
ProjectNames: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeProjectsRequestRequestTypeDef#
# DescribeProjectsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectsRequestRequestTypeDef
def get_value() -> DescribeProjectsRequestRequestTypeDef:
return {
"NextToken": ...,
}
# DescribeProjectsRequestRequestTypeDef definition
class DescribeProjectsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProjectNames: NotRequired[Sequence[str]],
DescribeStreamProcessorRequestRequestTypeDef#
# DescribeStreamProcessorRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeStreamProcessorRequestRequestTypeDef
def get_value() -> DescribeStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
# DescribeStreamProcessorRequestRequestTypeDef definition
class DescribeStreamProcessorRequestRequestTypeDef(TypedDict):
Name: str,
DetectLabelsImageQualityTypeDef#
# DetectLabelsImageQualityTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsImageQualityTypeDef
def get_value() -> DetectLabelsImageQualityTypeDef:
return {
"Brightness": ...,
}
# DetectLabelsImageQualityTypeDef definition
class DetectLabelsImageQualityTypeDef(TypedDict):
Brightness: NotRequired[float],
Sharpness: NotRequired[float],
Contrast: NotRequired[float],
DominantColorTypeDef#
# DominantColorTypeDef usage example
from mypy_boto3_rekognition.type_defs import DominantColorTypeDef
def get_value() -> DominantColorTypeDef:
return {
"Red": ...,
}
# DominantColorTypeDef definition
class DominantColorTypeDef(TypedDict):
Red: NotRequired[int],
Blue: NotRequired[int],
Green: NotRequired[int],
HexCode: NotRequired[str],
CSSColor: NotRequired[str],
SimplifiedColor: NotRequired[str],
PixelPercent: NotRequired[float],
DetectLabelsImagePropertiesSettingsTypeDef#
# DetectLabelsImagePropertiesSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsImagePropertiesSettingsTypeDef
def get_value() -> DetectLabelsImagePropertiesSettingsTypeDef:
return {
"MaxDominantColors": ...,
}
# DetectLabelsImagePropertiesSettingsTypeDef definition
class DetectLabelsImagePropertiesSettingsTypeDef(TypedDict):
MaxDominantColors: NotRequired[int],
GeneralLabelsSettingsTypeDef#
# GeneralLabelsSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import GeneralLabelsSettingsTypeDef
def get_value() -> GeneralLabelsSettingsTypeDef:
return {
"LabelInclusionFilters": ...,
}
# GeneralLabelsSettingsTypeDef definition
class GeneralLabelsSettingsTypeDef(TypedDict):
LabelInclusionFilters: NotRequired[Sequence[str]],
LabelExclusionFilters: NotRequired[Sequence[str]],
LabelCategoryInclusionFilters: NotRequired[Sequence[str]],
LabelCategoryExclusionFilters: NotRequired[Sequence[str]],
HumanLoopActivationOutputTypeDef#
# HumanLoopActivationOutputTypeDef usage example
from mypy_boto3_rekognition.type_defs import HumanLoopActivationOutputTypeDef
def get_value() -> HumanLoopActivationOutputTypeDef:
return {
"HumanLoopArn": ...,
}
# HumanLoopActivationOutputTypeDef definition
class HumanLoopActivationOutputTypeDef(TypedDict):
HumanLoopArn: NotRequired[str],
HumanLoopActivationReasons: NotRequired[List[str]],
HumanLoopActivationConditionsEvaluationResults: NotRequired[str],
ProtectiveEquipmentSummarizationAttributesTypeDef#
# ProtectiveEquipmentSummarizationAttributesTypeDef usage example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentSummarizationAttributesTypeDef
def get_value() -> ProtectiveEquipmentSummarizationAttributesTypeDef:
return {
"MinConfidence": ...,
"RequiredEquipmentTypes": ...,
}
# ProtectiveEquipmentSummarizationAttributesTypeDef definition
class ProtectiveEquipmentSummarizationAttributesTypeDef(TypedDict):
MinConfidence: float,
RequiredEquipmentTypes: Sequence[ProtectiveEquipmentTypeType], # (1)
ProtectiveEquipmentSummaryTypeDef#
# ProtectiveEquipmentSummaryTypeDef usage example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentSummaryTypeDef
def get_value() -> ProtectiveEquipmentSummaryTypeDef:
return {
"PersonsWithRequiredEquipment": ...,
}
# ProtectiveEquipmentSummaryTypeDef definition
class ProtectiveEquipmentSummaryTypeDef(TypedDict):
PersonsWithRequiredEquipment: NotRequired[List[int]],
PersonsWithoutRequiredEquipment: NotRequired[List[int]],
PersonsIndeterminate: NotRequired[List[int]],
DetectionFilterTypeDef#
# DetectionFilterTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectionFilterTypeDef
def get_value() -> DetectionFilterTypeDef:
return {
"MinConfidence": ...,
}
# DetectionFilterTypeDef definition
class DetectionFilterTypeDef(TypedDict):
MinConfidence: NotRequired[float],
MinBoundingBoxHeight: NotRequired[float],
MinBoundingBoxWidth: NotRequired[float],
DistributeDatasetTypeDef#
# DistributeDatasetTypeDef usage example
from mypy_boto3_rekognition.type_defs import DistributeDatasetTypeDef
def get_value() -> DistributeDatasetTypeDef:
return {
"Arn": ...,
}
# DistributeDatasetTypeDef definition
class DistributeDatasetTypeDef(TypedDict):
Arn: str,
EyeDirectionTypeDef#
# EyeDirectionTypeDef usage example
from mypy_boto3_rekognition.type_defs import EyeDirectionTypeDef
def get_value() -> EyeDirectionTypeDef:
return {
"Yaw": ...,
}
# EyeDirectionTypeDef definition
class EyeDirectionTypeDef(TypedDict):
Yaw: NotRequired[float],
Pitch: NotRequired[float],
Confidence: NotRequired[float],
EyeOpenTypeDef#
# EyeOpenTypeDef usage example
from mypy_boto3_rekognition.type_defs import EyeOpenTypeDef
def get_value() -> EyeOpenTypeDef:
return {
"Value": ...,
}
# EyeOpenTypeDef definition
class EyeOpenTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
EyeglassesTypeDef#
# EyeglassesTypeDef usage example
from mypy_boto3_rekognition.type_defs import EyeglassesTypeDef
def get_value() -> EyeglassesTypeDef:
return {
"Value": ...,
}
# EyeglassesTypeDef definition
class EyeglassesTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
FaceOccludedTypeDef#
# FaceOccludedTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceOccludedTypeDef
def get_value() -> FaceOccludedTypeDef:
return {
"Value": ...,
}
# FaceOccludedTypeDef definition
class FaceOccludedTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
GenderTypeDef#
# GenderTypeDef usage example
from mypy_boto3_rekognition.type_defs import GenderTypeDef
def get_value() -> GenderTypeDef:
return {
"Value": ...,
}
# GenderTypeDef definition
class GenderTypeDef(TypedDict):
Value: NotRequired[GenderTypeType], # (1)
Confidence: NotRequired[float],
- See GenderTypeType
MouthOpenTypeDef#
# MouthOpenTypeDef usage example
from mypy_boto3_rekognition.type_defs import MouthOpenTypeDef
def get_value() -> MouthOpenTypeDef:
return {
"Value": ...,
}
# MouthOpenTypeDef definition
class MouthOpenTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
MustacheTypeDef#
# MustacheTypeDef usage example
from mypy_boto3_rekognition.type_defs import MustacheTypeDef
def get_value() -> MustacheTypeDef:
return {
"Value": ...,
}
# MustacheTypeDef definition
class MustacheTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
SunglassesTypeDef#
# SunglassesTypeDef usage example
from mypy_boto3_rekognition.type_defs import SunglassesTypeDef
def get_value() -> SunglassesTypeDef:
return {
"Value": ...,
}
# SunglassesTypeDef definition
class SunglassesTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
FaceSearchSettingsTypeDef#
# FaceSearchSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceSearchSettingsTypeDef
def get_value() -> FaceSearchSettingsTypeDef:
return {
"CollectionId": ...,
}
# FaceSearchSettingsTypeDef definition
class FaceSearchSettingsTypeDef(TypedDict):
CollectionId: NotRequired[str],
FaceMatchThreshold: NotRequired[float],
PointTypeDef#
# PointTypeDef usage example
from mypy_boto3_rekognition.type_defs import PointTypeDef
def get_value() -> PointTypeDef:
return {
"X": ...,
}
# PointTypeDef definition
class PointTypeDef(TypedDict):
X: NotRequired[float],
Y: NotRequired[float],
GetCelebrityInfoRequestRequestTypeDef#
# GetCelebrityInfoRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetCelebrityInfoRequestRequestTypeDef
def get_value() -> GetCelebrityInfoRequestRequestTypeDef:
return {
"Id": ...,
}
# GetCelebrityInfoRequestRequestTypeDef definition
class GetCelebrityInfoRequestRequestTypeDef(TypedDict):
Id: str,
GetCelebrityRecognitionRequestRequestTypeDef#
# GetCelebrityRecognitionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetCelebrityRecognitionRequestRequestTypeDef
def get_value() -> GetCelebrityRecognitionRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetCelebrityRecognitionRequestRequestTypeDef definition
class GetCelebrityRecognitionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[CelebrityRecognitionSortByType], # (1)
VideoMetadataTypeDef#
# VideoMetadataTypeDef usage example
from mypy_boto3_rekognition.type_defs import VideoMetadataTypeDef
def get_value() -> VideoMetadataTypeDef:
return {
"Codec": ...,
}
# VideoMetadataTypeDef definition
class VideoMetadataTypeDef(TypedDict):
Codec: NotRequired[str],
DurationMillis: NotRequired[int],
Format: NotRequired[str],
FrameRate: NotRequired[float],
FrameHeight: NotRequired[int],
FrameWidth: NotRequired[int],
ColorRange: NotRequired[VideoColorRangeType], # (1)
GetContentModerationRequestMetadataTypeDef#
# GetContentModerationRequestMetadataTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetContentModerationRequestMetadataTypeDef
def get_value() -> GetContentModerationRequestMetadataTypeDef:
return {
"SortBy": ...,
}
# GetContentModerationRequestMetadataTypeDef definition
class GetContentModerationRequestMetadataTypeDef(TypedDict):
SortBy: NotRequired[ContentModerationSortByType], # (1)
AggregateBy: NotRequired[ContentModerationAggregateByType], # (2)
GetContentModerationRequestRequestTypeDef#
# GetContentModerationRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetContentModerationRequestRequestTypeDef
def get_value() -> GetContentModerationRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetContentModerationRequestRequestTypeDef definition
class GetContentModerationRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[ContentModerationSortByType], # (1)
AggregateBy: NotRequired[ContentModerationAggregateByType], # (2)
GetFaceDetectionRequestRequestTypeDef#
# GetFaceDetectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetFaceDetectionRequestRequestTypeDef
def get_value() -> GetFaceDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetFaceDetectionRequestRequestTypeDef definition
class GetFaceDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetFaceLivenessSessionResultsRequestRequestTypeDef#
# GetFaceLivenessSessionResultsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetFaceLivenessSessionResultsRequestRequestTypeDef
def get_value() -> GetFaceLivenessSessionResultsRequestRequestTypeDef:
return {
"SessionId": ...,
}
# GetFaceLivenessSessionResultsRequestRequestTypeDef definition
class GetFaceLivenessSessionResultsRequestRequestTypeDef(TypedDict):
SessionId: str,
GetFaceSearchRequestRequestTypeDef#
# GetFaceSearchRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetFaceSearchRequestRequestTypeDef
def get_value() -> GetFaceSearchRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetFaceSearchRequestRequestTypeDef definition
class GetFaceSearchRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[FaceSearchSortByType], # (1)
GetLabelDetectionRequestMetadataTypeDef#
# GetLabelDetectionRequestMetadataTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetLabelDetectionRequestMetadataTypeDef
def get_value() -> GetLabelDetectionRequestMetadataTypeDef:
return {
"SortBy": ...,
}
# GetLabelDetectionRequestMetadataTypeDef definition
class GetLabelDetectionRequestMetadataTypeDef(TypedDict):
SortBy: NotRequired[LabelDetectionSortByType], # (1)
AggregateBy: NotRequired[LabelDetectionAggregateByType], # (2)
GetLabelDetectionRequestRequestTypeDef#
# GetLabelDetectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetLabelDetectionRequestRequestTypeDef
def get_value() -> GetLabelDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetLabelDetectionRequestRequestTypeDef definition
class GetLabelDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[LabelDetectionSortByType], # (1)
AggregateBy: NotRequired[LabelDetectionAggregateByType], # (2)
GetPersonTrackingRequestRequestTypeDef#
# GetPersonTrackingRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetPersonTrackingRequestRequestTypeDef
def get_value() -> GetPersonTrackingRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetPersonTrackingRequestRequestTypeDef definition
class GetPersonTrackingRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[PersonTrackingSortByType], # (1)
GetSegmentDetectionRequestRequestTypeDef#
# GetSegmentDetectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetSegmentDetectionRequestRequestTypeDef
def get_value() -> GetSegmentDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetSegmentDetectionRequestRequestTypeDef definition
class GetSegmentDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SegmentTypeInfoTypeDef#
# SegmentTypeInfoTypeDef usage example
from mypy_boto3_rekognition.type_defs import SegmentTypeInfoTypeDef
def get_value() -> SegmentTypeInfoTypeDef:
return {
"Type": ...,
}
# SegmentTypeInfoTypeDef definition
class SegmentTypeInfoTypeDef(TypedDict):
Type: NotRequired[SegmentTypeType], # (1)
ModelVersion: NotRequired[str],
- See SegmentTypeType
GetTextDetectionRequestRequestTypeDef#
# GetTextDetectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetTextDetectionRequestRequestTypeDef
def get_value() -> GetTextDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetTextDetectionRequestRequestTypeDef definition
class GetTextDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
HumanLoopDataAttributesTypeDef#
# HumanLoopDataAttributesTypeDef usage example
from mypy_boto3_rekognition.type_defs import HumanLoopDataAttributesTypeDef
def get_value() -> HumanLoopDataAttributesTypeDef:
return {
"ContentClassifiers": ...,
}
# HumanLoopDataAttributesTypeDef definition
class HumanLoopDataAttributesTypeDef(TypedDict):
ContentClassifiers: NotRequired[Sequence[ContentClassifierType]], # (1)
KinesisDataStreamTypeDef#
# KinesisDataStreamTypeDef usage example
from mypy_boto3_rekognition.type_defs import KinesisDataStreamTypeDef
def get_value() -> KinesisDataStreamTypeDef:
return {
"Arn": ...,
}
# KinesisDataStreamTypeDef definition
class KinesisDataStreamTypeDef(TypedDict):
Arn: NotRequired[str],
KinesisVideoStreamStartSelectorTypeDef#
# KinesisVideoStreamStartSelectorTypeDef usage example
from mypy_boto3_rekognition.type_defs import KinesisVideoStreamStartSelectorTypeDef
def get_value() -> KinesisVideoStreamStartSelectorTypeDef:
return {
"ProducerTimestamp": ...,
}
# KinesisVideoStreamStartSelectorTypeDef definition
class KinesisVideoStreamStartSelectorTypeDef(TypedDict):
ProducerTimestamp: NotRequired[int],
FragmentNumber: NotRequired[str],
KinesisVideoStreamTypeDef#
# KinesisVideoStreamTypeDef usage example
from mypy_boto3_rekognition.type_defs import KinesisVideoStreamTypeDef
def get_value() -> KinesisVideoStreamTypeDef:
return {
"Arn": ...,
}
# KinesisVideoStreamTypeDef definition
class KinesisVideoStreamTypeDef(TypedDict):
Arn: NotRequired[str],
LabelAliasTypeDef#
# LabelAliasTypeDef usage example
from mypy_boto3_rekognition.type_defs import LabelAliasTypeDef
def get_value() -> LabelAliasTypeDef:
return {
"Name": ...,
}
# LabelAliasTypeDef definition
class LabelAliasTypeDef(TypedDict):
Name: NotRequired[str],
LabelCategoryTypeDef#
# LabelCategoryTypeDef usage example
from mypy_boto3_rekognition.type_defs import LabelCategoryTypeDef
def get_value() -> LabelCategoryTypeDef:
return {
"Name": ...,
}
# LabelCategoryTypeDef definition
class LabelCategoryTypeDef(TypedDict):
Name: NotRequired[str],
ParentTypeDef#
# ParentTypeDef usage example
from mypy_boto3_rekognition.type_defs import ParentTypeDef
def get_value() -> ParentTypeDef:
return {
"Name": ...,
}
# ParentTypeDef definition
class ParentTypeDef(TypedDict):
Name: NotRequired[str],
ListCollectionsRequestListCollectionsPaginateTypeDef#
# ListCollectionsRequestListCollectionsPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListCollectionsRequestListCollectionsPaginateTypeDef
def get_value() -> ListCollectionsRequestListCollectionsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListCollectionsRequestListCollectionsPaginateTypeDef definition
class ListCollectionsRequestListCollectionsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCollectionsRequestRequestTypeDef#
# ListCollectionsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListCollectionsRequestRequestTypeDef
def get_value() -> ListCollectionsRequestRequestTypeDef:
return {
"NextToken": ...,
}
# ListCollectionsRequestRequestTypeDef definition
class ListCollectionsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListCollectionsResponseTypeDef#
# ListCollectionsResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListCollectionsResponseTypeDef
def get_value() -> ListCollectionsResponseTypeDef:
return {
"CollectionIds": ...,
"NextToken": ...,
"FaceModelVersions": ...,
"ResponseMetadata": ...,
}
# ListCollectionsResponseTypeDef definition
class ListCollectionsResponseTypeDef(TypedDict):
CollectionIds: List[str],
NextToken: str,
FaceModelVersions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef#
# ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef
def get_value() -> ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef:
return {
"DatasetArn": ...,
}
# ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef definition
class ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef(TypedDict):
DatasetArn: str,
ContainsLabels: NotRequired[Sequence[str]],
Labeled: NotRequired[bool],
SourceRefContains: NotRequired[str],
HasErrors: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatasetEntriesRequestRequestTypeDef#
# ListDatasetEntriesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListDatasetEntriesRequestRequestTypeDef
def get_value() -> ListDatasetEntriesRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
# ListDatasetEntriesRequestRequestTypeDef definition
class ListDatasetEntriesRequestRequestTypeDef(TypedDict):
DatasetArn: str,
ContainsLabels: NotRequired[Sequence[str]],
Labeled: NotRequired[bool],
SourceRefContains: NotRequired[str],
HasErrors: NotRequired[bool],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDatasetEntriesResponseTypeDef#
# ListDatasetEntriesResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListDatasetEntriesResponseTypeDef
def get_value() -> ListDatasetEntriesResponseTypeDef:
return {
"DatasetEntries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListDatasetEntriesResponseTypeDef definition
class ListDatasetEntriesResponseTypeDef(TypedDict):
DatasetEntries: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef#
# ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef
def get_value() -> ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef:
return {
"DatasetArn": ...,
}
# ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef definition
class ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef(TypedDict):
DatasetArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatasetLabelsRequestRequestTypeDef#
# ListDatasetLabelsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListDatasetLabelsRequestRequestTypeDef
def get_value() -> ListDatasetLabelsRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
# ListDatasetLabelsRequestRequestTypeDef definition
class ListDatasetLabelsRequestRequestTypeDef(TypedDict):
DatasetArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListFacesRequestListFacesPaginateTypeDef#
# ListFacesRequestListFacesPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListFacesRequestListFacesPaginateTypeDef
def get_value() -> ListFacesRequestListFacesPaginateTypeDef:
return {
"CollectionId": ...,
}
# ListFacesRequestListFacesPaginateTypeDef definition
class ListFacesRequestListFacesPaginateTypeDef(TypedDict):
CollectionId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFacesRequestRequestTypeDef#
# ListFacesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListFacesRequestRequestTypeDef
def get_value() -> ListFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
}
# ListFacesRequestRequestTypeDef definition
class ListFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef#
# ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef
def get_value() -> ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef:
return {
"ProjectArn": ...,
}
# ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef definition
class ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef(TypedDict):
ProjectArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProjectPoliciesRequestRequestTypeDef#
# ListProjectPoliciesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListProjectPoliciesRequestRequestTypeDef
def get_value() -> ListProjectPoliciesRequestRequestTypeDef:
return {
"ProjectArn": ...,
}
# ListProjectPoliciesRequestRequestTypeDef definition
class ListProjectPoliciesRequestRequestTypeDef(TypedDict):
ProjectArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProjectPolicyTypeDef#
# ProjectPolicyTypeDef usage example
from mypy_boto3_rekognition.type_defs import ProjectPolicyTypeDef
def get_value() -> ProjectPolicyTypeDef:
return {
"ProjectArn": ...,
}
# ProjectPolicyTypeDef definition
class ProjectPolicyTypeDef(TypedDict):
ProjectArn: NotRequired[str],
PolicyName: NotRequired[str],
PolicyRevisionId: NotRequired[str],
PolicyDocument: NotRequired[str],
CreationTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef#
# ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef
def get_value() -> ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef definition
class ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamProcessorsRequestRequestTypeDef#
# ListStreamProcessorsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListStreamProcessorsRequestRequestTypeDef
def get_value() -> ListStreamProcessorsRequestRequestTypeDef:
return {
"NextToken": ...,
}
# ListStreamProcessorsRequestRequestTypeDef definition
class ListStreamProcessorsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StreamProcessorTypeDef#
# StreamProcessorTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorTypeDef
def get_value() -> StreamProcessorTypeDef:
return {
"Name": ...,
}
# StreamProcessorTypeDef definition
class StreamProcessorTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[StreamProcessorStatusType], # (1)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NotificationChannelTypeDef#
# NotificationChannelTypeDef usage example
from mypy_boto3_rekognition.type_defs import NotificationChannelTypeDef
def get_value() -> NotificationChannelTypeDef:
return {
"SNSTopicArn": ...,
"RoleArn": ...,
}
# NotificationChannelTypeDef definition
class NotificationChannelTypeDef(TypedDict):
SNSTopicArn: str,
RoleArn: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_rekognition.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
PutProjectPolicyRequestRequestTypeDef#
# PutProjectPolicyRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import PutProjectPolicyRequestRequestTypeDef
def get_value() -> PutProjectPolicyRequestRequestTypeDef:
return {
"ProjectArn": ...,
"PolicyName": ...,
"PolicyDocument": ...,
}
# PutProjectPolicyRequestRequestTypeDef definition
class PutProjectPolicyRequestRequestTypeDef(TypedDict):
ProjectArn: str,
PolicyName: str,
PolicyDocument: str,
PolicyRevisionId: NotRequired[str],
PutProjectPolicyResponseTypeDef#
# PutProjectPolicyResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import PutProjectPolicyResponseTypeDef
def get_value() -> PutProjectPolicyResponseTypeDef:
return {
"PolicyRevisionId": ...,
"ResponseMetadata": ...,
}
# PutProjectPolicyResponseTypeDef definition
class PutProjectPolicyResponseTypeDef(TypedDict):
PolicyRevisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_rekognition.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
S3DestinationTypeDef#
# S3DestinationTypeDef usage example
from mypy_boto3_rekognition.type_defs import S3DestinationTypeDef
def get_value() -> S3DestinationTypeDef:
return {
"Bucket": ...,
}
# S3DestinationTypeDef definition
class S3DestinationTypeDef(TypedDict):
Bucket: NotRequired[str],
KeyPrefix: NotRequired[str],
SearchFacesRequestRequestTypeDef#
# SearchFacesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import SearchFacesRequestRequestTypeDef
def get_value() -> SearchFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
"FaceId": ...,
}
# SearchFacesRequestRequestTypeDef definition
class SearchFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
FaceId: str,
MaxFaces: NotRequired[int],
FaceMatchThreshold: NotRequired[float],
ShotSegmentTypeDef#
# ShotSegmentTypeDef usage example
from mypy_boto3_rekognition.type_defs import ShotSegmentTypeDef
def get_value() -> ShotSegmentTypeDef:
return {
"Index": ...,
}
# ShotSegmentTypeDef definition
class ShotSegmentTypeDef(TypedDict):
Index: NotRequired[int],
Confidence: NotRequired[float],
TechnicalCueSegmentTypeDef#
# TechnicalCueSegmentTypeDef usage example
from mypy_boto3_rekognition.type_defs import TechnicalCueSegmentTypeDef
def get_value() -> TechnicalCueSegmentTypeDef:
return {
"Type": ...,
}
# TechnicalCueSegmentTypeDef definition
class TechnicalCueSegmentTypeDef(TypedDict):
Type: NotRequired[TechnicalCueTypeType], # (1)
Confidence: NotRequired[float],
StartCelebrityRecognitionResponseTypeDef#
# StartCelebrityRecognitionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartCelebrityRecognitionResponseTypeDef
def get_value() -> StartCelebrityRecognitionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartCelebrityRecognitionResponseTypeDef definition
class StartCelebrityRecognitionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartContentModerationResponseTypeDef#
# StartContentModerationResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartContentModerationResponseTypeDef
def get_value() -> StartContentModerationResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartContentModerationResponseTypeDef definition
class StartContentModerationResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartFaceDetectionResponseTypeDef#
# StartFaceDetectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartFaceDetectionResponseTypeDef
def get_value() -> StartFaceDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartFaceDetectionResponseTypeDef definition
class StartFaceDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartFaceSearchResponseTypeDef#
# StartFaceSearchResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartFaceSearchResponseTypeDef
def get_value() -> StartFaceSearchResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartFaceSearchResponseTypeDef definition
class StartFaceSearchResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartLabelDetectionResponseTypeDef#
# StartLabelDetectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartLabelDetectionResponseTypeDef
def get_value() -> StartLabelDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartLabelDetectionResponseTypeDef definition
class StartLabelDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartPersonTrackingResponseTypeDef#
# StartPersonTrackingResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartPersonTrackingResponseTypeDef
def get_value() -> StartPersonTrackingResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartPersonTrackingResponseTypeDef definition
class StartPersonTrackingResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartProjectVersionRequestRequestTypeDef#
# StartProjectVersionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartProjectVersionRequestRequestTypeDef
def get_value() -> StartProjectVersionRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
"MinInferenceUnits": ...,
}
# StartProjectVersionRequestRequestTypeDef definition
class StartProjectVersionRequestRequestTypeDef(TypedDict):
ProjectVersionArn: str,
MinInferenceUnits: int,
MaxInferenceUnits: NotRequired[int],
StartProjectVersionResponseTypeDef#
# StartProjectVersionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartProjectVersionResponseTypeDef
def get_value() -> StartProjectVersionResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
# StartProjectVersionResponseTypeDef definition
class StartProjectVersionResponseTypeDef(TypedDict):
Status: ProjectVersionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartShotDetectionFilterTypeDef#
# StartShotDetectionFilterTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartShotDetectionFilterTypeDef
def get_value() -> StartShotDetectionFilterTypeDef:
return {
"MinSegmentConfidence": ...,
}
# StartShotDetectionFilterTypeDef definition
class StartShotDetectionFilterTypeDef(TypedDict):
MinSegmentConfidence: NotRequired[float],
StartSegmentDetectionResponseTypeDef#
# StartSegmentDetectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartSegmentDetectionResponseTypeDef
def get_value() -> StartSegmentDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartSegmentDetectionResponseTypeDef definition
class StartSegmentDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StreamProcessingStopSelectorTypeDef#
# StreamProcessingStopSelectorTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessingStopSelectorTypeDef
def get_value() -> StreamProcessingStopSelectorTypeDef:
return {
"MaxDurationInSeconds": ...,
}
# StreamProcessingStopSelectorTypeDef definition
class StreamProcessingStopSelectorTypeDef(TypedDict):
MaxDurationInSeconds: NotRequired[int],
StartStreamProcessorResponseTypeDef#
# StartStreamProcessorResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartStreamProcessorResponseTypeDef
def get_value() -> StartStreamProcessorResponseTypeDef:
return {
"SessionId": ...,
"ResponseMetadata": ...,
}
# StartStreamProcessorResponseTypeDef definition
class StartStreamProcessorResponseTypeDef(TypedDict):
SessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartTextDetectionResponseTypeDef#
# StartTextDetectionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartTextDetectionResponseTypeDef
def get_value() -> StartTextDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartTextDetectionResponseTypeDef definition
class StartTextDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StopProjectVersionRequestRequestTypeDef#
# StopProjectVersionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StopProjectVersionRequestRequestTypeDef
def get_value() -> StopProjectVersionRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
}
# StopProjectVersionRequestRequestTypeDef definition
class StopProjectVersionRequestRequestTypeDef(TypedDict):
ProjectVersionArn: str,
StopProjectVersionResponseTypeDef#
# StopProjectVersionResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import StopProjectVersionResponseTypeDef
def get_value() -> StopProjectVersionResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
# StopProjectVersionResponseTypeDef definition
class StopProjectVersionResponseTypeDef(TypedDict):
Status: ProjectVersionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopStreamProcessorRequestRequestTypeDef#
# StopStreamProcessorRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StopStreamProcessorRequestRequestTypeDef
def get_value() -> StopStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
# StopStreamProcessorRequestRequestTypeDef definition
class StopStreamProcessorRequestRequestTypeDef(TypedDict):
Name: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
ComparedSourceImageFaceTypeDef#
# ComparedSourceImageFaceTypeDef usage example
from mypy_boto3_rekognition.type_defs import ComparedSourceImageFaceTypeDef
def get_value() -> ComparedSourceImageFaceTypeDef:
return {
"BoundingBox": ...,
}
# ComparedSourceImageFaceTypeDef definition
class ComparedSourceImageFaceTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
FaceTypeDef#
# FaceTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceTypeDef
def get_value() -> FaceTypeDef:
return {
"FaceId": ...,
}
# FaceTypeDef definition
class FaceTypeDef(TypedDict):
FaceId: NotRequired[str],
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
ImageId: NotRequired[str],
ExternalImageId: NotRequired[str],
Confidence: NotRequired[float],
IndexFacesModelVersion: NotRequired[str],
AuditImageTypeDef#
# AuditImageTypeDef usage example
from mypy_boto3_rekognition.type_defs import AuditImageTypeDef
def get_value() -> AuditImageTypeDef:
return {
"Bytes": ...,
}
# AuditImageTypeDef definition
class AuditImageTypeDef(TypedDict):
Bytes: NotRequired[bytes],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
BoundingBox: NotRequired[BoundingBoxTypeDef], # (2)
- See S3ObjectTypeDef
- See BoundingBoxTypeDef
GroundTruthManifestTypeDef#
# GroundTruthManifestTypeDef usage example
from mypy_boto3_rekognition.type_defs import GroundTruthManifestTypeDef
def get_value() -> GroundTruthManifestTypeDef:
return {
"S3Object": ...,
}
# GroundTruthManifestTypeDef definition
class GroundTruthManifestTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
ImageTypeDef#
# ImageTypeDef usage example
from mypy_boto3_rekognition.type_defs import ImageTypeDef
def get_value() -> ImageTypeDef:
return {
"Bytes": ...,
}
# ImageTypeDef definition
class ImageTypeDef(TypedDict):
Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
SummaryTypeDef#
# SummaryTypeDef usage example
from mypy_boto3_rekognition.type_defs import SummaryTypeDef
def get_value() -> SummaryTypeDef:
return {
"S3Object": ...,
}
# SummaryTypeDef definition
class SummaryTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
VideoTypeDef#
# VideoTypeDef usage example
from mypy_boto3_rekognition.type_defs import VideoTypeDef
def get_value() -> VideoTypeDef:
return {
"S3Object": ...,
}
# VideoTypeDef definition
class VideoTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
StartTechnicalCueDetectionFilterTypeDef#
# StartTechnicalCueDetectionFilterTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartTechnicalCueDetectionFilterTypeDef
def get_value() -> StartTechnicalCueDetectionFilterTypeDef:
return {
"MinSegmentConfidence": ...,
}
# StartTechnicalCueDetectionFilterTypeDef definition
class StartTechnicalCueDetectionFilterTypeDef(TypedDict):
MinSegmentConfidence: NotRequired[float],
BlackFrame: NotRequired[BlackFrameTypeDef], # (1)
GetCelebrityInfoResponseTypeDef#
# GetCelebrityInfoResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetCelebrityInfoResponseTypeDef
def get_value() -> GetCelebrityInfoResponseTypeDef:
return {
"Urls": ...,
"Name": ...,
"KnownGender": ...,
"ResponseMetadata": ...,
}
# GetCelebrityInfoResponseTypeDef definition
class GetCelebrityInfoResponseTypeDef(TypedDict):
Urls: List[str],
Name: str,
KnownGender: KnownGenderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ComparedFaceTypeDef#
# ComparedFaceTypeDef usage example
from mypy_boto3_rekognition.type_defs import ComparedFaceTypeDef
def get_value() -> ComparedFaceTypeDef:
return {
"BoundingBox": ...,
}
# ComparedFaceTypeDef definition
class ComparedFaceTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
Landmarks: NotRequired[List[LandmarkTypeDef]], # (2)
Pose: NotRequired[PoseTypeDef], # (3)
Quality: NotRequired[ImageQualityTypeDef], # (4)
Emotions: NotRequired[List[EmotionTypeDef]], # (5)
Smile: NotRequired[SmileTypeDef], # (6)
- See BoundingBoxTypeDef
- See LandmarkTypeDef
- See PoseTypeDef
- See ImageQualityTypeDef
- See EmotionTypeDef
- See SmileTypeDef
StreamProcessorSettingsForUpdateTypeDef#
# StreamProcessorSettingsForUpdateTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorSettingsForUpdateTypeDef
def get_value() -> StreamProcessorSettingsForUpdateTypeDef:
return {
"ConnectedHomeForUpdate": ...,
}
# StreamProcessorSettingsForUpdateTypeDef definition
class StreamProcessorSettingsForUpdateTypeDef(TypedDict):
ConnectedHomeForUpdate: NotRequired[ConnectedHomeSettingsForUpdateTypeDef], # (1)
ContentModerationDetectionTypeDef#
# ContentModerationDetectionTypeDef usage example
from mypy_boto3_rekognition.type_defs import ContentModerationDetectionTypeDef
def get_value() -> ContentModerationDetectionTypeDef:
return {
"Timestamp": ...,
}
# ContentModerationDetectionTypeDef definition
class ContentModerationDetectionTypeDef(TypedDict):
Timestamp: NotRequired[int],
ModerationLabel: NotRequired[ModerationLabelTypeDef], # (1)
StartTimestampMillis: NotRequired[int],
EndTimestampMillis: NotRequired[int],
DurationMillis: NotRequired[int],
CopyProjectVersionRequestRequestTypeDef#
# CopyProjectVersionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import CopyProjectVersionRequestRequestTypeDef
def get_value() -> CopyProjectVersionRequestRequestTypeDef:
return {
"SourceProjectArn": ...,
"SourceProjectVersionArn": ...,
"DestinationProjectArn": ...,
"VersionName": ...,
"OutputConfig": ...,
}
# CopyProjectVersionRequestRequestTypeDef definition
class CopyProjectVersionRequestRequestTypeDef(TypedDict):
SourceProjectArn: str,
SourceProjectVersionArn: str,
DestinationProjectArn: str,
VersionName: str,
OutputConfig: OutputConfigTypeDef, # (1)
Tags: NotRequired[Mapping[str, str]],
KmsKeyId: NotRequired[str],
EquipmentDetectionTypeDef#
# EquipmentDetectionTypeDef usage example
from mypy_boto3_rekognition.type_defs import EquipmentDetectionTypeDef
def get_value() -> EquipmentDetectionTypeDef:
return {
"BoundingBox": ...,
}
# EquipmentDetectionTypeDef definition
class EquipmentDetectionTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
Type: NotRequired[ProtectiveEquipmentTypeType], # (2)
CoversBodyPart: NotRequired[CoversBodyPartTypeDef], # (3)
CreateFaceLivenessSessionRequestSettingsTypeDef#
# CreateFaceLivenessSessionRequestSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateFaceLivenessSessionRequestSettingsTypeDef
def get_value() -> CreateFaceLivenessSessionRequestSettingsTypeDef:
return {
"OutputConfig": ...,
}
# CreateFaceLivenessSessionRequestSettingsTypeDef definition
class CreateFaceLivenessSessionRequestSettingsTypeDef(TypedDict):
OutputConfig: NotRequired[LivenessOutputConfigTypeDef], # (1)
AuditImagesLimit: NotRequired[int],
UpdateDatasetEntriesRequestRequestTypeDef#
# UpdateDatasetEntriesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import UpdateDatasetEntriesRequestRequestTypeDef
def get_value() -> UpdateDatasetEntriesRequestRequestTypeDef:
return {
"DatasetArn": ...,
"Changes": ...,
}
# UpdateDatasetEntriesRequestRequestTypeDef definition
class UpdateDatasetEntriesRequestRequestTypeDef(TypedDict):
DatasetArn: str,
Changes: DatasetChangesTypeDef, # (1)
DatasetDescriptionTypeDef#
# DatasetDescriptionTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetDescriptionTypeDef
def get_value() -> DatasetDescriptionTypeDef:
return {
"CreationTimestamp": ...,
}
# DatasetDescriptionTypeDef definition
class DatasetDescriptionTypeDef(TypedDict):
CreationTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
Status: NotRequired[DatasetStatusType], # (1)
StatusMessage: NotRequired[str],
StatusMessageCode: NotRequired[DatasetStatusMessageCodeType], # (2)
DatasetStats: NotRequired[DatasetStatsTypeDef], # (3)
DatasetLabelDescriptionTypeDef#
# DatasetLabelDescriptionTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetLabelDescriptionTypeDef
def get_value() -> DatasetLabelDescriptionTypeDef:
return {
"LabelName": ...,
}
# DatasetLabelDescriptionTypeDef definition
class DatasetLabelDescriptionTypeDef(TypedDict):
LabelName: NotRequired[str],
LabelStats: NotRequired[DatasetLabelStatsTypeDef], # (1)
ProjectDescriptionTypeDef#
# ProjectDescriptionTypeDef usage example
from mypy_boto3_rekognition.type_defs import ProjectDescriptionTypeDef
def get_value() -> ProjectDescriptionTypeDef:
return {
"ProjectArn": ...,
}
# ProjectDescriptionTypeDef definition
class ProjectDescriptionTypeDef(TypedDict):
ProjectArn: NotRequired[str],
CreationTimestamp: NotRequired[datetime],
Status: NotRequired[ProjectStatusType], # (1)
Datasets: NotRequired[List[DatasetMetadataTypeDef]], # (2)
DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef#
# DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef
def get_value() -> DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef:
return {
"ProjectArn": ...,
}
# DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef definition
class DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef#
# DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef
def get_value() -> DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef:
return {
"ProjectArn": ...,
}
# DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef definition
class DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DetectLabelsImageBackgroundTypeDef#
# DetectLabelsImageBackgroundTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsImageBackgroundTypeDef
def get_value() -> DetectLabelsImageBackgroundTypeDef:
return {
"Quality": ...,
}
# DetectLabelsImageBackgroundTypeDef definition
class DetectLabelsImageBackgroundTypeDef(TypedDict):
Quality: NotRequired[DetectLabelsImageQualityTypeDef], # (1)
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
DetectLabelsImageForegroundTypeDef#
# DetectLabelsImageForegroundTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsImageForegroundTypeDef
def get_value() -> DetectLabelsImageForegroundTypeDef:
return {
"Quality": ...,
}
# DetectLabelsImageForegroundTypeDef definition
class DetectLabelsImageForegroundTypeDef(TypedDict):
Quality: NotRequired[DetectLabelsImageQualityTypeDef], # (1)
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
InstanceTypeDef#
# InstanceTypeDef usage example
from mypy_boto3_rekognition.type_defs import InstanceTypeDef
def get_value() -> InstanceTypeDef:
return {
"BoundingBox": ...,
}
# InstanceTypeDef definition
class InstanceTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
DetectLabelsSettingsTypeDef#
# DetectLabelsSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsSettingsTypeDef
def get_value() -> DetectLabelsSettingsTypeDef:
return {
"GeneralLabels": ...,
}
# DetectLabelsSettingsTypeDef definition
class DetectLabelsSettingsTypeDef(TypedDict):
GeneralLabels: NotRequired[GeneralLabelsSettingsTypeDef], # (1)
ImageProperties: NotRequired[DetectLabelsImagePropertiesSettingsTypeDef], # (2)
LabelDetectionSettingsTypeDef#
# LabelDetectionSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import LabelDetectionSettingsTypeDef
def get_value() -> LabelDetectionSettingsTypeDef:
return {
"GeneralLabels": ...,
}
# LabelDetectionSettingsTypeDef definition
class LabelDetectionSettingsTypeDef(TypedDict):
GeneralLabels: NotRequired[GeneralLabelsSettingsTypeDef], # (1)
DetectModerationLabelsResponseTypeDef#
# DetectModerationLabelsResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectModerationLabelsResponseTypeDef
def get_value() -> DetectModerationLabelsResponseTypeDef:
return {
"ModerationLabels": ...,
"ModerationModelVersion": ...,
"HumanLoopActivationOutput": ...,
"ResponseMetadata": ...,
}
# DetectModerationLabelsResponseTypeDef definition
class DetectModerationLabelsResponseTypeDef(TypedDict):
ModerationLabels: List[ModerationLabelTypeDef], # (1)
ModerationModelVersion: str,
HumanLoopActivationOutput: HumanLoopActivationOutputTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DistributeDatasetEntriesRequestRequestTypeDef#
# DistributeDatasetEntriesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DistributeDatasetEntriesRequestRequestTypeDef
def get_value() -> DistributeDatasetEntriesRequestRequestTypeDef:
return {
"Datasets": ...,
}
# DistributeDatasetEntriesRequestRequestTypeDef definition
class DistributeDatasetEntriesRequestRequestTypeDef(TypedDict):
Datasets: Sequence[DistributeDatasetTypeDef], # (1)
FaceDetailTypeDef#
# FaceDetailTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceDetailTypeDef
def get_value() -> FaceDetailTypeDef:
return {
"BoundingBox": ...,
}
# FaceDetailTypeDef definition
class FaceDetailTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
AgeRange: NotRequired[AgeRangeTypeDef], # (2)
Smile: NotRequired[SmileTypeDef], # (3)
Eyeglasses: NotRequired[EyeglassesTypeDef], # (4)
Sunglasses: NotRequired[SunglassesTypeDef], # (5)
Gender: NotRequired[GenderTypeDef], # (6)
Beard: NotRequired[BeardTypeDef], # (7)
Mustache: NotRequired[MustacheTypeDef], # (8)
EyesOpen: NotRequired[EyeOpenTypeDef], # (9)
MouthOpen: NotRequired[MouthOpenTypeDef], # (10)
Emotions: NotRequired[List[EmotionTypeDef]], # (11)
Landmarks: NotRequired[List[LandmarkTypeDef]], # (12)
Pose: NotRequired[PoseTypeDef], # (13)
Quality: NotRequired[ImageQualityTypeDef], # (14)
Confidence: NotRequired[float],
FaceOccluded: NotRequired[FaceOccludedTypeDef], # (15)
EyeDirection: NotRequired[EyeDirectionTypeDef], # (16)
- See BoundingBoxTypeDef
- See AgeRangeTypeDef
- See SmileTypeDef
- See EyeglassesTypeDef
- See SunglassesTypeDef
- See GenderTypeDef
- See BeardTypeDef
- See MustacheTypeDef
- See EyeOpenTypeDef
- See MouthOpenTypeDef
- See EmotionTypeDef
- See LandmarkTypeDef
- See PoseTypeDef
- See ImageQualityTypeDef
- See FaceOccludedTypeDef
- See EyeDirectionTypeDef
StreamProcessorSettingsTypeDef#
# StreamProcessorSettingsTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorSettingsTypeDef
def get_value() -> StreamProcessorSettingsTypeDef:
return {
"FaceSearch": ...,
}
# StreamProcessorSettingsTypeDef definition
class StreamProcessorSettingsTypeDef(TypedDict):
FaceSearch: NotRequired[FaceSearchSettingsTypeDef], # (1)
ConnectedHome: NotRequired[ConnectedHomeSettingsTypeDef], # (2)
GeometryTypeDef#
# GeometryTypeDef usage example
from mypy_boto3_rekognition.type_defs import GeometryTypeDef
def get_value() -> GeometryTypeDef:
return {
"BoundingBox": ...,
}
# GeometryTypeDef definition
class GeometryTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Polygon: NotRequired[List[PointTypeDef]], # (2)
- See BoundingBoxTypeDef
- See PointTypeDef
RegionOfInterestTypeDef#
# RegionOfInterestTypeDef usage example
from mypy_boto3_rekognition.type_defs import RegionOfInterestTypeDef
def get_value() -> RegionOfInterestTypeDef:
return {
"BoundingBox": ...,
}
# RegionOfInterestTypeDef definition
class RegionOfInterestTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Polygon: NotRequired[Sequence[PointTypeDef]], # (2)
- See BoundingBoxTypeDef
- See PointTypeDef
HumanLoopConfigTypeDef#
# HumanLoopConfigTypeDef usage example
from mypy_boto3_rekognition.type_defs import HumanLoopConfigTypeDef
def get_value() -> HumanLoopConfigTypeDef:
return {
"HumanLoopName": ...,
"FlowDefinitionArn": ...,
}
# HumanLoopConfigTypeDef definition
class HumanLoopConfigTypeDef(TypedDict):
HumanLoopName: str,
FlowDefinitionArn: str,
DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef], # (1)
StreamProcessingStartSelectorTypeDef#
# StreamProcessingStartSelectorTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessingStartSelectorTypeDef
def get_value() -> StreamProcessingStartSelectorTypeDef:
return {
"KVSStreamStartSelector": ...,
}
# StreamProcessingStartSelectorTypeDef definition
class StreamProcessingStartSelectorTypeDef(TypedDict):
KVSStreamStartSelector: NotRequired[KinesisVideoStreamStartSelectorTypeDef], # (1)
StreamProcessorInputTypeDef#
# StreamProcessorInputTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorInputTypeDef
def get_value() -> StreamProcessorInputTypeDef:
return {
"KinesisVideoStream": ...,
}
# StreamProcessorInputTypeDef definition
class StreamProcessorInputTypeDef(TypedDict):
KinesisVideoStream: NotRequired[KinesisVideoStreamTypeDef], # (1)
ListProjectPoliciesResponseTypeDef#
# ListProjectPoliciesResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListProjectPoliciesResponseTypeDef
def get_value() -> ListProjectPoliciesResponseTypeDef:
return {
"ProjectPolicies": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListProjectPoliciesResponseTypeDef definition
class ListProjectPoliciesResponseTypeDef(TypedDict):
ProjectPolicies: List[ProjectPolicyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamProcessorsResponseTypeDef#
# ListStreamProcessorsResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListStreamProcessorsResponseTypeDef
def get_value() -> ListStreamProcessorsResponseTypeDef:
return {
"NextToken": ...,
"StreamProcessors": ...,
"ResponseMetadata": ...,
}
# ListStreamProcessorsResponseTypeDef definition
class ListStreamProcessorsResponseTypeDef(TypedDict):
NextToken: str,
StreamProcessors: List[StreamProcessorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StreamProcessorOutputTypeDef#
# StreamProcessorOutputTypeDef usage example
from mypy_boto3_rekognition.type_defs import StreamProcessorOutputTypeDef
def get_value() -> StreamProcessorOutputTypeDef:
return {
"KinesisDataStream": ...,
}
# StreamProcessorOutputTypeDef definition
class StreamProcessorOutputTypeDef(TypedDict):
KinesisDataStream: NotRequired[KinesisDataStreamTypeDef], # (1)
S3Destination: NotRequired[S3DestinationTypeDef], # (2)
SegmentDetectionTypeDef#
# SegmentDetectionTypeDef usage example
from mypy_boto3_rekognition.type_defs import SegmentDetectionTypeDef
def get_value() -> SegmentDetectionTypeDef:
return {
"Type": ...,
}
# SegmentDetectionTypeDef definition
class SegmentDetectionTypeDef(TypedDict):
Type: NotRequired[SegmentTypeType], # (1)
StartTimestampMillis: NotRequired[int],
EndTimestampMillis: NotRequired[int],
DurationMillis: NotRequired[int],
StartTimecodeSMPTE: NotRequired[str],
EndTimecodeSMPTE: NotRequired[str],
DurationSMPTE: NotRequired[str],
TechnicalCueSegment: NotRequired[TechnicalCueSegmentTypeDef], # (2)
ShotSegment: NotRequired[ShotSegmentTypeDef], # (3)
StartFrameNumber: NotRequired[int],
EndFrameNumber: NotRequired[int],
DurationFrames: NotRequired[int],
FaceMatchTypeDef#
# FaceMatchTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceMatchTypeDef
def get_value() -> FaceMatchTypeDef:
return {
"Similarity": ...,
}
# FaceMatchTypeDef definition
class FaceMatchTypeDef(TypedDict):
Similarity: NotRequired[float],
Face: NotRequired[FaceTypeDef], # (1)
- See FaceTypeDef
ListFacesResponseTypeDef#
# ListFacesResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListFacesResponseTypeDef
def get_value() -> ListFacesResponseTypeDef:
return {
"Faces": ...,
"NextToken": ...,
"FaceModelVersion": ...,
"ResponseMetadata": ...,
}
# ListFacesResponseTypeDef definition
class ListFacesResponseTypeDef(TypedDict):
Faces: List[FaceTypeDef], # (1)
NextToken: str,
FaceModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See FaceTypeDef
- See ResponseMetadataTypeDef
GetFaceLivenessSessionResultsResponseTypeDef#
# GetFaceLivenessSessionResultsResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetFaceLivenessSessionResultsResponseTypeDef
def get_value() -> GetFaceLivenessSessionResultsResponseTypeDef:
return {
"SessionId": ...,
"Status": ...,
"Confidence": ...,
"ReferenceImage": ...,
"AuditImages": ...,
"ResponseMetadata": ...,
}
# GetFaceLivenessSessionResultsResponseTypeDef definition
class GetFaceLivenessSessionResultsResponseTypeDef(TypedDict):
SessionId: str,
Status: LivenessSessionStatusType, # (1)
Confidence: float,
ReferenceImage: AuditImageTypeDef, # (2)
AuditImages: List[AuditImageTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See LivenessSessionStatusType
- See AuditImageTypeDef
- See AuditImageTypeDef
- See ResponseMetadataTypeDef
AssetTypeDef#
# AssetTypeDef usage example
from mypy_boto3_rekognition.type_defs import AssetTypeDef
def get_value() -> AssetTypeDef:
return {
"GroundTruthManifest": ...,
}
# AssetTypeDef definition
class AssetTypeDef(TypedDict):
GroundTruthManifest: NotRequired[GroundTruthManifestTypeDef], # (1)
DatasetSourceTypeDef#
# DatasetSourceTypeDef usage example
from mypy_boto3_rekognition.type_defs import DatasetSourceTypeDef
def get_value() -> DatasetSourceTypeDef:
return {
"GroundTruthManifest": ...,
}
# DatasetSourceTypeDef definition
class DatasetSourceTypeDef(TypedDict):
GroundTruthManifest: NotRequired[GroundTruthManifestTypeDef], # (1)
DatasetArn: NotRequired[str],
CompareFacesRequestRequestTypeDef#
# CompareFacesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import CompareFacesRequestRequestTypeDef
def get_value() -> CompareFacesRequestRequestTypeDef:
return {
"SourceImage": ...,
"TargetImage": ...,
}
# CompareFacesRequestRequestTypeDef definition
class CompareFacesRequestRequestTypeDef(TypedDict):
SourceImage: ImageTypeDef, # (1)
TargetImage: ImageTypeDef, # (1)
SimilarityThreshold: NotRequired[float],
QualityFilter: NotRequired[QualityFilterType], # (3)
- See ImageTypeDef
- See ImageTypeDef
- See QualityFilterType
DetectCustomLabelsRequestRequestTypeDef#
# DetectCustomLabelsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectCustomLabelsRequestRequestTypeDef
def get_value() -> DetectCustomLabelsRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
"Image": ...,
}
# DetectCustomLabelsRequestRequestTypeDef definition
class DetectCustomLabelsRequestRequestTypeDef(TypedDict):
ProjectVersionArn: str,
Image: ImageTypeDef, # (1)
MaxResults: NotRequired[int],
MinConfidence: NotRequired[float],
- See ImageTypeDef
DetectFacesRequestRequestTypeDef#
# DetectFacesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectFacesRequestRequestTypeDef
def get_value() -> DetectFacesRequestRequestTypeDef:
return {
"Image": ...,
}
# DetectFacesRequestRequestTypeDef definition
class DetectFacesRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
Attributes: NotRequired[Sequence[AttributeType]], # (2)
- See ImageTypeDef
- See AttributeType
DetectProtectiveEquipmentRequestRequestTypeDef#
# DetectProtectiveEquipmentRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectProtectiveEquipmentRequestRequestTypeDef
def get_value() -> DetectProtectiveEquipmentRequestRequestTypeDef:
return {
"Image": ...,
}
# DetectProtectiveEquipmentRequestRequestTypeDef definition
class DetectProtectiveEquipmentRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
SummarizationAttributes: NotRequired[ProtectiveEquipmentSummarizationAttributesTypeDef], # (2)
IndexFacesRequestRequestTypeDef#
# IndexFacesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import IndexFacesRequestRequestTypeDef
def get_value() -> IndexFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
"Image": ...,
}
# IndexFacesRequestRequestTypeDef definition
class IndexFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
Image: ImageTypeDef, # (1)
ExternalImageId: NotRequired[str],
DetectionAttributes: NotRequired[Sequence[AttributeType]], # (2)
MaxFaces: NotRequired[int],
QualityFilter: NotRequired[QualityFilterType], # (3)
- See ImageTypeDef
- See AttributeType
- See QualityFilterType
RecognizeCelebritiesRequestRequestTypeDef#
# RecognizeCelebritiesRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import RecognizeCelebritiesRequestRequestTypeDef
def get_value() -> RecognizeCelebritiesRequestRequestTypeDef:
return {
"Image": ...,
}
# RecognizeCelebritiesRequestRequestTypeDef definition
class RecognizeCelebritiesRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
- See ImageTypeDef
SearchFacesByImageRequestRequestTypeDef#
# SearchFacesByImageRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import SearchFacesByImageRequestRequestTypeDef
def get_value() -> SearchFacesByImageRequestRequestTypeDef:
return {
"CollectionId": ...,
"Image": ...,
}
# SearchFacesByImageRequestRequestTypeDef definition
class SearchFacesByImageRequestRequestTypeDef(TypedDict):
CollectionId: str,
Image: ImageTypeDef, # (1)
MaxFaces: NotRequired[int],
FaceMatchThreshold: NotRequired[float],
QualityFilter: NotRequired[QualityFilterType], # (2)
- See ImageTypeDef
- See QualityFilterType
EvaluationResultTypeDef#
# EvaluationResultTypeDef usage example
from mypy_boto3_rekognition.type_defs import EvaluationResultTypeDef
def get_value() -> EvaluationResultTypeDef:
return {
"F1Score": ...,
}
# EvaluationResultTypeDef definition
class EvaluationResultTypeDef(TypedDict):
F1Score: NotRequired[float],
Summary: NotRequired[SummaryTypeDef], # (1)
- See SummaryTypeDef
StartCelebrityRecognitionRequestRequestTypeDef#
# StartCelebrityRecognitionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartCelebrityRecognitionRequestRequestTypeDef
def get_value() -> StartCelebrityRecognitionRequestRequestTypeDef:
return {
"Video": ...,
}
# StartCelebrityRecognitionRequestRequestTypeDef definition
class StartCelebrityRecognitionRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartContentModerationRequestRequestTypeDef#
# StartContentModerationRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartContentModerationRequestRequestTypeDef
def get_value() -> StartContentModerationRequestRequestTypeDef:
return {
"Video": ...,
}
# StartContentModerationRequestRequestTypeDef definition
class StartContentModerationRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
MinConfidence: NotRequired[float],
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartFaceDetectionRequestRequestTypeDef#
# StartFaceDetectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartFaceDetectionRequestRequestTypeDef
def get_value() -> StartFaceDetectionRequestRequestTypeDef:
return {
"Video": ...,
}
# StartFaceDetectionRequestRequestTypeDef definition
class StartFaceDetectionRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
FaceAttributes: NotRequired[FaceAttributesType], # (3)
JobTag: NotRequired[str],
- See VideoTypeDef
- See NotificationChannelTypeDef
- See FaceAttributesType
StartFaceSearchRequestRequestTypeDef#
# StartFaceSearchRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartFaceSearchRequestRequestTypeDef
def get_value() -> StartFaceSearchRequestRequestTypeDef:
return {
"Video": ...,
"CollectionId": ...,
}
# StartFaceSearchRequestRequestTypeDef definition
class StartFaceSearchRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
CollectionId: str,
ClientRequestToken: NotRequired[str],
FaceMatchThreshold: NotRequired[float],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartPersonTrackingRequestRequestTypeDef#
# StartPersonTrackingRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartPersonTrackingRequestRequestTypeDef
def get_value() -> StartPersonTrackingRequestRequestTypeDef:
return {
"Video": ...,
}
# StartPersonTrackingRequestRequestTypeDef definition
class StartPersonTrackingRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartSegmentDetectionFiltersTypeDef#
# StartSegmentDetectionFiltersTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartSegmentDetectionFiltersTypeDef
def get_value() -> StartSegmentDetectionFiltersTypeDef:
return {
"TechnicalCueFilter": ...,
}
# StartSegmentDetectionFiltersTypeDef definition
class StartSegmentDetectionFiltersTypeDef(TypedDict):
TechnicalCueFilter: NotRequired[StartTechnicalCueDetectionFilterTypeDef], # (1)
ShotFilter: NotRequired[StartShotDetectionFilterTypeDef], # (2)
CelebrityTypeDef#
# CelebrityTypeDef usage example
from mypy_boto3_rekognition.type_defs import CelebrityTypeDef
def get_value() -> CelebrityTypeDef:
return {
"Urls": ...,
}
# CelebrityTypeDef definition
class CelebrityTypeDef(TypedDict):
Urls: NotRequired[List[str]],
Name: NotRequired[str],
Id: NotRequired[str],
Face: NotRequired[ComparedFaceTypeDef], # (1)
MatchConfidence: NotRequired[float],
KnownGender: NotRequired[KnownGenderTypeDef], # (2)
CompareFacesMatchTypeDef#
# CompareFacesMatchTypeDef usage example
from mypy_boto3_rekognition.type_defs import CompareFacesMatchTypeDef
def get_value() -> CompareFacesMatchTypeDef:
return {
"Similarity": ...,
}
# CompareFacesMatchTypeDef definition
class CompareFacesMatchTypeDef(TypedDict):
Similarity: NotRequired[float],
Face: NotRequired[ComparedFaceTypeDef], # (1)
GetContentModerationResponseTypeDef#
# GetContentModerationResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import GetContentModerationResponseTypeDef
def get_value() -> GetContentModerationResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"ModerationLabels": ...,
"NextToken": ...,
"ModerationModelVersion": ...,
"JobId": ...,
"Video": ...,
"JobTag": ...,
"GetRequestMetadata": ...,
"ResponseMetadata": ...,
}
# GetContentModerationResponseTypeDef definition
class GetContentModerationResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
ModerationLabels: List[ContentModerationDetectionTypeDef], # (3)
NextToken: str,
ModerationModelVersion: str,
JobId: str,
Video: VideoTypeDef, # (4)
JobTag: str,
GetRequestMetadata: GetContentModerationRequestMetadataTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See ContentModerationDetectionTypeDef
- See VideoTypeDef
- See GetContentModerationRequestMetadataTypeDef
- See ResponseMetadataTypeDef
ProtectiveEquipmentBodyPartTypeDef#
# ProtectiveEquipmentBodyPartTypeDef usage example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentBodyPartTypeDef
def get_value() -> ProtectiveEquipmentBodyPartTypeDef:
return {
"Name": ...,
}
# ProtectiveEquipmentBodyPartTypeDef definition
class ProtectiveEquipmentBodyPartTypeDef(TypedDict):
Name: NotRequired[BodyPartType], # (1)
Confidence: NotRequired[float],
EquipmentDetections: NotRequired[List[EquipmentDetectionTypeDef]], # (2)
CreateFaceLivenessSessionRequestRequestTypeDef#
# CreateFaceLivenessSessionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import CreateFaceLivenessSessionRequestRequestTypeDef
def get_value() -> CreateFaceLivenessSessionRequestRequestTypeDef:
return {
"KmsKeyId": ...,
}
# CreateFaceLivenessSessionRequestRequestTypeDef definition
class CreateFaceLivenessSessionRequestRequestTypeDef(TypedDict):
KmsKeyId: NotRequired[str],
Settings: NotRequired[CreateFaceLivenessSessionRequestSettingsTypeDef], # (1)
ClientRequestToken: NotRequired[str],
DescribeDatasetResponseTypeDef#
# DescribeDatasetResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeDatasetResponseTypeDef
def get_value() -> DescribeDatasetResponseTypeDef:
return {
"DatasetDescription": ...,
"ResponseMetadata": ...,
}
# DescribeDatasetResponseTypeDef definition
class DescribeDatasetResponseTypeDef(TypedDict):
DatasetDescription: DatasetDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatasetLabelsResponseTypeDef#
# ListDatasetLabelsResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import ListDatasetLabelsResponseTypeDef
def get_value() -> ListDatasetLabelsResponseTypeDef:
return {
"DatasetLabelDescriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListDatasetLabelsResponseTypeDef definition
class ListDatasetLabelsResponseTypeDef(TypedDict):
DatasetLabelDescriptions: List[DatasetLabelDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeProjectsResponseTypeDef#
# DescribeProjectsResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DescribeProjectsResponseTypeDef
def get_value() -> DescribeProjectsResponseTypeDef:
return {
"ProjectDescriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# DescribeProjectsResponseTypeDef definition
class DescribeProjectsResponseTypeDef(TypedDict):
ProjectDescriptions: List[ProjectDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DetectLabelsImagePropertiesTypeDef#
# DetectLabelsImagePropertiesTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsImagePropertiesTypeDef
def get_value() -> DetectLabelsImagePropertiesTypeDef:
return {
"Quality": ...,
}
# DetectLabelsImagePropertiesTypeDef definition
class DetectLabelsImagePropertiesTypeDef(TypedDict):
Quality: NotRequired[DetectLabelsImageQualityTypeDef], # (1)
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
Foreground: NotRequired[DetectLabelsImageForegroundTypeDef], # (3)
Background: NotRequired[DetectLabelsImageBackgroundTypeDef], # (4)
- See DetectLabelsImageQualityTypeDef
- See DominantColorTypeDef
- See DetectLabelsImageForegroundTypeDef
- See DetectLabelsImageBackgroundTypeDef
LabelTypeDef#
# LabelTypeDef usage example
from mypy_boto3_rekognition.type_defs import LabelTypeDef
def get_value() -> LabelTypeDef:
return {
"Name": ...,
}
# LabelTypeDef definition
class LabelTypeDef(TypedDict):
Name: NotRequired[str],
Confidence: NotRequired[float],
Instances: NotRequired[List[InstanceTypeDef]], # (1)
Parents: NotRequired[List[ParentTypeDef]], # (2)
Aliases: NotRequired[List[LabelAliasTypeDef]], # (3)
Categories: NotRequired[List[LabelCategoryTypeDef]], # (4)
- See InstanceTypeDef
- See ParentTypeDef
- See LabelAliasTypeDef
- See LabelCategoryTypeDef
DetectLabelsRequestRequestTypeDef#
# DetectLabelsRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectLabelsRequestRequestTypeDef
def get_value() -> DetectLabelsRequestRequestTypeDef:
return {
"Image": ...,
}
# DetectLabelsRequestRequestTypeDef definition
class DetectLabelsRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
MaxLabels: NotRequired[int],
MinConfidence: NotRequired[float],
Features: NotRequired[Sequence[DetectLabelsFeatureNameType]], # (2)
Settings: NotRequired[DetectLabelsSettingsTypeDef], # (3)
StartLabelDetectionRequestRequestTypeDef#
# StartLabelDetectionRequestRequestTypeDef usage example
from mypy_boto3_rekognition.type_defs import StartLabelDetectionRequestRequestTypeDef
def get_value() -> StartLabelDetectionRequestRequestTypeDef:
return {
"Video": ...,
}
# StartLabelDetectionRequestRequestTypeDef definition
class StartLabelDetectionRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
MinConfidence: NotRequired[float],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
Features: NotRequired[Sequence[LabelDetectionFeatureNameType]], # (3)
Settings: NotRequired[LabelDetectionSettingsTypeDef], # (4)
- See VideoTypeDef
- See NotificationChannelTypeDef
- See LabelDetectionFeatureNameType
- See LabelDetectionSettingsTypeDef
CelebrityDetailTypeDef#
# CelebrityDetailTypeDef usage example
from mypy_boto3_rekognition.type_defs import CelebrityDetailTypeDef
def get_value() -> CelebrityDetailTypeDef:
return {
"Urls": ...,
}
# CelebrityDetailTypeDef definition
class CelebrityDetailTypeDef(TypedDict):
Urls: NotRequired[List[str]],
Name: NotRequired[str],
Id: NotRequired[str],
Confidence: NotRequired[float],
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Face: NotRequired[FaceDetailTypeDef], # (2)
KnownGender: NotRequired[KnownGenderTypeDef], # (3)
- See BoundingBoxTypeDef
- See FaceDetailTypeDef
- See KnownGenderTypeDef
DetectFacesResponseTypeDef#
# DetectFacesResponseTypeDef usage example
from mypy_boto3_rekognition.type_defs import DetectFacesResponseTypeDef
def get_value() -> DetectFacesResponseTypeDef:
return {
"FaceDetails": ...,
"OrientationCorrection": ...,
"ResponseMetadata": ...,
}
# DetectFacesResponseTypeDef definition
class DetectFacesResponseTypeDef(TypedDict):
FaceDetails: List[FaceDetailTypeDef], # (1)
OrientationCorrection: OrientationCorrectionType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
FaceDetectionTypeDef#
# FaceDetectionTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceDetectionTypeDef
def get_value() -> FaceDetectionTypeDef:
return {
"Timestamp": ...,
}
# FaceDetectionTypeDef definition
class FaceDetectionTypeDef(TypedDict):
Timestamp: NotRequired[int],
Face: NotRequired[FaceDetailTypeDef], # (1)
FaceRecordTypeDef#
# FaceRecordTypeDef usage example
from mypy_boto3_rekognition.type_defs import FaceRecordTypeDef
def get_value() -> FaceRecordTypeDef:
return {
"Face": ...,
}
# FaceRecordTypeDef definition
class FaceRecordTypeDef(TypedDict):
Face: NotRequired[FaceTypeDef], # (1)
FaceDetail: NotRequired[FaceDetailTypeDef], # (2)
- See FaceTypeDef
- See FaceDetailTypeDef
PersonDetailTypeDef#
# PersonDetailTypeDef usage example
from mypy_boto3_rekognition.type_defs import PersonDetailTypeDef
def get_value() -> PersonDetailTypeDef:
return {
"Index": ...,
}
# PersonDetailTypeDef definition
class PersonDetailTypeDef(TypedDict):
Index: NotRequired[int],
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Face: NotRequired[FaceDetailTypeDef], # (2)
- See BoundingBoxTypeDef
- See FaceDetailTypeDef
UnindexedFaceTypeDef#
# UnindexedFaceTypeDef usage example
from mypy_boto3_rekognition.type_defs import UnindexedFaceTypeDef
def get_value() -> UnindexedFaceTypeDef:
return {
"Reasons": ...,
}
# UnindexedFaceTypeDef definition
class UnindexedFaceTypeDef(TypedDict):
Reasons: NotRequired[List[ReasonType]], # (1)
FaceDetail: NotRequired[FaceDetailTypeDef], # (2)
- See ReasonType
- See FaceDetailTypeDef
CustomLabelTypeDef#
# CustomLabelTypeDef usage example
from mypy_boto3_rekognition.type_defs import CustomLabelTypeDef
def get_value() -> CustomLabelTypeDef:
return {
"Name": ...,
}
# CustomLabelTypeDef definition
class CustomLabelTypeDef(TypedDict):
Name: NotRequired[str],
Confidence: NotRequired[float],
Geometry: NotRequired[GeometryTypeDef], # (1)