@aws-sdk/client-kendra 3.321.1 → 3.326.0

package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts

@@ -32,7 +32,7 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
  *             <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  *          <p>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#suggestions-block-list">Query
+ *             Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist">Query
  *                 suggestions block list</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -59,6 +59,10 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
  * };
  * const command = new CreateQuerySuggestionsBlockListCommand(input);
  * const response = await client.send(command);
+ * // { // CreateQuerySuggestionsBlockListResponse
+ * //   Id: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateQuerySuggestionsBlockListCommandInput - {@link CreateQuerySuggestionsBlockListCommandInput}
@@ -97,6 +101,8 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class CreateQuerySuggestionsBlockListCommand extends $Command<CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/CreateThesaurusCommand.d.ts

@@ -49,6 +49,10 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
  * };
  * const command = new CreateThesaurusCommand(input);
  * const response = await client.send(command);
+ * // { // CreateThesaurusResponse
+ * //   Id: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateThesaurusCommandInput - {@link CreateThesaurusCommandInput}
@@ -87,6 +91,8 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class CreateThesaurusCommand extends $Command<CreateThesaurusCommandInput, CreateThesaurusCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts

@@ -35,6 +35,8 @@ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAcc
  * };
  * const command = new DeleteAccessControlConfigurationCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteAccessControlConfigurationCommandInput - {@link DeleteAccessControlConfigurationCommandInput}
@@ -67,6 +69,8 @@ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAcc
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteAccessControlConfigurationCommand extends $Command<DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteDataSourceCommand.d.ts

@@ -35,6 +35,8 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteDataSourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteDataSourceCommandInput - {@link DeleteDataSourceCommandInput}
@@ -67,6 +69,8 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteDataSourceCommand extends $Command<DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteExperienceCommand.d.ts

@@ -34,6 +34,8 @@ export interface DeleteExperienceCommandOutput extends DeleteExperienceResponse,
  * };
  * const command = new DeleteExperienceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteExperienceCommandInput - {@link DeleteExperienceCommandInput}
@@ -66,6 +68,8 @@ export interface DeleteExperienceCommandOutput extends DeleteExperienceResponse,
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteExperienceCommand extends $Command<DeleteExperienceCommandInput, DeleteExperienceCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteFaqCommand.d.ts

@@ -32,6 +32,8 @@ export interface DeleteFaqCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteFaqCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteFaqCommandInput - {@link DeleteFaqCommandInput}
@@ -64,6 +66,8 @@ export interface DeleteFaqCommandOutput extends __MetadataBearer {
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteFaqCommand extends $Command<DeleteFaqCommandInput, DeleteFaqCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteIndexCommand.d.ts

@@ -34,6 +34,8 @@ export interface DeleteIndexCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteIndexCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteIndexCommandInput - {@link DeleteIndexCommandInput}
@@ -66,6 +68,8 @@ export interface DeleteIndexCommandOutput extends __MetadataBearer {
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteIndexCommand extends $Command<DeleteIndexCommandInput, DeleteIndexCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeletePrincipalMappingCommand.d.ts

@@ -46,6 +46,8 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeletePrincipalMappingCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeletePrincipalMappingCommandInput - {@link DeletePrincipalMappingCommandInput}
@@ -78,6 +80,8 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeletePrincipalMappingCommand extends $Command<DeletePrincipalMappingCommandInput, DeletePrincipalMappingCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts

@@ -38,6 +38,8 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
  * };
  * const command = new DeleteQuerySuggestionsBlockListCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteQuerySuggestionsBlockListCommandInput - {@link DeleteQuerySuggestionsBlockListCommandInput}
@@ -70,6 +72,8 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteQuerySuggestionsBlockListCommand extends $Command<DeleteQuerySuggestionsBlockListCommandInput, DeleteQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DeleteThesaurusCommand.d.ts

@@ -33,6 +33,8 @@ export interface DeleteThesaurusCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteThesaurusCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteThesaurusCommandInput - {@link DeleteThesaurusCommandInput}
@@ -65,6 +67,8 @@ export interface DeleteThesaurusCommandOutput extends __MetadataBearer {
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DeleteThesaurusCommand extends $Command<DeleteThesaurusCommandInput, DeleteThesaurusCommandOutput, KendraClientResolvedConfig> {

package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts

@@ -35,6 +35,32 @@ export interface DescribeAccessControlConfigurationCommandOutput extends Describ
  * };
  * const command = new DescribeAccessControlConfigurationCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccessControlConfigurationResponse
+ * //   Name: "STRING_VALUE", // required
+ * //   Description: "STRING_VALUE",
+ * //   ErrorMessage: "STRING_VALUE",
+ * //   AccessControlList: [ // PrincipalList
+ * //     { // Principal
+ * //       Name: "STRING_VALUE", // required
+ * //       Type: "USER" || "GROUP", // required
+ * //       Access: "ALLOW" || "DENY", // required
+ * //       DataSourceId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   HierarchicalAccessControlList: [ // HierarchicalPrincipalList
+ * //     { // HierarchicalPrincipal
+ * //       PrincipalList: [ // required
+ * //         {
+ * //           Name: "STRING_VALUE", // required
+ * //           Type: "USER" || "GROUP", // required
+ * //           Access: "ALLOW" || "DENY", // required
+ * //           DataSourceId: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeAccessControlConfigurationCommandInput - {@link DescribeAccessControlConfigurationCommandInput}
@@ -63,6 +89,8 @@ export interface DescribeAccessControlConfigurationCommandOutput extends Describ
  *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
  *             Please provide the correct input and try again.</p>
  *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
  *
  */
 export declare class DescribeAccessControlConfigurationCommand extends $Command<DescribeAccessControlConfigurationCommandInput, DescribeAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {