AWS.Tools.Kendra.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Kendra</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.AddKNDREntitiesToExperienceCmdlet"> <summary> Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDREntitiesToExperienceCmdlet.EntityList"> <summary> <para> <para>Lists users or groups in your IAM Identity Center identity source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDREntitiesToExperienceCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDREntitiesToExperienceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDREntitiesToExperienceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedEntityList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.AssociateEntitiesToExperienceResponse). Specifying the name of a property of type Amazon.Kendra.Model.AssociateEntitiesToExperienceResponse 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.KNDR.AddKNDREntitiesToExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDREntitiesToExperienceCmdlet.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.KNDR.AddKNDRPersonasToEntityCmdlet"> <summary> Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRPersonasToEntityCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRPersonasToEntityCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRPersonasToEntityCmdlet.Persona"> <summary> <para> <para>The personas that define the specific permissions of users or groups in your IAM Identity Center identity source. The available personas or access roles are <c>Owner</c> and <c>Viewer</c>. For more information on these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing access to your search page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRPersonasToEntityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedEntityList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.AssociatePersonasToEntitiesResponse). Specifying the name of a property of type Amazon.Kendra.Model.AssociatePersonasToEntitiesResponse 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.KNDR.AddKNDRPersonasToEntityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRPersonasToEntityCmdlet.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.KNDR.AddKNDRResourceTagCmdlet"> <summary> Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tag keys to add to the index, FAQ, or data source. If a tag already exists, the existing value is replaced with the new value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRResourceTagCmdlet.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.Kendra.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.AddKNDRResourceTagCmdlet.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.KNDR.AddKNDRResourceTagCmdlet.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.KNDR.ClearKNDRQuerySuggestionCmdlet"> <summary> Clears existing query suggestions from an index. <para> This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions. </para><para><c>ClearQuerySuggestions</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.ClearKNDRQuerySuggestionCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to clear query suggestions from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.ClearKNDRQuerySuggestionCmdlet.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.Kendra.Model.ClearQuerySuggestionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.ClearKNDRQuerySuggestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.ClearKNDRQuerySuggestionCmdlet.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.KNDR.GetKNDRAccessControlConfigurationCmdlet"> <summary> Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationCmdlet.Id"> <summary> <para> <para>The identifier of the access control configuration you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for an access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationCmdlet.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.Kendra.Model.DescribeAccessControlConfigurationResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeAccessControlConfigurationResponse 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.KNDR.GetKNDRAccessControlConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationListCmdlet"> <summary> Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of access control configurations to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there's more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of access control configurations.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessControlConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListAccessControlConfigurationsResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListAccessControlConfigurationsResponse 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.KNDR.GetKNDRAccessControlConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRAccessControlConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceCmdlet"> <summary> Gets information about an Amazon Kendra data source connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceCmdlet.Id"> <summary> <para> <para>The identifier of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceCmdlet.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.Kendra.Model.DescribeDataSourceResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeDataSourceResponse 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.KNDR.GetKNDRDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet"> <summary> Lists the data source connectors that you have created.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with one or more data source connectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of data source connectors to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data source connectors. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListDataSourcesResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListDataSourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet"> <summary> Gets statistics about synchronizing a data source connector.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.StartTimeFilter_EndTime"> <summary> <para> <para>The Unix timestamp for the end of the time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.Id"> <summary> <para> <para>The identifier of the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.StartTimeFilter_StartTime"> <summary> <para> <para>The Unix timestamp for the beginning of the time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.StatusFilter"> <summary> <para> <para>Only returns synchronization jobs with the <c>Status</c> field equal to the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'History'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListDataSourceSyncJobsResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListDataSourceSyncJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRDataSourceSyncJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet"> <summary> Lists specific permissions of users and groups with access to your Amazon Kendra experience.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of returned users or groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListEntityPersonasResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListEntityPersonasResponse 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.KNDR.GetKNDREntityPersonaListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDREntityPersonaListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceCmdlet"> <summary> Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceCmdlet.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.Kendra.Model.DescribeExperienceResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeExperienceResponse 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.KNDR.GetKNDRExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceEntityListCmdlet"> <summary> Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceEntityListCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceEntityListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceEntityListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceEntityListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListExperienceEntitiesResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListExperienceEntitiesResponse 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.KNDR.GetKNDRExperienceEntityListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceEntityListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceListCmdlet"> <summary> Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of returned Amazon Kendra experiences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Kendra experiences.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListExperiencesResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListExperiencesResponse 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.KNDR.GetKNDRExperienceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRExperienceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqCmdlet"> <summary> Gets information about an FAQ list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqCmdlet.Id"> <summary> <para> <para>The identifier of the FAQ you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the FAQ.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqCmdlet.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.Kendra.Model.DescribeFaqResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeFaqResponse 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.KNDR.GetKNDRFaqCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqListCmdlet"> <summary> Gets a list of FAQ lists associated with an index.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqListCmdlet.IndexId"> <summary> <para> <para>The index that contains the FAQ lists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FaqSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListFaqsResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListFaqsResponse 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.KNDR.GetKNDRFaqListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFaqListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetCmdlet"> <summary> Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetCmdlet.FeaturedResultsSetId"> <summary> <para> <para>The identifier of the set of featured results that you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used for featuring results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetCmdlet.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.Kendra.Model.DescribeFeaturedResultsSetResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeFeaturedResultsSetResponse 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.KNDR.GetKNDRFeaturedResultsSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeaturedResultsSetId parameter. The -PassThru parameter is deprecated, use -Select '^FeaturedResultsSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetListCmdlet"> <summary> Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used for featuring results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of featured results sets to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetListCmdlet.NextToken"> <summary> <para> <para>If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeaturedResultsSetSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListFeaturedResultsSetsResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListFeaturedResultsSetsResponse 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.KNDR.GetKNDRFeaturedResultsSetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRFeaturedResultsSetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGetDocumentStatusCmdlet"> <summary> Returns the indexing status for one or more documents submitted with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html"> BatchPutDocument</a> API. <para> When you use the <c>BatchPutDocument</c> API, documents are indexed asynchronously. You can use the <c>BatchGetDocumentStatus</c> API to get the current status of a list of documents so that you can determine if they have been successfully indexed. </para><para> You can also use the <c>BatchGetDocumentStatus</c> API to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html"> BatchDeleteDocument</a> API. When a document is deleted from the index, Amazon Kendra returns <c>NOT_FOUND</c> as the status. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGetDocumentStatusCmdlet.DocumentInfoList"> <summary> <para> <para>A list of <c>DocumentInfo</c> objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGetDocumentStatusCmdlet.IndexId"> <summary> <para> <para>The identifier of the index to add documents to. The index ID is returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">CreateIndex </a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGetDocumentStatusCmdlet.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.Kendra.Model.BatchGetDocumentStatusResponse). Specifying the name of a property of type Amazon.Kendra.Model.BatchGetDocumentStatusResponse 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.KNDR.GetKNDRGetDocumentStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet"> <summary> Provides a list of groups that are mapped to users before a given ordering or timestamp identifier. <para><c>ListGroupsOlderThanOrderingId</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.OrderingId"> <summary> <para> <para>The timestamp identifier used for the latest <c>PUT</c> or <c>DELETE</c> action for mapping users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.NextToken"> <summary> <para> <para> If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupsSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListGroupsOlderThanOrderingIdResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListGroupsOlderThanOrderingIdResponse 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.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OrderingId parameter. The -PassThru parameter is deprecated, use -Select '^OrderingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRGroupsOlderThanOrderingIdListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexCmdlet"> <summary> Gets information about an Amazon Kendra index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexCmdlet.Id"> <summary> <para> <para>The identifier of the index you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexCmdlet.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.Kendra.Model.DescribeIndexResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeIndexResponse 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.KNDR.GetKNDRIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexListCmdlet"> <summary> Lists the Amazon Kendra indexes that you created.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of indices to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of indexes. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexConfigurationSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListIndicesResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListIndicesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRIndexListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRPrincipalMappingCmdlet"> <summary> Describes the processing of <c>PUT</c> and <c>DELETE</c> actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed. <para><c>DescribePrincipalMapping</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRPrincipalMappingCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source to check the processing of <c>PUT</c> and <c>DELETE</c> actions for mapping users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRPrincipalMappingCmdlet.GroupId"> <summary> <para> <para>The identifier of the group required to check the processing of <c>PUT</c> and <c>DELETE</c> actions for mapping users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRPrincipalMappingCmdlet.IndexId"> <summary> <para> <para>The identifier of the index required to check the processing of <c>PUT</c> and <c>DELETE</c> actions for mapping users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRPrincipalMappingCmdlet.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.Kendra.Model.DescribePrincipalMappingResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribePrincipalMappingResponse 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.KNDR.GetKNDRPrincipalMappingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupId parameter. The -PassThru parameter is deprecated, use -Select '^GroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet"> <summary> Fetches the queries that are suggested to your users. <para><c>GetQuerySuggestions</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.AttributeSuggestionsConfig_AdditionalResponseAttribute"> <summary> <para> <para>The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.AttributeSuggestionsConfig_AttributeFilter"> <summary> <para> <para>Filters the search results based on document fields/attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.UserContext_DataSourceGroup"> <summary> <para> <para>The list of data source groups you want to filter search results based on groups' access to documents in that data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.UserContext_Group"> <summary> <para> <para>The list of groups you want to filter search results based on the groups' access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to get query suggestions from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.MaxSuggestionsCount"> <summary> <para> <para>The maximum number of query suggestions you want to show to your users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.QueryText"> <summary> <para> <para>The text of a user's query to generate query suggestions.</para><para>A query is suggested if the query prefix matches what a user starts to type as their query.</para><para>Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.AttributeSuggestionsConfig_SuggestionAttribute"> <summary> <para> <para>The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.SuggestionType"> <summary> <para> <para>The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.</para><para>If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.</para><para>If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.UserContext_Token"> <summary> <para> <para>The user context token for filtering search results for a user. It must be a JWT or a JSON token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.UserContext_UserId"> <summary> <para> <para>The identifier of the user you want to filter search results based on their access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionCmdlet.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.Kendra.Model.GetQuerySuggestionsResponse). Specifying the name of a property of type Amazon.Kendra.Model.GetQuerySuggestionsResponse 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.KNDR.GetKNDRQuerySuggestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListCmdlet"> <summary> Gets information about a block list used for query suggestions for an index. <para> This is used to check the current settings that are applied to a block list. </para><para><c>DescribeQuerySuggestionsBlockList</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListCmdlet.Id"> <summary> <para> <para>The identifier of the block list you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the block list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListCmdlet.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.Kendra.Model.DescribeQuerySuggestionsBlockListResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeQuerySuggestionsBlockListResponse 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.KNDR.GetKNDRQuerySuggestionsBlockListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet"> <summary> Lists the block lists used for query suggestions for an index. <para> For information on the current quota limits for block lists, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas for Amazon Kendra</a>. </para><para><c>ListQuerySuggestionsBlockLists</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for a list of all block lists that exist for that index.</para><para>For information on the current quota limits for block lists, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of block lists to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of block lists (<c>BlockListSummaryItems</c>).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BlockListSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListQuerySuggestionsBlockListsResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListQuerySuggestionsBlockListsResponse 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.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsBlockListListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsConfigCmdlet"> <summary> Gets information on the settings of query suggestions for an index. <para> This is used to check the current settings applied to query suggestions. </para><para><c>DescribeQuerySuggestionsConfig</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsConfigCmdlet.IndexId"> <summary> <para> <para>The identifier of the index with query suggestions that you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRQuerySuggestionsConfigCmdlet.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.Kendra.Model.DescribeQuerySuggestionsConfigResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeQuerySuggestionsConfigResponse 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.KNDR.GetKNDRQuerySuggestionsConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRResourceTagCmdlet"> <summary> Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRResourceTagCmdlet.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.Kendra.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Kendra.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.KNDR.GetKNDRResourceTagCmdlet.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.KNDR.GetKNDRSnapshotCmdlet"> <summary> Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.IndexId"> <summary> <para> <para>The identifier of the index to get search metrics data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.Interval"> <summary> <para> <para>The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:</para><ul><li><para><c>THIS_WEEK</c>: The current week, starting on the Sunday and ending on the day before the current date.</para></li><li><para><c>ONE_WEEK_AGO</c>: The previous week, starting on the Sunday and ending on the following Saturday.</para></li><li><para><c>TWO_WEEKS_AGO</c>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</para></li><li><para><c>THIS_MONTH</c>: The current month, starting on the first day of the month and ending on the day before the current date.</para></li><li><para><c>ONE_MONTH_AGO</c>: The previous month, starting on the first day of the month and ending on the last day of the month.</para></li><li><para><c>TWO_MONTHS_AGO</c>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.MetricType"> <summary> <para> <para>The metric you want to retrieve. You can specify only one metric per call.</para><para>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.MaxResult"> <summary> <para> <para>The maximum number of returned data for the metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.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.Kendra.Model.GetSnapshotsResponse). Specifying the name of a property of type Amazon.Kendra.Model.GetSnapshotsResponse 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.KNDR.GetKNDRSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRSnapshotCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesauriListCmdlet"> <summary> Lists the thesauri for an index.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesauriListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index with one or more thesauri.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesauriListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of thesauri to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesauriListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (<c>ThesaurusSummaryItems</c>). </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesauriListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThesaurusSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.ListThesauriResponse). Specifying the name of a property of type Amazon.Kendra.Model.ListThesauriResponse 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.KNDR.GetKNDRThesauriListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesauriListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesaurusCmdlet"> <summary> Gets information about an Amazon Kendra thesaurus. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesaurusCmdlet.Id"> <summary> <para> <para>The identifier of the thesaurus you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesaurusCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.GetKNDRThesaurusCmdlet.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.Kendra.Model.DescribeThesaurusResponse). Specifying the name of a property of type Amazon.Kendra.Model.DescribeThesaurusResponse 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.KNDR.GetKNDRThesaurusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet"> <summary> Searches an index given an input query. <note><para> If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html">Retrieve</a> API, which can return longer semantically relevant passages. We recommend using the <c>Retrieve</c> API instead of filing a service limit increase to increase the <c>Query</c> API document excerpt length. </para></note><para> You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information. </para><para> A query response contains three types of results. </para><ul><li><para> Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt. </para></li><li><para> Matching FAQs or questions-answer from your FAQ file. </para></li><li><para> Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt. </para></li></ul><para> You can specify that the query return only one type of result using the <c>QueryResultTypeFilter</c> parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.AttributeFilter"> <summary> <para> <para>Filters search results by document fields/attributes. You can only provide one attribute filter; however, the <c>AndAllFilters</c>, <c>NotFilter</c>, and <c>OrAllFilters</c> parameters contain a list of other filters.</para><para>The <c>AttributeFilter</c> parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.UserContext_DataSourceGroup"> <summary> <para> <para>The list of data source groups you want to filter search results based on groups' access to documents in that data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.CollapseConfiguration_DocumentAttributeKey"> <summary> <para> <para>The document attribute used to group search results. You can use any attribute that has the <c>Sortable</c> flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.SortingConfiguration_DocumentAttributeKey"> <summary> <para> <para>The name of the document attribute used to sort the response. You can use any field that has the <c>Sortable</c> flag set to true.</para><para>You can also sort by any of the following built-in attributes:</para><ul><li><para>_category</para></li><li><para>_created_at</para></li><li><para>_last_updated_at</para></li><li><para>_version</para></li><li><para>_view_count</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.DocumentRelevanceOverrideConfiguration"> <summary> <para> <para>Overrides relevance tuning configurations of fields/attributes set at the index level.</para><para>If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.</para><para>If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.CollapseConfiguration_Expand"> <summary> <para> <para>Specifies whether to expand the collapsed results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.Facet"> <summary> <para> <para>An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.UserContext_Group"> <summary> <para> <para>The list of groups you want to filter search results based on the groups' access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.SpellCorrectionConfiguration_IncludeQuerySpellCheckSuggestion"> <summary> <para> <para><c>TRUE</c> to suggest spell corrections for queries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.ExpandConfiguration_MaxExpandedResultsPerItem"> <summary> <para> <para>The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.ExpandConfiguration_MaxResultItemsToExpand"> <summary> <para> <para>The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.CollapseConfiguration_MissingAttributeKeyStrategy"> <summary> <para> <para>Specifies the behavior for documents without a value for the collapse attribute.</para><para>Amazon Kendra offers three customization options:</para><ul><li><para>Choose to <c>COLLAPSE</c> all documents with null or missing values in one group. This is the default configuration.</para></li><li><para>Choose to <c>IGNORE</c> documents with null or missing values. Ignored documents will not appear in query results.</para></li><li><para>Choose to <c>EXPAND</c> each document with a null or missing value into a group of its own.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.PageNumber"> <summary> <para> <para>Query results are returned in pages the size of the <c>PageSize</c> parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.QueryResultTypeFilter"> <summary> <para> <para>Sets the type of query result or response. Only results for the specified type are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.QueryText"> <summary> <para> <para>The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, <c>Timeoff AND October AND Category:HR</c> is counted as 3 tokens: <c>timeoff</c>, <c>october</c>, <c>hr</c>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching with advanced query syntax</a> in the Amazon Kendra Developer Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.RequestedDocumentAttribute"> <summary> <para> <para>An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.CollapseConfiguration_SortingConfiguration"> <summary> <para> <para>A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.SortingConfiguration"> <summary> <para> <para>Provides configuration information to determine how the results of a query are sorted.</para><para>You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.</para><para>If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.SortingConfiguration_SortOrder"> <summary> <para> <para>The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.UserContext_Token"> <summary> <para> <para>The user context token for filtering search results for a user. It must be a JWT or a JSON token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.UserContext_UserId"> <summary> <para> <para>The identifier of the user you want to filter search results based on their access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.VisitorId"> <summary> <para> <para>Provides an identifier for a specific user. The <c>VisitorId</c> should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the <c>VisitorId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.PageSize"> <summary> <para> <para>Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.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.Kendra.Model.QueryResponse). Specifying the name of a property of type Amazon.Kendra.Model.QueryResponse 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.KNDR.InvokeKNDRQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryText parameter. The -PassThru parameter is deprecated, use -Select '^QueryText' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRQueryCmdlet.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.KNDR.InvokeKNDRRetrieveCmdlet"> <summary> Retrieves relevant passages or text excerpts given an input query. <para> This API is similar to the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html">Query</a> API. However, by default, the <c>Query</c> API only returns excerpt passages of up to 100 token words. With the <c>Retrieve</c> API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the <c>Retrieve</c> API, you can alternatively use the <c>Query</c> API and its types of responses. </para><para> You can also do the following: </para><ul><li><para> Override boosting at the index level </para></li><li><para> Filter based on document fields or attributes </para></li><li><para> Filter based on the user or their group access to documents </para></li><li><para> View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query. </para><note><para> Confidence score buckets are currently available only for English. </para></note></li></ul><para> You can also include certain fields in the response that might provide useful additional information. </para><para> The <c>Retrieve</c> API shares the number of <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html">query capacity units</a> that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.AttributeFilter"> <summary> <para> <para>Filters search results by document fields/attributes. You can only provide one attribute filter; however, the <c>AndAllFilters</c>, <c>NotFilter</c>, and <c>OrAllFilters</c> parameters contain a list of other filters.</para><para>The <c>AttributeFilter</c> parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.UserContext_DataSourceGroup"> <summary> <para> <para>The list of data source groups you want to filter search results based on groups' access to documents in that data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.DocumentRelevanceOverrideConfiguration"> <summary> <para> <para>Overrides relevance tuning configurations of fields/attributes set at the index level.</para><para>If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.</para><para>If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.UserContext_Group"> <summary> <para> <para>The list of groups you want to filter search results based on the groups' access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.IndexId"> <summary> <para> <para>The identifier of the index to retrieve relevant passages for the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.PageNumber"> <summary> <para> <para>Retrieved relevant passages are returned in pages the size of the <c>PageSize</c> parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.QueryText"> <summary> <para> <para>The input query text to retrieve relevant passages for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, <c>Timeoff AND October AND Category:HR</c> is counted as 3 tokens: <c>timeoff</c>, <c>october</c>, <c>hr</c>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching with advanced query syntax</a> in the Amazon Kendra Developer Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.RequestedDocumentAttribute"> <summary> <para> <para>A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.UserContext_Token"> <summary> <para> <para>The user context token for filtering search results for a user. It must be a JWT or a JSON token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.UserContext_UserId"> <summary> <para> <para>The identifier of the user you want to filter search results based on their access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.PageSize"> <summary> <para> <para>Sets the number of retrieved relevant passages that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.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.Kendra.Model.RetrieveResponse). Specifying the name of a property of type Amazon.Kendra.Model.RetrieveResponse 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.KNDR.InvokeKNDRRetrieveCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryText parameter. The -PassThru parameter is deprecated, use -Select '^QueryText' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.InvokeKNDRRetrieveCmdlet.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.KNDR.NewKNDRAccessControlConfigurationCmdlet"> <summary> Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. <para> You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change. </para><para> To apply your access control configuration to certain documents, you call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API with the <c>AccessControlConfigurationId</c> included in the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a> object. If you use an S3 bucket as a data source, you update the <c>.metadata.json</c> with the <c>AccessControlConfigurationId</c> and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the <c>BatchPutDocument</c> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.AccessControlList"> <summary> <para> <para>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.Description"> <summary> <para> <para>A description for the access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.HierarchicalAccessControlList"> <summary> <para> <para>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.IndexId"> <summary> <para> <para>The identifier of the index to create an access control configuration for your documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.Name"> <summary> <para> <para>A name for the access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create an access control configuration. Multiple calls to the <c>CreateAccessControlConfiguration</c> API with the same client token will create only one access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateAccessControlConfigurationResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateAccessControlConfigurationResponse 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.KNDR.NewKNDRAccessControlConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRAccessControlConfigurationCmdlet.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.KNDR.NewKNDRDataSourceCmdlet"> <summary> Creates a data source connector that you want to use with an Amazon Kendra index. <para> You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. </para><para><c>CreateDataSource</c> is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. </para><para> For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python SDK</a>. For an example of creating an index and data source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Kendra currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Kendra currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Configuration"> <summary> <para> <para>Configuration information to connect to your data source repository.</para><para>You can't specify the <c>Configuration</c> parameter when the <c>Type</c> parameter is set to <c>CUSTOM</c>. If you do, you receive a <c>ValidationException</c> exception.</para><para>The <c>Configuration</c> parameter is required for all other data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Description"> <summary> <para> <para>A description for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to use with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_InlineConfiguration"> <summary> <para> <para>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.PostExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.PreExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.LanguageCode"> <summary> <para> <para>The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue"> <summary> <para> <para>A long integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue"> <summary> <para> <para>A long integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Name"> <summary> <para> <para>A name for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Operator"> <summary> <para> <para>The condition operator.</para><para>For example, you can use 'Contains' to partially match a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Operator"> <summary> <para> <para>The condition operator.</para><para>For example, you can use 'Contains' to partially match a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra.</a>.</para><para>You can't specify the <c>RoleArn</c> parameter when the <c>Type</c> parameter is set to <c>CUSTOM</c>. If you do, you receive a <c>ValidationException</c> exception.</para><para>The <c>RoleArn</c> parameter is required for all other data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.PostExtractionHookConfiguration_S3Bucket"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.PreExtractionHookConfiguration_S3Bucket"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Schedule"> <summary> <para> <para>Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the <c>StartDataSourceSyncJob</c> API to update the index.</para><para>Specify a <c>cron-</c> format schedule string or an empty string to indicate that the index is updated on demand.</para><para>You can't specify the <c>Schedule</c> parameter when the <c>Type</c> parameter is set to <c>CUSTOM</c>. If you do, you receive a <c>ValidationException</c> exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue"> <summary> <para> <para>A list of strings. The default maximum length or number of strings is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue"> <summary> <para> <para>A list of strings. The default maximum length or number of strings is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue"> <summary> <para> <para>A string, such as "department".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue"> <summary> <para> <para>A string, such as "department".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Type"> <summary> <para> <para>The type of data source repository. For example, <c>SHAREPOINT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create a data source connector. Multiple calls to the <c>CreateDataSource</c> API with the same client token will create only one data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateDataSourceResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRDataSourceCmdlet.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.KNDR.NewKNDRDataSourceCmdlet.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.KNDR.NewKNDRExperienceCmdlet"> <summary> Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.ContentSourceConfiguration_DataSourceId"> <summary> <para> <para>The identifier of the data sources you want to use for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.Description"> <summary> <para> <para>A description for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.ContentSourceConfiguration_DirectPutContent"> <summary> <para> <para><c>TRUE</c> to use documents you indexed directly using the <c>BatchPutDocument</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.ContentSourceConfiguration_FaqId"> <summary> <para> <para>The identifier of the FAQs that you want to use for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.UserIdentityConfiguration_IdentityAttributeName"> <summary> <para> <para>The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context filtering</a> and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started with an IAM Identity Center identity source</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.Name"> <summary> <para> <para>A name for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access <c>Query</c> API, <c>GetQuerySuggestions</c> API, and other required APIs. The role also must include permission to access IAM Identity Center that stores your user and group information. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the <c>CreateExperience</c> API with the same client token creates only one Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRExperienceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateExperienceResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateExperienceResponse 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.KNDR.NewKNDRExperienceCmdlet.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.KNDR.NewKNDRExperienceCmdlet.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.KNDR.NewKNDRFaqCmdlet"> <summary> Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket. <para> Adding FAQs to an index is an asynchronous operation. </para><para> For an example of adding an FAQ to an index using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your FAQ file</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.S3Path_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.Description"> <summary> <para> <para>A description for the FAQ.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.FileFormat"> <summary> <para> <para>The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.</para><para>The default format is CSV.</para><para>The format must match the format of the file stored in the S3 bucket identified in the <c>S3Path</c> parameter.</para><para>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html">Adding questions and answers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the FAQ.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.S3Path_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.LanguageCode"> <summary> <para> <para>The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.Name"> <summary> <para> <para>A name for the FAQ.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create a FAQ. Multiple calls to the <c>CreateFaqRequest</c> API with the same client token will create only one FAQ. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFaqCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateFaqResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateFaqResponse 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.KNDR.NewKNDRFaqCmdlet.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.KNDR.NewKNDRFaqCmdlet.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.KNDR.NewKNDRFeaturedResultsSetCmdlet"> <summary> Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results. <para> You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting <a href="http://aws.amazon.com/contact-us/">Support</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.Description"> <summary> <para> <para>A description for the set of featured results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.FeaturedDocument"> <summary> <para> <para>A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.FeaturedResultsSetName"> <summary> <para> <para>A name for the set of featured results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.IndexId"> <summary> <para> <para>The identifier of the index that you want to use for featuring results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.QueryText"> <summary> <para> <para>A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.Status"> <summary> <para> <para>The current status of the set of featured results. When the value is <c>ACTIVE</c>, featured results are ready for use. You can still configure your settings before setting the status to <c>ACTIVE</c>. You can set the status to <c>ACTIVE</c> or <c>INACTIVE</c> using the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html">UpdateFeaturedResultsSet</a> API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <c>ACTIVE</c> or <c>INACTIVE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create a set of featured results. Multiple calls to the <c>CreateFeaturedResultsSet</c> API with the same client token will create only one featured results set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeaturedResultsSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateFeaturedResultsSetResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateFeaturedResultsSetResponse 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.KNDR.NewKNDRFeaturedResultsSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeaturedResultsSetName parameter. The -PassThru parameter is deprecated, use -Select '^FeaturedResultsSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRFeaturedResultsSetCmdlet.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.KNDR.NewKNDRIndexCmdlet"> <summary> Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the <c>Status</c> field returned from a call to <c>DescribeIndex</c>. The <c>Status</c> field is set to <c>ACTIVE</c> when the index is ready to use. <para> Once the index is active, you can index your documents using the <c>BatchPutDocument</c> API or using one of the supported <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html">data sources</a>. </para><para> For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python SDK</a>. For an example of creating an index and data source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.Description"> <summary> <para> <para>A description for the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.Edition"> <summary> <para> <para>The Amazon Kendra edition to use for the index. Choose <c>DEVELOPER_EDITION</c> for indexes intended for development, testing, or proof of concept. Use <c>ENTERPRISE_EDITION</c> for production. Once you set the edition for an index, it can't be changed.</para><para>The <c>Edition</c> parameter is optional. If you don't supply a value, the default is <c>ENTERPRISE_EDITION</c>.</para><para>For more information on quota limits for Enterprise and Developer editions, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.Name"> <summary> <para> <para>A name for the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.UserContextPolicy"> <summary> <para> <para>The user context policy.</para><dl><dt>ATTRIBUTE_FILTER</dt><dd><para>All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of <c>_user_id</c> and <c>_group_ids</c> or you can provide user and group information in <c>UserContext</c>. </para></dd><dt>USER_TOKEN</dt><dd><para>Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable. </para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.UserGroupResolutionConfiguration_UserGroupResolutionMode"> <summary> <para> <para>The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.UserTokenConfiguration"> <summary> <para> <para>The user token configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create an index. Multiple calls to the <c>CreateIndex</c> API with the same client token will create only one index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateIndexResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRIndexCmdlet.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.KNDR.NewKNDRIndexCmdlet.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.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet"> <summary> Creates a block list to exlcude certain queries from suggestions. <para> Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. </para><para> You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. </para><para> For information on the current quota limits for block lists, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas for Amazon Kendra</a>. </para><para><c>CreateQuerySuggestionsBlockList</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para><para> For an example of creating a block list for query suggestions using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist">Query suggestions block list</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.SourceS3Path_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.Description"> <summary> <para> <para>A description for the block list.</para><para>For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to create a query suggestions block list for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.SourceS3Path_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.Name"> <summary> <para> <para>A name for the block list.</para><para>For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create a query suggestions block list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateQuerySuggestionsBlockListResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateQuerySuggestionsBlockListResponse 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.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRQuerySuggestionsBlockListCmdlet.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.KNDR.NewKNDRThesaurusCmdlet"> <summary> Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format. <para> For an example of adding a thesaurus file to an index, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html">Adding custom synonyms to an index</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.SourceS3Path_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.Description"> <summary> <para> <para>A description for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.SourceS3Path_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.Name"> <summary> <para> <para>A name for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create a thesaurus. Multiple calls to the <c>CreateThesaurus</c> API with the same client token will create only one thesaurus. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.NewKNDRThesaurusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateThesaurusResponse). Specifying the name of a property of type Amazon.Kendra.Model.CreateThesaurusResponse 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.KNDR.NewKNDRThesaurusCmdlet.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.KNDR.NewKNDRThesaurusCmdlet.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.KNDR.RemoveKNDRAccessControlConfigurationCmdlet"> <summary> Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRAccessControlConfigurationCmdlet.Id"> <summary> <para> <para>The identifier of the access control configuration you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRAccessControlConfigurationCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for an access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRAccessControlConfigurationCmdlet.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.Kendra.Model.DeleteAccessControlConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRAccessControlConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRAccessControlConfigurationCmdlet.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.KNDR.RemoveKNDRDataSourceCmdlet"> <summary> Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the <c>Status</c> field returned by a call to the <c>DescribeDataSource</c> API is set to <c>DELETING</c>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html">Deleting Data Sources</a>. <para> Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDataSourceCmdlet.Id"> <summary> <para> <para>The identifier of the data source connector you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDataSourceCmdlet.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.Kendra.Model.DeleteDataSourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDataSourceCmdlet.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.KNDR.RemoveKNDRDocumentBatchCmdlet"> <summary> Removes one or more documents from an index. The documents must have been added with the <c>BatchPutDocument</c> API. <para> The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the <c>BatchGetDocumentStatus</c> API to monitor the progress of deleting your documents. </para><para> Deleting documents from an index using <c>BatchDeleteDocument</c> could take up to an hour or more, depending on the number of documents you want to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.DataSourceSyncJobMetricTarget_DataSourceId"> <summary> <para> <para>The ID of the data source that is running the sync job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.DataSourceSyncJobMetricTarget_DataSourceSyncJobId"> <summary> <para> <para>The ID of the sync job that is running on the data source.</para><para>If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.</para><para>If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.DocumentIdList"> <summary> <para> <para>One or more identifiers for documents to delete from the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.IndexId"> <summary> <para> <para>The identifier of the index that contains the documents to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedDocuments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.BatchDeleteDocumentResponse). Specifying the name of a property of type Amazon.Kendra.Model.BatchDeleteDocumentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRDocumentBatchCmdlet.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.KNDR.RemoveKNDREntitiesFromExperienceCmdlet"> <summary> Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDREntitiesFromExperienceCmdlet.EntityList"> <summary> <para> <para>Lists users or groups in your IAM Identity Center identity source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDREntitiesFromExperienceCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDREntitiesFromExperienceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDREntitiesFromExperienceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedEntityList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.DisassociateEntitiesFromExperienceResponse). Specifying the name of a property of type Amazon.Kendra.Model.DisassociateEntitiesFromExperienceResponse 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.KNDR.RemoveKNDREntitiesFromExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDREntitiesFromExperienceCmdlet.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.KNDR.RemoveKNDRExperienceCmdlet"> <summary> Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRExperienceCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRExperienceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRExperienceCmdlet.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.Kendra.Model.DeleteExperienceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRExperienceCmdlet.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.KNDR.RemoveKNDRFaqCmdlet"> <summary> Removes an FAQ from an index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFaqCmdlet.Id"> <summary> <para> <para>The identifier of the FAQ you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFaqCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the FAQ.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFaqCmdlet.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.Kendra.Model.DeleteFaqResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFaqCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFaqCmdlet.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.KNDR.RemoveKNDRFeaturedResultsSetBatchCmdlet"> <summary> Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFeaturedResultsSetBatchCmdlet.FeaturedResultsSetId"> <summary> <para> <para>The identifiers of the featured results sets that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFeaturedResultsSetBatchCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used for featuring results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFeaturedResultsSetBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.BatchDeleteFeaturedResultsSetResponse). Specifying the name of a property of type Amazon.Kendra.Model.BatchDeleteFeaturedResultsSetResponse 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.KNDR.RemoveKNDRFeaturedResultsSetBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRFeaturedResultsSetBatchCmdlet.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.KNDR.RemoveKNDRIndexCmdlet"> <summary> Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the <c>Status</c> field returned by a call to the <c>DescribeIndex</c> API is set to <c>DELETING</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRIndexCmdlet.Id"> <summary> <para> <para>The identifier of the index you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRIndexCmdlet.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.Kendra.Model.DeleteIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRIndexCmdlet.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.KNDR.RemoveKNDRPersonasFromEntityCmdlet"> <summary> Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPersonasFromEntityCmdlet.EntityId"> <summary> <para> <para>The identifiers of users or groups in your IAM Identity Center identity source. For example, user IDs could be user emails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPersonasFromEntityCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPersonasFromEntityCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPersonasFromEntityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedEntityList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.DisassociatePersonasFromEntitiesResponse). Specifying the name of a property of type Amazon.Kendra.Model.DisassociatePersonasFromEntitiesResponse 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.KNDR.RemoveKNDRPersonasFromEntityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPersonasFromEntityCmdlet.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.KNDR.RemoveKNDRPrincipalMappingCmdlet"> <summary> Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. <para> For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results. </para><para> If you want to delete or replace users or sub groups of a group, you need to use the <c>PutPrincipalMapping</c> operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling <c>PutPrincipalMapping</c>. You can update your internal list of users or sub groups and input this list when calling <c>PutPrincipalMapping</c>. </para><para><c>DeletePrincipalMapping</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source you want to delete a group from.</para><para>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.GroupId"> <summary> <para> <para>The identifier of the group you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to delete a group from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.OrderingId"> <summary> <para> <para>The timestamp identifier you specify to ensure Amazon Kendra does not override the latest <c>DELETE</c> action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.</para><para>The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling <c>PutPrincipalMapping</c>. This ensures your <c>DELETE</c> action for that updated group with the latest members list doesn't get overwritten by earlier <c>DELETE</c> actions for the same group which are yet to be processed.</para><para>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.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.Kendra.Model.DeletePrincipalMappingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupId parameter. The -PassThru parameter is deprecated, use -Select '^GroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRPrincipalMappingCmdlet.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.KNDR.RemoveKNDRQuerySuggestionsBlockListCmdlet"> <summary> Deletes a block list used for query suggestions for an index. <para> A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked. </para><para><c>DeleteQuerySuggestionsBlockList</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRQuerySuggestionsBlockListCmdlet.Id"> <summary> <para> <para>The identifier of the block list you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRQuerySuggestionsBlockListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the block list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRQuerySuggestionsBlockListCmdlet.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.Kendra.Model.DeleteQuerySuggestionsBlockListResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRQuerySuggestionsBlockListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRQuerySuggestionsBlockListCmdlet.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.KNDR.RemoveKNDRResourceTagCmdlet"> <summary> Removes a tag from an index, FAQ, or a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not exist on the resource, it is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRResourceTagCmdlet.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.Kendra.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRResourceTagCmdlet.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.KNDR.RemoveKNDRResourceTagCmdlet.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.KNDR.RemoveKNDRThesaurusCmdlet"> <summary> Deletes an Amazon Kendra thesaurus. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRThesaurusCmdlet.Id"> <summary> <para> <para>The identifier of the thesaurus you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRThesaurusCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRThesaurusCmdlet.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.Kendra.Model.DeleteThesaurusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRThesaurusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.RemoveKNDRThesaurusCmdlet.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.KNDR.SendKNDRFeedbackCmdlet"> <summary> Enables you to provide feedback to Amazon Kendra to improve the performance of your index. <para><c>SubmitFeedback</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.ClickFeedbackItem"> <summary> <para> <para>Tells Amazon Kendra that a particular search result link was chosen by the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.IndexId"> <summary> <para> <para>The identifier of the index that was queried.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.QueryId"> <summary> <para> <para>The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the <c>Query</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.RelevanceFeedbackItem"> <summary> <para> <para>Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.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.Kendra.Model.SubmitFeedbackResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.SendKNDRFeedbackCmdlet.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.KNDR.StartKNDRDataSourceSyncJobCmdlet"> <summary> Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a <c>ResourceInUseException</c> exception. <para> Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StartKNDRDataSourceSyncJobCmdlet.Id"> <summary> <para> <para>The identifier of the data source connector to synchronize.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StartKNDRDataSourceSyncJobCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StartKNDRDataSourceSyncJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.StartDataSourceSyncJobResponse). Specifying the name of a property of type Amazon.Kendra.Model.StartDataSourceSyncJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StartKNDRDataSourceSyncJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StartKNDRDataSourceSyncJobCmdlet.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.KNDR.StopKNDRDataSourceSyncJobCmdlet"> <summary> Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StopKNDRDataSourceSyncJobCmdlet.Id"> <summary> <para> <para>The identifier of the data source connector for which to stop the synchronization jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StopKNDRDataSourceSyncJobCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StopKNDRDataSourceSyncJobCmdlet.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.Kendra.Model.StopDataSourceSyncJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StopKNDRDataSourceSyncJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.StopKNDRDataSourceSyncJobCmdlet.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.KNDR.UpdateKNDRAccessControlConfigurationCmdlet"> <summary> Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. <para> You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. </para><para> You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to apply the updated access control configuration, with the <c>AccessControlConfigurationId</c> included in the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a> object. If you use an S3 bucket as a data source, you synchronize your data source to apply the <c>AccessControlConfigurationId</c> in the <c>.metadata.json</c> file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the <c>BatchPutDocument</c> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.AccessControlList"> <summary> <para> <para>Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.Description"> <summary> <para> <para>A new description for the access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.HierarchicalAccessControlList"> <summary> <para> <para>The updated list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.Id"> <summary> <para> <para>The identifier of the access control configuration you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for an access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.Name"> <summary> <para> <para>A new name for the access control configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.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.Kendra.Model.UpdateAccessControlConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRAccessControlConfigurationCmdlet.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.KNDR.UpdateKNDRDataSourceCmdlet"> <summary> Updates an Amazon Kendra data source connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Kendra currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Kendra currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.Configuration"> <summary> <para> <para>Configuration information you want to update for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.Description"> <summary> <para> <para>A new description for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.Id"> <summary> <para> <para>The identifier of the data source connector you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used with the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_InlineConfiguration"> <summary> <para> <para>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.PostExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.PreExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.LanguageCode"> <summary> <para> <para>The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue"> <summary> <para> <para>A long integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue"> <summary> <para> <para>A long integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.Name"> <summary> <para> <para>A new name for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Operator"> <summary> <para> <para>The condition operator.</para><para>For example, you can use 'Contains' to partially match a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Operator"> <summary> <para> <para>The condition operator.</para><para>For example, you can use 'Contains' to partially match a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.PostExtractionHookConfiguration_S3Bucket"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.PreExtractionHookConfiguration_S3Bucket"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.Schedule"> <summary> <para> <para>The sync schedule you want to update for the data source connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue"> <summary> <para> <para>A list of strings. The default maximum length or number of strings is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue"> <summary> <para> <para>A list of strings. The default maximum length or number of strings is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue"> <summary> <para> <para>A string, such as "department".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue"> <summary> <para> <para>A string, such as "department".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.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.Kendra.Model.UpdateDataSourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRDataSourceCmdlet.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.KNDR.UpdateKNDRExperienceCmdlet"> <summary> Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.ContentSourceConfiguration_DataSourceId"> <summary> <para> <para>The identifier of the data sources you want to use for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.Description"> <summary> <para> <para>A new description for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.ContentSourceConfiguration_DirectPutContent"> <summary> <para> <para><c>TRUE</c> to use documents you indexed directly using the <c>BatchPutDocument</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.ContentSourceConfiguration_FaqId"> <summary> <para> <para>The identifier of the FAQs that you want to use for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.Id"> <summary> <para> <para>The identifier of your Amazon Kendra experience you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.UserIdentityConfiguration_IdentityAttributeName"> <summary> <para> <para>The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context filtering</a> and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started with an IAM Identity Center identity source</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.Name"> <summary> <para> <para>A new name for your Amazon Kendra experience.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to access <c>Query</c> API, <c>QuerySuggestions</c> API, <c>SubmitFeedback</c> API, and IAM Identity Center that stores your user and group information. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.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.Kendra.Model.UpdateExperienceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRExperienceCmdlet.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.KNDR.UpdateKNDRFeaturedResultsSetCmdlet"> <summary> Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.Description"> <summary> <para> <para>A new description for the set of featured results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.FeaturedDocument"> <summary> <para> <para>A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.FeaturedResultsSetId"> <summary> <para> <para>The identifier of the set of featured results that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.FeaturedResultsSetName"> <summary> <para> <para>A new name for the set of featured results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.IndexId"> <summary> <para> <para>The identifier of the index used for featuring results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.QueryText"> <summary> <para> <para>A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.Status"> <summary> <para> <para>You can set the status to <c>ACTIVE</c> or <c>INACTIVE</c>. When the value is <c>ACTIVE</c>, featured results are ready for use. You can still configure your settings before setting the status to <c>ACTIVE</c>. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <c>ACTIVE</c> or <c>INACTIVE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeaturedResultsSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.UpdateFeaturedResultsSetResponse). Specifying the name of a property of type Amazon.Kendra.Model.UpdateFeaturedResultsSetResponse 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.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeaturedResultsSetId parameter. The -PassThru parameter is deprecated, use -Select '^FeaturedResultsSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRFeaturedResultsSetCmdlet.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.KNDR.UpdateKNDRIndexCmdlet"> <summary> Updates an Amazon Kendra index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.Description"> <summary> <para> <para>A new description for the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.DocumentMetadataConfigurationUpdate"> <summary> <para> <para>The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.Id"> <summary> <para> <para>The identifier of the index you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.Name"> <summary> <para> <para>A new name for the index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.CapacityUnits_QueryCapacityUnit"> <summary> <para> <para>The amount of extra query capacity for an index and <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html">GetQuerySuggestions</a> capacity.</para><para>A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.</para><para><c>GetQuerySuggestions</c> capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and <c>GetQuerySuggestions</c> capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the <c>GetQuerySuggestions</c> capacity is 2.5 calls per second (higher than five times 0.2 queries per second).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.RoleArn"> <summary> <para> <para>An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.CapacityUnits_StorageCapacityUnit"> <summary> <para> <para>The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.UserContextPolicy"> <summary> <para> <para>The user context policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.UserGroupResolutionConfiguration_UserGroupResolutionMode"> <summary> <para> <para>The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.UserTokenConfiguration"> <summary> <para> <para>The user token configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.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.Kendra.Model.UpdateIndexResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRIndexCmdlet.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.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet"> <summary> Updates a block list used for query suggestions for an index. <para> Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately. </para><para> If a block list is updating, then you need to wait for the first update to finish before submitting another update. </para><para> Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. </para><para><c>UpdateQuerySuggestionsBlockList</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.SourceS3Path_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.Description"> <summary> <para> <para>A new description for the block list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.Id"> <summary> <para> <para>The identifier of the block list you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the block list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.SourceS3Path_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.Name"> <summary> <para> <para>A new name for the block list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.RoleArn"> <summary> <para> <para>The IAM (Identity and Access Management) role used to access the block list text file in S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.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.Kendra.Model.UpdateQuerySuggestionsBlockListResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsBlockListCmdlet.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.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet"> <summary> Updates the settings of query suggestions for an index. <para> Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. </para><para> If an update is currently processing, you need to wait for the update to finish before making another update. </para><para> Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. </para><para> You can still enable/disable query suggestions at any time. </para><para><c>UpdateQuerySuggestionsConfig</c> is currently not supported in the Amazon Web Services GovCloud (US-West) region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.AttributeSuggestionsConfig_AttributeSuggestionsMode"> <summary> <para> <para>You can set the mode to <c>ACTIVE</c> or <c>INACTIVE</c>. You must also set <c>SuggestionTypes</c> as either <c>QUERY</c> or <c>DOCUMENT_ATTRIBUTES</c> and then call <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html">GetQuerySuggestions</a>. If <c>Mode</c> to use query history is set to <c>ENABLED</c> when calling <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a> and <c>AttributeSuggestionsMode</c> to use fields/attributes is set to <c>ACTIVE</c>, and you haven't set your <c>SuggestionTypes</c> preference to <c>DOCUMENT_ATTRIBUTES</c>, then Amazon Kendra uses the query history.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.IncludeQueriesWithoutUserInformation"> <summary> <para> <para><c>TRUE</c> to include queries without user information (i.e. all queries, irrespective of the user), otherwise <c>FALSE</c> to only include queries with user information.</para><para>If you pass user information to Amazon Kendra along with the queries, you can set this flag to <c>FALSE</c> and instruct Amazon Kendra to only consider queries with user information.</para><para>If you set to <c>FALSE</c>, Amazon Kendra only considers queries searched at least <c>MinimumQueryCount</c> times across <c>MinimumNumberOfQueryingUsers</c> unique users for suggestions.</para><para>If you set to <c>TRUE</c>, Amazon Kendra ignores all user information and learns from all queries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.IndexId"> <summary> <para> <para> The identifier of the index with query suggestions you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.MinimumNumberOfQueryingUser"> <summary> <para> <para>The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.</para><para>Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.</para><para>How you tune this setting depends on your specific needs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.MinimumQueryCount"> <summary> <para> <para>The the minimum number of times a query must be searched in order to be eligible to suggest to your users.</para><para>Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.</para><para>How you tune this setting depends on your specific needs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.Mode"> <summary> <para> <para>Set the mode to <c>ENABLED</c> or <c>LEARN_ONLY</c>.</para><para>By default, Amazon Kendra enables query suggestions. <c>LEARN_ONLY</c> mode allows you to turn off query suggestions. You can to update this at any time.</para><para>In <c>LEARN_ONLY</c> mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.QueryLogLookBackWindowInDay"> <summary> <para> <para>How recent your queries are in your query log time window.</para><para>The time window is the number of days from current day to past days.</para><para>By default, Amazon Kendra sets this to 180.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.AttributeSuggestionsConfig_SuggestableConfigList"> <summary> <para> <para>The list of fields/attributes that you want to set as suggestible for query suggestions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.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.Kendra.Model.UpdateQuerySuggestionsConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRQuerySuggestionsConfigCmdlet.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.KNDR.UpdateKNDRThesaurusCmdlet"> <summary> Updates a thesaurus for an index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.SourceS3Path_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.Description"> <summary> <para> <para>A new description for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.Id"> <summary> <para> <para>The identifier of the thesaurus you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.IndexId"> <summary> <para> <para>The identifier of the index for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.SourceS3Path_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.Name"> <summary> <para> <para>A new name for the thesaurus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.RoleArn"> <summary> <para> <para>An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in <c>SourceS3Path</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.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.Kendra.Model.UpdateThesaurusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.UpdateKNDRThesaurusCmdlet.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.KNDR.WriteKNDRDocumentBatchCmdlet"> <summary> Adds one or more documents to an index. <para> The <c>BatchPutDocument</c> API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. </para><para> The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the <c>BatchGetDocumentStatus</c> API to monitor the progress of indexing your documents. </para><para> For an example of ingesting inline documents using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding files directly to an index</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Kendra currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey"> <summary> <para> <para>The identifier of the document attribute used for the condition.</para><para>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</para><para>Amazon Kendra currently does not support <c>_document_body</c> as an attribute key used for the condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue"> <summary> <para> <para>A date expressed as an ISO 8601 string.</para><para>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.Document"> <summary> <para> <para>One or more documents to add to the index.</para><para>Documents have the following file size limits.</para><ul><li><para>50 MB total size for any file</para></li><li><para>5 MB extracted text for any file</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.IndexId"> <summary> <para> <para>The identifier of the index to add the documents to. You need to create the index first using the <c>CreateIndex</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_InlineConfiguration"> <summary> <para> <para>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.PostExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.PreExtractionHookConfiguration_LambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue"> <summary> <para> <para>A long integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue"> <summary> <para> <para>A long integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Operator"> <summary> <para> <para>The condition operator.</para><para>For example, you can use 'Contains' to partially match a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Operator"> <summary> <para> <para>The condition operator.</para><para>For example, you can use 'Contains' to partially match a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role with permission to run <c>PreExtractionHookConfiguration</c> and <c>PostExtractionHookConfiguration</c> for altering document metadata and content during the document ingestion process. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.PostExtractionHookConfiguration_S3Bucket"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.PreExtractionHookConfiguration_S3Bucket"> <summary> <para> <para>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue"> <summary> <para> <para>A list of strings. The default maximum length or number of strings is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue"> <summary> <para> <para>A list of strings. The default maximum length or number of strings is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue"> <summary> <para> <para>A string, such as "department".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue"> <summary> <para> <para>A string, such as "department".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedDocuments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.BatchPutDocumentResponse). Specifying the name of a property of type Amazon.Kendra.Model.BatchPutDocumentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRDocumentBatchCmdlet.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.KNDR.WriteKNDRPrincipalMappingCmdlet"> <summary> Maps users to their groups so that you only need to provide the user ID when you issue the query. <para> You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. </para><para> This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering on user context</a>. </para><para> If more than five <c>PUT</c> actions for a group are currently processing, a validation exception is thrown. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.S3PathforGroupMembers_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.DataSourceId"> <summary> <para> <para>The identifier of the data source you want to map users to their groups.</para><para>This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.GroupId"> <summary> <para> <para>The identifier of the group you want to map its users to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.IndexId"> <summary> <para> <para>The identifier of the index you want to map users to their groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.S3PathforGroupMembers_Key"> <summary> <para> <para>The name of the file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.GroupMembers_MemberGroup"> <summary> <para> <para>A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.GroupMembers_MemberUser"> <summary> <para> <para>A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.OrderingId"> <summary> <para> <para>The timestamp identifier you specify to ensure Amazon Kendra does not override the latest <c>PUT</c> action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.</para><para>The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling <c>PutPrincipalMapping</c>. This ensures your <c>PUT</c> action for that updated group with the latest members list doesn't get overwritten by earlier <c>PUT</c> actions for the same group which are yet to be processed.</para><para>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.</para><para>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds">IAM roles for Amazon Kendra</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.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.Kendra.Model.PutPrincipalMappingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupId parameter. The -PassThru parameter is deprecated, use -Select '^GroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNDR.WriteKNDRPrincipalMappingCmdlet.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> |