Amazon Q Q Chatresponseconfigurations API
The Q Chatresponseconfigurations API from Amazon Q — 2 operation(s) for q chatresponseconfigurations.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-q:amazon-q-chatresponseconfigurations-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: QBusiness Chatresponseconfigurations API
version: '2023-11-27'
description: Generated from AWS's published Smithy model for QBusiness. 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://qbusiness.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Chatresponseconfigurations
paths:
/applications/{applicationId}/chatresponseconfigurations:
post:
operationId: CreateChatResponseConfiguration
summary: Create Chat Response Configuration
description: Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChatResponseConfigurationResponse'
'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/CreateChatResponseConfigurationRequest'
tags:
- Chatresponseconfigurations
get:
operationId: ListChatResponseConfigurations
summary: List Chat Response Configurations
description: Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListChatResponseConfigurationsResponse'
'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/ListChatResponseConfigurationsRequest'
tags:
- Chatresponseconfigurations
/applications/{applicationId}/chatresponseconfigurations/{chatResponseConfigurationId}:
delete:
operationId: DeleteChatResponseConfiguration
summary: Delete Chat Response Configuration
description: Deletes a specified chat response configuration from an Amazon Q Business application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteChatResponseConfigurationResponse'
'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'
'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/DeleteChatResponseConfigurationRequest'
tags:
- Chatresponseconfigurations
get:
operationId: GetChatResponseConfiguration
summary: Get Chat Response Configuration
description: Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetChatResponseConfigurationResponse'
'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/GetChatResponseConfigurationRequest'
tags:
- Chatresponseconfigurations
put:
operationId: UpdateChatResponseConfiguration
summary: Update Chat Response Configuration
description: Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateChatResponseConfigurationResponse'
'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'
'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/UpdateChatResponseConfigurationRequest'
tags:
- Chatresponseconfigurations
components:
schemas:
ErrorDetail:
type: object
properties:
errorMessage:
type: string
description: The message explaining the Amazon Q Business request error.
errorCode:
type: string
enum:
- InternalError
- InvalidRequest
- ResourceInactive
- ResourceNotFound
description: The code associated with the Amazon Q Business request error.
Tag:
type: object
properties:
key:
type: string
description: The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
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
ChatResponseConfiguration:
type: object
properties:
chatResponseConfigurationId:
type: string
description: A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.
chatResponseConfigurationArn:
type: string
description: The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.
displayName:
type: string
description: A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.
responseConfigurationSummary:
type: string
description: A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.
status:
type: string
enum:
- CREATING
- UPDATING
- FAILED
- ACTIVE
description: The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.
createdAt:
type: string
format: date-time
description: The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.
updatedAt:
type: string
format: date-time
description: The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.
required:
- chatResponseConfigurationId
- chatResponseConfigurationArn
- displayName
- status
ResponseConfiguration:
type: object
properties:
instructionCollection:
$ref: '#/components/schemas/InstructionCollection'
UpdateChatResponseConfigurationResponse:
type: object
properties: {}
CreateChatResponseConfigurationRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
displayName:
type: string
description: A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
clientToken:
type: string
description: A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.
responseConfigurations:
type: object
additionalProperties:
$ref: '#/components/schemas/ResponseConfiguration'
description: A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.
required:
- applicationId
- displayName
- responseConfigurations
CreateChatResponseConfigurationResponse:
type: object
properties:
chatResponseConfigurationId:
type: string
description: The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.
chatResponseConfigurationArn:
type: string
description: The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
required:
- chatResponseConfigurationId
- chatResponseConfigurationArn
InstructionCollection:
type: object
properties:
responseLength:
type: string
description: Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
targetAudience:
type: string
description: Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
perspective:
type: string
description: Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
outputStyle:
type: string
description: Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
identity:
type: string
description: Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
tone:
type: string
description: Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
customInstructions:
type: string
description: Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
examples:
type: string
description: Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
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
ChatResponseConfigurationDetail:
type: object
properties:
responseConfigurations:
type: object
additionalProperties:
$ref: '#/components/schemas/ResponseConfiguration'
description: A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.
responseConfigurationSummary:
type: string
description: A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.
status:
type: string
enum:
- CREATING
- UPDATING
- FAILED
- ACTIVE
description: The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.
error:
$ref: '#/components/schemas/ErrorDetail'
updatedAt:
type: string
format: date-time
description: The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.
ListChatResponseConfigurationsRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier of the Amazon Q Business application for which to list available chat response configurations.
maxResults:
type: integer
description: The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.
nextToken:
type: string
description: A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.
required:
- applicationId
ListChatResponseConfigurationsResponse:
type: object
properties:
chatResponseConfigurations:
type: array
items:
$ref: '#/components/schemas/ChatResponseConfiguration'
description: A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.
nextToken:
type: string
description: A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the maxResults parameter.
DeleteChatResponseConfigurationRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier of theAmazon Q Business application from which to delete the chat response configuration.
chatResponseConfigurationId:
type: string
description: The unique identifier of the chat response configuration to delete from the specified application.
required:
- applicationId
- chatResponseConfigurationId
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
GetChatResponseConfigurationRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.
chatResponseConfigurationId:
type: string
description: The unique identifier of the chat response configuration to retrieve from the specified application.
required:
- applicationId
- chatResponseConfigurationId
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
UpdateChatResponseConfigurationRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier of the Amazon Q Business application containing the chat response configuration to update.
chatResponseConfigurationId:
type: string
description: The unique identifier of the chat response configuration to update within the specified application.
displayName:
type: string
description: The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.
responseConfigurations:
type: object
additionalProperties:
$ref: '#/components/schemas/ResponseConfiguration'
description: The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.
clientToken:
type: string
description: A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.
required:
- applicationId
- chatResponseConfigurationId
- responseConfigurations
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
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
DeleteChatResponseConfigurationResponse:
type: object
properties: {}
GetChatResponseConfigurationResponse:
type: object
properties:
chatResponseConfigurationId:
type: string
description: The unique identifier of the retrieved chat response configuration.
chatResponseConfigurationArn:
type: string
description: The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
displayName:
type: string
description: The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.
createdAt:
type: string
format: date-time
description: The timestamp indicating when the chat response configuration was initially created.
inUseConfiguration:
$ref: '#/components/schemas/ChatResponseConfigurationDetail'
lastUpdateConfiguration:
$ref: '#/components/schemas/ChatResponseConfigurationDetail'
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)