Typed dictionaries
Index > Rekognition > Typed dictionaries
Auto-generated documentation for Rekognition type annotations stubs module mypy-boto3-rekognition.
AgeRangeTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import AgeRangeTypeDef
def get_value() -> AgeRangeTypeDef:
return {
"Low": ...,
}
AudioMetadataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import AudioMetadataTypeDef
def get_value() -> AudioMetadataTypeDef:
return {
"Codec": ...,
}
Definition
class AudioMetadataTypeDef(TypedDict):
Codec: NotRequired[str],
DurationMillis: NotRequired[int],
SampleRate: NotRequired[int],
NumberOfChannels: NotRequired[int],
BeardTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import BeardTypeDef
def get_value() -> BeardTypeDef:
return {
"Value": ...,
}
BlackFrameTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import BlackFrameTypeDef
def get_value() -> BlackFrameTypeDef:
return {
"MaxPixelThreshold": ...,
}
Definition
class BlackFrameTypeDef(TypedDict):
MaxPixelThreshold: NotRequired[float],
MinCoveragePercentage: NotRequired[float],
BoundingBoxTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import BoundingBoxTypeDef
def get_value() -> BoundingBoxTypeDef:
return {
"Width": ...,
}
Definition
class BoundingBoxTypeDef(TypedDict):
Width: NotRequired[float],
Height: NotRequired[float],
Left: NotRequired[float],
Top: NotRequired[float],
KnownGenderTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import KnownGenderTypeDef
def get_value() -> KnownGenderTypeDef:
return {
"Type": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
EmotionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import EmotionTypeDef
def get_value() -> EmotionTypeDef:
return {
"Type": ...,
}
Definition
class EmotionTypeDef(TypedDict):
Type: NotRequired[EmotionNameType], # (1)
Confidence: NotRequired[float],
- See EmotionNameType
ImageQualityTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ImageQualityTypeDef
def get_value() -> ImageQualityTypeDef:
return {
"Brightness": ...,
}
Definition
class ImageQualityTypeDef(TypedDict):
Brightness: NotRequired[float],
Sharpness: NotRequired[float],
LandmarkTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import LandmarkTypeDef
def get_value() -> LandmarkTypeDef:
return {
"Type": ...,
}
Definition
class LandmarkTypeDef(TypedDict):
Type: NotRequired[LandmarkTypeType], # (1)
X: NotRequired[float],
Y: NotRequired[float],
- See LandmarkTypeType
PoseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PoseTypeDef
def get_value() -> PoseTypeDef:
return {
"Roll": ...,
}
Definition
class PoseTypeDef(TypedDict):
Roll: NotRequired[float],
Yaw: NotRequired[float],
Pitch: NotRequired[float],
SmileTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SmileTypeDef
def get_value() -> SmileTypeDef:
return {
"Value": ...,
}
ConnectedHomeSettingsForUpdateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ConnectedHomeSettingsForUpdateTypeDef
def get_value() -> ConnectedHomeSettingsForUpdateTypeDef:
return {
"Labels": ...,
}
Definition
class ConnectedHomeSettingsForUpdateTypeDef(TypedDict):
Labels: NotRequired[Sequence[str]],
MinConfidence: NotRequired[float],
ConnectedHomeSettingsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ConnectedHomeSettingsTypeDef
def get_value() -> ConnectedHomeSettingsTypeDef:
return {
"Labels": ...,
}
Definition
class ConnectedHomeSettingsTypeDef(TypedDict):
Labels: Sequence[str],
MinConfidence: NotRequired[float],
ModerationLabelTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ModerationLabelTypeDef
def get_value() -> ModerationLabelTypeDef:
return {
"Confidence": ...,
}
Definition
class ModerationLabelTypeDef(TypedDict):
Confidence: NotRequired[float],
Name: NotRequired[str],
ParentName: NotRequired[str],
OutputConfigTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import OutputConfigTypeDef
def get_value() -> OutputConfigTypeDef:
return {
"S3Bucket": ...,
}
Definition
class OutputConfigTypeDef(TypedDict):
S3Bucket: NotRequired[str],
S3KeyPrefix: NotRequired[str],
CoversBodyPartTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CoversBodyPartTypeDef
def get_value() -> CoversBodyPartTypeDef:
return {
"Confidence": ...,
}
Definition
class CoversBodyPartTypeDef(TypedDict):
Confidence: NotRequired[float],
Value: NotRequired[bool],
CreateCollectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateCollectionRequestRequestTypeDef
def get_value() -> CreateCollectionRequestRequestTypeDef:
return {
"CollectionId": ...,
}
Definition
class CreateCollectionRequestRequestTypeDef(TypedDict):
CollectionId: str,
Tags: NotRequired[Mapping[str, str]],
CreateProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateProjectRequestRequestTypeDef
def get_value() -> CreateProjectRequestRequestTypeDef:
return {
"ProjectName": ...,
}
StreamProcessorDataSharingPreferenceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorDataSharingPreferenceTypeDef
def get_value() -> StreamProcessorDataSharingPreferenceTypeDef:
return {
"OptIn": ...,
}
StreamProcessorNotificationChannelTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorNotificationChannelTypeDef
def get_value() -> StreamProcessorNotificationChannelTypeDef:
return {
"SNSTopicArn": ...,
}
DatasetChangesTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetChangesTypeDef
def get_value() -> DatasetChangesTypeDef:
return {
"GroundTruth": ...,
}
Definition
class DatasetChangesTypeDef(TypedDict):
GroundTruth: Union[str, bytes, IO[Any], StreamingBody],
DatasetStatsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetStatsTypeDef
def get_value() -> DatasetStatsTypeDef:
return {
"LabeledEntries": ...,
}
Definition
class DatasetStatsTypeDef(TypedDict):
LabeledEntries: NotRequired[int],
TotalEntries: NotRequired[int],
TotalLabels: NotRequired[int],
ErrorEntries: NotRequired[int],
DatasetLabelStatsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetLabelStatsTypeDef
def get_value() -> DatasetLabelStatsTypeDef:
return {
"EntryCount": ...,
}
Definition
class DatasetLabelStatsTypeDef(TypedDict):
EntryCount: NotRequired[int],
BoundingBoxCount: NotRequired[int],
DatasetMetadataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetMetadataTypeDef
def get_value() -> DatasetMetadataTypeDef:
return {
"CreationTimestamp": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteCollectionRequestRequestTypeDef
def get_value() -> DeleteCollectionRequestRequestTypeDef:
return {
"CollectionId": ...,
}
DeleteDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteDatasetRequestRequestTypeDef
def get_value() -> DeleteDatasetRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
DeleteFacesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteFacesRequestRequestTypeDef
def get_value() -> DeleteFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
"FaceIds": ...,
}
Definition
class DeleteFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
FaceIds: Sequence[str],
DeleteProjectPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteProjectPolicyRequestRequestTypeDef
def get_value() -> DeleteProjectPolicyRequestRequestTypeDef:
return {
"ProjectArn": ...,
"PolicyName": ...,
}
Definition
class DeleteProjectPolicyRequestRequestTypeDef(TypedDict):
ProjectArn: str,
PolicyName: str,
PolicyRevisionId: NotRequired[str],
DeleteProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteProjectRequestRequestTypeDef
def get_value() -> DeleteProjectRequestRequestTypeDef:
return {
"ProjectArn": ...,
}
DeleteProjectVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteProjectVersionRequestRequestTypeDef
def get_value() -> DeleteProjectVersionRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
}
DeleteStreamProcessorRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteStreamProcessorRequestRequestTypeDef
def get_value() -> DeleteStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
DescribeCollectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeCollectionRequestRequestTypeDef
def get_value() -> DescribeCollectionRequestRequestTypeDef:
return {
"CollectionId": ...,
}
DescribeDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeDatasetRequestRequestTypeDef
def get_value() -> DescribeDatasetRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
WaiterConfigTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
Definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeProjectVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestRequestTypeDef
def get_value() -> DescribeProjectVersionsRequestRequestTypeDef:
return {
"ProjectArn": ...,
}
Definition
class DescribeProjectVersionsRequestRequestTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeProjectsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectsRequestRequestTypeDef
def get_value() -> DescribeProjectsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class DescribeProjectsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProjectNames: NotRequired[Sequence[str]],
DescribeStreamProcessorRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeStreamProcessorRequestRequestTypeDef
def get_value() -> DescribeStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
DetectLabelsImageQualityTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsImageQualityTypeDef
def get_value() -> DetectLabelsImageQualityTypeDef:
return {
"Brightness": ...,
}
Definition
class DetectLabelsImageQualityTypeDef(TypedDict):
Brightness: NotRequired[float],
Sharpness: NotRequired[float],
Contrast: NotRequired[float],
DominantColorTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DominantColorTypeDef
def get_value() -> DominantColorTypeDef:
return {
"Red": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsImagePropertiesSettingsTypeDef
def get_value() -> DetectLabelsImagePropertiesSettingsTypeDef:
return {
"MaxDominantColors": ...,
}
Definition
class DetectLabelsImagePropertiesSettingsTypeDef(TypedDict):
MaxDominantColors: NotRequired[int],
GeneralLabelsSettingsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GeneralLabelsSettingsTypeDef
def get_value() -> GeneralLabelsSettingsTypeDef:
return {
"LabelInclusionFilters": ...,
}
Definition
class GeneralLabelsSettingsTypeDef(TypedDict):
LabelInclusionFilters: NotRequired[Sequence[str]],
LabelExclusionFilters: NotRequired[Sequence[str]],
LabelCategoryInclusionFilters: NotRequired[Sequence[str]],
LabelCategoryExclusionFilters: NotRequired[Sequence[str]],
HumanLoopActivationOutputTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import HumanLoopActivationOutputTypeDef
def get_value() -> HumanLoopActivationOutputTypeDef:
return {
"HumanLoopArn": ...,
}
Definition
class HumanLoopActivationOutputTypeDef(TypedDict):
HumanLoopArn: NotRequired[str],
HumanLoopActivationReasons: NotRequired[List[str]],
HumanLoopActivationConditionsEvaluationResults: NotRequired[str],
ProtectiveEquipmentSummarizationAttributesTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentSummarizationAttributesTypeDef
def get_value() -> ProtectiveEquipmentSummarizationAttributesTypeDef:
return {
"MinConfidence": ...,
"RequiredEquipmentTypes": ...,
}
Definition
class ProtectiveEquipmentSummarizationAttributesTypeDef(TypedDict):
MinConfidence: float,
RequiredEquipmentTypes: Sequence[ProtectiveEquipmentTypeType], # (1)
ProtectiveEquipmentSummaryTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentSummaryTypeDef
def get_value() -> ProtectiveEquipmentSummaryTypeDef:
return {
"PersonsWithRequiredEquipment": ...,
}
Definition
class ProtectiveEquipmentSummaryTypeDef(TypedDict):
PersonsWithRequiredEquipment: NotRequired[List[int]],
PersonsWithoutRequiredEquipment: NotRequired[List[int]],
PersonsIndeterminate: NotRequired[List[int]],
DetectionFilterTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectionFilterTypeDef
def get_value() -> DetectionFilterTypeDef:
return {
"MinConfidence": ...,
}
Definition
class DetectionFilterTypeDef(TypedDict):
MinConfidence: NotRequired[float],
MinBoundingBoxHeight: NotRequired[float],
MinBoundingBoxWidth: NotRequired[float],
DistributeDatasetTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DistributeDatasetTypeDef
def get_value() -> DistributeDatasetTypeDef:
return {
"Arn": ...,
}
EyeOpenTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import EyeOpenTypeDef
def get_value() -> EyeOpenTypeDef:
return {
"Value": ...,
}
Definition
class EyeOpenTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
EyeglassesTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import EyeglassesTypeDef
def get_value() -> EyeglassesTypeDef:
return {
"Value": ...,
}
Definition
class EyeglassesTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
GenderTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GenderTypeDef
def get_value() -> GenderTypeDef:
return {
"Value": ...,
}
Definition
class GenderTypeDef(TypedDict):
Value: NotRequired[GenderTypeType], # (1)
Confidence: NotRequired[float],
- See GenderTypeType
MouthOpenTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import MouthOpenTypeDef
def get_value() -> MouthOpenTypeDef:
return {
"Value": ...,
}
Definition
class MouthOpenTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
MustacheTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import MustacheTypeDef
def get_value() -> MustacheTypeDef:
return {
"Value": ...,
}
Definition
class MustacheTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
SunglassesTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SunglassesTypeDef
def get_value() -> SunglassesTypeDef:
return {
"Value": ...,
}
Definition
class SunglassesTypeDef(TypedDict):
Value: NotRequired[bool],
Confidence: NotRequired[float],
FaceSearchSettingsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import FaceSearchSettingsTypeDef
def get_value() -> FaceSearchSettingsTypeDef:
return {
"CollectionId": ...,
}
Definition
class FaceSearchSettingsTypeDef(TypedDict):
CollectionId: NotRequired[str],
FaceMatchThreshold: NotRequired[float],
PointTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PointTypeDef
def get_value() -> PointTypeDef:
return {
"X": ...,
}
GetCelebrityInfoRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetCelebrityInfoRequestRequestTypeDef
def get_value() -> GetCelebrityInfoRequestRequestTypeDef:
return {
"Id": ...,
}
GetCelebrityRecognitionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetCelebrityRecognitionRequestRequestTypeDef
def get_value() -> GetCelebrityRecognitionRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetCelebrityRecognitionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[CelebrityRecognitionSortByType], # (1)
VideoMetadataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import VideoMetadataTypeDef
def get_value() -> VideoMetadataTypeDef:
return {
"Codec": ...,
}
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)
GetContentModerationRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetContentModerationRequestRequestTypeDef
def get_value() -> GetContentModerationRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetContentModerationRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[ContentModerationSortByType], # (1)
GetFaceDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetFaceDetectionRequestRequestTypeDef
def get_value() -> GetFaceDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetFaceDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetFaceSearchRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetFaceSearchRequestRequestTypeDef
def get_value() -> GetFaceSearchRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetFaceSearchRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[FaceSearchSortByType], # (1)
GetLabelDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetLabelDetectionRequestRequestTypeDef
def get_value() -> GetLabelDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetLabelDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[LabelDetectionSortByType], # (1)
AggregateBy: NotRequired[LabelDetectionAggregateByType], # (2)
GetPersonTrackingRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetPersonTrackingRequestRequestTypeDef
def get_value() -> GetPersonTrackingRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetPersonTrackingRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SortBy: NotRequired[PersonTrackingSortByType], # (1)
GetSegmentDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetSegmentDetectionRequestRequestTypeDef
def get_value() -> GetSegmentDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetSegmentDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SegmentTypeInfoTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SegmentTypeInfoTypeDef
def get_value() -> SegmentTypeInfoTypeDef:
return {
"Type": ...,
}
Definition
class SegmentTypeInfoTypeDef(TypedDict):
Type: NotRequired[SegmentTypeType], # (1)
ModelVersion: NotRequired[str],
- See SegmentTypeType
GetTextDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetTextDetectionRequestRequestTypeDef
def get_value() -> GetTextDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetTextDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
S3ObjectTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import S3ObjectTypeDef
def get_value() -> S3ObjectTypeDef:
return {
"Bucket": ...,
}
Definition
class S3ObjectTypeDef(TypedDict):
Bucket: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[str],
HumanLoopDataAttributesTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import HumanLoopDataAttributesTypeDef
def get_value() -> HumanLoopDataAttributesTypeDef:
return {
"ContentClassifiers": ...,
}
Definition
class HumanLoopDataAttributesTypeDef(TypedDict):
ContentClassifiers: NotRequired[Sequence[ContentClassifierType]], # (1)
KinesisDataStreamTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import KinesisDataStreamTypeDef
def get_value() -> KinesisDataStreamTypeDef:
return {
"Arn": ...,
}
KinesisVideoStreamStartSelectorTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import KinesisVideoStreamStartSelectorTypeDef
def get_value() -> KinesisVideoStreamStartSelectorTypeDef:
return {
"ProducerTimestamp": ...,
}
Definition
class KinesisVideoStreamStartSelectorTypeDef(TypedDict):
ProducerTimestamp: NotRequired[int],
FragmentNumber: NotRequired[str],
KinesisVideoStreamTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import KinesisVideoStreamTypeDef
def get_value() -> KinesisVideoStreamTypeDef:
return {
"Arn": ...,
}
LabelAliasTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import LabelAliasTypeDef
def get_value() -> LabelAliasTypeDef:
return {
"Name": ...,
}
LabelCategoryTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import LabelCategoryTypeDef
def get_value() -> LabelCategoryTypeDef:
return {
"Name": ...,
}
ParentTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ParentTypeDef
def get_value() -> ParentTypeDef:
return {
"Name": ...,
}
ListCollectionsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListCollectionsRequestRequestTypeDef
def get_value() -> ListCollectionsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListCollectionsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDatasetEntriesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListDatasetEntriesRequestRequestTypeDef
def get_value() -> ListDatasetEntriesRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
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],
ListDatasetLabelsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListDatasetLabelsRequestRequestTypeDef
def get_value() -> ListDatasetLabelsRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
Definition
class ListDatasetLabelsRequestRequestTypeDef(TypedDict):
DatasetArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListFacesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListFacesRequestRequestTypeDef
def get_value() -> ListFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
}
Definition
class ListFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListProjectPoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListProjectPoliciesRequestRequestTypeDef
def get_value() -> ListProjectPoliciesRequestRequestTypeDef:
return {
"ProjectArn": ...,
}
Definition
class ListProjectPoliciesRequestRequestTypeDef(TypedDict):
ProjectArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProjectPolicyTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProjectPolicyTypeDef
def get_value() -> ProjectPolicyTypeDef:
return {
"ProjectArn": ...,
}
Definition
class ProjectPolicyTypeDef(TypedDict):
ProjectArn: NotRequired[str],
PolicyName: NotRequired[str],
PolicyRevisionId: NotRequired[str],
PolicyDocument: NotRequired[str],
CreationTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
ListStreamProcessorsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListStreamProcessorsRequestRequestTypeDef
def get_value() -> ListStreamProcessorsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListStreamProcessorsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StreamProcessorTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorTypeDef
def get_value() -> StreamProcessorTypeDef:
return {
"Name": ...,
}
Definition
class StreamProcessorTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[StreamProcessorStatusType], # (1)
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
NotificationChannelTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import NotificationChannelTypeDef
def get_value() -> NotificationChannelTypeDef:
return {
"SNSTopicArn": ...,
"RoleArn": ...,
}
PutProjectPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PutProjectPolicyRequestRequestTypeDef
def get_value() -> PutProjectPolicyRequestRequestTypeDef:
return {
"ProjectArn": ...,
"PolicyName": ...,
"PolicyDocument": ...,
}
Definition
class PutProjectPolicyRequestRequestTypeDef(TypedDict):
ProjectArn: str,
PolicyName: str,
PolicyDocument: str,
PolicyRevisionId: NotRequired[str],
S3DestinationTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import S3DestinationTypeDef
def get_value() -> S3DestinationTypeDef:
return {
"Bucket": ...,
}
Definition
class S3DestinationTypeDef(TypedDict):
Bucket: NotRequired[str],
KeyPrefix: NotRequired[str],
SearchFacesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SearchFacesRequestRequestTypeDef
def get_value() -> SearchFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
"FaceId": ...,
}
Definition
class SearchFacesRequestRequestTypeDef(TypedDict):
CollectionId: str,
FaceId: str,
MaxFaces: NotRequired[int],
FaceMatchThreshold: NotRequired[float],
ShotSegmentTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ShotSegmentTypeDef
def get_value() -> ShotSegmentTypeDef:
return {
"Index": ...,
}
Definition
class ShotSegmentTypeDef(TypedDict):
Index: NotRequired[int],
Confidence: NotRequired[float],
TechnicalCueSegmentTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TechnicalCueSegmentTypeDef
def get_value() -> TechnicalCueSegmentTypeDef:
return {
"Type": ...,
}
Definition
class TechnicalCueSegmentTypeDef(TypedDict):
Type: NotRequired[TechnicalCueTypeType], # (1)
Confidence: NotRequired[float],
StartProjectVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartProjectVersionRequestRequestTypeDef
def get_value() -> StartProjectVersionRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
"MinInferenceUnits": ...,
}
Definition
class StartProjectVersionRequestRequestTypeDef(TypedDict):
ProjectVersionArn: str,
MinInferenceUnits: int,
MaxInferenceUnits: NotRequired[int],
StartShotDetectionFilterTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartShotDetectionFilterTypeDef
def get_value() -> StartShotDetectionFilterTypeDef:
return {
"MinSegmentConfidence": ...,
}
Definition
class StartShotDetectionFilterTypeDef(TypedDict):
MinSegmentConfidence: NotRequired[float],
StreamProcessingStopSelectorTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessingStopSelectorTypeDef
def get_value() -> StreamProcessingStopSelectorTypeDef:
return {
"MaxDurationInSeconds": ...,
}
Definition
class StreamProcessingStopSelectorTypeDef(TypedDict):
MaxDurationInSeconds: NotRequired[int],
StopProjectVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StopProjectVersionRequestRequestTypeDef
def get_value() -> StopProjectVersionRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
}
StopStreamProcessorRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StopStreamProcessorRequestRequestTypeDef
def get_value() -> StopStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
StartTechnicalCueDetectionFilterTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartTechnicalCueDetectionFilterTypeDef
def get_value() -> StartTechnicalCueDetectionFilterTypeDef:
return {
"MinSegmentConfidence": ...,
}
Definition
class StartTechnicalCueDetectionFilterTypeDef(TypedDict):
MinSegmentConfidence: NotRequired[float],
BlackFrame: NotRequired[BlackFrameTypeDef], # (1)
ComparedSourceImageFaceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ComparedSourceImageFaceTypeDef
def get_value() -> ComparedSourceImageFaceTypeDef:
return {
"BoundingBox": ...,
}
Definition
class ComparedSourceImageFaceTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
FaceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import FaceTypeDef
def get_value() -> FaceTypeDef:
return {
"FaceId": ...,
}
Definition
class FaceTypeDef(TypedDict):
FaceId: NotRequired[str],
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
ImageId: NotRequired[str],
ExternalImageId: NotRequired[str],
Confidence: NotRequired[float],
IndexFacesModelVersion: NotRequired[str],
CopyProjectVersionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CopyProjectVersionResponseTypeDef
def get_value() -> CopyProjectVersionResponseTypeDef:
return {
"ProjectVersionArn": ...,
"ResponseMetadata": ...,
}
Definition
class CopyProjectVersionResponseTypeDef(TypedDict):
ProjectVersionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCollectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateCollectionResponseTypeDef
def get_value() -> CreateCollectionResponseTypeDef:
return {
"StatusCode": ...,
"CollectionArn": ...,
"FaceModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class CreateCollectionResponseTypeDef(TypedDict):
StatusCode: int,
CollectionArn: str,
FaceModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDatasetResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateDatasetResponseTypeDef
def get_value() -> CreateDatasetResponseTypeDef:
return {
"DatasetArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDatasetResponseTypeDef(TypedDict):
DatasetArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProjectResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateProjectResponseTypeDef
def get_value() -> CreateProjectResponseTypeDef:
return {
"ProjectArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProjectResponseTypeDef(TypedDict):
ProjectArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProjectVersionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateProjectVersionResponseTypeDef
def get_value() -> CreateProjectVersionResponseTypeDef:
return {
"ProjectVersionArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProjectVersionResponseTypeDef(TypedDict):
ProjectVersionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateStreamProcessorResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateStreamProcessorResponseTypeDef
def get_value() -> CreateStreamProcessorResponseTypeDef:
return {
"StreamProcessorArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateStreamProcessorResponseTypeDef(TypedDict):
StreamProcessorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteCollectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteCollectionResponseTypeDef
def get_value() -> DeleteCollectionResponseTypeDef:
return {
"StatusCode": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteCollectionResponseTypeDef(TypedDict):
StatusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteFacesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteFacesResponseTypeDef
def get_value() -> DeleteFacesResponseTypeDef:
return {
"DeletedFaces": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteFacesResponseTypeDef(TypedDict):
DeletedFaces: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProjectResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteProjectResponseTypeDef
def get_value() -> DeleteProjectResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProjectResponseTypeDef(TypedDict):
Status: ProjectStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteProjectVersionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DeleteProjectVersionResponseTypeDef
def get_value() -> DeleteProjectVersionResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProjectVersionResponseTypeDef(TypedDict):
Status: ProjectVersionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCollectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeCollectionResponseTypeDef
def get_value() -> DescribeCollectionResponseTypeDef:
return {
"FaceCount": ...,
"FaceModelVersion": ...,
"CollectionARN": ...,
"CreationTimestamp": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCollectionResponseTypeDef(TypedDict):
FaceCount: int,
FaceModelVersion: str,
CollectionARN: str,
CreationTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCelebrityInfoResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetCelebrityInfoResponseTypeDef
def get_value() -> GetCelebrityInfoResponseTypeDef:
return {
"Urls": ...,
"Name": ...,
"KnownGender": ...,
"ResponseMetadata": ...,
}
Definition
class GetCelebrityInfoResponseTypeDef(TypedDict):
Urls: List[str],
Name: str,
KnownGender: KnownGenderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCollectionsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListCollectionsResponseTypeDef
def get_value() -> ListCollectionsResponseTypeDef:
return {
"CollectionIds": ...,
"NextToken": ...,
"FaceModelVersions": ...,
"ResponseMetadata": ...,
}
Definition
class ListCollectionsResponseTypeDef(TypedDict):
CollectionIds: List[str],
NextToken: str,
FaceModelVersions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDatasetEntriesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListDatasetEntriesResponseTypeDef
def get_value() -> ListDatasetEntriesResponseTypeDef:
return {
"DatasetEntries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatasetEntriesResponseTypeDef(TypedDict):
DatasetEntries: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutProjectPolicyResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PutProjectPolicyResponseTypeDef
def get_value() -> PutProjectPolicyResponseTypeDef:
return {
"PolicyRevisionId": ...,
"ResponseMetadata": ...,
}
Definition
class PutProjectPolicyResponseTypeDef(TypedDict):
PolicyRevisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartCelebrityRecognitionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartCelebrityRecognitionResponseTypeDef
def get_value() -> StartCelebrityRecognitionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartCelebrityRecognitionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartContentModerationResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartContentModerationResponseTypeDef
def get_value() -> StartContentModerationResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartContentModerationResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartFaceDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartFaceDetectionResponseTypeDef
def get_value() -> StartFaceDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartFaceDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartFaceSearchResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartFaceSearchResponseTypeDef
def get_value() -> StartFaceSearchResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartFaceSearchResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartLabelDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartLabelDetectionResponseTypeDef
def get_value() -> StartLabelDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartLabelDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartPersonTrackingResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartPersonTrackingResponseTypeDef
def get_value() -> StartPersonTrackingResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartPersonTrackingResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartProjectVersionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartProjectVersionResponseTypeDef
def get_value() -> StartProjectVersionResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
Definition
class StartProjectVersionResponseTypeDef(TypedDict):
Status: ProjectVersionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartSegmentDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartSegmentDetectionResponseTypeDef
def get_value() -> StartSegmentDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartSegmentDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartStreamProcessorResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartStreamProcessorResponseTypeDef
def get_value() -> StartStreamProcessorResponseTypeDef:
return {
"SessionId": ...,
"ResponseMetadata": ...,
}
Definition
class StartStreamProcessorResponseTypeDef(TypedDict):
SessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartTextDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartTextDetectionResponseTypeDef
def get_value() -> StartTextDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartTextDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StopProjectVersionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StopProjectVersionResponseTypeDef
def get_value() -> StopProjectVersionResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
Definition
class StopProjectVersionResponseTypeDef(TypedDict):
Status: ProjectVersionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ComparedFaceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ComparedFaceTypeDef
def get_value() -> ComparedFaceTypeDef:
return {
"BoundingBox": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorSettingsForUpdateTypeDef
def get_value() -> StreamProcessorSettingsForUpdateTypeDef:
return {
"ConnectedHomeForUpdate": ...,
}
Definition
class StreamProcessorSettingsForUpdateTypeDef(TypedDict):
ConnectedHomeForUpdate: NotRequired[ConnectedHomeSettingsForUpdateTypeDef], # (1)
ContentModerationDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ContentModerationDetectionTypeDef
def get_value() -> ContentModerationDetectionTypeDef:
return {
"Timestamp": ...,
}
Definition
class ContentModerationDetectionTypeDef(TypedDict):
Timestamp: NotRequired[int],
ModerationLabel: NotRequired[ModerationLabelTypeDef], # (1)
CopyProjectVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CopyProjectVersionRequestRequestTypeDef
def get_value() -> CopyProjectVersionRequestRequestTypeDef:
return {
"SourceProjectArn": ...,
"SourceProjectVersionArn": ...,
"DestinationProjectArn": ...,
"VersionName": ...,
"OutputConfig": ...,
}
Definition
class CopyProjectVersionRequestRequestTypeDef(TypedDict):
SourceProjectArn: str,
SourceProjectVersionArn: str,
DestinationProjectArn: str,
VersionName: str,
OutputConfig: OutputConfigTypeDef, # (1)
Tags: NotRequired[Mapping[str, str]],
KmsKeyId: NotRequired[str],
EquipmentDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import EquipmentDetectionTypeDef
def get_value() -> EquipmentDetectionTypeDef:
return {
"BoundingBox": ...,
}
Definition
class EquipmentDetectionTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
Type: NotRequired[ProtectiveEquipmentTypeType], # (2)
CoversBodyPart: NotRequired[CoversBodyPartTypeDef], # (3)
UpdateDatasetEntriesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import UpdateDatasetEntriesRequestRequestTypeDef
def get_value() -> UpdateDatasetEntriesRequestRequestTypeDef:
return {
"DatasetArn": ...,
"Changes": ...,
}
Definition
class UpdateDatasetEntriesRequestRequestTypeDef(TypedDict):
DatasetArn: str,
Changes: DatasetChangesTypeDef, # (1)
DatasetDescriptionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetDescriptionTypeDef
def get_value() -> DatasetDescriptionTypeDef:
return {
"CreationTimestamp": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetLabelDescriptionTypeDef
def get_value() -> DatasetLabelDescriptionTypeDef:
return {
"LabelName": ...,
}
Definition
class DatasetLabelDescriptionTypeDef(TypedDict):
LabelName: NotRequired[str],
LabelStats: NotRequired[DatasetLabelStatsTypeDef], # (1)
ProjectDescriptionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProjectDescriptionTypeDef
def get_value() -> ProjectDescriptionTypeDef:
return {
"ProjectArn": ...,
}
Definition
class ProjectDescriptionTypeDef(TypedDict):
ProjectArn: NotRequired[str],
CreationTimestamp: NotRequired[datetime],
Status: NotRequired[ProjectStatusType], # (1)
Datasets: NotRequired[List[DatasetMetadataTypeDef]], # (2)
DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef
def get_value() -> DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef:
return {
"ProjectArn": ...,
}
Definition
class DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeProjectsRequestDescribeProjectsPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectsRequestDescribeProjectsPaginateTypeDef
def get_value() -> DescribeProjectsRequestDescribeProjectsPaginateTypeDef:
return {
"ProjectNames": ...,
}
Definition
class DescribeProjectsRequestDescribeProjectsPaginateTypeDef(TypedDict):
ProjectNames: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCollectionsRequestListCollectionsPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListCollectionsRequestListCollectionsPaginateTypeDef
def get_value() -> ListCollectionsRequestListCollectionsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListCollectionsRequestListCollectionsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef
def get_value() -> ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef:
return {
"DatasetArn": ...,
}
Definition
class ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef(TypedDict):
DatasetArn: str,
ContainsLabels: NotRequired[Sequence[str]],
Labeled: NotRequired[bool],
SourceRefContains: NotRequired[str],
HasErrors: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef
def get_value() -> ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef:
return {
"DatasetArn": ...,
}
Definition
class ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef(TypedDict):
DatasetArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFacesRequestListFacesPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListFacesRequestListFacesPaginateTypeDef
def get_value() -> ListFacesRequestListFacesPaginateTypeDef:
return {
"CollectionId": ...,
}
Definition
class ListFacesRequestListFacesPaginateTypeDef(TypedDict):
CollectionId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef
def get_value() -> ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef:
return {
"ProjectArn": ...,
}
Definition
class ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef(TypedDict):
ProjectArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef
def get_value() -> ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef
def get_value() -> DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef:
return {
"ProjectArn": ...,
}
Definition
class DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef
def get_value() -> DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef:
return {
"ProjectArn": ...,
}
Definition
class DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef(TypedDict):
ProjectArn: str,
VersionNames: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DetectLabelsImageBackgroundTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsImageBackgroundTypeDef
def get_value() -> DetectLabelsImageBackgroundTypeDef:
return {
"Quality": ...,
}
Definition
class DetectLabelsImageBackgroundTypeDef(TypedDict):
Quality: NotRequired[DetectLabelsImageQualityTypeDef], # (1)
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
DetectLabelsImageForegroundTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsImageForegroundTypeDef
def get_value() -> DetectLabelsImageForegroundTypeDef:
return {
"Quality": ...,
}
Definition
class DetectLabelsImageForegroundTypeDef(TypedDict):
Quality: NotRequired[DetectLabelsImageQualityTypeDef], # (1)
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
InstanceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import InstanceTypeDef
def get_value() -> InstanceTypeDef:
return {
"BoundingBox": ...,
}
Definition
class InstanceTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Confidence: NotRequired[float],
DominantColors: NotRequired[List[DominantColorTypeDef]], # (2)
DetectLabelsSettingsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsSettingsTypeDef
def get_value() -> DetectLabelsSettingsTypeDef:
return {
"GeneralLabels": ...,
}
Definition
class DetectLabelsSettingsTypeDef(TypedDict):
GeneralLabels: NotRequired[GeneralLabelsSettingsTypeDef], # (1)
ImageProperties: NotRequired[DetectLabelsImagePropertiesSettingsTypeDef], # (2)
LabelDetectionSettingsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import LabelDetectionSettingsTypeDef
def get_value() -> LabelDetectionSettingsTypeDef:
return {
"GeneralLabels": ...,
}
Definition
class LabelDetectionSettingsTypeDef(TypedDict):
GeneralLabels: NotRequired[GeneralLabelsSettingsTypeDef], # (1)
DetectModerationLabelsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectModerationLabelsResponseTypeDef
def get_value() -> DetectModerationLabelsResponseTypeDef:
return {
"ModerationLabels": ...,
"ModerationModelVersion": ...,
"HumanLoopActivationOutput": ...,
"ResponseMetadata": ...,
}
Definition
class DetectModerationLabelsResponseTypeDef(TypedDict):
ModerationLabels: List[ModerationLabelTypeDef], # (1)
ModerationModelVersion: str,
HumanLoopActivationOutput: HumanLoopActivationOutputTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DistributeDatasetEntriesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DistributeDatasetEntriesRequestRequestTypeDef
def get_value() -> DistributeDatasetEntriesRequestRequestTypeDef:
return {
"Datasets": ...,
}
Definition
class DistributeDatasetEntriesRequestRequestTypeDef(TypedDict):
Datasets: Sequence[DistributeDatasetTypeDef], # (1)
FaceDetailTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import FaceDetailTypeDef
def get_value() -> FaceDetailTypeDef:
return {
"BoundingBox": ...,
}
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],
- 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
StreamProcessorSettingsTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorSettingsTypeDef
def get_value() -> StreamProcessorSettingsTypeDef:
return {
"FaceSearch": ...,
}
Definition
class StreamProcessorSettingsTypeDef(TypedDict):
FaceSearch: NotRequired[FaceSearchSettingsTypeDef], # (1)
ConnectedHome: NotRequired[ConnectedHomeSettingsTypeDef], # (2)
GeometryTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GeometryTypeDef
def get_value() -> GeometryTypeDef:
return {
"BoundingBox": ...,
}
Definition
class GeometryTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Polygon: NotRequired[List[PointTypeDef]], # (2)
- See BoundingBoxTypeDef
- See PointTypeDef
RegionOfInterestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import RegionOfInterestTypeDef
def get_value() -> RegionOfInterestTypeDef:
return {
"BoundingBox": ...,
}
Definition
class RegionOfInterestTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Polygon: NotRequired[Sequence[PointTypeDef]], # (2)
- See BoundingBoxTypeDef
- See PointTypeDef
GroundTruthManifestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GroundTruthManifestTypeDef
def get_value() -> GroundTruthManifestTypeDef:
return {
"S3Object": ...,
}
Definition
class GroundTruthManifestTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
ImageTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ImageTypeDef
def get_value() -> ImageTypeDef:
return {
"Bytes": ...,
}
Definition
class ImageTypeDef(TypedDict):
Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
SummaryTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SummaryTypeDef
def get_value() -> SummaryTypeDef:
return {
"S3Object": ...,
}
- See S3ObjectTypeDef
VideoTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import VideoTypeDef
def get_value() -> VideoTypeDef:
return {
"S3Object": ...,
}
- See S3ObjectTypeDef
HumanLoopConfigTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import HumanLoopConfigTypeDef
def get_value() -> HumanLoopConfigTypeDef:
return {
"HumanLoopName": ...,
"FlowDefinitionArn": ...,
}
Definition
class HumanLoopConfigTypeDef(TypedDict):
HumanLoopName: str,
FlowDefinitionArn: str,
DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef], # (1)
StreamProcessingStartSelectorTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessingStartSelectorTypeDef
def get_value() -> StreamProcessingStartSelectorTypeDef:
return {
"KVSStreamStartSelector": ...,
}
Definition
class StreamProcessingStartSelectorTypeDef(TypedDict):
KVSStreamStartSelector: NotRequired[KinesisVideoStreamStartSelectorTypeDef], # (1)
StreamProcessorInputTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorInputTypeDef
def get_value() -> StreamProcessorInputTypeDef:
return {
"KinesisVideoStream": ...,
}
Definition
class StreamProcessorInputTypeDef(TypedDict):
KinesisVideoStream: NotRequired[KinesisVideoStreamTypeDef], # (1)
ListProjectPoliciesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListProjectPoliciesResponseTypeDef
def get_value() -> ListProjectPoliciesResponseTypeDef:
return {
"ProjectPolicies": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListProjectPoliciesResponseTypeDef(TypedDict):
ProjectPolicies: List[ProjectPolicyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamProcessorsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListStreamProcessorsResponseTypeDef
def get_value() -> ListStreamProcessorsResponseTypeDef:
return {
"NextToken": ...,
"StreamProcessors": ...,
"ResponseMetadata": ...,
}
Definition
class ListStreamProcessorsResponseTypeDef(TypedDict):
NextToken: str,
StreamProcessors: List[StreamProcessorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StreamProcessorOutputTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StreamProcessorOutputTypeDef
def get_value() -> StreamProcessorOutputTypeDef:
return {
"KinesisDataStream": ...,
}
Definition
class StreamProcessorOutputTypeDef(TypedDict):
KinesisDataStream: NotRequired[KinesisDataStreamTypeDef], # (1)
S3Destination: NotRequired[S3DestinationTypeDef], # (2)
SegmentDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SegmentDetectionTypeDef
def get_value() -> SegmentDetectionTypeDef:
return {
"Type": ...,
}
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],
StartSegmentDetectionFiltersTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartSegmentDetectionFiltersTypeDef
def get_value() -> StartSegmentDetectionFiltersTypeDef:
return {
"TechnicalCueFilter": ...,
}
Definition
class StartSegmentDetectionFiltersTypeDef(TypedDict):
TechnicalCueFilter: NotRequired[StartTechnicalCueDetectionFilterTypeDef], # (1)
ShotFilter: NotRequired[StartShotDetectionFilterTypeDef], # (2)
FaceMatchTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import FaceMatchTypeDef
def get_value() -> FaceMatchTypeDef:
return {
"Similarity": ...,
}
Definition
class FaceMatchTypeDef(TypedDict):
Similarity: NotRequired[float],
Face: NotRequired[FaceTypeDef], # (1)
- See FaceTypeDef
ListFacesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListFacesResponseTypeDef
def get_value() -> ListFacesResponseTypeDef:
return {
"Faces": ...,
"NextToken": ...,
"FaceModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class ListFacesResponseTypeDef(TypedDict):
Faces: List[FaceTypeDef], # (1)
NextToken: str,
FaceModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See FaceTypeDef
- See ResponseMetadataTypeDef
CelebrityTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CelebrityTypeDef
def get_value() -> CelebrityTypeDef:
return {
"Urls": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import CompareFacesMatchTypeDef
def get_value() -> CompareFacesMatchTypeDef:
return {
"Similarity": ...,
}
Definition
class CompareFacesMatchTypeDef(TypedDict):
Similarity: NotRequired[float],
Face: NotRequired[ComparedFaceTypeDef], # (1)
GetContentModerationResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetContentModerationResponseTypeDef
def get_value() -> GetContentModerationResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"ModerationLabels": ...,
"NextToken": ...,
"ModerationModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class GetContentModerationResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
ModerationLabels: List[ContentModerationDetectionTypeDef], # (3)
NextToken: str,
ModerationModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See ContentModerationDetectionTypeDef
- See ResponseMetadataTypeDef
ProtectiveEquipmentBodyPartTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentBodyPartTypeDef
def get_value() -> ProtectiveEquipmentBodyPartTypeDef:
return {
"Name": ...,
}
Definition
class ProtectiveEquipmentBodyPartTypeDef(TypedDict):
Name: NotRequired[BodyPartType], # (1)
Confidence: NotRequired[float],
EquipmentDetections: NotRequired[List[EquipmentDetectionTypeDef]], # (2)
DescribeDatasetResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeDatasetResponseTypeDef
def get_value() -> DescribeDatasetResponseTypeDef:
return {
"DatasetDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDatasetResponseTypeDef(TypedDict):
DatasetDescription: DatasetDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatasetLabelsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ListDatasetLabelsResponseTypeDef
def get_value() -> ListDatasetLabelsResponseTypeDef:
return {
"DatasetLabelDescriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatasetLabelsResponseTypeDef(TypedDict):
DatasetLabelDescriptions: List[DatasetLabelDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeProjectsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectsResponseTypeDef
def get_value() -> DescribeProjectsResponseTypeDef:
return {
"ProjectDescriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeProjectsResponseTypeDef(TypedDict):
ProjectDescriptions: List[ProjectDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DetectLabelsImagePropertiesTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsImagePropertiesTypeDef
def get_value() -> DetectLabelsImagePropertiesTypeDef:
return {
"Quality": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import LabelTypeDef
def get_value() -> LabelTypeDef:
return {
"Name": ...,
}
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
CelebrityDetailTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CelebrityDetailTypeDef
def get_value() -> CelebrityDetailTypeDef:
return {
"Urls": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import DetectFacesResponseTypeDef
def get_value() -> DetectFacesResponseTypeDef:
return {
"FaceDetails": ...,
"OrientationCorrection": ...,
"ResponseMetadata": ...,
}
Definition
class DetectFacesResponseTypeDef(TypedDict):
FaceDetails: List[FaceDetailTypeDef], # (1)
OrientationCorrection: OrientationCorrectionType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
FaceDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import FaceDetectionTypeDef
def get_value() -> FaceDetectionTypeDef:
return {
"Timestamp": ...,
}
Definition
class FaceDetectionTypeDef(TypedDict):
Timestamp: NotRequired[int],
Face: NotRequired[FaceDetailTypeDef], # (1)
FaceRecordTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import FaceRecordTypeDef
def get_value() -> FaceRecordTypeDef:
return {
"Face": ...,
}
Definition
class FaceRecordTypeDef(TypedDict):
Face: NotRequired[FaceTypeDef], # (1)
FaceDetail: NotRequired[FaceDetailTypeDef], # (2)
- See FaceTypeDef
- See FaceDetailTypeDef
PersonDetailTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PersonDetailTypeDef
def get_value() -> PersonDetailTypeDef:
return {
"Index": ...,
}
Definition
class PersonDetailTypeDef(TypedDict):
Index: NotRequired[int],
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Face: NotRequired[FaceDetailTypeDef], # (2)
- See BoundingBoxTypeDef
- See FaceDetailTypeDef
UnindexedFaceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import UnindexedFaceTypeDef
def get_value() -> UnindexedFaceTypeDef:
return {
"Reasons": ...,
}
Definition
class UnindexedFaceTypeDef(TypedDict):
Reasons: NotRequired[List[ReasonType]], # (1)
FaceDetail: NotRequired[FaceDetailTypeDef], # (2)
- See ReasonType
- See FaceDetailTypeDef
CustomLabelTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CustomLabelTypeDef
def get_value() -> CustomLabelTypeDef:
return {
"Name": ...,
}
Definition
class CustomLabelTypeDef(TypedDict):
Name: NotRequired[str],
Confidence: NotRequired[float],
Geometry: NotRequired[GeometryTypeDef], # (1)
- See GeometryTypeDef
TextDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TextDetectionTypeDef
def get_value() -> TextDetectionTypeDef:
return {
"DetectedText": ...,
}
Definition
class TextDetectionTypeDef(TypedDict):
DetectedText: NotRequired[str],
Type: NotRequired[TextTypesType], # (1)
Id: NotRequired[int],
ParentId: NotRequired[int],
Confidence: NotRequired[float],
Geometry: NotRequired[GeometryTypeDef], # (2)
- See TextTypesType
- See GeometryTypeDef
DetectTextFiltersTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectTextFiltersTypeDef
def get_value() -> DetectTextFiltersTypeDef:
return {
"WordFilter": ...,
}
Definition
class DetectTextFiltersTypeDef(TypedDict):
WordFilter: NotRequired[DetectionFilterTypeDef], # (1)
RegionsOfInterest: NotRequired[Sequence[RegionOfInterestTypeDef]], # (2)
StartTextDetectionFiltersTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartTextDetectionFiltersTypeDef
def get_value() -> StartTextDetectionFiltersTypeDef:
return {
"WordFilter": ...,
}
Definition
class StartTextDetectionFiltersTypeDef(TypedDict):
WordFilter: NotRequired[DetectionFilterTypeDef], # (1)
RegionsOfInterest: NotRequired[Sequence[RegionOfInterestTypeDef]], # (2)
UpdateStreamProcessorRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import UpdateStreamProcessorRequestRequestTypeDef
def get_value() -> UpdateStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class UpdateStreamProcessorRequestRequestTypeDef(TypedDict):
Name: str,
SettingsForUpdate: NotRequired[StreamProcessorSettingsForUpdateTypeDef], # (1)
RegionsOfInterestForUpdate: NotRequired[Sequence[RegionOfInterestTypeDef]], # (2)
DataSharingPreferenceForUpdate: NotRequired[StreamProcessorDataSharingPreferenceTypeDef], # (3)
ParametersToDelete: NotRequired[Sequence[StreamProcessorParameterToDeleteType]], # (4)
- See StreamProcessorSettingsForUpdateTypeDef
- See RegionOfInterestTypeDef
- See StreamProcessorDataSharingPreferenceTypeDef
- See StreamProcessorParameterToDeleteType
AssetTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import AssetTypeDef
def get_value() -> AssetTypeDef:
return {
"GroundTruthManifest": ...,
}
Definition
class AssetTypeDef(TypedDict):
GroundTruthManifest: NotRequired[GroundTruthManifestTypeDef], # (1)
DatasetSourceTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DatasetSourceTypeDef
def get_value() -> DatasetSourceTypeDef:
return {
"GroundTruthManifest": ...,
}
Definition
class DatasetSourceTypeDef(TypedDict):
GroundTruthManifest: NotRequired[GroundTruthManifestTypeDef], # (1)
DatasetArn: NotRequired[str],
CompareFacesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CompareFacesRequestRequestTypeDef
def get_value() -> CompareFacesRequestRequestTypeDef:
return {
"SourceImage": ...,
"TargetImage": ...,
}
Definition
class CompareFacesRequestRequestTypeDef(TypedDict):
SourceImage: ImageTypeDef, # (1)
TargetImage: ImageTypeDef, # (1)
SimilarityThreshold: NotRequired[float],
QualityFilter: NotRequired[QualityFilterType], # (3)
- See ImageTypeDef
- See ImageTypeDef
- See QualityFilterType
DetectCustomLabelsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectCustomLabelsRequestRequestTypeDef
def get_value() -> DetectCustomLabelsRequestRequestTypeDef:
return {
"ProjectVersionArn": ...,
"Image": ...,
}
Definition
class DetectCustomLabelsRequestRequestTypeDef(TypedDict):
ProjectVersionArn: str,
Image: ImageTypeDef, # (1)
MaxResults: NotRequired[int],
MinConfidence: NotRequired[float],
- See ImageTypeDef
DetectFacesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectFacesRequestRequestTypeDef
def get_value() -> DetectFacesRequestRequestTypeDef:
return {
"Image": ...,
}
Definition
class DetectFacesRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
Attributes: NotRequired[Sequence[AttributeType]], # (2)
- See ImageTypeDef
- See AttributeType
DetectLabelsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsRequestRequestTypeDef
def get_value() -> DetectLabelsRequestRequestTypeDef:
return {
"Image": ...,
}
Definition
class DetectLabelsRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
MaxLabels: NotRequired[int],
MinConfidence: NotRequired[float],
Features: NotRequired[Sequence[DetectLabelsFeatureNameType]], # (2)
Settings: NotRequired[DetectLabelsSettingsTypeDef], # (3)
DetectProtectiveEquipmentRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectProtectiveEquipmentRequestRequestTypeDef
def get_value() -> DetectProtectiveEquipmentRequestRequestTypeDef:
return {
"Image": ...,
}
Definition
class DetectProtectiveEquipmentRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
SummarizationAttributes: NotRequired[ProtectiveEquipmentSummarizationAttributesTypeDef], # (2)
IndexFacesRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import IndexFacesRequestRequestTypeDef
def get_value() -> IndexFacesRequestRequestTypeDef:
return {
"CollectionId": ...,
"Image": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import RecognizeCelebritiesRequestRequestTypeDef
def get_value() -> RecognizeCelebritiesRequestRequestTypeDef:
return {
"Image": ...,
}
- See ImageTypeDef
SearchFacesByImageRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SearchFacesByImageRequestRequestTypeDef
def get_value() -> SearchFacesByImageRequestRequestTypeDef:
return {
"CollectionId": ...,
"Image": ...,
}
Definition
class SearchFacesByImageRequestRequestTypeDef(TypedDict):
CollectionId: str,
Image: ImageTypeDef, # (1)
MaxFaces: NotRequired[int],
FaceMatchThreshold: NotRequired[float],
QualityFilter: NotRequired[QualityFilterType], # (2)
- See ImageTypeDef
- See QualityFilterType
EvaluationResultTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import EvaluationResultTypeDef
def get_value() -> EvaluationResultTypeDef:
return {
"F1Score": ...,
}
Definition
class EvaluationResultTypeDef(TypedDict):
F1Score: NotRequired[float],
Summary: NotRequired[SummaryTypeDef], # (1)
- See SummaryTypeDef
StartCelebrityRecognitionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartCelebrityRecognitionRequestRequestTypeDef
def get_value() -> StartCelebrityRecognitionRequestRequestTypeDef:
return {
"Video": ...,
}
Definition
class StartCelebrityRecognitionRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartContentModerationRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartContentModerationRequestRequestTypeDef
def get_value() -> StartContentModerationRequestRequestTypeDef:
return {
"Video": ...,
}
Definition
class StartContentModerationRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
MinConfidence: NotRequired[float],
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartFaceDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartFaceDetectionRequestRequestTypeDef
def get_value() -> StartFaceDetectionRequestRequestTypeDef:
return {
"Video": ...,
}
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
Usage Example
from mypy_boto3_rekognition.type_defs import StartFaceSearchRequestRequestTypeDef
def get_value() -> StartFaceSearchRequestRequestTypeDef:
return {
"Video": ...,
"CollectionId": ...,
}
Definition
class StartFaceSearchRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
CollectionId: str,
ClientRequestToken: NotRequired[str],
FaceMatchThreshold: NotRequired[float],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
StartLabelDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartLabelDetectionRequestRequestTypeDef
def get_value() -> StartLabelDetectionRequestRequestTypeDef:
return {
"Video": ...,
}
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
StartPersonTrackingRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartPersonTrackingRequestRequestTypeDef
def get_value() -> StartPersonTrackingRequestRequestTypeDef:
return {
"Video": ...,
}
Definition
class StartPersonTrackingRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
DetectModerationLabelsRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectModerationLabelsRequestRequestTypeDef
def get_value() -> DetectModerationLabelsRequestRequestTypeDef:
return {
"Image": ...,
}
Definition
class DetectModerationLabelsRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
MinConfidence: NotRequired[float],
HumanLoopConfig: NotRequired[HumanLoopConfigTypeDef], # (2)
- See ImageTypeDef
- See HumanLoopConfigTypeDef
StartStreamProcessorRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartStreamProcessorRequestRequestTypeDef
def get_value() -> StartStreamProcessorRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class StartStreamProcessorRequestRequestTypeDef(TypedDict):
Name: str,
StartSelector: NotRequired[StreamProcessingStartSelectorTypeDef], # (1)
StopSelector: NotRequired[StreamProcessingStopSelectorTypeDef], # (2)
CreateStreamProcessorRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateStreamProcessorRequestRequestTypeDef
def get_value() -> CreateStreamProcessorRequestRequestTypeDef:
return {
"Input": ...,
"Output": ...,
"Name": ...,
"Settings": ...,
"RoleArn": ...,
}
Definition
class CreateStreamProcessorRequestRequestTypeDef(TypedDict):
Input: StreamProcessorInputTypeDef, # (1)
Output: StreamProcessorOutputTypeDef, # (2)
Name: str,
Settings: StreamProcessorSettingsTypeDef, # (3)
RoleArn: str,
Tags: NotRequired[Mapping[str, str]],
NotificationChannel: NotRequired[StreamProcessorNotificationChannelTypeDef], # (4)
KmsKeyId: NotRequired[str],
RegionsOfInterest: NotRequired[Sequence[RegionOfInterestTypeDef]], # (5)
DataSharingPreference: NotRequired[StreamProcessorDataSharingPreferenceTypeDef], # (6)
- See StreamProcessorInputTypeDef
- See StreamProcessorOutputTypeDef
- See StreamProcessorSettingsTypeDef
- See StreamProcessorNotificationChannelTypeDef
- See RegionOfInterestTypeDef
- See StreamProcessorDataSharingPreferenceTypeDef
DescribeStreamProcessorResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeStreamProcessorResponseTypeDef
def get_value() -> DescribeStreamProcessorResponseTypeDef:
return {
"Name": ...,
"StreamProcessorArn": ...,
"Status": ...,
"StatusMessage": ...,
"CreationTimestamp": ...,
"LastUpdateTimestamp": ...,
"Input": ...,
"Output": ...,
"RoleArn": ...,
"Settings": ...,
"NotificationChannel": ...,
"KmsKeyId": ...,
"RegionsOfInterest": ...,
"DataSharingPreference": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeStreamProcessorResponseTypeDef(TypedDict):
Name: str,
StreamProcessorArn: str,
Status: StreamProcessorStatusType, # (1)
StatusMessage: str,
CreationTimestamp: datetime,
LastUpdateTimestamp: datetime,
Input: StreamProcessorInputTypeDef, # (2)
Output: StreamProcessorOutputTypeDef, # (3)
RoleArn: str,
Settings: StreamProcessorSettingsTypeDef, # (4)
NotificationChannel: StreamProcessorNotificationChannelTypeDef, # (5)
KmsKeyId: str,
RegionsOfInterest: List[RegionOfInterestTypeDef], # (6)
DataSharingPreference: StreamProcessorDataSharingPreferenceTypeDef, # (7)
ResponseMetadata: ResponseMetadataTypeDef, # (8)
- See StreamProcessorStatusType
- See StreamProcessorInputTypeDef
- See StreamProcessorOutputTypeDef
- See StreamProcessorSettingsTypeDef
- See StreamProcessorNotificationChannelTypeDef
- See RegionOfInterestTypeDef
- See StreamProcessorDataSharingPreferenceTypeDef
- See ResponseMetadataTypeDef
GetSegmentDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetSegmentDetectionResponseTypeDef
def get_value() -> GetSegmentDetectionResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"AudioMetadata": ...,
"NextToken": ...,
"Segments": ...,
"SelectedSegmentTypes": ...,
"ResponseMetadata": ...,
}
Definition
class GetSegmentDetectionResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: List[VideoMetadataTypeDef], # (2)
AudioMetadata: List[AudioMetadataTypeDef], # (3)
NextToken: str,
Segments: List[SegmentDetectionTypeDef], # (4)
SelectedSegmentTypes: List[SegmentTypeInfoTypeDef], # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See AudioMetadataTypeDef
- See SegmentDetectionTypeDef
- See SegmentTypeInfoTypeDef
- See ResponseMetadataTypeDef
StartSegmentDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartSegmentDetectionRequestRequestTypeDef
def get_value() -> StartSegmentDetectionRequestRequestTypeDef:
return {
"Video": ...,
"SegmentTypes": ...,
}
Definition
class StartSegmentDetectionRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
SegmentTypes: Sequence[SegmentTypeType], # (2)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (3)
JobTag: NotRequired[str],
Filters: NotRequired[StartSegmentDetectionFiltersTypeDef], # (4)
- See VideoTypeDef
- See SegmentTypeType
- See NotificationChannelTypeDef
- See StartSegmentDetectionFiltersTypeDef
SearchFacesByImageResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SearchFacesByImageResponseTypeDef
def get_value() -> SearchFacesByImageResponseTypeDef:
return {
"SearchedFaceBoundingBox": ...,
"SearchedFaceConfidence": ...,
"FaceMatches": ...,
"FaceModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class SearchFacesByImageResponseTypeDef(TypedDict):
SearchedFaceBoundingBox: BoundingBoxTypeDef, # (1)
SearchedFaceConfidence: float,
FaceMatches: List[FaceMatchTypeDef], # (2)
FaceModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
SearchFacesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import SearchFacesResponseTypeDef
def get_value() -> SearchFacesResponseTypeDef:
return {
"SearchedFaceId": ...,
"FaceMatches": ...,
"FaceModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class SearchFacesResponseTypeDef(TypedDict):
SearchedFaceId: str,
FaceMatches: List[FaceMatchTypeDef], # (1)
FaceModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RecognizeCelebritiesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import RecognizeCelebritiesResponseTypeDef
def get_value() -> RecognizeCelebritiesResponseTypeDef:
return {
"CelebrityFaces": ...,
"UnrecognizedFaces": ...,
"OrientationCorrection": ...,
"ResponseMetadata": ...,
}
Definition
class RecognizeCelebritiesResponseTypeDef(TypedDict):
CelebrityFaces: List[CelebrityTypeDef], # (1)
UnrecognizedFaces: List[ComparedFaceTypeDef], # (2)
OrientationCorrection: OrientationCorrectionType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See CelebrityTypeDef
- See ComparedFaceTypeDef
- See OrientationCorrectionType
- See ResponseMetadataTypeDef
CompareFacesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CompareFacesResponseTypeDef
def get_value() -> CompareFacesResponseTypeDef:
return {
"SourceImageFace": ...,
"FaceMatches": ...,
"UnmatchedFaces": ...,
"SourceImageOrientationCorrection": ...,
"TargetImageOrientationCorrection": ...,
"ResponseMetadata": ...,
}
Definition
class CompareFacesResponseTypeDef(TypedDict):
SourceImageFace: ComparedSourceImageFaceTypeDef, # (1)
FaceMatches: List[CompareFacesMatchTypeDef], # (2)
UnmatchedFaces: List[ComparedFaceTypeDef], # (3)
SourceImageOrientationCorrection: OrientationCorrectionType, # (4)
TargetImageOrientationCorrection: OrientationCorrectionType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See ComparedSourceImageFaceTypeDef
- See CompareFacesMatchTypeDef
- See ComparedFaceTypeDef
- See OrientationCorrectionType
- See OrientationCorrectionType
- See ResponseMetadataTypeDef
ProtectiveEquipmentPersonTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProtectiveEquipmentPersonTypeDef
def get_value() -> ProtectiveEquipmentPersonTypeDef:
return {
"BodyParts": ...,
}
Definition
class ProtectiveEquipmentPersonTypeDef(TypedDict):
BodyParts: NotRequired[List[ProtectiveEquipmentBodyPartTypeDef]], # (1)
BoundingBox: NotRequired[BoundingBoxTypeDef], # (2)
Confidence: NotRequired[float],
Id: NotRequired[int],
DetectLabelsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectLabelsResponseTypeDef
def get_value() -> DetectLabelsResponseTypeDef:
return {
"Labels": ...,
"OrientationCorrection": ...,
"LabelModelVersion": ...,
"ImageProperties": ...,
"ResponseMetadata": ...,
}
Definition
class DetectLabelsResponseTypeDef(TypedDict):
Labels: List[LabelTypeDef], # (1)
OrientationCorrection: OrientationCorrectionType, # (2)
LabelModelVersion: str,
ImageProperties: DetectLabelsImagePropertiesTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See LabelTypeDef
- See OrientationCorrectionType
- See DetectLabelsImagePropertiesTypeDef
- See ResponseMetadataTypeDef
LabelDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import LabelDetectionTypeDef
def get_value() -> LabelDetectionTypeDef:
return {
"Timestamp": ...,
}
Definition
class LabelDetectionTypeDef(TypedDict):
Timestamp: NotRequired[int],
Label: NotRequired[LabelTypeDef], # (1)
StartTimestampMillis: NotRequired[int],
EndTimestampMillis: NotRequired[int],
DurationMillis: NotRequired[int],
- See LabelTypeDef
CelebrityRecognitionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CelebrityRecognitionTypeDef
def get_value() -> CelebrityRecognitionTypeDef:
return {
"Timestamp": ...,
}
Definition
class CelebrityRecognitionTypeDef(TypedDict):
Timestamp: NotRequired[int],
Celebrity: NotRequired[CelebrityDetailTypeDef], # (1)
GetFaceDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetFaceDetectionResponseTypeDef
def get_value() -> GetFaceDetectionResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"NextToken": ...,
"Faces": ...,
"ResponseMetadata": ...,
}
Definition
class GetFaceDetectionResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
NextToken: str,
Faces: List[FaceDetectionTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See FaceDetectionTypeDef
- See ResponseMetadataTypeDef
PersonDetectionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PersonDetectionTypeDef
def get_value() -> PersonDetectionTypeDef:
return {
"Timestamp": ...,
}
Definition
class PersonDetectionTypeDef(TypedDict):
Timestamp: NotRequired[int],
Person: NotRequired[PersonDetailTypeDef], # (1)
PersonMatchTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import PersonMatchTypeDef
def get_value() -> PersonMatchTypeDef:
return {
"Timestamp": ...,
}
Definition
class PersonMatchTypeDef(TypedDict):
Timestamp: NotRequired[int],
Person: NotRequired[PersonDetailTypeDef], # (1)
FaceMatches: NotRequired[List[FaceMatchTypeDef]], # (2)
- See PersonDetailTypeDef
- See FaceMatchTypeDef
IndexFacesResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import IndexFacesResponseTypeDef
def get_value() -> IndexFacesResponseTypeDef:
return {
"FaceRecords": ...,
"OrientationCorrection": ...,
"FaceModelVersion": ...,
"UnindexedFaces": ...,
"ResponseMetadata": ...,
}
Definition
class IndexFacesResponseTypeDef(TypedDict):
FaceRecords: List[FaceRecordTypeDef], # (1)
OrientationCorrection: OrientationCorrectionType, # (2)
FaceModelVersion: str,
UnindexedFaces: List[UnindexedFaceTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See FaceRecordTypeDef
- See OrientationCorrectionType
- See UnindexedFaceTypeDef
- See ResponseMetadataTypeDef
DetectCustomLabelsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectCustomLabelsResponseTypeDef
def get_value() -> DetectCustomLabelsResponseTypeDef:
return {
"CustomLabels": ...,
"ResponseMetadata": ...,
}
Definition
class DetectCustomLabelsResponseTypeDef(TypedDict):
CustomLabels: List[CustomLabelTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DetectTextResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectTextResponseTypeDef
def get_value() -> DetectTextResponseTypeDef:
return {
"TextDetections": ...,
"TextModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class DetectTextResponseTypeDef(TypedDict):
TextDetections: List[TextDetectionTypeDef], # (1)
TextModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TextDetectionResultTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TextDetectionResultTypeDef
def get_value() -> TextDetectionResultTypeDef:
return {
"Timestamp": ...,
}
Definition
class TextDetectionResultTypeDef(TypedDict):
Timestamp: NotRequired[int],
TextDetection: NotRequired[TextDetectionTypeDef], # (1)
DetectTextRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectTextRequestRequestTypeDef
def get_value() -> DetectTextRequestRequestTypeDef:
return {
"Image": ...,
}
Definition
class DetectTextRequestRequestTypeDef(TypedDict):
Image: ImageTypeDef, # (1)
Filters: NotRequired[DetectTextFiltersTypeDef], # (2)
- See ImageTypeDef
- See DetectTextFiltersTypeDef
StartTextDetectionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import StartTextDetectionRequestRequestTypeDef
def get_value() -> StartTextDetectionRequestRequestTypeDef:
return {
"Video": ...,
}
Definition
class StartTextDetectionRequestRequestTypeDef(TypedDict):
Video: VideoTypeDef, # (1)
ClientRequestToken: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
JobTag: NotRequired[str],
Filters: NotRequired[StartTextDetectionFiltersTypeDef], # (3)
TestingDataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TestingDataTypeDef
def get_value() -> TestingDataTypeDef:
return {
"Assets": ...,
}
Definition
class TestingDataTypeDef(TypedDict):
Assets: NotRequired[Sequence[AssetTypeDef]], # (1)
AutoCreate: NotRequired[bool],
- See AssetTypeDef
TrainingDataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TrainingDataTypeDef
def get_value() -> TrainingDataTypeDef:
return {
"Assets": ...,
}
- See AssetTypeDef
ValidationDataTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ValidationDataTypeDef
def get_value() -> ValidationDataTypeDef:
return {
"Assets": ...,
}
- See AssetTypeDef
CreateDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateDatasetRequestRequestTypeDef
def get_value() -> CreateDatasetRequestRequestTypeDef:
return {
"DatasetType": ...,
"ProjectArn": ...,
}
Definition
class CreateDatasetRequestRequestTypeDef(TypedDict):
DatasetType: DatasetTypeType, # (1)
ProjectArn: str,
DatasetSource: NotRequired[DatasetSourceTypeDef], # (2)
- See DatasetTypeType
- See DatasetSourceTypeDef
DetectProtectiveEquipmentResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DetectProtectiveEquipmentResponseTypeDef
def get_value() -> DetectProtectiveEquipmentResponseTypeDef:
return {
"ProtectiveEquipmentModelVersion": ...,
"Persons": ...,
"Summary": ...,
"ResponseMetadata": ...,
}
Definition
class DetectProtectiveEquipmentResponseTypeDef(TypedDict):
ProtectiveEquipmentModelVersion: str,
Persons: List[ProtectiveEquipmentPersonTypeDef], # (1)
Summary: ProtectiveEquipmentSummaryTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ProtectiveEquipmentPersonTypeDef
- See ProtectiveEquipmentSummaryTypeDef
- See ResponseMetadataTypeDef
GetLabelDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetLabelDetectionResponseTypeDef
def get_value() -> GetLabelDetectionResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"NextToken": ...,
"Labels": ...,
"LabelModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class GetLabelDetectionResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
NextToken: str,
Labels: List[LabelDetectionTypeDef], # (3)
LabelModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See LabelDetectionTypeDef
- See ResponseMetadataTypeDef
GetCelebrityRecognitionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetCelebrityRecognitionResponseTypeDef
def get_value() -> GetCelebrityRecognitionResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"NextToken": ...,
"Celebrities": ...,
"ResponseMetadata": ...,
}
Definition
class GetCelebrityRecognitionResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
NextToken: str,
Celebrities: List[CelebrityRecognitionTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See CelebrityRecognitionTypeDef
- See ResponseMetadataTypeDef
GetPersonTrackingResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetPersonTrackingResponseTypeDef
def get_value() -> GetPersonTrackingResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"NextToken": ...,
"Persons": ...,
"ResponseMetadata": ...,
}
Definition
class GetPersonTrackingResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
NextToken: str,
Persons: List[PersonDetectionTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See PersonDetectionTypeDef
- See ResponseMetadataTypeDef
GetFaceSearchResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetFaceSearchResponseTypeDef
def get_value() -> GetFaceSearchResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"NextToken": ...,
"VideoMetadata": ...,
"Persons": ...,
"ResponseMetadata": ...,
}
Definition
class GetFaceSearchResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
NextToken: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
Persons: List[PersonMatchTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
GetTextDetectionResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import GetTextDetectionResponseTypeDef
def get_value() -> GetTextDetectionResponseTypeDef:
return {
"JobStatus": ...,
"StatusMessage": ...,
"VideoMetadata": ...,
"TextDetections": ...,
"NextToken": ...,
"TextModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class GetTextDetectionResponseTypeDef(TypedDict):
JobStatus: VideoJobStatusType, # (1)
StatusMessage: str,
VideoMetadata: VideoMetadataTypeDef, # (2)
TextDetections: List[TextDetectionResultTypeDef], # (3)
NextToken: str,
TextModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VideoJobStatusType
- See VideoMetadataTypeDef
- See TextDetectionResultTypeDef
- See ResponseMetadataTypeDef
CreateProjectVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import CreateProjectVersionRequestRequestTypeDef
def get_value() -> CreateProjectVersionRequestRequestTypeDef:
return {
"ProjectArn": ...,
"VersionName": ...,
"OutputConfig": ...,
}
Definition
class CreateProjectVersionRequestRequestTypeDef(TypedDict):
ProjectArn: str,
VersionName: str,
OutputConfig: OutputConfigTypeDef, # (1)
TrainingData: NotRequired[TrainingDataTypeDef], # (2)
TestingData: NotRequired[TestingDataTypeDef], # (3)
Tags: NotRequired[Mapping[str, str]],
KmsKeyId: NotRequired[str],
- See OutputConfigTypeDef
- See TrainingDataTypeDef
- See TestingDataTypeDef
TestingDataResultTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TestingDataResultTypeDef
def get_value() -> TestingDataResultTypeDef:
return {
"Input": ...,
}
Definition
class TestingDataResultTypeDef(TypedDict):
Input: NotRequired[TestingDataTypeDef], # (1)
Output: NotRequired[TestingDataTypeDef], # (1)
Validation: NotRequired[ValidationDataTypeDef], # (3)
TrainingDataResultTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import TrainingDataResultTypeDef
def get_value() -> TrainingDataResultTypeDef:
return {
"Input": ...,
}
Definition
class TrainingDataResultTypeDef(TypedDict):
Input: NotRequired[TrainingDataTypeDef], # (1)
Output: NotRequired[TrainingDataTypeDef], # (1)
Validation: NotRequired[ValidationDataTypeDef], # (3)
ProjectVersionDescriptionTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import ProjectVersionDescriptionTypeDef
def get_value() -> ProjectVersionDescriptionTypeDef:
return {
"ProjectVersionArn": ...,
}
Definition
class ProjectVersionDescriptionTypeDef(TypedDict):
ProjectVersionArn: NotRequired[str],
CreationTimestamp: NotRequired[datetime],
MinInferenceUnits: NotRequired[int],
Status: NotRequired[ProjectVersionStatusType], # (1)
StatusMessage: NotRequired[str],
BillableTrainingTimeInSeconds: NotRequired[int],
TrainingEndTimestamp: NotRequired[datetime],
OutputConfig: NotRequired[OutputConfigTypeDef], # (2)
TrainingDataResult: NotRequired[TrainingDataResultTypeDef], # (3)
TestingDataResult: NotRequired[TestingDataResultTypeDef], # (4)
EvaluationResult: NotRequired[EvaluationResultTypeDef], # (5)
ManifestSummary: NotRequired[GroundTruthManifestTypeDef], # (6)
KmsKeyId: NotRequired[str],
MaxInferenceUnits: NotRequired[int],
SourceProjectVersionArn: NotRequired[str],
- See ProjectVersionStatusType
- See OutputConfigTypeDef
- See TrainingDataResultTypeDef
- See TestingDataResultTypeDef
- See EvaluationResultTypeDef
- See GroundTruthManifestTypeDef
DescribeProjectVersionsResponseTypeDef
Usage Example
from mypy_boto3_rekognition.type_defs import DescribeProjectVersionsResponseTypeDef
def get_value() -> DescribeProjectVersionsResponseTypeDef:
return {
"ProjectVersionDescriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}