Skip to content

/AWS1/IF_QST=>UPDATEAGENT()

About UpdateAgent

Updates an existing agent.

Method Signature

METHODS /AWS1/IF_QST~UPDATEAGENT
  IMPORTING
    !IV_AGENTID TYPE /AWS1/QSTAGENTID OPTIONAL
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_NAME TYPE /AWS1/QSTAGENTNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QSTAGENTDESCRIPTION OPTIONAL
    !IV_ICONID TYPE /AWS1/QSTICONID OPTIONAL
    !IT_STARTERPROMPTS TYPE /AWS1/CL_QSTSTARTERPRMPTLIST_W=>TT_STARTERPROMPTLIST OPTIONAL
    !IV_WELCOMEMESSAGE TYPE /AWS1/QSTWELCOMEMESSAGE OPTIONAL
    !IO_CUSTOMPROMPTINPUT TYPE REF TO /AWS1/CL_QSTCUSTOMPROMPTINPUT OPTIONAL
    !IT_SPACESTOADD TYPE /AWS1/CL_QSTUPAGREQPACESTOAD00=>TT_UPDAGENTREQSPACESTOADDLIST OPTIONAL
    !IT_SPACESTOREMOVE TYPE /AWS1/CL_QSTUPAGREQPACESTORE00=>TT_UPDAGENTREQSPACESTOREMLIST OPTIONAL
    !IT_ACTIONCONNECTORSTOADD TYPE /AWS1/CL_QSTUPAGREQACTCNRSTO00=>TT_UPDAGNTREQACTCNCTRSTOADDLST OPTIONAL
    !IT_ACTIONCONNECTORSTOREMOVE TYPE /AWS1/CL_QSTUPAGREQACTCNRSTO01=>TT_UPDAGNTREQACTCNCTRSTOREMLST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstupdateagentrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /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 to update.

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

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

iv_name TYPE /AWS1/QSTAGENTNAME /AWS1/QSTAGENTNAME

The name of the agent.

Optional arguments:

iv_description TYPE /AWS1/QSTAGENTDESCRIPTION /AWS1/QSTAGENTDESCRIPTION

A description of the agent.

iv_iconid TYPE /AWS1/QSTICONID /AWS1/QSTICONID

The icon identifier for the agent.

it_starterprompts TYPE /AWS1/CL_QSTSTARTERPRMPTLIST_W=>TT_STARTERPROMPTLIST TT_STARTERPROMPTLIST

A list of starter prompts that are displayed to users when they begin interacting with the agent.

iv_welcomemessage TYPE /AWS1/QSTWELCOMEMESSAGE /AWS1/QSTWELCOMEMESSAGE

The welcome message that is displayed when a user starts a conversation with the agent.

io_custompromptinput TYPE REF TO /AWS1/CL_QSTCUSTOMPROMPTINPUT /AWS1/CL_QSTCUSTOMPROMPTINPUT

The custom prompt configuration for the agent.

it_spacestoadd TYPE /AWS1/CL_QSTUPAGREQPACESTOAD00=>TT_UPDAGENTREQSPACESTOADDLIST TT_UPDAGENTREQSPACESTOADDLIST

The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

it_spacestoremove TYPE /AWS1/CL_QSTUPAGREQPACESTORE00=>TT_UPDAGENTREQSPACESTOREMLIST TT_UPDAGENTREQSPACESTOREMLIST

The Amazon Resource Names (ARNs) of the spaces to detach from the agent.

it_actionconnectorstoadd TYPE /AWS1/CL_QSTUPAGREQACTCNRSTO00=>TT_UPDAGNTREQACTCNCTRSTOADDLST TT_UPDAGNTREQACTCNCTRSTOADDLST

The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

it_actionconnectorstoremove TYPE /AWS1/CL_QSTUPAGREQACTCNRSTO01=>TT_UPDAGNTREQACTCNCTRSTOREMLST TT_UPDAGNTREQACTCNCTRSTOREMLST

The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstupdateagentrsp /AWS1/CL_QSTUPDATEAGENTRSP

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->updateagent(
  io_custompromptinput = new /aws1/cl_qstcustompromptinput(
    io_existingprompt = new /aws1/cl_qstcustompromptpfl(
      iv_modelprofileid = |string|
      iv_qbsawsaccountid = |string|
      iv_subscriptionid = |string|
    )
    io_newprompt = new /aws1/cl_qstcustprmptinpparms(
      iv_custominstructions = |string|
      iv_identity = |string|
      iv_outputstyle = |string|
      iv_responselength = |string|
      iv_tone = |string|
    )
  )
  it_actionconnectorstoadd = VALUE /aws1/cl_qstupagreqactcnrsto00=>tt_updagntreqactcnctrstoaddlst(
    ( new /aws1/cl_qstupagreqactcnrsto00( |string| ) )
  )
  it_actionconnectorstoremove = VALUE /aws1/cl_qstupagreqactcnrsto01=>tt_updagntreqactcnctrstoremlst(
    ( new /aws1/cl_qstupagreqactcnrsto01( |string| ) )
  )
  it_spacestoadd = VALUE /aws1/cl_qstupagreqpacestoad00=>tt_updagentreqspacestoaddlist(
    ( new /aws1/cl_qstupagreqpacestoad00( |string| ) )
  )
  it_spacestoremove = VALUE /aws1/cl_qstupagreqpacestore00=>tt_updagentreqspacestoremlist(
    ( new /aws1/cl_qstupagreqpacestore00( |string| ) )
  )
  it_starterprompts = VALUE /aws1/cl_qststarterprmptlist_w=>tt_starterpromptlist(
    ( new /aws1/cl_qststarterprmptlist_w( |string| ) )
  )
  iv_agentid = |string|
  iv_awsaccountid = |string|
  iv_description = |string|
  iv_iconid = |string|
  iv_name = |string|
  iv_welcomemessage = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_agentarn = lo_result->get_arn( ).
  lv_agentid = lo_result->get_agentid( ).
  lv_agentstatus = lo_result->get_agentstatus( ).
  LOOP AT lo_result->get_failedtoaddspaces( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_errormessage( ).
      lv_string = lo_row_1->get_errorcode( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_failedtoremovespaces( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_errormessage( ).
      lv_string = lo_row_1->get_errorcode( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_failedtoaddactioncnctrs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_errormessage( ).
      lv_string = lo_row_1->get_errorcode( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_failedtoremactioncnctrs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_errormessage( ).
      lv_string = lo_row_1->get_errorcode( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_requestid( ).
ENDIF.