Amazon Q

Amazon Q Q Chatcontrols API

The Q Chatcontrols API from Amazon Q — 1 operation(s) for q chatcontrols.

GitHub OpenAPI

Operations 3

DELETE /applications/{applicationId}/chatcontrols Delete Chat Controls Configuration #
GET /applications/{applicationId}/chatcontrols Get Chat Controls Configuration #
PATCH /applications/{applicationId}/chatcontrols Update Chat Controls Configuration #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-q/openapi/amazon-q-chatcontrols-api-openapi.yml

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-q:amazon-q-chatcontrols-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

amazon-q-chatcontrols-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: QBusiness Chatcontrols API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 3 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://qbusiness.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Chatcontrols
paths:
  /applications/{applicationId}/chatcontrols:
    delete:
      operationId: DeleteChatControlsConfiguration
      summary: Delete Chat Controls Configuration
      description: Deletes chat controls configured for an existing Amazon Q Business application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChatControlsConfigurationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteChatControlsConfigurationRequest'
      tags:
      - Chatcontrols
    get:
      operationId: GetChatControlsConfiguration
      summary: Get Chat Controls Configuration
      description: Gets information about chat controls configured for an existing Amazon Q Business application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChatControlsConfigurationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetChatControlsConfigurationRequest'
      tags:
      - Chatcontrols
    patch:
      operationId: UpdateChatControlsConfiguration
      summary: Update Chat Controls Configuration
      description: Updates a set of chat controls configured for an existing Amazon Q Business application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChatControlsConfigurationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChatControlsConfigurationRequest'
      tags:
      - Chatcontrols
components:
  schemas:
    RuleConfiguration:
      type: object
      properties:
        contentBlockerRule:
          $ref: '#/components/schemas/ContentBlockerRule'
        contentRetrievalRule:
          $ref: '#/components/schemas/ContentRetrievalRule'
      description: Exactly one member is set.
    ContentRetrievalRule:
      type: object
      properties:
        eligibleDataSources:
          type: array
          items:
            $ref: '#/components/schemas/EligibleDataSource'
          description: Specifies data sources in a Amazon Q Business application to use for content generation.
    GetChatControlsConfigurationRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the application for which the chat controls are configured.
        maxResults:
          type: integer
          description: The maximum number of configured chat controls to return.
        nextToken:
          type: string
          description: If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
      required:
      - applicationId
    Rule:
      type: object
      properties:
        includedUsersAndGroups:
          $ref: '#/components/schemas/UsersAndGroups'
        excludedUsersAndGroups:
          $ref: '#/components/schemas/UsersAndGroups'
        ruleType:
          type: string
          enum:
          - CONTENT_BLOCKER_RULE
          - CONTENT_RETRIEVAL_RULE
          description: The type of rule.
        ruleConfiguration:
          $ref: '#/components/schemas/RuleConfiguration'
      required:
      - ruleType
    ContentBlockerRule:
      type: object
      properties:
        systemMessageOverride:
          type: string
          description: The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
    BlockedPhrasesConfiguration:
      type: object
      properties:
        blockedPhrases:
          type: array
          items:
            type: string
          description: A list of phrases blocked from a Amazon Q Business web experience chat. Each phrase can contain a maximum of 36 characters. The list can contain a maximum of 20 phrases.
        systemMessageOverride:
          type: string
          description: The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ResourceNotFoundException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UsersAndGroups:
      type: object
      properties:
        userIds:
          type: array
          items:
            type: string
          description: The user ids associated with a topic control rule.
        userGroups:
          type: array
          items:
            type: string
          description: The user group names associated with a topic control rule.
    EligibleDataSource:
      type: object
      properties:
        indexId:
          type: string
          description: The identifier of the index the data source is attached to.
        dataSourceId:
          type: string
          description: The identifier of the data source.
    BlockedPhrasesConfigurationUpdate:
      type: object
      properties:
        blockedPhrasesToCreateOrUpdate:
          type: array
          items:
            type: string
          description: Creates or updates a blocked phrases configuration in your Amazon Q Business application.
        blockedPhrasesToDelete:
          type: array
          items:
            type: string
          description: Deletes a blocked phrases configuration in your Amazon Q Business application.
        systemMessageOverride:
          type: string
          description: The configured custom message displayed to your end user when they use blocked phrase during chat.
    AppliedOrchestrationConfiguration:
      type: object
      properties:
        control:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application.
      required:
      - control
    DeleteChatControlsConfigurationResponse:
      type: object
      properties: {}
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ServiceQuotaExceededException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The field name where the invalid entry was detected.
        message:
          type: string
          description: A message about the validation exception.
      required:
      - name
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteChatControlsConfigurationRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the application the chat controls have been configured for.
      required:
      - applicationId
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The message describing the ValidationException.
        reason:
          type: string
          enum:
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - UNKNOWN_OPERATION
          description: The reason for the ValidationException.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The input field(s) that failed validation.
      required:
      - message
      - reason
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ConflictException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    CreatorModeConfiguration:
      type: object
      properties:
        creatorModeControl:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.
      required:
      - creatorModeControl
    UpdateChatControlsConfigurationRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the application for which the chat controls are configured.
        clientToken:
          type: string
          description: A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
        responseScope:
          type: string
          enum:
          - ENTERPRISE_CONTENT_ONLY
          - EXTENDED_KNOWLEDGE_ENABLED
          description: The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
        orchestrationConfiguration:
          $ref: '#/components/schemas/OrchestrationConfiguration'
        blockedPhrasesConfigurationUpdate:
          $ref: '#/components/schemas/BlockedPhrasesConfigurationUpdate'
        topicConfigurationsToCreateOrUpdate:
          type: array
          items:
            $ref: '#/components/schemas/TopicConfiguration'
          description: The configured topic specific chat controls you want to update.
        topicConfigurationsToDelete:
          type: array
          items:
            $ref: '#/components/schemas/TopicConfiguration'
          description: The configured topic specific chat controls you want to delete.
        creatorModeConfiguration:
          $ref: '#/components/schemas/CreatorModeConfiguration'
        hallucinationReductionConfiguration:
          $ref: '#/components/schemas/HallucinationReductionConfiguration'
      required:
      - applicationId
    OrchestrationConfiguration:
      type: object
      properties:
        control:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.
      required:
      - control
    UpdateChatControlsConfigurationResponse:
      type: object
      properties: {}
    HallucinationReductionConfiguration:
      type: object
      properties:
        hallucinationReductionControl:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Controls whether hallucination reduction has been enabled or disabled for your application. The default status is DISABLED.
    GetChatControlsConfigurationResponse:
      type: object
      properties:
        responseScope:
          type: string
          enum:
          - ENTERPRISE_CONTENT_ONLY
          - EXTENDED_KNOWLEDGE_ENABLED
          description: The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
        orchestrationConfiguration:
          $ref: '#/components/schemas/AppliedOrchestrationConfiguration'
        blockedPhrases:
          $ref: '#/components/schemas/BlockedPhrasesConfiguration'
        topicConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TopicConfiguration'
          description: The topic specific controls configured for a Amazon Q Business application.
        creatorModeConfiguration:
          $ref: '#/components/schemas/AppliedCreatorModeConfiguration'
        nextToken:
          type: string
          description: If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
        hallucinationReductionConfiguration:
          $ref: '#/components/schemas/HallucinationReductionConfiguration'
    TopicConfiguration:
      type: object
      properties:
        name:
          type: string
          description: A name for your topic control configuration.
        description:
          type: string
          description: A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
        exampleChatMessages:
          type: array
          items:
            type: string
          description: A list of example phrases that you expect the end user to use in relation to the topic.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: Rules defined for a topic configuration.
      required:
      - name
      - rules
    AppliedCreatorModeConfiguration:
      type: object
      properties:
        creatorModeControl:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
      required:
      - creatorModeControl
  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: qbusiness
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)