Tagging collections - Amazon Rekognition
Add tags to a new collectionAdd tags to an existing collectionList tags in a collectionDelete tags from a collection

Tagging collections

You can identify, organize, search for, and filter Amazon Rekognition collections by using tags. Each tag is a label consisting of a user-defined key and value.

You can also use tags to control access for a collection by using Identity and Access Management (IAM). For more information, see Controlling access to AWS resources using resource tags.

Add tags to a new collection

You can add tags to a collection as you create it using the CreateCollection operation. Specify one or more tags in the Tags array input parameter.

AWS CLI

Replace the value of profile_name with the name of your developer profile. 

aws rekognition create-collection --collection-id "collection-name" --tags "{"key1":"value1","key2":"value2"}" --profile profile-name

For Windows devices:

aws rekognition create-collection --collection-id "collection-name" --tags "{\"key1\":\"value1\",\"key2\":\"value2\"}" --profile profile-name
Python

Replace the value of profile_name in the line that creates the Rekognition session with the name of your developer profile. 

import boto3

def create_collection(collection_id):
    client = boto3.client('rekognition')

    # Create a collection
    print('Creating collection:' + collection_id)
    response = client.create_collection(CollectionId=collection_id)
    print('Collection ARN: ' + response['CollectionArn'])
    print('Status code: ' + str(response['StatusCode']))
    print('Done...')

def main():
    collection_id = 'NewCollectionName'
    create_collection(collection_id)

if __name__ == "__main__":
    main()

Add tags to an existing collection

To add one or more tags to an existing collection, use the TagResource operation. Specify the collection's Amazon Resource Name (ARN) (ResourceArn) and the tags (Tags) that you want to add. The following example shows how to add two tags.

AWS CLI

Replace the value of profile_name with the name of your developer profile. 

aws rekognition tag-resource --resource-arn collection-arn --tags "{"key1":"value1","key2":"value2"}" --profile profile-name

For Windows devices: 

aws rekognition tag-resource --resource-arn collection-arn --tags "{\"key1\":\"value1\",\"key2\":\"value2\"}" --profile profile-name
Python

Replace the value of profile_name in the line that creates the Rekognition session with the name of your developer profile. 

# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
# PDX-License-Identifier: MIT-0 (For details, see https://github.com/awsdocs/amazon-rekognition-developer-guide/blob/master/LICENSE-SAMPLECODE.)

import boto3

def create_tag(collection_id):
    session = boto3.Session(profile_name='default')
    client = session.client('rekognition')
    response = client.tag_resource(ResourceArn=collection_id,
                                   Tags={
                                       "KeyName": "ValueName"
                                   })
    print(response)
    if "'HTTPStatusCode': 200" in str(response):
        print("Success!!")

def main():
    collection_arn = "collection-arn"
    create_tag(collection_arn)

if __name__ == "__main__":
    main()
Note

If you do not know the collection's Amazon Resource Name, you can use the DescribeCollection operation.

List tags in a collection

To list the tags attached to a collection, use the ListTagsForResource operation and specify the ARN of the collection (ResourceArn). The response is a map of tag keys and values that are attached to the specified collection.

AWS CLI

Replace the value of profile_name with the name of your developer profile. 

aws rekognition list-tags-for-resource --resource-arn resource-arn --profile profile-name
Python

Replace the value of profile_name in the line that creates the Rekognition session with the name of your developer profile. 

import boto3

def list_tags():
    client = boto3.client('rekognition')
    response = client.list_tags_for_resource(ResourceArn="arn:aws:rekognition:region-name:5498347593847598:collection/NewCollectionName")
    print(response)

def main():
    list_tags()

if __name__ == "__main__":
    main()

The output displays a list of tags attached to the collection:


                {
    "Tags": {
        "Dept": "Engineering",
        "Name": "Ana Silva Carolina",
        "Role": "Developer"
    }
}

Delete tags from a collection

To remove one or more tags from a collection, use the UntagResource operation. Specify the ARN of the model (ResourceArn) and the tag keys (Tag-Keys) that you want to remove.

AWS CLI

Replace the value of profile_name with the name of your developer profile.

aws rekognition untag-resource --resource-arn resource-arn --profile profile-name --tag-keys "key1" "key2"

Alternatively, you can specify tag-keys in this format:

--tag-keys key1,key2
Python

Replace the value of profile_name in the line that creates the Rekognition session with the name of your developer profile. 

import boto3

def list_tags():
    client = boto3.client('rekognition')
    response = client.untag_resource(ResourceArn="arn:aws:rekognition:region-name:5498347593847598:collection/NewCollectionName", TagKeys=['KeyName'])
    print(response)

def main():
    list_tags()

if __name__ == "__main__":
    main()