/AWS1/IF_CGP=>DESCRIBETERMS()

About DescribeTerms

Returns details for the requested terms documents ID. For more information, see Terms documents.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Method Signature

IMPORTING

Required arguments:

iv_termsid TYPE /AWS1/CGPTERMSIDTYPE /AWS1/CGPTERMSIDTYPE

The ID of the terms documents that you want to describe.

iv_userpoolid TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE

The ID of the user pool that contains the terms documents that you want to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_cgpdescrtermsresponse /AWS1/CL_CGPDESCRTERMSRESPONSE

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->/aws1/if_cgp~describeterms(
  iv_termsid = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_termstype = lo_result->get_terms( ).
  IF lo_termstype IS NOT INITIAL.
    lv_termsidtype = lo_termstype->get_termsid( ).
    lv_userpoolidtype = lo_termstype->get_userpoolid( ).
    lv_clientidtype = lo_termstype->get_clientid( ).
    lv_termsnametype = lo_termstype->get_termsname( ).
    lv_termssourcetype = lo_termstype->get_termssource( ).
    lv_termsenforcementtype = lo_termstype->get_enforcement( ).
    LOOP AT lo_termstype->get_links( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_linkurltype = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_datetype = lo_termstype->get_creationdate( ).
    lv_datetype = lo_termstype->get_lastmodifieddate( ).
  ENDIF.
ENDIF.