DescribeCollection 操作請求 DescribeCollection作業回應

描述集合

您可以使用 DescribeCollection 操作，來取得下列集合的相關資訊：

編制為集合索引的臉部數。
與集合搭配使用的模型版本。如需詳細資訊，請參閱模型版本控制。
集合的 Amazon Resource Name (ARN)。
集合的建立日期和時間。

描述集合 (SDK)

如果您尚未執行：
1. 建立或更新具有 AmazonRekognitionFullAccess 許可的使用者。如需詳細資訊，請參閱步驟 1：設定 AWS 帳戶並建立使用者。
2. 安裝和設定 AWS CLI AWS 軟體開發套件。如需詳細資訊，請參閱步驟 2：設定 AWS CLI 和 AWS SDK。

使用以下範例來呼叫 DescribeCollection 操作。

Java

此範例描述一個集合。

將 collectionId 的值變更為所需集合的 ID。


//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.)

package com.amazonaws.samples;

import com.amazonaws.services.rekognition.AmazonRekognition;
import com.amazonaws.services.rekognition.AmazonRekognitionClientBuilder;
import com.amazonaws.services.rekognition.model.DescribeCollectionRequest;
import com.amazonaws.services.rekognition.model.DescribeCollectionResult;


public class DescribeCollection {

   public static void main(String[] args) throws Exception {

      String collectionId = "CollectionID";
      
      AmazonRekognition rekognitionClient = AmazonRekognitionClientBuilder.defaultClient();

            
      System.out.println("Describing collection: " +
         collectionId );
         
            
        DescribeCollectionRequest request = new DescribeCollectionRequest()
                    .withCollectionId(collectionId);
           
      DescribeCollectionResult describeCollectionResult = rekognitionClient.describeCollection(request); 
      System.out.println("Collection Arn : " +
         describeCollectionResult.getCollectionARN());
      System.out.println("Face count : " +
         describeCollectionResult.getFaceCount().toString());
      System.out.println("Face model version : " +
         describeCollectionResult.getFaceModelVersion());
      System.out.println("Created : " +
         describeCollectionResult.getCreationTimestamp().toString());

   } 

}

Java V2

此代碼取自 AWS 文檔 SDK 示例 GitHub 存儲庫。請參閱此處的完整範例。


import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.rekognition.RekognitionClient;
import software.amazon.awssdk.services.rekognition.model.DescribeCollectionRequest;
import software.amazon.awssdk.services.rekognition.model.DescribeCollectionResponse;
import software.amazon.awssdk.services.rekognition.model.RekognitionException;
//snippet-end:[rekognition.java2.describe_collection.import]

/**
* Before running this Java V2 code example, set up your development environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DescribeCollection {

 public static void main(String[] args) {

     final String usage = "\n" +
         "Usage: " +
         "   <collectionName>\n\n" +
         "Where:\n" +
         "   collectionName - The name of the Amazon Rekognition collection. \n\n";

     if (args.length != 1) {
         System.out.println(usage);
         System.exit(1);
     }

     String collectionName = args[0];
     Region region = Region.US_EAST_1;
     RekognitionClient rekClient = RekognitionClient.builder()
         .region(region)
         .credentialsProvider(ProfileCredentialsProvider.create("profile-name"))
         .build();

     describeColl(rekClient, collectionName);
     rekClient.close();
 }

 // snippet-start:[rekognition.java2.describe_collection.main]
 public static void describeColl(RekognitionClient rekClient, String collectionName) {

     try {
         DescribeCollectionRequest describeCollectionRequest = DescribeCollectionRequest.builder()
             .collectionId(collectionName)
             .build();

         DescribeCollectionResponse describeCollectionResponse = rekClient.describeCollection(describeCollectionRequest);
         System.out.println("Collection Arn : " + describeCollectionResponse.collectionARN());
         System.out.println("Created : " + describeCollectionResponse.creationTimestamp().toString());

     } catch(RekognitionException e) {
         System.out.println(e.getMessage());
         System.exit(1);
     }
 }
 // snippet-end:[rekognition.java2.describe_collection.main]
}

AWS CLI

此 AWS CLI 命令會顯示 describe-collection CLI 作業的 JSON 輸出。將 collection-id 的值變更為所需集合的 ID。將建立 Rekognition 工作階段的行中 profile_name 的值取代為您的開發人員設定檔的名稱。


aws rekognition describe-collection --collection-id collection-name --profile profile-name

Python

此範例描述一個集合。

將 collection_id 的值變更為所需集合的 ID。將建立 Rekognition 工作階段的行中 profile_name 的值取代為您的開發人員設定檔的名稱。


# 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
from botocore.exceptions import ClientError

def describe_collection(collection_id):

    print('Attempting to describe collection ' + collection_id)
    
    session = boto3.Session(profile_name='default')
    client = session.client('rekognition')
    
    try:
    response = client.describe_collection(CollectionId=collection_id)
    print("Collection Arn: " + response['CollectionARN'])
    print("Face Count: " + str(response['FaceCount']))
    print("Face Model Version: " + response['FaceModelVersion'])
    print("Timestamp: " + str(response['CreationTimestamp']))
    
    except ClientError as e:
    if e.response['Error']['Code'] == 'ResourceNotFoundException':
    print('The collection ' + collection_id + ' was not found ')
    else:
    print('Error other than Not Found occurred: ' + e.response['Error']['Message'])
    print('Done...')

def main():
    collection_id = 'collection-name'
    describe_collection(collection_id)

if __name__ == "__main__":
    main()

.NET

此範例描述一個集合。

將 collectionId 的值變更為所需集合的 ID。


//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.)

using System;
using Amazon.Rekognition;
using Amazon.Rekognition.Model;

public class DescribeCollection
{
    public static void Example()
    {
        AmazonRekognitionClient rekognitionClient = new AmazonRekognitionClient();

        String collectionId = "CollectionID";
        Console.WriteLine("Describing collection: " + collectionId);

        DescribeCollectionRequest describeCollectionRequest = new DescribeCollectionRequest()
        {
            CollectionId = collectionId
        };

        DescribeCollectionResponse describeCollectionResponse = rekognitionClient.DescribeCollection(describeCollectionRequest);
        Console.WriteLine("Collection ARN: " + describeCollectionResponse.CollectionARN);
        Console.WriteLine("Face count: " + describeCollectionResponse.FaceCount);
        Console.WriteLine("Face model version: " + describeCollectionResponse.FaceModelVersion);
        Console.WriteLine("Created: " + describeCollectionResponse.CreationTimestamp);
    }
}

Node.js


//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 { DescribeCollectionCommand } from  "@aws-sdk/client-rekognition";
import  { RekognitionClient } from "@aws-sdk/client-rekognition";
import {fromIni} from '@aws-sdk/credential-providers';

// Set the AWS Region.
const REGION = "region-name"; //e.g. "us-east-1"
// Set the profile name
const profileName = "profile-name"
// Name the collection
const rekogClient = new RekognitionClient({region: REGION, 
  credentials: fromIni({profile: profileName,}), 
});

// Name the collection
const collection_name = "collection-name"

const describeCollection = async (collectionName) => {
  try {
     console.log(`Attempting to describe collection named - ${collectionName}`)
     var response = await rekogClient.send(new DescribeCollectionCommand({CollectionId: collectionName}))
     console.log('Collection Arn:')
     console.log(response.CollectionARN)
     console.log('Face Count:')
     console.log(response.FaceCount)
     console.log('Face Model Version:')
     console.log(response.FaceModelVersion)
     console.log('Timestamp:')
     console.log(response.CreationTimestamp)
     return response; // For unit tests.
  } catch (err) {
    console.log("Error", err.stack);
  }
};

describeCollection(collection_name)

DescribeCollection 操作請求

DescribeCollection 的輸入是所需集合的 ID，如以下 JSON 範例所示。


{
    "CollectionId": "MyCollection"
}

DescribeCollection作業回應

回應包括：

編制為集合索引的臉部數，FaceCount。
與集合配合使用的面模型版本FaceModelVersion。如需詳細資訊，請參閱模型版本控制。
集合 Amazon Resource Name，CollectionARN。
集合的建立日期和時間，CreationTimestamp。CreationTimestamp 的值是 Unix epoch 時間到集合建立時所經的毫秒數。Unix epoch 時間為 1970 年 1 月 1 日周四 00:00:00 國際標準時間 (UTC)。如需詳細資訊，請參閱 Unix 時間。


{
    "CollectionARN": "arn:aws:rekognition:us-east-1:nnnnnnnnnnnn:collection/MyCollection",
    "CreationTimestamp": 1.533422155042E9,
    "FaceCount": 200,
    "UserCount" : 20,
    "FaceModelVersion": "1.0"
}

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

列出集合

刪除集合