/AWS1/IF_BDA=>UPDATEAGENTALIAS()

About UpdateAgentAlias

Updates configurations for an alias of an agent.

Method Signature

METHODS /AWS1/IF_BDA~UPDATEAGENTALIAS
  IMPORTING
    !IV_AGENTID TYPE /AWS1/BDAID OPTIONAL
    !IV_AGENTALIASID TYPE /AWS1/BDAAGENTALIASID OPTIONAL
    !IV_AGENTALIASNAME TYPE /AWS1/BDANAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/BDADESCRIPTION OPTIONAL
    !IT_ROUTINGCONFIGURATION TYPE /AWS1/CL_BDAAGENTALIASROUTIN00=>TT_AGENTALIASROUTINGCONF OPTIONAL
    !IV_ALIASINVOCATIONSTATE TYPE /AWS1/BDAALIASINVOCATIONSTATE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdaupdagentaliasrsp
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDACONFLICTEXCEPTION
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDARESOURCENOTFOUNDEX
    /AWS1/CX_BDASERVICEQUOTAEXCDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentid TYPE /AWS1/BDAID /AWS1/BDAID

The unique identifier of the agent.

iv_agentaliasid TYPE /AWS1/BDAAGENTALIASID /AWS1/BDAAGENTALIASID

The unique identifier of the alias.

iv_agentaliasname TYPE /AWS1/BDANAME /AWS1/BDANAME

Specifies a new name for the alias.

Optional arguments:

iv_description TYPE /AWS1/BDADESCRIPTION /AWS1/BDADESCRIPTION

Specifies a new description for the alias.

it_routingconfiguration TYPE /AWS1/CL_BDAAGENTALIASROUTIN00=>TT_AGENTALIASROUTINGCONF TT_AGENTALIASROUTINGCONF

Contains details about the routing configuration of the alias.

iv_aliasinvocationstate TYPE /AWS1/BDAALIASINVOCATIONSTATE /AWS1/BDAALIASINVOCATIONSTATE

The invocation state for the agent alias. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdaupdagentaliasrsp /AWS1/CL_BDAUPDAGENTALIASRSP

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->updateagentalias(
  it_routingconfiguration = VALUE /aws1/cl_bdaagentaliasroutin00=>tt_agentaliasroutingconf(
    (
      new /aws1/cl_bdaagentaliasroutin00(
        iv_agentversion = |string|
        iv_provisionedthroughput = |string|
      )
    )
  )
  iv_agentaliasid = |string|
  iv_agentaliasname = |string|
  iv_agentid = |string|
  iv_aliasinvocationstate = |string|
  iv_description = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_agentalias = lo_result->get_agentalias( ).
  IF lo_agentalias IS NOT INITIAL.
    lv_id = lo_agentalias->get_agentid( ).
    lv_agentaliasid = lo_agentalias->get_agentaliasid( ).
    lv_name = lo_agentalias->get_agentaliasname( ).
    lv_agentaliasarn = lo_agentalias->get_agentaliasarn( ).
    lv_clienttoken = lo_agentalias->get_clienttoken( ).
    lv_description = lo_agentalias->get_description( ).
    LOOP AT lo_agentalias->get_routingconfiguration( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_version = lo_row_1->get_agentversion( ).
        lv_provisionedmodelidentif = lo_row_1->get_provisionedthroughput( ).
      ENDIF.
    ENDLOOP.
    lv_datetimestamp = lo_agentalias->get_createdat( ).
    lv_datetimestamp = lo_agentalias->get_updatedat( ).
    LOOP AT lo_agentalias->get_agentaliashistoryevents( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        LOOP AT lo_row_3->get_routingconfiguration( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_version = lo_row_1->get_agentversion( ).
            lv_provisionedmodelidentif = lo_row_1->get_provisionedthroughput( ).
          ENDIF.
        ENDLOOP.
        lv_datetimestamp = lo_row_3->get_enddate( ).
        lv_datetimestamp = lo_row_3->get_startdate( ).
      ENDIF.
    ENDLOOP.
    lv_agentaliasstatus = lo_agentalias->get_agentaliasstatus( ).
    LOOP AT lo_agentalias->get_failurereasons( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_failurereason = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_aliasinvocationstate = lo_agentalias->get_aliasinvocationstate( ).
  ENDIF.
ENDIF.