kendra / Client / update_experience

update_experience#

kendra.Client.update_experience(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_experience(
    Id='string',
    Name='string',
    IndexId='string',
    RoleArn='string',
    Configuration={
        'ContentSourceConfiguration': {
            'DataSourceIds': [
                'string',
            ],
            'FaqIds': [
                'string',
            ],
            'DirectPutContent': True|False
        },
        'UserIdentityConfiguration': {
            'IdentityAttributeName': 'string'
        }
    },
    Description='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The identifier of your Amazon Kendra experience you want to update.

  • Name (string) – A new name for your Amazon Kendra experience.

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index for your Amazon Kendra experience.

  • RoleArn (string) – The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

  • Configuration (dict) –

    Configuration information you want to update for your Amazon Kendra experience.

    • ContentSourceConfiguration (dict) –

      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 (dict) –

      The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

      • IdentityAttributeName (string) –

        The IAM Identity Center 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 IAM Identity Center 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 IAM Identity Center identity source.

  • Description (string) – A new description for your Amazon Kendra experience.

Returns:

None

Exceptions