Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qbusiness ]

get-chat-controls-configuration¶

Description¶

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

Synopsis¶

  get-chat-controls-configuration
--application-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--application-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

responseScope -> (string)

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.

blockedPhrases -> (structure)

The phrases blocked from chat by your chat control configuration.

blockedPhrases -> (list)

A list of phrases blocked from a Amazon Q Business web experience chat.

(string)

systemMessageOverride -> (string)

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

topicConfigurations -> (list)

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

(structure)

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

name -> (string)

A name for your topic control configuration.

description -> (string)

A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

exampleChatMessages -> (list)

A list of example phrases that you expect the end user to use in relation to the topic.

(string)

rules -> (list)

Rules defined for a topic configuration.

(structure)

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

includedUsersAndGroups -> (structure)

Users and groups to be included in a rule.

userIds -> (list)

The user ids associated with a topic control rule.

(string)

userGroups -> (list)

The user groups associated with a topic control rule.

(string)

excludedUsersAndGroups -> (structure)

Users and groups to be excluded from a rule.

userIds -> (list)

The user ids associated with a topic control rule.

(string)

userGroups -> (list)

The user groups associated with a topic control rule.

(string)

ruleType -> (string)

The type of rule.

ruleConfiguration -> (tagged union structure)

The configuration information for a rule.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: contentBlockerRule, contentRetrievalRule.

contentBlockerRule -> (structure)

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

systemMessageOverride -> (string)

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

contentRetrievalRule -> (structure)

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

eligibleDataSources -> (list)

Specifies data sources in a Amazon Q Business application to use for content generation.

(structure)

The identifier of the data source Amazon Q Business will generate responses from.

indexId -> (string)

The identifier of the index the data source is attached to.

dataSourceId -> (string)

The identifier of the data source.

creatorModeConfiguration -> (structure)

The configuration details for CREATOR_MODE .

creatorModeControl -> (string)

Information about whether creator mode is enabled or disabled for an Amazon Q Business application.

nextToken -> (string)

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.

Table Of Contents

Feedback

User Guide