[ aws . kendra ]

create-experience

Description

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-experience
--name <value>
--index-id <value>
[--role-arn <value>]
[--configuration <value>]
[--description <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

A name for your Amazon Kendra experience.

--index-id (string)

The identifier of the index for your Amazon Kendra experience.

--role-arn (string)

The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra .

--configuration (structure)

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.

ContentSourceConfiguration -> (structure)

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.

DataSourceIds -> (list)

The identifier of the data sources you want to use for your Amazon Kendra experience.

(string)

FaqIds -> (list)

The identifier of the FAQs that you want to use for your Amazon Kendra experience.

(string)

DirectPutContent -> (boolean)

TRUE to use documents you indexed directly using the BatchPutDocument API.

UserIdentityConfiguration -> (structure)

The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.

IdentityAttributeName -> (string)

The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an Amazon Web Services SSO identity source .

Shorthand Syntax:

ContentSourceConfiguration={DataSourceIds=[string,string],FaqIds=[string,string],DirectPutContent=boolean},UserIdentityConfiguration={IdentityAttributeName=string}

JSON Syntax:

{
  "ContentSourceConfiguration": {
    "DataSourceIds": ["string", ...],
    "FaqIds": ["string", ...],
    "DirectPutContent": true|false
  },
  "UserIdentityConfiguration": {
    "IdentityAttributeName": "string"
  }
}

--description (string)

A description for your Amazon Kendra experience.

--client-token (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Id -> (string)

The identifier for your created Amazon Kendra experience.