Skip to content

/AWS1/IF_DOA=>CREATEAGENTSPACE()

About CreateAgentSpace

Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.

Method Signature

METHODS /AWS1/IF_DOA~CREATEAGENTSPACE
  IMPORTING
    !IV_NAME TYPE /AWS1/DOAAGENTSPACENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DOADESCRIPTION OPTIONAL
    !IV_LOCALE TYPE /AWS1/DOALOCALE OPTIONAL
    !IV_KMSKEYARN TYPE /AWS1/DOAKMSKEYARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DOASTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DOATAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doacreagentspaceout
  RAISING
    /AWS1/CX_DOAACCESSDENIEDEX
    /AWS1/CX_DOACONFLICTEXCEPTION
    /AWS1/CX_DOACONTENTSIZEEXCDEX
    /AWS1/CX_DOAINTERNALSERVEREX
    /AWS1/CX_DOAINVALIDPARAMETEREX
    /AWS1/CX_DOARESOURCENOTFOUNDEX
    /AWS1/CX_DOASERVICEQUOTAEXCDEX
    /AWS1/CX_DOATHROTTLINGEX
    /AWS1/CX_DOAVLDTNEXCEPTION
    /AWS1/CX_DOACLIENTEXC
    /AWS1/CX_DOASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/DOAAGENTSPACENAME /AWS1/DOAAGENTSPACENAME

The name of the AgentSpace.

Optional arguments:

iv_description TYPE /AWS1/DOADESCRIPTION /AWS1/DOADESCRIPTION

The description of the AgentSpace.

iv_locale TYPE /AWS1/DOALOCALE /AWS1/DOALOCALE

The locale for the AgentSpace, which determines the language used in agent responses.

iv_kmskeyarn TYPE /AWS1/DOAKMSKEYARN /AWS1/DOAKMSKEYARN

The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.

iv_clienttoken TYPE /AWS1/DOASTRING /AWS1/DOASTRING

Client-provided token to ensure request idempotency. When the same token is provided in subsequent calls, the same response is returned within a 8-hour window.

it_tags TYPE /AWS1/CL_DOATAGS_W=>TT_TAGS TT_TAGS

Tags to add to the AgentSpace at creation time.

RETURNING

oo_output TYPE REF TO /aws1/cl_doacreagentspaceout /AWS1/CL_DOACREAGENTSPACEOUT

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->createagentspace(
  it_tags = VALUE /aws1/cl_doatags_w=>tt_tags(
    (
      VALUE /aws1/cl_doatags_w=>ts_tags_maprow(
        value = new /aws1/cl_doatags_w( |string| )
        key = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_kmskeyarn = |string|
  iv_locale = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_agentspace = lo_result->get_agentspace( ).
  IF lo_agentspace IS NOT INITIAL.
    lv_agentspacename = lo_agentspace->get_name( ).
    lv_description = lo_agentspace->get_description( ).
    lv_locale = lo_agentspace->get_locale( ).
    lv_timestamp = lo_agentspace->get_createdat( ).
    lv_timestamp = lo_agentspace->get_updatedat( ).
    lv_kmskeyarn = lo_agentspace->get_kmskeyarn( ).
    lv_agentspaceid = lo_agentspace->get_agentspaceid( ).
  ENDIF.
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.