Amazon Kendra

Amazon Kendra Experience API

Operations for managing search experiences

Documentation GitHub OpenAPI

Operations 5

POST /#CreateExperience Create Experience #

POST /#DeleteExperience Delete Experience #

POST /#DescribeExperience Describe Experience #

POST /#ListExperiences List Experiences #

POST /#UpdateExperience Update Experience #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-kendra:amazon-kendra-experience-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWSKendraFrontendService Experience API
  version: '2019-02-03'
  description: Generated from AWS's published Smithy model for AWSKendraFrontendService. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://kendra.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateExperience:
    post:
      operationId: CreateExperience
      summary: Create Experience
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateExperienceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.CreateExperience
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateExperienceRequest'
      tags:
      - Experience
  /#DeleteExperience:
    post:
      operationId: DeleteExperience
      summary: Delete Experience
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteExperienceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.DeleteExperience
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteExperienceRequest'
      tags:
      - Experience
  /#DescribeExperience:
    post:
      operationId: DescribeExperience
      summary: Describe Experience
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeExperienceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.DescribeExperience
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeExperienceRequest'
      tags:
      - Experience
  /#ListExperiences:
    post:
      operationId: ListExperiences
      summary: List Experiences
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListExperiencesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.ListExperiences
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListExperiencesRequest'
      tags:
      - Experience
  /#UpdateExperience:
    post:
      operationId: UpdateExperience
      summary: Update Experience
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.UpdateExperience
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateExperienceRequest'
      tags:
      - Experience
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: kendra
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    ContentSourceConfiguration:
      type: object
      properties:
        DataSourceIds:
          type: array
          items:
            type: string
          description: The identifier of the data sources you want to use for your Amazon Kendra experience.
        FaqIds:
          type: array
          items:
            type: string
          description: The identifier of the FAQs that you want to use for your Amazon Kendra experience.
        DirectPutContent:
          type: boolean
          description: TRUE to use documents you indexed directly using the BatchPutDocument API.
    CreateExperienceRequest:
      type: object
      properties:
        Name:
          type: string
          description: A name for your Amazon Kendra experience.
        IndexId:
          type: string
          description: The identifier of the index for your Amazon Kendra experience.
        RoleArn:
          type: string
          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.
        Configuration:
          $ref: '#/components/schemas/ExperienceConfiguration'
        Description:
          type: string
          description: A description for your Amazon Kendra experience.
        ClientToken:
          type: string
          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.
      required:
      - Name
      - IndexId
    CreateExperienceResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of your Amazon Kendra experience.
      required:
      - Id
    DeleteExperienceRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of your Amazon Kendra experience you want to delete.
        IndexId:
          type: string
          description: The identifier of the index for your Amazon Kendra experience.
      required:
      - Id
      - IndexId
    DeleteExperienceResponse:
      type: object
      properties: {}
    DescribeExperienceRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of your Amazon Kendra experience you want to get information on.
        IndexId:
          type: string
          description: The identifier of the index for your Amazon Kendra experience.
      required:
      - Id
      - IndexId
    DescribeExperienceResponse:
      type: object
      properties:
        Id:
          type: string
          description: Shows the identifier of your Amazon Kendra experience.
        IndexId:
          type: string
          description: Shows the identifier of the index for your Amazon Kendra experience.
        Name:
          type: string
          description: Shows the name of your Amazon Kendra experience.
        Endpoints:
          type: array
          items:
            $ref: '#/components/schemas/ExperienceEndpoint'
          description: Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by
            Amazon Web Services.
        Configuration:
          $ref: '#/components/schemas/ExperienceConfiguration'
        CreatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when your Amazon Kendra experience was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when your Amazon Kendra experience was last updated.
        Description:
          type: string
          description: Shows the description for your Amazon Kendra experience.
        Status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          description: 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:
          type: string
          description: 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.
        ErrorMessage:
          type: string
          description: The reason your Amazon Kendra experience could not properly process.
    ExperienceConfiguration:
      type: object
      properties:
        ContentSourceConfiguration:
          $ref: '#/components/schemas/ContentSourceConfiguration'
        UserIdentityConfiguration:
          $ref: '#/components/schemas/UserIdentityConfiguration'
    ExperienceEndpoint:
      type: object
      properties:
        EndpointType:
          type: string
          enum:
          - HOME
          description: 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:
          type: string
          description: The endpoint of your Amazon Kendra experience.
    ExperiencesSummary:
      type: object
      properties:
        Name:
          type: string
          description: The name of your Amazon Kendra experience.
        Id:
          type: string
          description: The identifier of your Amazon Kendra experience.
        CreatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when your Amazon Kendra experience was created.
        Status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The processing status of your Amazon Kendra experience.
        Endpoints:
          type: array
          items:
            $ref: '#/components/schemas/ExperienceEndpoint'
          description: The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon
            Web Services.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListExperiencesRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for your Amazon Kendra experience.
        NextToken:
          type: string
          description: If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns
            a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Kendra
            experiences.
        MaxResults:
          type: integer
          description: The maximum number of returned Amazon Kendra experiences.
      required:
      - IndexId
    ListExperiencesResponse:
      type: object
      properties:
        SummaryItems:
          type: array
          items:
            $ref: '#/components/schemas/ExperiencesSummary'
          description: An array of summary information for one or more Amazon Kendra experiences.
        NextToken:
          type: string
          description: If the response is truncated, Amazon Kendra returns this token, which you can use in a later request
            to retrieve the next set of Amazon Kendra experiences.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateExperienceRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of your Amazon Kendra experience you want to update.
        Name:
          type: string
          description: A new name for your Amazon Kendra experience.
        IndexId:
          type: string
          description: The identifier of the index for your Amazon Kendra experience.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role with permission to access the Query API, QuerySuggestions
            API, SubmitFeedback API, and IAM Identity Center that stores your users and groups information. For more information,
            see IAM roles for Amazon Kendra.
        Configuration:
          $ref: '#/components/schemas/ExperienceConfiguration'
        Description:
          type: string
          description: A new description for your Amazon Kendra experience.
      required:
      - Id
      - IndexId
    UserIdentityConfiguration:
      type: object
      properties:
        IdentityAttributeName:
          type: string
          description: 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.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/kendra/service/2019-02-03/kendra-2019-02-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)

Amazon Kendra Experience API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources