describe_collection

describe_collection(**kwargs)

Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_collection(
    CollectionId='string'
)

Parameters

CollectionId (string) --

[REQUIRED]

The ID of the collection to describe.

Return type

dict

Returns

Response Syntax

{
    'FaceCount': 123,
    'FaceModelVersion': 'string',
    'CollectionARN': 'string',
    'CreationTimestamp': datetime(2015, 1, 1)
}

Response Structure

• (dict) --
  • FaceCount (integer) --

    The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

  • FaceModelVersion (string) --

    The version of the face model that's used by the collection for face detection.

    For more information, see Model versioning in the Amazon Rekognition Developer Guide.

  • CollectionARN (string) --

    The Amazon Resource Name (ARN) of the collection.

  • CreationTimestamp (datetime) --

    The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

Exceptions

• Rekognition.Client.exceptions.InvalidParameterException
• Rekognition.Client.exceptions.AccessDeniedException
• Rekognition.Client.exceptions.InternalServerError
• Rekognition.Client.exceptions.ThrottlingException
• Rekognition.Client.exceptions.ProvisionedThroughputExceededException
• Rekognition.Client.exceptions.ResourceNotFoundException