/AWS1/IF_REK=>DESCRIBECOLLECTION()

About DescribeCollection

Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

Method Signature

METHODS /AWS1/IF_REK~DESCRIBECOLLECTION
  IMPORTING
    !IV_COLLECTIONID TYPE /AWS1/REKCOLLECTIONID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rekdescrcollresponse
  RAISING
    /AWS1/CX_REKACCESSDENIEDEX
    /AWS1/CX_REKINTERNALSERVERERR
    /AWS1/CX_REKINVALIDPARAMETEREX
    /AWS1/CX_REKPROVTHRUPUTEXCDEX
    /AWS1/CX_REKRESOURCENOTFOUNDEX
    /AWS1/CX_REKTHROTTLINGEX
    /AWS1/CX_REKCLIENTEXC
    /AWS1/CX_REKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_collectionid TYPE /AWS1/REKCOLLECTIONID /AWS1/REKCOLLECTIONID

The ID of the collection to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_rekdescrcollresponse /AWS1/CL_REKDESCRCOLLRESPONSE

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describecollection( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_ulong = lo_result->get_facecount( ).
  lv_string = lo_result->get_facemodelversion( ).
  lv_string = lo_result->get_collectionarn( ).
  lv_datetime = lo_result->get_creationtimestamp( ).
  lv_ulong = lo_result->get_usercount( ).
ENDIF.