CreateCollection - Amazon Rekognition


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.

Request Syntax

{ "CollectionId": "string", "Tags": { "string" : "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


ID for the collection that you are creating.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.\-]+

Required: Yes


A set of tags (key-value pairs) that you want to attach to the collection.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

Response Syntax

{ "CollectionArn": "string", "FaceModelVersion": "string", "StatusCode": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

Type: String


Version number of the face detection model associated with the collection you are creating.

Type: String


HTTP status code indicating the result of the operation.

Type: Integer

Valid Range: Minimum value of 0.


For information about the errors that are common to all actions, see Common Errors.


You are not authorized to perform the action.

HTTP Status Code: 400


Amazon Rekognition experienced a service issue. Try your call again.

HTTP Status Code: 500


Input parameter violated a constraint. Validate your parameter before calling the API operation again.

HTTP Status Code: 400


The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

HTTP Status Code: 400


A resource with the specified ID already exists.

HTTP Status Code: 400


The size of the resource exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition.

HTTP Status Code: 400


Amazon Rekognition is temporarily unable to process the request. Try your call again.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: