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.
Request Syntax
{
"ClientToken": "string",
"Configuration": {
"ContentSourceConfiguration": {
"DataSourceIds": [ "string" ],
"DirectPutContent": boolean,
"FaqIds": [ "string" ]
},
"UserIdentityConfiguration": {
"IdentityAttributeName": "string"
}
},
"Description": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientToken
-
A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the
CreateExperienceAPI with the same client token creates only one Amazon Kendra experience.Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- Configuration
-
Configuration information for your Amazon Kendra experience. This includes
ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, andUserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.Type: ExperienceConfiguration object
Required: No
- Description
-
A description for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^\P{C}*$Required: No
- IndexId
-
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*Required: Yes
- Name
-
A name for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*Required: Yes
- RoleArn
-
The Amazon Resource Name (ARN) of an IAM role with permission to access
QueryAPI,GetQuerySuggestionsAPI, and other required APIs. The role also must include permission to access AWS IAM Identity Center that stores your user and group information. For more information, see IAM access roles for Amazon Kendra.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: No
Response Syntax
{
"Id": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Id
-
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
HTTP Status Code: 400
- ConflictException
-
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
HTTP Status Code: 400
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support
to inquire about an increase of limits. HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Please reduce the number of requests and try again.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
