Menu
Amazon Rekognition
Developer Guide

CreateCollection

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.

Note

Collection names are case-sensitive.

For an example, see Example 1: Managing Collections.

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

Request Syntax

Copy
{ "CollectionId": "string" }

Request Parameters

The request accepts the following data in JSON format.

CollectionId

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

Response Syntax

Copy
{ "CollectionArn": "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.

CollectionArn

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

Type: String

StatusCode

HTTP status code indicating the result of the operation.

Type: Integer

Valid Range: Minimum value of 0.

Errors

AccessDeniedException

You are not authorized to perform the action.

HTTP Status Code: 400

InternalServerError

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

HTTP Status Code: 500

InvalidParameterException

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

HTTP Status Code: 400

ProvisionedThroughputExceededException

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

HTTP Status Code: 400

ResourceAlreadyExistsException

A collection with the specified ID already exists.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 500

Example

Example Request

The following example shows a request that creates a collection named mycollection.

Sample Request

Copy
POST https://rekognition.us-west-2.amazonaws.com/ HTTP/1.1 Host: rekognition.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 32 X-Amz-Target: RekognitionService.CreateCollection X-Amz-Date: 20170105T155520Z User-Agent: aws-cli/1.11.25 Python/2.7.9 Windows/8 botocore/1.4.82 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=XXXXXXXXXXXXXXXXXX/20170105/us-west-2/rekognition/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX {"CollectionId": "mycollection"}

Sample Response

Copy
HTTP/1.1 200 OK Content-Type: application/x-amz-json-1.1 Date: Thu, 05 Jan 2017 15:55:22 GMT x-amzn-RequestId: 5d4c8b73-d35f-11e6-96d5-039839f35287 Content-Length: 99 Connection: keep-alive { "CollectionArn":"aws:rekognition:us-west-2:11111111111:collection/mycollection", "StatusCode":200 }

See Also

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