experiences

Creates, updates, deletes, gets or lists an experiences resource.

Overview

Name	experiences
Type	Resource
Id	aws.kendra.experiences

Fields

The following fields are returned by SELECT queries:

describe_experience

Name	Datatype	Description
configuration	object	Shows the 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.
created_at	string (date-time)	The Unix timestamp when your Amazon Kendra experience was created.
description	string	Shows the description for your Amazon Kendra experience. (pattern: <code>^\P{C}*$</code>)
endpoints	array	Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
error_message	string	The reason your Amazon Kendra experience could not properly process. (pattern: <code>^\P{C}*$</code>)
id	string	Shows the identifier of your Amazon Kendra experience. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
index_id	string	Shows the identifier of the index for your Amazon Kendra experience. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]*</code>)
name	string	Shows the name of your Amazon Kendra experience. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
role_arn	string	The Amazon Resource Name (ARN) of the IAM role with permission to access the Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your users and groups information. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
status	string	The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed. (CREATING, ACTIVE, DELETING, FAILED)
updated_at	string (date-time)	The Unix timestamp when your Amazon Kendra experience was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_experience	select	region		Gets information about your 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.
create_experience	insert	region, IndexId		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.
associate_entities_to_experience	update	region, IndexId, EntityList		Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create 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.
update_experience	update	region, IndexId		Updates your 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.
delete_experience	delete	region		Deletes your 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.
disassociate_entities_from_experience	exec	region, IndexId, EntityList		Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create 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.
list_experiences	exec	region, IndexId		Lists one or more Amazon Kendra experiences. You can create 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_experience

Gets information about your 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.

SELECT
configuration,
created_at,
description,
endpoints,
error_message,
id,
index_id,
name,
role_arn,
status,
updated_at
FROM aws.kendra.experiences
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_experience

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.

INSERT INTO aws.kendra.experiences (
Name,
IndexId,
RoleArn,
Configuration,
Description,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ IndexId }}' /* required */,
'{{ RoleArn }}',
'{{ Configuration }}',
'{{ Description }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: experiences
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the experiences resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      A name for your Amazon Kendra experience.
  - name: IndexId
    value: "{{ IndexId }}"
    description: |
      The identifier of the index for your Amazon Kendra experience.
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions 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.
  - name: Configuration
    description: |
      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.
    value:
      ContentSourceConfiguration:
        DataSourceIds:
          - "{{ DataSourceIds }}"
        FaqIds:
          - "{{ FaqIds }}"
        DirectPutContent: {{ DirectPutContent }}
      UserIdentityConfiguration:
        IdentityAttributeName: "{{ IdentityAttributeName }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for your Amazon Kendra experience.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.

UPDATE examples

associate_entities_to_experience

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create 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.

UPDATE aws.kendra.experiences
SET 
Id = '{{ Id }}',
IndexId = '{{ IndexId }}',
EntityList = '{{ EntityList }}'
WHERE 
region = '{{ region }}' --required
AND IndexId = '{{ IndexId }}' --required
AND EntityList = '{{ EntityList }}' --required
RETURNING
failed_entity_list;

update_experience

Updates your 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.

UPDATE aws.kendra.experiences
SET 
Id = '{{ Id }}',
Name = '{{ Name }}',
IndexId = '{{ IndexId }}',
RoleArn = '{{ RoleArn }}',
Configuration = '{{ Configuration }}',
Description = '{{ Description }}'
WHERE 
region = '{{ region }}' --required
AND IndexId = '{{ IndexId }}' --required;

DELETE examples

delete_experience

Deletes your 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.

DELETE FROM aws.kendra.experiences
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_entities_from_experience

Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create 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.

EXEC aws.kendra.experiences.disassociate_entities_from_experience 
@region='{{ region }}' --required 
@@json=
'{
"Id": "{{ Id }}", 
"IndexId": "{{ IndexId }}", 
"EntityList": "{{ EntityList }}"
}'
;

list_experiences

Lists one or more Amazon Kendra experiences. You can create 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.

EXEC aws.kendra.experiences.list_experiences 
@region='{{ region }}' --required 
@@json=
'{
"IndexId": "{{ IndexId }}", 
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}
}'
;