Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- Attribute
- EmotionName
- GenderType
- LandmarkType
- OrientationCorrection
- AgeRange
- Beard
- BoundingBox
- Celebrity
- CompareFacesMatch
- ComparedFace
- ComparedSourceImageFace
- Emotion
- EyeOpen
- Eyeglasses
- Face
- FaceDetail
- FaceMatch
- FaceRecord
- Gender
- Image
- ImageQuality
- Label
- Landmark
- ModerationLabel
- MouthOpen
- Mustache
- Pose
- S3Object
- Smile
- Sunglasses
This is the Amazon Rekognition API reference.
- rekognition :: Service
- _AccessDeniedException :: 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
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPaginationTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Rekognition.ListCollections
- module Network.AWS.Rekognition.DeleteCollection
- module Network.AWS.Rekognition.CreateCollection
- module Network.AWS.Rekognition.DetectLabels
- module Network.AWS.Rekognition.SearchFacesByImage
- module Network.AWS.Rekognition.RecognizeCelebrities
- module Network.AWS.Rekognition.SearchFaces
- module Network.AWS.Rekognition.IndexFaces
- module Network.AWS.Rekognition.CompareFaces
- module Network.AWS.Rekognition.DetectFaces
- module Network.AWS.Rekognition.ListFaces
- module Network.AWS.Rekognition.DeleteFaces
- module Network.AWS.Rekognition.GetCelebrityInfo
- module Network.AWS.Rekognition.DetectModerationLabels
- data Attribute
- data EmotionName
- data GenderType
- data LandmarkType
- = EyeLeft
- | EyeRight
- | LeftEyeBrowLeft
- | LeftEyeBrowRight
- | LeftEyeBrowUp
- | LeftEyeDown
- | LeftEyeLeft
- | LeftEyeRight
- | LeftEyeUp
- | LeftPupil
- | MouthDown
- | MouthLeft
- | MouthRight
- | MouthUp
- | Nose
- | NoseLeft
- | NoseRight
- | RightEyeBrowLeft
- | RightEyeBrowRight
- | RightEyeBrowUp
- | RightEyeDown
- | RightEyeLeft
- | RightEyeRight
- | RightEyeUp
- | RightPupil
- data OrientationCorrection
- data AgeRange
- ageRange :: AgeRange
- arLow :: Lens' AgeRange (Maybe Natural)
- arHigh :: Lens' AgeRange (Maybe Natural)
- data Beard
- beard :: Beard
- bValue :: Lens' Beard (Maybe Bool)
- bConfidence :: Lens' Beard (Maybe Double)
- data BoundingBox
- boundingBox :: BoundingBox
- bbHeight :: Lens' BoundingBox (Maybe Double)
- bbLeft :: Lens' BoundingBox (Maybe Double)
- bbWidth :: Lens' BoundingBox (Maybe Double)
- bbTop :: Lens' BoundingBox (Maybe Double)
- data Celebrity
- celebrity :: Celebrity
- cMatchConfidence :: Lens' Celebrity (Maybe Double)
- cURLs :: Lens' Celebrity [Text]
- cName :: Lens' Celebrity (Maybe Text)
- cId :: Lens' Celebrity (Maybe Text)
- cFace :: Lens' Celebrity (Maybe ComparedFace)
- data CompareFacesMatch
- compareFacesMatch :: CompareFacesMatch
- cfmSimilarity :: Lens' CompareFacesMatch (Maybe Double)
- cfmFace :: Lens' CompareFacesMatch (Maybe ComparedFace)
- data ComparedFace
- comparedFace :: ComparedFace
- cfBoundingBox :: Lens' ComparedFace (Maybe BoundingBox)
- cfPose :: Lens' ComparedFace (Maybe Pose)
- cfConfidence :: Lens' ComparedFace (Maybe Double)
- cfQuality :: Lens' ComparedFace (Maybe ImageQuality)
- cfLandmarks :: Lens' ComparedFace [Landmark]
- data ComparedSourceImageFace
- comparedSourceImageFace :: ComparedSourceImageFace
- csifBoundingBox :: Lens' ComparedSourceImageFace (Maybe BoundingBox)
- csifConfidence :: Lens' ComparedSourceImageFace (Maybe Double)
- data Emotion
- emotion :: Emotion
- eConfidence :: Lens' Emotion (Maybe Double)
- eType :: Lens' Emotion (Maybe EmotionName)
- data EyeOpen
- eyeOpen :: EyeOpen
- eoValue :: Lens' EyeOpen (Maybe Bool)
- eoConfidence :: Lens' EyeOpen (Maybe Double)
- data Eyeglasses
- eyeglasses :: Eyeglasses
- eyeValue :: Lens' Eyeglasses (Maybe Bool)
- eyeConfidence :: Lens' Eyeglasses (Maybe Double)
- data Face
- face :: Face
- fFaceId :: Lens' Face (Maybe Text)
- fBoundingBox :: Lens' Face (Maybe BoundingBox)
- fExternalImageId :: Lens' Face (Maybe Text)
- fConfidence :: Lens' Face (Maybe Double)
- fImageId :: Lens' Face (Maybe Text)
- data FaceDetail
- faceDetail :: FaceDetail
- fdAgeRange :: Lens' FaceDetail (Maybe AgeRange)
- fdSunglasses :: Lens' FaceDetail (Maybe Sunglasses)
- fdMouthOpen :: Lens' FaceDetail (Maybe MouthOpen)
- fdBoundingBox :: Lens' FaceDetail (Maybe BoundingBox)
- fdEmotions :: Lens' FaceDetail [Emotion]
- fdEyesOpen :: Lens' FaceDetail (Maybe EyeOpen)
- fdPose :: Lens' FaceDetail (Maybe Pose)
- fdConfidence :: Lens' FaceDetail (Maybe Double)
- fdGender :: Lens' FaceDetail (Maybe Gender)
- fdQuality :: Lens' FaceDetail (Maybe ImageQuality)
- fdEyeglasses :: Lens' FaceDetail (Maybe Eyeglasses)
- fdBeard :: Lens' FaceDetail (Maybe Beard)
- fdMustache :: Lens' FaceDetail (Maybe Mustache)
- fdSmile :: Lens' FaceDetail (Maybe Smile)
- fdLandmarks :: Lens' FaceDetail [Landmark]
- data FaceMatch
- faceMatch :: FaceMatch
- fmSimilarity :: Lens' FaceMatch (Maybe Double)
- fmFace :: Lens' FaceMatch (Maybe Face)
- data FaceRecord
- faceRecord :: FaceRecord
- frFaceDetail :: Lens' FaceRecord (Maybe FaceDetail)
- frFace :: Lens' FaceRecord (Maybe Face)
- data Gender
- gender :: Gender
- gValue :: Lens' Gender (Maybe GenderType)
- gConfidence :: Lens' Gender (Maybe Double)
- data Image
- image :: Image
- iS3Object :: Lens' Image (Maybe S3Object)
- iBytes :: Lens' Image (Maybe ByteString)
- data ImageQuality
- imageQuality :: ImageQuality
- iqSharpness :: Lens' ImageQuality (Maybe Double)
- iqBrightness :: Lens' ImageQuality (Maybe Double)
- data Label
- label :: Label
- lConfidence :: Lens' Label (Maybe Double)
- lName :: Lens' Label (Maybe Text)
- data Landmark
- landmark :: Landmark
- lType :: Lens' Landmark (Maybe LandmarkType)
- lX :: Lens' Landmark (Maybe Double)
- lY :: Lens' Landmark (Maybe Double)
- data ModerationLabel
- moderationLabel :: ModerationLabel
- mlConfidence :: Lens' ModerationLabel (Maybe Double)
- mlName :: Lens' ModerationLabel (Maybe Text)
- mlParentName :: Lens' ModerationLabel (Maybe Text)
- data MouthOpen
- mouthOpen :: MouthOpen
- moValue :: Lens' MouthOpen (Maybe Bool)
- moConfidence :: Lens' MouthOpen (Maybe Double)
- data Mustache
- mustache :: Mustache
- mValue :: Lens' Mustache (Maybe Bool)
- mConfidence :: Lens' Mustache (Maybe Double)
- data Pose
- pose :: Pose
- pYaw :: Lens' Pose (Maybe Double)
- pRoll :: Lens' Pose (Maybe Double)
- pPitch :: Lens' Pose (Maybe Double)
- data S3Object
- s3Object :: S3Object
- soBucket :: Lens' S3Object (Maybe Text)
- soName :: Lens' S3Object (Maybe Text)
- soVersion :: Lens' S3Object (Maybe Text)
- data Smile
- smile :: Smile
- smiValue :: Lens' Smile (Maybe Bool)
- smiConfidence :: Lens' Smile (Maybe Double)
- data Sunglasses
- sunglasses :: Sunglasses
- sValue :: Lens' Sunglasses (Maybe Bool)
- sConfidence :: Lens' Sunglasses (Maybe Double)
Service Configuration
rekognition :: 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.
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 collection 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. For more information, see limits
.
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.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Collection specified in the request is not found.
InvalidPaginationTokenException
_InvalidPaginationTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Pagination token in the request is not valid.
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.
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.
ListCollections (Paginated)
DeleteCollection
CreateCollection
DetectLabels
SearchFacesByImage
RecognizeCelebrities
SearchFaces
IndexFaces
CompareFaces
DetectFaces
ListFaces (Paginated)
DeleteFaces
GetCelebrityInfo
DetectModerationLabels
Types
Attribute
EmotionName
data EmotionName Source #
GenderType
data GenderType Source #
LandmarkType
data LandmarkType Source #
OrientationCorrection
data OrientationCorrection Source #
AgeRange
Structure containing the estimated age range, in years, for a face.
Rekognition estimates an age-range for faces detected in the input image. Estimated age ranges can overlap; a face of a 5 year old may have an estimated range of 4-6 whilst the face of a 6 year old may have an estimated range of 4-8.
See: ageRange
smart constructor.
Beard
Indicates whether or not the face has a beard, and the confidence level in the determination.
See: beard
smart constructor.
Creates a value of Beard
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bValue
- Boolean value that indicates whether the face has beard or not.bConfidence
- Level of confidence in the determination.
bValue :: Lens' Beard (Maybe Bool) Source #
Boolean value that indicates whether the face has beard or not.
BoundingBox
data BoundingBox Source #
Identifies the bounding box around the object or face. 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 (350700) and a top
value of 0.25 (50200).
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.
See: boundingBox
smart constructor.
boundingBox :: BoundingBox Source #
Creates a value of BoundingBox
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bbHeight
- Height of the bounding box as a ratio of the overall image height.bbLeft
- Left coordinate of the bounding box as a ratio of overall image width.bbWidth
- Width of the bounding box as a ratio of the overall image width.bbTop
- Top coordinate of the bounding box as a ratio of overall image height.
bbHeight :: Lens' BoundingBox (Maybe Double) Source #
Height of the bounding box as a ratio of the overall image height.
bbLeft :: Lens' BoundingBox (Maybe Double) Source #
Left coordinate of the bounding box as a ratio of overall image width.
bbWidth :: Lens' BoundingBox (Maybe Double) Source #
Width of the bounding box as a ratio of the overall image width.
bbTop :: Lens' BoundingBox (Maybe Double) Source #
Top coordinate of the bounding box as a ratio of overall image height.
Celebrity
Provides information about a celebrity recognized by the operation.
See: celebrity
smart constructor.
celebrity :: Celebrity Source #
Creates a value of Celebrity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cMatchConfidence
- The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.cURLs
- An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.cName
- The name of the celebrity.cId
- A unique identifier for the celebrity.cFace
- Provides information about the celebrity's face, such as its location on the image.
cMatchConfidence :: Lens' Celebrity (Maybe Double) Source #
The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
cURLs :: Lens' Celebrity [Text] Source #
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
cFace :: Lens' Celebrity (Maybe ComparedFace) Source #
Provides information about the celebrity's face, such as its location on the image.
CompareFacesMatch
data CompareFacesMatch Source #
Provides information about a face in a target image that matches the source image face analysed 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: compareFacesMatch
smart constructor.
compareFacesMatch :: CompareFacesMatch Source #
Creates a value of CompareFacesMatch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfmSimilarity
- Level of confidence that the faces match.cfmFace
- Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
cfmSimilarity :: Lens' CompareFacesMatch (Maybe Double) Source #
Level of confidence that the faces match.
cfmFace :: Lens' CompareFacesMatch (Maybe ComparedFace) Source #
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 analysed by CompareFaces
and RecognizeCelebrities
.
See: comparedFace
smart constructor.
comparedFace :: ComparedFace Source #
Creates a value of ComparedFace
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfBoundingBox
- Bounding box of the face.cfPose
- Indicates the pose of the face as determined by its pitch, roll, and yaw.cfConfidence
- Level of confidence that what the bounding box contains is a face.cfQuality
- Identifies face image brightness and sharpness.cfLandmarks
- An array of facial landmarks.
cfBoundingBox :: Lens' ComparedFace (Maybe BoundingBox) Source #
Bounding box of the face.
cfPose :: Lens' ComparedFace (Maybe Pose) Source #
Indicates the pose of the face as determined by its pitch, roll, and yaw.
cfConfidence :: Lens' ComparedFace (Maybe Double) Source #
Level of confidence that what the bounding box contains is a face.
cfQuality :: Lens' ComparedFace (Maybe ImageQuality) Source #
Identifies face image brightness and sharpness.
cfLandmarks :: Lens' ComparedFace [Landmark] Source #
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: comparedSourceImageFace
smart constructor.
comparedSourceImageFace :: ComparedSourceImageFace Source #
Creates a value of ComparedSourceImageFace
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csifBoundingBox
- Bounding box of the face.csifConfidence
- Confidence level that the selected bounding box contains a face.
csifBoundingBox :: Lens' ComparedSourceImageFace (Maybe BoundingBox) Source #
Bounding box of the face.
csifConfidence :: Lens' ComparedSourceImageFace (Maybe Double) Source #
Confidence level that the selected bounding box contains a face.
Emotion
The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.
See: emotion
smart constructor.
Creates a value of Emotion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eConfidence
- Level of confidence in the determination.eType
- Type of emotion detected.
EyeOpen
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
See: eyeOpen
smart constructor.
Creates a value of EyeOpen
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eoValue
- Boolean value that indicates whether the eyes on the face are open.eoConfidence
- Level of confidence in the determination.
eoValue :: Lens' EyeOpen (Maybe Bool) Source #
Boolean value that indicates whether the eyes on the face are open.
Eyeglasses
data Eyeglasses Source #
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
See: eyeglasses
smart constructor.
eyeglasses :: Eyeglasses Source #
Creates a value of Eyeglasses
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eyeValue
- Boolean value that indicates whether the face is wearing eye glasses or not.eyeConfidence
- Level of confidence in the determination.
eyeValue :: Lens' Eyeglasses (Maybe Bool) Source #
Boolean value that indicates whether the face is wearing eye glasses or not.
eyeConfidence :: Lens' Eyeglasses (Maybe Double) Source #
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: face
smart constructor.
Creates a value of Face
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fFaceId
- Unique identifier that Amazon Rekognition assigns to the face.fBoundingBox
- Bounding box of the face.fExternalImageId
- Identifier that you assign to all the faces in the input image.fConfidence
- Confidence level that the bounding box contains a face (and not a different object such as a tree).fImageId
- Unique identifier that Amazon Rekognition assigns to the input image.
fFaceId :: Lens' Face (Maybe Text) Source #
Unique identifier that Amazon Rekognition assigns to the face.
fBoundingBox :: Lens' Face (Maybe BoundingBox) Source #
Bounding box of the face.
fExternalImageId :: Lens' Face (Maybe Text) Source #
Identifier that you assign to all the faces in the input image.
fConfidence :: Lens' Face (Maybe Double) Source #
Confidence level that the bounding box contains a face (and not a different object such as a tree).
fImageId :: Lens' Face (Maybe Text) Source #
Unique identifier that Amazon Rekognition assigns to the input image.
FaceDetail
data FaceDetail Source #
Structure containing attributes of the face that the algorithm detected.
See: faceDetail
smart constructor.
faceDetail :: FaceDetail Source #
Creates a value of FaceDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fdAgeRange
- The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.fdSunglasses
- Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.fdMouthOpen
- Indicates whether or not the mouth on the face is open, and the confidence level in the determination.fdBoundingBox
- Bounding box of the face.fdEmotions
- The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.fdEyesOpen
- Indicates whether or not the eyes on the face are open, and the confidence level in the determination.fdPose
- Indicates the pose of the face as determined by its pitch, roll, and yaw.fdConfidence
- Confidence level that the bounding box contains a face (and not a different object such as a tree).fdGender
- Gender of the face and the confidence level in the determination.fdQuality
- Identifies image brightness and sharpness.fdEyeglasses
- Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.fdBeard
- Indicates whether or not the face has a beard, and the confidence level in the determination.fdMustache
- Indicates whether or not the face has a mustache, and the confidence level in the determination.fdSmile
- Indicates whether or not the face is smiling, and the confidence level in the determination.fdLandmarks
- Indicates the location of landmarks on the face.
fdAgeRange :: Lens' FaceDetail (Maybe AgeRange) Source #
The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
fdSunglasses :: Lens' FaceDetail (Maybe Sunglasses) Source #
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
fdMouthOpen :: Lens' FaceDetail (Maybe MouthOpen) Source #
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
fdBoundingBox :: Lens' FaceDetail (Maybe BoundingBox) Source #
Bounding box of the face.
fdEmotions :: Lens' FaceDetail [Emotion] Source #
The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.
fdEyesOpen :: Lens' FaceDetail (Maybe EyeOpen) Source #
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
fdPose :: Lens' FaceDetail (Maybe Pose) Source #
Indicates the pose of the face as determined by its pitch, roll, and yaw.
fdConfidence :: Lens' FaceDetail (Maybe Double) Source #
Confidence level that the bounding box contains a face (and not a different object such as a tree).
fdGender :: Lens' FaceDetail (Maybe Gender) Source #
Gender of the face and the confidence level in the determination.
fdQuality :: Lens' FaceDetail (Maybe ImageQuality) Source #
Identifies image brightness and sharpness.
fdEyeglasses :: Lens' FaceDetail (Maybe Eyeglasses) Source #
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
fdBeard :: Lens' FaceDetail (Maybe Beard) Source #
Indicates whether or not the face has a beard, and the confidence level in the determination.
fdMustache :: Lens' FaceDetail (Maybe Mustache) Source #
Indicates whether or not the face has a mustache, and the confidence level in the determination.
fdSmile :: Lens' FaceDetail (Maybe Smile) Source #
Indicates whether or not the face is smiling, and the confidence level in the determination.
fdLandmarks :: Lens' FaceDetail [Landmark] Source #
Indicates the location of landmarks on the face.
FaceMatch
Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.
See: faceMatch
smart constructor.
faceMatch :: FaceMatch Source #
Creates a value of FaceMatch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fmSimilarity
- Confidence in the match of this face with the input face.fmFace
- Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.
fmSimilarity :: Lens' FaceMatch (Maybe Double) Source #
Confidence in the match of this face with the input face.
fmFace :: Lens' FaceMatch (Maybe Face) Source #
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 back-end database) and facial attributes that are detected but aren't stored in the database.
See: faceRecord
smart constructor.
faceRecord :: FaceRecord Source #
Creates a value of FaceRecord
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
frFaceDetail
- Structure containing attributes of the face that the algorithm detected.frFace
- Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
frFaceDetail :: Lens' FaceRecord (Maybe FaceDetail) Source #
Structure containing attributes of the face that the algorithm detected.
frFace :: Lens' FaceRecord (Maybe Face) Source #
Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
Gender
Gender of the face and the confidence level in the determination.
See: gender
smart constructor.
Creates a value of Gender
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gValue
- Gender of the face.gConfidence
- Level of confidence in the determination.
Image
Provides the input image either as bytes or an S3 object.
You pass image bytes to a 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 Rekognition API operations. For more information, see example4
.
You pass images stored in an S3 bucket to a 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 Amazon 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 'manage-access-resource-policies' .
See: image
smart constructor.
Creates a value of Image
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iS3Object
- Identifies an S3 object as the image source.iBytes
- Blob of image bytes up to 5 MBs.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.
iBytes :: Lens' Image (Maybe ByteString) Source #
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: imageQuality
smart constructor.
imageQuality :: ImageQuality Source #
Creates a value of ImageQuality
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iqSharpness
- Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.iqBrightness
- Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
iqSharpness :: Lens' ImageQuality (Maybe Double) Source #
Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
iqBrightness :: Lens' ImageQuality (Maybe Double) Source #
Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
Label
Structure containing details about the detected label, including name, and level of confidence.
See: label
smart constructor.
Creates a value of Label
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lConfidence
- Level of confidence.lName
- The name (label) of the object.
Landmark
Indicates the location of the landmark on the face.
See: landmark
smart constructor.
Creates a value of Landmark
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lType
- Type of the landmark.lX
- x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.lY
- y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.
lX :: Lens' Landmark (Maybe Double) Source #
x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
lY :: Lens' Landmark (Maybe Double) Source #
y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.
ModerationLabel
data ModerationLabel Source #
Provides information about a single type of moderated content found in an image. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see 'image-moderation' .
See: moderationLabel
smart constructor.
moderationLabel :: ModerationLabel Source #
Creates a value of ModerationLabel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mlConfidence
- Specifies the confidence that Amazon Rekognition has that the label has been correctly identified. If you don't specify theMinConfidence
parameter in the call toDetectModerationLabels
, the operation returns labels with a confidence value greater than or equal to 50 percent.mlName
- The label name for the type of content detected in the image.mlParentName
- The name for the parent label. Labels at the top-level of the hierarchy have the parent label""
.
mlConfidence :: Lens' ModerationLabel (Maybe Double) Source #
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.
mlName :: Lens' ModerationLabel (Maybe Text) Source #
The label name for the type of content detected in the image.
mlParentName :: Lens' ModerationLabel (Maybe Text) Source #
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: mouthOpen
smart constructor.
mouthOpen :: MouthOpen Source #
Creates a value of MouthOpen
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
moValue
- Boolean value that indicates whether the mouth on the face is open or not.moConfidence
- Level of confidence in the determination.
moValue :: Lens' MouthOpen (Maybe Bool) Source #
Boolean value that indicates whether the mouth on the face is open or not.
Mustache
Indicates whether or not the face has a mustache, and the confidence level in the determination.
See: mustache
smart constructor.
Creates a value of Mustache
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mValue
- Boolean value that indicates whether the face has mustache or not.mConfidence
- Level of confidence in the determination.
mValue :: Lens' Mustache (Maybe Bool) Source #
Boolean value that indicates whether the face has mustache or not.
Pose
Indicates the pose of the face as determined by its pitch, roll, and yaw.
See: pose
smart constructor.
Creates a value of Pose
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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 'manage-access-resource-policies' .
See: s3Object
smart constructor.
soVersion :: Lens' S3Object (Maybe Text) Source #
If the bucket is versioning enabled, you can specify the object version.
Smile
Indicates whether or not the face is smiling, and the confidence level in the determination.
See: smile
smart constructor.
Creates a value of Smile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smiValue
- Boolean value that indicates whether the face is smiling or not.smiConfidence
- Level of confidence in the determination.
smiValue :: Lens' Smile (Maybe Bool) Source #
Boolean value that indicates whether the face is smiling or not.
Sunglasses
data Sunglasses Source #
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
See: sunglasses
smart constructor.
sunglasses :: Sunglasses Source #
Creates a value of Sunglasses
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sValue
- Boolean value that indicates whether the face is wearing sunglasses or not.sConfidence
- Level of confidence in the determination.
sValue :: Lens' Sunglasses (Maybe Bool) Source #
Boolean value that indicates whether the face is wearing sunglasses or not.
sConfidence :: Lens' Sunglasses (Maybe Double) Source #
Level of confidence in the determination.