Skip to content

Type definitions#

Index > Rekognition > Type definitions

Auto-generated documentation for Rekognition type annotations stubs module mypy-boto3-rekognition.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AgeRangeTypeDef#

# AgeRangeTypeDef definition

class AgeRangeTypeDef(TypedDict):
    Low: NotRequired[int],
    High: NotRequired[int],

AssociateFacesRequestRequestTypeDef#

# AssociateFacesRequestRequestTypeDef definition

class AssociateFacesRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    UserId: str,
    FaceIds: Sequence[str],
    UserMatchThreshold: NotRequired[float],
    ClientRequestToken: NotRequired[str],

AssociatedFaceTypeDef#

# AssociatedFaceTypeDef definition

class AssociatedFaceTypeDef(TypedDict):
    FaceId: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

UnsuccessfulFaceAssociationTypeDef#

# UnsuccessfulFaceAssociationTypeDef definition

class UnsuccessfulFaceAssociationTypeDef(TypedDict):
    FaceId: NotRequired[str],
    UserId: NotRequired[str],
    Confidence: NotRequired[float],
    Reasons: NotRequired[List[UnsuccessfulFaceAssociationReasonType]],  # (1)
  1. See UnsuccessfulFaceAssociationReasonType

AudioMetadataTypeDef#

# AudioMetadataTypeDef definition

class AudioMetadataTypeDef(TypedDict):
    Codec: NotRequired[str],
    DurationMillis: NotRequired[int],
    SampleRate: NotRequired[int],
    NumberOfChannels: NotRequired[int],

BoundingBoxTypeDef#

# BoundingBoxTypeDef definition

class BoundingBoxTypeDef(TypedDict):
    Width: NotRequired[float],
    Height: NotRequired[float],
    Left: NotRequired[float],
    Top: NotRequired[float],

S3ObjectTypeDef#

# S3ObjectTypeDef definition

class S3ObjectTypeDef(TypedDict):
    Bucket: NotRequired[str],
    Name: NotRequired[str],
    Version: NotRequired[str],

BeardTypeDef#

# BeardTypeDef definition

class BeardTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

BlackFrameTypeDef#

# BlackFrameTypeDef definition

class BlackFrameTypeDef(TypedDict):
    MaxPixelThreshold: NotRequired[float],
    MinCoveragePercentage: NotRequired[float],

KnownGenderTypeDef#

# KnownGenderTypeDef definition

class KnownGenderTypeDef(TypedDict):
    Type: NotRequired[KnownGenderTypeType],  # (1)
  1. See KnownGenderTypeType

EmotionTypeDef#

# EmotionTypeDef definition

class EmotionTypeDef(TypedDict):
    Type: NotRequired[EmotionNameType],  # (1)
    Confidence: NotRequired[float],
  1. See EmotionNameType

ImageQualityTypeDef#

# ImageQualityTypeDef definition

class ImageQualityTypeDef(TypedDict):
    Brightness: NotRequired[float],
    Sharpness: NotRequired[float],

LandmarkTypeDef#

# LandmarkTypeDef definition

class LandmarkTypeDef(TypedDict):
    Type: NotRequired[LandmarkTypeType],  # (1)
    X: NotRequired[float],
    Y: NotRequired[float],
  1. See LandmarkTypeType

PoseTypeDef#

# PoseTypeDef definition

class PoseTypeDef(TypedDict):
    Roll: NotRequired[float],
    Yaw: NotRequired[float],
    Pitch: NotRequired[float],

SmileTypeDef#

# SmileTypeDef definition

class SmileTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

ConnectedHomeSettingsForUpdateTypeDef#

# ConnectedHomeSettingsForUpdateTypeDef definition

class ConnectedHomeSettingsForUpdateTypeDef(TypedDict):
    Labels: NotRequired[Sequence[str]],
    MinConfidence: NotRequired[float],

ConnectedHomeSettingsTypeDef#

# ConnectedHomeSettingsTypeDef definition

class ConnectedHomeSettingsTypeDef(TypedDict):
    Labels: Sequence[str],
    MinConfidence: NotRequired[float],

ModerationLabelTypeDef#

# ModerationLabelTypeDef definition

class ModerationLabelTypeDef(TypedDict):
    Confidence: NotRequired[float],
    Name: NotRequired[str],
    ParentName: NotRequired[str],
    TaxonomyLevel: NotRequired[int],

ContentTypeTypeDef#

# ContentTypeTypeDef definition

class ContentTypeTypeDef(TypedDict):
    Confidence: NotRequired[float],
    Name: NotRequired[str],

OutputConfigTypeDef#

# OutputConfigTypeDef definition

class OutputConfigTypeDef(TypedDict):
    S3Bucket: NotRequired[str],
    S3KeyPrefix: NotRequired[str],

CoversBodyPartTypeDef#

# CoversBodyPartTypeDef definition

class CoversBodyPartTypeDef(TypedDict):
    Confidence: NotRequired[float],
    Value: NotRequired[bool],

CreateCollectionRequestRequestTypeDef#

# CreateCollectionRequestRequestTypeDef definition

class CreateCollectionRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    Tags: NotRequired[Mapping[str, str]],

LivenessOutputConfigTypeDef#

# LivenessOutputConfigTypeDef definition

class LivenessOutputConfigTypeDef(TypedDict):
    S3Bucket: str,
    S3KeyPrefix: NotRequired[str],

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    Feature: NotRequired[CustomizationFeatureType],  # (1)
    AutoUpdate: NotRequired[ProjectAutoUpdateType],  # (2)
  1. See CustomizationFeatureType
  2. See ProjectAutoUpdateType

StreamProcessorDataSharingPreferenceTypeDef#

# StreamProcessorDataSharingPreferenceTypeDef definition

class StreamProcessorDataSharingPreferenceTypeDef(TypedDict):
    OptIn: bool,

StreamProcessorNotificationChannelTypeDef#

# StreamProcessorNotificationChannelTypeDef definition

class StreamProcessorNotificationChannelTypeDef(TypedDict):
    SNSTopicArn: str,

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    UserId: str,
    ClientRequestToken: NotRequired[str],

CustomizationFeatureContentModerationConfigTypeDef#

# CustomizationFeatureContentModerationConfigTypeDef definition

class CustomizationFeatureContentModerationConfigTypeDef(TypedDict):
    ConfidenceThreshold: NotRequired[float],

DatasetStatsTypeDef#

# DatasetStatsTypeDef definition

class DatasetStatsTypeDef(TypedDict):
    LabeledEntries: NotRequired[int],
    TotalEntries: NotRequired[int],
    TotalLabels: NotRequired[int],
    ErrorEntries: NotRequired[int],

DatasetLabelStatsTypeDef#

# DatasetLabelStatsTypeDef definition

class DatasetLabelStatsTypeDef(TypedDict):
    EntryCount: NotRequired[int],
    BoundingBoxCount: NotRequired[int],

DatasetMetadataTypeDef#

# DatasetMetadataTypeDef definition

class DatasetMetadataTypeDef(TypedDict):
    CreationTimestamp: NotRequired[datetime],
    DatasetType: NotRequired[DatasetTypeType],  # (1)
    DatasetArn: NotRequired[str],
    Status: NotRequired[DatasetStatusType],  # (2)
    StatusMessage: NotRequired[str],
    StatusMessageCode: NotRequired[DatasetStatusMessageCodeType],  # (3)
  1. See DatasetTypeType
  2. See DatasetStatusType
  3. See DatasetStatusMessageCodeType

DeleteCollectionRequestRequestTypeDef#

# DeleteCollectionRequestRequestTypeDef definition

class DeleteCollectionRequestRequestTypeDef(TypedDict):
    CollectionId: str,

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    DatasetArn: str,

DeleteFacesRequestRequestTypeDef#

# DeleteFacesRequestRequestTypeDef definition

class DeleteFacesRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    FaceIds: Sequence[str],

UnsuccessfulFaceDeletionTypeDef#

# UnsuccessfulFaceDeletionTypeDef definition

class UnsuccessfulFaceDeletionTypeDef(TypedDict):
    FaceId: NotRequired[str],
    UserId: NotRequired[str],
    Reasons: NotRequired[List[UnsuccessfulFaceDeletionReasonType]],  # (1)
  1. See UnsuccessfulFaceDeletionReasonType

DeleteProjectPolicyRequestRequestTypeDef#

# DeleteProjectPolicyRequestRequestTypeDef definition

class DeleteProjectPolicyRequestRequestTypeDef(TypedDict):
    ProjectArn: str,
    PolicyName: str,
    PolicyRevisionId: NotRequired[str],

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    ProjectArn: str,

DeleteProjectVersionRequestRequestTypeDef#

# DeleteProjectVersionRequestRequestTypeDef definition

class DeleteProjectVersionRequestRequestTypeDef(TypedDict):
    ProjectVersionArn: str,

DeleteStreamProcessorRequestRequestTypeDef#

# DeleteStreamProcessorRequestRequestTypeDef definition

class DeleteStreamProcessorRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    UserId: str,
    ClientRequestToken: NotRequired[str],

DescribeCollectionRequestRequestTypeDef#

# DescribeCollectionRequestRequestTypeDef definition

class DescribeCollectionRequestRequestTypeDef(TypedDict):
    CollectionId: str,

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    DatasetArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeProjectVersionsRequestRequestTypeDef#

# DescribeProjectVersionsRequestRequestTypeDef definition

class DescribeProjectVersionsRequestRequestTypeDef(TypedDict):
    ProjectArn: str,
    VersionNames: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeProjectsRequestRequestTypeDef#

# DescribeProjectsRequestRequestTypeDef definition

class DescribeProjectsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ProjectNames: NotRequired[Sequence[str]],
    Features: NotRequired[Sequence[CustomizationFeatureType]],  # (1)
  1. See CustomizationFeatureType

DescribeStreamProcessorRequestRequestTypeDef#

# DescribeStreamProcessorRequestRequestTypeDef definition

class DescribeStreamProcessorRequestRequestTypeDef(TypedDict):
    Name: str,

DetectLabelsImageQualityTypeDef#

# DetectLabelsImageQualityTypeDef definition

class DetectLabelsImageQualityTypeDef(TypedDict):
    Brightness: NotRequired[float],
    Sharpness: NotRequired[float],
    Contrast: NotRequired[float],

DominantColorTypeDef#

# DominantColorTypeDef definition

class DominantColorTypeDef(TypedDict):
    Red: NotRequired[int],
    Blue: NotRequired[int],
    Green: NotRequired[int],
    HexCode: NotRequired[str],
    CSSColor: NotRequired[str],
    SimplifiedColor: NotRequired[str],
    PixelPercent: NotRequired[float],

DetectLabelsImagePropertiesSettingsTypeDef#

# DetectLabelsImagePropertiesSettingsTypeDef definition

class DetectLabelsImagePropertiesSettingsTypeDef(TypedDict):
    MaxDominantColors: NotRequired[int],

GeneralLabelsSettingsTypeDef#

# GeneralLabelsSettingsTypeDef definition

class GeneralLabelsSettingsTypeDef(TypedDict):
    LabelInclusionFilters: NotRequired[Sequence[str]],
    LabelExclusionFilters: NotRequired[Sequence[str]],
    LabelCategoryInclusionFilters: NotRequired[Sequence[str]],
    LabelCategoryExclusionFilters: NotRequired[Sequence[str]],

HumanLoopActivationOutputTypeDef#

# HumanLoopActivationOutputTypeDef definition

class HumanLoopActivationOutputTypeDef(TypedDict):
    HumanLoopArn: NotRequired[str],
    HumanLoopActivationReasons: NotRequired[List[str]],
    HumanLoopActivationConditionsEvaluationResults: NotRequired[str],

ProtectiveEquipmentSummarizationAttributesTypeDef#

# ProtectiveEquipmentSummarizationAttributesTypeDef definition

class ProtectiveEquipmentSummarizationAttributesTypeDef(TypedDict):
    MinConfidence: float,
    RequiredEquipmentTypes: Sequence[ProtectiveEquipmentTypeType],  # (1)
  1. See ProtectiveEquipmentTypeType

ProtectiveEquipmentSummaryTypeDef#

# ProtectiveEquipmentSummaryTypeDef definition

class ProtectiveEquipmentSummaryTypeDef(TypedDict):
    PersonsWithRequiredEquipment: NotRequired[List[int]],
    PersonsWithoutRequiredEquipment: NotRequired[List[int]],
    PersonsIndeterminate: NotRequired[List[int]],

DetectionFilterTypeDef#

# DetectionFilterTypeDef definition

class DetectionFilterTypeDef(TypedDict):
    MinConfidence: NotRequired[float],
    MinBoundingBoxHeight: NotRequired[float],
    MinBoundingBoxWidth: NotRequired[float],

DisassociateFacesRequestRequestTypeDef#

# DisassociateFacesRequestRequestTypeDef definition

class DisassociateFacesRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    UserId: str,
    FaceIds: Sequence[str],
    ClientRequestToken: NotRequired[str],

DisassociatedFaceTypeDef#

# DisassociatedFaceTypeDef definition

class DisassociatedFaceTypeDef(TypedDict):
    FaceId: NotRequired[str],

UnsuccessfulFaceDisassociationTypeDef#

# UnsuccessfulFaceDisassociationTypeDef definition

class UnsuccessfulFaceDisassociationTypeDef(TypedDict):
    FaceId: NotRequired[str],
    UserId: NotRequired[str],
    Reasons: NotRequired[List[UnsuccessfulFaceDisassociationReasonType]],  # (1)
  1. See UnsuccessfulFaceDisassociationReasonType

DistributeDatasetTypeDef#

# DistributeDatasetTypeDef definition

class DistributeDatasetTypeDef(TypedDict):
    Arn: str,

EyeDirectionTypeDef#

# EyeDirectionTypeDef definition

class EyeDirectionTypeDef(TypedDict):
    Yaw: NotRequired[float],
    Pitch: NotRequired[float],
    Confidence: NotRequired[float],

EyeOpenTypeDef#

# EyeOpenTypeDef definition

class EyeOpenTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

EyeglassesTypeDef#

# EyeglassesTypeDef definition

class EyeglassesTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

FaceOccludedTypeDef#

# FaceOccludedTypeDef definition

class FaceOccludedTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

GenderTypeDef#

# GenderTypeDef definition

class GenderTypeDef(TypedDict):
    Value: NotRequired[GenderTypeType],  # (1)
    Confidence: NotRequired[float],
  1. See GenderTypeType

MouthOpenTypeDef#

# MouthOpenTypeDef definition

class MouthOpenTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

MustacheTypeDef#

# MustacheTypeDef definition

class MustacheTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

SunglassesTypeDef#

# SunglassesTypeDef definition

class SunglassesTypeDef(TypedDict):
    Value: NotRequired[bool],
    Confidence: NotRequired[float],

FaceSearchSettingsTypeDef#

# FaceSearchSettingsTypeDef definition

class FaceSearchSettingsTypeDef(TypedDict):
    CollectionId: NotRequired[str],
    FaceMatchThreshold: NotRequired[float],

PointTypeDef#

# PointTypeDef definition

class PointTypeDef(TypedDict):
    X: NotRequired[float],
    Y: NotRequired[float],

GetCelebrityInfoRequestRequestTypeDef#

# GetCelebrityInfoRequestRequestTypeDef definition

class GetCelebrityInfoRequestRequestTypeDef(TypedDict):
    Id: str,

GetCelebrityRecognitionRequestRequestTypeDef#

# GetCelebrityRecognitionRequestRequestTypeDef definition

class GetCelebrityRecognitionRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[CelebrityRecognitionSortByType],  # (1)
  1. See CelebrityRecognitionSortByType

VideoMetadataTypeDef#

# VideoMetadataTypeDef definition

class VideoMetadataTypeDef(TypedDict):
    Codec: NotRequired[str],
    DurationMillis: NotRequired[int],
    Format: NotRequired[str],
    FrameRate: NotRequired[float],
    FrameHeight: NotRequired[int],
    FrameWidth: NotRequired[int],
    ColorRange: NotRequired[VideoColorRangeType],  # (1)
  1. See VideoColorRangeType

GetContentModerationRequestMetadataTypeDef#

# GetContentModerationRequestMetadataTypeDef definition

class GetContentModerationRequestMetadataTypeDef(TypedDict):
    SortBy: NotRequired[ContentModerationSortByType],  # (1)
    AggregateBy: NotRequired[ContentModerationAggregateByType],  # (2)
  1. See ContentModerationSortByType
  2. See ContentModerationAggregateByType

GetContentModerationRequestRequestTypeDef#

# GetContentModerationRequestRequestTypeDef definition

class GetContentModerationRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[ContentModerationSortByType],  # (1)
    AggregateBy: NotRequired[ContentModerationAggregateByType],  # (2)
  1. See ContentModerationSortByType
  2. See ContentModerationAggregateByType

GetFaceDetectionRequestRequestTypeDef#

# GetFaceDetectionRequestRequestTypeDef definition

class GetFaceDetectionRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetFaceLivenessSessionResultsRequestRequestTypeDef#

# GetFaceLivenessSessionResultsRequestRequestTypeDef definition

class GetFaceLivenessSessionResultsRequestRequestTypeDef(TypedDict):
    SessionId: str,

GetFaceSearchRequestRequestTypeDef#

# GetFaceSearchRequestRequestTypeDef definition

class GetFaceSearchRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[FaceSearchSortByType],  # (1)
  1. See FaceSearchSortByType

GetLabelDetectionRequestMetadataTypeDef#

# GetLabelDetectionRequestMetadataTypeDef definition

class GetLabelDetectionRequestMetadataTypeDef(TypedDict):
    SortBy: NotRequired[LabelDetectionSortByType],  # (1)
    AggregateBy: NotRequired[LabelDetectionAggregateByType],  # (2)
  1. See LabelDetectionSortByType
  2. See LabelDetectionAggregateByType

GetLabelDetectionRequestRequestTypeDef#

# GetLabelDetectionRequestRequestTypeDef definition

class GetLabelDetectionRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[LabelDetectionSortByType],  # (1)
    AggregateBy: NotRequired[LabelDetectionAggregateByType],  # (2)
  1. See LabelDetectionSortByType
  2. See LabelDetectionAggregateByType

GetMediaAnalysisJobRequestRequestTypeDef#

# GetMediaAnalysisJobRequestRequestTypeDef definition

class GetMediaAnalysisJobRequestRequestTypeDef(TypedDict):
    JobId: str,

MediaAnalysisJobFailureDetailsTypeDef#

# MediaAnalysisJobFailureDetailsTypeDef definition

class MediaAnalysisJobFailureDetailsTypeDef(TypedDict):
    Code: NotRequired[MediaAnalysisJobFailureCodeType],  # (1)
    Message: NotRequired[str],
  1. See MediaAnalysisJobFailureCodeType

MediaAnalysisOutputConfigTypeDef#

# MediaAnalysisOutputConfigTypeDef definition

class MediaAnalysisOutputConfigTypeDef(TypedDict):
    S3Bucket: str,
    S3KeyPrefix: NotRequired[str],

GetPersonTrackingRequestRequestTypeDef#

# GetPersonTrackingRequestRequestTypeDef definition

class GetPersonTrackingRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[PersonTrackingSortByType],  # (1)
  1. See PersonTrackingSortByType

GetSegmentDetectionRequestRequestTypeDef#

# GetSegmentDetectionRequestRequestTypeDef definition

class GetSegmentDetectionRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

SegmentTypeInfoTypeDef#

# SegmentTypeInfoTypeDef definition

class SegmentTypeInfoTypeDef(TypedDict):
    Type: NotRequired[SegmentTypeType],  # (1)
    ModelVersion: NotRequired[str],
  1. See SegmentTypeType

GetTextDetectionRequestRequestTypeDef#

# GetTextDetectionRequestRequestTypeDef definition

class GetTextDetectionRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

HumanLoopDataAttributesTypeDef#

# HumanLoopDataAttributesTypeDef definition

class HumanLoopDataAttributesTypeDef(TypedDict):
    ContentClassifiers: NotRequired[Sequence[ContentClassifierType]],  # (1)
  1. See ContentClassifierType

KinesisDataStreamTypeDef#

# KinesisDataStreamTypeDef definition

class KinesisDataStreamTypeDef(TypedDict):
    Arn: NotRequired[str],

KinesisVideoStreamStartSelectorTypeDef#

# KinesisVideoStreamStartSelectorTypeDef definition

class KinesisVideoStreamStartSelectorTypeDef(TypedDict):
    ProducerTimestamp: NotRequired[int],
    FragmentNumber: NotRequired[str],

KinesisVideoStreamTypeDef#

# KinesisVideoStreamTypeDef definition

class KinesisVideoStreamTypeDef(TypedDict):
    Arn: NotRequired[str],

LabelAliasTypeDef#

# LabelAliasTypeDef definition

class LabelAliasTypeDef(TypedDict):
    Name: NotRequired[str],

LabelCategoryTypeDef#

# LabelCategoryTypeDef definition

class LabelCategoryTypeDef(TypedDict):
    Name: NotRequired[str],

ParentTypeDef#

# ParentTypeDef definition

class ParentTypeDef(TypedDict):
    Name: NotRequired[str],

ListCollectionsRequestRequestTypeDef#

# ListCollectionsRequestRequestTypeDef definition

class ListCollectionsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDatasetEntriesRequestRequestTypeDef#

# ListDatasetEntriesRequestRequestTypeDef definition

class ListDatasetEntriesRequestRequestTypeDef(TypedDict):
    DatasetArn: str,
    ContainsLabels: NotRequired[Sequence[str]],
    Labeled: NotRequired[bool],
    SourceRefContains: NotRequired[str],
    HasErrors: NotRequired[bool],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDatasetLabelsRequestRequestTypeDef#

# ListDatasetLabelsRequestRequestTypeDef definition

class ListDatasetLabelsRequestRequestTypeDef(TypedDict):
    DatasetArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListFacesRequestRequestTypeDef#

# ListFacesRequestRequestTypeDef definition

class ListFacesRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    UserId: NotRequired[str],
    FaceIds: NotRequired[Sequence[str]],

ListMediaAnalysisJobsRequestRequestTypeDef#

# ListMediaAnalysisJobsRequestRequestTypeDef definition

class ListMediaAnalysisJobsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListProjectPoliciesRequestRequestTypeDef#

# ListProjectPoliciesRequestRequestTypeDef definition

class ListProjectPoliciesRequestRequestTypeDef(TypedDict):
    ProjectArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ProjectPolicyTypeDef#

# ProjectPolicyTypeDef definition

class ProjectPolicyTypeDef(TypedDict):
    ProjectArn: NotRequired[str],
    PolicyName: NotRequired[str],
    PolicyRevisionId: NotRequired[str],
    PolicyDocument: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],

ListStreamProcessorsRequestRequestTypeDef#

# ListStreamProcessorsRequestRequestTypeDef definition

class ListStreamProcessorsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

StreamProcessorTypeDef#

# StreamProcessorTypeDef definition

class StreamProcessorTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[StreamProcessorStatusType],  # (1)
  1. See StreamProcessorStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListUsersRequestRequestTypeDef#

# ListUsersRequestRequestTypeDef definition

class ListUsersRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    UserId: NotRequired[str],
    UserStatus: NotRequired[UserStatusType],  # (1)
  1. See UserStatusType

MatchedUserTypeDef#

# MatchedUserTypeDef definition

class MatchedUserTypeDef(TypedDict):
    UserId: NotRequired[str],
    UserStatus: NotRequired[UserStatusType],  # (1)
  1. See UserStatusType

MediaAnalysisDetectModerationLabelsConfigTypeDef#

# MediaAnalysisDetectModerationLabelsConfigTypeDef definition

class MediaAnalysisDetectModerationLabelsConfigTypeDef(TypedDict):
    MinConfidence: NotRequired[float],
    ProjectVersion: NotRequired[str],

MediaAnalysisModelVersionsTypeDef#

# MediaAnalysisModelVersionsTypeDef definition

class MediaAnalysisModelVersionsTypeDef(TypedDict):
    Moderation: NotRequired[str],

NotificationChannelTypeDef#

# NotificationChannelTypeDef definition

class NotificationChannelTypeDef(TypedDict):
    SNSTopicArn: str,
    RoleArn: str,

PutProjectPolicyRequestRequestTypeDef#

# PutProjectPolicyRequestRequestTypeDef definition

class PutProjectPolicyRequestRequestTypeDef(TypedDict):
    ProjectArn: str,
    PolicyName: str,
    PolicyDocument: str,
    PolicyRevisionId: NotRequired[str],

S3DestinationTypeDef#

# S3DestinationTypeDef definition

class S3DestinationTypeDef(TypedDict):
    Bucket: NotRequired[str],
    KeyPrefix: NotRequired[str],

SearchFacesRequestRequestTypeDef#

# SearchFacesRequestRequestTypeDef definition

class SearchFacesRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    FaceId: str,
    MaxFaces: NotRequired[int],
    FaceMatchThreshold: NotRequired[float],

SearchUsersRequestRequestTypeDef#

# SearchUsersRequestRequestTypeDef definition

class SearchUsersRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    UserId: NotRequired[str],
    FaceId: NotRequired[str],
    UserMatchThreshold: NotRequired[float],
    MaxUsers: NotRequired[int],

SearchedFaceTypeDef#

# SearchedFaceTypeDef definition

class SearchedFaceTypeDef(TypedDict):
    FaceId: NotRequired[str],

SearchedUserTypeDef#

# SearchedUserTypeDef definition

class SearchedUserTypeDef(TypedDict):
    UserId: NotRequired[str],

ShotSegmentTypeDef#

# ShotSegmentTypeDef definition

class ShotSegmentTypeDef(TypedDict):
    Index: NotRequired[int],
    Confidence: NotRequired[float],

TechnicalCueSegmentTypeDef#

# TechnicalCueSegmentTypeDef definition

class TechnicalCueSegmentTypeDef(TypedDict):
    Type: NotRequired[TechnicalCueTypeType],  # (1)
    Confidence: NotRequired[float],
  1. See TechnicalCueTypeType

StartProjectVersionRequestRequestTypeDef#

# StartProjectVersionRequestRequestTypeDef definition

class StartProjectVersionRequestRequestTypeDef(TypedDict):
    ProjectVersionArn: str,
    MinInferenceUnits: int,
    MaxInferenceUnits: NotRequired[int],

StartShotDetectionFilterTypeDef#

# StartShotDetectionFilterTypeDef definition

class StartShotDetectionFilterTypeDef(TypedDict):
    MinSegmentConfidence: NotRequired[float],

StreamProcessingStopSelectorTypeDef#

# StreamProcessingStopSelectorTypeDef definition

class StreamProcessingStopSelectorTypeDef(TypedDict):
    MaxDurationInSeconds: NotRequired[int],

StopProjectVersionRequestRequestTypeDef#

# StopProjectVersionRequestRequestTypeDef definition

class StopProjectVersionRequestRequestTypeDef(TypedDict):
    ProjectVersionArn: str,

StopStreamProcessorRequestRequestTypeDef#

# StopStreamProcessorRequestRequestTypeDef definition

class StopStreamProcessorRequestRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

CopyProjectVersionResponseTypeDef#

# CopyProjectVersionResponseTypeDef definition

class CopyProjectVersionResponseTypeDef(TypedDict):
    ProjectVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateCollectionResponseTypeDef#

# CreateCollectionResponseTypeDef definition

class CreateCollectionResponseTypeDef(TypedDict):
    StatusCode: int,
    CollectionArn: str,
    FaceModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    DatasetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFaceLivenessSessionResponseTypeDef#

# CreateFaceLivenessSessionResponseTypeDef definition

class CreateFaceLivenessSessionResponseTypeDef(TypedDict):
    SessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProjectResponseTypeDef#

# CreateProjectResponseTypeDef definition

class CreateProjectResponseTypeDef(TypedDict):
    ProjectArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProjectVersionResponseTypeDef#

# CreateProjectVersionResponseTypeDef definition

class CreateProjectVersionResponseTypeDef(TypedDict):
    ProjectVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStreamProcessorResponseTypeDef#

# CreateStreamProcessorResponseTypeDef definition

class CreateStreamProcessorResponseTypeDef(TypedDict):
    StreamProcessorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteCollectionResponseTypeDef#

# DeleteCollectionResponseTypeDef definition

class DeleteCollectionResponseTypeDef(TypedDict):
    StatusCode: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProjectResponseTypeDef#

# DeleteProjectResponseTypeDef definition

class DeleteProjectResponseTypeDef(TypedDict):
    Status: ProjectStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectStatusType
  2. See ResponseMetadataTypeDef

DeleteProjectVersionResponseTypeDef#

# DeleteProjectVersionResponseTypeDef definition

class DeleteProjectVersionResponseTypeDef(TypedDict):
    Status: ProjectVersionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectVersionStatusType
  2. See ResponseMetadataTypeDef

DescribeCollectionResponseTypeDef#

# DescribeCollectionResponseTypeDef definition

class DescribeCollectionResponseTypeDef(TypedDict):
    FaceCount: int,
    FaceModelVersion: str,
    CollectionARN: str,
    CreationTimestamp: datetime,
    UserCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListCollectionsResponseTypeDef#

# ListCollectionsResponseTypeDef definition

class ListCollectionsResponseTypeDef(TypedDict):
    CollectionIds: List[str],
    NextToken: str,
    FaceModelVersions: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDatasetEntriesResponseTypeDef#

# ListDatasetEntriesResponseTypeDef definition

class ListDatasetEntriesResponseTypeDef(TypedDict):
    DatasetEntries: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutProjectPolicyResponseTypeDef#

# PutProjectPolicyResponseTypeDef definition

class PutProjectPolicyResponseTypeDef(TypedDict):
    PolicyRevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartCelebrityRecognitionResponseTypeDef#

# StartCelebrityRecognitionResponseTypeDef definition

class StartCelebrityRecognitionResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartContentModerationResponseTypeDef#

# StartContentModerationResponseTypeDef definition

class StartContentModerationResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartFaceDetectionResponseTypeDef#

# StartFaceDetectionResponseTypeDef definition

class StartFaceDetectionResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartFaceSearchResponseTypeDef#

# StartFaceSearchResponseTypeDef definition

class StartFaceSearchResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartLabelDetectionResponseTypeDef#

# StartLabelDetectionResponseTypeDef definition

class StartLabelDetectionResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMediaAnalysisJobResponseTypeDef#

# StartMediaAnalysisJobResponseTypeDef definition

class StartMediaAnalysisJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartPersonTrackingResponseTypeDef#

# StartPersonTrackingResponseTypeDef definition

class StartPersonTrackingResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartProjectVersionResponseTypeDef#

# StartProjectVersionResponseTypeDef definition

class StartProjectVersionResponseTypeDef(TypedDict):
    Status: ProjectVersionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectVersionStatusType
  2. See ResponseMetadataTypeDef

StartSegmentDetectionResponseTypeDef#

# StartSegmentDetectionResponseTypeDef definition

class StartSegmentDetectionResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartStreamProcessorResponseTypeDef#

# StartStreamProcessorResponseTypeDef definition

class StartStreamProcessorResponseTypeDef(TypedDict):
    SessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartTextDetectionResponseTypeDef#

# StartTextDetectionResponseTypeDef definition

class StartTextDetectionResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopProjectVersionResponseTypeDef#

# StopProjectVersionResponseTypeDef definition

class StopProjectVersionResponseTypeDef(TypedDict):
    Status: ProjectVersionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectVersionStatusType
  2. See ResponseMetadataTypeDef

AssociateFacesResponseTypeDef#

# AssociateFacesResponseTypeDef definition

class AssociateFacesResponseTypeDef(TypedDict):
    AssociatedFaces: List[AssociatedFaceTypeDef],  # (1)
    UnsuccessfulFaceAssociations: List[UnsuccessfulFaceAssociationTypeDef],  # (2)
    UserStatus: UserStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AssociatedFaceTypeDef
  2. See UnsuccessfulFaceAssociationTypeDef
  3. See UserStatusType
  4. See ResponseMetadataTypeDef

ComparedSourceImageFaceTypeDef#

# ComparedSourceImageFaceTypeDef definition

class ComparedSourceImageFaceTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Confidence: NotRequired[float],
  1. See BoundingBoxTypeDef

FaceTypeDef#

# FaceTypeDef definition

class FaceTypeDef(TypedDict):
    FaceId: NotRequired[str],
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    ImageId: NotRequired[str],
    ExternalImageId: NotRequired[str],
    Confidence: NotRequired[float],
    IndexFacesModelVersion: NotRequired[str],
    UserId: NotRequired[str],
  1. See BoundingBoxTypeDef

AuditImageTypeDef#

# AuditImageTypeDef definition

class AuditImageTypeDef(TypedDict):
    Bytes: NotRequired[bytes],
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (2)
  1. See S3ObjectTypeDef
  2. See BoundingBoxTypeDef

GroundTruthManifestTypeDef#

# GroundTruthManifestTypeDef definition

class GroundTruthManifestTypeDef(TypedDict):
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

MediaAnalysisInputTypeDef#

# MediaAnalysisInputTypeDef definition

class MediaAnalysisInputTypeDef(TypedDict):
    S3Object: S3ObjectTypeDef,  # (1)
  1. See S3ObjectTypeDef

MediaAnalysisManifestSummaryTypeDef#

# MediaAnalysisManifestSummaryTypeDef definition

class MediaAnalysisManifestSummaryTypeDef(TypedDict):
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

SummaryTypeDef#

# SummaryTypeDef definition

class SummaryTypeDef(TypedDict):
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

VideoTypeDef#

# VideoTypeDef definition

class VideoTypeDef(TypedDict):
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

StartTechnicalCueDetectionFilterTypeDef#

# StartTechnicalCueDetectionFilterTypeDef definition

class StartTechnicalCueDetectionFilterTypeDef(TypedDict):
    MinSegmentConfidence: NotRequired[float],
    BlackFrame: NotRequired[BlackFrameTypeDef],  # (1)
  1. See BlackFrameTypeDef

DatasetChangesTypeDef#

# DatasetChangesTypeDef definition

class DatasetChangesTypeDef(TypedDict):
    GroundTruth: Union[str, bytes, IO[Any], StreamingBody],

ImageTypeDef#

# ImageTypeDef definition

class ImageTypeDef(TypedDict):
    Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

GetCelebrityInfoResponseTypeDef#

# GetCelebrityInfoResponseTypeDef definition

class GetCelebrityInfoResponseTypeDef(TypedDict):
    Urls: List[str],
    Name: str,
    KnownGender: KnownGenderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnownGenderTypeDef
  2. See ResponseMetadataTypeDef

ComparedFaceTypeDef#

# ComparedFaceTypeDef definition

class ComparedFaceTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Confidence: NotRequired[float],
    Landmarks: NotRequired[List[LandmarkTypeDef]],  # (2)
    Pose: NotRequired[PoseTypeDef],  # (3)
    Quality: NotRequired[ImageQualityTypeDef],  # (4)
    Emotions: NotRequired[List[EmotionTypeDef]],  # (5)
    Smile: NotRequired[SmileTypeDef],  # (6)
  1. See BoundingBoxTypeDef
  2. See LandmarkTypeDef
  3. See PoseTypeDef
  4. See ImageQualityTypeDef
  5. See EmotionTypeDef
  6. See SmileTypeDef

StreamProcessorSettingsForUpdateTypeDef#

# StreamProcessorSettingsForUpdateTypeDef definition

class StreamProcessorSettingsForUpdateTypeDef(TypedDict):
    ConnectedHomeForUpdate: NotRequired[ConnectedHomeSettingsForUpdateTypeDef],  # (1)
  1. See ConnectedHomeSettingsForUpdateTypeDef

ContentModerationDetectionTypeDef#

# ContentModerationDetectionTypeDef definition

class ContentModerationDetectionTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    ModerationLabel: NotRequired[ModerationLabelTypeDef],  # (1)
    StartTimestampMillis: NotRequired[int],
    EndTimestampMillis: NotRequired[int],
    DurationMillis: NotRequired[int],
  1. See ModerationLabelTypeDef

CopyProjectVersionRequestRequestTypeDef#

# CopyProjectVersionRequestRequestTypeDef definition

class CopyProjectVersionRequestRequestTypeDef(TypedDict):
    SourceProjectArn: str,
    SourceProjectVersionArn: str,
    DestinationProjectArn: str,
    VersionName: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    Tags: NotRequired[Mapping[str, str]],
    KmsKeyId: NotRequired[str],
  1. See OutputConfigTypeDef

EquipmentDetectionTypeDef#

# EquipmentDetectionTypeDef definition

class EquipmentDetectionTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Confidence: NotRequired[float],
    Type: NotRequired[ProtectiveEquipmentTypeType],  # (2)
    CoversBodyPart: NotRequired[CoversBodyPartTypeDef],  # (3)
  1. See BoundingBoxTypeDef
  2. See ProtectiveEquipmentTypeType
  3. See CoversBodyPartTypeDef

CreateFaceLivenessSessionRequestSettingsTypeDef#

# CreateFaceLivenessSessionRequestSettingsTypeDef definition

class CreateFaceLivenessSessionRequestSettingsTypeDef(TypedDict):
    OutputConfig: NotRequired[LivenessOutputConfigTypeDef],  # (1)
    AuditImagesLimit: NotRequired[int],
  1. See LivenessOutputConfigTypeDef

CustomizationFeatureConfigTypeDef#

# CustomizationFeatureConfigTypeDef definition

class CustomizationFeatureConfigTypeDef(TypedDict):
    ContentModeration: NotRequired[CustomizationFeatureContentModerationConfigTypeDef],  # (1)
  1. See CustomizationFeatureContentModerationConfigTypeDef

DatasetDescriptionTypeDef#

# DatasetDescriptionTypeDef definition

class DatasetDescriptionTypeDef(TypedDict):
    CreationTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],
    Status: NotRequired[DatasetStatusType],  # (1)
    StatusMessage: NotRequired[str],
    StatusMessageCode: NotRequired[DatasetStatusMessageCodeType],  # (2)
    DatasetStats: NotRequired[DatasetStatsTypeDef],  # (3)
  1. See DatasetStatusType
  2. See DatasetStatusMessageCodeType
  3. See DatasetStatsTypeDef

DatasetLabelDescriptionTypeDef#

# DatasetLabelDescriptionTypeDef definition

class DatasetLabelDescriptionTypeDef(TypedDict):
    LabelName: NotRequired[str],
    LabelStats: NotRequired[DatasetLabelStatsTypeDef],  # (1)
  1. See DatasetLabelStatsTypeDef

ProjectDescriptionTypeDef#

# ProjectDescriptionTypeDef definition

class ProjectDescriptionTypeDef(TypedDict):
    ProjectArn: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    Status: NotRequired[ProjectStatusType],  # (1)
    Datasets: NotRequired[List[DatasetMetadataTypeDef]],  # (2)
    Feature: NotRequired[CustomizationFeatureType],  # (3)
    AutoUpdate: NotRequired[ProjectAutoUpdateType],  # (4)
  1. See ProjectStatusType
  2. See DatasetMetadataTypeDef
  3. See CustomizationFeatureType
  4. See ProjectAutoUpdateType

DeleteFacesResponseTypeDef#

# DeleteFacesResponseTypeDef definition

class DeleteFacesResponseTypeDef(TypedDict):
    DeletedFaces: List[str],
    UnsuccessfulFaceDeletions: List[UnsuccessfulFaceDeletionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnsuccessfulFaceDeletionTypeDef
  2. See ResponseMetadataTypeDef

DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef#

# DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef definition

class DescribeProjectVersionsRequestDescribeProjectVersionsPaginateTypeDef(TypedDict):
    ProjectArn: str,
    VersionNames: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeProjectsRequestDescribeProjectsPaginateTypeDef#

# DescribeProjectsRequestDescribeProjectsPaginateTypeDef definition

class DescribeProjectsRequestDescribeProjectsPaginateTypeDef(TypedDict):
    ProjectNames: NotRequired[Sequence[str]],
    Features: NotRequired[Sequence[CustomizationFeatureType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See CustomizationFeatureType
  2. See PaginatorConfigTypeDef

ListCollectionsRequestListCollectionsPaginateTypeDef#

# ListCollectionsRequestListCollectionsPaginateTypeDef definition

class ListCollectionsRequestListCollectionsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef#

# ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef definition

class ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef(TypedDict):
    DatasetArn: str,
    ContainsLabels: NotRequired[Sequence[str]],
    Labeled: NotRequired[bool],
    SourceRefContains: NotRequired[str],
    HasErrors: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef#

# ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef definition

class ListDatasetLabelsRequestListDatasetLabelsPaginateTypeDef(TypedDict):
    DatasetArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFacesRequestListFacesPaginateTypeDef#

# ListFacesRequestListFacesPaginateTypeDef definition

class ListFacesRequestListFacesPaginateTypeDef(TypedDict):
    CollectionId: str,
    UserId: NotRequired[str],
    FaceIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef#

# ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef definition

class ListProjectPoliciesRequestListProjectPoliciesPaginateTypeDef(TypedDict):
    ProjectArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef#

# ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef definition

class ListStreamProcessorsRequestListStreamProcessorsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUsersRequestListUsersPaginateTypeDef#

# ListUsersRequestListUsersPaginateTypeDef definition

class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
    CollectionId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef#

# DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef definition

class DescribeProjectVersionsRequestProjectVersionRunningWaitTypeDef(TypedDict):
    ProjectArn: str,
    VersionNames: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef#

# DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef definition

class DescribeProjectVersionsRequestProjectVersionTrainingCompletedWaitTypeDef(TypedDict):
    ProjectArn: str,
    VersionNames: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DetectLabelsImageBackgroundTypeDef#

# DetectLabelsImageBackgroundTypeDef definition

class DetectLabelsImageBackgroundTypeDef(TypedDict):
    Quality: NotRequired[DetectLabelsImageQualityTypeDef],  # (1)
    DominantColors: NotRequired[List[DominantColorTypeDef]],  # (2)
  1. See DetectLabelsImageQualityTypeDef
  2. See DominantColorTypeDef

DetectLabelsImageForegroundTypeDef#

# DetectLabelsImageForegroundTypeDef definition

class DetectLabelsImageForegroundTypeDef(TypedDict):
    Quality: NotRequired[DetectLabelsImageQualityTypeDef],  # (1)
    DominantColors: NotRequired[List[DominantColorTypeDef]],  # (2)
  1. See DetectLabelsImageQualityTypeDef
  2. See DominantColorTypeDef

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Confidence: NotRequired[float],
    DominantColors: NotRequired[List[DominantColorTypeDef]],  # (2)
  1. See BoundingBoxTypeDef
  2. See DominantColorTypeDef

DetectLabelsSettingsTypeDef#

# DetectLabelsSettingsTypeDef definition

class DetectLabelsSettingsTypeDef(TypedDict):
    GeneralLabels: NotRequired[GeneralLabelsSettingsTypeDef],  # (1)
    ImageProperties: NotRequired[DetectLabelsImagePropertiesSettingsTypeDef],  # (2)
  1. See GeneralLabelsSettingsTypeDef
  2. See DetectLabelsImagePropertiesSettingsTypeDef

LabelDetectionSettingsTypeDef#

# LabelDetectionSettingsTypeDef definition

class LabelDetectionSettingsTypeDef(TypedDict):
    GeneralLabels: NotRequired[GeneralLabelsSettingsTypeDef],  # (1)
  1. See GeneralLabelsSettingsTypeDef

DetectModerationLabelsResponseTypeDef#

# DetectModerationLabelsResponseTypeDef definition

class DetectModerationLabelsResponseTypeDef(TypedDict):
    ModerationLabels: List[ModerationLabelTypeDef],  # (1)
    ModerationModelVersion: str,
    HumanLoopActivationOutput: HumanLoopActivationOutputTypeDef,  # (2)
    ProjectVersion: str,
    ContentTypes: List[ContentTypeTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ModerationLabelTypeDef
  2. See HumanLoopActivationOutputTypeDef
  3. See ContentTypeTypeDef
  4. See ResponseMetadataTypeDef

DisassociateFacesResponseTypeDef#

# DisassociateFacesResponseTypeDef definition

class DisassociateFacesResponseTypeDef(TypedDict):
    DisassociatedFaces: List[DisassociatedFaceTypeDef],  # (1)
    UnsuccessfulFaceDisassociations: List[UnsuccessfulFaceDisassociationTypeDef],  # (2)
    UserStatus: UserStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DisassociatedFaceTypeDef
  2. See UnsuccessfulFaceDisassociationTypeDef
  3. See UserStatusType
  4. See ResponseMetadataTypeDef

DistributeDatasetEntriesRequestRequestTypeDef#

# DistributeDatasetEntriesRequestRequestTypeDef definition

class DistributeDatasetEntriesRequestRequestTypeDef(TypedDict):
    Datasets: Sequence[DistributeDatasetTypeDef],  # (1)
  1. See DistributeDatasetTypeDef

FaceDetailTypeDef#

# FaceDetailTypeDef definition

class FaceDetailTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    AgeRange: NotRequired[AgeRangeTypeDef],  # (2)
    Smile: NotRequired[SmileTypeDef],  # (3)
    Eyeglasses: NotRequired[EyeglassesTypeDef],  # (4)
    Sunglasses: NotRequired[SunglassesTypeDef],  # (5)
    Gender: NotRequired[GenderTypeDef],  # (6)
    Beard: NotRequired[BeardTypeDef],  # (7)
    Mustache: NotRequired[MustacheTypeDef],  # (8)
    EyesOpen: NotRequired[EyeOpenTypeDef],  # (9)
    MouthOpen: NotRequired[MouthOpenTypeDef],  # (10)
    Emotions: NotRequired[List[EmotionTypeDef]],  # (11)
    Landmarks: NotRequired[List[LandmarkTypeDef]],  # (12)
    Pose: NotRequired[PoseTypeDef],  # (13)
    Quality: NotRequired[ImageQualityTypeDef],  # (14)
    Confidence: NotRequired[float],
    FaceOccluded: NotRequired[FaceOccludedTypeDef],  # (15)
    EyeDirection: NotRequired[EyeDirectionTypeDef],  # (16)
  1. See BoundingBoxTypeDef
  2. See AgeRangeTypeDef
  3. See SmileTypeDef
  4. See EyeglassesTypeDef
  5. See SunglassesTypeDef
  6. See GenderTypeDef
  7. See BeardTypeDef
  8. See MustacheTypeDef
  9. See EyeOpenTypeDef
  10. See MouthOpenTypeDef
  11. See EmotionTypeDef
  12. See LandmarkTypeDef
  13. See PoseTypeDef
  14. See ImageQualityTypeDef
  15. See FaceOccludedTypeDef
  16. See EyeDirectionTypeDef

StreamProcessorSettingsTypeDef#

# StreamProcessorSettingsTypeDef definition

class StreamProcessorSettingsTypeDef(TypedDict):
    FaceSearch: NotRequired[FaceSearchSettingsTypeDef],  # (1)
    ConnectedHome: NotRequired[ConnectedHomeSettingsTypeDef],  # (2)
  1. See FaceSearchSettingsTypeDef
  2. See ConnectedHomeSettingsTypeDef

GeometryTypeDef#

# GeometryTypeDef definition

class GeometryTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Polygon: NotRequired[List[PointTypeDef]],  # (2)
  1. See BoundingBoxTypeDef
  2. See PointTypeDef

RegionOfInterestTypeDef#

# RegionOfInterestTypeDef definition

class RegionOfInterestTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Polygon: NotRequired[Sequence[PointTypeDef]],  # (2)
  1. See BoundingBoxTypeDef
  2. See PointTypeDef

HumanLoopConfigTypeDef#

# HumanLoopConfigTypeDef definition

class HumanLoopConfigTypeDef(TypedDict):
    HumanLoopName: str,
    FlowDefinitionArn: str,
    DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef],  # (1)
  1. See HumanLoopDataAttributesTypeDef

StreamProcessingStartSelectorTypeDef#

# StreamProcessingStartSelectorTypeDef definition

class StreamProcessingStartSelectorTypeDef(TypedDict):
    KVSStreamStartSelector: NotRequired[KinesisVideoStreamStartSelectorTypeDef],  # (1)
  1. See KinesisVideoStreamStartSelectorTypeDef

StreamProcessorInputTypeDef#

# StreamProcessorInputTypeDef definition

class StreamProcessorInputTypeDef(TypedDict):
    KinesisVideoStream: NotRequired[KinesisVideoStreamTypeDef],  # (1)
  1. See KinesisVideoStreamTypeDef

ListProjectPoliciesResponseTypeDef#

# ListProjectPoliciesResponseTypeDef definition

class ListProjectPoliciesResponseTypeDef(TypedDict):
    ProjectPolicies: List[ProjectPolicyTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectPolicyTypeDef
  2. See ResponseMetadataTypeDef

ListStreamProcessorsResponseTypeDef#

# ListStreamProcessorsResponseTypeDef definition

class ListStreamProcessorsResponseTypeDef(TypedDict):
    NextToken: str,
    StreamProcessors: List[StreamProcessorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamProcessorTypeDef
  2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef#

# ListUsersResponseTypeDef definition

class ListUsersResponseTypeDef(TypedDict):
    Users: List[UserTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

UserMatchTypeDef#

# UserMatchTypeDef definition

class UserMatchTypeDef(TypedDict):
    Similarity: NotRequired[float],
    User: NotRequired[MatchedUserTypeDef],  # (1)
  1. See MatchedUserTypeDef

MediaAnalysisOperationsConfigTypeDef#

# MediaAnalysisOperationsConfigTypeDef definition

class MediaAnalysisOperationsConfigTypeDef(TypedDict):
    DetectModerationLabels: NotRequired[MediaAnalysisDetectModerationLabelsConfigTypeDef],  # (1)
  1. See MediaAnalysisDetectModerationLabelsConfigTypeDef

MediaAnalysisResultsTypeDef#

# MediaAnalysisResultsTypeDef definition

class MediaAnalysisResultsTypeDef(TypedDict):
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
    ModelVersions: NotRequired[MediaAnalysisModelVersionsTypeDef],  # (2)
  1. See S3ObjectTypeDef
  2. See MediaAnalysisModelVersionsTypeDef

StreamProcessorOutputTypeDef#

# StreamProcessorOutputTypeDef definition

class StreamProcessorOutputTypeDef(TypedDict):
    KinesisDataStream: NotRequired[KinesisDataStreamTypeDef],  # (1)
    S3Destination: NotRequired[S3DestinationTypeDef],  # (2)
  1. See KinesisDataStreamTypeDef
  2. See S3DestinationTypeDef

SegmentDetectionTypeDef#

# SegmentDetectionTypeDef definition

class SegmentDetectionTypeDef(TypedDict):
    Type: NotRequired[SegmentTypeType],  # (1)
    StartTimestampMillis: NotRequired[int],
    EndTimestampMillis: NotRequired[int],
    DurationMillis: NotRequired[int],
    StartTimecodeSMPTE: NotRequired[str],
    EndTimecodeSMPTE: NotRequired[str],
    DurationSMPTE: NotRequired[str],
    TechnicalCueSegment: NotRequired[TechnicalCueSegmentTypeDef],  # (2)
    ShotSegment: NotRequired[ShotSegmentTypeDef],  # (3)
    StartFrameNumber: NotRequired[int],
    EndFrameNumber: NotRequired[int],
    DurationFrames: NotRequired[int],
  1. See SegmentTypeType
  2. See TechnicalCueSegmentTypeDef
  3. See ShotSegmentTypeDef

FaceMatchTypeDef#

# FaceMatchTypeDef definition

class FaceMatchTypeDef(TypedDict):
    Similarity: NotRequired[float],
    Face: NotRequired[FaceTypeDef],  # (1)
  1. See FaceTypeDef

ListFacesResponseTypeDef#

# ListFacesResponseTypeDef definition

class ListFacesResponseTypeDef(TypedDict):
    Faces: List[FaceTypeDef],  # (1)
    NextToken: str,
    FaceModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FaceTypeDef
  2. See ResponseMetadataTypeDef

GetFaceLivenessSessionResultsResponseTypeDef#

# GetFaceLivenessSessionResultsResponseTypeDef definition

class GetFaceLivenessSessionResultsResponseTypeDef(TypedDict):
    SessionId: str,
    Status: LivenessSessionStatusType,  # (1)
    Confidence: float,
    ReferenceImage: AuditImageTypeDef,  # (2)
    AuditImages: List[AuditImageTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See LivenessSessionStatusType
  2. See AuditImageTypeDef
  3. See AuditImageTypeDef
  4. See ResponseMetadataTypeDef

AssetTypeDef#

# AssetTypeDef definition

class AssetTypeDef(TypedDict):
    GroundTruthManifest: NotRequired[GroundTruthManifestTypeDef],  # (1)
  1. See GroundTruthManifestTypeDef

DatasetSourceTypeDef#

# DatasetSourceTypeDef definition

class DatasetSourceTypeDef(TypedDict):
    GroundTruthManifest: NotRequired[GroundTruthManifestTypeDef],  # (1)
    DatasetArn: NotRequired[str],
  1. See GroundTruthManifestTypeDef

EvaluationResultTypeDef#

# EvaluationResultTypeDef definition

class EvaluationResultTypeDef(TypedDict):
    F1Score: NotRequired[float],
    Summary: NotRequired[SummaryTypeDef],  # (1)
  1. See SummaryTypeDef

StartCelebrityRecognitionRequestRequestTypeDef#

# StartCelebrityRecognitionRequestRequestTypeDef definition

class StartCelebrityRecognitionRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    JobTag: NotRequired[str],
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef

StartContentModerationRequestRequestTypeDef#

# StartContentModerationRequestRequestTypeDef definition

class StartContentModerationRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    MinConfidence: NotRequired[float],
    ClientRequestToken: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    JobTag: NotRequired[str],
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef

StartFaceDetectionRequestRequestTypeDef#

# StartFaceDetectionRequestRequestTypeDef definition

class StartFaceDetectionRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    FaceAttributes: NotRequired[FaceAttributesType],  # (3)
    JobTag: NotRequired[str],
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See FaceAttributesType

StartFaceSearchRequestRequestTypeDef#

# StartFaceSearchRequestRequestTypeDef definition

class StartFaceSearchRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    CollectionId: str,
    ClientRequestToken: NotRequired[str],
    FaceMatchThreshold: NotRequired[float],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    JobTag: NotRequired[str],
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef

StartPersonTrackingRequestRequestTypeDef#

# StartPersonTrackingRequestRequestTypeDef definition

class StartPersonTrackingRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    JobTag: NotRequired[str],
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef

StartSegmentDetectionFiltersTypeDef#

# StartSegmentDetectionFiltersTypeDef definition

class StartSegmentDetectionFiltersTypeDef(TypedDict):
    TechnicalCueFilter: NotRequired[StartTechnicalCueDetectionFilterTypeDef],  # (1)
    ShotFilter: NotRequired[StartShotDetectionFilterTypeDef],  # (2)
  1. See StartTechnicalCueDetectionFilterTypeDef
  2. See StartShotDetectionFilterTypeDef

UpdateDatasetEntriesRequestRequestTypeDef#

# UpdateDatasetEntriesRequestRequestTypeDef definition

class UpdateDatasetEntriesRequestRequestTypeDef(TypedDict):
    DatasetArn: str,
    Changes: DatasetChangesTypeDef,  # (1)
  1. See DatasetChangesTypeDef

CompareFacesRequestRequestTypeDef#

# CompareFacesRequestRequestTypeDef definition

class CompareFacesRequestRequestTypeDef(TypedDict):
    SourceImage: ImageTypeDef,  # (1)
    TargetImage: ImageTypeDef,  # (1)
    SimilarityThreshold: NotRequired[float],
    QualityFilter: NotRequired[QualityFilterType],  # (3)
  1. See ImageTypeDef
  2. See ImageTypeDef
  3. See QualityFilterType

DetectCustomLabelsRequestRequestTypeDef#

# DetectCustomLabelsRequestRequestTypeDef definition

class DetectCustomLabelsRequestRequestTypeDef(TypedDict):
    ProjectVersionArn: str,
    Image: ImageTypeDef,  # (1)
    MaxResults: NotRequired[int],
    MinConfidence: NotRequired[float],
  1. See ImageTypeDef

DetectFacesRequestRequestTypeDef#

# DetectFacesRequestRequestTypeDef definition

class DetectFacesRequestRequestTypeDef(TypedDict):
    Image: ImageTypeDef,  # (1)
    Attributes: NotRequired[Sequence[AttributeType]],  # (2)
  1. See ImageTypeDef
  2. See AttributeType

DetectProtectiveEquipmentRequestRequestTypeDef#

# DetectProtectiveEquipmentRequestRequestTypeDef definition

class DetectProtectiveEquipmentRequestRequestTypeDef(TypedDict):
    Image: ImageTypeDef,  # (1)
    SummarizationAttributes: NotRequired[ProtectiveEquipmentSummarizationAttributesTypeDef],  # (2)
  1. See ImageTypeDef
  2. See ProtectiveEquipmentSummarizationAttributesTypeDef

IndexFacesRequestRequestTypeDef#

# IndexFacesRequestRequestTypeDef definition

class IndexFacesRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    ExternalImageId: NotRequired[str],
    DetectionAttributes: NotRequired[Sequence[AttributeType]],  # (2)
    MaxFaces: NotRequired[int],
    QualityFilter: NotRequired[QualityFilterType],  # (3)
  1. See ImageTypeDef
  2. See AttributeType
  3. See QualityFilterType

RecognizeCelebritiesRequestRequestTypeDef#

# RecognizeCelebritiesRequestRequestTypeDef definition

class RecognizeCelebritiesRequestRequestTypeDef(TypedDict):
    Image: ImageTypeDef,  # (1)
  1. See ImageTypeDef

SearchFacesByImageRequestRequestTypeDef#

# SearchFacesByImageRequestRequestTypeDef definition

class SearchFacesByImageRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    MaxFaces: NotRequired[int],
    FaceMatchThreshold: NotRequired[float],
    QualityFilter: NotRequired[QualityFilterType],  # (2)
  1. See ImageTypeDef
  2. See QualityFilterType

SearchUsersByImageRequestRequestTypeDef#

# SearchUsersByImageRequestRequestTypeDef definition

class SearchUsersByImageRequestRequestTypeDef(TypedDict):
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    UserMatchThreshold: NotRequired[float],
    MaxUsers: NotRequired[int],
    QualityFilter: NotRequired[QualityFilterType],  # (2)
  1. See ImageTypeDef
  2. See QualityFilterType

CelebrityTypeDef#

# CelebrityTypeDef definition

class CelebrityTypeDef(TypedDict):
    Urls: NotRequired[List[str]],
    Name: NotRequired[str],
    Id: NotRequired[str],
    Face: NotRequired[ComparedFaceTypeDef],  # (1)
    MatchConfidence: NotRequired[float],
    KnownGender: NotRequired[KnownGenderTypeDef],  # (2)
  1. See ComparedFaceTypeDef
  2. See KnownGenderTypeDef

CompareFacesMatchTypeDef#

# CompareFacesMatchTypeDef definition

class CompareFacesMatchTypeDef(TypedDict):
    Similarity: NotRequired[float],
    Face: NotRequired[ComparedFaceTypeDef],  # (1)
  1. See ComparedFaceTypeDef

GetContentModerationResponseTypeDef#

# GetContentModerationResponseTypeDef definition

class GetContentModerationResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    ModerationLabels: List[ContentModerationDetectionTypeDef],  # (3)
    NextToken: str,
    ModerationModelVersion: str,
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    GetRequestMetadata: GetContentModerationRequestMetadataTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See ContentModerationDetectionTypeDef
  4. See VideoTypeDef
  5. See GetContentModerationRequestMetadataTypeDef
  6. See ResponseMetadataTypeDef

ProtectiveEquipmentBodyPartTypeDef#

# ProtectiveEquipmentBodyPartTypeDef definition

class ProtectiveEquipmentBodyPartTypeDef(TypedDict):
    Name: NotRequired[BodyPartType],  # (1)
    Confidence: NotRequired[float],
    EquipmentDetections: NotRequired[List[EquipmentDetectionTypeDef]],  # (2)
  1. See BodyPartType
  2. See EquipmentDetectionTypeDef

CreateFaceLivenessSessionRequestRequestTypeDef#

# CreateFaceLivenessSessionRequestRequestTypeDef definition

class CreateFaceLivenessSessionRequestRequestTypeDef(TypedDict):
    KmsKeyId: NotRequired[str],
    Settings: NotRequired[CreateFaceLivenessSessionRequestSettingsTypeDef],  # (1)
    ClientRequestToken: NotRequired[str],
  1. See CreateFaceLivenessSessionRequestSettingsTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    DatasetDescription: DatasetDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetLabelsResponseTypeDef#

# ListDatasetLabelsResponseTypeDef definition

class ListDatasetLabelsResponseTypeDef(TypedDict):
    DatasetLabelDescriptions: List[DatasetLabelDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetLabelDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeProjectsResponseTypeDef#

# DescribeProjectsResponseTypeDef definition

class DescribeProjectsResponseTypeDef(TypedDict):
    ProjectDescriptions: List[ProjectDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DetectLabelsImagePropertiesTypeDef#

# DetectLabelsImagePropertiesTypeDef definition

class DetectLabelsImagePropertiesTypeDef(TypedDict):
    Quality: NotRequired[DetectLabelsImageQualityTypeDef],  # (1)
    DominantColors: NotRequired[List[DominantColorTypeDef]],  # (2)
    Foreground: NotRequired[DetectLabelsImageForegroundTypeDef],  # (3)
    Background: NotRequired[DetectLabelsImageBackgroundTypeDef],  # (4)
  1. See DetectLabelsImageQualityTypeDef
  2. See DominantColorTypeDef
  3. See DetectLabelsImageForegroundTypeDef
  4. See DetectLabelsImageBackgroundTypeDef

LabelTypeDef#

# LabelTypeDef definition

class LabelTypeDef(TypedDict):
    Name: NotRequired[str],
    Confidence: NotRequired[float],
    Instances: NotRequired[List[InstanceTypeDef]],  # (1)
    Parents: NotRequired[List[ParentTypeDef]],  # (2)
    Aliases: NotRequired[List[LabelAliasTypeDef]],  # (3)
    Categories: NotRequired[List[LabelCategoryTypeDef]],  # (4)
  1. See InstanceTypeDef
  2. See ParentTypeDef
  3. See LabelAliasTypeDef
  4. See LabelCategoryTypeDef

DetectLabelsRequestRequestTypeDef#

# DetectLabelsRequestRequestTypeDef definition

class DetectLabelsRequestRequestTypeDef(TypedDict):
    Image: ImageTypeDef,  # (1)
    MaxLabels: NotRequired[int],
    MinConfidence: NotRequired[float],
    Features: NotRequired[Sequence[DetectLabelsFeatureNameType]],  # (2)
    Settings: NotRequired[DetectLabelsSettingsTypeDef],  # (3)
  1. See ImageTypeDef
  2. See DetectLabelsFeatureNameType
  3. See DetectLabelsSettingsTypeDef

StartLabelDetectionRequestRequestTypeDef#

# StartLabelDetectionRequestRequestTypeDef definition

class StartLabelDetectionRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    MinConfidence: NotRequired[float],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    JobTag: NotRequired[str],
    Features: NotRequired[Sequence[LabelDetectionFeatureNameType]],  # (3)
    Settings: NotRequired[LabelDetectionSettingsTypeDef],  # (4)
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See LabelDetectionFeatureNameType
  4. See LabelDetectionSettingsTypeDef

CelebrityDetailTypeDef#

# CelebrityDetailTypeDef definition

class CelebrityDetailTypeDef(TypedDict):
    Urls: NotRequired[List[str]],
    Name: NotRequired[str],
    Id: NotRequired[str],
    Confidence: NotRequired[float],
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Face: NotRequired[FaceDetailTypeDef],  # (2)
    KnownGender: NotRequired[KnownGenderTypeDef],  # (3)
  1. See BoundingBoxTypeDef
  2. See FaceDetailTypeDef
  3. See KnownGenderTypeDef

DetectFacesResponseTypeDef#

# DetectFacesResponseTypeDef definition

class DetectFacesResponseTypeDef(TypedDict):
    FaceDetails: List[FaceDetailTypeDef],  # (1)
    OrientationCorrection: OrientationCorrectionType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FaceDetailTypeDef
  2. See OrientationCorrectionType
  3. See ResponseMetadataTypeDef

FaceDetectionTypeDef#

# FaceDetectionTypeDef definition

class FaceDetectionTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    Face: NotRequired[FaceDetailTypeDef],  # (1)
  1. See FaceDetailTypeDef

FaceRecordTypeDef#

# FaceRecordTypeDef definition

class FaceRecordTypeDef(TypedDict):
    Face: NotRequired[FaceTypeDef],  # (1)
    FaceDetail: NotRequired[FaceDetailTypeDef],  # (2)
  1. See FaceTypeDef
  2. See FaceDetailTypeDef

PersonDetailTypeDef#

# PersonDetailTypeDef definition

class PersonDetailTypeDef(TypedDict):
    Index: NotRequired[int],
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Face: NotRequired[FaceDetailTypeDef],  # (2)
  1. See BoundingBoxTypeDef
  2. See FaceDetailTypeDef

SearchedFaceDetailsTypeDef#

# SearchedFaceDetailsTypeDef definition

class SearchedFaceDetailsTypeDef(TypedDict):
    FaceDetail: NotRequired[FaceDetailTypeDef],  # (1)
  1. See FaceDetailTypeDef

UnindexedFaceTypeDef#

# UnindexedFaceTypeDef definition

class UnindexedFaceTypeDef(TypedDict):
    Reasons: NotRequired[List[ReasonType]],  # (1)
    FaceDetail: NotRequired[FaceDetailTypeDef],  # (2)
  1. See ReasonType
  2. See FaceDetailTypeDef

UnsearchedFaceTypeDef#

# UnsearchedFaceTypeDef definition

class UnsearchedFaceTypeDef(TypedDict):
    FaceDetails: NotRequired[FaceDetailTypeDef],  # (1)
    Reasons: NotRequired[List[UnsearchedFaceReasonType]],  # (2)
  1. See FaceDetailTypeDef
  2. See UnsearchedFaceReasonType

CustomLabelTypeDef#

# CustomLabelTypeDef definition

class CustomLabelTypeDef(TypedDict):
    Name: NotRequired[str],
    Confidence: NotRequired[float],
    Geometry: NotRequired[GeometryTypeDef],  # (1)
  1. See GeometryTypeDef

TextDetectionTypeDef#

# TextDetectionTypeDef definition

class TextDetectionTypeDef(TypedDict):
    DetectedText: NotRequired[str],
    Type: NotRequired[TextTypesType],  # (1)
    Id: NotRequired[int],
    ParentId: NotRequired[int],
    Confidence: NotRequired[float],
    Geometry: NotRequired[GeometryTypeDef],  # (2)
  1. See TextTypesType
  2. See GeometryTypeDef

DetectTextFiltersTypeDef#

# DetectTextFiltersTypeDef definition

class DetectTextFiltersTypeDef(TypedDict):
    WordFilter: NotRequired[DetectionFilterTypeDef],  # (1)
    RegionsOfInterest: NotRequired[Sequence[RegionOfInterestTypeDef]],  # (2)
  1. See DetectionFilterTypeDef
  2. See RegionOfInterestTypeDef

StartTextDetectionFiltersTypeDef#

# StartTextDetectionFiltersTypeDef definition

class StartTextDetectionFiltersTypeDef(TypedDict):
    WordFilter: NotRequired[DetectionFilterTypeDef],  # (1)
    RegionsOfInterest: NotRequired[Sequence[RegionOfInterestTypeDef]],  # (2)
  1. See DetectionFilterTypeDef
  2. See RegionOfInterestTypeDef

UpdateStreamProcessorRequestRequestTypeDef#

# UpdateStreamProcessorRequestRequestTypeDef definition

class UpdateStreamProcessorRequestRequestTypeDef(TypedDict):
    Name: str,
    SettingsForUpdate: NotRequired[StreamProcessorSettingsForUpdateTypeDef],  # (1)
    RegionsOfInterestForUpdate: NotRequired[Sequence[RegionOfInterestTypeDef]],  # (2)
    DataSharingPreferenceForUpdate: NotRequired[StreamProcessorDataSharingPreferenceTypeDef],  # (3)
    ParametersToDelete: NotRequired[Sequence[StreamProcessorParameterToDeleteType]],  # (4)
  1. See StreamProcessorSettingsForUpdateTypeDef
  2. See RegionOfInterestTypeDef
  3. See StreamProcessorDataSharingPreferenceTypeDef
  4. See StreamProcessorParameterToDeleteType

DetectModerationLabelsRequestRequestTypeDef#

# DetectModerationLabelsRequestRequestTypeDef definition

class DetectModerationLabelsRequestRequestTypeDef(TypedDict):
    Image: ImageTypeDef,  # (1)
    MinConfidence: NotRequired[float],
    HumanLoopConfig: NotRequired[HumanLoopConfigTypeDef],  # (2)
    ProjectVersion: NotRequired[str],
  1. See ImageTypeDef
  2. See HumanLoopConfigTypeDef

StartStreamProcessorRequestRequestTypeDef#

# StartStreamProcessorRequestRequestTypeDef definition

class StartStreamProcessorRequestRequestTypeDef(TypedDict):
    Name: str,
    StartSelector: NotRequired[StreamProcessingStartSelectorTypeDef],  # (1)
    StopSelector: NotRequired[StreamProcessingStopSelectorTypeDef],  # (2)
  1. See StreamProcessingStartSelectorTypeDef
  2. See StreamProcessingStopSelectorTypeDef

SearchUsersResponseTypeDef#

# SearchUsersResponseTypeDef definition

class SearchUsersResponseTypeDef(TypedDict):
    UserMatches: List[UserMatchTypeDef],  # (1)
    FaceModelVersion: str,
    SearchedFace: SearchedFaceTypeDef,  # (2)
    SearchedUser: SearchedUserTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See UserMatchTypeDef
  2. See SearchedFaceTypeDef
  3. See SearchedUserTypeDef
  4. See ResponseMetadataTypeDef

StartMediaAnalysisJobRequestRequestTypeDef#

# StartMediaAnalysisJobRequestRequestTypeDef definition

class StartMediaAnalysisJobRequestRequestTypeDef(TypedDict):
    OperationsConfig: MediaAnalysisOperationsConfigTypeDef,  # (1)
    Input: MediaAnalysisInputTypeDef,  # (2)
    OutputConfig: MediaAnalysisOutputConfigTypeDef,  # (3)
    ClientRequestToken: NotRequired[str],
    JobName: NotRequired[str],
    KmsKeyId: NotRequired[str],
  1. See MediaAnalysisOperationsConfigTypeDef
  2. See MediaAnalysisInputTypeDef
  3. See MediaAnalysisOutputConfigTypeDef

GetMediaAnalysisJobResponseTypeDef#

# GetMediaAnalysisJobResponseTypeDef definition

class GetMediaAnalysisJobResponseTypeDef(TypedDict):
    JobId: str,
    JobName: str,
    OperationsConfig: MediaAnalysisOperationsConfigTypeDef,  # (1)
    Status: MediaAnalysisJobStatusType,  # (2)
    FailureDetails: MediaAnalysisJobFailureDetailsTypeDef,  # (3)
    CreationTimestamp: datetime,
    CompletionTimestamp: datetime,
    Input: MediaAnalysisInputTypeDef,  # (4)
    OutputConfig: MediaAnalysisOutputConfigTypeDef,  # (5)
    KmsKeyId: str,
    Results: MediaAnalysisResultsTypeDef,  # (6)
    ManifestSummary: MediaAnalysisManifestSummaryTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See MediaAnalysisOperationsConfigTypeDef
  2. See MediaAnalysisJobStatusType
  3. See MediaAnalysisJobFailureDetailsTypeDef
  4. See MediaAnalysisInputTypeDef
  5. See MediaAnalysisOutputConfigTypeDef
  6. See MediaAnalysisResultsTypeDef
  7. See MediaAnalysisManifestSummaryTypeDef
  8. See ResponseMetadataTypeDef

MediaAnalysisJobDescriptionTypeDef#

# MediaAnalysisJobDescriptionTypeDef definition

class MediaAnalysisJobDescriptionTypeDef(TypedDict):
    JobId: str,
    OperationsConfig: MediaAnalysisOperationsConfigTypeDef,  # (1)
    Status: MediaAnalysisJobStatusType,  # (2)
    CreationTimestamp: datetime,
    Input: MediaAnalysisInputTypeDef,  # (4)
    OutputConfig: MediaAnalysisOutputConfigTypeDef,  # (5)
    JobName: NotRequired[str],
    FailureDetails: NotRequired[MediaAnalysisJobFailureDetailsTypeDef],  # (3)
    CompletionTimestamp: NotRequired[datetime],
    KmsKeyId: NotRequired[str],
    Results: NotRequired[MediaAnalysisResultsTypeDef],  # (6)
    ManifestSummary: NotRequired[MediaAnalysisManifestSummaryTypeDef],  # (7)
  1. See MediaAnalysisOperationsConfigTypeDef
  2. See MediaAnalysisJobStatusType
  3. See MediaAnalysisJobFailureDetailsTypeDef
  4. See MediaAnalysisInputTypeDef
  5. See MediaAnalysisOutputConfigTypeDef
  6. See MediaAnalysisResultsTypeDef
  7. See MediaAnalysisManifestSummaryTypeDef

CreateStreamProcessorRequestRequestTypeDef#

# CreateStreamProcessorRequestRequestTypeDef 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)
  1. See StreamProcessorInputTypeDef
  2. See StreamProcessorOutputTypeDef
  3. See StreamProcessorSettingsTypeDef
  4. See StreamProcessorNotificationChannelTypeDef
  5. See RegionOfInterestTypeDef
  6. See StreamProcessorDataSharingPreferenceTypeDef

DescribeStreamProcessorResponseTypeDef#

# DescribeStreamProcessorResponseTypeDef 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)
  1. See StreamProcessorStatusType
  2. See StreamProcessorInputTypeDef
  3. See StreamProcessorOutputTypeDef
  4. See StreamProcessorSettingsTypeDef
  5. See StreamProcessorNotificationChannelTypeDef
  6. See RegionOfInterestTypeDef
  7. See StreamProcessorDataSharingPreferenceTypeDef
  8. See ResponseMetadataTypeDef

GetSegmentDetectionResponseTypeDef#

# GetSegmentDetectionResponseTypeDef 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)
    JobId: str,
    Video: VideoTypeDef,  # (6)
    JobTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See AudioMetadataTypeDef
  4. See SegmentDetectionTypeDef
  5. See SegmentTypeInfoTypeDef
  6. See VideoTypeDef
  7. See ResponseMetadataTypeDef

SearchFacesByImageResponseTypeDef#

# SearchFacesByImageResponseTypeDef definition

class SearchFacesByImageResponseTypeDef(TypedDict):
    SearchedFaceBoundingBox: BoundingBoxTypeDef,  # (1)
    SearchedFaceConfidence: float,
    FaceMatches: List[FaceMatchTypeDef],  # (2)
    FaceModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BoundingBoxTypeDef
  2. See FaceMatchTypeDef
  3. See ResponseMetadataTypeDef

SearchFacesResponseTypeDef#

# SearchFacesResponseTypeDef definition

class SearchFacesResponseTypeDef(TypedDict):
    SearchedFaceId: str,
    FaceMatches: List[FaceMatchTypeDef],  # (1)
    FaceModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FaceMatchTypeDef
  2. See ResponseMetadataTypeDef

TestingDataPaginatorTypeDef#

# TestingDataPaginatorTypeDef definition

class TestingDataPaginatorTypeDef(TypedDict):
    Assets: NotRequired[List[AssetTypeDef]],  # (1)
    AutoCreate: NotRequired[bool],
  1. See AssetTypeDef

TestingDataTypeDef#

# TestingDataTypeDef definition

class TestingDataTypeDef(TypedDict):
    Assets: NotRequired[Sequence[AssetTypeDef]],  # (1)
    AutoCreate: NotRequired[bool],
  1. See AssetTypeDef

TrainingDataPaginatorTypeDef#

# TrainingDataPaginatorTypeDef definition

class TrainingDataPaginatorTypeDef(TypedDict):
    Assets: NotRequired[List[AssetTypeDef]],  # (1)
  1. See AssetTypeDef

TrainingDataTypeDef#

# TrainingDataTypeDef definition

class TrainingDataTypeDef(TypedDict):
    Assets: NotRequired[Sequence[AssetTypeDef]],  # (1)
  1. See AssetTypeDef

ValidationDataTypeDef#

# ValidationDataTypeDef definition

class ValidationDataTypeDef(TypedDict):
    Assets: NotRequired[List[AssetTypeDef]],  # (1)
  1. See AssetTypeDef

CreateDatasetRequestRequestTypeDef#

# CreateDatasetRequestRequestTypeDef definition

class CreateDatasetRequestRequestTypeDef(TypedDict):
    DatasetType: DatasetTypeType,  # (1)
    ProjectArn: str,
    DatasetSource: NotRequired[DatasetSourceTypeDef],  # (2)
  1. See DatasetTypeType
  2. See DatasetSourceTypeDef

StartSegmentDetectionRequestRequestTypeDef#

# StartSegmentDetectionRequestRequestTypeDef 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)
  1. See VideoTypeDef
  2. See SegmentTypeType
  3. See NotificationChannelTypeDef
  4. See StartSegmentDetectionFiltersTypeDef

RecognizeCelebritiesResponseTypeDef#

# RecognizeCelebritiesResponseTypeDef definition

class RecognizeCelebritiesResponseTypeDef(TypedDict):
    CelebrityFaces: List[CelebrityTypeDef],  # (1)
    UnrecognizedFaces: List[ComparedFaceTypeDef],  # (2)
    OrientationCorrection: OrientationCorrectionType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CelebrityTypeDef
  2. See ComparedFaceTypeDef
  3. See OrientationCorrectionType
  4. See ResponseMetadataTypeDef

CompareFacesResponseTypeDef#

# CompareFacesResponseTypeDef definition

class CompareFacesResponseTypeDef(TypedDict):
    SourceImageFace: ComparedSourceImageFaceTypeDef,  # (1)
    FaceMatches: List[CompareFacesMatchTypeDef],  # (2)
    UnmatchedFaces: List[ComparedFaceTypeDef],  # (3)
    SourceImageOrientationCorrection: OrientationCorrectionType,  # (4)
    TargetImageOrientationCorrection: OrientationCorrectionType,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See ComparedSourceImageFaceTypeDef
  2. See CompareFacesMatchTypeDef
  3. See ComparedFaceTypeDef
  4. See OrientationCorrectionType
  5. See OrientationCorrectionType
  6. See ResponseMetadataTypeDef

ProtectiveEquipmentPersonTypeDef#

# ProtectiveEquipmentPersonTypeDef definition

class ProtectiveEquipmentPersonTypeDef(TypedDict):
    BodyParts: NotRequired[List[ProtectiveEquipmentBodyPartTypeDef]],  # (1)
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (2)
    Confidence: NotRequired[float],
    Id: NotRequired[int],
  1. See ProtectiveEquipmentBodyPartTypeDef
  2. See BoundingBoxTypeDef

DetectLabelsResponseTypeDef#

# DetectLabelsResponseTypeDef definition

class DetectLabelsResponseTypeDef(TypedDict):
    Labels: List[LabelTypeDef],  # (1)
    OrientationCorrection: OrientationCorrectionType,  # (2)
    LabelModelVersion: str,
    ImageProperties: DetectLabelsImagePropertiesTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See LabelTypeDef
  2. See OrientationCorrectionType
  3. See DetectLabelsImagePropertiesTypeDef
  4. See ResponseMetadataTypeDef

LabelDetectionTypeDef#

# LabelDetectionTypeDef definition

class LabelDetectionTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    Label: NotRequired[LabelTypeDef],  # (1)
    StartTimestampMillis: NotRequired[int],
    EndTimestampMillis: NotRequired[int],
    DurationMillis: NotRequired[int],
  1. See LabelTypeDef

CelebrityRecognitionTypeDef#

# CelebrityRecognitionTypeDef definition

class CelebrityRecognitionTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    Celebrity: NotRequired[CelebrityDetailTypeDef],  # (1)
  1. See CelebrityDetailTypeDef

GetFaceDetectionResponseTypeDef#

# GetFaceDetectionResponseTypeDef definition

class GetFaceDetectionResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    NextToken: str,
    Faces: List[FaceDetectionTypeDef],  # (3)
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See FaceDetectionTypeDef
  4. See VideoTypeDef
  5. See ResponseMetadataTypeDef

PersonDetectionTypeDef#

# PersonDetectionTypeDef definition

class PersonDetectionTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    Person: NotRequired[PersonDetailTypeDef],  # (1)
  1. See PersonDetailTypeDef

PersonMatchTypeDef#

# PersonMatchTypeDef definition

class PersonMatchTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    Person: NotRequired[PersonDetailTypeDef],  # (1)
    FaceMatches: NotRequired[List[FaceMatchTypeDef]],  # (2)
  1. See PersonDetailTypeDef
  2. See FaceMatchTypeDef

IndexFacesResponseTypeDef#

# IndexFacesResponseTypeDef definition

class IndexFacesResponseTypeDef(TypedDict):
    FaceRecords: List[FaceRecordTypeDef],  # (1)
    OrientationCorrection: OrientationCorrectionType,  # (2)
    FaceModelVersion: str,
    UnindexedFaces: List[UnindexedFaceTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FaceRecordTypeDef
  2. See OrientationCorrectionType
  3. See UnindexedFaceTypeDef
  4. See ResponseMetadataTypeDef

SearchUsersByImageResponseTypeDef#

# SearchUsersByImageResponseTypeDef definition

class SearchUsersByImageResponseTypeDef(TypedDict):
    UserMatches: List[UserMatchTypeDef],  # (1)
    FaceModelVersion: str,
    SearchedFace: SearchedFaceDetailsTypeDef,  # (2)
    UnsearchedFaces: List[UnsearchedFaceTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See UserMatchTypeDef
  2. See SearchedFaceDetailsTypeDef
  3. See UnsearchedFaceTypeDef
  4. See ResponseMetadataTypeDef

DetectCustomLabelsResponseTypeDef#

# DetectCustomLabelsResponseTypeDef definition

class DetectCustomLabelsResponseTypeDef(TypedDict):
    CustomLabels: List[CustomLabelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomLabelTypeDef
  2. See ResponseMetadataTypeDef

DetectTextResponseTypeDef#

# DetectTextResponseTypeDef definition

class DetectTextResponseTypeDef(TypedDict):
    TextDetections: List[TextDetectionTypeDef],  # (1)
    TextModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TextDetectionTypeDef
  2. See ResponseMetadataTypeDef

TextDetectionResultTypeDef#

# TextDetectionResultTypeDef definition

class TextDetectionResultTypeDef(TypedDict):
    Timestamp: NotRequired[int],
    TextDetection: NotRequired[TextDetectionTypeDef],  # (1)
  1. See TextDetectionTypeDef

DetectTextRequestRequestTypeDef#

# DetectTextRequestRequestTypeDef definition

class DetectTextRequestRequestTypeDef(TypedDict):
    Image: ImageTypeDef,  # (1)
    Filters: NotRequired[DetectTextFiltersTypeDef],  # (2)
  1. See ImageTypeDef
  2. See DetectTextFiltersTypeDef

StartTextDetectionRequestRequestTypeDef#

# StartTextDetectionRequestRequestTypeDef definition

class StartTextDetectionRequestRequestTypeDef(TypedDict):
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    JobTag: NotRequired[str],
    Filters: NotRequired[StartTextDetectionFiltersTypeDef],  # (3)
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See StartTextDetectionFiltersTypeDef

ListMediaAnalysisJobsResponseTypeDef#

# ListMediaAnalysisJobsResponseTypeDef definition

class ListMediaAnalysisJobsResponseTypeDef(TypedDict):
    NextToken: str,
    MediaAnalysisJobs: List[MediaAnalysisJobDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MediaAnalysisJobDescriptionTypeDef
  2. See ResponseMetadataTypeDef

CreateProjectVersionRequestRequestTypeDef#

# CreateProjectVersionRequestRequestTypeDef 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],
    VersionDescription: NotRequired[str],
    FeatureConfig: NotRequired[CustomizationFeatureConfigTypeDef],  # (4)
  1. See OutputConfigTypeDef
  2. See TrainingDataTypeDef
  3. See TestingDataTypeDef
  4. See CustomizationFeatureConfigTypeDef

TestingDataResultPaginatorTypeDef#

# TestingDataResultPaginatorTypeDef definition

class TestingDataResultPaginatorTypeDef(TypedDict):
    Input: NotRequired[TestingDataPaginatorTypeDef],  # (1)
    Output: NotRequired[TestingDataPaginatorTypeDef],  # (1)
    Validation: NotRequired[ValidationDataTypeDef],  # (3)
  1. See TestingDataPaginatorTypeDef
  2. See TestingDataPaginatorTypeDef
  3. See ValidationDataTypeDef

TestingDataResultTypeDef#

# TestingDataResultTypeDef definition

class TestingDataResultTypeDef(TypedDict):
    Input: NotRequired[TestingDataTypeDef],  # (1)
    Output: NotRequired[TestingDataTypeDef],  # (1)
    Validation: NotRequired[ValidationDataTypeDef],  # (3)
  1. See TestingDataTypeDef
  2. See TestingDataTypeDef
  3. See ValidationDataTypeDef

TrainingDataResultPaginatorTypeDef#

# TrainingDataResultPaginatorTypeDef definition

class TrainingDataResultPaginatorTypeDef(TypedDict):
    Input: NotRequired[TrainingDataPaginatorTypeDef],  # (1)
    Output: NotRequired[TrainingDataPaginatorTypeDef],  # (1)
    Validation: NotRequired[ValidationDataTypeDef],  # (3)
  1. See TrainingDataPaginatorTypeDef
  2. See TrainingDataPaginatorTypeDef
  3. See ValidationDataTypeDef

TrainingDataResultTypeDef#

# TrainingDataResultTypeDef definition

class TrainingDataResultTypeDef(TypedDict):
    Input: NotRequired[TrainingDataTypeDef],  # (1)
    Output: NotRequired[TrainingDataTypeDef],  # (1)
    Validation: NotRequired[ValidationDataTypeDef],  # (3)
  1. See TrainingDataTypeDef
  2. See TrainingDataTypeDef
  3. See ValidationDataTypeDef

DetectProtectiveEquipmentResponseTypeDef#

# DetectProtectiveEquipmentResponseTypeDef definition

class DetectProtectiveEquipmentResponseTypeDef(TypedDict):
    ProtectiveEquipmentModelVersion: str,
    Persons: List[ProtectiveEquipmentPersonTypeDef],  # (1)
    Summary: ProtectiveEquipmentSummaryTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ProtectiveEquipmentPersonTypeDef
  2. See ProtectiveEquipmentSummaryTypeDef
  3. See ResponseMetadataTypeDef

GetLabelDetectionResponseTypeDef#

# GetLabelDetectionResponseTypeDef definition

class GetLabelDetectionResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    NextToken: str,
    Labels: List[LabelDetectionTypeDef],  # (3)
    LabelModelVersion: str,
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    GetRequestMetadata: GetLabelDetectionRequestMetadataTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See LabelDetectionTypeDef
  4. See VideoTypeDef
  5. See GetLabelDetectionRequestMetadataTypeDef
  6. See ResponseMetadataTypeDef

GetCelebrityRecognitionResponseTypeDef#

# GetCelebrityRecognitionResponseTypeDef definition

class GetCelebrityRecognitionResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    NextToken: str,
    Celebrities: List[CelebrityRecognitionTypeDef],  # (3)
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See CelebrityRecognitionTypeDef
  4. See VideoTypeDef
  5. See ResponseMetadataTypeDef

GetPersonTrackingResponseTypeDef#

# GetPersonTrackingResponseTypeDef definition

class GetPersonTrackingResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    NextToken: str,
    Persons: List[PersonDetectionTypeDef],  # (3)
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See PersonDetectionTypeDef
  4. See VideoTypeDef
  5. See ResponseMetadataTypeDef

GetFaceSearchResponseTypeDef#

# GetFaceSearchResponseTypeDef definition

class GetFaceSearchResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    NextToken: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    Persons: List[PersonMatchTypeDef],  # (3)
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See PersonMatchTypeDef
  4. See VideoTypeDef
  5. See ResponseMetadataTypeDef

GetTextDetectionResponseTypeDef#

# GetTextDetectionResponseTypeDef definition

class GetTextDetectionResponseTypeDef(TypedDict):
    JobStatus: VideoJobStatusType,  # (1)
    StatusMessage: str,
    VideoMetadata: VideoMetadataTypeDef,  # (2)
    TextDetections: List[TextDetectionResultTypeDef],  # (3)
    NextToken: str,
    TextModelVersion: str,
    JobId: str,
    Video: VideoTypeDef,  # (4)
    JobTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See VideoJobStatusType
  2. See VideoMetadataTypeDef
  3. See TextDetectionResultTypeDef
  4. See VideoTypeDef
  5. See ResponseMetadataTypeDef

ProjectVersionDescriptionPaginatorTypeDef#

# ProjectVersionDescriptionPaginatorTypeDef definition

class ProjectVersionDescriptionPaginatorTypeDef(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[TrainingDataResultPaginatorTypeDef],  # (3)
    TestingDataResult: NotRequired[TestingDataResultPaginatorTypeDef],  # (4)
    EvaluationResult: NotRequired[EvaluationResultTypeDef],  # (5)
    ManifestSummary: NotRequired[GroundTruthManifestTypeDef],  # (6)
    KmsKeyId: NotRequired[str],
    MaxInferenceUnits: NotRequired[int],
    SourceProjectVersionArn: NotRequired[str],
    VersionDescription: NotRequired[str],
    Feature: NotRequired[CustomizationFeatureType],  # (7)
    BaseModelVersion: NotRequired[str],
    FeatureConfig: NotRequired[CustomizationFeatureConfigTypeDef],  # (8)
  1. See ProjectVersionStatusType
  2. See OutputConfigTypeDef
  3. See TrainingDataResultPaginatorTypeDef
  4. See TestingDataResultPaginatorTypeDef
  5. See EvaluationResultTypeDef
  6. See GroundTruthManifestTypeDef
  7. See CustomizationFeatureType
  8. See CustomizationFeatureConfigTypeDef

ProjectVersionDescriptionTypeDef#

# ProjectVersionDescriptionTypeDef 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],
    VersionDescription: NotRequired[str],
    Feature: NotRequired[CustomizationFeatureType],  # (7)
    BaseModelVersion: NotRequired[str],
    FeatureConfig: NotRequired[CustomizationFeatureConfigTypeDef],  # (8)
  1. See ProjectVersionStatusType
  2. See OutputConfigTypeDef
  3. See TrainingDataResultTypeDef
  4. See TestingDataResultTypeDef
  5. See EvaluationResultTypeDef
  6. See GroundTruthManifestTypeDef
  7. See CustomizationFeatureType
  8. See CustomizationFeatureConfigTypeDef

DescribeProjectVersionsResponsePaginatorTypeDef#

# DescribeProjectVersionsResponsePaginatorTypeDef definition

class DescribeProjectVersionsResponsePaginatorTypeDef(TypedDict):
    ProjectVersionDescriptions: List[ProjectVersionDescriptionPaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectVersionDescriptionPaginatorTypeDef
  2. See ResponseMetadataTypeDef

DescribeProjectVersionsResponseTypeDef#

# DescribeProjectVersionsResponseTypeDef definition

class DescribeProjectVersionsResponseTypeDef(TypedDict):
    ProjectVersionDescriptions: List[ProjectVersionDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectVersionDescriptionTypeDef
  2. See ResponseMetadataTypeDef