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-query-suggestions-block-list-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 Query Suggestions Block List 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: Query Suggestions Block List
paths:
  /#CreateQuerySuggestionsBlockList:
    post:
      operationId: CreateQuerySuggestionsBlockList
      summary: Create Query Suggestions Block List
      description: Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateQuerySuggestionsBlockListResponse'
        '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.CreateQuerySuggestionsBlockList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateQuerySuggestionsBlockListRequest'
      tags:
      - Query Suggestions Block List
  /#DeleteQuerySuggestionsBlockList:
    post:
      operationId: DeleteQuerySuggestionsBlockList
      summary: Delete Query Suggestions Block List
      description: Deletes a block list used for query suggestions for an index. A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked. DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
      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.DeleteQuerySuggestionsBlockList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteQuerySuggestionsBlockListRequest'
      tags:
      - Query Suggestions Block List
  /#DescribeQuerySuggestionsBlockList:
    post:
      operationId: DescribeQuerySuggestionsBlockList
      summary: Describe Query Suggestions Block List
      description: Gets information about a block list used for query suggestions for an index. This is used to check the current settings that are applied to a block list. DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeQuerySuggestionsBlockListResponse'
        '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.DescribeQuerySuggestionsBlockList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeQuerySuggestionsBlockListRequest'
      tags:
      - Query Suggestions Block List
  /#ListQuerySuggestionsBlockLists:
    post:
      operationId: ListQuerySuggestionsBlockLists
      summary: List Query Suggestions Block Lists
      description: Lists the block lists used for query suggestions for an index. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListQuerySuggestionsBlockListsResponse'
        '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.ListQuerySuggestionsBlockLists
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListQuerySuggestionsBlockListsRequest'
      tags:
      - Query Suggestions Block List
  /#UpdateQuerySuggestionsBlockList:
    post:
      operationId: UpdateQuerySuggestionsBlockList
      summary: Update Query Suggestions Block List
      description: Updates a block list used for query suggestions for an index. Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately. If a block list is updating, then you need to wait for the first update to finish before submitting another update. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
      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.UpdateQuerySuggestionsBlockList
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateQuerySuggestionsBlockListRequest'
      tags:
      - Query Suggestions Block List
components:
  schemas:
    ListQuerySuggestionsBlockListsRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for a list of all block lists that exist for that index. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
        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 block lists (BlockListSummaryItems).
        MaxResults:
          type: integer
          description: The maximum number of block lists to return.
      required:
      - IndexId
    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
    DescribeQuerySuggestionsBlockListResponse:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for the block list.
        Id:
          type: string
          description: The identifier of the block list.
        Name:
          type: string
          description: The name of the block list.
        Description:
          type: string
          description: The description for the block list.
        Status:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - DELETING
          - UPDATING
          - ACTIVE_BUT_UPDATE_FAILED
          - FAILED
          description: The current status of the block list. When the value is ACTIVE, the block list is ready for use.
        ErrorMessage:
          type: string
          description: The error message containing details if there are issues processing the block list.
        CreatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when a block list for query suggestions was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when a block list for query suggestions was last updated.
        SourceS3Path:
          $ref: '#/components/schemas/S3Path'
        ItemCount:
          type: integer
          description: The current number of valid, non-empty words or phrases in the block list text file.
        FileSizeBytes:
          type: integer
          description: The current size of the block list text file in S3.
        RoleArn:
          type: string
          description: The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3. The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    ListQuerySuggestionsBlockListsResponse:
      type: object
      properties:
        BlockListSummaryItems:
          type: array
          items:
            $ref: '#/components/schemas/QuerySuggestionsBlockListSummary'
          description: Summary items for a block list. This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
        NextToken:
          type: string
          description: If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.
    CreateQuerySuggestionsBlockListResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the block list.
    DeleteQuerySuggestionsBlockListRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for the block list.
        Id:
          type: string
          description: The identifier of the block list you want to delete.
      required:
      - IndexId
      - Id
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    QuerySuggestionsBlockListSummary:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of a block list.
        Name:
          type: string
          description: The name of the block list.
        Status:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - DELETING
          - UPDATING
          - ACTIVE_BUT_UPDATE_FAILED
          - FAILED
          description: The status of the block list.
        CreatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the block list was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the block list was last updated.
        ItemCount:
          type: integer
          description: The number of items in the block list file.
    CreateQuerySuggestionsBlockListRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index you want to create a query suggestions block list for.
        Name:
          type: string
          description: A name for the block list. For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.
        Description:
          type: string
          description: A description for the block list. For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."
        SourceS3Path:
          $ref: '#/components/schemas/S3Path'
        ClientToken:
          type: string
          description: A token that you provide to identify the request to create a query suggestions block list.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.'
      required:
      - IndexId
      - Name
      - SourceS3Path
      - RoleArn
    DescribeQuerySuggestionsBlockListRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for the block list.
        Id:
          type: string
          description: The identifier of the block list you want to get information on.
      required:
      - IndexId
      - Id
    UpdateQuerySuggestionsBlockListRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for the block list.
        Id:
          type: string
          description: The identifier of the block list you want to update.
        Name:
          type: string
          description: A new name for the block list.
        Description:
          type: string
          description: A new description for the block list.
        SourceS3Path:
          $ref: '#/components/schemas/S3Path'
        RoleArn:
          type: string
          description: The IAM (Identity and Access Management) role used to access the block list text file in S3.
      required:
      - IndexId
      - Id
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    S3Path:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the S3 bucket that contains the file.
        Key:
          type: string
          description: The name of the file.
      required:
      - Bucket
      - Key
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      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)