| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition
Contents
- Service Configuration
- Errors
- AccessDeniedException
- VideoTooLargeException
- InvalidParameterException
- InvalidImageFormatException
- ResourceAlreadyExistsException
- InvalidS3ObjectException
- ProvisionedThroughputExceededException
- ImageTooLargeException
- ServiceQuotaExceededException
- ThrottlingException
- InternalServerError
- IdempotentParameterMismatchException
- ResourceNotReadyException
- ResourceNotFoundException
- HumanLoopQuotaExceededException
- InvalidPaginationTokenException
- LimitExceededException
- ResourceInUseException
- Waiters
- Operations
- DetectProtectiveEquipment
- DeleteProject
- StartCelebrityRecognition
- GetPersonTracking
- GetTextDetection
- StartSegmentDetection
- ListCollections (Paginated)
- StartProjectVersion
- DeleteCollection
- CreateCollection
- StopStreamProcessor
- DetectLabels
- ListTagsForResource
- StartContentModeration
- SearchFacesByImage
- ListStreamProcessors (Paginated)
- DescribeCollection
- DeleteProjectVersion
- DescribeProjectVersions (Paginated)
- RecognizeCelebrities
- DetectCustomLabels
- GetFaceSearch
- StartLabelDetection
- SearchFaces
- IndexFaces
- GetLabelDetection
- StopProjectVersion
- DescribeStreamProcessor
- StartFaceSearch
- StartTextDetection
- StartPersonTracking
- GetCelebrityRecognition
- StartStreamProcessor
- DetectText
- GetSegmentDetection
- CompareFaces
- DetectFaces
- GetFaceDetection
- TagResource
- ListFaces (Paginated)
- CreateProjectVersion
- DescribeProjects (Paginated)
- GetContentModeration
- DeleteFaces
- GetCelebrityInfo
- DeleteStreamProcessor
- UntagResource
- DetectModerationLabels
- CreateStreamProcessor
- StartFaceDetection
- CreateProject
- Types
- Attribute
- BodyPart
- CelebrityRecognitionSortBy
- ContentClassifier
- ContentModerationSortBy
- EmotionName
- FaceAttributes
- FaceSearchSortBy
- GenderType
- KnownGenderType
- LabelDetectionSortBy
- LandmarkType
- OrientationCorrection
- PersonTrackingSortBy
- ProjectStatus
- ProjectVersionStatus
- ProtectiveEquipmentType
- QualityFilter
- Reason
- SegmentType
- StreamProcessorStatus
- TechnicalCueType
- TextTypes
- VideoColorRange
- VideoJobStatus
- AgeRange
- Asset
- AudioMetadata
- Beard
- BlackFrame
- BoundingBox
- Celebrity
- CelebrityDetail
- CelebrityRecognition
- CompareFacesMatch
- ComparedFace
- ComparedSourceImageFace
- ContentModerationDetection
- CoversBodyPart
- CustomLabel
- DetectTextFilters
- DetectionFilter
- Emotion
- EquipmentDetection
- EvaluationResult
- EyeOpen
- Eyeglasses
- Face
- FaceDetail
- FaceDetection
- FaceMatch
- FaceRecord
- FaceSearchSettings
- Gender
- Geometry
- GroundTruthManifest
- HumanLoopActivationOutput
- HumanLoopConfig
- HumanLoopDataAttributes
- Image
- ImageQuality
- Instance
- KinesisDataStream
- KinesisVideoStream
- KnownGender
- Label
- LabelDetection
- Landmark
- ModerationLabel
- MouthOpen
- Mustache
- NotificationChannel
- OutputConfig
- Parent
- PersonDetail
- PersonDetection
- PersonMatch
- Point
- Pose
- ProjectDescription
- ProjectVersionDescription
- ProtectiveEquipmentBodyPart
- ProtectiveEquipmentPerson
- ProtectiveEquipmentSummarizationAttributes
- ProtectiveEquipmentSummary
- RegionOfInterest
- S3Object
- SegmentDetection
- SegmentTypeInfo
- ShotSegment
- Smile
- StartSegmentDetectionFilters
- StartShotDetectionFilter
- StartTechnicalCueDetectionFilter
- StartTextDetectionFilters
- StreamProcessor
- StreamProcessorInput
- StreamProcessorOutput
- StreamProcessorSettings
- Summary
- Sunglasses
- TechnicalCueSegment
- TestingData
- TestingDataResult
- TextDetection
- TextDetectionResult
- TrainingData
- TrainingDataResult
- UnindexedFace
- ValidationData
- Video
- VideoMetadata
Description
Derived from API version 2016-06-27 of the AWS service descriptions, licensed under Apache 2.0.
This is the Amazon Rekognition API reference.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _VideoTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidImageFormatException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidS3ObjectException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ImageTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotReadyException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _HumanLoopQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPaginationTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newProjectVersionRunning :: Wait DescribeProjectVersions
- newProjectVersionTrainingCompleted :: Wait DescribeProjectVersions
- data DetectProtectiveEquipment = DetectProtectiveEquipment' (Maybe ProtectiveEquipmentSummarizationAttributes) Image
- newDetectProtectiveEquipment :: Image -> DetectProtectiveEquipment
- data DetectProtectiveEquipmentResponse = DetectProtectiveEquipmentResponse' (Maybe ProtectiveEquipmentSummary) (Maybe Text) (Maybe [ProtectiveEquipmentPerson]) Int
- newDetectProtectiveEquipmentResponse :: Int -> DetectProtectiveEquipmentResponse
- data DeleteProject = DeleteProject' Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' (Maybe ProjectStatus) Int
- newDeleteProjectResponse :: Int -> DeleteProjectResponse
- data StartCelebrityRecognition = StartCelebrityRecognition' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) Video
- newStartCelebrityRecognition :: Video -> StartCelebrityRecognition
- data StartCelebrityRecognitionResponse = StartCelebrityRecognitionResponse' (Maybe Text) Int
- newStartCelebrityRecognitionResponse :: Int -> StartCelebrityRecognitionResponse
- data GetPersonTracking = GetPersonTracking' (Maybe Text) (Maybe Natural) (Maybe PersonTrackingSortBy) Text
- newGetPersonTracking :: Text -> GetPersonTracking
- data GetPersonTrackingResponse = GetPersonTrackingResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe VideoJobStatus) (Maybe [PersonDetection]) Int
- newGetPersonTrackingResponse :: Int -> GetPersonTrackingResponse
- data GetTextDetection = GetTextDetection' (Maybe Text) (Maybe Natural) Text
- newGetTextDetection :: Text -> GetTextDetection
- data GetTextDetectionResponse = GetTextDetectionResponse' (Maybe [TextDetectionResult]) (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe Text) (Maybe VideoJobStatus) Int
- newGetTextDetectionResponse :: Int -> GetTextDetectionResponse
- data StartSegmentDetection = StartSegmentDetection' (Maybe Text) (Maybe StartSegmentDetectionFilters) (Maybe NotificationChannel) (Maybe Text) Video (NonEmpty SegmentType)
- newStartSegmentDetection :: Video -> NonEmpty SegmentType -> StartSegmentDetection
- data StartSegmentDetectionResponse = StartSegmentDetectionResponse' (Maybe Text) Int
- newStartSegmentDetectionResponse :: Int -> StartSegmentDetectionResponse
- data ListCollections = ListCollections' (Maybe Text) (Maybe Natural)
- newListCollections :: ListCollections
- data ListCollectionsResponse = ListCollectionsResponse' (Maybe [Text]) (Maybe Text) (Maybe [Text]) Int
- newListCollectionsResponse :: Int -> ListCollectionsResponse
- data StartProjectVersion = StartProjectVersion' Text Natural
- newStartProjectVersion :: Text -> Natural -> StartProjectVersion
- data StartProjectVersionResponse = StartProjectVersionResponse' (Maybe ProjectVersionStatus) Int
- newStartProjectVersionResponse :: Int -> StartProjectVersionResponse
- data DeleteCollection = DeleteCollection' Text
- newDeleteCollection :: Text -> DeleteCollection
- data DeleteCollectionResponse = DeleteCollectionResponse' (Maybe Natural) Int
- newDeleteCollectionResponse :: Int -> DeleteCollectionResponse
- data CreateCollection = CreateCollection' (Maybe (HashMap Text Text)) Text
- newCreateCollection :: Text -> CreateCollection
- data CreateCollectionResponse = CreateCollectionResponse' (Maybe Text) (Maybe Text) (Maybe Natural) Int
- newCreateCollectionResponse :: Int -> CreateCollectionResponse
- data StopStreamProcessor = StopStreamProcessor' Text
- newStopStreamProcessor :: Text -> StopStreamProcessor
- data StopStreamProcessorResponse = StopStreamProcessorResponse' Int
- newStopStreamProcessorResponse :: Int -> StopStreamProcessorResponse
- data DetectLabels = DetectLabels' (Maybe Double) (Maybe Natural) Image
- newDetectLabels :: Image -> DetectLabels
- data DetectLabelsResponse = DetectLabelsResponse' (Maybe [Label]) (Maybe OrientationCorrection) (Maybe Text) Int
- newDetectLabelsResponse :: Int -> DetectLabelsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartContentModeration = StartContentModeration' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe Double) Video
- newStartContentModeration :: Video -> StartContentModeration
- data StartContentModerationResponse = StartContentModerationResponse' (Maybe Text) Int
- newStartContentModerationResponse :: Int -> StartContentModerationResponse
- data SearchFacesByImage = SearchFacesByImage' (Maybe QualityFilter) (Maybe Double) (Maybe Natural) Text Image
- newSearchFacesByImage :: Text -> Image -> SearchFacesByImage
- data SearchFacesByImageResponse = SearchFacesByImageResponse' (Maybe [FaceMatch]) (Maybe Text) (Maybe BoundingBox) (Maybe Double) Int
- newSearchFacesByImageResponse :: Int -> SearchFacesByImageResponse
- data ListStreamProcessors = ListStreamProcessors' (Maybe Text) (Maybe Natural)
- newListStreamProcessors :: ListStreamProcessors
- data ListStreamProcessorsResponse = ListStreamProcessorsResponse' (Maybe [StreamProcessor]) (Maybe Text) Int
- newListStreamProcessorsResponse :: Int -> ListStreamProcessorsResponse
- data DescribeCollection = DescribeCollection' Text
- newDescribeCollection :: Text -> DescribeCollection
- data DescribeCollectionResponse = DescribeCollectionResponse' (Maybe Text) (Maybe Natural) (Maybe POSIX) (Maybe Text) Int
- newDescribeCollectionResponse :: Int -> DescribeCollectionResponse
- data DeleteProjectVersion = DeleteProjectVersion' Text
- newDeleteProjectVersion :: Text -> DeleteProjectVersion
- data DeleteProjectVersionResponse = DeleteProjectVersionResponse' (Maybe ProjectVersionStatus) Int
- newDeleteProjectVersionResponse :: Int -> DeleteProjectVersionResponse
- data DescribeProjectVersions = DescribeProjectVersions' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Natural) Text
- newDescribeProjectVersions :: Text -> DescribeProjectVersions
- data DescribeProjectVersionsResponse = DescribeProjectVersionsResponse' (Maybe Text) (Maybe [ProjectVersionDescription]) Int
- newDescribeProjectVersionsResponse :: Int -> DescribeProjectVersionsResponse
- data RecognizeCelebrities = RecognizeCelebrities' Image
- newRecognizeCelebrities :: Image -> RecognizeCelebrities
- data RecognizeCelebritiesResponse = RecognizeCelebritiesResponse' (Maybe [Celebrity]) (Maybe OrientationCorrection) (Maybe [ComparedFace]) Int
- newRecognizeCelebritiesResponse :: Int -> RecognizeCelebritiesResponse
- data DetectCustomLabels = DetectCustomLabels' (Maybe Double) (Maybe Natural) Text Image
- newDetectCustomLabels :: Text -> Image -> DetectCustomLabels
- data DetectCustomLabelsResponse = DetectCustomLabelsResponse' (Maybe [CustomLabel]) Int
- newDetectCustomLabelsResponse :: Int -> DetectCustomLabelsResponse
- data GetFaceSearch = GetFaceSearch' (Maybe Text) (Maybe Natural) (Maybe FaceSearchSortBy) Text
- newGetFaceSearch :: Text -> GetFaceSearch
- data GetFaceSearchResponse = GetFaceSearchResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe VideoJobStatus) (Maybe [PersonMatch]) Int
- newGetFaceSearchResponse :: Int -> GetFaceSearchResponse
- data StartLabelDetection = StartLabelDetection' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe Double) Video
- newStartLabelDetection :: Video -> StartLabelDetection
- data StartLabelDetectionResponse = StartLabelDetectionResponse' (Maybe Text) Int
- newStartLabelDetectionResponse :: Int -> StartLabelDetectionResponse
- data SearchFaces = SearchFaces' (Maybe Double) (Maybe Natural) Text Text
- newSearchFaces :: Text -> Text -> SearchFaces
- data SearchFacesResponse = SearchFacesResponse' (Maybe [FaceMatch]) (Maybe Text) (Maybe Text) Int
- newSearchFacesResponse :: Int -> SearchFacesResponse
- data IndexFaces = IndexFaces' (Maybe Text) (Maybe QualityFilter) (Maybe Natural) (Maybe [Attribute]) Text Image
- newIndexFaces :: Text -> Image -> IndexFaces
- data IndexFacesResponse = IndexFacesResponse' (Maybe Text) (Maybe [FaceRecord]) (Maybe OrientationCorrection) (Maybe [UnindexedFace]) Int
- newIndexFacesResponse :: Int -> IndexFacesResponse
- data GetLabelDetection = GetLabelDetection' (Maybe Text) (Maybe Natural) (Maybe LabelDetectionSortBy) Text
- newGetLabelDetection :: Text -> GetLabelDetection
- data GetLabelDetectionResponse = GetLabelDetectionResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe [LabelDetection]) (Maybe VideoJobStatus) (Maybe Text) Int
- newGetLabelDetectionResponse :: Int -> GetLabelDetectionResponse
- data StopProjectVersion = StopProjectVersion' Text
- newStopProjectVersion :: Text -> StopProjectVersion
- data StopProjectVersionResponse = StopProjectVersionResponse' (Maybe ProjectVersionStatus) Int
- newStopProjectVersionResponse :: Int -> StopProjectVersionResponse
- data DescribeStreamProcessor = DescribeStreamProcessor' Text
- newDescribeStreamProcessor :: Text -> DescribeStreamProcessor
- data DescribeStreamProcessorResponse = DescribeStreamProcessorResponse' (Maybe StreamProcessorStatus) (Maybe StreamProcessorSettings) (Maybe StreamProcessorInput) (Maybe StreamProcessorOutput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) Int
- newDescribeStreamProcessorResponse :: Int -> DescribeStreamProcessorResponse
- data StartFaceSearch = StartFaceSearch' (Maybe Double) (Maybe Text) (Maybe NotificationChannel) (Maybe Text) Video Text
- newStartFaceSearch :: Video -> Text -> StartFaceSearch
- data StartFaceSearchResponse = StartFaceSearchResponse' (Maybe Text) Int
- newStartFaceSearchResponse :: Int -> StartFaceSearchResponse
- data StartTextDetection = StartTextDetection' (Maybe Text) (Maybe StartTextDetectionFilters) (Maybe NotificationChannel) (Maybe Text) Video
- newStartTextDetection :: Video -> StartTextDetection
- data StartTextDetectionResponse = StartTextDetectionResponse' (Maybe Text) Int
- newStartTextDetectionResponse :: Int -> StartTextDetectionResponse
- data StartPersonTracking = StartPersonTracking' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) Video
- newStartPersonTracking :: Video -> StartPersonTracking
- data StartPersonTrackingResponse = StartPersonTrackingResponse' (Maybe Text) Int
- newStartPersonTrackingResponse :: Int -> StartPersonTrackingResponse
- data GetCelebrityRecognition = GetCelebrityRecognition' (Maybe Text) (Maybe Natural) (Maybe CelebrityRecognitionSortBy) Text
- newGetCelebrityRecognition :: Text -> GetCelebrityRecognition
- data GetCelebrityRecognitionResponse = GetCelebrityRecognitionResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe [CelebrityRecognition]) (Maybe VideoJobStatus) Int
- newGetCelebrityRecognitionResponse :: Int -> GetCelebrityRecognitionResponse
- data StartStreamProcessor = StartStreamProcessor' Text
- newStartStreamProcessor :: Text -> StartStreamProcessor
- data StartStreamProcessorResponse = StartStreamProcessorResponse' Int
- newStartStreamProcessorResponse :: Int -> StartStreamProcessorResponse
- data DetectText = DetectText' (Maybe DetectTextFilters) Image
- newDetectText :: Image -> DetectText
- data DetectTextResponse = DetectTextResponse' (Maybe [TextDetection]) (Maybe Text) Int
- newDetectTextResponse :: Int -> DetectTextResponse
- data GetSegmentDetection = GetSegmentDetection' (Maybe Text) (Maybe Natural) Text
- newGetSegmentDetection :: Text -> GetSegmentDetection
- data GetSegmentDetectionResponse = GetSegmentDetectionResponse' (Maybe [SegmentTypeInfo]) (Maybe Text) (Maybe [VideoMetadata]) (Maybe Text) (Maybe [SegmentDetection]) (Maybe VideoJobStatus) (Maybe [AudioMetadata]) Int
- newGetSegmentDetectionResponse :: Int -> GetSegmentDetectionResponse
- data CompareFaces = CompareFaces' (Maybe QualityFilter) (Maybe Double) Image Image
- newCompareFaces :: Image -> Image -> CompareFaces
- data CompareFacesResponse = CompareFacesResponse' (Maybe [CompareFacesMatch]) (Maybe [ComparedFace]) (Maybe OrientationCorrection) (Maybe OrientationCorrection) (Maybe ComparedSourceImageFace) Int
- newCompareFacesResponse :: Int -> CompareFacesResponse
- data DetectFaces = DetectFaces' (Maybe [Attribute]) Image
- newDetectFaces :: Image -> DetectFaces
- data DetectFacesResponse = DetectFacesResponse' (Maybe OrientationCorrection) (Maybe [FaceDetail]) Int
- newDetectFacesResponse :: Int -> DetectFacesResponse
- data GetFaceDetection = GetFaceDetection' (Maybe Text) (Maybe Natural) Text
- newGetFaceDetection :: Text -> GetFaceDetection
- data GetFaceDetectionResponse = GetFaceDetectionResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe [FaceDetection]) (Maybe VideoJobStatus) Int
- newGetFaceDetectionResponse :: Int -> GetFaceDetectionResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListFaces = ListFaces' (Maybe Text) (Maybe Natural) Text
- newListFaces :: Text -> ListFaces
- data ListFacesResponse = ListFacesResponse' (Maybe Text) (Maybe Text) (Maybe [Face]) Int
- newListFacesResponse :: Int -> ListFacesResponse
- data CreateProjectVersion = CreateProjectVersion' (Maybe Text) (Maybe (HashMap Text Text)) Text Text OutputConfig TrainingData TestingData
- newCreateProjectVersion :: Text -> Text -> OutputConfig -> TrainingData -> TestingData -> CreateProjectVersion
- data CreateProjectVersionResponse = CreateProjectVersionResponse' (Maybe Text) Int
- newCreateProjectVersionResponse :: Int -> CreateProjectVersionResponse
- data DescribeProjects = DescribeProjects' (Maybe Text) (Maybe Natural)
- newDescribeProjects :: DescribeProjects
- data DescribeProjectsResponse = DescribeProjectsResponse' (Maybe Text) (Maybe [ProjectDescription]) Int
- newDescribeProjectsResponse :: Int -> DescribeProjectsResponse
- data GetContentModeration = GetContentModeration' (Maybe Text) (Maybe Natural) (Maybe ContentModerationSortBy) Text
- newGetContentModeration :: Text -> GetContentModeration
- data GetContentModerationResponse = GetContentModerationResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe VideoJobStatus) (Maybe Text) (Maybe [ContentModerationDetection]) Int
- newGetContentModerationResponse :: Int -> GetContentModerationResponse
- data DeleteFaces = DeleteFaces' Text (NonEmpty Text)
- newDeleteFaces :: Text -> NonEmpty Text -> DeleteFaces
- data DeleteFacesResponse = DeleteFacesResponse' (Maybe (NonEmpty Text)) Int
- newDeleteFacesResponse :: Int -> DeleteFacesResponse
- data GetCelebrityInfo = GetCelebrityInfo' Text
- newGetCelebrityInfo :: Text -> GetCelebrityInfo
- data GetCelebrityInfoResponse = GetCelebrityInfoResponse' (Maybe [Text]) (Maybe KnownGender) (Maybe Text) Int
- newGetCelebrityInfoResponse :: Int -> GetCelebrityInfoResponse
- data DeleteStreamProcessor = DeleteStreamProcessor' Text
- newDeleteStreamProcessor :: Text -> DeleteStreamProcessor
- data DeleteStreamProcessorResponse = DeleteStreamProcessorResponse' Int
- newDeleteStreamProcessorResponse :: Int -> DeleteStreamProcessorResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data DetectModerationLabels = DetectModerationLabels' (Maybe HumanLoopConfig) (Maybe Double) Image
- newDetectModerationLabels :: Image -> DetectModerationLabels
- data DetectModerationLabelsResponse = DetectModerationLabelsResponse' (Maybe HumanLoopActivationOutput) (Maybe Text) (Maybe [ModerationLabel]) Int
- newDetectModerationLabelsResponse :: Int -> DetectModerationLabelsResponse
- data CreateStreamProcessor = CreateStreamProcessor' (Maybe (HashMap Text Text)) StreamProcessorInput StreamProcessorOutput Text StreamProcessorSettings Text
- newCreateStreamProcessor :: StreamProcessorInput -> StreamProcessorOutput -> Text -> StreamProcessorSettings -> Text -> CreateStreamProcessor
- data CreateStreamProcessorResponse = CreateStreamProcessorResponse' (Maybe Text) Int
- newCreateStreamProcessorResponse :: Int -> CreateStreamProcessorResponse
- data StartFaceDetection = StartFaceDetection' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe FaceAttributes) Video
- newStartFaceDetection :: Video -> StartFaceDetection
- data StartFaceDetectionResponse = StartFaceDetectionResponse' (Maybe Text) Int
- newStartFaceDetectionResponse :: Int -> StartFaceDetectionResponse
- data CreateProject = CreateProject' Text
- newCreateProject :: Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' (Maybe Text) Int
- newCreateProjectResponse :: Int -> CreateProjectResponse
- newtype Attribute where
- Attribute' { }
- pattern Attribute_ALL :: Attribute
- pattern Attribute_DEFAULT :: Attribute
- newtype BodyPart where
- BodyPart' {
- fromBodyPart :: Text
- pattern BodyPart_FACE :: BodyPart
- pattern BodyPart_HEAD :: BodyPart
- pattern BodyPart_LEFT_HAND :: BodyPart
- pattern BodyPart_RIGHT_HAND :: BodyPart
- BodyPart' {
- newtype CelebrityRecognitionSortBy where
- newtype ContentClassifier where
- newtype ContentModerationSortBy where
- newtype EmotionName where
- EmotionName' { }
- pattern EmotionName_ANGRY :: EmotionName
- pattern EmotionName_CALM :: EmotionName
- pattern EmotionName_CONFUSED :: EmotionName
- pattern EmotionName_DISGUSTED :: EmotionName
- pattern EmotionName_FEAR :: EmotionName
- pattern EmotionName_HAPPY :: EmotionName
- pattern EmotionName_SAD :: EmotionName
- pattern EmotionName_SURPRISED :: EmotionName
- pattern EmotionName_UNKNOWN :: EmotionName
- newtype FaceAttributes where
- FaceAttributes' { }
- pattern FaceAttributes_ALL :: FaceAttributes
- pattern FaceAttributes_DEFAULT :: FaceAttributes
- newtype FaceSearchSortBy where
- FaceSearchSortBy' { }
- pattern FaceSearchSortBy_INDEX :: FaceSearchSortBy
- pattern FaceSearchSortBy_TIMESTAMP :: FaceSearchSortBy
- newtype GenderType where
- GenderType' { }
- pattern GenderType_Female :: GenderType
- pattern GenderType_Male :: GenderType
- newtype KnownGenderType where
- KnownGenderType' { }
- pattern KnownGenderType_Female :: KnownGenderType
- pattern KnownGenderType_Male :: KnownGenderType
- newtype LabelDetectionSortBy where
- newtype LandmarkType where
- LandmarkType' { }
- pattern LandmarkType_ChinBottom :: LandmarkType
- pattern LandmarkType_EyeLeft :: LandmarkType
- pattern LandmarkType_EyeRight :: LandmarkType
- pattern LandmarkType_LeftEyeBrowLeft :: LandmarkType
- pattern LandmarkType_LeftEyeBrowRight :: LandmarkType
- pattern LandmarkType_LeftEyeBrowUp :: LandmarkType
- pattern LandmarkType_LeftEyeDown :: LandmarkType
- pattern LandmarkType_LeftEyeLeft :: LandmarkType
- pattern LandmarkType_LeftEyeRight :: LandmarkType
- pattern LandmarkType_LeftEyeUp :: LandmarkType
- pattern LandmarkType_LeftPupil :: LandmarkType
- pattern LandmarkType_MidJawlineLeft :: LandmarkType
- pattern LandmarkType_MidJawlineRight :: LandmarkType
- pattern LandmarkType_MouthDown :: LandmarkType
- pattern LandmarkType_MouthLeft :: LandmarkType
- pattern LandmarkType_MouthRight :: LandmarkType
- pattern LandmarkType_MouthUp :: LandmarkType
- pattern LandmarkType_Nose :: LandmarkType
- pattern LandmarkType_NoseLeft :: LandmarkType
- pattern LandmarkType_NoseRight :: LandmarkType
- pattern LandmarkType_RightEyeBrowLeft :: LandmarkType
- pattern LandmarkType_RightEyeBrowRight :: LandmarkType
- pattern LandmarkType_RightEyeBrowUp :: LandmarkType
- pattern LandmarkType_RightEyeDown :: LandmarkType
- pattern LandmarkType_RightEyeLeft :: LandmarkType
- pattern LandmarkType_RightEyeRight :: LandmarkType
- pattern LandmarkType_RightEyeUp :: LandmarkType
- pattern LandmarkType_RightPupil :: LandmarkType
- pattern LandmarkType_UpperJawlineLeft :: LandmarkType
- pattern LandmarkType_UpperJawlineRight :: LandmarkType
- newtype OrientationCorrection where
- newtype PersonTrackingSortBy where
- newtype ProjectStatus where
- ProjectStatus' { }
- pattern ProjectStatus_CREATED :: ProjectStatus
- pattern ProjectStatus_CREATING :: ProjectStatus
- pattern ProjectStatus_DELETING :: ProjectStatus
- newtype ProjectVersionStatus where
- ProjectVersionStatus' { }
- pattern ProjectVersionStatus_DELETING :: ProjectVersionStatus
- pattern ProjectVersionStatus_FAILED :: ProjectVersionStatus
- pattern ProjectVersionStatus_RUNNING :: ProjectVersionStatus
- pattern ProjectVersionStatus_STARTING :: ProjectVersionStatus
- pattern ProjectVersionStatus_STOPPED :: ProjectVersionStatus
- pattern ProjectVersionStatus_STOPPING :: ProjectVersionStatus
- pattern ProjectVersionStatus_TRAINING_COMPLETED :: ProjectVersionStatus
- pattern ProjectVersionStatus_TRAINING_FAILED :: ProjectVersionStatus
- pattern ProjectVersionStatus_TRAINING_IN_PROGRESS :: ProjectVersionStatus
- newtype ProtectiveEquipmentType where
- newtype QualityFilter where
- QualityFilter' { }
- pattern QualityFilter_AUTO :: QualityFilter
- pattern QualityFilter_HIGH :: QualityFilter
- pattern QualityFilter_LOW :: QualityFilter
- pattern QualityFilter_MEDIUM :: QualityFilter
- pattern QualityFilter_NONE :: QualityFilter
- newtype Reason where
- Reason' {
- fromReason :: Text
- pattern Reason_EXCEEDS_MAX_FACES :: Reason
- pattern Reason_EXTREME_POSE :: Reason
- pattern Reason_LOW_BRIGHTNESS :: Reason
- pattern Reason_LOW_CONFIDENCE :: Reason
- pattern Reason_LOW_FACE_QUALITY :: Reason
- pattern Reason_LOW_SHARPNESS :: Reason
- pattern Reason_SMALL_BOUNDING_BOX :: Reason
- Reason' {
- newtype SegmentType where
- SegmentType' { }
- pattern SegmentType_SHOT :: SegmentType
- pattern SegmentType_TECHNICAL_CUE :: SegmentType
- newtype StreamProcessorStatus where
- StreamProcessorStatus' { }
- pattern StreamProcessorStatus_FAILED :: StreamProcessorStatus
- pattern StreamProcessorStatus_RUNNING :: StreamProcessorStatus
- pattern StreamProcessorStatus_STARTING :: StreamProcessorStatus
- pattern StreamProcessorStatus_STOPPED :: StreamProcessorStatus
- pattern StreamProcessorStatus_STOPPING :: StreamProcessorStatus
- newtype TechnicalCueType where
- TechnicalCueType' { }
- pattern TechnicalCueType_BlackFrames :: TechnicalCueType
- pattern TechnicalCueType_ColorBars :: TechnicalCueType
- pattern TechnicalCueType_Content :: TechnicalCueType
- pattern TechnicalCueType_EndCredits :: TechnicalCueType
- pattern TechnicalCueType_OpeningCredits :: TechnicalCueType
- pattern TechnicalCueType_Slate :: TechnicalCueType
- pattern TechnicalCueType_StudioLogo :: TechnicalCueType
- newtype TextTypes where
- TextTypes' { }
- pattern TextTypes_LINE :: TextTypes
- pattern TextTypes_WORD :: TextTypes
- newtype VideoColorRange where
- VideoColorRange' { }
- pattern VideoColorRange_FULL :: VideoColorRange
- pattern VideoColorRange_LIMITED :: VideoColorRange
- newtype VideoJobStatus where
- VideoJobStatus' { }
- pattern VideoJobStatus_FAILED :: VideoJobStatus
- pattern VideoJobStatus_IN_PROGRESS :: VideoJobStatus
- pattern VideoJobStatus_SUCCEEDED :: VideoJobStatus
- data AgeRange = AgeRange' (Maybe Natural) (Maybe Natural)
- newAgeRange :: AgeRange
- data Asset = Asset' (Maybe GroundTruthManifest)
- newAsset :: Asset
- data AudioMetadata = AudioMetadata' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural)
- newAudioMetadata :: AudioMetadata
- data Beard = Beard' (Maybe Bool) (Maybe Double)
- newBeard :: Beard
- data BlackFrame = BlackFrame' (Maybe Double) (Maybe Double)
- newBlackFrame :: BlackFrame
- data BoundingBox = BoundingBox' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newBoundingBox :: BoundingBox
- data Celebrity = Celebrity' (Maybe Double) (Maybe [Text]) (Maybe KnownGender) (Maybe Text) (Maybe Text) (Maybe ComparedFace)
- newCelebrity :: Celebrity
- data CelebrityDetail = CelebrityDetail' (Maybe BoundingBox) (Maybe [Text]) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe FaceDetail)
- newCelebrityDetail :: CelebrityDetail
- data CelebrityRecognition = CelebrityRecognition' (Maybe CelebrityDetail) (Maybe Integer)
- newCelebrityRecognition :: CelebrityRecognition
- data CompareFacesMatch = CompareFacesMatch' (Maybe Double) (Maybe ComparedFace)
- newCompareFacesMatch :: CompareFacesMatch
- data ComparedFace = ComparedFace' (Maybe BoundingBox) (Maybe [Emotion]) (Maybe Pose) (Maybe Double) (Maybe ImageQuality) (Maybe Smile) (Maybe [Landmark])
- newComparedFace :: ComparedFace
- data ComparedSourceImageFace = ComparedSourceImageFace' (Maybe BoundingBox) (Maybe Double)
- newComparedSourceImageFace :: ComparedSourceImageFace
- data ContentModerationDetection = ContentModerationDetection' (Maybe ModerationLabel) (Maybe Integer)
- newContentModerationDetection :: ContentModerationDetection
- data CoversBodyPart = CoversBodyPart' (Maybe Bool) (Maybe Double)
- newCoversBodyPart :: CoversBodyPart
- data CustomLabel = CustomLabel' (Maybe Double) (Maybe Text) (Maybe Geometry)
- newCustomLabel :: CustomLabel
- data DetectTextFilters = DetectTextFilters' (Maybe [RegionOfInterest]) (Maybe DetectionFilter)
- newDetectTextFilters :: DetectTextFilters
- data DetectionFilter = DetectionFilter' (Maybe Double) (Maybe Double) (Maybe Double)
- newDetectionFilter :: DetectionFilter
- data Emotion = Emotion' (Maybe Double) (Maybe EmotionName)
- newEmotion :: Emotion
- data EquipmentDetection = EquipmentDetection' (Maybe BoundingBox) (Maybe CoversBodyPart) (Maybe Double) (Maybe ProtectiveEquipmentType)
- newEquipmentDetection :: EquipmentDetection
- data EvaluationResult = EvaluationResult' (Maybe Summary) (Maybe Double)
- newEvaluationResult :: EvaluationResult
- data EyeOpen = EyeOpen' (Maybe Bool) (Maybe Double)
- newEyeOpen :: EyeOpen
- data Eyeglasses = Eyeglasses' (Maybe Bool) (Maybe Double)
- newEyeglasses :: Eyeglasses
- data Face = Face' (Maybe Text) (Maybe BoundingBox) (Maybe Text) (Maybe Double) (Maybe Text)
- newFace :: Face
- data FaceDetail = FaceDetail' (Maybe AgeRange) (Maybe Sunglasses) (Maybe MouthOpen) (Maybe BoundingBox) (Maybe [Emotion]) (Maybe EyeOpen) (Maybe Pose) (Maybe Double) (Maybe Gender) (Maybe ImageQuality) (Maybe Eyeglasses) (Maybe Beard) (Maybe Mustache) (Maybe Smile) (Maybe [Landmark])
- newFaceDetail :: FaceDetail
- data FaceDetection = FaceDetection' (Maybe Integer) (Maybe FaceDetail)
- newFaceDetection :: FaceDetection
- data FaceMatch = FaceMatch' (Maybe Double) (Maybe Face)
- newFaceMatch :: FaceMatch
- data FaceRecord = FaceRecord' (Maybe FaceDetail) (Maybe Face)
- newFaceRecord :: FaceRecord
- data FaceSearchSettings = FaceSearchSettings' (Maybe Double) (Maybe Text)
- newFaceSearchSettings :: FaceSearchSettings
- data Gender = Gender' (Maybe GenderType) (Maybe Double)
- newGender :: Gender
- data Geometry = Geometry' (Maybe BoundingBox) (Maybe [Point])
- newGeometry :: Geometry
- data GroundTruthManifest = GroundTruthManifest' (Maybe S3Object)
- newGroundTruthManifest :: GroundTruthManifest
- data HumanLoopActivationOutput = HumanLoopActivationOutput' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newHumanLoopActivationOutput :: HumanLoopActivationOutput
- data HumanLoopConfig = HumanLoopConfig' (Maybe HumanLoopDataAttributes) Text Text
- newHumanLoopConfig :: Text -> Text -> HumanLoopConfig
- data HumanLoopDataAttributes = HumanLoopDataAttributes' (Maybe [ContentClassifier])
- newHumanLoopDataAttributes :: HumanLoopDataAttributes
- data Image = Image' (Maybe S3Object) (Maybe Base64)
- newImage :: Image
- data ImageQuality = ImageQuality' (Maybe Double) (Maybe Double)
- newImageQuality :: ImageQuality
- data Instance = Instance' (Maybe BoundingBox) (Maybe Double)
- newInstance :: Instance
- data KinesisDataStream = KinesisDataStream' (Maybe Text)
- newKinesisDataStream :: KinesisDataStream
- data KinesisVideoStream = KinesisVideoStream' (Maybe Text)
- newKinesisVideoStream :: KinesisVideoStream
- data KnownGender = KnownGender' (Maybe KnownGenderType)
- newKnownGender :: KnownGender
- data Label = Label' (Maybe Double) (Maybe [Parent]) (Maybe Text) (Maybe [Instance])
- newLabel :: Label
- data LabelDetection = LabelDetection' (Maybe Label) (Maybe Integer)
- newLabelDetection :: LabelDetection
- data Landmark = Landmark' (Maybe LandmarkType) (Maybe Double) (Maybe Double)
- newLandmark :: Landmark
- data ModerationLabel = ModerationLabel' (Maybe Double) (Maybe Text) (Maybe Text)
- newModerationLabel :: ModerationLabel
- data MouthOpen = MouthOpen' (Maybe Bool) (Maybe Double)
- newMouthOpen :: MouthOpen
- data Mustache = Mustache' (Maybe Bool) (Maybe Double)
- newMustache :: Mustache
- data NotificationChannel = NotificationChannel' Text Text
- newNotificationChannel :: Text -> Text -> NotificationChannel
- data OutputConfig = OutputConfig' (Maybe Text) (Maybe Text)
- newOutputConfig :: OutputConfig
- data Parent = Parent' (Maybe Text)
- newParent :: Parent
- data PersonDetail = PersonDetail' (Maybe BoundingBox) (Maybe Integer) (Maybe FaceDetail)
- newPersonDetail :: PersonDetail
- data PersonDetection = PersonDetection' (Maybe PersonDetail) (Maybe Integer)
- newPersonDetection :: PersonDetection
- data PersonMatch = PersonMatch' (Maybe [FaceMatch]) (Maybe PersonDetail) (Maybe Integer)
- newPersonMatch :: PersonMatch
- data Point = Point' (Maybe Double) (Maybe Double)
- newPoint :: Point
- data Pose = Pose' (Maybe Double) (Maybe Double) (Maybe Double)
- newPose :: Pose
- data ProjectDescription = ProjectDescription' (Maybe ProjectStatus) (Maybe POSIX) (Maybe Text)
- newProjectDescription :: ProjectDescription
- data ProjectVersionDescription = ProjectVersionDescription' (Maybe Natural) (Maybe ProjectVersionStatus) (Maybe EvaluationResult) (Maybe GroundTruthManifest) (Maybe Text) (Maybe TestingDataResult) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe OutputConfig) (Maybe Natural) (Maybe POSIX) (Maybe TrainingDataResult)
- newProjectVersionDescription :: ProjectVersionDescription
- data ProtectiveEquipmentBodyPart = ProtectiveEquipmentBodyPart' (Maybe [EquipmentDetection]) (Maybe Double) (Maybe BodyPart)
- newProtectiveEquipmentBodyPart :: ProtectiveEquipmentBodyPart
- data ProtectiveEquipmentPerson = ProtectiveEquipmentPerson' (Maybe [ProtectiveEquipmentBodyPart]) (Maybe BoundingBox) (Maybe Double) (Maybe Natural)
- newProtectiveEquipmentPerson :: ProtectiveEquipmentPerson
- data ProtectiveEquipmentSummarizationAttributes = ProtectiveEquipmentSummarizationAttributes' Double [ProtectiveEquipmentType]
- newProtectiveEquipmentSummarizationAttributes :: Double -> ProtectiveEquipmentSummarizationAttributes
- data ProtectiveEquipmentSummary = ProtectiveEquipmentSummary' (Maybe [Natural]) (Maybe [Natural]) (Maybe [Natural])
- newProtectiveEquipmentSummary :: ProtectiveEquipmentSummary
- data RegionOfInterest = RegionOfInterest' (Maybe BoundingBox)
- newRegionOfInterest :: RegionOfInterest
- data S3Object = S3Object' (Maybe Text) (Maybe Text) (Maybe Text)
- newS3Object :: S3Object
- data SegmentDetection = SegmentDetection' (Maybe TechnicalCueSegment) (Maybe Natural) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Integer) (Maybe SegmentType) (Maybe ShotSegment) (Maybe Natural)
- newSegmentDetection :: SegmentDetection
- data SegmentTypeInfo = SegmentTypeInfo' (Maybe Text) (Maybe SegmentType)
- newSegmentTypeInfo :: SegmentTypeInfo
- data ShotSegment = ShotSegment' (Maybe Double) (Maybe Natural)
- newShotSegment :: ShotSegment
- data Smile = Smile' (Maybe Bool) (Maybe Double)
- newSmile :: Smile
- data StartSegmentDetectionFilters = StartSegmentDetectionFilters' (Maybe StartTechnicalCueDetectionFilter) (Maybe StartShotDetectionFilter)
- newStartSegmentDetectionFilters :: StartSegmentDetectionFilters
- data StartShotDetectionFilter = StartShotDetectionFilter' (Maybe Double)
- newStartShotDetectionFilter :: StartShotDetectionFilter
- data StartTechnicalCueDetectionFilter = StartTechnicalCueDetectionFilter' (Maybe BlackFrame) (Maybe Double)
- newStartTechnicalCueDetectionFilter :: StartTechnicalCueDetectionFilter
- data StartTextDetectionFilters = StartTextDetectionFilters' (Maybe [RegionOfInterest]) (Maybe DetectionFilter)
- newStartTextDetectionFilters :: StartTextDetectionFilters
- data StreamProcessor = StreamProcessor' (Maybe StreamProcessorStatus) (Maybe Text)
- newStreamProcessor :: StreamProcessor
- data StreamProcessorInput = StreamProcessorInput' (Maybe KinesisVideoStream)
- newStreamProcessorInput :: StreamProcessorInput
- data StreamProcessorOutput = StreamProcessorOutput' (Maybe KinesisDataStream)
- newStreamProcessorOutput :: StreamProcessorOutput
- data StreamProcessorSettings = StreamProcessorSettings' (Maybe FaceSearchSettings)
- newStreamProcessorSettings :: StreamProcessorSettings
- data Summary = Summary' (Maybe S3Object)
- newSummary :: Summary
- data Sunglasses = Sunglasses' (Maybe Bool) (Maybe Double)
- newSunglasses :: Sunglasses
- data TechnicalCueSegment = TechnicalCueSegment' (Maybe Double) (Maybe TechnicalCueType)
- newTechnicalCueSegment :: TechnicalCueSegment
- data TestingData = TestingData' (Maybe [Asset]) (Maybe Bool)
- newTestingData :: TestingData
- data TestingDataResult = TestingDataResult' (Maybe TestingData) (Maybe TestingData) (Maybe ValidationData)
- newTestingDataResult :: TestingDataResult
- data TextDetection = TextDetection' (Maybe Text) (Maybe Double) (Maybe Geometry) (Maybe Natural) (Maybe TextTypes) (Maybe Natural)
- newTextDetection :: TextDetection
- data TextDetectionResult = TextDetectionResult' (Maybe TextDetection) (Maybe Integer)
- newTextDetectionResult :: TextDetectionResult
- data TrainingData = TrainingData' (Maybe [Asset])
- newTrainingData :: TrainingData
- data TrainingDataResult = TrainingDataResult' (Maybe TrainingData) (Maybe TrainingData) (Maybe ValidationData)
- newTrainingDataResult :: TrainingDataResult
- data UnindexedFace = UnindexedFace' (Maybe [Reason]) (Maybe FaceDetail)
- newUnindexedFace :: UnindexedFace
- data ValidationData = ValidationData' (Maybe [Asset])
- newValidationData :: ValidationData
- data Video = Video' (Maybe S3Object)
- newVideo :: Video
- data VideoMetadata = VideoMetadata' (Maybe Double) (Maybe VideoColorRange) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural)
- newVideoMetadata :: VideoMetadata
Service Configuration
defaultService :: Service Source #
API version 2016-06-27 of the Amazon Rekognition SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Rekognition.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized to perform the action.
VideoTooLargeException
_VideoTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
InvalidImageFormatException
_InvalidImageFormatException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The provided image format is not supported.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource with the specified ID already exists.
InvalidS3ObjectException
_InvalidS3ObjectException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Rekognition is unable to access the S3 object specified in the request.
ProvisionedThroughputExceededException
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ImageTooLargeException
_ImageTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Rekognition is temporarily unable to process the request. Try your call again.
InternalServerError
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Rekognition experienced a service issue. Try your call again.
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A ClientRequestToken input parameter was reused with an operation, but
at least one of the other input parameters is different from the
previous call to the operation.
ResourceNotReadyException
_ResourceNotReadyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource isn't ready. For example, this exception occurs
when you call DetectCustomLabels with a model version that isn't
deployed.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request cannot be found.
HumanLoopQuotaExceededException
_HumanLoopQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of in-progress human reviews you have has exceeded the number allowed.
InvalidPaginationTokenException
_InvalidPaginationTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Pagination token in the request is not valid.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Amazon Rekognition service limit was exceeded. For example, if you
start too many Amazon Rekognition Video jobs concurrently, calls to
start operations (StartLabelDetection, for example) will raise a
LimitExceededException exception (HTTP status code: 400) until the
number of concurrently running jobs is below the Amazon Rekognition
service limit.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is already being used.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
ProjectVersionRunning
newProjectVersionRunning :: Wait DescribeProjectVersions Source #
Polls DescribeProjectVersions every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
ProjectVersionTrainingCompleted
newProjectVersionTrainingCompleted :: Wait DescribeProjectVersions Source #
Polls DescribeProjectVersions every 120 seconds until a successful state is reached. An error is returned after 360 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DetectProtectiveEquipment
data DetectProtectiveEquipment Source #
See: newDetectProtectiveEquipment smart constructor.
Instances
newDetectProtectiveEquipment Source #
Create a value of DetectProtectiveEquipment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:summarizationAttributes:DetectProtectiveEquipment', detectProtectiveEquipment_summarizationAttributes - An array of PPE types that you want to summarize.
$sel:image:DetectProtectiveEquipment', detectProtectiveEquipment_image - The image in which you want to detect PPE on detected persons. The image
can be passed as image bytes or you can reference an image stored in an
Amazon S3 bucket.
data DetectProtectiveEquipmentResponse Source #
See: newDetectProtectiveEquipmentResponse smart constructor.
Constructors
| DetectProtectiveEquipmentResponse' (Maybe ProtectiveEquipmentSummary) (Maybe Text) (Maybe [ProtectiveEquipmentPerson]) Int |
Instances
newDetectProtectiveEquipmentResponse Source #
Arguments
| :: Int | |
| -> DetectProtectiveEquipmentResponse |
Create a value of DetectProtectiveEquipmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:summary:DetectProtectiveEquipmentResponse', detectProtectiveEquipmentResponse_summary - Summary information for the types of PPE specified in the
SummarizationAttributes input parameter.
$sel:protectiveEquipmentModelVersion:DetectProtectiveEquipmentResponse', detectProtectiveEquipmentResponse_protectiveEquipmentModelVersion - The version number of the PPE detection model used to detect PPE in the
image.
$sel:persons:DetectProtectiveEquipmentResponse', detectProtectiveEquipmentResponse_persons - An array of persons detected in the image (including persons not wearing
PPE).
$sel:httpStatus:DetectProtectiveEquipmentResponse', detectProtectiveEquipmentResponse_httpStatus - The response's http status code.
DeleteProject
data DeleteProject Source #
See: newDeleteProject smart constructor.
Constructors
| DeleteProject' Text |
Instances
Arguments
| :: Text | |
| -> DeleteProject |
Create a value of DeleteProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectArn:DeleteProject', deleteProject_projectArn - The Amazon Resource Name (ARN) of the project that you want to delete.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse smart constructor.
Constructors
| DeleteProjectResponse' (Maybe ProjectStatus) Int |
Instances
newDeleteProjectResponse Source #
Create a value of DeleteProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DeleteProjectResponse', deleteProjectResponse_status - The current status of the delete project operation.
$sel:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.
StartCelebrityRecognition
data StartCelebrityRecognition Source #
See: newStartCelebrityRecognition smart constructor.
Constructors
| StartCelebrityRecognition' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) Video |
Instances
newStartCelebrityRecognition Source #
Create a value of StartCelebrityRecognition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartCelebrityRecognition', startCelebrityRecognition_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:notificationChannel:StartCelebrityRecognition', startCelebrityRecognition_notificationChannel - The Amazon SNS topic ARN that you want Amazon Rekognition Video to
publish the completion status of the celebrity recognition analysis to.
The Amazon SNS topic must have a topic name that begins with
AmazonRekognition if you are using the AmazonRekognitionServiceRole
permissions policy.
$sel:clientRequestToken:StartCelebrityRecognition', startCelebrityRecognition_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartCelebrityRecognition requests, the same
JobId is returned. Use ClientRequestToken to prevent the same job
from being accidently started more than once.
$sel:video:StartCelebrityRecognition', startCelebrityRecognition_video - The video in which you want to recognize celebrities. The video must be
stored in an Amazon S3 bucket.
data StartCelebrityRecognitionResponse Source #
See: newStartCelebrityRecognitionResponse smart constructor.
Constructors
| StartCelebrityRecognitionResponse' (Maybe Text) Int |
Instances
newStartCelebrityRecognitionResponse Source #
Arguments
| :: Int | |
| -> StartCelebrityRecognitionResponse |
Create a value of StartCelebrityRecognitionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartCelebrityRecognitionResponse', startCelebrityRecognitionResponse_jobId - The identifier for the celebrity recognition analysis job. Use JobId
to identify the job in a subsequent call to GetCelebrityRecognition.
$sel:httpStatus:StartCelebrityRecognitionResponse', startCelebrityRecognitionResponse_httpStatus - The response's http status code.
GetPersonTracking
data GetPersonTracking Source #
See: newGetPersonTracking smart constructor.
Constructors
| GetPersonTracking' (Maybe Text) (Maybe Natural) (Maybe PersonTrackingSortBy) Text |
Instances
Arguments
| :: Text | |
| -> GetPersonTracking |
Create a value of GetPersonTracking with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetPersonTracking', getPersonTracking_nextToken - If the previous response was incomplete (because there are more persons
to retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
persons.
$sel:maxResults:GetPersonTracking', getPersonTracking_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000. If you specify a value greater than 1000,
a maximum of 1000 results is returned. The default value is 1000.
$sel:sortBy:GetPersonTracking', getPersonTracking_sortBy - Sort to use for elements in the Persons array. Use TIMESTAMP to sort
array elements by the time persons are detected. Use INDEX to sort by
the tracked persons. If you sort by INDEX, the array elements for each
person are sorted by detection confidence. The default sort is by
TIMESTAMP.
$sel:jobId:GetPersonTracking', getPersonTracking_jobId - The identifier for a job that tracks persons in a video. You get the
JobId from a call to StartPersonTracking.
data GetPersonTrackingResponse Source #
See: newGetPersonTrackingResponse smart constructor.
Constructors
| GetPersonTrackingResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe VideoJobStatus) (Maybe [PersonDetection]) Int |
Instances
newGetPersonTrackingResponse Source #
Create a value of GetPersonTrackingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetPersonTracking', getPersonTrackingResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of persons.
$sel:videoMetadata:GetPersonTrackingResponse', getPersonTrackingResponse_videoMetadata - Information about a video that Amazon Rekognition Video analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition Video operation.
$sel:statusMessage:GetPersonTrackingResponse', getPersonTrackingResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:jobStatus:GetPersonTrackingResponse', getPersonTrackingResponse_jobStatus - The current status of the person tracking job.
$sel:persons:GetPersonTrackingResponse', getPersonTrackingResponse_persons - An array of the persons detected in the video and the time(s) their path
was tracked throughout the video. An array element will exist for each
time a person's path is tracked.
$sel:httpStatus:GetPersonTrackingResponse', getPersonTrackingResponse_httpStatus - The response's http status code.
GetTextDetection
data GetTextDetection Source #
See: newGetTextDetection smart constructor.
Instances
Arguments
| :: Text | |
| -> GetTextDetection |
Create a value of GetTextDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetTextDetection', getTextDetection_nextToken - If the previous response was incomplete (because there are more labels
to retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
text.
$sel:maxResults:GetTextDetection', getTextDetection_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000.
$sel:jobId:GetTextDetection', getTextDetection_jobId - Job identifier for the text detection operation for which you want
results returned. You get the job identifer from an initial call to
StartTextDetection.
data GetTextDetectionResponse Source #
See: newGetTextDetectionResponse smart constructor.
Constructors
| GetTextDetectionResponse' (Maybe [TextDetectionResult]) (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe Text) (Maybe VideoJobStatus) Int |
Instances
newGetTextDetectionResponse Source #
Create a value of GetTextDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textDetections:GetTextDetectionResponse', getTextDetectionResponse_textDetections - An array of text detected in the video. Each element contains the
detected text, the time in milliseconds from the start of the video that
the text was detected, and where it was detected on the screen.
$sel:nextToken:GetTextDetection', getTextDetectionResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of text.
$sel:videoMetadata:GetTextDetectionResponse', getTextDetectionResponse_videoMetadata - Undocumented member.
$sel:statusMessage:GetTextDetectionResponse', getTextDetectionResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:textModelVersion:GetTextDetectionResponse', getTextDetectionResponse_textModelVersion - Version number of the text detection model that was used to detect text.
$sel:jobStatus:GetTextDetectionResponse', getTextDetectionResponse_jobStatus - Current status of the text detection job.
$sel:httpStatus:GetTextDetectionResponse', getTextDetectionResponse_httpStatus - The response's http status code.
StartSegmentDetection
data StartSegmentDetection Source #
See: newStartSegmentDetection smart constructor.
Constructors
| StartSegmentDetection' (Maybe Text) (Maybe StartSegmentDetectionFilters) (Maybe NotificationChannel) (Maybe Text) Video (NonEmpty SegmentType) |
Instances
newStartSegmentDetection Source #
Arguments
| :: Video | |
| -> NonEmpty SegmentType | |
| -> StartSegmentDetection |
Create a value of StartSegmentDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartSegmentDetection', startSegmentDetection_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:filters:StartSegmentDetection', startSegmentDetection_filters - Filters for technical cue or shot detection.
$sel:notificationChannel:StartSegmentDetection', startSegmentDetection_notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition
Video to publish the completion status of the segment detection
operation. Note that the Amazon SNS topic must have a topic name that
begins with AmazonRekognition if you are using the
AmazonRekognitionServiceRole permissions policy to access the topic.
$sel:clientRequestToken:StartSegmentDetection', startSegmentDetection_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartSegmentDetection requests, the same JobId
is returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:video:StartSegmentDetection', startSegmentDetection_video - Undocumented member.
$sel:segmentTypes:StartSegmentDetection', startSegmentDetection_segmentTypes - An array of segment types to detect in the video. Valid values are
TECHNICAL_CUE and SHOT.
data StartSegmentDetectionResponse Source #
See: newStartSegmentDetectionResponse smart constructor.
Constructors
| StartSegmentDetectionResponse' (Maybe Text) Int |
Instances
newStartSegmentDetectionResponse Source #
Create a value of StartSegmentDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartSegmentDetectionResponse', startSegmentDetectionResponse_jobId - Unique identifier for the segment detection job. The JobId is returned
from StartSegmentDetection.
$sel:httpStatus:StartSegmentDetectionResponse', startSegmentDetectionResponse_httpStatus - The response's http status code.
ListCollections (Paginated)
data ListCollections Source #
See: newListCollections smart constructor.
Constructors
| ListCollections' (Maybe Text) (Maybe Natural) |
Instances
newListCollections :: ListCollections Source #
Create a value of ListCollections with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListCollections', listCollections_nextToken - Pagination token from the previous response.
$sel:maxResults:ListCollections', listCollections_maxResults - Maximum number of collection IDs to return.
data ListCollectionsResponse Source #
See: newListCollectionsResponse smart constructor.
Instances
newListCollectionsResponse Source #
Create a value of ListCollectionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionIds:ListCollectionsResponse', listCollectionsResponse_collectionIds - An array of collection IDs.
$sel:nextToken:ListCollections', listCollectionsResponse_nextToken - If the result is truncated, the response provides a NextToken that you
can use in the subsequent request to fetch the next set of collection
IDs.
$sel:faceModelVersions:ListCollectionsResponse', listCollectionsResponse_faceModelVersions - Version numbers of the face detection models associated with the
collections in the array CollectionIds. For example, the value of
FaceModelVersions[2] is the version number for the face detection
model used by the collection in CollectionId[2].
$sel:httpStatus:ListCollectionsResponse', listCollectionsResponse_httpStatus - The response's http status code.
StartProjectVersion
data StartProjectVersion Source #
See: newStartProjectVersion smart constructor.
Constructors
| StartProjectVersion' Text Natural |
Instances
newStartProjectVersion Source #
Arguments
| :: Text | |
| -> Natural | |
| -> StartProjectVersion |
Create a value of StartProjectVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectVersionArn:StartProjectVersion', startProjectVersion_projectVersionArn - The Amazon Resource Name(ARN) of the model version that you want to
start.
$sel:minInferenceUnits:StartProjectVersion', startProjectVersion_minInferenceUnits - The minimum number of inference units to use. A single inference unit
represents 1 hour of processing and can support up to 5 Transaction Pers
Second (TPS). Use a higher number to increase the TPS throughput of your
model. You are charged for the number of inference units that you use.
data StartProjectVersionResponse Source #
See: newStartProjectVersionResponse smart constructor.
Constructors
| StartProjectVersionResponse' (Maybe ProjectVersionStatus) Int |
Instances
newStartProjectVersionResponse Source #
Create a value of StartProjectVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:StartProjectVersionResponse', startProjectVersionResponse_status - The current running status of the model.
$sel:httpStatus:StartProjectVersionResponse', startProjectVersionResponse_httpStatus - The response's http status code.
DeleteCollection
data DeleteCollection Source #
See: newDeleteCollection smart constructor.
Constructors
| DeleteCollection' Text |
Instances
Arguments
| :: Text | |
| -> DeleteCollection |
Create a value of DeleteCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionId:DeleteCollection', deleteCollection_collectionId - ID of the collection to delete.
data DeleteCollectionResponse Source #
See: newDeleteCollectionResponse smart constructor.
Constructors
| DeleteCollectionResponse' (Maybe Natural) Int |
Instances
newDeleteCollectionResponse Source #
Create a value of DeleteCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:statusCode:DeleteCollectionResponse', deleteCollectionResponse_statusCode - HTTP status code that indicates the result of the operation.
$sel:httpStatus:DeleteCollectionResponse', deleteCollectionResponse_httpStatus - The response's http status code.
CreateCollection
data CreateCollection Source #
See: newCreateCollection smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateCollection |
Create a value of CreateCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateCollection', createCollection_tags - A set of tags (key-value pairs) that you want to attach to the
collection.
$sel:collectionId:CreateCollection', createCollection_collectionId - ID for the collection that you are creating.
data CreateCollectionResponse Source #
See: newCreateCollectionResponse smart constructor.
Instances
newCreateCollectionResponse Source #
Create a value of CreateCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceModelVersion:CreateCollectionResponse', createCollectionResponse_faceModelVersion - Version number of the face detection model associated with the
collection you are creating.
$sel:collectionArn:CreateCollectionResponse', createCollectionResponse_collectionArn - Amazon Resource Name (ARN) of the collection. You can use this to manage
permissions on your resources.
$sel:statusCode:CreateCollectionResponse', createCollectionResponse_statusCode - HTTP status code indicating the result of the operation.
$sel:httpStatus:CreateCollectionResponse', createCollectionResponse_httpStatus - The response's http status code.
StopStreamProcessor
data StopStreamProcessor Source #
See: newStopStreamProcessor smart constructor.
Constructors
| StopStreamProcessor' Text |
Instances
newStopStreamProcessor Source #
Arguments
| :: Text | |
| -> StopStreamProcessor |
Create a value of StopStreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:StopStreamProcessor', stopStreamProcessor_name - The name of a stream processor created by CreateStreamProcessor.
data StopStreamProcessorResponse Source #
See: newStopStreamProcessorResponse smart constructor.
Constructors
| StopStreamProcessorResponse' Int |
Instances
newStopStreamProcessorResponse Source #
Create a value of StopStreamProcessorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopStreamProcessorResponse', stopStreamProcessorResponse_httpStatus - The response's http status code.
DetectLabels
data DetectLabels Source #
See: newDetectLabels smart constructor.
Instances
Arguments
| :: Image | |
| -> DetectLabels |
Create a value of DetectLabels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minConfidence:DetectLabels', detectLabels_minConfidence - Specifies the minimum confidence level for the labels to return. Amazon
Rekognition doesn't return any labels with confidence lower than this
specified value.
If MinConfidence is not specified, the operation returns labels with a
confidence values greater than or equal to 55 percent.
$sel:maxLabels:DetectLabels', detectLabels_maxLabels - Maximum number of labels you want the service to return in the response.
The service returns the specified number of highest confidence labels.
$sel:image:DetectLabels', detectLabels_image - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing image bytes is
not supported. Images stored in an S3 Bucket do not need to be
base64-encoded.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data DetectLabelsResponse Source #
See: newDetectLabelsResponse smart constructor.
Constructors
| DetectLabelsResponse' (Maybe [Label]) (Maybe OrientationCorrection) (Maybe Text) Int |
Instances
newDetectLabelsResponse Source #
Arguments
| :: Int | |
| -> DetectLabelsResponse |
Create a value of DetectLabelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labels:DetectLabelsResponse', detectLabelsResponse_labels - An array of labels for the real-world objects detected.
$sel:orientationCorrection:DetectLabelsResponse', detectLabelsResponse_orientationCorrection - The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
$sel:labelModelVersion:DetectLabelsResponse', detectLabelsResponse_labelModelVersion - Version number of the label detection model that was used to detect
labels.
$sel:httpStatus:DetectLabelsResponse', detectLabelsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - Amazon Resource Name (ARN) of the model, collection, or stream processor
that contains the tags that you want a list of.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A list of key-value tags assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
StartContentModeration
data StartContentModeration Source #
See: newStartContentModeration smart constructor.
Constructors
| StartContentModeration' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe Double) Video |
Instances
newStartContentModeration Source #
Create a value of StartContentModeration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartContentModeration', startContentModeration_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:notificationChannel:StartContentModeration', startContentModeration_notificationChannel - The Amazon SNS topic ARN that you want Amazon Rekognition Video to
publish the completion status of the content analysis to. The Amazon SNS
topic must have a topic name that begins with AmazonRekognition if you
are using the AmazonRekognitionServiceRole permissions policy to access
the topic.
$sel:clientRequestToken:StartContentModeration', startContentModeration_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartContentModeration requests, the same JobId
is returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:minConfidence:StartContentModeration', startContentModeration_minConfidence - Specifies the minimum confidence that Amazon Rekognition must have in
order to return a moderated content label. Confidence represents how
certain Amazon Rekognition is that the moderated content is correctly
identified. 0 is the lowest confidence. 100 is the highest confidence.
Amazon Rekognition doesn't return any moderated content labels with a
confidence level lower than this specified value. If you don't specify
MinConfidence, GetContentModeration returns labels with confidence
values greater than or equal to 50 percent.
$sel:video:StartContentModeration', startContentModeration_video - The video in which you want to detect inappropriate, unwanted, or
offensive content. The video must be stored in an Amazon S3 bucket.
data StartContentModerationResponse Source #
See: newStartContentModerationResponse smart constructor.
Constructors
| StartContentModerationResponse' (Maybe Text) Int |
Instances
newStartContentModerationResponse Source #
Create a value of StartContentModerationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartContentModerationResponse', startContentModerationResponse_jobId - The identifier for the content analysis job. Use JobId to identify the
job in a subsequent call to GetContentModeration.
$sel:httpStatus:StartContentModerationResponse', startContentModerationResponse_httpStatus - The response's http status code.
SearchFacesByImage
data SearchFacesByImage Source #
See: newSearchFacesByImage smart constructor.
Constructors
| SearchFacesByImage' (Maybe QualityFilter) (Maybe Double) (Maybe Natural) Text Image |
Instances
newSearchFacesByImage Source #
Arguments
| :: Text | |
| -> Image | |
| -> SearchFacesByImage |
Create a value of SearchFacesByImage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:qualityFilter:SearchFacesByImage', searchFacesByImage_qualityFilter - A filter that specifies a quality bar for how much filtering is done to
identify faces. Filtered faces aren't searched for in the collection.
If you specify AUTO, Amazon Rekognition chooses the quality bar. If
you specify LOW, MEDIUM, or HIGH, filtering removes all faces that
don’t meet the chosen quality bar. The quality bar is based on a variety
of common use cases. Low-quality detections can occur for a number of
reasons. Some examples are an object that's misidentified as a face, a
face that's too blurry, or a face with a pose that's too extreme to
use. If you specify NONE, no filtering is performed. The default value
is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
$sel:faceMatchThreshold:SearchFacesByImage', searchFacesByImage_faceMatchThreshold - (Optional) Specifies the minimum confidence in the face match to return.
For example, don't return any matches where confidence in matches is
less than 70%. The default value is 80%.
$sel:maxFaces:SearchFacesByImage', searchFacesByImage_maxFaces - Maximum number of faces to return. The operation returns the maximum
number of faces with the highest confidence in the match.
$sel:collectionId:SearchFacesByImage', searchFacesByImage_collectionId - ID of the collection to search.
$sel:image:SearchFacesByImage', searchFacesByImage_image - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data SearchFacesByImageResponse Source #
See: newSearchFacesByImageResponse smart constructor.
Constructors
| SearchFacesByImageResponse' (Maybe [FaceMatch]) (Maybe Text) (Maybe BoundingBox) (Maybe Double) Int |
Instances
newSearchFacesByImageResponse Source #
Create a value of SearchFacesByImageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatches:SearchFacesByImageResponse', searchFacesByImageResponse_faceMatches - An array of faces that match the input face, along with the confidence
in the match.
$sel:faceModelVersion:SearchFacesByImageResponse', searchFacesByImageResponse_faceModelVersion - Version number of the face detection model associated with the input
collection (CollectionId).
$sel:searchedFaceBoundingBox:SearchFacesByImageResponse', searchFacesByImageResponse_searchedFaceBoundingBox - The bounding box around the face in the input image that Amazon
Rekognition used for the search.
$sel:searchedFaceConfidence:SearchFacesByImageResponse', searchFacesByImageResponse_searchedFaceConfidence - The level of confidence that the searchedFaceBoundingBox, contains a
face.
$sel:httpStatus:SearchFacesByImageResponse', searchFacesByImageResponse_httpStatus - The response's http status code.
ListStreamProcessors (Paginated)
data ListStreamProcessors Source #
See: newListStreamProcessors smart constructor.
Constructors
| ListStreamProcessors' (Maybe Text) (Maybe Natural) |
Instances
newListStreamProcessors :: ListStreamProcessors Source #
Create a value of ListStreamProcessors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListStreamProcessors', listStreamProcessors_nextToken - If the previous response was incomplete (because there are more stream
processors to retrieve), Amazon Rekognition Video returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of stream processors.
$sel:maxResults:ListStreamProcessors', listStreamProcessors_maxResults - Maximum number of stream processors you want Amazon Rekognition Video to
return in the response. The default is 1000.
data ListStreamProcessorsResponse Source #
See: newListStreamProcessorsResponse smart constructor.
Constructors
| ListStreamProcessorsResponse' (Maybe [StreamProcessor]) (Maybe Text) Int |
Instances
newListStreamProcessorsResponse Source #
Create a value of ListStreamProcessorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamProcessors:ListStreamProcessorsResponse', listStreamProcessorsResponse_streamProcessors - List of stream processors that you have created.
$sel:nextToken:ListStreamProcessors', listStreamProcessorsResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of stream processors.
$sel:httpStatus:ListStreamProcessorsResponse', listStreamProcessorsResponse_httpStatus - The response's http status code.
DescribeCollection
data DescribeCollection Source #
See: newDescribeCollection smart constructor.
Constructors
| DescribeCollection' Text |
Instances
newDescribeCollection Source #
Arguments
| :: Text | |
| -> DescribeCollection |
Create a value of DescribeCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionId:DescribeCollection', describeCollection_collectionId - The ID of the collection to describe.
data DescribeCollectionResponse Source #
See: newDescribeCollectionResponse smart constructor.
Instances
newDescribeCollectionResponse Source #
Create a value of DescribeCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceModelVersion:DescribeCollectionResponse', describeCollectionResponse_faceModelVersion - The version of the face model that's used by the collection for face
detection.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
$sel:faceCount:DescribeCollectionResponse', describeCollectionResponse_faceCount - The number of faces that are indexed into the collection. To index faces
into a collection, use IndexFaces.
$sel:creationTimestamp:DescribeCollectionResponse', describeCollectionResponse_creationTimestamp - The number of milliseconds since the Unix epoch time until the creation
of the collection. The Unix epoch time is 00:00:00 Coordinated Universal
Time (UTC), Thursday, 1 January 1970.
$sel:collectionARN:DescribeCollectionResponse', describeCollectionResponse_collectionARN - The Amazon Resource Name (ARN) of the collection.
$sel:httpStatus:DescribeCollectionResponse', describeCollectionResponse_httpStatus - The response's http status code.
DeleteProjectVersion
data DeleteProjectVersion Source #
See: newDeleteProjectVersion smart constructor.
Constructors
| DeleteProjectVersion' Text |
Instances
newDeleteProjectVersion Source #
Create a value of DeleteProjectVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectVersionArn:DeleteProjectVersion', deleteProjectVersion_projectVersionArn - The Amazon Resource Name (ARN) of the model version that you want to
delete.
data DeleteProjectVersionResponse Source #
See: newDeleteProjectVersionResponse smart constructor.
Constructors
| DeleteProjectVersionResponse' (Maybe ProjectVersionStatus) Int |
Instances
newDeleteProjectVersionResponse Source #
Create a value of DeleteProjectVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DeleteProjectVersionResponse', deleteProjectVersionResponse_status - The status of the deletion operation.
$sel:httpStatus:DeleteProjectVersionResponse', deleteProjectVersionResponse_httpStatus - The response's http status code.
DescribeProjectVersions (Paginated)
data DescribeProjectVersions Source #
See: newDescribeProjectVersions smart constructor.
Instances
newDescribeProjectVersions Source #
Create a value of DescribeProjectVersions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeProjectVersions', describeProjectVersions_nextToken - If the previous response was incomplete (because there is more results
to retrieve), Amazon Rekognition Custom Labels returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of results.
$sel:versionNames:DescribeProjectVersions', describeProjectVersions_versionNames - A list of model version names that you want to describe. You can add up
to 10 model version names to the list. If you don't specify a value,
all model descriptions are returned. A version name is part of a model
(ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the
version name in the following ARN.
arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.
$sel:maxResults:DescribeProjectVersions', describeProjectVersions_maxResults - The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
$sel:projectArn:DescribeProjectVersions', describeProjectVersions_projectArn - The Amazon Resource Name (ARN) of the project that contains the models
you want to describe.
data DescribeProjectVersionsResponse Source #
See: newDescribeProjectVersionsResponse smart constructor.
Constructors
| DescribeProjectVersionsResponse' (Maybe Text) (Maybe [ProjectVersionDescription]) Int |
Instances
newDescribeProjectVersionsResponse Source #
Create a value of DescribeProjectVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeProjectVersions', describeProjectVersionsResponse_nextToken - If the previous response was incomplete (because there is more results
to retrieve), Amazon Rekognition Custom Labels returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of results.
$sel:projectVersionDescriptions:DescribeProjectVersionsResponse', describeProjectVersionsResponse_projectVersionDescriptions - A list of model descriptions. The list is sorted by the creation date
and time of the model versions, latest to earliest.
$sel:httpStatus:DescribeProjectVersionsResponse', describeProjectVersionsResponse_httpStatus - The response's http status code.
RecognizeCelebrities
data RecognizeCelebrities Source #
See: newRecognizeCelebrities smart constructor.
Constructors
| RecognizeCelebrities' Image |
Instances
newRecognizeCelebrities Source #
Arguments
| :: Image | |
| -> RecognizeCelebrities |
Create a value of RecognizeCelebrities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:image:RecognizeCelebrities', recognizeCelebrities_image - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data RecognizeCelebritiesResponse Source #
See: newRecognizeCelebritiesResponse smart constructor.
Constructors
| RecognizeCelebritiesResponse' (Maybe [Celebrity]) (Maybe OrientationCorrection) (Maybe [ComparedFace]) Int |
Instances
newRecognizeCelebritiesResponse Source #
Create a value of RecognizeCelebritiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:celebrityFaces:RecognizeCelebritiesResponse', recognizeCelebritiesResponse_celebrityFaces - Details about each celebrity found in the image. Amazon Rekognition can
detect a maximum of 64 celebrities in an image. Each celebrity object
includes the following attributes: Face, Confidence, Emotions,
Landmarks, Pose, Quality, Smile, Id, KnownGender,
MatchConfidence, Name, Urls.
$sel:orientationCorrection:RecognizeCelebritiesResponse', recognizeCelebritiesResponse_orientationCorrection - Support for estimating image orientation using the the
OrientationCorrection field has ceased as of August 2021. Any returned
values for this field included in an API response will always be NULL.
The orientation of the input image (counterclockwise direction). If your
application displays the image, you can use this value to correct the
orientation. The bounding box coordinates returned in CelebrityFaces
and UnrecognizedFaces represent face locations before the image
orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable
image (Exif) metadata that includes the image's orientation. If so, and
the Exif metadata for the input image populates the orientation field,
the value of OrientationCorrection is null. The CelebrityFaces and
UnrecognizedFaces bounding box coordinates represent face locations
after Exif metadata is used to correct the image orientation. Images in
.png format don't contain Exif metadata.
$sel:unrecognizedFaces:RecognizeCelebritiesResponse', recognizeCelebritiesResponse_unrecognizedFaces - Details about each unrecognized face in the image.
$sel:httpStatus:RecognizeCelebritiesResponse', recognizeCelebritiesResponse_httpStatus - The response's http status code.
DetectCustomLabels
data DetectCustomLabels Source #
See: newDetectCustomLabels smart constructor.
Instances
newDetectCustomLabels Source #
Arguments
| :: Text | |
| -> Image | |
| -> DetectCustomLabels |
Create a value of DetectCustomLabels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minConfidence:DetectCustomLabels', detectCustomLabels_minConfidence - Specifies the minimum confidence level for the labels to return.
DetectCustomLabels doesn't return any labels with a confidence value
that's lower than this specified value. If you specify a value of 0,
DetectCustomLabels returns all labels, regardless of the assumed
threshold applied to each label. If you don't specify a value for
MinConfidence, DetectCustomLabels returns labels based on the
assumed threshold of each label.
$sel:maxResults:DetectCustomLabels', detectCustomLabels_maxResults - Maximum number of results you want the service to return in the
response. The service returns the specified number of highest confidence
labels ranked from highest confidence to lowest.
$sel:projectVersionArn:DetectCustomLabels', detectCustomLabels_projectVersionArn - The ARN of the model version that you want to use.
$sel:image:DetectCustomLabels', detectCustomLabels_image - Undocumented member.
data DetectCustomLabelsResponse Source #
See: newDetectCustomLabelsResponse smart constructor.
Constructors
| DetectCustomLabelsResponse' (Maybe [CustomLabel]) Int |
Instances
newDetectCustomLabelsResponse Source #
Create a value of DetectCustomLabelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customLabels:DetectCustomLabelsResponse', detectCustomLabelsResponse_customLabels - An array of custom labels detected in the input image.
$sel:httpStatus:DetectCustomLabelsResponse', detectCustomLabelsResponse_httpStatus - The response's http status code.
GetFaceSearch
data GetFaceSearch Source #
See: newGetFaceSearch smart constructor.
Constructors
| GetFaceSearch' (Maybe Text) (Maybe Natural) (Maybe FaceSearchSortBy) Text |
Instances
Arguments
| :: Text | |
| -> GetFaceSearch |
Create a value of GetFaceSearch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetFaceSearch', getFaceSearch_nextToken - If the previous response was incomplete (because there is more search
results to retrieve), Amazon Rekognition Video returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of search results.
$sel:maxResults:GetFaceSearch', getFaceSearch_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000. If you specify a value greater than 1000,
a maximum of 1000 results is returned. The default value is 1000.
$sel:sortBy:GetFaceSearch', getFaceSearch_sortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group
faces by the time that they are recognized. Use INDEX to sort by
recognized faces.
$sel:jobId:GetFaceSearch', getFaceSearch_jobId - The job identifer for the search request. You get the job identifier
from an initial call to StartFaceSearch.
data GetFaceSearchResponse Source #
See: newGetFaceSearchResponse smart constructor.
Constructors
| GetFaceSearchResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe VideoJobStatus) (Maybe [PersonMatch]) Int |
Instances
newGetFaceSearchResponse Source #
Create a value of GetFaceSearchResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetFaceSearch', getFaceSearchResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of search results.
$sel:videoMetadata:GetFaceSearchResponse', getFaceSearchResponse_videoMetadata - Information about a video that Amazon Rekognition analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition Video operation.
$sel:statusMessage:GetFaceSearchResponse', getFaceSearchResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:jobStatus:GetFaceSearchResponse', getFaceSearchResponse_jobStatus - The current status of the face search job.
$sel:persons:GetFaceSearchResponse', getFaceSearchResponse_persons - An array of persons, PersonMatch, in the video whose face(s) match the
face(s) in an Amazon Rekognition collection. It also includes time
information for when persons are matched in the video. You specify the
input collection in an initial call to StartFaceSearch. Each Persons
element includes a time the person was matched, face match details
(FaceMatches) for matching faces in the collection, and person
information (Person) for the matched person.
$sel:httpStatus:GetFaceSearchResponse', getFaceSearchResponse_httpStatus - The response's http status code.
StartLabelDetection
data StartLabelDetection Source #
See: newStartLabelDetection smart constructor.
Constructors
| StartLabelDetection' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe Double) Video |
Instances
newStartLabelDetection Source #
Arguments
| :: Video | |
| -> StartLabelDetection |
Create a value of StartLabelDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartLabelDetection', startLabelDetection_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:notificationChannel:StartLabelDetection', startLabelDetection_notificationChannel - The Amazon SNS topic ARN you want Amazon Rekognition Video to publish
the completion status of the label detection operation to. The Amazon
SNS topic must have a topic name that begins with AmazonRekognition if
you are using the AmazonRekognitionServiceRole permissions policy.
$sel:clientRequestToken:StartLabelDetection', startLabelDetection_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartLabelDetection requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:minConfidence:StartLabelDetection', startLabelDetection_minConfidence - Specifies the minimum confidence that Amazon Rekognition Video must have
in order to return a detected label. Confidence represents how certain
Amazon Rekognition is that a label is correctly identified.0 is the
lowest confidence. 100 is the highest confidence. Amazon Rekognition
Video doesn't return any labels with a confidence level lower than this
specified value.
If you don't specify MinConfidence, the operation returns labels with
confidence values greater than or equal to 50 percent.
$sel:video:StartLabelDetection', startLabelDetection_video - The video in which you want to detect labels. The video must be stored
in an Amazon S3 bucket.
data StartLabelDetectionResponse Source #
See: newStartLabelDetectionResponse smart constructor.
Constructors
| StartLabelDetectionResponse' (Maybe Text) Int |
Instances
newStartLabelDetectionResponse Source #
Create a value of StartLabelDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartLabelDetectionResponse', startLabelDetectionResponse_jobId - The identifier for the label detection job. Use JobId to identify the
job in a subsequent call to GetLabelDetection.
$sel:httpStatus:StartLabelDetectionResponse', startLabelDetectionResponse_httpStatus - The response's http status code.
SearchFaces
data SearchFaces Source #
See: newSearchFaces smart constructor.
Instances
Create a value of SearchFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatchThreshold:SearchFaces', searchFaces_faceMatchThreshold - Optional value specifying the minimum confidence in the face match to
return. For example, don't return any matches where confidence in
matches is less than 70%. The default value is 80%.
$sel:maxFaces:SearchFaces', searchFaces_maxFaces - Maximum number of faces to return. The operation returns the maximum
number of faces with the highest confidence in the match.
$sel:collectionId:SearchFaces', searchFaces_collectionId - ID of the collection the face belongs to.
$sel:faceId:SearchFaces', searchFaces_faceId - ID of a face to find matches for in the collection.
data SearchFacesResponse Source #
See: newSearchFacesResponse smart constructor.
Instances
newSearchFacesResponse Source #
Arguments
| :: Int | |
| -> SearchFacesResponse |
Create a value of SearchFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatches:SearchFacesResponse', searchFacesResponse_faceMatches - An array of faces that matched the input face, along with the confidence
in the match.
$sel:faceModelVersion:SearchFacesResponse', searchFacesResponse_faceModelVersion - Version number of the face detection model associated with the input
collection (CollectionId).
$sel:searchedFaceId:SearchFacesResponse', searchFacesResponse_searchedFaceId - ID of the face that was searched for matches in a collection.
$sel:httpStatus:SearchFacesResponse', searchFacesResponse_httpStatus - The response's http status code.
IndexFaces
data IndexFaces Source #
See: newIndexFaces smart constructor.
Constructors
| IndexFaces' (Maybe Text) (Maybe QualityFilter) (Maybe Natural) (Maybe [Attribute]) Text Image |
Instances
Arguments
| :: Text | |
| -> Image | |
| -> IndexFaces |
Create a value of IndexFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalImageId:IndexFaces', indexFaces_externalImageId - The ID you want to assign to all the faces detected in the image.
$sel:qualityFilter:IndexFaces', indexFaces_qualityFilter - A filter that specifies a quality bar for how much filtering is done to
identify faces. Filtered faces aren't indexed. If you specify AUTO,
Amazon Rekognition chooses the quality bar. If you specify LOW,
MEDIUM, or HIGH, filtering removes all faces that don’t meet the
chosen quality bar. The default value is AUTO. The quality bar is
based on a variety of common use cases. Low-quality detections can occur
for a number of reasons. Some examples are an object that's
misidentified as a face, a face that's too blurry, or a face with a
pose that's too extreme to use. If you specify NONE, no filtering is
performed.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
$sel:maxFaces:IndexFaces', indexFaces_maxFaces - The maximum number of faces to index. The value of MaxFaces must be
greater than or equal to 1. IndexFaces returns no more than 100
detected faces in an image, even if you specify a larger value for
MaxFaces.
If IndexFaces detects more faces than the value of MaxFaces, the
faces with the lowest quality are filtered out first. If there are still
more faces than the value of MaxFaces, the faces with the smallest
bounding boxes are filtered out (up to the number that's needed to
satisfy the value of MaxFaces). Information about the unindexed faces
is available in the UnindexedFaces array.
The faces that are returned by IndexFaces are sorted by the largest
face bounding box size to the smallest size, in descending order.
MaxFaces can be used with a collection associated with any version of
the face model.
$sel:detectionAttributes:IndexFaces', indexFaces_detectionAttributes - An array of facial attributes that you want to be returned. This can be
the default list of attributes or all attributes. If you don't specify
a value for Attributes or if you specify ["DEFAULT"], the API
returns the following subset of facial attributes: BoundingBox,
Confidence, Pose, Quality, and Landmarks. If you provide
["ALL"], all facial attributes are returned, but the operation takes
longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a
logical AND operator to determine which attributes to return (in this
case, all attributes).
$sel:collectionId:IndexFaces', indexFaces_collectionId - The ID of an existing collection to which you want to add the faces that
are detected in the input images.
$sel:image:IndexFaces', indexFaces_image - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes isn't supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data IndexFacesResponse Source #
See: newIndexFacesResponse smart constructor.
Constructors
| IndexFacesResponse' (Maybe Text) (Maybe [FaceRecord]) (Maybe OrientationCorrection) (Maybe [UnindexedFace]) Int |
Instances
newIndexFacesResponse Source #
Arguments
| :: Int | |
| -> IndexFacesResponse |
Create a value of IndexFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceModelVersion:IndexFacesResponse', indexFacesResponse_faceModelVersion - The version number of the face detection model that's associated with
the input collection (CollectionId).
$sel:faceRecords:IndexFacesResponse', indexFacesResponse_faceRecords - An array of faces detected and added to the collection. For more
information, see Searching Faces in a Collection in the Amazon
Rekognition Developer Guide.
$sel:orientationCorrection:IndexFacesResponse', indexFacesResponse_orientationCorrection - If your collection is associated with a face detection model that's
later than version 3.0, the value of OrientationCorrection is always
null and no orientation information is returned.
If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:
- If the input image is in .jpeg format, it might contain exchangeable
image file format (Exif) metadata that includes the image's
orientation. Amazon Rekognition uses this orientation information to
perform image correction - the bounding box coordinates are
translated to represent object locations after the orientation
information in the Exif metadata is used to correct the image
orientation. Images in .png format don't contain Exif metadata. The
value of
OrientationCorrectionis null. - If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords array. You can
get the version of the face detection model by calling
DescribeCollection.
$sel:unindexedFaces:IndexFacesResponse', indexFacesResponse_unindexedFaces - An array of faces that were detected in the image but weren't indexed.
They weren't indexed because the quality filter identified them as low
quality, or the MaxFaces request parameter filtered them out. To use
the quality filter, you specify the QualityFilter request parameter.
$sel:httpStatus:IndexFacesResponse', indexFacesResponse_httpStatus - The response's http status code.
GetLabelDetection
data GetLabelDetection Source #
See: newGetLabelDetection smart constructor.
Constructors
| GetLabelDetection' (Maybe Text) (Maybe Natural) (Maybe LabelDetectionSortBy) Text |
Instances
Arguments
| :: Text | |
| -> GetLabelDetection |
Create a value of GetLabelDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetLabelDetection', getLabelDetection_nextToken - If the previous response was incomplete (because there are more labels
to retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
labels.
$sel:maxResults:GetLabelDetection', getLabelDetection_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000. If you specify a value greater than 1000,
a maximum of 1000 results is returned. The default value is 1000.
$sel:sortBy:GetLabelDetection', getLabelDetection_sortBy - Sort to use for elements in the Labels array. Use TIMESTAMP to sort
array elements by the time labels are detected. Use NAME to
alphabetically group elements for a label together. Within each label
group, the array element are sorted by detection confidence. The default
sort is by TIMESTAMP.
$sel:jobId:GetLabelDetection', getLabelDetection_jobId - Job identifier for the label detection operation for which you want
results returned. You get the job identifer from an initial call to
StartlabelDetection.
data GetLabelDetectionResponse Source #
See: newGetLabelDetectionResponse smart constructor.
Constructors
| GetLabelDetectionResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe [LabelDetection]) (Maybe VideoJobStatus) (Maybe Text) Int |
Instances
newGetLabelDetectionResponse Source #
Create a value of GetLabelDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetLabelDetection', getLabelDetectionResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of labels.
$sel:videoMetadata:GetLabelDetectionResponse', getLabelDetectionResponse_videoMetadata - Information about a video that Amazon Rekognition Video analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition video operation.
$sel:statusMessage:GetLabelDetectionResponse', getLabelDetectionResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:labels:GetLabelDetectionResponse', getLabelDetectionResponse_labels - An array of labels detected in the video. Each element contains the
detected label and the time, in milliseconds from the start of the
video, that the label was detected.
$sel:jobStatus:GetLabelDetectionResponse', getLabelDetectionResponse_jobStatus - The current status of the label detection job.
$sel:labelModelVersion:GetLabelDetectionResponse', getLabelDetectionResponse_labelModelVersion - Version number of the label detection model that was used to detect
labels.
$sel:httpStatus:GetLabelDetectionResponse', getLabelDetectionResponse_httpStatus - The response's http status code.
StopProjectVersion
data StopProjectVersion Source #
See: newStopProjectVersion smart constructor.
Constructors
| StopProjectVersion' Text |
Instances
newStopProjectVersion Source #
Create a value of StopProjectVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectVersionArn:StopProjectVersion', stopProjectVersion_projectVersionArn - The Amazon Resource Name (ARN) of the model version that you want to
delete.
This operation requires permissions to perform the
rekognition:StopProjectVersion action.
data StopProjectVersionResponse Source #
See: newStopProjectVersionResponse smart constructor.
Constructors
| StopProjectVersionResponse' (Maybe ProjectVersionStatus) Int |
Instances
newStopProjectVersionResponse Source #
Create a value of StopProjectVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:StopProjectVersionResponse', stopProjectVersionResponse_status - The current status of the stop operation.
$sel:httpStatus:StopProjectVersionResponse', stopProjectVersionResponse_httpStatus - The response's http status code.
DescribeStreamProcessor
data DescribeStreamProcessor Source #
See: newDescribeStreamProcessor smart constructor.
Constructors
| DescribeStreamProcessor' Text |
Instances
newDescribeStreamProcessor Source #
Create a value of DescribeStreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:DescribeStreamProcessor', describeStreamProcessor_name - Name of the stream processor for which you want information.
data DescribeStreamProcessorResponse Source #
See: newDescribeStreamProcessorResponse smart constructor.
Constructors
Instances
newDescribeStreamProcessorResponse Source #
Create a value of DescribeStreamProcessorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DescribeStreamProcessorResponse', describeStreamProcessorResponse_status - Current status of the stream processor.
$sel:settings:DescribeStreamProcessorResponse', describeStreamProcessorResponse_settings - Face recognition input parameters that are being used by the stream
processor. Includes the collection to use for face recognition and the
face attributes to detect.
$sel:input:DescribeStreamProcessorResponse', describeStreamProcessorResponse_input - Kinesis video stream that provides the source streaming video.
$sel:output:DescribeStreamProcessorResponse', describeStreamProcessorResponse_output - Kinesis data stream to which Amazon Rekognition Video puts the analysis
results.
$sel:streamProcessorArn:DescribeStreamProcessorResponse', describeStreamProcessorResponse_streamProcessorArn - ARN of the stream processor.
$sel:statusMessage:DescribeStreamProcessorResponse', describeStreamProcessorResponse_statusMessage - Detailed status message about the stream processor.
$sel:name:DescribeStreamProcessor', describeStreamProcessorResponse_name - Name of the stream processor.
$sel:creationTimestamp:DescribeStreamProcessorResponse', describeStreamProcessorResponse_creationTimestamp - Date and time the stream processor was created
$sel:lastUpdateTimestamp:DescribeStreamProcessorResponse', describeStreamProcessorResponse_lastUpdateTimestamp - The time, in Unix format, the stream processor was last updated. For
example, when the stream processor moves from a running state to a
failed state, or when the user starts or stops the stream processor.
$sel:roleArn:DescribeStreamProcessorResponse', describeStreamProcessorResponse_roleArn - ARN of the IAM role that allows access to the stream processor.
$sel:httpStatus:DescribeStreamProcessorResponse', describeStreamProcessorResponse_httpStatus - The response's http status code.
StartFaceSearch
data StartFaceSearch Source #
See: newStartFaceSearch smart constructor.
Constructors
| StartFaceSearch' (Maybe Double) (Maybe Text) (Maybe NotificationChannel) (Maybe Text) Video Text |
Instances
Arguments
| :: Video | |
| -> Text | |
| -> StartFaceSearch |
Create a value of StartFaceSearch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatchThreshold:StartFaceSearch', startFaceSearch_faceMatchThreshold - The minimum confidence in the person match to return. For example,
don't return any matches where confidence in matches is less than 70%.
The default value is 80%.
$sel:jobTag:StartFaceSearch', startFaceSearch_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:notificationChannel:StartFaceSearch', startFaceSearch_notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition
Video to publish the completion status of the search. The Amazon SNS
topic must have a topic name that begins with AmazonRekognition if you
are using the AmazonRekognitionServiceRole permissions policy to access
the topic.
$sel:clientRequestToken:StartFaceSearch', startFaceSearch_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartFaceSearch requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:video:StartFaceSearch', startFaceSearch_video - The video you want to search. The video must be stored in an Amazon S3
bucket.
$sel:collectionId:StartFaceSearch', startFaceSearch_collectionId - ID of the collection that contains the faces you want to search for.
data StartFaceSearchResponse Source #
See: newStartFaceSearchResponse smart constructor.
Constructors
| StartFaceSearchResponse' (Maybe Text) Int |
Instances
newStartFaceSearchResponse Source #
Create a value of StartFaceSearchResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartFaceSearchResponse', startFaceSearchResponse_jobId - The identifier for the search job. Use JobId to identify the job in a
subsequent call to GetFaceSearch.
$sel:httpStatus:StartFaceSearchResponse', startFaceSearchResponse_httpStatus - The response's http status code.
StartTextDetection
data StartTextDetection Source #
See: newStartTextDetection smart constructor.
Constructors
| StartTextDetection' (Maybe Text) (Maybe StartTextDetectionFilters) (Maybe NotificationChannel) (Maybe Text) Video |
Instances
newStartTextDetection Source #
Arguments
| :: Video | |
| -> StartTextDetection |
Create a value of StartTextDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartTextDetection', startTextDetection_jobTag - An identifier returned in the completion status published by your Amazon
Simple Notification Service topic. For example, you can use JobTag to
group related jobs and identify them in the completion notification.
$sel:filters:StartTextDetection', startTextDetection_filters - Optional parameters that let you set criteria the text must meet to be
included in your response.
$sel:notificationChannel:StartTextDetection', startTextDetection_notificationChannel - Undocumented member.
$sel:clientRequestToken:StartTextDetection', startTextDetection_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartTextDetection requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidentaly started more than once.
$sel:video:StartTextDetection', startTextDetection_video - Undocumented member.
data StartTextDetectionResponse Source #
See: newStartTextDetectionResponse smart constructor.
Constructors
| StartTextDetectionResponse' (Maybe Text) Int |
Instances
newStartTextDetectionResponse Source #
Create a value of StartTextDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartTextDetectionResponse', startTextDetectionResponse_jobId - Identifier for the text detection job. Use JobId to identify the job
in a subsequent call to GetTextDetection.
$sel:httpStatus:StartTextDetectionResponse', startTextDetectionResponse_httpStatus - The response's http status code.
StartPersonTracking
data StartPersonTracking Source #
See: newStartPersonTracking smart constructor.
Constructors
| StartPersonTracking' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) Video |
Instances
newStartPersonTracking Source #
Arguments
| :: Video | |
| -> StartPersonTracking |
Create a value of StartPersonTracking with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartPersonTracking', startPersonTracking_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:notificationChannel:StartPersonTracking', startPersonTracking_notificationChannel - The Amazon SNS topic ARN you want Amazon Rekognition Video to publish
the completion status of the people detection operation to. The Amazon
SNS topic must have a topic name that begins with AmazonRekognition if
you are using the AmazonRekognitionServiceRole permissions policy.
$sel:clientRequestToken:StartPersonTracking', startPersonTracking_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartPersonTracking requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:video:StartPersonTracking', startPersonTracking_video - The video in which you want to detect people. The video must be stored
in an Amazon S3 bucket.
data StartPersonTrackingResponse Source #
See: newStartPersonTrackingResponse smart constructor.
Constructors
| StartPersonTrackingResponse' (Maybe Text) Int |
Instances
newStartPersonTrackingResponse Source #
Create a value of StartPersonTrackingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartPersonTrackingResponse', startPersonTrackingResponse_jobId - The identifier for the person detection job. Use JobId to identify the
job in a subsequent call to GetPersonTracking.
$sel:httpStatus:StartPersonTrackingResponse', startPersonTrackingResponse_httpStatus - The response's http status code.
GetCelebrityRecognition
data GetCelebrityRecognition Source #
See: newGetCelebrityRecognition smart constructor.
Constructors
| GetCelebrityRecognition' (Maybe Text) (Maybe Natural) (Maybe CelebrityRecognitionSortBy) Text |
Instances
newGetCelebrityRecognition Source #
Create a value of GetCelebrityRecognition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetCelebrityRecognition', getCelebrityRecognition_nextToken - If the previous response was incomplete (because there is more
recognized celebrities to retrieve), Amazon Rekognition Video returns a
pagination token in the response. You can use this pagination token to
retrieve the next set of celebrities.
$sel:maxResults:GetCelebrityRecognition', getCelebrityRecognition_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000. If you specify a value greater than 1000,
a maximum of 1000 results is returned. The default value is 1000.
$sel:sortBy:GetCelebrityRecognition', getCelebrityRecognition_sortBy - Sort to use for celebrities returned in Celebrities field. Specify
ID to sort by the celebrity identifier, specify TIMESTAMP to sort by
the time the celebrity was recognized.
$sel:jobId:GetCelebrityRecognition', getCelebrityRecognition_jobId - Job identifier for the required celebrity recognition analysis. You can
get the job identifer from a call to StartCelebrityRecognition.
data GetCelebrityRecognitionResponse Source #
See: newGetCelebrityRecognitionResponse smart constructor.
Constructors
| GetCelebrityRecognitionResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe [CelebrityRecognition]) (Maybe VideoJobStatus) Int |
Instances
newGetCelebrityRecognitionResponse Source #
Create a value of GetCelebrityRecognitionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetCelebrityRecognition', getCelebrityRecognitionResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of celebrities.
$sel:videoMetadata:GetCelebrityRecognitionResponse', getCelebrityRecognitionResponse_videoMetadata - Information about a video that Amazon Rekognition Video analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition Video operation.
$sel:statusMessage:GetCelebrityRecognitionResponse', getCelebrityRecognitionResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:celebrities:GetCelebrityRecognitionResponse', getCelebrityRecognitionResponse_celebrities - Array of celebrities recognized in the video.
$sel:jobStatus:GetCelebrityRecognitionResponse', getCelebrityRecognitionResponse_jobStatus - The current status of the celebrity recognition job.
$sel:httpStatus:GetCelebrityRecognitionResponse', getCelebrityRecognitionResponse_httpStatus - The response's http status code.
StartStreamProcessor
data StartStreamProcessor Source #
See: newStartStreamProcessor smart constructor.
Constructors
| StartStreamProcessor' Text |
Instances
newStartStreamProcessor Source #
Arguments
| :: Text | |
| -> StartStreamProcessor |
Create a value of StartStreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:StartStreamProcessor', startStreamProcessor_name - The name of the stream processor to start processing.
data StartStreamProcessorResponse Source #
See: newStartStreamProcessorResponse smart constructor.
Constructors
| StartStreamProcessorResponse' Int |
Instances
newStartStreamProcessorResponse Source #
Create a value of StartStreamProcessorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartStreamProcessorResponse', startStreamProcessorResponse_httpStatus - The response's http status code.
DetectText
data DetectText Source #
See: newDetectText smart constructor.
Constructors
| DetectText' (Maybe DetectTextFilters) Image |
Instances
Arguments
| :: Image | |
| -> DetectText |
Create a value of DetectText with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DetectText', detectText_filters - Optional parameters that let you set the criteria that the text must
meet to be included in your response.
$sel:image:DetectText', detectText_image - The input image as base64-encoded bytes or an Amazon S3 object. If you
use the AWS CLI to call Amazon Rekognition operations, you can't pass
image bytes.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data DetectTextResponse Source #
See: newDetectTextResponse smart constructor.
Constructors
| DetectTextResponse' (Maybe [TextDetection]) (Maybe Text) Int |
Instances
newDetectTextResponse Source #
Arguments
| :: Int | |
| -> DetectTextResponse |
Create a value of DetectTextResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textDetections:DetectTextResponse', detectTextResponse_textDetections - An array of text that was detected in the input image.
$sel:textModelVersion:DetectTextResponse', detectTextResponse_textModelVersion - The model version used to detect text.
$sel:httpStatus:DetectTextResponse', detectTextResponse_httpStatus - The response's http status code.
GetSegmentDetection
data GetSegmentDetection Source #
See: newGetSegmentDetection smart constructor.
Instances
newGetSegmentDetection Source #
Arguments
| :: Text | |
| -> GetSegmentDetection |
Create a value of GetSegmentDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetSegmentDetection', getSegmentDetection_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of text.
$sel:maxResults:GetSegmentDetection', getSegmentDetection_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000.
$sel:jobId:GetSegmentDetection', getSegmentDetection_jobId - Job identifier for the text detection operation for which you want
results returned. You get the job identifer from an initial call to
StartSegmentDetection.
data GetSegmentDetectionResponse Source #
See: newGetSegmentDetectionResponse smart constructor.
Constructors
| GetSegmentDetectionResponse' (Maybe [SegmentTypeInfo]) (Maybe Text) (Maybe [VideoMetadata]) (Maybe Text) (Maybe [SegmentDetection]) (Maybe VideoJobStatus) (Maybe [AudioMetadata]) Int |
Instances
newGetSegmentDetectionResponse Source #
Create a value of GetSegmentDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:selectedSegmentTypes:GetSegmentDetectionResponse', getSegmentDetectionResponse_selectedSegmentTypes - An array containing the segment types requested in the call to
StartSegmentDetection.
$sel:nextToken:GetSegmentDetection', getSegmentDetectionResponse_nextToken - If the previous response was incomplete (because there are more labels
to retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
text.
$sel:videoMetadata:GetSegmentDetectionResponse', getSegmentDetectionResponse_videoMetadata - Currently, Amazon Rekognition Video returns a single object in the
VideoMetadata array. The object contains information about the video
stream in the input file that Amazon Rekognition Video chose to analyze.
The VideoMetadata object includes the video codec, video format and
other information. Video metadata is returned in each page of
information returned by GetSegmentDetection.
$sel:statusMessage:GetSegmentDetectionResponse', getSegmentDetectionResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:segments:GetSegmentDetectionResponse', getSegmentDetectionResponse_segments - An array of segments detected in a video. The array is sorted by the
segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes
input parameter of StartSegmentDetection. Within each segment type the
array is sorted by timestamp values.
$sel:jobStatus:GetSegmentDetectionResponse', getSegmentDetectionResponse_jobStatus - Current status of the segment detection job.
$sel:audioMetadata:GetSegmentDetectionResponse', getSegmentDetectionResponse_audioMetadata - An array of objects. There can be multiple audio streams. Each
AudioMetadata object contains metadata for a single audio stream.
Audio information in an AudioMetadata objects includes the audio
codec, the number of audio channels, the duration of the audio stream,
and the sample rate. Audio metadata is returned in each page of
information returned by GetSegmentDetection.
$sel:httpStatus:GetSegmentDetectionResponse', getSegmentDetectionResponse_httpStatus - The response's http status code.
CompareFaces
data CompareFaces Source #
See: newCompareFaces smart constructor.
Constructors
| CompareFaces' (Maybe QualityFilter) (Maybe Double) Image Image |
Instances
Arguments
| :: Image | |
| -> Image | |
| -> CompareFaces |
Create a value of CompareFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:qualityFilter:CompareFaces', compareFaces_qualityFilter - A filter that specifies a quality bar for how much filtering is done to
identify faces. Filtered faces aren't compared. If you specify AUTO,
Amazon Rekognition chooses the quality bar. If you specify LOW,
MEDIUM, or HIGH, filtering removes all faces that don’t meet the
chosen quality bar. The quality bar is based on a variety of common use
cases. Low-quality detections can occur for a number of reasons. Some
examples are an object that's misidentified as a face, a face that's
too blurry, or a face with a pose that's too extreme to use. If you
specify NONE, no filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
$sel:similarityThreshold:CompareFaces', compareFaces_similarityThreshold - The minimum level of confidence in the face matches that a match must
meet to be included in the FaceMatches array.
$sel:sourceImage:CompareFaces', compareFaces_sourceImage - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
$sel:targetImage:CompareFaces', compareFaces_targetImage - The target image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data CompareFacesResponse Source #
See: newCompareFacesResponse smart constructor.
Constructors
| CompareFacesResponse' (Maybe [CompareFacesMatch]) (Maybe [ComparedFace]) (Maybe OrientationCorrection) (Maybe OrientationCorrection) (Maybe ComparedSourceImageFace) Int |
Instances
newCompareFacesResponse Source #
Arguments
| :: Int | |
| -> CompareFacesResponse |
Create a value of CompareFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatches:CompareFacesResponse', compareFacesResponse_faceMatches - An array of faces in the target image that match the source image face.
Each CompareFacesMatch object provides the bounding box, the
confidence level that the bounding box contains a face, and the
similarity score for the face in the bounding box and the face in the
source image.
$sel:unmatchedFaces:CompareFacesResponse', compareFacesResponse_unmatchedFaces - An array of faces in the target image that did not match the source
image face.
$sel:targetImageOrientationCorrection:CompareFacesResponse', compareFacesResponse_targetImageOrientationCorrection - The value of TargetImageOrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
$sel:sourceImageOrientationCorrection:CompareFacesResponse', compareFacesResponse_sourceImageOrientationCorrection - The value of SourceImageOrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
$sel:sourceImageFace:CompareFacesResponse', compareFacesResponse_sourceImageFace - The face in the source image that was used for comparison.
$sel:httpStatus:CompareFacesResponse', compareFacesResponse_httpStatus - The response's http status code.
DetectFaces
data DetectFaces Source #
See: newDetectFaces smart constructor.
Constructors
| DetectFaces' (Maybe [Attribute]) Image |
Instances
Arguments
| :: Image | |
| -> DetectFaces |
Create a value of DetectFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:DetectFaces', detectFaces_attributes - An array of facial attributes you want to be returned. This can be the
default list of attributes or all attributes. If you don't specify a
value for Attributes or if you specify ["DEFAULT"], the API
returns the following subset of facial attributes: BoundingBox,
Confidence, Pose, Quality, and Landmarks. If you provide
["ALL"], all facial attributes are returned, but the operation takes
longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a
logical AND operator to determine which attributes to return (in this
case, all attributes).
$sel:image:DetectFaces', detectFaces_image - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data DetectFacesResponse Source #
See: newDetectFacesResponse smart constructor.
Constructors
| DetectFacesResponse' (Maybe OrientationCorrection) (Maybe [FaceDetail]) Int |
Instances
newDetectFacesResponse Source #
Arguments
| :: Int | |
| -> DetectFacesResponse |
Create a value of DetectFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orientationCorrection:DetectFacesResponse', detectFacesResponse_orientationCorrection - The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
$sel:faceDetails:DetectFacesResponse', detectFacesResponse_faceDetails - Details of each face found in the image.
$sel:httpStatus:DetectFacesResponse', detectFacesResponse_httpStatus - The response's http status code.
GetFaceDetection
data GetFaceDetection Source #
See: newGetFaceDetection smart constructor.
Instances
Arguments
| :: Text | |
| -> GetFaceDetection |
Create a value of GetFaceDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetFaceDetection', getFaceDetection_nextToken - If the previous response was incomplete (because there are more faces to
retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
faces.
$sel:maxResults:GetFaceDetection', getFaceDetection_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000. If you specify a value greater than 1000,
a maximum of 1000 results is returned. The default value is 1000.
$sel:jobId:GetFaceDetection', getFaceDetection_jobId - Unique identifier for the face detection job. The JobId is returned
from StartFaceDetection.
data GetFaceDetectionResponse Source #
See: newGetFaceDetectionResponse smart constructor.
Constructors
| GetFaceDetectionResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe [FaceDetection]) (Maybe VideoJobStatus) Int |
Instances
newGetFaceDetectionResponse Source #
Create a value of GetFaceDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetFaceDetection', getFaceDetectionResponse_nextToken - If the response is truncated, Amazon Rekognition returns this token that
you can use in the subsequent request to retrieve the next set of faces.
$sel:videoMetadata:GetFaceDetectionResponse', getFaceDetectionResponse_videoMetadata - Information about a video that Amazon Rekognition Video analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition video operation.
$sel:statusMessage:GetFaceDetectionResponse', getFaceDetectionResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:faces:GetFaceDetectionResponse', getFaceDetectionResponse_faces - An array of faces detected in the video. Each element contains a
detected face's details and the time, in milliseconds from the start of
the video, the face was detected.
$sel:jobStatus:GetFaceDetectionResponse', getFaceDetectionResponse_jobStatus - The current status of the face detection job.
$sel:httpStatus:GetFaceDetectionResponse', getFaceDetectionResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - Amazon Resource Name (ARN) of the model, collection, or stream processor
that you want to assign the tags to.
$sel:tags:TagResource', tagResource_tags - The key-value tags to assign to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
ListFaces (Paginated)
See: newListFaces smart constructor.
Instances
Create a value of ListFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListFaces', listFaces_nextToken - If the previous response was incomplete (because there is more data to
retrieve), Amazon Rekognition returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
faces.
$sel:maxResults:ListFaces', listFaces_maxResults - Maximum number of faces to return.
$sel:collectionId:ListFaces', listFaces_collectionId - ID of the collection from which to list the faces.
data ListFacesResponse Source #
See: newListFacesResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListFacesResponse |
Create a value of ListFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceModelVersion:ListFacesResponse', listFacesResponse_faceModelVersion - Version number of the face detection model associated with the input
collection (CollectionId).
$sel:nextToken:ListFaces', listFacesResponse_nextToken - If the response is truncated, Amazon Rekognition returns this token that
you can use in the subsequent request to retrieve the next set of faces.
$sel:faces:ListFacesResponse', listFacesResponse_faces - An array of Face objects.
$sel:httpStatus:ListFacesResponse', listFacesResponse_httpStatus - The response's http status code.
CreateProjectVersion
data CreateProjectVersion Source #
See: newCreateProjectVersion smart constructor.
Constructors
| CreateProjectVersion' (Maybe Text) (Maybe (HashMap Text Text)) Text Text OutputConfig TrainingData TestingData |
Instances
newCreateProjectVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> OutputConfig | |
| -> TrainingData | |
| -> TestingData | |
| -> CreateProjectVersion |
Create a value of CreateProjectVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:CreateProjectVersion', createProjectVersion_kmsKeyId - The identifier for your AWS Key Management Service (AWS KMS) customer
master key (CMK). You can supply the Amazon Resource Name (ARN) of your
CMK, the ID of your CMK, an alias for your CMK, or an alias ARN. The key
is used to encrypt training and test images copied into the service for
model training. Your source images are unaffected. The key is also used
to encrypt training results and manifest files written to the output
Amazon S3 bucket (OutputConfig).
If you choose to use your own CMK, you need the following permissions on the CMK.
- kms:CreateGrant
- kms:DescribeKey
- kms:GenerateDataKey
- kms:Decrypt
If you don't specify a value for KmsKeyId, images copied into the
service are encrypted using a key that AWS owns and manages.
$sel:tags:CreateProjectVersion', createProjectVersion_tags - A set of tags (key-value pairs) that you want to attach to the model.
$sel:projectArn:CreateProjectVersion', createProjectVersion_projectArn - The ARN of the Amazon Rekognition Custom Labels project that manages the
model that you want to train.
$sel:versionName:CreateProjectVersion', createProjectVersion_versionName - A name for the version of the model. This value must be unique.
$sel:outputConfig:CreateProjectVersion', createProjectVersion_outputConfig - The Amazon S3 bucket location to store the results of training. The S3
bucket can be in any AWS account as long as the caller has
s3:PutObject permissions on the S3 bucket.
$sel:trainingData:CreateProjectVersion', createProjectVersion_trainingData - The dataset to use for training.
$sel:testingData:CreateProjectVersion', createProjectVersion_testingData - The dataset to use for testing.
data CreateProjectVersionResponse Source #
See: newCreateProjectVersionResponse smart constructor.
Constructors
| CreateProjectVersionResponse' (Maybe Text) Int |
Instances
newCreateProjectVersionResponse Source #
Create a value of CreateProjectVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectVersionArn:CreateProjectVersionResponse', createProjectVersionResponse_projectVersionArn - The ARN of the model version that was created. Use
DescribeProjectVersion to get the current status of the training
operation.
$sel:httpStatus:CreateProjectVersionResponse', createProjectVersionResponse_httpStatus - The response's http status code.
DescribeProjects (Paginated)
data DescribeProjects Source #
See: newDescribeProjects smart constructor.
Constructors
| DescribeProjects' (Maybe Text) (Maybe Natural) |
Instances
newDescribeProjects :: DescribeProjects Source #
Create a value of DescribeProjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeProjects', describeProjects_nextToken - If the previous response was incomplete (because there is more results
to retrieve), Amazon Rekognition Custom Labels returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of results.
$sel:maxResults:DescribeProjects', describeProjects_maxResults - The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
data DescribeProjectsResponse Source #
See: newDescribeProjectsResponse smart constructor.
Constructors
| DescribeProjectsResponse' (Maybe Text) (Maybe [ProjectDescription]) Int |
Instances
newDescribeProjectsResponse Source #
Create a value of DescribeProjectsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeProjects', describeProjectsResponse_nextToken - If the previous response was incomplete (because there is more results
to retrieve), Amazon Rekognition Custom Labels returns a pagination
token in the response. You can use this pagination token to retrieve the
next set of results.
$sel:projectDescriptions:DescribeProjectsResponse', describeProjectsResponse_projectDescriptions - A list of project descriptions. The list is sorted by the date and time
the projects are created.
$sel:httpStatus:DescribeProjectsResponse', describeProjectsResponse_httpStatus - The response's http status code.
GetContentModeration
data GetContentModeration Source #
See: newGetContentModeration smart constructor.
Constructors
| GetContentModeration' (Maybe Text) (Maybe Natural) (Maybe ContentModerationSortBy) Text |
Instances
newGetContentModeration Source #
Arguments
| :: Text | |
| -> GetContentModeration |
Create a value of GetContentModeration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetContentModeration', getContentModeration_nextToken - If the previous response was incomplete (because there is more data to
retrieve), Amazon Rekognition returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
content moderation labels.
$sel:maxResults:GetContentModeration', getContentModeration_maxResults - Maximum number of results to return per paginated call. The largest
value you can specify is 1000. If you specify a value greater than 1000,
a maximum of 1000 results is returned. The default value is 1000.
$sel:sortBy:GetContentModeration', getContentModeration_sortBy - Sort to use for elements in the ModerationLabelDetections array. Use
TIMESTAMP to sort array elements by the time labels are detected. Use
NAME to alphabetically group elements for a label together. Within
each label group, the array element are sorted by detection confidence.
The default sort is by TIMESTAMP.
$sel:jobId:GetContentModeration', getContentModeration_jobId - The identifier for the inappropriate, unwanted, or offensive content
moderation job. Use JobId to identify the job in a subsequent call to
GetContentModeration.
data GetContentModerationResponse Source #
See: newGetContentModerationResponse smart constructor.
Constructors
| GetContentModerationResponse' (Maybe Text) (Maybe VideoMetadata) (Maybe Text) (Maybe VideoJobStatus) (Maybe Text) (Maybe [ContentModerationDetection]) Int |
Instances
newGetContentModerationResponse Source #
Create a value of GetContentModerationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetContentModeration', getContentModerationResponse_nextToken - If the response is truncated, Amazon Rekognition Video returns this
token that you can use in the subsequent request to retrieve the next
set of content moderation labels.
$sel:videoMetadata:GetContentModerationResponse', getContentModerationResponse_videoMetadata - Information about a video that Amazon Rekognition analyzed.
Videometadata is returned in every page of paginated responses from
GetContentModeration.
$sel:statusMessage:GetContentModerationResponse', getContentModerationResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:jobStatus:GetContentModerationResponse', getContentModerationResponse_jobStatus - The current status of the content moderation analysis job.
$sel:moderationModelVersion:GetContentModerationResponse', getContentModerationResponse_moderationModelVersion - Version number of the moderation detection model that was used to detect
inappropriate, unwanted, or offensive content.
$sel:moderationLabels:GetContentModerationResponse', getContentModerationResponse_moderationLabels - The detected inappropriate, unwanted, or offensive content moderation
labels and the time(s) they were detected.
$sel:httpStatus:GetContentModerationResponse', getContentModerationResponse_httpStatus - The response's http status code.
DeleteFaces
data DeleteFaces Source #
See: newDeleteFaces smart constructor.
Constructors
| DeleteFaces' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> DeleteFaces |
Create a value of DeleteFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionId:DeleteFaces', deleteFaces_collectionId - Collection from which to remove the specific faces.
$sel:faceIds:DeleteFaces', deleteFaces_faceIds - An array of face IDs to delete.
data DeleteFacesResponse Source #
See: newDeleteFacesResponse smart constructor.
Constructors
| DeleteFacesResponse' (Maybe (NonEmpty Text)) Int |
Instances
newDeleteFacesResponse Source #
Arguments
| :: Int | |
| -> DeleteFacesResponse |
Create a value of DeleteFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletedFaces:DeleteFacesResponse', deleteFacesResponse_deletedFaces - An array of strings (face IDs) of the faces that were deleted.
$sel:httpStatus:DeleteFacesResponse', deleteFacesResponse_httpStatus - The response's http status code.
GetCelebrityInfo
data GetCelebrityInfo Source #
See: newGetCelebrityInfo smart constructor.
Constructors
| GetCelebrityInfo' Text |
Instances
Arguments
| :: Text | |
| -> GetCelebrityInfo |
Create a value of GetCelebrityInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:GetCelebrityInfo', getCelebrityInfo_id - The ID for the celebrity. You get the celebrity ID from a call to the
RecognizeCelebrities operation, which recognizes celebrities in an
image.
data GetCelebrityInfoResponse Source #
See: newGetCelebrityInfoResponse smart constructor.
Constructors
| GetCelebrityInfoResponse' (Maybe [Text]) (Maybe KnownGender) (Maybe Text) Int |
Instances
newGetCelebrityInfoResponse Source #
Create a value of GetCelebrityInfoResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:urls:GetCelebrityInfoResponse', getCelebrityInfoResponse_urls - An array of URLs pointing to additional celebrity information.
$sel:knownGender:GetCelebrityInfoResponse', getCelebrityInfoResponse_knownGender - Retrieves the known gender for the celebrity.
$sel:name:GetCelebrityInfoResponse', getCelebrityInfoResponse_name - The name of the celebrity.
$sel:httpStatus:GetCelebrityInfoResponse', getCelebrityInfoResponse_httpStatus - The response's http status code.
DeleteStreamProcessor
data DeleteStreamProcessor Source #
See: newDeleteStreamProcessor smart constructor.
Constructors
| DeleteStreamProcessor' Text |
Instances
newDeleteStreamProcessor Source #
Arguments
| :: Text | |
| -> DeleteStreamProcessor |
Create a value of DeleteStreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:DeleteStreamProcessor', deleteStreamProcessor_name - The name of the stream processor you want to delete.
data DeleteStreamProcessorResponse Source #
See: newDeleteStreamProcessorResponse smart constructor.
Constructors
| DeleteStreamProcessorResponse' Int |
Instances
newDeleteStreamProcessorResponse Source #
Create a value of DeleteStreamProcessorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteStreamProcessorResponse', deleteStreamProcessorResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - Amazon Resource Name (ARN) of the model, collection, or stream processor
that you want to remove the tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of the tags that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
DetectModerationLabels
data DetectModerationLabels Source #
See: newDetectModerationLabels smart constructor.
Constructors
| DetectModerationLabels' (Maybe HumanLoopConfig) (Maybe Double) Image |
Instances
newDetectModerationLabels Source #
Create a value of DetectModerationLabels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:humanLoopConfig:DetectModerationLabels', detectModerationLabels_humanLoopConfig - Sets up the configuration for human evaluation, including the
FlowDefinition the image will be sent to.
$sel:minConfidence:DetectModerationLabels', detectModerationLabels_minConfidence - Specifies the minimum confidence level for the labels to return. Amazon
Rekognition doesn't return any labels with a confidence level lower
than this specified value.
If you don't specify MinConfidence, the operation returns labels with
confidence values greater than or equal to 50 percent.
$sel:image:DetectModerationLabels', detectModerationLabels_image - The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded
image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not
need to base64-encode image bytes passed using the Bytes field. For
more information, see Images in the Amazon Rekognition developer guide.
data DetectModerationLabelsResponse Source #
See: newDetectModerationLabelsResponse smart constructor.
Constructors
| DetectModerationLabelsResponse' (Maybe HumanLoopActivationOutput) (Maybe Text) (Maybe [ModerationLabel]) Int |
Instances
newDetectModerationLabelsResponse Source #
Create a value of DetectModerationLabelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:humanLoopActivationOutput:DetectModerationLabelsResponse', detectModerationLabelsResponse_humanLoopActivationOutput - Shows the results of the human in the loop evaluation.
$sel:moderationModelVersion:DetectModerationLabelsResponse', detectModerationLabelsResponse_moderationModelVersion - Version number of the moderation detection model that was used to detect
unsafe content.
$sel:moderationLabels:DetectModerationLabelsResponse', detectModerationLabelsResponse_moderationLabels - Array of detected Moderation labels and the time, in milliseconds from
the start of the video, they were detected.
$sel:httpStatus:DetectModerationLabelsResponse', detectModerationLabelsResponse_httpStatus - The response's http status code.
CreateStreamProcessor
data CreateStreamProcessor Source #
See: newCreateStreamProcessor smart constructor.
Constructors
| CreateStreamProcessor' (Maybe (HashMap Text Text)) StreamProcessorInput StreamProcessorOutput Text StreamProcessorSettings Text |
Instances
newCreateStreamProcessor Source #
Arguments
| :: StreamProcessorInput | |
| -> StreamProcessorOutput | |
| -> Text | |
| -> StreamProcessorSettings | |
| -> Text | |
| -> CreateStreamProcessor |
Create a value of CreateStreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateStreamProcessor', createStreamProcessor_tags - A set of tags (key-value pairs) that you want to attach to the stream
processor.
$sel:input:CreateStreamProcessor', createStreamProcessor_input - Kinesis video stream stream that provides the source streaming video. If
you are using the AWS CLI, the parameter name is StreamProcessorInput.
$sel:output:CreateStreamProcessor', createStreamProcessor_output - Kinesis data stream stream to which Amazon Rekognition Video puts the
analysis results. If you are using the AWS CLI, the parameter name is
StreamProcessorOutput.
$sel:name:CreateStreamProcessor', createStreamProcessor_name - An identifier you assign to the stream processor. You can use Name to
manage the stream processor. For example, you can get the current status
of the stream processor by calling DescribeStreamProcessor. Name is
idempotent.
$sel:settings:CreateStreamProcessor', createStreamProcessor_settings - Face recognition input parameters to be used by the stream processor.
Includes the collection to use for face recognition and the face
attributes to detect.
$sel:roleArn:CreateStreamProcessor', createStreamProcessor_roleArn - ARN of the IAM role that allows access to the stream processor.
data CreateStreamProcessorResponse Source #
See: newCreateStreamProcessorResponse smart constructor.
Constructors
| CreateStreamProcessorResponse' (Maybe Text) Int |
Instances
newCreateStreamProcessorResponse Source #
Create a value of CreateStreamProcessorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamProcessorArn:CreateStreamProcessorResponse', createStreamProcessorResponse_streamProcessorArn - ARN for the newly create stream processor.
$sel:httpStatus:CreateStreamProcessorResponse', createStreamProcessorResponse_httpStatus - The response's http status code.
StartFaceDetection
data StartFaceDetection Source #
See: newStartFaceDetection smart constructor.
Constructors
| StartFaceDetection' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe FaceAttributes) Video |
Instances
newStartFaceDetection Source #
Arguments
| :: Video | |
| -> StartFaceDetection |
Create a value of StartFaceDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartFaceDetection', startFaceDetection_jobTag - An identifier you specify that's returned in the completion
notification that's published to your Amazon Simple Notification
Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
$sel:notificationChannel:StartFaceDetection', startFaceDetection_notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition
Video to publish the completion status of the face detection operation.
The Amazon SNS topic must have a topic name that begins with
AmazonRekognition if you are using the AmazonRekognitionServiceRole
permissions policy.
$sel:clientRequestToken:StartFaceDetection', startFaceDetection_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartFaceDetection requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:faceAttributes:StartFaceDetection', startFaceDetection_faceAttributes - The face attributes you want returned.
DEFAULT - The following subset of facial attributes are returned:
BoundingBox, Confidence, Pose, Quality and Landmarks.
ALL - All facial attributes are returned.
$sel:video:StartFaceDetection', startFaceDetection_video - The video in which you want to detect faces. The video must be stored in
an Amazon S3 bucket.
data StartFaceDetectionResponse Source #
See: newStartFaceDetectionResponse smart constructor.
Constructors
| StartFaceDetectionResponse' (Maybe Text) Int |
Instances
newStartFaceDetectionResponse Source #
Create a value of StartFaceDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartFaceDetectionResponse', startFaceDetectionResponse_jobId - The identifier for the face detection job. Use JobId to identify the
job in a subsequent call to GetFaceDetection.
$sel:httpStatus:StartFaceDetectionResponse', startFaceDetectionResponse_httpStatus - The response's http status code.
CreateProject
data CreateProject Source #
See: newCreateProject smart constructor.
Constructors
| CreateProject' Text |
Instances
Arguments
| :: Text | |
| -> CreateProject |
Create a value of CreateProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectName:CreateProject', createProject_projectName - The name of the project to create.
data CreateProjectResponse Source #
See: newCreateProjectResponse smart constructor.
Constructors
| CreateProjectResponse' (Maybe Text) Int |
Instances
newCreateProjectResponse Source #
Create a value of CreateProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:projectArn:CreateProjectResponse', createProjectResponse_projectArn - The Amazon Resource Name (ARN) of the new project. You can use the ARN
to configure IAM access to the project.
$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.
Types
Attribute
Constructors
| Attribute' | |
Fields | |
Bundled Patterns
| pattern Attribute_ALL :: Attribute | |
| pattern Attribute_DEFAULT :: Attribute |
Instances
BodyPart
Constructors
| BodyPart' | |
Fields
| |
Bundled Patterns
| pattern BodyPart_FACE :: BodyPart | |
| pattern BodyPart_HEAD :: BodyPart | |
| pattern BodyPart_LEFT_HAND :: BodyPart | |
| pattern BodyPart_RIGHT_HAND :: BodyPart |
Instances
CelebrityRecognitionSortBy
newtype CelebrityRecognitionSortBy Source #
Constructors
| CelebrityRecognitionSortBy' | |
Fields | |
Bundled Patterns
| pattern CelebrityRecognitionSortBy_ID :: CelebrityRecognitionSortBy | |
| pattern CelebrityRecognitionSortBy_TIMESTAMP :: CelebrityRecognitionSortBy |
Instances
ContentClassifier
newtype ContentClassifier Source #
Constructors
| ContentClassifier' | |
Fields | |
Bundled Patterns
| pattern ContentClassifier_FreeOfAdultContent :: ContentClassifier | |
| pattern ContentClassifier_FreeOfPersonallyIdentifiableInformation :: ContentClassifier |
Instances
ContentModerationSortBy
newtype ContentModerationSortBy Source #
Constructors
| ContentModerationSortBy' | |
Fields | |
Bundled Patterns
| pattern ContentModerationSortBy_NAME :: ContentModerationSortBy | |
| pattern ContentModerationSortBy_TIMESTAMP :: ContentModerationSortBy |
Instances
EmotionName
newtype EmotionName Source #
Constructors
| EmotionName' | |
Fields | |
Bundled Patterns
| pattern EmotionName_ANGRY :: EmotionName | |
| pattern EmotionName_CALM :: EmotionName | |
| pattern EmotionName_CONFUSED :: EmotionName | |
| pattern EmotionName_DISGUSTED :: EmotionName | |
| pattern EmotionName_FEAR :: EmotionName | |
| pattern EmotionName_HAPPY :: EmotionName | |
| pattern EmotionName_SAD :: EmotionName | |
| pattern EmotionName_SURPRISED :: EmotionName | |
| pattern EmotionName_UNKNOWN :: EmotionName |
Instances
FaceAttributes
newtype FaceAttributes Source #
Constructors
| FaceAttributes' | |
Fields | |
Bundled Patterns
| pattern FaceAttributes_ALL :: FaceAttributes | |
| pattern FaceAttributes_DEFAULT :: FaceAttributes |
Instances
FaceSearchSortBy
newtype FaceSearchSortBy Source #
Constructors
| FaceSearchSortBy' | |
Fields | |
Bundled Patterns
| pattern FaceSearchSortBy_INDEX :: FaceSearchSortBy | |
| pattern FaceSearchSortBy_TIMESTAMP :: FaceSearchSortBy |
Instances
GenderType
newtype GenderType Source #
Constructors
| GenderType' | |
Fields | |
Bundled Patterns
| pattern GenderType_Female :: GenderType | |
| pattern GenderType_Male :: GenderType |
Instances
KnownGenderType
newtype KnownGenderType Source #
A list of enum string of possible gender values that Celebrity returns.
Constructors
| KnownGenderType' | |
Fields | |
Bundled Patterns
| pattern KnownGenderType_Female :: KnownGenderType | |
| pattern KnownGenderType_Male :: KnownGenderType |
Instances
LabelDetectionSortBy
newtype LabelDetectionSortBy Source #
Constructors
| LabelDetectionSortBy' | |
Fields | |
Bundled Patterns
| pattern LabelDetectionSortBy_NAME :: LabelDetectionSortBy | |
| pattern LabelDetectionSortBy_TIMESTAMP :: LabelDetectionSortBy |
Instances
LandmarkType
newtype LandmarkType Source #
Constructors
| LandmarkType' | |
Fields | |
Bundled Patterns
Instances
OrientationCorrection
newtype OrientationCorrection Source #
Constructors
| OrientationCorrection' | |
Fields | |
Bundled Patterns
Instances
PersonTrackingSortBy
newtype PersonTrackingSortBy Source #
Constructors
| PersonTrackingSortBy' | |
Fields | |
Bundled Patterns
| pattern PersonTrackingSortBy_INDEX :: PersonTrackingSortBy | |
| pattern PersonTrackingSortBy_TIMESTAMP :: PersonTrackingSortBy |
Instances
ProjectStatus
newtype ProjectStatus Source #
Constructors
| ProjectStatus' | |
Fields | |
Bundled Patterns
| pattern ProjectStatus_CREATED :: ProjectStatus | |
| pattern ProjectStatus_CREATING :: ProjectStatus | |
| pattern ProjectStatus_DELETING :: ProjectStatus |
Instances
ProjectVersionStatus
newtype ProjectVersionStatus Source #
Constructors
| ProjectVersionStatus' | |
Fields | |
Bundled Patterns
Instances
ProtectiveEquipmentType
newtype ProtectiveEquipmentType Source #
Constructors
| ProtectiveEquipmentType' | |
Fields | |
Bundled Patterns
Instances
QualityFilter
newtype QualityFilter Source #
Constructors
| QualityFilter' | |
Fields | |
Bundled Patterns
| pattern QualityFilter_AUTO :: QualityFilter | |
| pattern QualityFilter_HIGH :: QualityFilter | |
| pattern QualityFilter_LOW :: QualityFilter | |
| pattern QualityFilter_MEDIUM :: QualityFilter | |
| pattern QualityFilter_NONE :: QualityFilter |
Instances
Reason
Constructors
| Reason' | |
Fields
| |
Bundled Patterns
| pattern Reason_EXCEEDS_MAX_FACES :: Reason | |
| pattern Reason_EXTREME_POSE :: Reason | |
| pattern Reason_LOW_BRIGHTNESS :: Reason | |
| pattern Reason_LOW_CONFIDENCE :: Reason | |
| pattern Reason_LOW_FACE_QUALITY :: Reason | |
| pattern Reason_LOW_SHARPNESS :: Reason | |
| pattern Reason_SMALL_BOUNDING_BOX :: Reason |
Instances
SegmentType
newtype SegmentType Source #
Constructors
| SegmentType' | |
Fields | |
Bundled Patterns
| pattern SegmentType_SHOT :: SegmentType | |
| pattern SegmentType_TECHNICAL_CUE :: SegmentType |
Instances
StreamProcessorStatus
newtype StreamProcessorStatus Source #
Constructors
| StreamProcessorStatus' | |
Fields | |
Bundled Patterns
| pattern StreamProcessorStatus_FAILED :: StreamProcessorStatus | |
| pattern StreamProcessorStatus_RUNNING :: StreamProcessorStatus | |
| pattern StreamProcessorStatus_STARTING :: StreamProcessorStatus | |
| pattern StreamProcessorStatus_STOPPED :: StreamProcessorStatus | |
| pattern StreamProcessorStatus_STOPPING :: StreamProcessorStatus |
Instances
TechnicalCueType
newtype TechnicalCueType Source #
Constructors
| TechnicalCueType' | |
Fields | |
Bundled Patterns
| pattern TechnicalCueType_BlackFrames :: TechnicalCueType | |
| pattern TechnicalCueType_ColorBars :: TechnicalCueType | |
| pattern TechnicalCueType_Content :: TechnicalCueType | |
| pattern TechnicalCueType_EndCredits :: TechnicalCueType | |
| pattern TechnicalCueType_OpeningCredits :: TechnicalCueType | |
| pattern TechnicalCueType_Slate :: TechnicalCueType | |
| pattern TechnicalCueType_StudioLogo :: TechnicalCueType |
Instances
TextTypes
Constructors
| TextTypes' | |
Fields | |
Bundled Patterns
| pattern TextTypes_LINE :: TextTypes | |
| pattern TextTypes_WORD :: TextTypes |
Instances
VideoColorRange
newtype VideoColorRange Source #
Constructors
| VideoColorRange' | |
Fields | |
Bundled Patterns
| pattern VideoColorRange_FULL :: VideoColorRange | |
| pattern VideoColorRange_LIMITED :: VideoColorRange |
Instances
VideoJobStatus
newtype VideoJobStatus Source #
Constructors
| VideoJobStatus' | |
Fields | |
Bundled Patterns
| pattern VideoJobStatus_FAILED :: VideoJobStatus | |
| pattern VideoJobStatus_IN_PROGRESS :: VideoJobStatus | |
| pattern VideoJobStatus_SUCCEEDED :: VideoJobStatus |
Instances
AgeRange
Structure containing the estimated age range, in years, for a face.
Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the face of a 6-year-old might have an estimated range of 4-8.
See: newAgeRange smart constructor.
Instances
| Eq AgeRange Source # | |
| Read AgeRange Source # | |
| Show AgeRange Source # | |
| Generic AgeRange Source # | |
| NFData AgeRange Source # | |
Defined in Amazonka.Rekognition.Types.AgeRange | |
| Hashable AgeRange Source # | |
Defined in Amazonka.Rekognition.Types.AgeRange | |
| FromJSON AgeRange Source # | |
| type Rep AgeRange Source # | |
Defined in Amazonka.Rekognition.Types.AgeRange type Rep AgeRange = D1 ('MetaData "AgeRange" "Amazonka.Rekognition.Types.AgeRange" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "AgeRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "low") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "high") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) | |
newAgeRange :: AgeRange Source #
Create a value of AgeRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:low:AgeRange', ageRange_low - The lowest estimated age.
$sel:high:AgeRange', ageRange_high - The highest estimated age.
Asset
Assets are the images that you use to train and evaluate a model version. Assets can also contain validation information that you use to debug a failed model training.
See: newAsset smart constructor.
Constructors
| Asset' (Maybe GroundTruthManifest) |
Instances
| Eq Asset Source # | |
| Read Asset Source # | |
| Show Asset Source # | |
| Generic Asset Source # | |
| NFData Asset Source # | |
Defined in Amazonka.Rekognition.Types.Asset | |
| Hashable Asset Source # | |
Defined in Amazonka.Rekognition.Types.Asset | |
| ToJSON Asset Source # | |
Defined in Amazonka.Rekognition.Types.Asset | |
| FromJSON Asset Source # | |
| type Rep Asset Source # | |
Defined in Amazonka.Rekognition.Types.Asset type Rep Asset = D1 ('MetaData "Asset" "Amazonka.Rekognition.Types.Asset" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Asset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groundTruthManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroundTruthManifest)))) | |
Create a value of Asset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groundTruthManifest:Asset', asset_groundTruthManifest - Undocumented member.
AudioMetadata
data AudioMetadata Source #
Metadata information about an audio stream. An array of AudioMetadata
objects for the audio streams found in a stored video is returned by
GetSegmentDetection.
See: newAudioMetadata smart constructor.
Instances
newAudioMetadata :: AudioMetadata Source #
Create a value of AudioMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codec:AudioMetadata', audioMetadata_codec - The audio codec used to encode or decode the audio stream.
$sel:sampleRate:AudioMetadata', audioMetadata_sampleRate - The sample rate for the audio stream.
$sel:numberOfChannels:AudioMetadata', audioMetadata_numberOfChannels - The number of audio channels in the segment.
$sel:durationMillis:AudioMetadata', audioMetadata_durationMillis - The duration of the audio stream in milliseconds.
Beard
Indicates whether or not the face has a beard, and the confidence level in the determination.
See: newBeard smart constructor.
Instances
| Eq Beard Source # | |
| Read Beard Source # | |
| Show Beard Source # | |
| Generic Beard Source # | |
| NFData Beard Source # | |
Defined in Amazonka.Rekognition.Types.Beard | |
| Hashable Beard Source # | |
Defined in Amazonka.Rekognition.Types.Beard | |
| FromJSON Beard Source # | |
| type Rep Beard Source # | |
Defined in Amazonka.Rekognition.Types.Beard type Rep Beard = D1 ('MetaData "Beard" "Amazonka.Rekognition.Types.Beard" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Beard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Beard with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Beard', beard_value - Boolean value that indicates whether the face has beard or not.
$sel:confidence:Beard', beard_confidence - Level of confidence in the determination.
BlackFrame
data BlackFrame Source #
A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. As videos can come from multiple sources, formats, and time periods, they may contain different standards and varying noise levels for black frames that need to be accounted for. For more information, see StartSegmentDetection.
See: newBlackFrame smart constructor.
Constructors
| BlackFrame' (Maybe Double) (Maybe Double) |
Instances
newBlackFrame :: BlackFrame Source #
Create a value of BlackFrame with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxPixelThreshold:BlackFrame', blackFrame_maxPixelThreshold - A threshold used to determine the maximum luminance value for a pixel to
be considered black. In a full color range video, luminance values range
from 0-255. A pixel value of 0 is pure black, and the most strict
filter. The maximum black pixel value is computed as follows:
max_black_pixel_value = minimum_luminance + MaxPixelThreshold
*luminance_range.
For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.
The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.
$sel:minCoveragePercentage:BlackFrame', blackFrame_minCoveragePercentage - The minimum percentage of pixels in a frame that need to have a
luminance below the max_black_pixel_value for a frame to be considered a
black frame. Luminance is calculated using the BT.709 matrix.
The default value is 99, which means at least 99% of all pixels in the
frame are black pixels as per the MaxPixelThreshold set. You can
reduce this value to allow more noise on the black frame.
BoundingBox
data BoundingBox Source #
Identifies the bounding box around the label, face, text or personal
protective equipment. The left (x-coordinate) and top (y-coordinate)
are coordinates representing the top and left sides of the bounding box.
Note that the upper-left corner of the image is the origin (0,0).
The top and left values returned are ratios of the overall image
size. For example, if the input image is 700x200 pixels, and the
top-left coordinate of the bounding box is 350x50 pixels, the API
returns a left value of 0.5 (350/700) and a top value of 0.25
(50/200).
The width and height values represent the dimensions of the bounding
box as a ratio of the overall image dimension. For example, if the input
image is 700x200 pixels, and the bounding box width is 70 pixels, the
width returned is 0.1.
The bounding box coordinates can have negative values. For example, if
Amazon Rekognition is able to detect a face that is at the image edge
and is only partially visible, the service can return coordinates that
are outside the image bounds and, depending on the image edge, you might
get negative values or values greater than 1 for the left or top
values.
See: newBoundingBox smart constructor.
Instances
newBoundingBox :: BoundingBox Source #
Create a value of BoundingBox with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:height:BoundingBox', boundingBox_height - Height of the bounding box as a ratio of the overall image height.
$sel:left:BoundingBox', boundingBox_left - Left coordinate of the bounding box as a ratio of overall image width.
$sel:width:BoundingBox', boundingBox_width - Width of the bounding box as a ratio of the overall image width.
$sel:top:BoundingBox', boundingBox_top - Top coordinate of the bounding box as a ratio of overall image height.
Celebrity
Provides information about a celebrity recognized by the RecognizeCelebrities operation.
See: newCelebrity smart constructor.
Constructors
| Celebrity' (Maybe Double) (Maybe [Text]) (Maybe KnownGender) (Maybe Text) (Maybe Text) (Maybe ComparedFace) |
Instances
newCelebrity :: Celebrity Source #
Create a value of Celebrity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matchConfidence:Celebrity', celebrity_matchConfidence - The confidence, in percentage, that Amazon Rekognition has that the
recognized face is the celebrity.
$sel:urls:Celebrity', celebrity_urls - An array of URLs pointing to additional information about the celebrity.
If there is no additional information about the celebrity, this list is
empty.
$sel:knownGender:Celebrity', celebrity_knownGender - Undocumented member.
$sel:name:Celebrity', celebrity_name - The name of the celebrity.
$sel:id:Celebrity', celebrity_id - A unique identifier for the celebrity.
$sel:face:Celebrity', celebrity_face - Provides information about the celebrity's face, such as its location
on the image.
CelebrityDetail
data CelebrityDetail Source #
Information about a recognized celebrity.
See: newCelebrityDetail smart constructor.
Constructors
| CelebrityDetail' (Maybe BoundingBox) (Maybe [Text]) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe FaceDetail) |
Instances
newCelebrityDetail :: CelebrityDetail Source #
Create a value of CelebrityDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:CelebrityDetail', celebrityDetail_boundingBox - Bounding box around the body of a celebrity.
$sel:urls:CelebrityDetail', celebrityDetail_urls - An array of URLs pointing to additional celebrity information.
$sel:confidence:CelebrityDetail', celebrityDetail_confidence - The confidence, in percentage, that Amazon Rekognition has that the
recognized face is the celebrity.
$sel:name:CelebrityDetail', celebrityDetail_name - The name of the celebrity.
$sel:id:CelebrityDetail', celebrityDetail_id - The unique identifier for the celebrity.
$sel:face:CelebrityDetail', celebrityDetail_face - Face details for the recognized celebrity.
CelebrityRecognition
data CelebrityRecognition Source #
Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.
See: newCelebrityRecognition smart constructor.
Constructors
| CelebrityRecognition' (Maybe CelebrityDetail) (Maybe Integer) |
Instances
newCelebrityRecognition :: CelebrityRecognition Source #
Create a value of CelebrityRecognition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:celebrity:CelebrityRecognition', celebrityRecognition_celebrity - Information about a recognized celebrity.
$sel:timestamp:CelebrityRecognition', celebrityRecognition_timestamp - The time, in milliseconds from the start of the video, that the
celebrity was recognized.
CompareFacesMatch
data CompareFacesMatch Source #
Provides information about a face in a target image that matches the
source image face analyzed by CompareFaces. The Face property
contains the bounding box of the face in the target image. The
Similarity property is the confidence that the source image face
matches the face in the bounding box.
See: newCompareFacesMatch smart constructor.
Constructors
| CompareFacesMatch' (Maybe Double) (Maybe ComparedFace) |
Instances
newCompareFacesMatch :: CompareFacesMatch Source #
Create a value of CompareFacesMatch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:similarity:CompareFacesMatch', compareFacesMatch_similarity - Level of confidence that the faces match.
$sel:face:CompareFacesMatch', compareFacesMatch_face - Provides face metadata (bounding box and confidence that the bounding
box actually contains a face).
ComparedFace
data ComparedFace Source #
Provides face metadata for target image faces that are analyzed by
CompareFaces and RecognizeCelebrities.
See: newComparedFace smart constructor.
Constructors
| ComparedFace' (Maybe BoundingBox) (Maybe [Emotion]) (Maybe Pose) (Maybe Double) (Maybe ImageQuality) (Maybe Smile) (Maybe [Landmark]) |
Instances
newComparedFace :: ComparedFace Source #
Create a value of ComparedFace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:ComparedFace', comparedFace_boundingBox - Bounding box of the face.
$sel:emotions:ComparedFace', comparedFace_emotions - The emotions that appear to be expressed on the face, and the confidence
level in the determination. Valid values include "Happy", "Sad",
"Angry", "Confused", "Disgusted", "Surprised", "Calm",
"Unknown", and "Fear".
$sel:pose:ComparedFace', comparedFace_pose - Indicates the pose of the face as determined by its pitch, roll, and
yaw.
$sel:confidence:ComparedFace', comparedFace_confidence - Level of confidence that what the bounding box contains is a face.
$sel:quality:ComparedFace', comparedFace_quality - Identifies face image brightness and sharpness.
$sel:smile:ComparedFace', comparedFace_smile - Indicates whether or not the face is smiling, and the confidence level
in the determination.
$sel:landmarks:ComparedFace', comparedFace_landmarks - An array of facial landmarks.
ComparedSourceImageFace
data ComparedSourceImageFace Source #
Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.
See: newComparedSourceImageFace smart constructor.
Constructors
| ComparedSourceImageFace' (Maybe BoundingBox) (Maybe Double) |
Instances
newComparedSourceImageFace :: ComparedSourceImageFace Source #
Create a value of ComparedSourceImageFace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:ComparedSourceImageFace', comparedSourceImageFace_boundingBox - Bounding box of the face.
$sel:confidence:ComparedSourceImageFace', comparedSourceImageFace_confidence - Confidence level that the selected bounding box contains a face.
ContentModerationDetection
data ContentModerationDetection Source #
Information about an inappropriate, unwanted, or offensive content label detection in a stored video.
See: newContentModerationDetection smart constructor.
Constructors
| ContentModerationDetection' (Maybe ModerationLabel) (Maybe Integer) |
Instances
newContentModerationDetection :: ContentModerationDetection Source #
Create a value of ContentModerationDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:moderationLabel:ContentModerationDetection', contentModerationDetection_moderationLabel - The content moderation label detected by in the stored video.
$sel:timestamp:ContentModerationDetection', contentModerationDetection_timestamp - Time, in milliseconds from the beginning of the video, that the content
moderation label was detected.
CoversBodyPart
data CoversBodyPart Source #
Information about an item of Personal Protective Equipment covering a corresponding body part. For more information, see DetectProtectiveEquipment.
See: newCoversBodyPart smart constructor.
Constructors
| CoversBodyPart' (Maybe Bool) (Maybe Double) |
Instances
newCoversBodyPart :: CoversBodyPart Source #
Create a value of CoversBodyPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:CoversBodyPart', coversBodyPart_value - True if the PPE covers the corresponding body part, otherwise false.
$sel:confidence:CoversBodyPart', coversBodyPart_confidence - The confidence that Amazon Rekognition has in the value of Value.
CustomLabel
data CustomLabel Source #
A custom label detected in an image by a call to DetectCustomLabels.
See: newCustomLabel smart constructor.
Instances
newCustomLabel :: CustomLabel Source #
Create a value of CustomLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:confidence:CustomLabel', customLabel_confidence - The confidence that the model has in the detection of the custom label.
The range is 0-100. A higher value indicates a higher confidence.
$sel:name:CustomLabel', customLabel_name - The name of the custom label.
$sel:geometry:CustomLabel', customLabel_geometry - The location of the detected object on the image that corresponds to the
custom label. Includes an axis aligned coarse bounding box surrounding
the object and a finer grain polygon for more accurate spatial
information.
DetectTextFilters
data DetectTextFilters Source #
A set of optional parameters that you can use to set the criteria that
the text must meet to be included in your response. WordFilter looks
at a word’s height, width, and minimum confidence. RegionOfInterest
lets you set a specific region of the image to look for text in.
See: newDetectTextFilters smart constructor.
Constructors
| DetectTextFilters' (Maybe [RegionOfInterest]) (Maybe DetectionFilter) |
Instances
newDetectTextFilters :: DetectTextFilters Source #
Create a value of DetectTextFilters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionsOfInterest:DetectTextFilters', detectTextFilters_regionsOfInterest - A Filter focusing on a certain area of the image. Uses a BoundingBox
object to set the region of the image.
$sel:wordFilter:DetectTextFilters', detectTextFilters_wordFilter - Undocumented member.
DetectionFilter
data DetectionFilter Source #
A set of parameters that allow you to filter out certain results from your returned results.
See: newDetectionFilter smart constructor.
Instances
newDetectionFilter :: DetectionFilter Source #
Create a value of DetectionFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minBoundingBoxHeight:DetectionFilter', detectionFilter_minBoundingBoxHeight - Sets the minimum height of the word bounding box. Words with bounding
box heights lesser than this value will be excluded from the result.
Value is relative to the video frame height.
$sel:minBoundingBoxWidth:DetectionFilter', detectionFilter_minBoundingBoxWidth - Sets the minimum width of the word bounding box. Words with bounding
boxes widths lesser than this value will be excluded from the result.
Value is relative to the video frame width.
$sel:minConfidence:DetectionFilter', detectionFilter_minConfidence - Sets the confidence of word detection. Words with detection confidence
below this will be excluded from the result. Values should be between 50
and 100 as Text in Video will not return any result below 50.
Emotion
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
See: newEmotion smart constructor.
Constructors
| Emotion' (Maybe Double) (Maybe EmotionName) |
Instances
| Eq Emotion Source # | |
| Read Emotion Source # | |
| Show Emotion Source # | |
| Generic Emotion Source # | |
| NFData Emotion Source # | |
Defined in Amazonka.Rekognition.Types.Emotion | |
| Hashable Emotion Source # | |
Defined in Amazonka.Rekognition.Types.Emotion | |
| FromJSON Emotion Source # | |
| type Rep Emotion Source # | |
Defined in Amazonka.Rekognition.Types.Emotion type Rep Emotion = D1 ('MetaData "Emotion" "Amazonka.Rekognition.Types.Emotion" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Emotion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmotionName)))) | |
newEmotion :: Emotion Source #
Create a value of Emotion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:confidence:Emotion', emotion_confidence - Level of confidence in the determination.
$sel:type':Emotion', emotion_type - Type of emotion detected.
EquipmentDetection
data EquipmentDetection Source #
Information about an item of Personal Protective Equipment (PPE) detected by DetectProtectiveEquipment. For more information, see DetectProtectiveEquipment.
See: newEquipmentDetection smart constructor.
Constructors
| EquipmentDetection' (Maybe BoundingBox) (Maybe CoversBodyPart) (Maybe Double) (Maybe ProtectiveEquipmentType) |
Instances
newEquipmentDetection :: EquipmentDetection Source #
Create a value of EquipmentDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:EquipmentDetection', equipmentDetection_boundingBox - A bounding box surrounding the item of detected PPE.
$sel:coversBodyPart:EquipmentDetection', equipmentDetection_coversBodyPart - Information about the body part covered by the detected PPE.
$sel:confidence:EquipmentDetection', equipmentDetection_confidence - The confidence that Amazon Rekognition has that the bounding box
(BoundingBox) contains an item of PPE.
$sel:type':EquipmentDetection', equipmentDetection_type - The type of detected PPE.
EvaluationResult
data EvaluationResult Source #
The evaluation results for the training of a model.
See: newEvaluationResult smart constructor.
Constructors
| EvaluationResult' (Maybe Summary) (Maybe Double) |
Instances
newEvaluationResult :: EvaluationResult Source #
Create a value of EvaluationResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:summary:EvaluationResult', evaluationResult_summary - The S3 bucket that contains the training summary.
$sel:f1Score:EvaluationResult', evaluationResult_f1Score - The F1 score for the evaluation of all labels. The F1 score metric
evaluates the overall precision and recall performance of the model as a
single value. A higher value indicates better precision and recall
performance. A lower score indicates that precision, recall, or both are
performing poorly.
EyeOpen
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
See: newEyeOpen smart constructor.
Instances
| Eq EyeOpen Source # | |
| Read EyeOpen Source # | |
| Show EyeOpen Source # | |
| Generic EyeOpen Source # | |
| NFData EyeOpen Source # | |
Defined in Amazonka.Rekognition.Types.EyeOpen | |
| Hashable EyeOpen Source # | |
Defined in Amazonka.Rekognition.Types.EyeOpen | |
| FromJSON EyeOpen Source # | |
| type Rep EyeOpen Source # | |
Defined in Amazonka.Rekognition.Types.EyeOpen type Rep EyeOpen = D1 ('MetaData "EyeOpen" "Amazonka.Rekognition.Types.EyeOpen" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "EyeOpen'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
newEyeOpen :: EyeOpen Source #
Create a value of EyeOpen with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:EyeOpen', eyeOpen_value - Boolean value that indicates whether the eyes on the face are open.
$sel:confidence:EyeOpen', eyeOpen_confidence - Level of confidence in the determination.
Eyeglasses
data Eyeglasses Source #
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
See: newEyeglasses smart constructor.
Constructors
| Eyeglasses' (Maybe Bool) (Maybe Double) |
Instances
newEyeglasses :: Eyeglasses Source #
Create a value of Eyeglasses with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Eyeglasses', eyeglasses_value - Boolean value that indicates whether the face is wearing eye glasses or
not.
$sel:confidence:Eyeglasses', eyeglasses_confidence - Level of confidence in the determination.
Face
Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
See: newFace smart constructor.
Instances
Create a value of Face with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceId:Face', face_faceId - Unique identifier that Amazon Rekognition assigns to the face.
$sel:boundingBox:Face', face_boundingBox - Bounding box of the face.
$sel:externalImageId:Face', face_externalImageId - Identifier that you assign to all the faces in the input image.
$sel:confidence:Face', face_confidence - Confidence level that the bounding box contains a face (and not a
different object such as a tree).
$sel:imageId:Face', face_imageId - Unique identifier that Amazon Rekognition assigns to the input image.
FaceDetail
data FaceDetail Source #
Structure containing attributes of the face that the algorithm detected.
A FaceDetail object contains either the default facial attributes or
all facial attributes. The default attributes are BoundingBox,
Confidence, Landmarks, Pose, and Quality.
GetFaceDetection is the only Amazon Rekognition Video stored video
operation that can return a FaceDetail object with all attributes. To
specify which attributes to return, use the FaceAttributes input
parameter for StartFaceDetection. The following Amazon Rekognition Video
operations return only the default attributes. The corresponding Start
operations don't have a FaceAttributes input parameter.
- GetCelebrityRecognition
- GetPersonTracking
- GetFaceSearch
The Amazon Rekognition Image DetectFaces and IndexFaces operations can
return all facial attributes. To specify which attributes to return, use
the Attributes input parameter for DetectFaces. For IndexFaces,
use the DetectAttributes input parameter.
See: newFaceDetail smart constructor.
Constructors
| FaceDetail' (Maybe AgeRange) (Maybe Sunglasses) (Maybe MouthOpen) (Maybe BoundingBox) (Maybe [Emotion]) (Maybe EyeOpen) (Maybe Pose) (Maybe Double) (Maybe Gender) (Maybe ImageQuality) (Maybe Eyeglasses) (Maybe Beard) (Maybe Mustache) (Maybe Smile) (Maybe [Landmark]) |
Instances
newFaceDetail :: FaceDetail Source #
Create a value of FaceDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ageRange:FaceDetail', faceDetail_ageRange - The estimated age range, in years, for the face. Low represents the
lowest estimated age and High represents the highest estimated age.
$sel:sunglasses:FaceDetail', faceDetail_sunglasses - Indicates whether or not the face is wearing sunglasses, and the
confidence level in the determination.
$sel:mouthOpen:FaceDetail', faceDetail_mouthOpen - Indicates whether or not the mouth on the face is open, and the
confidence level in the determination.
$sel:boundingBox:FaceDetail', faceDetail_boundingBox - Bounding box of the face. Default attribute.
$sel:emotions:FaceDetail', faceDetail_emotions - The emotions that appear to be expressed on the face, and the confidence
level in the determination. The API is only making a determination of
the physical appearance of a person's face. It is not a determination
of the person’s internal emotional state and should not be used in such
a way. For example, a person pretending to have a sad face might not be
sad emotionally.
$sel:eyesOpen:FaceDetail', faceDetail_eyesOpen - Indicates whether or not the eyes on the face are open, and the
confidence level in the determination.
$sel:pose:FaceDetail', faceDetail_pose - Indicates the pose of the face as determined by its pitch, roll, and
yaw. Default attribute.
$sel:confidence:FaceDetail', faceDetail_confidence - Confidence level that the bounding box contains a face (and not a
different object such as a tree). Default attribute.
$sel:gender:FaceDetail', faceDetail_gender - The predicted gender of a detected face.
$sel:quality:FaceDetail', faceDetail_quality - Identifies image brightness and sharpness. Default attribute.
$sel:eyeglasses:FaceDetail', faceDetail_eyeglasses - Indicates whether or not the face is wearing eye glasses, and the
confidence level in the determination.
$sel:beard:FaceDetail', faceDetail_beard - Indicates whether or not the face has a beard, and the confidence level
in the determination.
$sel:mustache:FaceDetail', faceDetail_mustache - Indicates whether or not the face has a mustache, and the confidence
level in the determination.
$sel:smile:FaceDetail', faceDetail_smile - Indicates whether or not the face is smiling, and the confidence level
in the determination.
$sel:landmarks:FaceDetail', faceDetail_landmarks - Indicates the location of landmarks on the face. Default attribute.
FaceDetection
data FaceDetection Source #
Information about a face detected in a video analysis request and the time the face was detected in the video.
See: newFaceDetection smart constructor.
Constructors
| FaceDetection' (Maybe Integer) (Maybe FaceDetail) |
Instances
newFaceDetection :: FaceDetection Source #
Create a value of FaceDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timestamp:FaceDetection', faceDetection_timestamp - Time, in milliseconds from the start of the video, that the face was
detected.
$sel:face:FaceDetection', faceDetection_face - The face properties for the detected face.
FaceMatch
Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.
See: newFaceMatch smart constructor.
Constructors
| FaceMatch' (Maybe Double) (Maybe Face) |
Instances
| Eq FaceMatch Source # | |
| Read FaceMatch Source # | |
| Show FaceMatch Source # | |
| Generic FaceMatch Source # | |
| NFData FaceMatch Source # | |
Defined in Amazonka.Rekognition.Types.FaceMatch | |
| Hashable FaceMatch Source # | |
Defined in Amazonka.Rekognition.Types.FaceMatch | |
| FromJSON FaceMatch Source # | |
| type Rep FaceMatch Source # | |
Defined in Amazonka.Rekognition.Types.FaceMatch type Rep FaceMatch = D1 ('MetaData "FaceMatch" "Amazonka.Rekognition.Types.FaceMatch" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "FaceMatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "similarity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "face") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Face)))) | |
newFaceMatch :: FaceMatch Source #
Create a value of FaceMatch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:similarity:FaceMatch', faceMatch_similarity - Confidence in the match of this face with the input face.
$sel:face:FaceMatch', faceMatch_face - Describes the face properties such as the bounding box, face ID, image
ID of the source image, and external image ID that you assigned.
FaceRecord
data FaceRecord Source #
Object containing both the face metadata (stored in the backend database), and facial attributes that are detected but aren't stored in the database.
See: newFaceRecord smart constructor.
Constructors
| FaceRecord' (Maybe FaceDetail) (Maybe Face) |
Instances
newFaceRecord :: FaceRecord Source #
Create a value of FaceRecord with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceDetail:FaceRecord', faceRecord_faceDetail - Structure containing attributes of the face that the algorithm detected.
$sel:face:FaceRecord', faceRecord_face - Describes the face properties such as the bounding box, face ID, image
ID of the input image, and external image ID that you assigned.
FaceSearchSettings
data FaceSearchSettings Source #
Input face recognition parameters for an Amazon Rekognition stream
processor. FaceRecognitionSettings is a request parameter for
CreateStreamProcessor.
See: newFaceSearchSettings smart constructor.
Constructors
| FaceSearchSettings' (Maybe Double) (Maybe Text) |
Instances
newFaceSearchSettings :: FaceSearchSettings Source #
Create a value of FaceSearchSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatchThreshold:FaceSearchSettings', faceSearchSettings_faceMatchThreshold - Minimum face match confidence score that must be met to return a result
for a recognized face. Default is 80. 0 is the lowest confidence. 100 is
the highest confidence.
$sel:collectionId:FaceSearchSettings', faceSearchSettings_collectionId - The ID of a collection that contains faces that you want to search for.
Gender
The predicted gender of a detected face.
Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor wearing a long-haired wig and earrings for a role might be predicted as female.
Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.
We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.
See: newGender smart constructor.
Constructors
| Gender' (Maybe GenderType) (Maybe Double) |
Instances
| Eq Gender Source # | |
| Read Gender Source # | |
| Show Gender Source # | |
| Generic Gender Source # | |
| NFData Gender Source # | |
Defined in Amazonka.Rekognition.Types.Gender | |
| Hashable Gender Source # | |
Defined in Amazonka.Rekognition.Types.Gender | |
| FromJSON Gender Source # | |
| type Rep Gender Source # | |
Defined in Amazonka.Rekognition.Types.Gender type Rep Gender = D1 ('MetaData "Gender" "Amazonka.Rekognition.Types.Gender" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Gender'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GenderType)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Gender with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Gender', gender_value - The predicted gender of the face.
$sel:confidence:Gender', gender_confidence - Level of confidence in the prediction.
Geometry
Information about where an object (DetectCustomLabels) or text (DetectText) is located on an image.
See: newGeometry smart constructor.
Constructors
| Geometry' (Maybe BoundingBox) (Maybe [Point]) |
Instances
| Eq Geometry Source # | |
| Read Geometry Source # | |
| Show Geometry Source # | |
| Generic Geometry Source # | |
| NFData Geometry Source # | |
Defined in Amazonka.Rekognition.Types.Geometry | |
| Hashable Geometry Source # | |
Defined in Amazonka.Rekognition.Types.Geometry | |
| FromJSON Geometry Source # | |
| type Rep Geometry Source # | |
Defined in Amazonka.Rekognition.Types.Geometry type Rep Geometry = D1 ('MetaData "Geometry" "Amazonka.Rekognition.Types.Geometry" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Geometry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "boundingBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoundingBox)) :*: S1 ('MetaSel ('Just "polygon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Point])))) | |
newGeometry :: Geometry Source #
Create a value of Geometry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:Geometry', geometry_boundingBox - An axis-aligned coarse representation of the detected item's location
on the image.
$sel:polygon:Geometry', geometry_polygon - Within the bounding box, a fine-grained polygon around the detected
item.
GroundTruthManifest
data GroundTruthManifest Source #
The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.
See: newGroundTruthManifest smart constructor.
Constructors
| GroundTruthManifest' (Maybe S3Object) |
Instances
newGroundTruthManifest :: GroundTruthManifest Source #
Create a value of GroundTruthManifest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Object:GroundTruthManifest', groundTruthManifest_s3Object - Undocumented member.
HumanLoopActivationOutput
data HumanLoopActivationOutput Source #
Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
See: newHumanLoopActivationOutput smart constructor.
Instances
newHumanLoopActivationOutput :: HumanLoopActivationOutput Source #
Create a value of HumanLoopActivationOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:humanLoopActivationReasons:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationReasons - Shows if and why human review was needed.
$sel:humanLoopArn:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopArn - The Amazon Resource Name (ARN) of the HumanLoop created.
$sel:humanLoopActivationConditionsEvaluationResults:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationConditionsEvaluationResults - Shows the result of condition evaluations, including those conditions
which activated a human review.
HumanLoopConfig
data HumanLoopConfig Source #
Sets up the flow definition the image will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.
See: newHumanLoopConfig smart constructor.
Constructors
| HumanLoopConfig' (Maybe HumanLoopDataAttributes) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> HumanLoopConfig |
Create a value of HumanLoopConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataAttributes:HumanLoopConfig', humanLoopConfig_dataAttributes - Sets attributes of the input data.
$sel:humanLoopName:HumanLoopConfig', humanLoopConfig_humanLoopName - The name of the human review used for this image. This should be kept
unique within a region.
$sel:flowDefinitionArn:HumanLoopConfig', humanLoopConfig_flowDefinitionArn - The Amazon Resource Name (ARN) of the flow definition. You can create a
flow definition by using the Amazon Sagemaker
CreateFlowDefinition
Operation.
HumanLoopDataAttributes
data HumanLoopDataAttributes Source #
Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information.
See: newHumanLoopDataAttributes smart constructor.
Constructors
| HumanLoopDataAttributes' (Maybe [ContentClassifier]) |
Instances
newHumanLoopDataAttributes :: HumanLoopDataAttributes Source #
Create a value of HumanLoopDataAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentClassifiers:HumanLoopDataAttributes', humanLoopDataAttributes_contentClassifiers - Sets whether the input image is free of personally identifiable
information.
Image
Provides the input image either as bytes or an S3 object.
You pass image bytes to an Amazon Rekognition API operation by using the
Bytes property. For example, you would use the Bytes property to
pass an image loaded from a local file system. Image bytes passed by
using the Bytes property must be base64-encoded. Your code may not
need to encode image bytes if you are using an AWS SDK to call Amazon
Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
You pass images stored in an S3 bucket to an Amazon Rekognition API
operation by using the S3Object property. Images stored in an S3
bucket do not need to be base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
See: newImage smart constructor.
Instances
| Eq Image Source # | |
| Read Image Source # | |
| Show Image Source # | |
| Generic Image Source # | |
| NFData Image Source # | |
Defined in Amazonka.Rekognition.Types.Image | |
| Hashable Image Source # | |
Defined in Amazonka.Rekognition.Types.Image | |
| ToJSON Image Source # | |
Defined in Amazonka.Rekognition.Types.Image | |
| type Rep Image Source # | |
Defined in Amazonka.Rekognition.Types.Image type Rep Image = D1 ('MetaData "Image" "Amazonka.Rekognition.Types.Image" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Image'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object)) :*: S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) | |
Create a value of Image with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Object:Image', image_s3Object - Identifies an S3 object as the image source.
$sel:bytes:Image', image_bytes - Blob of image bytes up to 5 MBs.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
ImageQuality
data ImageQuality Source #
Identifies face image brightness and sharpness.
See: newImageQuality smart constructor.
Constructors
| ImageQuality' (Maybe Double) (Maybe Double) |
Instances
newImageQuality :: ImageQuality Source #
Create a value of ImageQuality with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sharpness:ImageQuality', imageQuality_sharpness - Value representing sharpness of the face. The service returns a value
between 0 and 100 (inclusive). A higher value indicates a sharper face
image.
$sel:brightness:ImageQuality', imageQuality_brightness - Value representing brightness of the face. The service returns a value
between 0 and 100 (inclusive). A higher value indicates a brighter face
image.
Instance
An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).
See: newInstance smart constructor.
Constructors
| Instance' (Maybe BoundingBox) (Maybe Double) |
Instances
| Eq Instance Source # | |
| Read Instance Source # | |
| Show Instance Source # | |
| Generic Instance Source # | |
| NFData Instance Source # | |
Defined in Amazonka.Rekognition.Types.Instance | |
| Hashable Instance Source # | |
Defined in Amazonka.Rekognition.Types.Instance | |
| FromJSON Instance Source # | |
| type Rep Instance Source # | |
Defined in Amazonka.Rekognition.Types.Instance type Rep Instance = D1 ('MetaData "Instance" "Amazonka.Rekognition.Types.Instance" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Instance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "boundingBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoundingBox)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
newInstance :: Instance Source #
Create a value of Instance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:Instance', instance_boundingBox - The position of the label instance on the image.
$sel:confidence:Instance', instance_confidence - The confidence that Amazon Rekognition has in the accuracy of the
bounding box.
KinesisDataStream
data KinesisDataStream Source #
The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
See: newKinesisDataStream smart constructor.
Constructors
| KinesisDataStream' (Maybe Text) |
Instances
newKinesisDataStream :: KinesisDataStream Source #
Create a value of KinesisDataStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:KinesisDataStream', kinesisDataStream_arn - ARN of the output Amazon Kinesis Data Streams stream.
KinesisVideoStream
data KinesisVideoStream Source #
Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
See: newKinesisVideoStream smart constructor.
Constructors
| KinesisVideoStream' (Maybe Text) |
Instances
newKinesisVideoStream :: KinesisVideoStream Source #
Create a value of KinesisVideoStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:KinesisVideoStream', kinesisVideoStream_arn - ARN of the Kinesis video stream stream that streams the source video.
KnownGender
data KnownGender Source #
The known gender identity for the celebrity that matches the provided ID.
See: newKnownGender smart constructor.
Constructors
| KnownGender' (Maybe KnownGenderType) |
Instances
newKnownGender :: KnownGender Source #
Create a value of KnownGender with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':KnownGender', knownGender_type - A string value of the KnownGender info about the Celebrity.
Label
Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.
See: newLabel smart constructor.
Instances
| Eq Label Source # | |
| Read Label Source # | |
| Show Label Source # | |
| Generic Label Source # | |
| NFData Label Source # | |
Defined in Amazonka.Rekognition.Types.Label | |
| Hashable Label Source # | |
Defined in Amazonka.Rekognition.Types.Label | |
| FromJSON Label Source # | |
| type Rep Label Source # | |
Defined in Amazonka.Rekognition.Types.Label type Rep Label = D1 ('MetaData "Label" "Amazonka.Rekognition.Types.Label" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Label'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "parents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parent]))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Instance]))))) | |
Create a value of Label with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:confidence:Label', label_confidence - Level of confidence.
$sel:parents:Label', label_parents - The parent labels for a label. The response includes all ancestor
labels.
$sel:name:Label', label_name - The name (label) of the object or scene.
$sel:instances:Label', label_instances - If Label represents an object, Instances contains the bounding boxes
for each instance of the detected object. Bounding boxes are returned
for common object labels such as people, cars, furniture, apparel or
pets.
LabelDetection
data LabelDetection Source #
Information about a label detected in a video analysis request and the time the label was detected in the video.
See: newLabelDetection smart constructor.
Constructors
| LabelDetection' (Maybe Label) (Maybe Integer) |
Instances
newLabelDetection :: LabelDetection Source #
Create a value of LabelDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:label:LabelDetection', labelDetection_label - Details about the detected label.
$sel:timestamp:LabelDetection', labelDetection_timestamp - Time, in milliseconds from the start of the video, that the label was
detected.
Landmark
Indicates the location of the landmark on the face.
See: newLandmark smart constructor.
Instances
| Eq Landmark Source # | |
| Read Landmark Source # | |
| Show Landmark Source # | |
| Generic Landmark Source # | |
| NFData Landmark Source # | |
Defined in Amazonka.Rekognition.Types.Landmark | |
| Hashable Landmark Source # | |
Defined in Amazonka.Rekognition.Types.Landmark | |
| FromJSON Landmark Source # | |
| type Rep Landmark Source # | |
Defined in Amazonka.Rekognition.Types.Landmark type Rep Landmark = D1 ('MetaData "Landmark" "Amazonka.Rekognition.Types.Landmark" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Landmark'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LandmarkType)) :*: (S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) | |
newLandmark :: Landmark Source #
Create a value of Landmark with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':Landmark', landmark_type - Type of landmark.
$sel:x:Landmark', landmark_x - The x-coordinate of the landmark expressed as a ratio of the width of
the image. The x-coordinate is measured from the left-side of the image.
For example, if the image is 700 pixels wide and the x-coordinate of the
landmark is at 350 pixels, this value is 0.5.
$sel:y:Landmark', landmark_y - The y-coordinate of the landmark expressed as a ratio of the height of
the image. The y-coordinate is measured from the top of the image. For
example, if the image height is 200 pixels and the y-coordinate of the
landmark is at 50 pixels, this value is 0.25.
ModerationLabel
data ModerationLabel Source #
Provides information about a single type of inappropriate, unwanted, or offensive content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Content moderation in the Amazon Rekognition Developer Guide.
See: newModerationLabel smart constructor.
Instances
newModerationLabel :: ModerationLabel Source #
Create a value of ModerationLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:confidence:ModerationLabel', moderationLabel_confidence - Specifies the confidence that Amazon Rekognition has that the label has
been correctly identified.
If you don't specify the MinConfidence parameter in the call to
DetectModerationLabels, the operation returns labels with a confidence
value greater than or equal to 50 percent.
$sel:name:ModerationLabel', moderationLabel_name - The label name for the type of unsafe content detected in the image.
$sel:parentName:ModerationLabel', moderationLabel_parentName - The name for the parent label. Labels at the top level of the hierarchy
have the parent label "".
MouthOpen
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
See: newMouthOpen smart constructor.
Constructors
| MouthOpen' (Maybe Bool) (Maybe Double) |
Instances
| Eq MouthOpen Source # | |
| Read MouthOpen Source # | |
| Show MouthOpen Source # | |
| Generic MouthOpen Source # | |
| NFData MouthOpen Source # | |
Defined in Amazonka.Rekognition.Types.MouthOpen | |
| Hashable MouthOpen Source # | |
Defined in Amazonka.Rekognition.Types.MouthOpen | |
| FromJSON MouthOpen Source # | |
| type Rep MouthOpen Source # | |
Defined in Amazonka.Rekognition.Types.MouthOpen type Rep MouthOpen = D1 ('MetaData "MouthOpen" "Amazonka.Rekognition.Types.MouthOpen" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "MouthOpen'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
newMouthOpen :: MouthOpen Source #
Create a value of MouthOpen with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:MouthOpen', mouthOpen_value - Boolean value that indicates whether the mouth on the face is open or
not.
$sel:confidence:MouthOpen', mouthOpen_confidence - Level of confidence in the determination.
Mustache
Indicates whether or not the face has a mustache, and the confidence level in the determination.
See: newMustache smart constructor.
Instances
| Eq Mustache Source # | |
| Read Mustache Source # | |
| Show Mustache Source # | |
| Generic Mustache Source # | |
| NFData Mustache Source # | |
Defined in Amazonka.Rekognition.Types.Mustache | |
| Hashable Mustache Source # | |
Defined in Amazonka.Rekognition.Types.Mustache | |
| FromJSON Mustache Source # | |
| type Rep Mustache Source # | |
Defined in Amazonka.Rekognition.Types.Mustache type Rep Mustache = D1 ('MetaData "Mustache" "Amazonka.Rekognition.Types.Mustache" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Mustache'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
newMustache :: Mustache Source #
Create a value of Mustache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Mustache', mustache_value - Boolean value that indicates whether the face has mustache or not.
$sel:confidence:Mustache', mustache_confidence - Level of confidence in the determination.
NotificationChannel
data NotificationChannel Source #
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.
See: newNotificationChannel smart constructor.
Constructors
| NotificationChannel' Text Text |
Instances
newNotificationChannel Source #
Arguments
| :: Text | |
| -> Text | |
| -> NotificationChannel |
Create a value of NotificationChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sNSTopicArn:NotificationChannel', notificationChannel_sNSTopicArn - The Amazon SNS topic to which Amazon Rekognition to posts the completion
status.
$sel:roleArn:NotificationChannel', notificationChannel_roleArn - The ARN of an IAM role that gives Amazon Rekognition publishing
permissions to the Amazon SNS topic.
OutputConfig
data OutputConfig Source #
The S3 bucket and folder location where training output is placed.
See: newOutputConfig smart constructor.
Constructors
| OutputConfig' (Maybe Text) (Maybe Text) |
Instances
newOutputConfig :: OutputConfig Source #
Create a value of OutputConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3KeyPrefix:OutputConfig', outputConfig_s3KeyPrefix - The prefix applied to the training output files.
$sel:s3Bucket:OutputConfig', outputConfig_s3Bucket - The S3 bucket where training output is placed.
Parent
A parent label for a label. A label can have 0, 1, or more parents.
See: newParent smart constructor.
Instances
| Eq Parent Source # | |
| Read Parent Source # | |
| Show Parent Source # | |
| Generic Parent Source # | |
| NFData Parent Source # | |
Defined in Amazonka.Rekognition.Types.Parent | |
| Hashable Parent Source # | |
Defined in Amazonka.Rekognition.Types.Parent | |
| FromJSON Parent Source # | |
| type Rep Parent Source # | |
Defined in Amazonka.Rekognition.Types.Parent | |
Create a value of Parent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Parent', parent_name - The name of the parent label.
PersonDetail
data PersonDetail Source #
Details about a person detected in a video analysis request.
See: newPersonDetail smart constructor.
Constructors
| PersonDetail' (Maybe BoundingBox) (Maybe Integer) (Maybe FaceDetail) |
Instances
newPersonDetail :: PersonDetail Source #
Create a value of PersonDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:PersonDetail', personDetail_boundingBox - Bounding box around the detected person.
$sel:index:PersonDetail', personDetail_index - Identifier for the person detected person within a video. Use to keep
track of the person throughout the video. The identifier is not stored
by Amazon Rekognition.
$sel:face:PersonDetail', personDetail_face - Face details for the detected person.
PersonDetection
data PersonDetection Source #
Details and path tracking information for a single time a person's path
is tracked in a video. Amazon Rekognition operations that track
people's paths return an array of PersonDetection objects with
elements for each time a person's path is tracked in a video.
For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.
See: newPersonDetection smart constructor.
Constructors
| PersonDetection' (Maybe PersonDetail) (Maybe Integer) |
Instances
newPersonDetection :: PersonDetection Source #
Create a value of PersonDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:person:PersonDetection', personDetection_person - Details about a person whose path was tracked in a video.
$sel:timestamp:PersonDetection', personDetection_timestamp - The time, in milliseconds from the start of the video, that the
person's path was tracked.
PersonMatch
data PersonMatch Source #
Information about a person whose face matches a face(s) in an Amazon
Rekognition collection. Includes information about the faces in the
Amazon Rekognition collection (FaceMatch), information about the person
(PersonDetail), and the time stamp for when the person was detected in a
video. An array of PersonMatch objects is returned by GetFaceSearch.
See: newPersonMatch smart constructor.
Constructors
| PersonMatch' (Maybe [FaceMatch]) (Maybe PersonDetail) (Maybe Integer) |
Instances
newPersonMatch :: PersonMatch Source #
Create a value of PersonMatch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceMatches:PersonMatch', personMatch_faceMatches - Information about the faces in the input collection that match the face
of a person in the video.
$sel:person:PersonMatch', personMatch_person - Information about the matched person.
$sel:timestamp:PersonMatch', personMatch_timestamp - The time, in milliseconds from the beginning of the video, that the
person was matched in the video.
Point
The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
An array of Point objects, Polygon, is returned by DetectText and by
DetectCustomLabels. Polygon represents a fine-grained polygon around a
detected item. For more information, see Geometry in the Amazon
Rekognition Developer Guide.
See: newPoint smart constructor.
Instances
| Eq Point Source # | |
| Read Point Source # | |
| Show Point Source # | |
| Generic Point Source # | |
| NFData Point Source # | |
Defined in Amazonka.Rekognition.Types.Point | |
| Hashable Point Source # | |
Defined in Amazonka.Rekognition.Types.Point | |
| FromJSON Point Source # | |
| type Rep Point Source # | |
Defined in Amazonka.Rekognition.Types.Point type Rep Point = D1 ('MetaData "Point" "Amazonka.Rekognition.Types.Point" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Point'" 'PrefixI 'True) (S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Point with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:x:Point', point_x - The value of the X coordinate for a point on a Polygon.
$sel:y:Point', point_y - The value of the Y coordinate for a point on a Polygon.
Pose
Indicates the pose of the face as determined by its pitch, roll, and yaw.
See: newPose smart constructor.
Instances
| Eq Pose Source # | |
| Read Pose Source # | |
| Show Pose Source # | |
| Generic Pose Source # | |
| NFData Pose Source # | |
Defined in Amazonka.Rekognition.Types.Pose | |
| Hashable Pose Source # | |
Defined in Amazonka.Rekognition.Types.Pose | |
| FromJSON Pose Source # | |
| type Rep Pose Source # | |
Defined in Amazonka.Rekognition.Types.Pose type Rep Pose = D1 ('MetaData "Pose" "Amazonka.Rekognition.Types.Pose" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Pose'" 'PrefixI 'True) (S1 ('MetaSel ('Just "yaw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "roll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "pitch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) | |
Create a value of Pose with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:yaw:Pose', pose_yaw - Value representing the face rotation on the yaw axis.
$sel:roll:Pose', pose_roll - Value representing the face rotation on the roll axis.
$sel:pitch:Pose', pose_pitch - Value representing the face rotation on the pitch axis.
ProjectDescription
data ProjectDescription Source #
A description of a Amazon Rekognition Custom Labels project.
See: newProjectDescription smart constructor.
Constructors
| ProjectDescription' (Maybe ProjectStatus) (Maybe POSIX) (Maybe Text) |
Instances
newProjectDescription :: ProjectDescription Source #
Create a value of ProjectDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ProjectDescription', projectDescription_status - The current status of the project.
$sel:creationTimestamp:ProjectDescription', projectDescription_creationTimestamp - The Unix timestamp for the date and time that the project was created.
$sel:projectArn:ProjectDescription', projectDescription_projectArn - The Amazon Resource Name (ARN) of the project.
ProjectVersionDescription
data ProjectVersionDescription Source #
The description of a version of a model.
See: newProjectVersionDescription smart constructor.
Constructors
Instances
newProjectVersionDescription :: ProjectVersionDescription Source #
Create a value of ProjectVersionDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minInferenceUnits:ProjectVersionDescription', projectVersionDescription_minInferenceUnits - The minimum number of inference units used by the model. For more
information, see StartProjectVersion.
$sel:status:ProjectVersionDescription', projectVersionDescription_status - The current status of the model version.
$sel:evaluationResult:ProjectVersionDescription', projectVersionDescription_evaluationResult - The training results. EvaluationResult is only returned if training is
successful.
$sel:manifestSummary:ProjectVersionDescription', projectVersionDescription_manifestSummary - The location of the summary manifest. The summary manifest provides
aggregate data validation results for the training and test datasets.
$sel:kmsKeyId:ProjectVersionDescription', projectVersionDescription_kmsKeyId - The identifer for the AWS Key Management Service (AWS KMS) customer
master key that was used to encrypt the model during training.
$sel:testingDataResult:ProjectVersionDescription', projectVersionDescription_testingDataResult - Contains information about the testing results.
$sel:statusMessage:ProjectVersionDescription', projectVersionDescription_statusMessage - A descriptive message for an error or warning that occurred.
$sel:creationTimestamp:ProjectVersionDescription', projectVersionDescription_creationTimestamp - The Unix datetime for the date and time that training started.
$sel:projectVersionArn:ProjectVersionDescription', projectVersionDescription_projectVersionArn - The Amazon Resource Name (ARN) of the model version.
$sel:outputConfig:ProjectVersionDescription', projectVersionDescription_outputConfig - The location where training results are saved.
$sel:billableTrainingTimeInSeconds:ProjectVersionDescription', projectVersionDescription_billableTrainingTimeInSeconds - The duration, in seconds, that the model version has been billed for
training. This value is only returned if the model version has been
successfully trained.
$sel:trainingEndTimestamp:ProjectVersionDescription', projectVersionDescription_trainingEndTimestamp - The Unix date and time that training of the model ended.
$sel:trainingDataResult:ProjectVersionDescription', projectVersionDescription_trainingDataResult - Contains information about the training results.
ProtectiveEquipmentBodyPart
data ProtectiveEquipmentBodyPart Source #
Information about a body part detected by DetectProtectiveEquipment that
contains PPE. An array of ProtectiveEquipmentBodyPart objects is
returned for each person detected by DetectProtectiveEquipment.
See: newProtectiveEquipmentBodyPart smart constructor.
Constructors
| ProtectiveEquipmentBodyPart' (Maybe [EquipmentDetection]) (Maybe Double) (Maybe BodyPart) |
Instances
newProtectiveEquipmentBodyPart :: ProtectiveEquipmentBodyPart Source #
Create a value of ProtectiveEquipmentBodyPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:equipmentDetections:ProtectiveEquipmentBodyPart', protectiveEquipmentBodyPart_equipmentDetections - An array of Personal Protective Equipment items detected around a body
part.
$sel:confidence:ProtectiveEquipmentBodyPart', protectiveEquipmentBodyPart_confidence - The confidence that Amazon Rekognition has in the detection accuracy of
the detected body part.
$sel:name:ProtectiveEquipmentBodyPart', protectiveEquipmentBodyPart_name - The detected body part.
ProtectiveEquipmentPerson
data ProtectiveEquipmentPerson Source #
A person detected by a call to DetectProtectiveEquipment. The API
returns all persons detected in the input image in an array of
ProtectiveEquipmentPerson objects.
See: newProtectiveEquipmentPerson smart constructor.
Constructors
| ProtectiveEquipmentPerson' (Maybe [ProtectiveEquipmentBodyPart]) (Maybe BoundingBox) (Maybe Double) (Maybe Natural) |
Instances
newProtectiveEquipmentPerson :: ProtectiveEquipmentPerson Source #
Create a value of ProtectiveEquipmentPerson with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bodyParts:ProtectiveEquipmentPerson', protectiveEquipmentPerson_bodyParts - An array of body parts detected on a person's body (including body
parts without PPE).
$sel:boundingBox:ProtectiveEquipmentPerson', protectiveEquipmentPerson_boundingBox - A bounding box around the detected person.
$sel:confidence:ProtectiveEquipmentPerson', protectiveEquipmentPerson_confidence - The confidence that Amazon Rekognition has that the bounding box
contains a person.
$sel:id:ProtectiveEquipmentPerson', protectiveEquipmentPerson_id - The identifier for the detected person. The identifier is only unique
for a single call to DetectProtectiveEquipment.
ProtectiveEquipmentSummarizationAttributes
data ProtectiveEquipmentSummarizationAttributes Source #
Specifies summary attributes to return from a call to
DetectProtectiveEquipment. You can specify which types of PPE to
summarize. You can also specify a minimum confidence value for
detections. Summary information is returned in the Summary
(ProtectiveEquipmentSummary) field of the response from
DetectProtectiveEquipment. The summary includes which persons in an
image were detected wearing the requested types of person protective
equipment (PPE), which persons were detected as not wearing PPE, and the
persons in which a determination could not be made. For more
information, see ProtectiveEquipmentSummary.
See: newProtectiveEquipmentSummarizationAttributes smart constructor.
Instances
newProtectiveEquipmentSummarizationAttributes Source #
Arguments
| :: Double |
|
| -> ProtectiveEquipmentSummarizationAttributes |
Create a value of ProtectiveEquipmentSummarizationAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minConfidence:ProtectiveEquipmentSummarizationAttributes', protectiveEquipmentSummarizationAttributes_minConfidence - The minimum confidence level for which you want summary information. The
confidence level applies to person detection, body part detection,
equipment detection, and body part coverage. Amazon Rekognition doesn't
return summary information with a confidence than this specified value.
There isn't a default value.
Specify a MinConfidence value that is between 50-100% as
DetectProtectiveEquipment returns predictions only where the detection
confidence is between 50% - 100%. If you specify a value that is less
than 50%, the results are the same specifying a value of 50%.
$sel:requiredEquipmentTypes:ProtectiveEquipmentSummarizationAttributes', protectiveEquipmentSummarizationAttributes_requiredEquipmentTypes - An array of personal protective equipment types for which you want
summary information. If a person is detected wearing a required
requipment type, the person's ID is added to the
PersonsWithRequiredEquipment array field returned in
ProtectiveEquipmentSummary by DetectProtectiveEquipment.
ProtectiveEquipmentSummary
data ProtectiveEquipmentSummary Source #
Summary information for required items of personal protective equipment
(PPE) detected on persons by a call to DetectProtectiveEquipment. You
specify the required type of PPE in the SummarizationAttributes
(ProtectiveEquipmentSummarizationAttributes) input parameter. The
summary includes which persons were detected wearing the required
personal protective equipment (PersonsWithRequiredEquipment), which
persons were detected as not wearing the required PPE
(PersonsWithoutRequiredEquipment), and the persons in which a
determination could not be made (PersonsIndeterminate).
To get a total for each category, use the size of the field array. For
example, to find out how many people were detected as wearing the
specified PPE, use the size of the PersonsWithRequiredEquipment array.
If you want to find out more about a person, such as the location
(BoundingBox) of the person on the image, use the person ID in each
array element. Each person ID matches the ID field of a
ProtectiveEquipmentPerson object returned in the Persons array by
DetectProtectiveEquipment.
See: newProtectiveEquipmentSummary smart constructor.
Instances
newProtectiveEquipmentSummary :: ProtectiveEquipmentSummary Source #
Create a value of ProtectiveEquipmentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:personsWithRequiredEquipment:ProtectiveEquipmentSummary', protectiveEquipmentSummary_personsWithRequiredEquipment - An array of IDs for persons who are wearing detected personal protective
equipment.
$sel:personsWithoutRequiredEquipment:ProtectiveEquipmentSummary', protectiveEquipmentSummary_personsWithoutRequiredEquipment - An array of IDs for persons who are not wearing all of the types of PPE
specified in the RequiredEquipmentTypes field of the detected personal
protective equipment.
$sel:personsIndeterminate:ProtectiveEquipmentSummary', protectiveEquipmentSummary_personsIndeterminate - An array of IDs for persons where it was not possible to determine if
they are wearing personal protective equipment.
RegionOfInterest
data RegionOfInterest Source #
Specifies a location within the frame that Rekognition checks for text.
Uses a BoundingBox object to set a region of the screen.
A word is included in the region if the word is more than half in that region. If there is more than one region, the word will be compared with all regions of the screen. Any word more than half in a region is kept in the results.
See: newRegionOfInterest smart constructor.
Constructors
| RegionOfInterest' (Maybe BoundingBox) |
Instances
newRegionOfInterest :: RegionOfInterest Source #
Create a value of RegionOfInterest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:RegionOfInterest', regionOfInterest_boundingBox - The box representing a region of interest on screen.
S3Object
Provides the S3 bucket name and object name.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.
See: newS3Object smart constructor.
Instances
| Eq S3Object Source # | |
| Read S3Object Source # | |
| Show S3Object Source # | |
| Generic S3Object Source # | |
| NFData S3Object Source # | |
Defined in Amazonka.Rekognition.Types.S3Object | |
| Hashable S3Object Source # | |
Defined in Amazonka.Rekognition.Types.S3Object | |
| ToJSON S3Object Source # | |
Defined in Amazonka.Rekognition.Types.S3Object | |
| FromJSON S3Object Source # | |
| type Rep S3Object Source # | |
Defined in Amazonka.Rekognition.Types.S3Object type Rep S3Object = D1 ('MetaData "S3Object" "Amazonka.Rekognition.Types.S3Object" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "S3Object'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newS3Object :: S3Object Source #
Create a value of S3Object with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3Object', s3Object_bucket - Name of the S3 bucket.
$sel:name:S3Object', s3Object_name - S3 object key name.
$sel:version:S3Object', s3Object_version - If the bucket is versioning enabled, you can specify the object version.
SegmentDetection
data SegmentDetection Source #
A technical cue or shot detection segment detected in a video. An array
of SegmentDetection objects containing all segments detected in a
stored video is returned by GetSegmentDetection.
See: newSegmentDetection smart constructor.
Constructors
| SegmentDetection' (Maybe TechnicalCueSegment) (Maybe Natural) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Integer) (Maybe SegmentType) (Maybe ShotSegment) (Maybe Natural) |
Instances
newSegmentDetection :: SegmentDetection Source #
Create a value of SegmentDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:technicalCueSegment:SegmentDetection', segmentDetection_technicalCueSegment - If the segment is a technical cue, contains information about the
technical cue.
$sel:endFrameNumber:SegmentDetection', segmentDetection_endFrameNumber - The frame number at the end of a video segment, using a frame index that
starts with 0.
$sel:durationSMPTE:SegmentDetection', segmentDetection_durationSMPTE - The duration of the timecode for the detected segment in SMPTE format.
$sel:endTimestampMillis:SegmentDetection', segmentDetection_endTimestampMillis - The end time of the detected segment, in milliseconds, from the start of
the video. This value is rounded down.
$sel:startTimecodeSMPTE:SegmentDetection', segmentDetection_startTimecodeSMPTE - The frame-accurate SMPTE timecode, from the start of a video, for the
start of a detected segment. StartTimecode is in HH:MM:SS:fr format
(and ;fr for drop frame-rates).
$sel:endTimecodeSMPTE:SegmentDetection', segmentDetection_endTimecodeSMPTE - The frame-accurate SMPTE timecode, from the start of a video, for the
end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and
;fr for drop frame-rates).
$sel:durationMillis:SegmentDetection', segmentDetection_durationMillis - The duration of the detected segment in milliseconds.
$sel:durationFrames:SegmentDetection', segmentDetection_durationFrames - The duration of a video segment, expressed in frames.
$sel:startTimestampMillis:SegmentDetection', segmentDetection_startTimestampMillis - The start time of the detected segment in milliseconds from the start of
the video. This value is rounded down. For example, if the actual
timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a
value of 100 millis.
$sel:type':SegmentDetection', segmentDetection_type - The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
$sel:shotSegment:SegmentDetection', segmentDetection_shotSegment - If the segment is a shot detection, contains information about the shot
detection.
$sel:startFrameNumber:SegmentDetection', segmentDetection_startFrameNumber - The frame number of the start of a video segment, using a frame index
that starts with 0.
SegmentTypeInfo
data SegmentTypeInfo Source #
Information about the type of a segment requested in a call to
StartSegmentDetection. An array of SegmentTypeInfo objects is returned
by the response from GetSegmentDetection.
See: newSegmentTypeInfo smart constructor.
Constructors
| SegmentTypeInfo' (Maybe Text) (Maybe SegmentType) |
Instances
newSegmentTypeInfo :: SegmentTypeInfo Source #
Create a value of SegmentTypeInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:modelVersion:SegmentTypeInfo', segmentTypeInfo_modelVersion - The version of the model used to detect segments.
$sel:type':SegmentTypeInfo', segmentTypeInfo_type - The type of a segment (technical cue or shot detection).
ShotSegment
data ShotSegment Source #
Information about a shot detection segment detected in a video. For more information, see SegmentDetection.
See: newShotSegment smart constructor.
Constructors
| ShotSegment' (Maybe Double) (Maybe Natural) |
Instances
newShotSegment :: ShotSegment Source #
Create a value of ShotSegment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:confidence:ShotSegment', shotSegment_confidence - The confidence that Amazon Rekognition Video has in the accuracy of the
detected segment.
$sel:index:ShotSegment', shotSegment_index - An Identifier for a shot detection segment detected in a video.
Smile
Indicates whether or not the face is smiling, and the confidence level in the determination.
See: newSmile smart constructor.
Instances
| Eq Smile Source # | |
| Read Smile Source # | |
| Show Smile Source # | |
| Generic Smile Source # | |
| NFData Smile Source # | |
Defined in Amazonka.Rekognition.Types.Smile | |
| Hashable Smile Source # | |
Defined in Amazonka.Rekognition.Types.Smile | |
| FromJSON Smile Source # | |
| type Rep Smile Source # | |
Defined in Amazonka.Rekognition.Types.Smile type Rep Smile = D1 ('MetaData "Smile" "Amazonka.Rekognition.Types.Smile" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Smile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Smile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Smile', smile_value - Boolean value that indicates whether the face is smiling or not.
$sel:confidence:Smile', smile_confidence - Level of confidence in the determination.
StartSegmentDetectionFilters
data StartSegmentDetectionFilters Source #
Filters applied to the technical cue or shot detection segments. For more information, see StartSegmentDetection.
See: newStartSegmentDetectionFilters smart constructor.
Constructors
| StartSegmentDetectionFilters' (Maybe StartTechnicalCueDetectionFilter) (Maybe StartShotDetectionFilter) |
Instances
newStartSegmentDetectionFilters :: StartSegmentDetectionFilters Source #
Create a value of StartSegmentDetectionFilters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:technicalCueFilter:StartSegmentDetectionFilters', startSegmentDetectionFilters_technicalCueFilter - Filters that are specific to technical cues.
$sel:shotFilter:StartSegmentDetectionFilters', startSegmentDetectionFilters_shotFilter - Filters that are specific to shot detections.
StartShotDetectionFilter
data StartShotDetectionFilter Source #
Filters for the shot detection segments returned by
GetSegmentDetection. For more information, see
StartSegmentDetectionFilters.
See: newStartShotDetectionFilter smart constructor.
Constructors
| StartShotDetectionFilter' (Maybe Double) |
Instances
newStartShotDetectionFilter :: StartShotDetectionFilter Source #
Create a value of StartShotDetectionFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minSegmentConfidence:StartShotDetectionFilter', startShotDetectionFilter_minSegmentConfidence - Specifies the minimum confidence that Amazon Rekognition Video must have
in order to return a detected segment. Confidence represents how certain
Amazon Rekognition is that a segment is correctly identified. 0 is the
lowest confidence. 100 is the highest confidence. Amazon Rekognition
Video doesn't return any segments with a confidence level lower than
this specified value.
If you don't specify MinSegmentConfidence, the GetSegmentDetection
returns segments with confidence values greater than or equal to 50
percent.
StartTechnicalCueDetectionFilter
data StartTechnicalCueDetectionFilter Source #
Filters for the technical segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.
See: newStartTechnicalCueDetectionFilter smart constructor.
Constructors
| StartTechnicalCueDetectionFilter' (Maybe BlackFrame) (Maybe Double) |
Instances
newStartTechnicalCueDetectionFilter :: StartTechnicalCueDetectionFilter Source #
Create a value of StartTechnicalCueDetectionFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blackFrame:StartTechnicalCueDetectionFilter', startTechnicalCueDetectionFilter_blackFrame - A filter that allows you to control the black frame detection by
specifying the black levels and pixel coverage of black pixels in a
frame. Videos can come from multiple sources, formats, and time periods,
with different standards and varying noise levels for black frames that
need to be accounted for.
$sel:minSegmentConfidence:StartTechnicalCueDetectionFilter', startTechnicalCueDetectionFilter_minSegmentConfidence - Specifies the minimum confidence that Amazon Rekognition Video must have
in order to return a detected segment. Confidence represents how certain
Amazon Rekognition is that a segment is correctly identified. 0 is the
lowest confidence. 100 is the highest confidence. Amazon Rekognition
Video doesn't return any segments with a confidence level lower than
this specified value.
If you don't specify MinSegmentConfidence, GetSegmentDetection
returns segments with confidence values greater than or equal to 50
percent.
StartTextDetectionFilters
data StartTextDetectionFilters Source #
Set of optional parameters that let you set the criteria text must meet
to be included in your response. WordFilter looks at a word's height,
width and minimum confidence. RegionOfInterest lets you set a specific
region of the screen to look for text in.
See: newStartTextDetectionFilters smart constructor.
Constructors
| StartTextDetectionFilters' (Maybe [RegionOfInterest]) (Maybe DetectionFilter) |
Instances
newStartTextDetectionFilters :: StartTextDetectionFilters Source #
Create a value of StartTextDetectionFilters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionsOfInterest:StartTextDetectionFilters', startTextDetectionFilters_regionsOfInterest - Filter focusing on a certain area of the frame. Uses a BoundingBox
object to set the region of the screen.
$sel:wordFilter:StartTextDetectionFilters', startTextDetectionFilters_wordFilter - Filters focusing on qualities of the text, such as confidence or size.
StreamProcessor
data StreamProcessor Source #
An object that recognizes faces in a streaming video. An Amazon
Rekognition stream processor is created by a call to
CreateStreamProcessor. The request parameters for
CreateStreamProcessor describe the Kinesis video stream source for the
streaming video, face recognition parameters, and where to stream the
analysis resullts.
See: newStreamProcessor smart constructor.
Constructors
| StreamProcessor' (Maybe StreamProcessorStatus) (Maybe Text) |
Instances
newStreamProcessor :: StreamProcessor Source #
Create a value of StreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:StreamProcessor', streamProcessor_status - Current status of the Amazon Rekognition stream processor.
$sel:name:StreamProcessor', streamProcessor_name - Name of the Amazon Rekognition stream processor.
StreamProcessorInput
data StreamProcessorInput Source #
Information about the source streaming video.
See: newStreamProcessorInput smart constructor.
Constructors
| StreamProcessorInput' (Maybe KinesisVideoStream) |
Instances
newStreamProcessorInput :: StreamProcessorInput Source #
Create a value of StreamProcessorInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisVideoStream:StreamProcessorInput', streamProcessorInput_kinesisVideoStream - The Kinesis video stream input stream for the source streaming video.
StreamProcessorOutput
data StreamProcessorOutput Source #
Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
See: newStreamProcessorOutput smart constructor.
Constructors
| StreamProcessorOutput' (Maybe KinesisDataStream) |
Instances
newStreamProcessorOutput :: StreamProcessorOutput Source #
Create a value of StreamProcessorOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisDataStream:StreamProcessorOutput', streamProcessorOutput_kinesisDataStream - The Amazon Kinesis Data Streams stream to which the Amazon Rekognition
stream processor streams the analysis results.
StreamProcessorSettings
data StreamProcessorSettings Source #
Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.
See: newStreamProcessorSettings smart constructor.
Constructors
| StreamProcessorSettings' (Maybe FaceSearchSettings) |
Instances
newStreamProcessorSettings :: StreamProcessorSettings Source #
Create a value of StreamProcessorSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faceSearch:StreamProcessorSettings', streamProcessorSettings_faceSearch - Face search settings to use on a streaming video.
Summary
The S3 bucket that contains the training summary. The training summary includes aggregated evaluation metrics for the entire testing dataset and metrics for each individual label.
You get the training summary S3 bucket location by calling DescribeProjectVersions.
See: newSummary smart constructor.
Instances
| Eq Summary Source # | |
| Read Summary Source # | |
| Show Summary Source # | |
| Generic Summary Source # | |
| NFData Summary Source # | |
Defined in Amazonka.Rekognition.Types.Summary | |
| Hashable Summary Source # | |
Defined in Amazonka.Rekognition.Types.Summary | |
| FromJSON Summary Source # | |
| type Rep Summary Source # | |
Defined in Amazonka.Rekognition.Types.Summary type Rep Summary = D1 ('MetaData "Summary" "Amazonka.Rekognition.Types.Summary" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "Summary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object)))) | |
newSummary :: Summary Source #
Create a value of Summary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Object:Summary', summary_s3Object - Undocumented member.
Sunglasses
data Sunglasses Source #
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
See: newSunglasses smart constructor.
Constructors
| Sunglasses' (Maybe Bool) (Maybe Double) |
Instances
newSunglasses :: Sunglasses Source #
Create a value of Sunglasses with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Sunglasses', sunglasses_value - Boolean value that indicates whether the face is wearing sunglasses or
not.
$sel:confidence:Sunglasses', sunglasses_confidence - Level of confidence in the determination.
TechnicalCueSegment
data TechnicalCueSegment Source #
Information about a technical cue segment. For more information, see SegmentDetection.
See: newTechnicalCueSegment smart constructor.
Constructors
| TechnicalCueSegment' (Maybe Double) (Maybe TechnicalCueType) |
Instances
newTechnicalCueSegment :: TechnicalCueSegment Source #
Create a value of TechnicalCueSegment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:confidence:TechnicalCueSegment', technicalCueSegment_confidence - The confidence that Amazon Rekognition Video has in the accuracy of the
detected segment.
$sel:type':TechnicalCueSegment', technicalCueSegment_type - The type of the technical cue.
TestingData
data TestingData Source #
The dataset used for testing. Optionally, if AutoCreate is set, Amazon
Rekognition Custom Labels creates a testing dataset using an 80/20
split of the training dataset.
See: newTestingData smart constructor.
Constructors
| TestingData' (Maybe [Asset]) (Maybe Bool) |
Instances
newTestingData :: TestingData Source #
Create a value of TestingData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assets:TestingData', testingData_assets - The assets used for testing.
$sel:autoCreate:TestingData', testingData_autoCreate - If specified, Amazon Rekognition Custom Labels creates a testing dataset
with an 80/20 split of the training dataset.
TestingDataResult
data TestingDataResult Source #
Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.
See: newTestingDataResult smart constructor.
Constructors
| TestingDataResult' (Maybe TestingData) (Maybe TestingData) (Maybe ValidationData) |
Instances
newTestingDataResult :: TestingDataResult Source #
Create a value of TestingDataResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:input:TestingDataResult', testingDataResult_input - The testing dataset that was supplied for training.
$sel:output:TestingDataResult', testingDataResult_output - The subset of the dataset that was actually tested. Some images (assets)
might not be tested due to file formatting and other issues.
$sel:validation:TestingDataResult', testingDataResult_validation - The location of the data validation manifest. The data validation
manifest is created for the test dataset during model training.
TextDetection
data TextDetection Source #
Information about a word or line of text detected by DetectText.
The DetectedText field contains the text that Amazon Rekognition
detected in the image.
Every word and line has an identifier (Id). Each word belongs to a
line and has a parent identifier (ParentId) that identifies the line
of text in which the word appears. The word Id is also an index for
the word within a line of words.
For more information, see Detecting Text in the Amazon Rekognition Developer Guide.
See: newTextDetection smart constructor.
Constructors
| TextDetection' (Maybe Text) (Maybe Double) (Maybe Geometry) (Maybe Natural) (Maybe TextTypes) (Maybe Natural) |
Instances
newTextDetection :: TextDetection Source #
Create a value of TextDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detectedText:TextDetection', textDetection_detectedText - The word or line of text recognized by Amazon Rekognition.
$sel:confidence:TextDetection', textDetection_confidence - The confidence that Amazon Rekognition has in the accuracy of the
detected text and the accuracy of the geometry points around the
detected text.
$sel:geometry:TextDetection', textDetection_geometry - The location of the detected text on the image. Includes an axis aligned
coarse bounding box surrounding the text and a finer grain polygon for
more accurate spatial information.
$sel:id:TextDetection', textDetection_id - The identifier for the detected text. The identifier is only unique for
a single call to DetectText.
$sel:type':TextDetection', textDetection_type - The type of text that was detected.
$sel:parentId:TextDetection', textDetection_parentId - The Parent identifier for the detected text identified by the value of
ID. If the type of detected text is LINE, the value of ParentId is
Null.
TextDetectionResult
data TextDetectionResult Source #
Information about text detected in a video. Incudes the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
See: newTextDetectionResult smart constructor.
Constructors
| TextDetectionResult' (Maybe TextDetection) (Maybe Integer) |
Instances
newTextDetectionResult :: TextDetectionResult Source #
Create a value of TextDetectionResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textDetection:TextDetectionResult', textDetectionResult_textDetection - Details about text detected in a video.
$sel:timestamp:TextDetectionResult', textDetectionResult_timestamp - The time, in milliseconds from the start of the video, that the text was
detected.
TrainingData
data TrainingData Source #
The dataset used for training.
See: newTrainingData smart constructor.
Constructors
| TrainingData' (Maybe [Asset]) |
Instances
newTrainingData :: TrainingData Source #
Create a value of TrainingData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assets:TrainingData', trainingData_assets - A Sagemaker GroundTruth manifest file that contains the training images
(assets).
TrainingDataResult
data TrainingDataResult Source #
Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.
See: newTrainingDataResult smart constructor.
Constructors
| TrainingDataResult' (Maybe TrainingData) (Maybe TrainingData) (Maybe ValidationData) |
Instances
newTrainingDataResult :: TrainingDataResult Source #
Create a value of TrainingDataResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:input:TrainingDataResult', trainingDataResult_input - The training assets that you supplied for training.
$sel:output:TrainingDataResult', trainingDataResult_output - The images (assets) that were actually trained by Amazon Rekognition
Custom Labels.
$sel:validation:TrainingDataResult', trainingDataResult_validation - The location of the data validation manifest. The data validation
manifest is created for the training dataset during model training.
UnindexedFace
data UnindexedFace Source #
A face that IndexFaces detected, but didn't index. Use the Reasons
response attribute to determine why a face wasn't indexed.
See: newUnindexedFace smart constructor.
Constructors
| UnindexedFace' (Maybe [Reason]) (Maybe FaceDetail) |
Instances
newUnindexedFace :: UnindexedFace Source #
Create a value of UnindexedFace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reasons:UnindexedFace', unindexedFace_reasons - An array of reasons that specify why a face wasn't indexed.
- EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.
- EXCEEDS_MAX_FACES - The number of faces detected is already higher
than that specified by the
MaxFacesinput parameter forIndexFaces. - LOW_BRIGHTNESS - The image is too dark.
- LOW_SHARPNESS - The image is too blurry.
- LOW_CONFIDENCE - The face was detected with a low confidence.
- SMALL_BOUNDING_BOX - The bounding box around the face is too small.
$sel:faceDetail:UnindexedFace', unindexedFace_faceDetail - The structure that contains attributes of a face that
IndexFacesdetected, but didn't index.
ValidationData
data ValidationData Source #
Contains the Amazon S3 bucket location of the validation data for a model training job.
The validation data includes error information for individual JSON lines in the dataset. For more information, see Debugging a Failed Model Training in the Amazon Rekognition Custom Labels Developer Guide.
You get the ValidationData object for the training dataset
(TrainingDataResult) and the test dataset (TestingDataResult) by calling
DescribeProjectVersions.
The assets array contains a single Asset object. The GroundTruthManifest field of the Asset object contains the S3 bucket location of the validation data.
See: newValidationData smart constructor.
Constructors
| ValidationData' (Maybe [Asset]) |
Instances
newValidationData :: ValidationData Source #
Create a value of ValidationData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assets:ValidationData', validationData_assets - The assets that comprise the validation data.
Video
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start
operations such as StartLabelDetection use Video to specify a video
for analysis. The supported file formats are .mp4, .mov and .avi.
See: newVideo smart constructor.
Instances
| Eq Video Source # | |
| Read Video Source # | |
| Show Video Source # | |
| Generic Video Source # | |
| NFData Video Source # | |
Defined in Amazonka.Rekognition.Types.Video | |
| Hashable Video Source # | |
Defined in Amazonka.Rekognition.Types.Video | |
| ToJSON Video Source # | |
Defined in Amazonka.Rekognition.Types.Video | |
| type Rep Video Source # | |
Defined in Amazonka.Rekognition.Types.Video | |
Create a value of Video with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Object:Video', video_s3Object - The Amazon S3 bucket name and file name for the video.
VideoMetadata
data VideoMetadata Source #
Information about a video that Amazon Rekognition analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition video operation.
See: newVideoMetadata smart constructor.
Constructors
| VideoMetadata' (Maybe Double) (Maybe VideoColorRange) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) |
Instances
newVideoMetadata :: VideoMetadata Source #
Create a value of VideoMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameRate:VideoMetadata', videoMetadata_frameRate - Number of frames per second in the video.
$sel:colorRange:VideoMetadata', videoMetadata_colorRange - A description of the range of luminance values in a video, either
LIMITED (16 to 235) or FULL (0 to 255).
$sel:format:VideoMetadata', videoMetadata_format - Format of the analyzed video. Possible values are MP4, MOV and AVI.
$sel:codec:VideoMetadata', videoMetadata_codec - Type of compression used in the analyzed video.
$sel:frameHeight:VideoMetadata', videoMetadata_frameHeight - Vertical pixel dimension of the video.
$sel:durationMillis:VideoMetadata', videoMetadata_durationMillis - Length of the video in milliseconds.
$sel:frameWidth:VideoMetadata', videoMetadata_frameWidth - Horizontal pixel dimension of the video.