Crate rusoto_rekognition [] [src]

Amazon Rekognition

If you're using the service, you're probably looking for RekognitionClient and Rekognition.

Structs

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.

Beard

Indicates whether or not the face has a beard, and the confidence level in the determination.

BoundingBox

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 (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.

CompareFacesMatch

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.

CompareFacesRequest
CompareFacesResponse
ComparedFace

Provides face metadata for target image faces that are analysed by CompareFaces.

ComparedSourceImageFace

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.

CreateCollectionRequest
CreateCollectionResponse
DeleteCollectionRequest
DeleteCollectionResponse
DeleteFacesRequest
DeleteFacesResponse
DetectFacesRequest
DetectFacesResponse
DetectLabelsRequest
DetectLabelsResponse
DetectModerationLabelsRequest
DetectModerationLabelsResponse
Emotion

The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

EyeOpen

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

Eyeglasses

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

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.

FaceDetail

Structure containing attributes of the face that the algorithm detected.

FaceMatch

Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

FaceRecord

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.

Gender

Gender of the face and the confidence level in the determination.

Image

Provides the source 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.

ImageQuality

Identifies face image brightness and sharpness.

IndexFacesRequest
IndexFacesResponse
Label

Structure containing details about the detected label, including name, and level of confidence.

Landmark

Indicates the location of the landmark on the face.

ListCollectionsRequest
ListCollectionsResponse
ListFacesRequest
ListFacesResponse
ModerationLabel

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 howitworks-moderateimage.

MouthOpen

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

Mustache

Indicates whether or not the face has a mustache, and the confidence level in the determination.

Pose

Indicates the pose of the face as determined by its pitch, roll, and yaw.

RekognitionClient

A client for the Amazon Rekognition API.

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.

SearchFacesByImageRequest
SearchFacesByImageResponse
SearchFacesRequest
SearchFacesResponse
Smile

Indicates whether or not the face is smiling, and the confidence level in the determination.

Sunglasses

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

Enums

CompareFacesError

Errors returned by CompareFaces

CreateCollectionError

Errors returned by CreateCollection

DeleteCollectionError

Errors returned by DeleteCollection

DeleteFacesError

Errors returned by DeleteFaces

DetectFacesError

Errors returned by DetectFaces

DetectLabelsError

Errors returned by DetectLabels

DetectModerationLabelsError

Errors returned by DetectModerationLabels

IndexFacesError

Errors returned by IndexFaces

ListCollectionsError

Errors returned by ListCollections

ListFacesError

Errors returned by ListFaces

SearchFacesByImageError

Errors returned by SearchFacesByImage

SearchFacesError

Errors returned by SearchFaces

Traits

Rekognition

Trait representing the capabilities of the Amazon Rekognition API. Amazon Rekognition clients implement this trait.

Type Definitions

Attribute
Attributes
Boolean
CollectionId
CollectionIdList
CompareFacesMatchList
CompareFacesUnmatchList
Degree
EmotionName
Emotions
ExternalImageId
FaceDetailList
FaceId
FaceIdList
FaceList
FaceMatchList
FaceRecordList
Float
GenderType
ImageBlob
ImageId
Labels
LandmarkType
Landmarks
MaxFaces
ModerationLabels
OrientationCorrection
PageSize
PaginationToken
Percent
S3Bucket
S3ObjectName
S3ObjectVersion
UInteger