AWS.Tools.QConnect.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QConnect</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QC.AddQCResourceTagCmdlet"> <summary> Adds the specified tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.AddQCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.AddQCResourceTagCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.AddQCResourceTagCmdlet.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.QConnect.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.AddQCResourceTagCmdlet.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.QC.AddQCResourceTagCmdlet.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.QC.GetQCAIAgentCmdlet"> <summary> Gets an Amazon Q in Connect AI Agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentCmdlet.AiAgentId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentCmdlet.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.QConnect.Model.GetAIAgentResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetAIAgentResponse 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.QC.GetQCAIAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiAgentId parameter. The -PassThru parameter is deprecated, use -Select '^AiAgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentListCmdlet"> <summary> Lists AI Agents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentListCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentListCmdlet.Origin"> <summary> <para> <para>The origin of the AI Agents to be listed. <c>SYSTEM</c> for a default AI Agent created by Q in Connect or <c>CUSTOMER</c> for an AI Agent created by calling AI Agent creation APIs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiAgentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListAIAgentsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListAIAgentsResponse 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.QC.GetQCAIAgentListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet"> <summary> List AI Agent versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet.AiAgentId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet.Origin"> <summary> <para> <para>The origin of the AI Agent versions to be listed. <c>SYSTEM</c> for a default AI Agent created by Q in Connect or <c>CUSTOMER</c> for an AI Agent created by calling AI Agent creation APIs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIAgentVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiAgentVersionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListAIAgentVersionsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListAIAgentVersionsResponse 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.QC.GetQCAIAgentVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiAgentId parameter. The -PassThru parameter is deprecated, use -Select '^AiAgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptCmdlet"> <summary> Gets and Amazon Q in Connect AI Prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptCmdlet.AiPromptId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptCmdlet.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.QConnect.Model.GetAIPromptResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetAIPromptResponse 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.QC.GetQCAIPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiPromptId parameter. The -PassThru parameter is deprecated, use -Select '^AiPromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptListCmdlet"> <summary> Lists the AI Prompts available on the Amazon Q in Connect assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptListCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptListCmdlet.Origin"> <summary> <para> <para>The origin of the AI Prompts to be listed. <c>SYSTEM</c> for a default AI Agent created by Q in Connect or <c>CUSTOMER</c> for an AI Agent created by calling AI Agent creation APIs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiPromptSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListAIPromptsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListAIPromptsResponse 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.QC.GetQCAIPromptListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet"> <summary> Lists AI Prompt versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet.AiPromptId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet.Origin"> <summary> <para> <para>The origin of the AI Prompt versions to be listed. <c>SYSTEM</c> for a default AI Agent created by Q in Connect or <c>CUSTOMER</c> for an AI Agent created by calling AI Agent creation APIs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAIPromptVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiPromptVersionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListAIPromptVersionsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListAIPromptVersionsResponse 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.QC.GetQCAIPromptVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiPromptId parameter. The -PassThru parameter is deprecated, use -Select '^AiPromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantCmdlet"> <summary> Retrieves information about an assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Assistant'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetAssistantResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetAssistantResponse 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.QC.GetQCAssistantCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationCmdlet"> <summary> Retrieves information about an assistant association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationCmdlet.AssistantAssociationId"> <summary> <para> <para>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssistantAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetAssistantAssociationResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetAssistantAssociationResponse 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.QC.GetQCAssistantAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationListCmdlet"> <summary> Lists information about assistant associations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationListCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssistantAssociationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListAssistantAssociationsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListAssistantAssociationsResponse 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.QC.GetQCAssistantAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantListCmdlet"> <summary> Lists information about assistants. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCAssistantListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssistantSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListAssistantsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListAssistantsResponse 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.QC.GetQCContentCmdlet"> <summary> Retrieves content, including a pre-signed URL to download the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentCmdlet.ContentId"> <summary> <para> <para>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Content'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetContentResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetContentResponse 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.QC.GetQCContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContentId parameter. The -PassThru parameter is deprecated, use -Select '^ContentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationCmdlet"> <summary> Returns the content association. <para> For more information about content associations--what they are and when they are used--see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationCmdlet.ContentAssociationId"> <summary> <para> <para>The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationCmdlet.ContentId"> <summary> <para> <para>The identifier of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContentAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetContentAssociationResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetContentAssociationResponse 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.QC.GetQCContentAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContentAssociationId parameter. The -PassThru parameter is deprecated, use -Select '^ContentAssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationListCmdlet"> <summary> Lists the content associations. <para> For more information about content associations--what they are and when they are used--see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationListCmdlet.ContentId"> <summary> <para> <para>The identifier of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContentAssociationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListContentAssociationsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListContentAssociationsResponse 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.QC.GetQCContentAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContentId parameter. The -PassThru parameter is deprecated, use -Select '^ContentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCContentListCmdlet"> <summary> Lists the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListContentsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListContentsResponse 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.QC.GetQCContentListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCContentSummaryCmdlet"> <summary> Retrieves summary information about the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentSummaryCmdlet.ContentId"> <summary> <para> <para>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentSummaryCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCContentSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContentSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetContentSummaryResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetContentSummaryResponse 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.QC.GetQCContentSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContentId parameter. The -PassThru parameter is deprecated, use -Select '^ContentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobCmdlet"> <summary> Retrieves the started import job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobCmdlet.ImportJobId"> <summary> <para> <para>The identifier of the import job to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base that the import job belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetImportJobResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetImportJobResponse 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.QC.GetQCImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImportJobId parameter. The -PassThru parameter is deprecated, use -Select '^ImportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobListCmdlet"> <summary> Lists information about import jobs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListImportJobsResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListImportJobsResponse 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.QC.GetQCImportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBaseCmdlet"> <summary> Retrieves information about the knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetKnowledgeBaseResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetKnowledgeBaseResponse 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.QC.GetQCKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBasisListCmdlet"> <summary> Lists the knowledge bases. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBasisListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBasisListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCKnowledgeBasisListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBaseSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListKnowledgeBasesResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListKnowledgeBasesResponse 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.QC.GetQCQuickResponseCmdlet"> <summary> Retrieves the quick response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseCmdlet.QuickResponseId"> <summary> <para> <para>The identifier of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetQuickResponseResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetQuickResponseResponse 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.QC.GetQCQuickResponseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QuickResponseId parameter. The -PassThru parameter is deprecated, use -Select '^QuickResponseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseListCmdlet"> <summary> Lists information about quick response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCQuickResponseListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickResponseSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.ListQuickResponsesResponse). Specifying the name of a property of type Amazon.QConnect.Model.ListQuickResponsesResponse 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.QC.GetQCQuickResponseListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCRecommendationCmdlet"> <summary> <important><para> This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. </para></important><para> Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the <c>waitTimeSeconds</c> parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html">QueryAssistant</a>. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCRecommendationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCRecommendationCmdlet.SessionId"> <summary> <para> <para>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCRecommendationCmdlet.WaitTimeSecond"> <summary> <para> <para>The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than <c>WaitTimeSeconds</c>. If no messages are available and the wait time expires, the call returns successfully with an empty list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCRecommendationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCRecommendationCmdlet.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.QConnect.Model.GetRecommendationsResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetRecommendationsResponse 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.QC.GetQCRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.GetQCResourceTagCmdlet"> <summary> Lists the tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCResourceTagCmdlet.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.QConnect.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.QConnect.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.QC.GetQCResourceTagCmdlet.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.QC.GetQCSessionCmdlet"> <summary> Retrieves information for a specified session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCSessionCmdlet.SessionId"> <summary> <para> <para>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.GetQCSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.GetSessionResponse). Specifying the name of a property of type Amazon.QConnect.Model.GetSessionResponse 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.QC.GetQCSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet"> <summary> Creates an Amazon Q in Connect AI Agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Answer Generation prompt used by the <c>ANSWER_RECOMMENDATION</c> AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.ManualSearchAIAgentConfiguration_AnswerGenerationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_AssociationConfiguration"> <summary> <para> <para>The association configurations for overriding behavior on this AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.ManualSearchAIAgentConfiguration_AssociationConfiguration"> <summary> <para> <para>The association configurations for overriding behavior on this AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.Description"> <summary> <para> <para>The description of the AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_IntentLabelingGenerationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Intent Labeling prompt used by the <c>ANSWER_RECOMMENDATION</c> AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.Name"> <summary> <para> <para>The name of the AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_QueryReformulationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Query Reformulation prompt used by the <c>ANSWER_RECOMMENDATION</c> AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.Type"> <summary> <para> <para>The type of the AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.VisibilityStatus"> <summary> <para> <para>The visibility status of the AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiAgent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateAIAgentResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAIAgentResponse 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.QC.NewQCAIAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentCmdlet.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.QC.NewQCAIAgentVersionCmdlet"> <summary> Creates and Amazon Q in Connect AI Agent version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentVersionCmdlet.AiAgentId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentVersionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentVersionCmdlet.ModifiedTime"> <summary> <para> <para>The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentVersionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentVersionCmdlet.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.QConnect.Model.CreateAIAgentVersionResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAIAgentVersionResponse 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.QC.NewQCAIAgentVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiAgentId parameter. The -PassThru parameter is deprecated, use -Select '^AiAgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIAgentVersionCmdlet.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.QC.NewQCAIPromptCmdlet"> <summary> Creates an Amazon Q in Connect AI Prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.ApiFormat"> <summary> <para> <para>The API Format of the AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.Description"> <summary> <para> <para>The description of the AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.ModelId"> <summary> <para> <para>The identifier of the model used for this AI Prompt. Model Ids supported are: <c>CLAUDE_3_HAIKU_20240307_V1</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.Name"> <summary> <para> <para>The name of the AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.TemplateType"> <summary> <para> <para>The type of the prompt template for this AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.TextFullAIPromptEditTemplateConfiguration_Text"> <summary> <para> <para>The YAML text for the AI Prompt template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.Type"> <summary> <para> <para>The type of this AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.VisibilityStatus"> <summary> <para> <para>The visibility status of the AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiPrompt'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateAIPromptResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAIPromptResponse 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.QC.NewQCAIPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptCmdlet.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.QC.NewQCAIPromptVersionCmdlet"> <summary> Creates an Amazon Q in Connect AI Prompt version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptVersionCmdlet.AiPromptId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptVersionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptVersionCmdlet.ModifiedTime"> <summary> <para> <para>The time the AI Prompt was last modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptVersionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptVersionCmdlet.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.QConnect.Model.CreateAIPromptVersionResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAIPromptVersionResponse 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.QC.NewQCAIPromptVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiPromptId parameter. The -PassThru parameter is deprecated, use -Select '^AiPromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAIPromptVersionCmdlet.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.QC.NewQCAssistantCmdlet"> <summary> Creates an Amazon Q in Connect assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.Description"> <summary> <para> <para>The description of the assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.Name"> <summary> <para> <para>The name of the assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.Type"> <summary> <para> <para>The type of assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Assistant'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateAssistantResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAssistantResponse 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.QC.NewQCAssistantCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantCmdlet.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.QC.NewQCAssistantAssociationCmdlet"> <summary> Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.AssociationType"> <summary> <para> <para>The type of association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.Association_KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssistantAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateAssistantAssociationResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAssistantAssociationResponse 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.QC.NewQCAssistantAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCAssistantAssociationCmdlet.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.QC.NewQCContentCmdlet"> <summary> Creates Amazon Q in Connect content. Before to calling this API, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to upload an asset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.Metadata"> <summary> <para> <para>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.Name"> <summary> <para> <para>The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.OverrideLinkOutUri"> <summary> <para> <para>The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.Title"> <summary> <para> <para>The title of the content. If not set, the title is equal to the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.UploadId"> <summary> <para> <para>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Content'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateContentResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateContentResponse 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.QC.NewQCContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentCmdlet.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.QC.NewQCContentAssociationCmdlet"> <summary> Creates an association between a content resource in a knowledge base and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step guides</a>. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. <para> After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content. </para><para> Note the following limitations: </para><ul><li><para> You can create only one content association for each content resource in a knowledge base. </para></li><li><para> You can associate a step-by-step guide with multiple content resources. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.AssociationType"> <summary> <para> <para>The type of association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.ContentId"> <summary> <para> <para>The identifier of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.AmazonConnectGuideAssociation_FlowId"> <summary> <para> <para> The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContentAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateContentAssociationResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateContentAssociationResponse 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.QC.NewQCContentAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContentId parameter. The -PassThru parameter is deprecated, use -Select '^ContentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCContentAssociationCmdlet.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.QC.NewQCKnowledgeBaseCmdlet"> <summary> Creates a knowledge base. <note><para> When using this API, you cannot reuse <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a> DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an <c>InvalidRequestException</c> error. </para><para> For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: </para><ol><li><para> Call <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>. </para></li><li><para> Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>. </para></li><li><para> Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one. </para></li><li><para> Call CreateKnowledgeBase. </para></li></ol></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.AppIntegrations_AppIntegrationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</para><ul><li><para> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least <c>Id</c>, <c>ArticleNumber</c>, <c>VersionNumber</c>, <c>Title</c>, <c>PublishStatus</c>, and <c>IsDeleted</c> as source fields. </para></li><li><para> For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least <c>number</c>, <c>short_description</c>, <c>sys_mod_count</c>, <c>workflow_state</c>, and <c>active</c> as source fields. </para></li><li><para> For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/"> Zendesk</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if <c>objectFields</c> is not provided, including at least <c>id</c>, <c>title</c>, <c>updated_at</c>, and <c>draft</c> as source fields. </para></li><li><para> For <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index">SharePoint</a>, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among <c>docx</c>, <c>pdf</c>, <c>html</c>, <c>htm</c>, and <c>txt</c>. </para></li><li><para> For <a href="http://aws.amazon.com/s3/">Amazon S3</a>, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The <c>SourceURI</c> of your DataIntegration must use the following format: <c>s3://your_s3_bucket_name</c>.</para><important><para>The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal <c>app-integrations.amazonaws.com</c> to perform <c>s3:ListBucket</c>, <c>s3:GetObject</c>, and <c>s3:GetBucketLocation</c> against the bucket.</para></important></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.SemanticChunkingConfiguration_BreakpointPercentileThreshold"> <summary> <para> <para>The dissimilarity threshold for splitting chunks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.SemanticChunkingConfiguration_BufferSize"> <summary> <para> <para>The buffer size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.ChunkingConfiguration_ChunkingStrategy"> <summary> <para> <para>Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for <c>NONE</c>, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.WebCrawlerConfiguration_ExclusionFilter"> <summary> <para> <para>A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.WebCrawlerConfiguration_InclusionFilter"> <summary> <para> <para>A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.KnowledgeBaseType"> <summary> <para> <para>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.HierarchicalChunkingConfiguration_LevelConfiguration"> <summary> <para> <para>Token settings for each layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.FixedSizeChunkingConfiguration_MaxToken"> <summary> <para> <para>The maximum number of tokens to include in a chunk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.SemanticChunkingConfiguration_MaxToken"> <summary> <para> <para>The maximum number of tokens that a chunk can contain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.BedrockFoundationModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the foundation model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.Name"> <summary> <para> <para>The name of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.AppIntegrations_ObjectField"> <summary> <para> <para>The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. </para><ul><li><para> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, you must include at least <c>Id</c>, <c>ArticleNumber</c>, <c>VersionNumber</c>, <c>Title</c>, <c>PublishStatus</c>, and <c>IsDeleted</c>. </para></li><li><para>For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, you must include at least <c>number</c>, <c>short_description</c>, <c>sys_mod_count</c>, <c>workflow_state</c>, and <c>active</c>. </para></li><li><para>For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/"> Zendesk</a>, you must include at least <c>id</c>, <c>title</c>, <c>updated_at</c>, and <c>draft</c>. </para></li></ul><para>Make sure to include additional fields. These fields are indexed and used to source recommendations. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.FixedSizeChunkingConfiguration_OverlapPercentage"> <summary> <para> <para>The percentage of overlap between adjacent chunks of a data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.HierarchicalChunkingConfiguration_OverlapToken"> <summary> <para> <para>The number of tokens to repeat across chunks in the same layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.ParsingPrompt_ParsingPromptText"> <summary> <para> <para>Instructions for interpreting the contents of a document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.ParsingConfiguration_ParsingStrategy"> <summary> <para> <para>The parsing strategy for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.CrawlerLimits_RateLimit"> <summary> <para> <para>Rate of web URLs retrieved per minute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.WebCrawlerConfiguration_Scope"> <summary> <para> <para>The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL <c>https://docs.aws.amazon.com/bedrock/latest/userguide/</c> and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain <c>aws.amazon.com</c> can also include sub domain <c>docs.aws.amazon.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.UrlConfiguration_SeedUrl"> <summary> <para> <para>List of URLs for crawling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.RenderingConfiguration_TemplateUri"> <summary> <para> <para>A URI template containing exactly one variable in <c>${variableName} </c>format. This can only be set for <c>EXTERNAL</c> knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:</para><ul><li><para>Salesforce: <c>Id</c>, <c>ArticleNumber</c>, <c>VersionNumber</c>, <c>Title</c>, <c>PublishStatus</c>, or <c>IsDeleted</c></para></li><li><para>ServiceNow: <c>number</c>, <c>short_description</c>, <c>sys_mod_count</c>, <c>workflow_state</c>, or <c>active</c></para></li><li><para>Zendesk: <c>id</c>, <c>title</c>, <c>updated_at</c>, or <c>draft</c></para></li></ul><para>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html">GetContent</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateKnowledgeBaseResponse 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.QC.NewQCKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseType parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCKnowledgeBaseCmdlet.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.QC.NewQCQuickResponseCmdlet"> <summary> Creates an Amazon Q in Connect quick response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Channel"> <summary> <para> <para>The Amazon Connect channels this quick response applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Content_Content"> <summary> <para> <para>The content of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.ContentType"> <summary> <para> <para>The media type of the quick response content.</para><ul><li><para>Use <c>application/x.quickresponse;format=plain</c> for a quick response written in plain text.</para></li><li><para>Use <c>application/x.quickresponse;format=markdown</c> for a quick response written in richtext.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.GroupingConfiguration_Criterion"> <summary> <para> <para>The criteria used for grouping Amazon Q in Connect users.</para><para>The following is the list of supported criteria values.</para><ul><li><para><c>RoutingProfileArn</c>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Description"> <summary> <para> <para>The description of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.IsActive"> <summary> <para> <para>Whether the quick response is active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Language"> <summary> <para> <para>The language code value for the language in which the quick response is written. The supported language codes include <c>de_DE</c>, <c>en_US</c>, <c>es_ES</c>, <c>fr_FR</c>, <c>id_ID</c>, <c>it_IT</c>, <c>ja_JP</c>, <c>ko_KR</c>, <c>pt_BR</c>, <c>zh_CN</c>, <c>zh_TW</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Name"> <summary> <para> <para>The name of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.ShortcutKey"> <summary> <para> <para>The shortcut key of the quick response. The value should be unique across the knowledge base. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.GroupingConfiguration_Value"> <summary> <para> <para>The list of values that define different groups of Amazon Q in Connect users.</para><ul><li><para>When setting <c>criteria</c> to <c>RoutingProfileArn</c>, you need to provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateQuickResponseResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateQuickResponseResponse 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.QC.NewQCQuickResponseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCQuickResponseCmdlet.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.QC.NewQCSessionCmdlet"> <summary> Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.AiAgentConfiguration"> <summary> <para> <para>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.TagCondition_Key"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.Name"> <summary> <para> <para>The name of the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.TagCondition_Value"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateSessionResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateSessionResponse 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.QC.NewQCSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.NewQCSessionCmdlet.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.QC.RemoveQCAIAgentCmdlet"> <summary> Deletes an Amazon Q in Connect AI Agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentCmdlet.AiAgentId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentCmdlet.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.QConnect.Model.DeleteAIAgentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiAgentId parameter. The -PassThru parameter is deprecated, use -Select '^AiAgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentCmdlet.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.QC.RemoveQCAIAgentVersionCmdlet"> <summary> Deletes an Amazon Q in Connect AI Agent Version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentVersionCmdlet.AiAgentId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentVersionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentVersionCmdlet.VersionNumber"> <summary> <para> <para>The version number of the AI Agent version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentVersionCmdlet.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.QConnect.Model.DeleteAIAgentVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiAgentId parameter. The -PassThru parameter is deprecated, use -Select '^AiAgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIAgentVersionCmdlet.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.QC.RemoveQCAIPromptCmdlet"> <summary> Deletes an Amazon Q in Connect AI Prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptCmdlet.AiPromptId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptCmdlet.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.QConnect.Model.DeleteAIPromptResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiPromptId parameter. The -PassThru parameter is deprecated, use -Select '^AiPromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptCmdlet.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.QC.RemoveQCAIPromptVersionCmdlet"> <summary> Delete and Amazon Q in Connect AI Prompt version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptVersionCmdlet.AiPromptId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptVersionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptVersionCmdlet.VersionNumber"> <summary> <para> <para>The version number of the AI Prompt version to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptVersionCmdlet.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.QConnect.Model.DeleteAIPromptVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiPromptId parameter. The -PassThru parameter is deprecated, use -Select '^AiPromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAIPromptVersionCmdlet.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.QC.RemoveQCAssistantCmdlet"> <summary> Deletes an assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantCmdlet.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.QConnect.Model.DeleteAssistantResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantCmdlet.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.QC.RemoveQCAssistantAIAgentCmdlet"> <summary> Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAIAgentCmdlet.AiAgentType"> <summary> <para> <para>The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAIAgentCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAIAgentCmdlet.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.QConnect.Model.RemoveAssistantAIAgentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAIAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAIAgentCmdlet.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.QC.RemoveQCAssistantAssociationCmdlet"> <summary> Deletes an assistant association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAssociationCmdlet.AssistantAssociationId"> <summary> <para> <para>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAssociationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAssociationCmdlet.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.QConnect.Model.DeleteAssistantAssociationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantAssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantAssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCAssistantAssociationCmdlet.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.QC.RemoveQCContentCmdlet"> <summary> Deletes the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentCmdlet.ContentId"> <summary> <para> <para>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentCmdlet.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.QConnect.Model.DeleteContentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentCmdlet.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.QC.RemoveQCContentAssociationCmdlet"> <summary> Deletes the content association. <para> For more information about content associations--what they are and when they are used--see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentAssociationCmdlet.ContentAssociationId"> <summary> <para> <para>The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentAssociationCmdlet.ContentId"> <summary> <para> <para>The identifier of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentAssociationCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentAssociationCmdlet.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.QConnect.Model.DeleteContentAssociationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContentAssociationId parameter. The -PassThru parameter is deprecated, use -Select '^ContentAssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCContentAssociationCmdlet.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.QC.RemoveQCImportJobCmdlet"> <summary> Deletes the quick response import job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCImportJobCmdlet.ImportJobId"> <summary> <para> <para>The identifier of the import job to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCImportJobCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCImportJobCmdlet.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.QConnect.Model.DeleteImportJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImportJobId parameter. The -PassThru parameter is deprecated, use -Select '^ImportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCImportJobCmdlet.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.QC.RemoveQCKnowledgeBaseCmdlet"> <summary> Deletes the knowledge base. <note><para> When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a> DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a> and <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> in the <i>Amazon AppIntegrations API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseCmdlet.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.QConnect.Model.DeleteKnowledgeBaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseCmdlet.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.QC.RemoveQCKnowledgeBaseTemplateUriCmdlet"> <summary> Removes a URI template from a knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseTemplateUriCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseTemplateUriCmdlet.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.QConnect.Model.RemoveKnowledgeBaseTemplateUriResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseTemplateUriCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCKnowledgeBaseTemplateUriCmdlet.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.QC.RemoveQCQuickResponseCmdlet"> <summary> Deletes a quick response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCQuickResponseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCQuickResponseCmdlet.QuickResponseId"> <summary> <para> <para>The identifier of the quick response to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCQuickResponseCmdlet.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.QConnect.Model.DeleteQuickResponseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCQuickResponseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QuickResponseId parameter. The -PassThru parameter is deprecated, use -Select '^QuickResponseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCQuickResponseCmdlet.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.QC.RemoveQCRecommendationsReceivedCmdlet"> <summary> Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a> and a <c>waitTimeSeconds</c> input for long-polling behavior and avoiding duplicate recommendations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCRecommendationsReceivedCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCRecommendationsReceivedCmdlet.RecommendationId"> <summary> <para> <para>The identifiers of the recommendations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCRecommendationsReceivedCmdlet.SessionId"> <summary> <para> <para>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCRecommendationsReceivedCmdlet.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.QConnect.Model.NotifyRecommendationsReceivedResponse). Specifying the name of a property of type Amazon.QConnect.Model.NotifyRecommendationsReceivedResponse 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.QC.RemoveQCRecommendationsReceivedCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCRecommendationsReceivedCmdlet.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.QC.RemoveQCResourceTagCmdlet"> <summary> Removes the specified tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCResourceTagCmdlet.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.QConnect.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.RemoveQCResourceTagCmdlet.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.QC.RemoveQCResourceTagCmdlet.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.QC.SearchQCAssistantCmdlet"> <summary> <important><para> This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. </para></important><para> Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.IntentInputData_IntentId"> <summary> <para> <para>The identifier of the Amazon Q intent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.OverrideKnowledgeBaseSearchType"> <summary> <para> <para>The search type to be used against the Knowledge Base for this request. The values can be <c>SEMANTIC</c> which uses vector embeddings or <c>HYBRID</c> which use vector embeddings and raw text.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.QueryCondition"> <summary> <para> <para>Information about how to query content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.QueryText"> <summary> <para> <para>The text to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.SessionId"> <summary> <para> <para>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.QueryTextInputData_Text"> <summary> <para> <para>The text to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.QueryAssistantResponse). Specifying the name of a property of type Amazon.QConnect.Model.QueryAssistantResponse 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.QC.SearchQCAssistantCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCAssistantCmdlet.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.QC.SearchQCContentCmdlet"> <summary> Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCContentCmdlet.SearchExpression_Filter"> <summary> <para> <para>The search expression filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCContentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCContentCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCContentCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.SearchContentResponse). Specifying the name of a property of type Amazon.QConnect.Model.SearchContentResponse 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.QC.SearchQCContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCContentCmdlet.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.QC.SearchQCQuickResponseCmdlet"> <summary> Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.Attribute"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.SearchExpression_Filter"> <summary> <para> <para>The configuration of filtering rules applied to quick response query results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.OrderOnField_Name"> <summary> <para> <para>The name of the attribute to order the quick response query results by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.OrderOnField_Order"> <summary> <para> <para>The order at which the quick responses are sorted by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.SearchExpression_Query"> <summary> <para> <para>The quick response query expressions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.SearchQuickResponsesResponse). Specifying the name of a property of type Amazon.QConnect.Model.SearchQuickResponsesResponse 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.QC.SearchQCQuickResponseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCQuickResponseCmdlet.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.QC.SearchQCSessionCmdlet"> <summary> Searches for sessions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCSessionCmdlet.SearchExpression_Filter"> <summary> <para> <para>The search expression filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCSessionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCSessionCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SessionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.SearchSessionsResponse). Specifying the name of a property of type Amazon.QConnect.Model.SearchSessionsResponse 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.QC.SearchQCSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.SearchQCSessionCmdlet.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.QC.StartQCContentUploadCmdlet"> <summary> Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_CreateContent.html">CreateContent</a> to finalize the content creation process or <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html">UpdateContent</a> to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCContentUploadCmdlet.ContentType"> <summary> <para> <para>The type of content to upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCContentUploadCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCContentUploadCmdlet.PresignedUrlTimeToLive"> <summary> <para> <para>The expected expiration time of the generated presigned URL, specified in minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCContentUploadCmdlet.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.QConnect.Model.StartContentUploadResponse). Specifying the name of a property of type Amazon.QConnect.Model.StartContentUploadResponse 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.QC.StartQCContentUploadCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCContentUploadCmdlet.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.QC.StartQCImportJobCmdlet"> <summary> Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to upload an asset that contains the resource data. <ul><li><para> For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see <a href="https://docs.aws.amazon.com/console/connect/quick-responses/add-data">Import quick responses</a>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.ImportJobType"> <summary> <para> <para>The type of the import job.</para><ul><li><para>For importing quick response resource, set the value to <c>QUICK_RESPONSES</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.ConnectConfiguration_InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para><ul><li><para>For importing Amazon Q in Connect quick responses, this should be a <c>QUICK_RESPONSES</c> type knowledge base.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.Metadata"> <summary> <para> <para>The metadata fields of the imported Amazon Q in Connect resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.ExternalSourceConfiguration_Source"> <summary> <para> <para>The type of the external data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.UploadId"> <summary> <para> <para>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.ClientToken"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.StartImportJobResponse). Specifying the name of a property of type Amazon.QConnect.Model.StartImportJobResponse 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.QC.StartQCImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.StartQCImportJobCmdlet.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.QC.UpdateQCAIAgentCmdlet"> <summary> Updates an AI Agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.AiAgentId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Answer Generation prompt used by the <c>ANSWER_RECOMMENDATION</c> AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.ManualSearchAIAgentConfiguration_AnswerGenerationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_AssociationConfiguration"> <summary> <para> <para>The association configurations for overriding behavior on this AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.ManualSearchAIAgentConfiguration_AssociationConfiguration"> <summary> <para> <para>The association configurations for overriding behavior on this AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.Description"> <summary> <para> <para>The description of the Amazon Q in Connect AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_IntentLabelingGenerationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Intent Labeling prompt used by the <c>ANSWER_RECOMMENDATION</c> AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.AnswerRecommendationAIAgentConfiguration_QueryReformulationAIPromptId"> <summary> <para> <para>The AI Prompt identifier for the Query Reformulation prompt used by the <c>ANSWER_RECOMMENDATION</c> AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.VisibilityStatus"> <summary> <para> <para>The visbility status of the Amazon Q in Connect AI Agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiAgent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateAIAgentResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateAIAgentResponse 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.QC.UpdateQCAIAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiAgentId parameter. The -PassThru parameter is deprecated, use -Select '^AiAgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIAgentCmdlet.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.QC.UpdateQCAIPromptCmdlet"> <summary> Updates an AI Prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.AiPromptId"> <summary> <para> <para>The identifier of the Amazon Q in Connect AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.Description"> <summary> <para> <para>The description of the Amazon Q in Connect AI Prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.TextFullAIPromptEditTemplateConfiguration_Text"> <summary> <para> <para>The YAML text for the AI Prompt template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.VisibilityStatus"> <summary> <para> <para>The visibility status of the Amazon Q in Connect AI prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AiPrompt'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateAIPromptResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateAIPromptResponse 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.QC.UpdateQCAIPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AiPromptId parameter. The -PassThru parameter is deprecated, use -Select '^AiPromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAIPromptCmdlet.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.QC.UpdateQCAssistantAIAgentCmdlet"> <summary> Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAssistantAIAgentCmdlet.Configuration_AiAgentId"> <summary> <para> <para>The ID of the AI Agent to be configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAssistantAIAgentCmdlet.AiAgentType"> <summary> <para> <para>The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAssistantAIAgentCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAssistantAIAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Assistant'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateAssistantAIAgentResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateAssistantAIAgentResponse 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.QC.UpdateQCAssistantAIAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCAssistantAIAgentCmdlet.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.QC.UpdateQCContentCmdlet"> <summary> Updates information about the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.ContentId"> <summary> <para> <para>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.Metadata"> <summary> <para> <para>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.OverrideLinkOutUri"> <summary> <para> <para>The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing <c>overrideLinkOurUri</c>, exclude this argument and set <c>removeOverrideLinkOutUri</c> to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.RemoveOverrideLinkOutUri"> <summary> <para> <para>Unset the existing <c>overrideLinkOutUri</c> if it exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.RevisionId"> <summary> <para> <para>The <c>revisionId</c> of the content resource to update, taken from an earlier call to <c>GetContent</c>, <c>GetContentSummary</c>, <c>SearchContent</c>, or <c>ListContents</c>. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a <c>PreconditionFailedException</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.Title"> <summary> <para> <para>The title of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.UploadId"> <summary> <para> <para>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Content'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateContentResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateContentResponse 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.QC.UpdateQCContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCContentCmdlet.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.QC.UpdateQCKnowledgeBaseTemplateUriCmdlet"> <summary> Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in <c>${variable}</c> format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an <c>Id</c> value, and you can set the template URI to <c>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCKnowledgeBaseTemplateUriCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCKnowledgeBaseTemplateUriCmdlet.TemplateUri"> <summary> <para> <para>The template URI to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCKnowledgeBaseTemplateUriCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateKnowledgeBaseTemplateUriResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateKnowledgeBaseTemplateUriResponse 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.QC.UpdateQCKnowledgeBaseTemplateUriCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCKnowledgeBaseTemplateUriCmdlet.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.QC.UpdateQCQuickResponseCmdlet"> <summary> Updates an existing Amazon Q in Connect quick response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.Channel"> <summary> <para> <para>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <c>Chat</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.Content_Content"> <summary> <para> <para>The content of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.ContentType"> <summary> <para> <para>The media type of the quick response content.</para><ul><li><para>Use <c>application/x.quickresponse;format=plain</c> for quick response written in plain text.</para></li><li><para>Use <c>application/x.quickresponse;format=markdown</c> for quick response written in richtext.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.GroupingConfiguration_Criterion"> <summary> <para> <para>The criteria used for grouping Amazon Q in Connect users.</para><para>The following is the list of supported criteria values.</para><ul><li><para><c>RoutingProfileArn</c>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.Description"> <summary> <para> <para>The updated description of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.IsActive"> <summary> <para> <para>Whether the quick response is active. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.Language"> <summary> <para> <para>The language code value for the language in which the quick response is written. The supported language codes include <c>de_DE</c>, <c>en_US</c>, <c>es_ES</c>, <c>fr_FR</c>, <c>id_ID</c>, <c>it_IT</c>, <c>ja_JP</c>, <c>ko_KR</c>, <c>pt_BR</c>, <c>zh_CN</c>, <c>zh_TW</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.Name"> <summary> <para> <para>The name of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.QuickResponseId"> <summary> <para> <para>The identifier of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.RemoveDescription"> <summary> <para> <para>Whether to remove the description from the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.RemoveGroupingConfiguration"> <summary> <para> <para>Whether to remove the grouping configuration of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.RemoveShortcutKey"> <summary> <para> <para>Whether to remove the shortcut key of the quick response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.ShortcutKey"> <summary> <para> <para>The shortcut key of the quick response. The value should be unique across the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.GroupingConfiguration_Value"> <summary> <para> <para>The list of values that define different groups of Amazon Q in Connect users.</para><ul><li><para>When setting <c>criteria</c> to <c>RoutingProfileArn</c>, you need to provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateQuickResponseResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateQuickResponseResponse 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.QC.UpdateQCQuickResponseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QuickResponseId parameter. The -PassThru parameter is deprecated, use -Select '^QuickResponseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCQuickResponseCmdlet.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.QC.UpdateQCSessionCmdlet"> <summary> Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.AiAgentConfiguration"> <summary> <para> <para>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.TagCondition_Key"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.SessionId"> <summary> <para> <para>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.TagCondition_Value"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.UpdateSessionResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateSessionResponse 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.QC.UpdateQCSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionCmdlet.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.QC.UpdateQCSessionDataCmdlet"> <summary> Updates the data stored on an Amazon Q in Connect Session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionDataCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionDataCmdlet.Data"> <summary> <para> <para>The data stored on the Amazon Q in Connect Session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionDataCmdlet.Namespace"> <summary> <para> <para>The namespace into which the session data is stored. Supported namespaces are: Custom</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionDataCmdlet.SessionId"> <summary> <para> <para>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionDataCmdlet.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.QConnect.Model.UpdateSessionDataResponse). Specifying the name of a property of type Amazon.QConnect.Model.UpdateSessionDataResponse 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.QC.UpdateQCSessionDataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.UpdateQCSessionDataCmdlet.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.QC.WriteQCFeedbackCmdlet"> <summary> Provides feedback against the specified assistant for the specified target. This API only supports generative targets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.WriteQCFeedbackCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Amazon Q in Connect assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.WriteQCFeedbackCmdlet.GenerativeContentFeedbackData_Relevance"> <summary> <para> <para>The relevance of the feedback.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.WriteQCFeedbackCmdlet.TargetId"> <summary> <para> <para>The identifier of the feedback target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.WriteQCFeedbackCmdlet.TargetType"> <summary> <para> <para>The type of the feedback target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.WriteQCFeedbackCmdlet.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.QConnect.Model.PutFeedbackResponse). Specifying the name of a property of type Amazon.QConnect.Model.PutFeedbackResponse 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.QC.WriteQCFeedbackCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssistantId parameter. The -PassThru parameter is deprecated, use -Select '^AssistantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QC.WriteQCFeedbackCmdlet.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> |