AWS.Tools.QBusiness.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QBusiness</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.AddQBUSResourceTagCmdlet"> <summary> Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.AddQBUSResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.AddQBUSResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.AddQBUSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.AddQBUSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.AddQBUSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationCmdlet"> <summary> Gets information about an existing Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationCmdlet.Select"> <summary> 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.GetApplicationResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationListCmdlet"> <summary> Lists Amazon Q Business applications. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of Amazon Q Business applications to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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 applications.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Applications'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListApplicationsResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListApplicationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSChatControlsConfigurationCmdlet"> <summary> Gets information about an chat controls configured for an existing Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSChatControlsConfigurationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application for which the chat controls are configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSChatControlsConfigurationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of configured chat controls to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSChatControlsConfigurationCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSChatControlsConfigurationCmdlet.Select"> <summary> 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.GetChatControlsConfigurationResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetChatControlsConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSChatControlsConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet"> <summary> Lists one or more Amazon Q Business conversations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet.UserId"> <summary> <para> <para>The identifier of the user involved in the Amazon Q Business web experience conversation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of Amazon Q Business conversations to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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 conversations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Conversations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListConversationsResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListConversationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSConversationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceCmdlet"> <summary> Gets information about an existing Amazon Q Business data source connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceCmdlet.IndexId"> <summary> <para> <para>The identfier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceCmdlet.Select"> <summary> 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.GetDataSourceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet"> <summary> Lists the Amazon Q Business data source connectors that you have created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application linked to the data source connectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with one or more data source connectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of data source connectors to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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 data source connectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListDataSourcesResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListDataSourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet"> <summary> Get information about an Amazon Q Business data source connector synchronization. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application connected to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.DataSourceId"> <summary> <para> <para> The identifier of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.EndTime"> <summary> <para> <para> The end time of the data source connector sync.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the Amazon Q Business data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.StartTime"> <summary> <para> <para> The start time of the data source connector sync. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.StatusFilter"> <summary> <para> <para>Only returns synchronization jobs with the <c>Status</c> field equal to the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of synchronization jobs to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'History'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListDataSourceSyncJobsResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListDataSourceSyncJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDataSourceSyncJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet"> <summary> A list of documents attached to an index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application id the documents are attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data sources the documents are attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index the documents are attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of documents to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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 documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDetailList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListDocumentsResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSDocumentListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet"> <summary> Describes a group by group name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application id the group is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source the group is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet.IndexId"> <summary> <para> <para>The identifier of the index the group is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet.Select"> <summary> 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.GetGroupResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet"> <summary> Provides a list of groups that are mapped to users. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application for getting a list of groups mapped to users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source for getting a list of groups mapped to users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for getting a list of groups mapped to users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.UpdatedEarlierThan"> <summary> <para> <para>The timestamp identifier used for the latest <c>PUT</c> or <c>DELETE</c> action for mapping users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of returned groups that are mapped to users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.NextToken"> <summary> <para> <para>If the previous 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 groups that are mapped to users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListGroupsResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSGroupListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexCmdlet"> <summary> Gets information about an existing Amazon Q Business index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application connected to the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexCmdlet.IndexId"> <summary> <para> <para>The identifier of the Amazon Q Business index you want information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexCmdlet.Select"> <summary> 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.GetIndexResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexListCmdlet"> <summary> Lists the Amazon Q Business indices you have created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application connected to the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of indices to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexListCmdlet.NextToken"> <summary> <para> <para>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 indices.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Indices'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListIndicesResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListIndicesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSIndexListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet"> <summary> Gets a list of messages associated with an Amazon Q Business web experience. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.ApplicationId"> <summary> <para> <para>The identifier for the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.ConversationId"> <summary> <para> <para>The identifier of the Amazon Q Business web experience conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.UserId"> <summary> <para> <para>The identifier of the user involved in the Amazon Q Business web experience conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of messages to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.NextToken"> <summary> <para> <para>If the number of retrievers returned exceeds <c>maxResults</c>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Messages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListMessagesResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListMessagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSMessageListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConversationId parameter. The -PassThru parameter is deprecated, use -Select '^ConversationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginCmdlet"> <summary> Gets information about an existing Amazon Q Business plugin. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application which contains the plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginCmdlet.PluginId"> <summary> <para> <para>The identifier of the plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginCmdlet.Select"> <summary> 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.GetPluginResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetPluginResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PluginId parameter. The -PassThru parameter is deprecated, use -Select '^PluginId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginListCmdlet"> <summary> Lists configured Amazon Q Business plugins. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application the plugin is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of documents to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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 plugins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plugins'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListPluginsResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListPluginsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSPluginListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSResourceTagCmdlet"> <summary> Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverCmdlet"> <summary> Gets information about an existing retriever used by an Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application using the retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverCmdlet.RetrieverId"> <summary> <para> <para>The identifier of the retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverCmdlet.Select"> <summary> 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.GetRetrieverResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetRetrieverResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetrieverId parameter. The -PassThru parameter is deprecated, use -Select '^RetrieverId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverListCmdlet"> <summary> Lists the retriever used by an Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application using the retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of retrievers returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverListCmdlet.NextToken"> <summary> <para> <para>If the number of retrievers returned exceeds <c>maxResults</c>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Retrievers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListRetrieversResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListRetrieversResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSRetrieverListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSUserCmdlet"> <summary> Describes the universally unique identifier (UUID) associated with a local user in a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSUserCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application connected to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSUserCmdlet.UserId"> <summary> <para> <para>The user email address attached to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserAliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.GetUserResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceCmdlet"> <summary> Gets information about an existing Amazon Q Business web experience. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application linked to the web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceCmdlet.WebExperienceId"> <summary> <para> <para>The identifier of the Amazon Q Business web experience. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceCmdlet.Select"> <summary> 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.GetWebExperienceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.GetWebExperienceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebExperienceId parameter. The -PassThru parameter is deprecated, use -Select '^WebExperienceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceListCmdlet"> <summary> Lists one or more Amazon Q Business Web Experiences. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceListCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application linked to the listed web experiences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of Amazon Q Business Web Experiences to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceListCmdlet.NextToken"> <summary> <para> <para>If the <c>maxResults</c> 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 conversations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WebExperiences'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.ListWebExperiencesResponse). Specifying the name of a property of type Amazon.QBusiness.Model.ListWebExperiencesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.GetQBUSWebExperienceListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet"> <summary> Creates an Amazon Q Business application. <note><para> There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign subscription tiers to users. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.AttachmentsConfiguration_AttachmentsControlMode"> <summary> <para> <para>Status information about whether file upload functionality is activated or deactivated for your end user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.ClientIdsForOIDC"> <summary> <para> <para>The OIDC client ID for a Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.Description"> <summary> <para> <para>A description for the Amazon Q Business application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.DisplayName"> <summary> <para> <para>A name for the Amazon Q Business application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.IamIdentityProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.IdentityCenterInstanceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.IdentityType"> <summary> <para> <para>The authentication type being used by a Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.EncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.PersonalizationConfiguration_PersonalizationControlMode"> <summary> <para> <para>An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.QAppsConfiguration_QAppsControlMode"> <summary> <para> <para>Status information about whether end users can create and use Amazon Q Apps in the web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.RoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions">service linked role (SLR)</a> and use it as the application's role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.Select"> <summary> 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.CreateApplicationResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DisplayName parameter. The -PassThru parameter is deprecated, use -Select '^DisplayName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet"> <summary> Creates a data source connector for an Amazon Q Business application. <para><c>CreateDataSource</c> is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.ApplicationId"> <summary> <para> <para> The identifier of the Amazon Q Business application the data source will be attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.Configuration"> <summary> <para> <para>Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.</para><para>Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:</para><ul><li><para><a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html">Amazon S3 JSON schema</a></para></li><li><para><a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html">Web Crawler JSON schema</a></para></li></ul><para>You can find configuration templates for your specific data source using the following steps:</para><ol><li><para>Navigate to the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html">Supported connectors</a> page in the Amazon Q Business User Guide, and select the data source of your choice.</para></li><li><para>Then, from your specific data source connector page, select <b>Using the API</b>. You will find the JSON schema for your data source, including parameter descriptions, in this section.</para></li></ol> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.Description"> <summary> <para> <para>A description for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DisplayName"> <summary> <para> <para>A name for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index that you want to use with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_InlineConfiguration"> <summary> <para> <para>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_Key"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently doesn't support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_Key"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently doesn't support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PostExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for Custom Document Enrichment (CDE)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PreExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for Custom Document Enrichment (CDE)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_LongValue"> <summary> <para> <para>A long integer value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_LongValue"> <summary> <para> <para>A long integer value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_Operator"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_Operator"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PostExtractionHookConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PreExtractionHookConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PostExtractionHookConfiguration_S3BucketName"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PreExtractionHookConfiguration_S3BucketName"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_StringListValue"> <summary> <para> <para>A list of strings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_StringListValue"> <summary> <para> <para>A list of strings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_StringValue"> <summary> <para> <para>A string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_StringValue"> <summary> <para> <para>A string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.SyncSchedule"> <summary> <para> <para>Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.</para><para>Specify a <c>cron-</c> format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the <c>Schedule</c> parameter when the <c>Type</c> parameter is set to <c>CUSTOM</c>. If you do, you receive a <c>ValidationException</c> exception. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.ClientToken"> <summary> <para> <para>A token you provide to identify a request to create a data source connector. Multiple calls to the <c>CreateDataSource</c> API with the same client token will create only one data source connector. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.Select"> <summary> 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.CreateDataSourceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet"> <summary> Creates an Amazon Q Business index. <para> To determine if index creation has completed, check the <c>Status</c> field returned from a call to <c>DescribeIndex</c>. The <c>Status</c> field is set to <c>ACTIVE</c> when the index is ready to use. </para><para> Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html"><c>BatchPutDocument</c></a> API or the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html"><c>CreateDataSource</c></a> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application using the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.Description"> <summary> <para> <para>A description for the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.DisplayName"> <summary> <para> <para>A name for the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.Type"> <summary> <para> <para>The index type that's suitable for your needs. For more information on what's included in each type of index, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers">Amazon Q Business tiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.CapacityConfiguration_Unit"> <summary> <para> <para>The number of storage units configured for an Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create an index. Multiple calls to the <c>CreateIndex</c> API with the same client token will create only one index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.Select"> <summary> 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.CreateIndexResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet"> <summary> Creates an Amazon Q Business plugin. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.CustomPluginConfiguration_ApiSchemaType"> <summary> <para> <para>The type of OpenAPI schema to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application that will contain the plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.S3_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.CustomPluginConfiguration_Description"> <summary> <para> <para>A description for your custom plugin configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.DisplayName"> <summary> <para> <para>A the name for your plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.S3_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.AuthConfiguration_NoAuthConfiguration"> <summary> <para> <para>Information about invoking a custom plugin without any authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.ApiSchema_Payload"> <summary> <para> <para>The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.BasicAuthConfiguration_RoleArn"> <summary> <para> <para>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.OAuth2ClientCredentialConfiguration_RoleArn"> <summary> <para> <para>The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.BasicAuthConfiguration_SecretArn"> <summary> <para> <para>The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.OAuth2ClientCredentialConfiguration_SecretArn"> <summary> <para> <para>The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.ServerUrl"> <summary> <para> <para>The source URL used for plugin configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.Type"> <summary> <para> <para>The type of plugin you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create your Amazon Q Business plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.Select"> <summary> 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.CreatePluginResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreatePluginResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSPluginCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet"> <summary> Adds a retriever to your Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.ApplicationId"> <summary> <para> <para>The identifier of your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.NativeIndexConfiguration_BoostingOverride"> <summary> <para> <para>Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.DisplayName"> <summary> <para> <para>The name of your retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.KendraIndexConfiguration_IndexId"> <summary> <para> <para>The identifier of the Amazon Kendra index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.NativeIndexConfiguration_IndexId"> <summary> <para> <para>The identifier for the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.RoleArn"> <summary> <para> <para>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.Type"> <summary> <para> <para>The type of retriever you are using.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create your Amazon Q Business application retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.Select"> <summary> 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.CreateRetrieverResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateRetrieverResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSRetrieverCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet"> <summary> Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application for which the user mapping will be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.UserAlias"> <summary> <para> <para>The list of user aliases in the mapping.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.UserId"> <summary> <para> <para>The user emails attached to a user mapping.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create your Amazon Q Business user mapping.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.CreateUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet"> <summary> Creates an Amazon Q Business web experience. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.SamlConfiguration_AuthenticationUrl"> <summary> <para> <para>The URL where Amazon Q Business end users will be redirected for authentication. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.Origin"> <summary> <para> Amazon.QBusiness.Model.CreateWebExperienceRequest.Origins </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role attached to your web experience.</para><note><para>You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.SamplePromptsControlMode"> <summary> <para> <para>Determines whether sample prompts are enabled in the web experience for an end user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.OpenIDConnectConfiguration_SecretsArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.OpenIDConnectConfiguration_SecretsRole"> <summary> <para> <para>An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.Subtitle"> <summary> <para> <para>A subtitle to personalize your Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.Title"> <summary> <para> <para>The title for your Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.WelcomeMessage"> <summary> <para> <para>The customized welcome message for end users of an Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.ClientToken"> <summary> <para> <para>A token you provide to identify a request to create an Amazon Q Business web experience. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.Select"> <summary> 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.CreateWebExperienceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateWebExperienceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.NewQBUSWebExperienceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSApplicationCmdlet"> <summary> Deletes an Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSApplicationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSApplicationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet"> <summary> Asynchronously deletes one or more documents added using the <c>BatchPutDocument</c> API from an Amazon Q Business index. <para> You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.DataSourceSyncId"> <summary> <para> <para>The identifier of the data source sync during which the documents were deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.Document"> <summary> <para> <para>Documents deleted from the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.IndexId"> <summary> <para> <para>The identifier of the Amazon Q Business index that contains the documents to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedDocuments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.BatchDeleteDocumentResponse). Specifying the name of a property of type Amazon.QBusiness.Model.BatchDeleteDocumentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSBatchDeleteDocumentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSChatControlsConfigurationCmdlet"> <summary> Deletes chat controls configured for an existing Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSChatControlsConfigurationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application the chat controls have been configured for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSChatControlsConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteChatControlsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSChatControlsConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSChatControlsConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet"> <summary> Deletes an Amazon Q Business web experience conversation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application associated with the conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet.ConversationId"> <summary> <para> <para>The identifier of the Amazon Q Business web experience conversation being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet.UserId"> <summary> <para> <para>The identifier of the user who is deleting the conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteConversationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConversationId parameter. The -PassThru parameter is deprecated, use -Select '^ConversationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSConversationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet"> <summary> Deletes an Amazon Q Business data source connector. While the data source is being deleted, the <c>Status</c> field returned by a call to the <c>DescribeDataSource</c> API is set to <c>DELETING</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source connector that you want to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteDataSourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet"> <summary> Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. <para> If you want to delete, update, or replace users or sub groups of a group, you need to use the <c>PutGroup</c> operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling <c>PutGroup</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application in which the group mapping belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source linked to the group</para><para>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to delete the group from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSIndexCmdlet"> <summary> Deletes an Amazon Q Business index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSIndexCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSIndexCmdlet.IndexId"> <summary> <para> <para>The identifier of the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSPluginCmdlet"> <summary> Deletes an Amazon Q Business plugin. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSPluginCmdlet.ApplicationId"> <summary> <para> <para>The identifier the application attached to the Amazon Q Business plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSPluginCmdlet.PluginId"> <summary> <para> <para>The identifier of the plugin being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSPluginCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeletePluginResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSPluginCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PluginId parameter. The -PassThru parameter is deprecated, use -Select '^PluginId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSPluginCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSResourceTagCmdlet"> <summary> Removes a tag from an Amazon Q Business application or a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSRetrieverCmdlet"> <summary> Deletes the retriever used by an Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSRetrieverCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application using the retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSRetrieverCmdlet.RetrieverId"> <summary> <para> <para>The identifier of the retriever being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSRetrieverCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteRetrieverResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSRetrieverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetrieverId parameter. The -PassThru parameter is deprecated, use -Select '^RetrieverId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSRetrieverCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSUserCmdlet"> <summary> Deletes a user by email id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSUserCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application from which the user is being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSUserCmdlet.UserId"> <summary> <para> <para>The user email being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSWebExperienceCmdlet"> <summary> Deletes an Amazon Q Business web experience. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSWebExperienceCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSWebExperienceCmdlet.WebExperienceId"> <summary> <para> <para>The identifier of the Amazon Q Business web experience being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSWebExperienceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.DeleteWebExperienceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSWebExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebExperienceId parameter. The -PassThru parameter is deprecated, use -Select '^WebExperienceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.RemoveQBUSWebExperienceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet"> <summary> Adds one or more documents to an Amazon Q Business index. <para> You use this API to: </para><ul><li><para> ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. </para></li><li><para> add custom attributes to documents in an Amazon Q Business index. </para></li><li><para> attach an access control list to the documents added to an Amazon Q Business index. </para></li></ul><para> You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.DataSourceSyncId"> <summary> <para> <para>The identifier of the data source sync during which the documents were added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.Document"> <summary> <para> <para>One or more documents to add to the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.IndexId"> <summary> <para> <para>The identifier of the Amazon Q Business index to add the documents to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedDocuments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.BatchPutDocumentResponse). Specifying the name of a property of type Amazon.QBusiness.Model.BatchPutDocumentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSBatchPutDocumentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet"> <summary> Starts or continues a non-streaming Amazon Q Business conversation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.Attachment"> <summary> <para> <para>A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.AttributeFilter"> <summary> <para> <para>Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ChatMode"> <summary> <para> <para>The chat modes available to an Amazon Q Business end user.</para><ul><li><para><c>RETRIEVAL_MODE</c> - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.</para></li><li><para><c>CREATOR_MODE</c> - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.</para></li><li><para><c>PLUGIN_MODE</c> - By selecting this mode, users can choose to use plugins in chat.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>, and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ConversationId"> <summary> <para> <para>The identifier of the Amazon Q Business conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ParentMessageId"> <summary> <para> <para>The identifier of the previous system message in a conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ActionExecution_Payload"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ActionExecution_PayloadFieldNameSeparator"> <summary> <para> <para>A string used to retain information about the hierarchical contexts within an action execution event payload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ActionExecution_PluginId"> <summary> <para> <para>The identifier of the plugin the action is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.PluginConfiguration_PluginId"> <summary> <para> <para> The identifier of the plugin you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.AuthChallengeResponse_ResponseMap"> <summary> <para> <para>The mapping of key-value pairs in an authentication challenge response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.UserGroup"> <summary> <para> <para>The group names that a user associated with the chat input belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.UserId"> <summary> <para> <para>The identifier of the user attached to the chat input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.UserMessage"> <summary> <para> <para>A end user message in a conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify a chat request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.SetQBUSChatSyncCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet"> <summary> Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a <c>ConflictException</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet.ApplicationId"> <summary> <para> <para>The identifier of Amazon Q Business application the data source is connected to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet.DataSourceId"> <summary> <para> <para> The identifier of the data source connector. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.StartDataSourceSyncJobResponse). Specifying the name of a property of type Amazon.QBusiness.Model.StartDataSourceSyncJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StartQBUSDataSourceSyncJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet"> <summary> Stops an Amazon Q Business data source connector synchronization job already in progress. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application that the data source is connected to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet.DataSourceId"> <summary> <para> <para> The identifier of the data source connector. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the Amazon Q Business data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.StopDataSourceSyncJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.StopQBUSDataSourceSyncJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet"> <summary> Updates an existing Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.AttachmentsConfiguration_AttachmentsControlMode"> <summary> <para> <para>Status information about whether file upload functionality is activated or deactivated for your end user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.AutoSubscriptionConfiguration_AutoSubscribe"> <summary> <para> <para>Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.AutoSubscriptionConfiguration_DefaultSubscriptionType"> <summary> <para> <para>Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for <c>autoSubscribe</c> is set to <c>ENABLED</c> you must select a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.Description"> <summary> <para> <para>A description for the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.DisplayName"> <summary> <para> <para>A name for the Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.IdentityCenterInstanceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.PersonalizationConfiguration_PersonalizationControlMode"> <summary> <para> <para>An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.QAppsConfiguration_QAppsControlMode"> <summary> <para> <para>Status information about whether end users can create and use Amazon Q Apps in the web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.RoleArn"> <summary> <para> <para>An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdateApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet"> <summary> Updates an set of chat controls configured for an existing Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application for which the chat controls are configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.BlockedPhrasesConfigurationUpdate_BlockedPhrasesToCreateOrUpdate"> <summary> <para> <para>Creates or updates a blocked phrases configuration in your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.BlockedPhrasesConfigurationUpdate_BlockedPhrasesToDelete"> <summary> <para> <para>Deletes a blocked phrases configuration in your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.CreatorModeConfiguration_CreatorModeControl"> <summary> <para> <para>Status information about whether <c>CREATOR_MODE</c> has been enabled or disabled. The default status is <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.ResponseScope"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.BlockedPhrasesConfigurationUpdate_SystemMessageOverride"> <summary> <para> <para>The configured custom message displayed to your end user when they use blocked phrase during chat.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.TopicConfigurationsToCreateOrUpdate"> <summary> <para> <para>The configured topic specific chat controls you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.TopicConfigurationsToDelete"> <summary> <para> <para>The configured topic specific chat controls you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to update a Amazon Q Business application chat configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdateChatControlsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSChatControlsConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet"> <summary> Updates an existing Amazon Q Business data source connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.ApplicationId"> <summary> <para> <para> The identifier of the Amazon Q Business application the data source is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.Configuration"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.Description"> <summary> <para> <para>The description of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DisplayName"> <summary> <para> <para>A name of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index attached to the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_InlineConfiguration"> <summary> <para> <para>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_Key"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently doesn't support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_Key"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently doesn't support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PostExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for Custom Document Enrichment (CDE)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PreExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for Custom Document Enrichment (CDE)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_LongValue"> <summary> <para> <para>A long integer value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_LongValue"> <summary> <para> <para>A long integer value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_Operator"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_Operator"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Q Business currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PostExtractionHookConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PreExtractionHookConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PostExtractionHookConfiguration_S3BucketName"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PreExtractionHookConfiguration_S3BucketName"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_StringListValue"> <summary> <para> <para>A list of strings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_StringListValue"> <summary> <para> <para>A list of strings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PostInvocationCondition_StringValue"> <summary> <para> <para>A string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.DocumentEnrichmentConfiguration_PreInvocationCondition_StringValue"> <summary> <para> <para>A string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.SyncSchedule"> <summary> <para> <para>The chosen update frequency for your data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdateDataSourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet"> <summary> Updates an Amazon Q Business index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application connected to the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.Description"> <summary> <para> <para>The description of the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.DisplayName"> <summary> <para> <para>The name of the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.DocumentAttributeConfiguration"> <summary> <para> <para>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.IndexId"> <summary> <para> <para>The identifier of the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.CapacityConfiguration_Unit"> <summary> <para> <para>The number of storage units configured for an Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdateIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet"> <summary> Updates an Amazon Q Business plugin. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.CustomPluginConfiguration_ApiSchemaType"> <summary> <para> <para>The type of OpenAPI schema to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application the plugin is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.S3_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.CustomPluginConfiguration_Description"> <summary> <para> <para>A description for your custom plugin configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.DisplayName"> <summary> <para> <para>The name of the plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.S3_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.AuthConfiguration_NoAuthConfiguration"> <summary> <para> <para>Information about invoking a custom plugin without any authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.ApiSchema_Payload"> <summary> <para> <para>The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.PluginId"> <summary> <para> <para>The identifier of the plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.BasicAuthConfiguration_RoleArn"> <summary> <para> <para>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.OAuth2ClientCredentialConfiguration_RoleArn"> <summary> <para> <para>The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.BasicAuthConfiguration_SecretArn"> <summary> <para> <para>The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.OAuth2ClientCredentialConfiguration_SecretArn"> <summary> <para> <para>The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.ServerUrl"> <summary> <para> <para>The source URL used for plugin configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.State"> <summary> <para> <para>The status of the plugin. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdatePluginResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PluginId parameter. The -PassThru parameter is deprecated, use -Select '^PluginId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSPluginCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet"> <summary> Updates the retriever used for your Amazon Q Business application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.ApplicationId"> <summary> <para> <para>The identifier of your Amazon Q Business application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.NativeIndexConfiguration_BoostingOverride"> <summary> <para> <para>Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.DisplayName"> <summary> <para> <para>The name of your retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.KendraIndexConfiguration_IndexId"> <summary> <para> <para>The identifier of the Amazon Kendra index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.NativeIndexConfiguration_IndexId"> <summary> <para> <para>The identifier for the Amazon Q Business index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.RetrieverId"> <summary> <para> <para>The identifier of your retriever.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdateRetrieverResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetrieverId parameter. The -PassThru parameter is deprecated, use -Select '^RetrieverId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSRetrieverCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet"> <summary> Updates a information associated with a user id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application the user is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.UserAliasesToDelete"> <summary> <para> <para>The user aliases attached to the user id that are to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.UserAliasesToUpdate"> <summary> <para> <para>The user aliases attached to the user id that are to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.UserId"> <summary> <para> <para>The email id attached to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.Select"> <summary> 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.UpdateUserResponse). Specifying the name of a property of type Amazon.QBusiness.Model.UpdateUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet"> <summary> Updates an Amazon Q Business web experience. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the Amazon Q Business application attached to the web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.SamlConfiguration_AuthenticationUrl"> <summary> <para> <para>The URL where Amazon Q Business end users will be redirected for authentication. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.SamlConfiguration_MetadataXML"> <summary> <para> <para>The metadata XML that your IdP generated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.Origin"> <summary> <para> Amazon.QBusiness.Model.UpdateWebExperienceRequest.Origins </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.SamlConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.SamplePromptsControlMode"> <summary> <para> <para>Determines whether sample prompts are enabled in the web experience for an end user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.OpenIDConnectConfiguration_SecretsArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.OpenIDConnectConfiguration_SecretsRole"> <summary> <para> <para>An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.Subtitle"> <summary> <para> <para>The subtitle of the Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.Title"> <summary> <para> <para>The title of the Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.SamlConfiguration_UserGroupAttribute"> <summary> <para> <para>The group attribute name in your IdP that maps to user groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.SamlConfiguration_UserIdAttribute"> <summary> <para> <para>The user attribute name in your IdP that maps to the user email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.WebExperienceId"> <summary> <para> <para>The identifier of the Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.WelcomeMessage"> <summary> <para> <para>A customized welcome message for an end user in an Amazon Q Business web experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.UpdateWebExperienceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebExperienceId parameter. The -PassThru parameter is deprecated, use -Select '^WebExperienceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.UpdateQBUSWebExperienceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet"> <summary> Enables your end user to provide feedback on their Amazon Q Business generated chat responses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application associated with the feedback.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.MessageUsefulness_Comment"> <summary> <para> <para>A comment given by an end user on the usefulness of an AI-generated chat message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.ConversationId"> <summary> <para> <para>The identifier of the conversation the feedback is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.MessageCopiedAt"> <summary> <para> <para>The timestamp for when the feedback was recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.MessageId"> <summary> <para> <para>The identifier of the chat message that the feedback was given for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.MessageUsefulness_Reason"> <summary> <para> <para>The reason for a usefulness rating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.MessageUsefulness_SubmittedAt"> <summary> <para> <para>The timestamp for when the feedback was submitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.MessageUsefulness_Usefulness"> <summary> <para> <para>The usefulness value assigned by an end user to a message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.UserId"> <summary> <para> <para>The identifier of the user giving the feedback.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.PutFeedbackResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MessageId parameter. The -PassThru parameter is deprecated, use -Select '^MessageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSFeedbackCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet"> <summary> Create, or updates, a mapping of users—who have access to a document—to groups. <para> You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.ApplicationId"> <summary> <para> <para>The identifier of the application in which the user and group mapping belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.GroupName"> <summary> <para> <para>The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.IndexId"> <summary> <para> <para>The identifier of the index in which you want to map users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.GroupMembers_MemberGroup"> <summary> <para> <para>A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.GroupMembers_MemberUser"> <summary> <para> <para>A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.Type"> <summary> <para> <para>The type of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.PutGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QBUS.WriteQBUSGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |