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)