IAmazonRekognition.CreateCollection Method (CreateCollectionRequest)

Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces 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.

When you create a collection, it is associated with the latest version of the face model version.

Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.

Note:

For .NET Core 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

public abstract CreateCollectionResponse CreateCollection(
         CreateCollectionRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.CreateCollectionRequest

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

Return Value

Type: CreateCollectionResponse

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

Exceptions

Exception	Condition
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 resource with the specified ID already exists.
ServiceQuotaExceededException	The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
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 client = new AmazonRekognitionClient();
var response = client.CreateCollection(new CreateCollectionRequest 
{
    CollectionId = "myphotos"
});

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

Version Information

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

IAmazonRekognition.CreateCollection (CreateCollectionRequest)

Method