Skip to content

/AWS1/IF_KND=>CREATEINDEX()

About CreateIndex

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or using one of the supported data sources.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Method Signature

METHODS /AWS1/IF_KND~CREATEINDEX
  IMPORTING
    !IV_NAME TYPE /AWS1/KNDINDEXNAME OPTIONAL
    !IV_EDITION TYPE /AWS1/KNDINDEXEDITION OPTIONAL
    !IV_ROLEARN TYPE /AWS1/KNDROLEARN OPTIONAL
    !IO_SERVERSIDEENCRYPTIONCONF TYPE REF TO /AWS1/CL_KNDSERVERSIDEENCCONF OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/KNDDESCRIPTION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/KNDCLIENTTOKENNAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_KNDTAG=>TT_TAGLIST OPTIONAL
    !IT_USERTOKENCONFIGURATIONS TYPE /AWS1/CL_KNDUSERTOKENCONF=>TT_USERTOKENCONFIGURATIONLIST OPTIONAL
    !IV_USERCONTEXTPOLICY TYPE /AWS1/KNDUSERCONTEXTPOLICY OPTIONAL
    !IO_USERGROUPRESOLUTIONCONF TYPE REF TO /AWS1/CL_KNDUSERGRRESOLUTION00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndcreateindexrsp
  RAISING
    /AWS1/CX_KNDACCESSDENIEDEX
    /AWS1/CX_KNDCONFLICTEXCEPTION
    /AWS1/CX_KNDINTERNALSERVEREX
    /AWS1/CX_KNDRESRCALRDYEXISTEX
    /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/KNDINDEXNAME /AWS1/KNDINDEXNAME

A name for the index.

iv_rolearn TYPE /AWS1/KNDROLEARN /AWS1/KNDROLEARN

The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Optional arguments:

iv_edition TYPE /AWS1/KNDINDEXEDITION /AWS1/KNDINDEXEDITION

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.

io_serversideencryptionconf TYPE REF TO /AWS1/CL_KNDSERVERSIDEENCCONF /AWS1/CL_KNDSERVERSIDEENCCONF

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

A description for the index.

iv_clienttoken TYPE /AWS1/KNDCLIENTTOKENNAME /AWS1/KNDCLIENTTOKENNAME

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

it_tags TYPE /AWS1/CL_KNDTAG=>TT_TAGLIST TT_TAGLIST

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

it_usertokenconfigurations TYPE /AWS1/CL_KNDUSERTOKENCONF=>TT_USERTOKENCONFIGURATIONLIST TT_USERTOKENCONFIGURATIONLIST

The user token configuration.

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

iv_usercontextpolicy TYPE /AWS1/KNDUSERCONTEXTPOLICY /AWS1/KNDUSERCONTEXTPOLICY

The user context policy.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.
ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

io_usergroupresolutionconf TYPE REF TO /AWS1/CL_KNDUSERGRRESOLUTION00 /AWS1/CL_KNDUSERGRRESOLUTION00

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

RETURNING

oo_output TYPE REF TO /aws1/cl_kndcreateindexrsp /AWS1/CL_KNDCREATEINDEXRSP

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->createindex(
  io_serversideencryptionconf = new /aws1/cl_kndserversideencconf( |string| )
  io_usergroupresolutionconf = new /aws1/cl_kndusergrresolution00( |string| )
  it_tags = VALUE /aws1/cl_kndtag=>tt_taglist(
    (
      new /aws1/cl_kndtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_usertokenconfigurations = VALUE /aws1/cl_kndusertokenconf=>tt_usertokenconfigurationlist(
    (
      new /aws1/cl_kndusertokenconf(
        io_jsontokentypeconf = new /aws1/cl_kndjsontokentypeconf(
          iv_groupattributefield = |string|
          iv_usernameattributefield = |string|
        )
        io_jwttokentypeconfiguration = new /aws1/cl_kndjwttokentypeconf(
          iv_claimregex = |string|
          iv_groupattributefield = |string|
          iv_issuer = |string|
          iv_keylocation = |string|
          iv_secretmanagerarn = |string|
          iv_url = |string|
          iv_usernameattributefield = |string|
        )
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_edition = |string|
  iv_name = |string|
  iv_rolearn = |string|
  iv_usercontextpolicy = |string|
).

This is an example of reading all possible response values

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