DescribeCollection solicitud de operación DescribeCollectionrespuesta de operación

Descripción de una colección

Puede utilizar la DescribeCollectionoperación para obtener la siguiente información sobre una colección:

El número de rostros que se indexan en la colección.
La versión del modelo que se utiliza con la colección. Para obtener más información, consulte Control de versiones del modelo.
El nombre de recurso de Amazon (ARN) de la colección.
La fecha y hora de creación de la colección.

Para describir una colección (SDK)

Si aún no lo ha hecho:
1. Cree o actualice un usuario de AmazonRekognitionFullAccess con permisos. Para obtener más información, consulte Paso 1: Configurar una cuenta de AWS y crear un usuario.
2. Instale y configure los SDK AWS CLI y los AWS SDK. Para obtener más información, consulte Paso 2: Configurar los SDK AWS CLI y AWS.

Consulte los siguientes ejemplos para llamar a la operación DescribeCollection.

Java

Este ejemplo describe una colección.

Cambie el valor collectionId por el ID de la colección deseada.


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

Este código se ha tomado del GitHub repositorio de ejemplos del SDK de AWS documentación. Consulte el ejemplo completo aquí.


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

Este AWS CLI comando muestra el resultado JSON de la operación describe-collection CLI. Cambie el valor de collection-id por el ID de la colección deseada. Sustituya el valor de profile_name en la línea que crea la sesión de Rekognition por el nombre de su perfil de desarrollador.


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

Python

Este ejemplo describe una colección.

Cambie el valor collection_id por el ID de la colección deseada. Sustituya el valor de profile_name en la línea que crea la sesión de Rekognition por el nombre de su perfil de desarrollador.


# 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

Este ejemplo describe una colección.

Cambie el valor collectionId por el ID de la colección deseada.


//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 solicitud de operación

La entrada de DescribeCollection es el ID de la colección deseada, tal y como se muestra en el siguiente ejemplo de JSON.


{
    "CollectionId": "MyCollection"
}

DescribeCollectionrespuesta de operación

La respuesta incluye:

El número de rostros que se indexan en la colección, FaceCount.
La versión del modelo facial que se utiliza con la colección, FaceModelVersion. Para obtener más información, consulte Control de versiones del modelo.
La colección del Nombre de recurso de Amazon, CollectionARN.
La fecha y hora de creación de la colección, CreationTimestamp. El valor de CreationTimestamp es el número de milisegundos desde el formato de tiempo Unix hasta la creación de la colección. El formato de tiempo Unix es 00:00:00 UTC (hora universal coordinada), jueves 1 de enero de 1970. Para obtener más información, consulte Unix Time (Tiempo Unix).


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

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Listado de colecciones

Eliminación de una colección