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.

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.

Collection names are case-sensitive.

For an example, see example1.

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

Note:

For PCL this operation is only available in asynchronous form. Please refer to CreateCollectionAsync.

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

Syntax

C#
public virtual CreateCollectionResponse CreateCollection(
         CreateCollectionRequest request
)
Parameters
request
Type: Amazon.Rekognition.Model.CreateCollectionRequest

Container for the necessary parameters to execute the CreateCollection service method.

Return Value
The response from the CreateCollection service method, as returned by Rekognition.

Exceptions

ExceptionCondition
AccessDeniedException You are not authorized to perform the action.
InternalServerErrorException Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException Input parameter violated a constraint. Validate your parameter before calling the API operation again.
ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceAlreadyExistsException A collection with the specified ID already exists.
ThrottlingException Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

This operation creates a Rekognition collection for storing image data.

To create a collection


var response = client.CreateCollection(new CreateCollectionRequest 
{
    CollectionId = "myphotos"
});

string collectionArn = response.CollectionArn;
integer statusCode = response.StatusCode;

            

Version Information

.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

See Also