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.
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.
Request Syntax
{ "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
{ "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.
- CollectionArn
-
Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
Type: String
- FaceModelVersion
-
Version number of the face detection model associated with the collection you are creating.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
