Menu
Amazon Rekognition
Developer Guide

DeleteCollection

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Example 1: Managing Collections.

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

Request Syntax

{
   "CollectionId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

CollectionId

ID of the collection to delete.

Type: String

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

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

Required: Yes

Response Syntax

{
   "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.

StatusCode

HTTP status code that indicates 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

ResourceNotFoundException

The collection specified in the request cannot be found.

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 deletes a collection named mycollection.

Sample Request


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.DeleteCollection
X-Amz-Date: 20170105T170937Z
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=XXXXX/us-west-2/rekognition/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
   Signature=XXXXXXXXXXXXXXXX

{"CollectionId": "mycollection"}
  

Sample Response


HTTP/1.1 200 OK
Content-Type: application/x-amz-json-1.1
Date: Thu, 05 Jan 2017 17:09:39 GMT
x-amzn-RequestId: bde4e432-d369-11e6-9921-8744f72327ab
Content-Length: 18
Connection: keep-alive

{"StatusCode":200}
          

See Also

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