/AWS1/IF_KND=>CREATEEXPERIENCE()

About CreateExperience

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.

Method Signature

METHODS /AWS1/IF_KND~CREATEEXPERIENCE
  IMPORTING
    !IV_NAME TYPE /AWS1/KNDEXPERIENCENAME OPTIONAL
    !IV_INDEXID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IV_ROLEARN TYPE /AWS1/KNDROLEARN OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_KNDEXPERIENCECONF OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/KNDDESCRIPTION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/KNDCLIENTTOKENNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndcreexperiencersp
  RAISING
    /AWS1/CX_KNDACCESSDENIEDEX
    /AWS1/CX_KNDCONFLICTEXCEPTION
    /AWS1/CX_KNDINTERNALSERVEREX
    /AWS1/CX_KNDRESOURCENOTFOUNDEX
    /AWS1/CX_KNDSERVICEQUOTAEXCDEX
    /AWS1/CX_KNDTHROTTLINGEX
    /AWS1/CX_KNDVALIDATIONEX
    /AWS1/CX_KNDCLIENTEXC
    /AWS1/CX_KNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/KNDEXPERIENCENAME /AWS1/KNDEXPERIENCENAME

A name for your Amazon Kendra experience.

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index for your Amazon Kendra experience.

Optional arguments:

iv_rolearn TYPE /AWS1/KNDROLEARN /AWS1/KNDROLEARN

The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions API, and other required APIs. The role also must include permission to access IAM Identity Center that stores your user and group information. For more information, see IAM access roles for Amazon Kendra.

io_configuration TYPE REF TO /AWS1/CL_KNDEXPERIENCECONF /AWS1/CL_KNDEXPERIENCECONF

Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

A description for your Amazon Kendra experience.

iv_clienttoken TYPE /AWS1/KNDCLIENTTOKENNAME /AWS1/KNDCLIENTTOKENNAME

A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.

RETURNING

oo_output TYPE REF TO /aws1/cl_kndcreexperiencersp /AWS1/CL_KNDCREEXPERIENCERSP

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->createexperience(
  io_configuration = new /aws1/cl_kndexperienceconf(
    io_contentsourceconf = new /aws1/cl_kndcontentsourceconf(
      it_datasourceids = VALUE /aws1/cl_knddatasourceidlist_w=>tt_datasourceidlist(
        ( new /aws1/cl_knddatasourceidlist_w( |string| ) )
      )
      it_faqids = VALUE /aws1/cl_kndfaqidslist_w=>tt_faqidslist(
        ( new /aws1/cl_kndfaqidslist_w( |string| ) )
      )
      iv_directputcontent = ABAP_TRUE
    )
    io_useridentityconfiguration = new /aws1/cl_knduseridentityconf( |string| )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_indexid = |string|
  iv_name = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_experienceid = lo_result->get_id( ).
ENDIF.