collections

Creates, updates, deletes or gets a collection resource or lists collections in a region

Overview

Name	collections
Type	Resource
Description	The AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Id	awscc.rekognition.collections

Fields

get (all properties)

Name	Datatype	Description
arn	string	The ARN of the stream processor
collection_id	string	The name of the collection
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
collection_id	string	The name of the collection
region	string	AWS region.

For more information, see AWS::Rekognition::Collection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	collections	INSERT	CollectionId, region
delete_resource	collections	DELETE	Identifier, region
update_resource	collections	UPDATE	Identifier, PatchDocument, region
list_resources	collections_list_only	SELECT	region
get_resource	collections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual collection.

SELECT
  region,
  arn,
  collection_id,
  tags
FROM awscc.rekognition.collections
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ collection_id }}';

list (identifiers only)

Lists all collections in a region.

SELECT
  region,
  collection_id
FROM awscc.rekognition.collections_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new collection resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.rekognition.collections (
  CollectionId,
  region
)
SELECT
  '{{ collection_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.rekognition.collections (
  CollectionId,
  Tags,
  region
)
SELECT
  '{{ collection_id }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: collection
  props:
    - name: collection_id
      value: '{{ collection_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a collection resource, using stack-deploy.

/*+ update */
UPDATE awscc.rekognition.collections
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ collection_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rekognition.collections
WHERE
  Identifier = '{{ collection_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the collections resource, the following permissions are required:

Create

rekognition:CreateCollection,
rekognition:DescribeCollection,
rekognition:ListTagsForResource,
rekognition:TagResource

Read

rekognition:DescribeCollection,
rekognition:ListTagsForResource

Update

rekognition:TagResource,
rekognition:UntagResource,
rekognition:DescribeCollection,
rekognition:ListTagsForResource

Delete

rekognition:DeleteCollection

List

rekognition:ListCollections