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 AssociateFaces operation.

Inheritance Hierarchy

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

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

Syntax

C#
public class AssociateFacesResponse : AmazonWebServiceResponse

The AssociateFacesResponse type exposes the following members

Constructors

NameDescription
Public Method AssociateFacesResponse()

Properties

NameTypeDescription
Public Property AssociatedFaces System.Collections.Generic.List<Amazon.Rekognition.Model.AssociatedFace>

Gets and sets the property AssociatedFaces.

An array of AssociatedFace objects containing FaceIDs that have been successfully associated with the UserID. Returned if the AssociateFaces action is successful.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property UnsuccessfulFaceAssociations System.Collections.Generic.List<Amazon.Rekognition.Model.UnsuccessfulFaceAssociation>

Gets and sets the property UnsuccessfulFaceAssociations.

An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully associated along with the reasons. Returned if the AssociateFaces action is successful.

Public Property UserStatus Amazon.Rekognition.UserStatus

Gets and sets the property UserStatus.

The status of an update made to a UserID. Reflects if the UserID has been updated for every requested change.

Examples

This operation associates one or more faces with an existing UserID.

AssociateFaces


var client = new AmazonRekognitionClient();
var response = client.AssociateFaces(new AssociateFacesRequest 
{
    ClientRequestToken = "550e8400-e29b-41d4-a716-446655440002",
    CollectionId = "MyCollection",
    FaceIds = new List<string> {
        "f5817d37-94f6-4335-bfee-6cf79a3d806e",
        "851cb847-dccc-4fea-9309-9f4805967855",
        "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
    },
    UserId = "DemoUser",
    UserMatchThreshold = 70
});

List<AssociatedFace> associatedFaces = response.AssociatedFaces;
List<UnsuccessfulFaceAssociation> unsuccessfulFaceAssociations = response.UnsuccessfulFaceAssociations;
string userStatus = response.UserStatus;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5