DESCRIBEAGENT()`¶

About DescribeAgent¶

Describes an agent.

Method Signature¶

METHODS /AWS1/IF_QST~DESCRIBEAGENT
  IMPORTING
    !IV_AGENTID TYPE /AWS1/QSTAGENTID OPTIONAL
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdescragentresponse
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_agentid` `TYPE /AWS1/QSTAGENTID` `/AWS1/QSTAGENTID`¶

The unique identifier for the agent.

`iv_awsaccountid` `TYPE /AWS1/QSTAWSACCOUNTID` `/AWS1/QSTAWSACCOUNTID`¶

The ID of the Amazon Web Services account that contains the agent.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstdescragentresponse` `/AWS1/CL_QSTDESCRAGENTRESPONSE`¶

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->describeagent(
  iv_agentid = |string|
  iv_awsaccountid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_agent = lo_result->get_agent( ).
  IF lo_agent IS NOT INITIAL.
    LOOP AT lo_agent->get_spaces( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_arn = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_agent->get_actionconnectors( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_arn = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_agentdescription = lo_agent->get_description( ).
    lv_iconid = lo_agent->get_iconid( ).
    lv_agentname = lo_agent->get_name( ).
    LOOP AT lo_agent->get_starterprompts( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_starterprompt = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_welcomemessage = lo_agent->get_welcomemessage( ).
    lv_agentarn = lo_agent->get_arn( ).
    lv_agentid = lo_agent->get_agentid( ).
    lv_agentlifecycle = lo_agent->get_agentlifecycle( ).
    lv_agentstatus = lo_agent->get_agentstatus( ).
    lv_timestamp = lo_agent->get_createdat( ).
    lv_string = lo_agent->get_creator( ).
    lo_custompromptinterface = lo_agent->get_custompromptinterface( ).
    IF lo_custompromptinterface IS NOT INITIAL.
      lv_modelprofileid = lo_custompromptinterface->get_modelprofileid( ).
      lv_subscriptionid = lo_custompromptinterface->get_subscriptionid( ).
      lv_qbsawsaccountid = lo_custompromptinterface->get_qbsawsaccountid( ).
      lv_styledescription = lo_custompromptinterface->get_responselength( ).
      lv_styledescription = lo_custompromptinterface->get_outputstyle( ).
      lv_styledescription = lo_custompromptinterface->get_identity( ).
      lv_styledescription = lo_custompromptinterface->get_tone( ).
      lv_styledescription = lo_custompromptinterface->get_custominstructions( ).
      lv_sensitivetext = lo_custompromptinterface->get_promptsummary( ).
    ENDIF.
    lv_string = lo_agent->get_errormessage( ).
    lv_timestamp = lo_agent->get_updatedat( ).
  ENDIF.
  lv_string = lo_result->get_requestid( ).
ENDIF.

/AWS1/IF_QST=>DESCRIBEAGENT()¶