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-featured-results-set-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.2.0
info:
  title: AWSKendraFrontendService Featured Results Set 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: []
tags:
- name: Featured Results Set
paths:
  /#BatchDeleteFeaturedResultsSet:
    post:
      operationId: BatchDeleteFeaturedResultsSet
      summary: Batch Delete Featured Results Set
      description: Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchDeleteFeaturedResultsSetResponse'
        '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.BatchDeleteFeaturedResultsSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchDeleteFeaturedResultsSetRequest'
      tags:
      - Featured Results Set
  /#CreateFeaturedResultsSet:
    post:
      operationId: CreateFeaturedResultsSet
      summary: Create Featured Results Set
      description: Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results. You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateFeaturedResultsSetResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; FeaturedResultsConflictException
          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.CreateFeaturedResultsSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateFeaturedResultsSetRequest'
      tags:
      - Featured Results Set
  /#DescribeFeaturedResultsSet:
    post:
      operationId: DescribeFeaturedResultsSet
      summary: Describe Featured Results Set
      description: Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeFeaturedResultsSetResponse'
        '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.DescribeFeaturedResultsSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeFeaturedResultsSetRequest'
      tags:
      - Featured Results Set
  /#ListFeaturedResultsSets:
    post:
      operationId: ListFeaturedResultsSets
      summary: List Featured Results Sets
      description: Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListFeaturedResultsSetsResponse'
        '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.ListFeaturedResultsSets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListFeaturedResultsSetsRequest'
      tags:
      - Featured Results Set
  /#UpdateFeaturedResultsSet:
    post:
      operationId: UpdateFeaturedResultsSet
      summary: Update Featured Results Set
      description: Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateFeaturedResultsSetResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: FeaturedResultsConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FeaturedResultsConflictException'
        '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.UpdateFeaturedResultsSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateFeaturedResultsSetRequest'
      tags:
      - Featured Results Set
components:
  schemas:
    FeaturedDocumentWithMetadata:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.
        Title:
          type: string
          description: The main title of the featured document.
        URI:
          type: string
          description: The source URI location of the featured document.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, data source, or other resource.
        Value:
          type: string
          description: The value associated with the tag. The value may be an empty string but it can't be null.
      required:
      - Key
      - Value
    FeaturedResultsSetSummary:
      type: object
      properties:
        FeaturedResultsSetId:
          type: string
          description: The identifier of the set of featured results.
        FeaturedResultsSetName:
          type: string
          description: The name for the set of featured results.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        LastUpdatedTimestamp:
          type: integer
          description: The Unix timestamp when the set of featured results was last updated.
        CreationTimestamp:
          type: integer
          description: The Unix timestamp when the set of featured results was created.
    ConflictingItem:
      type: object
      properties:
        QueryText:
          type: string
          description: The text of the conflicting query.
        SetName:
          type: string
          description: The name for the set of featured results that the conflicting query belongs to.
        SetId:
          type: string
          description: The identifier of the set of featured results that the conflicting query belongs to.
    ListFeaturedResultsSetsResponse:
      type: object
      properties:
        FeaturedResultsSetSummaryItems:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedResultsSetSummary'
          description: An array of summary information for one or more featured results sets.
        NextToken:
          type: string
          description: If the response is truncated, Amazon Kendra returns a pagination token in the response.
    BatchDeleteFeaturedResultsSetRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index used for featuring results.
        FeaturedResultsSetIds:
          type: array
          items:
            type: string
          description: The identifiers of the featured results sets that you want to delete.
      required:
      - IndexId
      - FeaturedResultsSetIds
    FeaturedResultsSet:
      type: object
      properties:
        FeaturedResultsSetId:
          type: string
          description: The identifier of the set of featured results.
        FeaturedResultsSetName:
          type: string
          description: The name for the set of featured results.
        Description:
          type: string
          description: The description for the set of featured results.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        QueryTexts:
          type: array
          items:
            type: string
          description: The list of queries for featuring results. Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
        FeaturedDocuments:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedDocument'
          description: The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console. You can add up to four featured documents. You can request to increase this limit by contacting Support. Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only spe
        LastUpdatedTimestamp:
          type: integer
          description: The Unix timestamp when the set of featured results was last updated.
        CreationTimestamp:
          type: integer
          description: The Unix timestamp when the set of featured results was created.
    FeaturedDocumentMissing:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the document that doesn't exist but you have specified as a featured document.
    UpdateFeaturedResultsSetResponse:
      type: object
      properties:
        FeaturedResultsSet:
          $ref: '#/components/schemas/FeaturedResultsSet'
    ListFeaturedResultsSetsRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index used for featuring results.
        NextToken:
          type: string
          description: If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.
        MaxResults:
          type: integer
          description: The maximum number of featured results sets to return.
      required:
      - IndexId
    DescribeFeaturedResultsSetRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index used for featuring results.
        FeaturedResultsSetId:
          type: string
          description: The identifier of the set of featured results that you want to get information on.
      required:
      - IndexId
      - FeaturedResultsSetId
    BatchDeleteFeaturedResultsSetResponse:
      type: object
      properties:
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchDeleteFeaturedResultsSetError'
          description: The list of errors for the featured results set IDs, explaining why they couldn't be removed from the index.
      required:
      - Errors
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    CreateFeaturedResultsSetResponse:
      type: object
      properties:
        FeaturedResultsSet:
          $ref: '#/components/schemas/FeaturedResultsSet'
    FeaturedDocument:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the document to feature in the search results. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    FeaturedResultsConflictException:
      type: object
      properties:
        Message:
          type: string
          description: An explanation for the conflicting queries.
        ConflictingItems:
          type: array
          items:
            $ref: '#/components/schemas/ConflictingItem'
          description: A list of the conflicting queries, including the query text, the name for the featured results set, and the identifier of the featured results set.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BatchDeleteFeaturedResultsSetError:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the set of featured results that couldn't be removed from the index.
        ErrorCode:
          type: string
          enum:
          - InternalError
          - InvalidRequest
          description: The error code for why the set of featured results couldn't be removed from the index.
        ErrorMessage:
          type: string
          description: An explanation for why the set of featured results couldn't be removed from the index.
      required:
      - Id
      - ErrorCode
      - ErrorMessage
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    DescribeFeaturedResultsSetResponse:
      type: object
      properties:
        FeaturedResultsSetId:
          type: string
          description: The identifier of the set of featured results.
        FeaturedResultsSetName:
          type: string
          description: The name for the set of featured results.
        Description:
          type: string
          description: The description for the set of featured results.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        QueryTexts:
          type: array
          items:
            type: string
          description: The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
        FeaturedDocumentsWithMetadata:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedDocumentWithMetadata'
          description: The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.
        FeaturedDocumentsMissing:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedDocumentMissing'
          description: The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.
        LastUpdatedTimestamp:
          type: integer
          description: The timestamp when the set of featured results was last updated.
        CreationTimestamp:
          type: integer
          description: The Unix timestamp when the set of the featured results was created.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateFeaturedResultsSetRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index that you want to use for featuring results.
        FeaturedResultsSetName:
          type: string
          description: A name for the set of featured results.
        Description:
          type: string
          description: A description for the set of featured results.
        ClientToken:
          type: string
          description: A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        QueryTexts:
          type: array
          items:
            type: string
          description: A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
        FeaturedDocuments:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedDocument'
          description: A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.'
      required:
      - IndexId
      - FeaturedResultsSetName
    UpdateFeaturedResultsSetRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index used for featuring results.
        FeaturedResultsSetId:
          type: string
          description: The identifier of the set of featured results that you want to update.
        FeaturedResultsSetName:
          type: string
          description: A new name for the set of featured results.
        Description:
          type: string
          description: A new description for the set of featured results.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        QueryTexts:
          type: array
          items:
            type: string
          description: A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
        FeaturedDocuments:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedDocument'
          description: A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.
      required:
      - IndexId
      - FeaturedResultsSetId
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
  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
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)