C# Class Amazon.Rekognition.AmazonRekognitionClient

Implementation for accessing Rekognition This is Amazon Rekognition API guide.

Inheritance: AmazonServiceClient, IAmazonRekognition

Public Methods

Method	Description
AmazonRekognitionClient ( ) : System	Constructs AmazonRekognitionClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonRekognitionClient ( AWSCredentials credentials ) : System	Constructs AmazonRekognitionClient with AWS Credentials
AmazonRekognitionClient ( AWSCredentials credentials, AmazonRekognitionConfig clientConfig ) : System	Constructs AmazonRekognitionClient with AWS Credentials and an AmazonRekognitionClient Configuration object.
AmazonRekognitionClient ( AWSCredentials credentials, RegionEndpoint region ) : System	Constructs AmazonRekognitionClient with AWS Credentials
AmazonRekognitionClient ( AmazonRekognitionConfig config ) : System	Constructs AmazonRekognitionClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonRekognitionClient ( RegionEndpoint region ) : System	Constructs AmazonRekognitionClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System	Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key
AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonRekognitionConfig clientConfig ) : System	Constructs AmazonRekognitionClient with AWS Access Key ID, AWS Secret Key and an AmazonRekognitionClient Configuration object.
AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System	Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key
AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System	Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key
AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonRekognitionConfig clientConfig ) : System	Constructs AmazonRekognitionClient with AWS Access Key ID, AWS Secret Key and an AmazonRekognitionClient Configuration object.
AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System	Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key
BeginCompareFaces ( CompareFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the CompareFaces operation.
BeginCreateCollection ( CreateCollectionRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the CreateCollection operation.
BeginDeleteCollection ( DeleteCollectionRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DeleteCollection operation.
BeginDeleteFaces ( DeleteFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DeleteFaces operation.
BeginDetectFaces ( DetectFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DetectFaces operation.
BeginDetectLabels ( DetectLabelsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DetectLabels operation.
BeginIndexFaces ( IndexFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the IndexFaces operation.
BeginListCollections ( ListCollectionsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListCollections operation.
BeginListFaces ( ListFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListFaces operation.
BeginSearchFaces ( SearchFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the SearchFaces operation.
BeginSearchFacesByImage ( SearchFacesByImageRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the SearchFacesByImage operation.
CompareFaces ( CompareFacesRequest request ) : CompareFacesResponse	Compares a face in the source input image with each face detected in the target input image. If the source image contains multiple faces, the service detects the largest face and uses it to compare with each face detected in the target image. In response, the operation returns an array of face matches ordered by similarity score with the highest similarity scores first. For each face match, the response provides a bounding box of the face and `confidence` value (indicating the level of confidence that the bounding box contains a face). The response also provides a `similarity` score, which indicates how closely the faces match. By default, only faces with the similarity score of greater than or equal to 80% are returned in the response. You can change this value. In addition to the face matches, the response returns information about the face in the source image, including the bounding box of the face and confidence value. This is a stateless API operation. That is, the operation does not persist any data. For an example, see get-started-exercise-compare-faces This operation requires permissions to perform the `rekognition:CompareFaces` action.
CompareFacesAsync ( CompareFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the CompareFaces operation.
CreateCollection ( CreateCollectionRequest request ) : CreateCollectionResponse	Creates a collection in an AWS region. You can add faces to the collection using the operation. For example, you might create collections, one for each of your application users. A user can then index faces using the `IndexFaces` operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. For an example, see example1. This operation requires permissions to perform the `rekognition:CreateCollection` action.
CreateCollectionAsync ( CreateCollectionRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the CreateCollection operation.
DeleteCollection ( DeleteCollectionRequest request ) : DeleteCollectionResponse	Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see example1. This operation requires permissions to perform the `rekognition:DeleteCollection` action.
DeleteCollectionAsync ( DeleteCollectionRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DeleteCollection operation.
DeleteFaces ( DeleteFacesRequest request ) : DeleteFacesResponse	Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the `rekognition:DeleteFaces` action.
DeleteFacesAsync ( DeleteFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DeleteFaces operation.
DetectFaces ( DetectFacesRequest request ) : DetectFacesResponse	Detects faces within an image (JPEG or PNG) that is provided as input. For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence. This is a stateless API operation. That is, the operation does not persist any data. For an example, see get-started-exercise-detect-faces. This operation requires permissions to perform the `rekognition:DetectFaces` action.
DetectFacesAsync ( DetectFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DetectFaces operation.
DetectLabels ( DetectLabelsRequest request ) : DetectLabelsResponse	Detects instances of real-world labels within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see get-started-exercise-detect-labels. For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object. `{Name: lighthouse, Confidence: 98.4629}` `{Name: rock,Confidence: 79.2097}` `{Name: sea,Confidence: 75.061}` In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. `{Name: flower,Confidence: 99.0562}` `{Name: plant,Confidence: 99.0562}` `{Name: tulip,Confidence: 99.0562}` In this example, the detection algorithm more precisely identifies the flower as a tulip. You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify `MinConfidence` to control the confidence threshold for the labels returned. The default is 50%. You can also add the `MaxLabels` parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the `rekognition:DetectLabels` action.
DetectLabelsAsync ( DetectLabelsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DetectLabels operation.
EndCompareFaces ( IAsyncResult asyncResult ) : CompareFacesResponse	Finishes the asynchronous execution of the CompareFaces operation.
EndCreateCollection ( IAsyncResult asyncResult ) : CreateCollectionResponse	Finishes the asynchronous execution of the CreateCollection operation.
EndDeleteCollection ( IAsyncResult asyncResult ) : DeleteCollectionResponse	Finishes the asynchronous execution of the DeleteCollection operation.
EndDeleteFaces ( IAsyncResult asyncResult ) : DeleteFacesResponse	Finishes the asynchronous execution of the DeleteFaces operation.
EndDetectFaces ( IAsyncResult asyncResult ) : DetectFacesResponse	Finishes the asynchronous execution of the DetectFaces operation.
EndDetectLabels ( IAsyncResult asyncResult ) : DetectLabelsResponse	Finishes the asynchronous execution of the DetectLabels operation.
EndIndexFaces ( IAsyncResult asyncResult ) : IndexFacesResponse	Finishes the asynchronous execution of the IndexFaces operation.
EndListCollections ( IAsyncResult asyncResult ) : ListCollectionsResponse	Finishes the asynchronous execution of the ListCollections operation.
EndListFaces ( IAsyncResult asyncResult ) : ListFacesResponse	Finishes the asynchronous execution of the ListFaces operation.
EndSearchFaces ( IAsyncResult asyncResult ) : SearchFacesResponse	Finishes the asynchronous execution of the SearchFaces operation.
EndSearchFacesByImage ( IAsyncResult asyncResult ) : SearchFacesByImageResponse	Finishes the asynchronous execution of the SearchFacesByImage operation.
IndexFaces ( IndexFacesRequest request ) : IndexFacesResponse	Detects faces in the input image and adds them to the specified collection. Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations. If you provide the optional `externalImageID` for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image If you request all facial attributes (using the `detectionAttributes` parameter, Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the `IndexFaces` operation, Rekognition doesn't save duplicate face metadata. For an example, see example2. This operation requires permissions to perform the `rekognition:IndexFaces` action.
IndexFacesAsync ( IndexFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the IndexFaces operation.
ListCollections ( ListCollectionsRequest request ) : ListCollectionsResponse	Returns list of collection IDs in your account. If the result is truncated, the response also provides a `NextToken` that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see example1. This operation requires permissions to perform the `rekognition:ListCollections` action.
ListCollectionsAsync ( ListCollectionsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListCollections operation.
ListFaces ( ListFacesRequest request ) : ListFacesResponse	Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see example3. This operation requires permissions to perform the `rekognition:ListFaces` action.
ListFacesAsync ( ListFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListFaces operation.
SearchFaces ( SearchFacesRequest request ) : SearchFacesResponse	For a given input face ID, searches the specified collection for matching faces. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the `SearchFacesByImage` operation. The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a `confidence` value for each face match, indicating the confidence that the specific face matches the input face. For an example, see example3. This operation requires permissions to perform the `rekognition:SearchFaces` action.
SearchFacesAsync ( SearchFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the SearchFaces operation.
SearchFacesByImage ( SearchFacesByImageRequest request ) : SearchFacesByImageResponse	For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the API, and then use the face IDs returned in subsequent calls to the API. You can also call the `DetectFaces` API and use the bounding boxes in the response to make face crops, which then you can pass in to the `SearchFacesByImage` API. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a `similarity` indicating how similar the face is to the input face. In the response, the API also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Rekognition used for the input image. For an example, see example3. This operation requires permissions to perform the `rekognition:SearchFacesByImage` action.
SearchFacesByImageAsync ( SearchFacesByImageRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the SearchFacesByImage operation.

Protected Methods

Method	Description
CreateSigner ( ) : AbstractAWSSigner	Creates the signer for the service.
Dispose ( bool disposing ) : void	Disposes the service client.

Method Details

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonRekognitionClient ( ) : System
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Credentials

public AmazonRekognitionClient ( AWSCredentials credentials ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Credentials and an AmazonRekognitionClient Configuration object.

public AmazonRekognitionClient ( AWSCredentials credentials, AmazonRekognitionConfig clientConfig ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
clientConfig	AmazonRekognitionConfig	The AmazonRekognitionClient Configuration Object
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Credentials

public AmazonRekognitionClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
region	RegionEndpoint	The region to connect.
return	System

AmazonRekognitionClient() public method

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonRekognitionClient ( AmazonRekognitionConfig config ) : System
config	AmazonRekognitionConfig	The AmazonRekognitionClient Configuration Object
return	System

AmazonRekognitionClient() public method

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonRekognitionClient ( RegionEndpoint region ) : System
region	RegionEndpoint	The region to connect.
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key

public AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Access Key ID, AWS Secret Key and an AmazonRekognitionClient Configuration object.

public AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonRekognitionConfig clientConfig ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
clientConfig	AmazonRekognitionConfig	The AmazonRekognitionClient Configuration Object
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key

public AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
region	RegionEndpoint	The region to connect.
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key

public AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Access Key ID, AWS Secret Key and an AmazonRekognitionClient Configuration object.

public AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonRekognitionConfig clientConfig ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
clientConfig	AmazonRekognitionConfig	The AmazonRekognitionClient Configuration Object
return	System

AmazonRekognitionClient() public method

Constructs AmazonRekognitionClient with AWS Access Key ID and AWS Secret Key

public AmazonRekognitionClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
region	RegionEndpoint	The region to connect.
return	System

BeginCompareFaces() public method

Initiates the asynchronous execution of the CompareFaces operation.

public BeginCompareFaces ( CompareFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.CompareFacesRequest	Container for the necessary parameters to execute the CompareFaces operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginCreateCollection() public method

Initiates the asynchronous execution of the CreateCollection operation.

public BeginCreateCollection ( CreateCollectionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.CreateCollectionRequest	Container for the necessary parameters to execute the CreateCollection operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDeleteCollection() public method

Initiates the asynchronous execution of the DeleteCollection operation.

public BeginDeleteCollection ( DeleteCollectionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.DeleteCollectionRequest	Container for the necessary parameters to execute the DeleteCollection operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDeleteFaces() public method

Initiates the asynchronous execution of the DeleteFaces operation.

public BeginDeleteFaces ( DeleteFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.DeleteFacesRequest	Container for the necessary parameters to execute the DeleteFaces operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDetectFaces() public method

Initiates the asynchronous execution of the DetectFaces operation.

public BeginDetectFaces ( DetectFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.DetectFacesRequest	Container for the necessary parameters to execute the DetectFaces operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDetectLabels() public method

Initiates the asynchronous execution of the DetectLabels operation.

public BeginDetectLabels ( DetectLabelsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.DetectLabelsRequest	Container for the necessary parameters to execute the DetectLabels operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginIndexFaces() public method

Initiates the asynchronous execution of the IndexFaces operation.

public BeginIndexFaces ( IndexFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.IndexFacesRequest	Container for the necessary parameters to execute the IndexFaces operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListCollections() public method

Initiates the asynchronous execution of the ListCollections operation.

public BeginListCollections ( ListCollectionsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.ListCollectionsRequest	Container for the necessary parameters to execute the ListCollections operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListFaces() public method

Initiates the asynchronous execution of the ListFaces operation.

public BeginListFaces ( ListFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.ListFacesRequest	Container for the necessary parameters to execute the ListFaces operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginSearchFaces() public method

Initiates the asynchronous execution of the SearchFaces operation.

public BeginSearchFaces ( SearchFacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	SearchFacesRequest	Container for the necessary parameters to execute the SearchFaces operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginSearchFacesByImage() public method

Initiates the asynchronous execution of the SearchFacesByImage operation.

public BeginSearchFacesByImage ( SearchFacesByImageRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.Rekognition.Model.SearchFacesByImageRequest	Container for the necessary parameters to execute the SearchFacesByImage operation on AmazonRekognitionClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

CompareFaces() public method

Compares a face in the source input image with each face detected in the target input image.

If the source image contains multiple faces, the service detects the largest face and uses it to compare with each face detected in the target image.

In response, the operation returns an array of face matches ordered by similarity score with the highest similarity scores first. For each face match, the response provides a bounding box of the face and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

By default, only faces with the similarity score of greater than or equal to 80% are returned in the response. You can change this value.

In addition to the face matches, the response returns information about the face in the source image, including the bounding box of the face and confidence value.

This is a stateless API operation. That is, the operation does not persist any data.

For an example, see get-started-exercise-compare-faces

This operation requires permissions to perform the rekognition:CompareFaces action.

/// You are not authorized to perform the action. /// /// The input image size exceeds the allowed limit. For more information, see limits. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// The provided image format is not supported. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// Amazon Rekognition is unable to access the S3 object specified in the request. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public CompareFaces ( CompareFacesRequest request ) : CompareFacesResponse
request	Amazon.Rekognition.Model.CompareFacesRequest	Container for the necessary parameters to execute the CompareFaces service method.
return	Amazon.Rekognition.Model.CompareFacesResponse

CompareFacesAsync() public method

Initiates the asynchronous execution of the CompareFaces operation.

public CompareFacesAsync ( CompareFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.CompareFacesRequest	Container for the necessary parameters to execute the CompareFaces operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateCollection() public method

Creates a collection in an AWS region. You can add faces to the collection using the operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

For an example, see example1.

This operation requires permissions to perform the rekognition:CreateCollection action.

/// You are not authorized to perform the action. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// The collection with specific ID already exist. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public CreateCollection ( CreateCollectionRequest request ) : CreateCollectionResponse
request	Amazon.Rekognition.Model.CreateCollectionRequest	Container for the necessary parameters to execute the CreateCollection service method.
return	Amazon.Rekognition.Model.CreateCollectionResponse

CreateCollectionAsync() public method

Initiates the asynchronous execution of the CreateCollection operation.

public CreateCollectionAsync ( CreateCollectionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.CreateCollectionRequest	Container for the necessary parameters to execute the CreateCollection operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateSigner() protected method

Creates the signer for the service.

protected CreateSigner ( ) : AbstractAWSSigner
return	Amazon.Runtime.Internal.Auth.AbstractAWSSigner

DeleteCollection() public method

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see example1.

This operation requires permissions to perform the rekognition:DeleteCollection action.

/// You are not authorized to perform the action. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Collection specified in the request is not found. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public DeleteCollection ( DeleteCollectionRequest request ) : DeleteCollectionResponse
request	Amazon.Rekognition.Model.DeleteCollectionRequest	Container for the necessary parameters to execute the DeleteCollection service method.
return	Amazon.Rekognition.Model.DeleteCollectionResponse

DeleteCollectionAsync() public method

Initiates the asynchronous execution of the DeleteCollection operation.

public DeleteCollectionAsync ( DeleteCollectionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.DeleteCollectionRequest	Container for the necessary parameters to execute the DeleteCollection operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DeleteFaces() public method

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

This operation requires permissions to perform the rekognition:DeleteFaces action.

/// You are not authorized to perform the action. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Collection specified in the request is not found. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public DeleteFaces ( DeleteFacesRequest request ) : DeleteFacesResponse
request	Amazon.Rekognition.Model.DeleteFacesRequest	Container for the necessary parameters to execute the DeleteFaces service method.
return	Amazon.Rekognition.Model.DeleteFacesResponse

DeleteFacesAsync() public method

Initiates the asynchronous execution of the DeleteFaces operation.

public DeleteFacesAsync ( DeleteFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.DeleteFacesRequest	Container for the necessary parameters to execute the DeleteFaces operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DetectFaces() public method

Detects faces within an image (JPEG or PNG) that is provided as input.

For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc.

The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence.

This is a stateless API operation. That is, the operation does not persist any data.

For an example, see get-started-exercise-detect-faces.

This operation requires permissions to perform the rekognition:DetectFaces action.

public DetectFaces ( DetectFacesRequest request ) : DetectFacesResponse
request	Amazon.Rekognition.Model.DetectFacesRequest	Container for the necessary parameters to execute the DetectFaces service method.
return	Amazon.Rekognition.Model.DetectFacesResponse

DetectFacesAsync() public method

Initiates the asynchronous execution of the DetectFaces operation.

public DetectFacesAsync ( DetectFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.DetectFacesRequest	Container for the necessary parameters to execute the DetectFaces operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DetectLabels() public method

Detects instances of real-world labels within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see get-started-exercise-detect-labels.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels parameter to limit the number of labels returned.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

public DetectLabels ( DetectLabelsRequest request ) : DetectLabelsResponse
request	Amazon.Rekognition.Model.DetectLabelsRequest	Container for the necessary parameters to execute the DetectLabels service method.
return	Amazon.Rekognition.Model.DetectLabelsResponse

DetectLabelsAsync() public method

Initiates the asynchronous execution of the DetectLabels operation.

public DetectLabelsAsync ( DetectLabelsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.DetectLabelsRequest	Container for the necessary parameters to execute the DetectLabels operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

Dispose() protected method

Disposes the service client.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

EndCompareFaces() public method

Finishes the asynchronous execution of the CompareFaces operation.

public EndCompareFaces ( IAsyncResult asyncResult ) : CompareFacesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginCompareFaces.
return	Amazon.Rekognition.Model.CompareFacesResponse

EndCreateCollection() public method

Finishes the asynchronous execution of the CreateCollection operation.

public EndCreateCollection ( IAsyncResult asyncResult ) : CreateCollectionResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginCreateCollection.
return	Amazon.Rekognition.Model.CreateCollectionResponse

EndDeleteCollection() public method

Finishes the asynchronous execution of the DeleteCollection operation.

public EndDeleteCollection ( IAsyncResult asyncResult ) : DeleteCollectionResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDeleteCollection.
return	Amazon.Rekognition.Model.DeleteCollectionResponse

EndDeleteFaces() public method

Finishes the asynchronous execution of the DeleteFaces operation.

public EndDeleteFaces ( IAsyncResult asyncResult ) : DeleteFacesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDeleteFaces.
return	Amazon.Rekognition.Model.DeleteFacesResponse

EndDetectFaces() public method

Finishes the asynchronous execution of the DetectFaces operation.

public EndDetectFaces ( IAsyncResult asyncResult ) : DetectFacesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDetectFaces.
return	Amazon.Rekognition.Model.DetectFacesResponse

EndDetectLabels() public method

Finishes the asynchronous execution of the DetectLabels operation.

public EndDetectLabels ( IAsyncResult asyncResult ) : DetectLabelsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDetectLabels.
return	Amazon.Rekognition.Model.DetectLabelsResponse

EndIndexFaces() public method

Finishes the asynchronous execution of the IndexFaces operation.

public EndIndexFaces ( IAsyncResult asyncResult ) : IndexFacesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginIndexFaces.
return	Amazon.Rekognition.Model.IndexFacesResponse

EndListCollections() public method

Finishes the asynchronous execution of the ListCollections operation.

public EndListCollections ( IAsyncResult asyncResult ) : ListCollectionsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListCollections.
return	Amazon.Rekognition.Model.ListCollectionsResponse

EndListFaces() public method

Finishes the asynchronous execution of the ListFaces operation.

public EndListFaces ( IAsyncResult asyncResult ) : ListFacesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListFaces.
return	Amazon.Rekognition.Model.ListFacesResponse

EndSearchFaces() public method

Finishes the asynchronous execution of the SearchFaces operation.

public EndSearchFaces ( IAsyncResult asyncResult ) : SearchFacesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginSearchFaces.
return	Amazon.Rekognition.Model.SearchFacesResponse

EndSearchFacesByImage() public method

Finishes the asynchronous execution of the SearchFacesByImage operation.

public EndSearchFacesByImage ( IAsyncResult asyncResult ) : SearchFacesByImageResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginSearchFacesByImage.
return	Amazon.Rekognition.Model.SearchFacesByImageResponse

IndexFaces() public method

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.

If you provide the optional externalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image If you request all facial attributes (using the detectionAttributes parameter, Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Rekognition doesn't save duplicate face metadata.

For an example, see example2.

This operation requires permissions to perform the rekognition:IndexFaces action.

/// You are not authorized to perform the action. /// /// The input image size exceeds the allowed limit. For more information, see limits. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// The provided image format is not supported. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// Amazon Rekognition is unable to access the S3 object specified in the request. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Collection specified in the request is not found. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public IndexFaces ( IndexFacesRequest request ) : IndexFacesResponse
request	Amazon.Rekognition.Model.IndexFacesRequest	Container for the necessary parameters to execute the IndexFaces service method.
return	Amazon.Rekognition.Model.IndexFacesResponse

IndexFacesAsync() public method

Initiates the asynchronous execution of the IndexFaces operation.

public IndexFacesAsync ( IndexFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.IndexFacesRequest	Container for the necessary parameters to execute the IndexFaces operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListCollections() public method

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see example1.

This operation requires permissions to perform the rekognition:ListCollections action.

/// You are not authorized to perform the action. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// Pagination token in the request is not valid. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Collection specified in the request is not found. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public ListCollections ( ListCollectionsRequest request ) : ListCollectionsResponse
request	Amazon.Rekognition.Model.ListCollectionsRequest	Container for the necessary parameters to execute the ListCollections service method.
return	Amazon.Rekognition.Model.ListCollectionsResponse

ListCollectionsAsync() public method

Initiates the asynchronous execution of the ListCollections operation.

public ListCollectionsAsync ( ListCollectionsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.ListCollectionsRequest	Container for the necessary parameters to execute the ListCollections operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListFaces() public method

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see example3.

This operation requires permissions to perform the rekognition:ListFaces action.

public ListFaces ( ListFacesRequest request ) : ListFacesResponse
request	Amazon.Rekognition.Model.ListFacesRequest	Container for the necessary parameters to execute the ListFaces service method.
return	Amazon.Rekognition.Model.ListFacesResponse

ListFacesAsync() public method

Initiates the asynchronous execution of the ListFaces operation.

public ListFacesAsync ( ListFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.ListFacesRequest	Container for the necessary parameters to execute the ListFaces operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

SearchFaces() public method

For a given input face ID, searches the specified collection for matching faces. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see example3.

This operation requires permissions to perform the rekognition:SearchFaces action.

/// You are not authorized to perform the action. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Collection specified in the request is not found. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public SearchFaces ( SearchFacesRequest request ) : SearchFacesResponse
request	SearchFacesRequest	Container for the necessary parameters to execute the SearchFaces service method.
return	Amazon.Rekognition.Model.SearchFacesResponse

SearchFacesAsync() public method

Initiates the asynchronous execution of the SearchFaces operation.

public SearchFacesAsync ( SearchFacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	SearchFacesRequest	Container for the necessary parameters to execute the SearchFaces operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

SearchFacesByImage() public method

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the API, and then use the face IDs returned in subsequent calls to the API.

You can also call the DetectFaces API and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage API.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the API also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Rekognition used for the input image.

For an example, see example3.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

/// You are not authorized to perform the action. /// /// The input image size exceeds the allowed limit. For more information, see limits. /// /// Amazon Rekognition experienced a service issue. Try your call again. /// /// The provided image format is not supported. /// /// Input parameter violated a constraint. Validate your parameter before calling the /// API again. /// /// Amazon Rekognition is unable to access the S3 object specified in the request. /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Rekognition. /// /// Collection specified in the request is not found. /// /// Amazon Rekognition is temporarily unable to process the request. Try your call again. ///

public SearchFacesByImage ( SearchFacesByImageRequest request ) : SearchFacesByImageResponse
request	Amazon.Rekognition.Model.SearchFacesByImageRequest	Container for the necessary parameters to execute the SearchFacesByImage service method.
return	Amazon.Rekognition.Model.SearchFacesByImageResponse

SearchFacesByImageAsync() public method

Initiates the asynchronous execution of the SearchFacesByImage operation.

public SearchFacesByImageAsync ( SearchFacesByImageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.Rekognition.Model.SearchFacesByImageRequest	Container for the necessary parameters to execute the SearchFacesByImage operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task