GetChatControlsConfigurationCommand

Suggest an Edit

Gets information about chat controls configured for an existing Amazon Q Business application.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, GetChatControlsConfigurationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetChatControlsConfigurationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetChatControlsConfigurationRequest
  applicationId: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new GetChatControlsConfigurationCommand(input);
const response = await client.send(command);
// { // GetChatControlsConfigurationResponse
//   responseScope: "ENTERPRISE_CONTENT_ONLY" || "EXTENDED_KNOWLEDGE_ENABLED",
//   orchestrationConfiguration: { // AppliedOrchestrationConfiguration
//     control: "ENABLED" || "DISABLED", // required
//   },
//   blockedPhrases: { // BlockedPhrasesConfiguration
//     blockedPhrases: [ // BlockedPhrases
//       "STRING_VALUE",
//     ],
//     systemMessageOverride: "STRING_VALUE",
//   },
//   topicConfigurations: [ // TopicConfigurations
//     { // TopicConfiguration
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       exampleChatMessages: [ // ExampleChatMessages
//         "STRING_VALUE",
//       ],
//       rules: [ // Rules // required
//         { // Rule
//           includedUsersAndGroups: { // UsersAndGroups
//             userIds: [ // UserIds
//               "STRING_VALUE",
//             ],
//             userGroups: [ // UserGroups
//               "STRING_VALUE",
//             ],
//           },
//           excludedUsersAndGroups: {
//             userIds: [
//               "STRING_VALUE",
//             ],
//             userGroups: [
//               "STRING_VALUE",
//             ],
//           },
//           ruleType: "CONTENT_BLOCKER_RULE" || "CONTENT_RETRIEVAL_RULE", // required
//           ruleConfiguration: { // RuleConfiguration Union: only one key present
//             contentBlockerRule: { // ContentBlockerRule
//               systemMessageOverride: "STRING_VALUE",
//             },
//             contentRetrievalRule: { // ContentRetrievalRule
//               eligibleDataSources: [ // EligibleDataSources
//                 { // EligibleDataSource
//                   indexId: "STRING_VALUE",
//                   dataSourceId: "STRING_VALUE",
//                 },
//               ],
//             },
//           },
//         },
//       ],
//     },
//   ],
//   creatorModeConfiguration: { // AppliedCreatorModeConfiguration
//     creatorModeControl: "ENABLED" || "DISABLED", // required
//   },
//   nextToken: "STRING_VALUE",
// };

GetChatControlsConfigurationCommand Input

See GetChatControlsConfigurationCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the application for which the chat controls are configured.

maxResults
number | undefined

The maximum number of configured chat controls to return.

nextToken
string | undefined

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.

GetChatControlsConfigurationCommand Output

See GetChatControlsConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
blockedPhrases
BlockedPhrasesConfiguration | undefined

The phrases blocked from chat by your chat control configuration.

creatorModeConfiguration
AppliedCreatorModeConfiguration | undefined

The configuration details for CREATOR_MODE.

nextToken
string | undefined

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.

orchestrationConfiguration
AppliedOrchestrationConfiguration | undefined

The chat response orchestration settings for your application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages .

responseScope
ResponseScope | undefined

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.

topicConfigurations
TopicConfiguration[] | undefined

The topic specific controls configured for a Amazon Q Business application.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.