AWS.Tools.ConnectWisdomService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ConnectWisdomService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.WSDM.AddWSDMResourceTagCmdlet"> <summary> Adds the specified tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.AddWSDMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.AddWSDMResourceTagCmdlet.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.WSDM.AddWSDMResourceTagCmdlet.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.ConnectWisdomService.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.AddWSDMResourceTagCmdlet.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.WSDM.AddWSDMResourceTagCmdlet.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.WSDM.GetWSDMAssistantCmdlet"> <summary> Retrieves information about an assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantCmdlet.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.ConnectWisdomService.Model.GetAssistantResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMAssistantCmdlet.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.WSDM.GetWSDMAssistantAssociationCmdlet"> <summary> Retrieves information about an assistant association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantAssociationCmdlet.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.WSDM.GetWSDMAssistantAssociationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantAssociationCmdlet.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.ConnectWisdomService.Model.GetAssistantAssociationResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMAssistantAssociationCmdlet.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.WSDM.GetWSDMAssistantAssociationListCmdlet"> <summary> Lists information about assistant associations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantAssociationListCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantAssociationListCmdlet.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.WSDM.GetWSDMAssistantAssociationListCmdlet.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.ConnectWisdomService.Model.ListAssistantAssociationsResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMAssistantAssociationListCmdlet.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.WSDM.GetWSDMAssistantListCmdlet"> <summary> Lists information about assistants. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMAssistantListCmdlet.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.WSDM.GetWSDMAssistantListCmdlet.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.ConnectWisdomService.Model.ListAssistantsResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMContentCmdlet"> <summary> Retrieves content, including a pre-signed URL to download the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMContentCmdlet.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.WSDM.GetWSDMContentCmdlet.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.WSDM.GetWSDMContentCmdlet.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.ConnectWisdomService.Model.GetContentResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMContentCmdlet.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.WSDM.GetWSDMContentListCmdlet"> <summary> Lists the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMContentListCmdlet.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.WSDM.GetWSDMContentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMContentListCmdlet.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.WSDM.GetWSDMContentListCmdlet.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.ConnectWisdomService.Model.ListContentsResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMContentListCmdlet.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.WSDM.GetWSDMContentSummaryCmdlet"> <summary> Retrieves summary information about the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMContentSummaryCmdlet.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.WSDM.GetWSDMContentSummaryCmdlet.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.WSDM.GetWSDMContentSummaryCmdlet.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.ConnectWisdomService.Model.GetContentSummaryResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMContentSummaryCmdlet.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.WSDM.GetWSDMKnowledgeBaseCmdlet"> <summary> Retrieves information about the knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMKnowledgeBaseCmdlet.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.WSDM.GetWSDMKnowledgeBaseCmdlet.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.ConnectWisdomService.Model.GetKnowledgeBaseResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMKnowledgeBaseCmdlet.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.WSDM.GetWSDMKnowledgeBasisListCmdlet"> <summary> Lists the knowledge bases. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMKnowledgeBasisListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMKnowledgeBasisListCmdlet.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.WSDM.GetWSDMKnowledgeBasisListCmdlet.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.ConnectWisdomService.Model.ListKnowledgeBasesResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMRecommendationCmdlet"> <summary> Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the <code>waitTimeSeconds</code> 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/wisdom/latest/APIReference/API_QueryAssistant.html">QueryAssistant</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMRecommendationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMRecommendationCmdlet.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.WSDM.GetWSDMRecommendationCmdlet.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 <code>WaitTimeSeconds</code>. 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.WSDM.GetWSDMRecommendationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMRecommendationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Recommendations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectWisdomService.Model.GetRecommendationsResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMRecommendationCmdlet.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.WSDM.GetWSDMResourceTagCmdlet"> <summary> Lists the tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMResourceTagCmdlet.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.ConnectWisdomService.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMResourceTagCmdlet.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.WSDM.GetWSDMSessionCmdlet"> <summary> Retrieves information for a specified session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.GetWSDMSessionCmdlet.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.WSDM.GetWSDMSessionCmdlet.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.ConnectWisdomService.Model.GetSessionResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.GetWSDMSessionCmdlet.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.WSDM.NewWSDMAssistantCmdlet"> <summary> Creates an Amazon Connect Wisdom assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantCmdlet.Description"> <summary> <para> <para>The description of the assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The KMS key. 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.WSDM.NewWSDMAssistantCmdlet.Name"> <summary> <para> <para>The name of the assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantCmdlet.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.WSDM.NewWSDMAssistantCmdlet.Type"> <summary> <para> <para>The type of assistant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantCmdlet.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.WSDM.NewWSDMAssistantCmdlet.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.ConnectWisdomService.Model.CreateAssistantResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.NewWSDMAssistantCmdlet.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.WSDM.NewWSDMAssistantCmdlet.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.WSDM.NewWSDMAssistantAssociationCmdlet"> <summary> Creates an association between an Amazon Connect Wisdom 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.WSDM.NewWSDMAssistantAssociationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantAssociationCmdlet.AssociationType"> <summary> <para> <para>The type of association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantAssociationCmdlet.Association_KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMAssistantAssociationCmdlet.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.WSDM.NewWSDMAssistantAssociationCmdlet.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.WSDM.NewWSDMAssistantAssociationCmdlet.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.ConnectWisdomService.Model.CreateAssistantAssociationResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.NewWSDMAssistantAssociationCmdlet.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.WSDM.NewWSDMAssistantAssociationCmdlet.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.WSDM.NewWSDMContentCmdlet"> <summary> Creates Wisdom content. Before to calling this API, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to upload an asset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMContentCmdlet.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/wisdom/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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.ConnectWisdomService.Model.CreateContentResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMContentCmdlet.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.WSDM.NewWSDMKnowledgeBaseCmdlet"> <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 <code>InvalidRequestException</code> 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/wisdom/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.WSDM.NewWSDMKnowledgeBaseCmdlet.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 <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, and <code>IsDeleted</code> 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 <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, and <code>active</code> 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 <code>objectFields</code> is not provided, including at least <code>id</code>, <code>title</code>, <code>updated_at</code>, and <code>draft</code> 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 <code>docx</code>, <code>pdf</code>, <code>html</code>, <code>htm</code>, and <code>txt</code>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMKnowledgeBaseCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMKnowledgeBaseCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The KMS key. 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.WSDM.NewWSDMKnowledgeBaseCmdlet.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.WSDM.NewWSDMKnowledgeBaseCmdlet.Name"> <summary> <para> <para>The name of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMKnowledgeBaseCmdlet.AppIntegrations_ObjectField"> <summary> <para> <para>The fields from the source that are made available to your agents in Wisdom. 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 <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, and <code>IsDeleted</code>. </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 <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, and <code>active</code>. </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 <code>id</code>, <code>title</code>, <code>updated_at</code>, and <code>draft</code>. </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.WSDM.NewWSDMKnowledgeBaseCmdlet.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.WSDM.NewWSDMKnowledgeBaseCmdlet.RenderingConfiguration_TemplateUri"> <summary> <para> <para>A URI template containing exactly one variable in <code>${variableName} </code>format. This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:</para><ul><li><para>Salesforce: <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, or <code>IsDeleted</code></para></li><li><para>ServiceNow: <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, or <code>active</code></para></li><li><para>Zendesk: <code>id</code>, <code>title</code>, <code>updated_at</code>, or <code>draft</code></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/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMKnowledgeBaseCmdlet.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.WSDM.NewWSDMKnowledgeBaseCmdlet.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.ConnectWisdomService.Model.CreateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.NewWSDMKnowledgeBaseCmdlet.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.WSDM.NewWSDMKnowledgeBaseCmdlet.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.WSDM.NewWSDMSessionCmdlet"> <summary> Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMSessionCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMSessionCmdlet.Name"> <summary> <para> <para>The name of the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.NewWSDMSessionCmdlet.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.WSDM.NewWSDMSessionCmdlet.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.WSDM.NewWSDMSessionCmdlet.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.ConnectWisdomService.Model.CreateSessionResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.NewWSDMSessionCmdlet.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.WSDM.NewWSDMSessionCmdlet.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.WSDM.RemoveWSDMAssistantCmdlet"> <summary> Deletes an assistant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMAssistantCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMAssistantCmdlet.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.ConnectWisdomService.Model.DeleteAssistantResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMAssistantCmdlet.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.WSDM.RemoveWSDMAssistantCmdlet.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.WSDM.RemoveWSDMAssistantAssociationCmdlet"> <summary> Deletes an assistant association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMAssistantAssociationCmdlet.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.WSDM.RemoveWSDMAssistantAssociationCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMAssistantAssociationCmdlet.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.ConnectWisdomService.Model.DeleteAssistantAssociationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMAssistantAssociationCmdlet.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.WSDM.RemoveWSDMAssistantAssociationCmdlet.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.WSDM.RemoveWSDMContentCmdlet"> <summary> Deletes the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMContentCmdlet.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.WSDM.RemoveWSDMContentCmdlet.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.WSDM.RemoveWSDMContentCmdlet.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.ConnectWisdomService.Model.DeleteContentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMContentCmdlet.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.WSDM.RemoveWSDMContentCmdlet.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.WSDM.RemoveWSDMKnowledgeBaseCmdlet"> <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.WSDM.RemoveWSDMKnowledgeBaseCmdlet.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.WSDM.RemoveWSDMKnowledgeBaseCmdlet.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.ConnectWisdomService.Model.DeleteKnowledgeBaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMKnowledgeBaseCmdlet.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.WSDM.RemoveWSDMKnowledgeBaseCmdlet.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.WSDM.RemoveWSDMKnowledgeBaseTemplateUriCmdlet"> <summary> Removes a URI template from a knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMKnowledgeBaseTemplateUriCmdlet.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.WSDM.RemoveWSDMKnowledgeBaseTemplateUriCmdlet.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.ConnectWisdomService.Model.RemoveKnowledgeBaseTemplateUriResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMKnowledgeBaseTemplateUriCmdlet.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.WSDM.RemoveWSDMKnowledgeBaseTemplateUriCmdlet.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.WSDM.RemoveWSDMRecommendationsReceivedCmdlet"> <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/wisdom/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a> and a <code>waitTimeSeconds</code> input for long-polling behavior and avoiding duplicate recommendations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMRecommendationsReceivedCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMRecommendationsReceivedCmdlet.RecommendationId"> <summary> <para> <para>The identifiers of the recommendations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMRecommendationsReceivedCmdlet.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.WSDM.RemoveWSDMRecommendationsReceivedCmdlet.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.ConnectWisdomService.Model.NotifyRecommendationsReceivedResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.RemoveWSDMRecommendationsReceivedCmdlet.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.WSDM.RemoveWSDMRecommendationsReceivedCmdlet.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.WSDM.RemoveWSDMResourceTagCmdlet"> <summary> Removes the specified tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMResourceTagCmdlet.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.ConnectWisdomService.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.RemoveWSDMResourceTagCmdlet.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.WSDM.RemoveWSDMResourceTagCmdlet.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.WSDM.SearchWSDMAssistantCmdlet"> <summary> Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMAssistantCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMAssistantCmdlet.QueryText"> <summary> <para> <para>The text to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMAssistantCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMAssistantCmdlet.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.WSDM.SearchWSDMAssistantCmdlet.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.ConnectWisdomService.Model.QueryAssistantResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.SearchWSDMAssistantCmdlet.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.WSDM.SearchWSDMAssistantCmdlet.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.WSDM.SearchWSDMContentCmdlet"> <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.WSDM.SearchWSDMContentCmdlet.SearchExpression_Filter"> <summary> <para> <para>The search expression filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMContentCmdlet.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.WSDM.SearchWSDMContentCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMContentCmdlet.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.WSDM.SearchWSDMContentCmdlet.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.ConnectWisdomService.Model.SearchContentResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.SearchWSDMContentCmdlet.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.WSDM.SearchWSDMContentCmdlet.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.WSDM.SearchWSDMSessionCmdlet"> <summary> Searches for sessions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMSessionCmdlet.AssistantId"> <summary> <para> <para>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMSessionCmdlet.SearchExpression_Filter"> <summary> <para> <para>The search expression filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMSessionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.SearchWSDMSessionCmdlet.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.WSDM.SearchWSDMSessionCmdlet.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.ConnectWisdomService.Model.SearchSessionsResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.SearchWSDMSessionCmdlet.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.WSDM.SearchWSDMSessionCmdlet.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.WSDM.StartWSDMContentUploadCmdlet"> <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/wisdom/latest/APIReference/API_CreateContent.html">CreateContent</a> to finalize the content creation process or <a href="https://docs.aws.amazon.com/wisdom/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.WSDM.StartWSDMContentUploadCmdlet.ContentType"> <summary> <para> <para>The type of content to upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.StartWSDMContentUploadCmdlet.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.WSDM.StartWSDMContentUploadCmdlet.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.ConnectWisdomService.Model.StartContentUploadResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.StartWSDMContentUploadCmdlet.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.WSDM.StartWSDMContentUploadCmdlet.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.WSDM.UpdateWSDMContentCmdlet"> <summary> Updates information about the content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.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.WSDM.UpdateWSDMContentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.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 <code>overrideLinkOurUri</code>, exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.RemoveOverrideLinkOutUri"> <summary> <para> <para>Unset the existing <code>overrideLinkOutUri</code> if it exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.RevisionId"> <summary> <para> <para>The <code>revisionId</code> of the content resource to update, taken from an earlier call to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or <code>ListContents</code>. 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 <code>PreconditionFailedException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.Title"> <summary> <para> <para>The title of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMContentCmdlet.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.WSDM.UpdateWSDMContentCmdlet.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.ConnectWisdomService.Model.UpdateContentResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.UpdateWSDMContentCmdlet.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.WSDM.UpdateWSDMContentCmdlet.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.WSDM.UpdateWSDMKnowledgeBaseTemplateUriCmdlet"> <summary> Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in <code>${variable}</code> format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an <code>Id</code> value, and you can set the template URI to <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMKnowledgeBaseTemplateUriCmdlet.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.WSDM.UpdateWSDMKnowledgeBaseTemplateUriCmdlet.TemplateUri"> <summary> <para> <para>The template URI to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WSDM.UpdateWSDMKnowledgeBaseTemplateUriCmdlet.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.ConnectWisdomService.Model.UpdateKnowledgeBaseTemplateUriResponse). Specifying the name of a property of type Amazon.ConnectWisdomService.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.WSDM.UpdateWSDMKnowledgeBaseTemplateUriCmdlet.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.WSDM.UpdateWSDMKnowledgeBaseTemplateUriCmdlet.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> |