ListCollections
Returns list of collection IDs in your account. If the result is truncated, the
response also provides a NextToken that you can use in the subsequent request to
fetch the next set of collection IDs.
For an example, see Listing collections.
This operation requires permissions to perform the
rekognition:ListCollections action.
Request Syntax
{
"MaxResults": number,
"NextToken": "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.
- MaxResults
-
Maximum number of collection IDs to return.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 4096.
Required: No
- NextToken
-
Pagination token from the previous response.
Type: String
Length Constraints: Maximum length of 255.
Required: No
Response Syntax
{
"CollectionIds": [ "string" ],
"FaceModelVersions": [ "string" ],
"NextToken": "string"
}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.
- CollectionIds
-
An array of collection IDs.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.\-]+ - FaceModelVersions
-
Version numbers of the face detection models associated with the collections in the array
CollectionIds. For example, the value ofFaceModelVersions[2]is the version number for the face detection model used by the collection inCollectionId[2].Type: Array of strings
- NextToken
-
If the result is truncated, the response provides a
NextTokenthat you can use in the subsequent request to fetch the next set of collection IDs.Type: String
Length Constraints: Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common 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
- InvalidPaginationTokenException
-
Pagination token in the request is not valid.
HTTP Status Code: 400
- 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 resource 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
