Skip to content

Create Experience

kendra_create_experience R Documentation

Creates an Amazon Kendra experience such as a search application

Description

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.

Usage

kendra_create_experience(Name, IndexId, RoleArn, Configuration,
  Description, ClientToken)

Arguments

Name

[required] A name for your Amazon Kendra experience.

IndexId

[required] The identifier of the index for your Amazon Kendra experience.

RoleArn

The Amazon Resource Name (ARN) of an IAM role with permission to access query API, get_query_suggestions 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.

Configuration

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.

Description

A description for your Amazon Kendra experience.

ClientToken

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

Value

A list with the following syntax:

list(
  Id = "string"
)

Request syntax

svc$create_experience(
  Name = "string",
  IndexId = "string",
  RoleArn = "string",
  Configuration = list(
    ContentSourceConfiguration = list(
      DataSourceIds = list(
        "string"
      ),
      FaqIds = list(
        "string"
      ),
      DirectPutContent = TRUE|FALSE
    ),
    UserIdentityConfiguration = list(
      IdentityAttributeName = "string"
    )
  ),
  Description = "string",
  ClientToken = "string"
)