kendra / Client / create_experience

create_experience#

kendra.Client.create_experience(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

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

  • Name (string) –

    [REQUIRED]

    A 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 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.

  • Configuration (dict) –

    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 (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 description for your Amazon Kendra experience.

  • ClientToken (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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) –

    • Id (string) –

      The identifier of your Amazon Kendra experience.

Exceptions