How to Configure Your Kendra Target

The following topics describe how to create a Kendra Target in Connectivity Hub.

Info:
The term “Index” as defined by Kendra is a container that holds “Data Sources.”

  • When BA Insight applications index into Kendra (via Connectivity Hub), a “Data Source” is created for each content source, such as SharePoint.

    • For another example: one Kendra "Data Source" is created for the Documentum content source.

  • A single Kendra Index - "DemoKendra" - that holds multiple data sources, each mapped to a SmartHub content source would look like this:

    • DemoKendra (Index):

      • Documentum → (Kendra Data Source)
      • SharePoint → (Kendra Data Source)
      • File Share → (Kendra Data Source)
      • and so on
Note: The search schema applies at the Index level (for example, DemoKendra) NOT at the Data Source level.

  • This is important if two data sources use metadata properties with the same name but different settings.

  • For example, one metadata property may be refinable, but not the other of the same name.

How to Create a New Target

To add the Kendra Integration target, follow these steps:

  1. Go to the Connectivity Hub Target page.
    1. Select New>Custom API Target.
  2. The Load Target dialog appears.
  3. Select Kendra as the target from the drop-down menu.
    Scroll down if you do not see your target.



  4. Enter a Target name.
    1. The Target name is the name of the Kendra Index.
    2. The Index can be an existing Index in AWS or else the Target will create the Index upon first usage.

  5. Select the Custom Settings tab.

    1. Login: Enter an AWS Access Key. 

    2. Password: Enter the AWS Access key secret



  6. Service/End Point Region: Enter a Kendra Service Endpoint Region


  7. Role ARN:

    1. Optional (see screenshot above)

    2. Enter a Role ARN (Amazon Resource Name) with either of the following:

      1. Admin access

      2. Permissions listed below:

        • Kendra:ListDataSource
        • Kendra:CreateDataSource
        • Kendra:ListDataSourceSyncJobs
        • Kendra:UpdateIndex
        • Kendra:StartDataSourceSyncJobs
        • Kendra:BatchDeleteDocument
        • iam:PassRole
        • Kendra:ListIndices

    3. Amazon Kendra requires permissions to access your CloudWatch log.

    4. Choose an existing IAM role with the correct permissions.

    Info

    Kendra SDK requires a role ARN (Amazon Resource Name) for CloudWatch: it requires permission to write logs to CloudWatch when it interacts with Amazon Kendra.

    • The role ARN is used to authenticate and authorize the SDK to access the CloudWatch service on your behalf

    • If you do not provide a role ARN for CloudWatch when using the Kendra Target, then your application cannot write logs to CloudWatch

      • This means no access to the detailed logs and metrics that can help you troubleshoot issues

    • Without CloudWatch logs, it may be more difficult to identify and diagnose errors that occur during the Kendra processes

    • If you do not have an existing Role that has List and Write access to CloudWatch, create a new role in the AWS IAM Console
      See the screenshot below:

  8. Click Save.