Skip to content

/AWS1/IF_IAM=>GETHUMANREADABLESUMMARY()

About GetHumanReadableSummary

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request

This method uses a Large Language Model (LLM) to generate the summary.

If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read default permissions granted to delegation requests. These rules are identical to GetDelegationRequest API behavior, such that a party who has permissions to call GetDelegationRequest for a given delegation request will always be able to retrieve the human readable summary for that request.

Method Signature

METHODS /AWS1/IF_IAM~GETHUMANREADABLESUMMARY
  IMPORTING
    !IV_ENTITYARN TYPE /AWS1/IAMARNTYPE OPTIONAL
    !IV_LOCALE TYPE /AWS1/IAMLOCALETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iamgethumreadablesu01
  RAISING
    /AWS1/CX_IAMINVALIDINPUTEX
    /AWS1/CX_IAMNOSUCHENTITYEX
    /AWS1/CX_IAMSERVICEFAILUREEX
    /AWS1/CX_IAMCLIENTEXC
    /AWS1/CX_IAMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_entityarn TYPE /AWS1/IAMARNTYPE /AWS1/IAMARNTYPE

Arn of the entity to be summarized. At this time, the only supported entity type is delegation-request

Optional arguments:

iv_locale TYPE /AWS1/IAMLOCALETYPE /AWS1/IAMLOCALETYPE

A string representing the locale to use for the summary generation. The supported locale strings are based on the Supported languages of the Amazon Web Services Management Console .

RETURNING

oo_output TYPE REF TO /aws1/cl_iamgethumreadablesu01 /AWS1/CL_IAMGETHUMREADABLESU01

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->gethumanreadablesummary(
  iv_entityarn = |string|
  iv_locale = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_summarycontenttype = lo_result->get_summarycontent( ).
  lv_localetype = lo_result->get_locale( ).
  lv_summarystatetype = lo_result->get_summarystate( ).
ENDIF.