kendra / Client / describe_experience

describe_experience#

kendra.Client.describe_experience(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_experience(
    Id='string',
    IndexId='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The identifier of your Amazon Kendra experience you want to get information on.

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index for your Amazon Kendra experience.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'IndexId': 'string',
    'Name': 'string',
    'Endpoints': [
        {
            'EndpointType': 'HOME',
            'Endpoint': 'string'
        },
    ],
    'Configuration': {
        'ContentSourceConfiguration': {
            'DataSourceIds': [
                'string',
            ],
            'FaqIds': [
                'string',
            ],
            'DirectPutContent': True|False
        },
        'UserIdentityConfiguration': {
            'IdentityAttributeName': 'string'
        }
    },
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
    'RoleArn': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) –

    • Id (string) –

      Shows the identifier of your Amazon Kendra experience.

    • IndexId (string) –

      Shows the identifier of the index for your Amazon Kendra experience.

    • Name (string) –

      Shows the name of your Amazon Kendra experience.

    • Endpoints (list) –

      Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

      • (dict) –

        Provides the configuration information for the endpoint for your Amazon Kendra experience.

        • EndpointType (string) –

          The type of endpoint for your Amazon Kendra experience. The type currently available is HOME, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

        • Endpoint (string) –

          The endpoint of your Amazon Kendra experience.

    • Configuration (dict) –

      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.

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

    • CreatedAt (datetime) –

      The Unix timestamp when your Amazon Kendra experience was created.

    • UpdatedAt (datetime) –

      The Unix timestamp when your Amazon Kendra experience was last updated.

    • Description (string) –

      Shows the description for your Amazon Kendra experience.

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

    • RoleArn (string) –

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

    • ErrorMessage (string) –

      The reason your Amazon Kendra experience could not properly process.

Exceptions