AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QBusiness ChatSync API operation.

Syntax

Set-QBUSChatSync
-ApplicationId <String>
-Attachment <AttachmentInput[]>
-AttributeFilter <AttributeFilter>
-ChatMode <ChatMode>
-ConversationId <String>
-ParentMessageId <String>
-ActionExecution_Payload <Hashtable>
-ActionExecution_PayloadFieldNameSeparator <String>
-ActionExecution_PluginId <String>
-PluginConfiguration_PluginId <String>
-AuthChallengeResponse_ResponseMap <Hashtable>
-UserGroup <String[]>
-UserId <String>
-UserMessage <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQBusinessConfig>

Description

Starts or continues a non-streaming Amazon Q Business conversation.

Parameters

-ActionExecution_Payload <Hashtable>
A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActionExecution_PayloadFieldNameSeparator <String>
A string used to retain information about the hierarchical contexts within an action execution event payload.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActionExecution_PluginId <String>
The identifier of the plugin the action is attached to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApplicationId <String>
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Attachment <AttachmentInput[]>
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttachments
-AttributeFilter <AttributeFilter>
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthChallengeResponse_ResponseMap <Hashtable>
The mapping of key-value pairs in an authentication challenge response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ChatMode <ChatMode>
The chatMode parameter determines the chat modes available to Amazon Q Business users:
  • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge
  • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.
  • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.
If none of the modes are selected, Amazon Q will only respond using the information from the attached files.For more information, see Admin controls and guardrails, Plugins, and Response sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQBusinessConfig>
Amazon.PowerShell.Cmdlets.QBUS.AmazonQBusinessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A token that you provide to identify a chat request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConversationId <String>
The identifier of the Amazon Q Business conversation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParentMessageId <String>
The identifier of the previous system message in a conversation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PluginConfiguration_PluginId <String>
The identifier of the plugin you want to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChatModeConfiguration_PluginConfiguration_PluginId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ChatSyncResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ChatSyncResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserGroup <String[]>
The group names that a user associated with the chat input belongs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUserGroups
-UserId <String>
The identifier of the user attached to the chat input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserMessage <String>
A end user message in a conversation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QBusiness.Model.ChatSyncResponse
This cmdlet returns an Amazon.QBusiness.Model.ChatSyncResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z