AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the IndexFaces operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Rekognition.Model.IndexFacesResponse

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class IndexFacesResponse : AmazonWebServiceResponse

The IndexFacesResponse type exposes the following members

Constructors

NameDescription
Public Method IndexFacesResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property FaceRecords System.Collections.Generic.List<Amazon.Rekognition.Model.FaceRecord>

Gets and sets the property FaceRecords.

An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property OrientationCorrection Amazon.Rekognition.OrientationCorrection

Gets and sets the property OrientationCorrection.

The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in FaceRecords represent face locations before the image orientation is corrected.

If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of OrientationCorrection is null and the bounding box coordinates in FaceRecords represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.

Examples

This operation detects faces in an image and adds them to the specified Rekognition collection.

To add a face to a collection


var response = client.IndexFaces(new IndexFacesRequest 
{
    CollectionId = "myphotos",
    DetectionAttributes = new List {
                    
    },
    ExternalImageId = "myphotoid",
    Image = new Image { S3Object = new S3Object {
        Bucket = "mybucket",
        Name = "myphoto"
    } }
});

List faceRecords = response.FaceRecords;
string orientationCorrection = response.OrientationCorrection;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms