The AWS::Rekognition::Collection type creates a server-side container called a collection. You can use a collection
to store information about detected faces and search for known faces in images, stored videos, and streaming videos.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Rekognition::Collection",
"Properties" : {
"CollectionId" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::Rekognition::Collection
Properties:
CollectionId: String
Tags:
- Tag
Properties
CollectionId-
ID for the collection that you are creating.
Required: Yes
Type: String
Pattern:
\A[a-zA-Z0-9_\.\-]+$Maximum:
255Update requires: Replacement
-
A set of tags (key-value pairs) that you want to attach to the collection.
Required: No
Type: Array of Tag
Minimum:
0Maximum:
200Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns
the collection ID. For example:
{ "Ref": "MyCollection" }
For more information about using the Ref function, see Ref.
Fn::GetAtt
Fn::GetAtt
returns a value for a specified attribute of this type. The
following are the available attributes and sample return values. For more information about
using Fn::GetAtt, see
Fn::GetAtt.
Arn-
Returns the Amazon Resource Name of the collection.
