@aws-sdk/client-kendra 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/dist-types/Kendra.d.ts +61 -0
  2. package/dist-types/KendraClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +16 -0
  6. package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +16 -0
  7. package/dist-types/commands/BatchPutDocumentCommand.d.ts +16 -0
  8. package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateDataSourceCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateExperienceCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateFaqCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateIndexCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateThesaurusCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteDataSourceCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteExperienceCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteFaqCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteIndexCommand.d.ts +16 -0
  21. package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteThesaurusCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeDataSourceCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeExperienceCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeFaqCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeIndexCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeThesaurusCommand.d.ts +16 -0
  33. package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +16 -0
  34. package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +16 -0
  35. package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +16 -0
  36. package/dist-types/commands/GetSnapshotsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +16 -0
  38. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +16 -0
  39. package/dist-types/commands/ListDataSourcesCommand.d.ts +16 -0
  40. package/dist-types/commands/ListEntityPersonasCommand.d.ts +16 -0
  41. package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +16 -0
  42. package/dist-types/commands/ListExperiencesCommand.d.ts +16 -0
  43. package/dist-types/commands/ListFaqsCommand.d.ts +16 -0
  44. package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +16 -0
  45. package/dist-types/commands/ListIndicesCommand.d.ts +16 -0
  46. package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/ListThesauriCommand.d.ts +16 -0
  49. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +16 -0
  50. package/dist-types/commands/QueryCommand.d.ts +16 -0
  51. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +16 -0
  52. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +16 -0
  53. package/dist-types/commands/SubmitFeedbackCommand.d.ts +16 -0
  54. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  55. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  56. package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +16 -0
  57. package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
  58. package/dist-types/commands/UpdateExperienceCommand.d.ts +16 -0
  59. package/dist-types/commands/UpdateIndexCommand.d.ts +16 -0
  60. package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +16 -0
  61. package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +16 -0
  62. package/dist-types/commands/UpdateThesaurusCommand.d.ts +16 -0
  63. package/dist-types/models/KendraServiceException.d.ts +2 -0
  64. package/dist-types/models/models_0.d.ts +617 -1
  65. package/dist-types/models/models_1.d.ts +16 -0
  66. package/dist-types/pagination/GetSnapshotsPaginator.d.ts +3 -0
  67. package/dist-types/pagination/Interfaces.d.ts +3 -0
  68. package/dist-types/pagination/ListAccessControlConfigurationsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/ListDataSourceSyncJobsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListDataSourcesPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListEntityPersonasPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListExperienceEntitiesPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListExperiencesPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListFaqsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListGroupsOlderThanOrderingIdPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListIndicesPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListQuerySuggestionsBlockListsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListThesauriPaginator.d.ts +3 -0
  79. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { BatchDeleteDocumentRequest, BatchDeleteDocumentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchDeleteDocumentCommand}.
8
10
  */
9
11
  export interface BatchDeleteDocumentCommandInput extends BatchDeleteDocumentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchDeleteDocumentCommand}.
13
17
  */
14
18
  export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more documents from an index. The documents must have
18
23
  * been added with the <code>BatchPutDocument</code> API.</p>
19
24
  * <p>The documents are deleted asynchronously. You can see the progress of
@@ -29,6 +34,8 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param BatchDeleteDocumentCommandInput - {@link BatchDeleteDocumentCommandInput}
38
+ * @returns {@link BatchDeleteDocumentCommandOutput}
32
39
  * @see {@link BatchDeleteDocumentCommandInput} for command's `input` shape.
33
40
  * @see {@link BatchDeleteDocumentCommandOutput} for command's `response` shape.
34
41
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -62,11 +69,20 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
62
69
  export declare class BatchDeleteDocumentCommand extends $Command<BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput, KendraClientResolvedConfig> {
63
70
  readonly input: BatchDeleteDocumentCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: BatchDeleteDocumentCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { BatchGetDocumentStatusRequest, BatchGetDocumentStatusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetDocumentStatusCommand}.
8
10
  */
9
11
  export interface BatchGetDocumentStatusCommandInput extends BatchGetDocumentStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetDocumentStatusCommand}.
13
17
  */
14
18
  export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the indexing status for one or more documents submitted
18
23
  * with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
19
24
  * BatchPutDocument</a> API.</p>
@@ -37,6 +42,8 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param BatchGetDocumentStatusCommandInput - {@link BatchGetDocumentStatusCommandInput}
46
+ * @returns {@link BatchGetDocumentStatusCommandOutput}
40
47
  * @see {@link BatchGetDocumentStatusCommandInput} for command's `input` shape.
41
48
  * @see {@link BatchGetDocumentStatusCommandOutput} for command's `response` shape.
42
49
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -70,11 +77,20 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
70
77
  export declare class BatchGetDocumentStatusCommand extends $Command<BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput, KendraClientResolvedConfig> {
71
78
  readonly input: BatchGetDocumentStatusCommandInput;
72
79
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
80
+ /**
81
+ * @public
82
+ */
73
83
  constructor(input: BatchGetDocumentStatusCommandInput);
74
84
  /**
75
85
  * @internal
76
86
  */
77
87
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput>;
88
+ /**
89
+ * @internal
90
+ */
78
91
  private serialize;
92
+ /**
93
+ * @internal
94
+ */
79
95
  private deserialize;
80
96
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { BatchPutDocumentRequest, BatchPutDocumentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchPutDocumentCommand}.
8
10
  */
9
11
  export interface BatchPutDocumentCommandInput extends BatchPutDocumentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchPutDocumentCommand}.
13
17
  */
14
18
  export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds one or more documents to an index.</p>
18
23
  * <p>The <code>BatchPutDocument</code> API enables you to ingest
19
24
  * inline documents or a set of documents stored in an Amazon S3 bucket. Use
@@ -36,6 +41,8 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param BatchPutDocumentCommandInput - {@link BatchPutDocumentCommandInput}
45
+ * @returns {@link BatchPutDocumentCommandOutput}
39
46
  * @see {@link BatchPutDocumentCommandInput} for command's `input` shape.
40
47
  * @see {@link BatchPutDocumentCommandOutput} for command's `response` shape.
41
48
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -74,11 +81,20 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
74
81
  export declare class BatchPutDocumentCommand extends $Command<BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput, KendraClientResolvedConfig> {
75
82
  readonly input: BatchPutDocumentCommandInput;
76
83
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
84
+ /**
85
+ * @public
86
+ */
77
87
  constructor(input: BatchPutDocumentCommandInput);
78
88
  /**
79
89
  * @internal
80
90
  */
81
91
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput>;
92
+ /**
93
+ * @internal
94
+ */
82
95
  private serialize;
96
+ /**
97
+ * @internal
98
+ */
83
99
  private deserialize;
84
100
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { ClearQuerySuggestionsRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ClearQuerySuggestionsCommand}.
8
10
  */
9
11
  export interface ClearQuerySuggestionsCommandInput extends ClearQuerySuggestionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ClearQuerySuggestionsCommand}.
13
17
  */
14
18
  export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Clears existing query suggestions from an index.</p>
18
23
  * <p>This deletes existing suggestions only, not the queries
19
24
  * in the query log. After you clear suggestions, Amazon Kendra learns
@@ -34,6 +39,8 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param ClearQuerySuggestionsCommandInput - {@link ClearQuerySuggestionsCommandInput}
43
+ * @returns {@link ClearQuerySuggestionsCommandOutput}
37
44
  * @see {@link ClearQuerySuggestionsCommandInput} for command's `input` shape.
38
45
  * @see {@link ClearQuerySuggestionsCommandOutput} for command's `response` shape.
39
46
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -67,11 +74,20 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
67
74
  export declare class ClearQuerySuggestionsCommand extends $Command<ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput, KendraClientResolvedConfig> {
68
75
  readonly input: ClearQuerySuggestionsCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: ClearQuerySuggestionsCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateAccessControlConfigurationRequest, CreateAccessControlConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAccessControlConfigurationCommand}.
8
10
  */
9
11
  export interface CreateAccessControlConfigurationCommandInput extends CreateAccessControlConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAccessControlConfigurationCommand}.
13
17
  */
14
18
  export interface CreateAccessControlConfigurationCommandOutput extends CreateAccessControlConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an access configuration for your documents. This includes
18
23
  * user and group access information for your documents. This is useful
19
24
  * for user context filtering, where search results are filtered based
@@ -47,6 +52,8 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param CreateAccessControlConfigurationCommandInput - {@link CreateAccessControlConfigurationCommandInput}
56
+ * @returns {@link CreateAccessControlConfigurationCommandOutput}
50
57
  * @see {@link CreateAccessControlConfigurationCommandInput} for command's `input` shape.
51
58
  * @see {@link CreateAccessControlConfigurationCommandOutput} for command's `response` shape.
52
59
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -85,11 +92,20 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
85
92
  export declare class CreateAccessControlConfigurationCommand extends $Command<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
86
93
  readonly input: CreateAccessControlConfigurationCommandInput;
87
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
88
98
  constructor(input: CreateAccessControlConfigurationCommandInput);
89
99
  /**
90
100
  * @internal
91
101
  */
92
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
93
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
94
110
  private deserialize;
95
111
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateDataSourceRequest, CreateDataSourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataSourceCommand}.
8
10
  */
9
11
  export interface CreateDataSourceCommandInput extends CreateDataSourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataSourceCommand}.
13
17
  */
14
18
  export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a data source connector that you want to use with an Amazon Kendra
18
23
  * index.</p>
19
24
  * <p>You specify a name, data source connector type and description for your data source. You
@@ -37,6 +42,8 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param CreateDataSourceCommandInput - {@link CreateDataSourceCommandInput}
46
+ * @returns {@link CreateDataSourceCommandOutput}
40
47
  * @see {@link CreateDataSourceCommandInput} for command's `input` shape.
41
48
  * @see {@link CreateDataSourceCommandOutput} for command's `response` shape.
42
49
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -79,11 +86,20 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
79
86
  export declare class CreateDataSourceCommand extends $Command<CreateDataSourceCommandInput, CreateDataSourceCommandOutput, KendraClientResolvedConfig> {
80
87
  readonly input: CreateDataSourceCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: CreateDataSourceCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataSourceCommandInput, CreateDataSourceCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateExperienceRequest, CreateExperienceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateExperienceCommand}.
8
10
  */
9
11
  export interface CreateExperienceCommandInput extends CreateExperienceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateExperienceCommand}.
13
17
  */
14
18
  export interface CreateExperienceCommandOutput extends CreateExperienceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Kendra experience such as a search application. For more information
18
23
  * on creating a search application experience, including using the Python and Java SDKs,
19
24
  * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
@@ -28,6 +33,8 @@ export interface CreateExperienceCommandOutput extends CreateExperienceResponse,
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateExperienceCommandInput - {@link CreateExperienceCommandInput}
37
+ * @returns {@link CreateExperienceCommandOutput}
31
38
  * @see {@link CreateExperienceCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateExperienceCommandOutput} for command's `response` shape.
33
40
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -66,11 +73,20 @@ export interface CreateExperienceCommandOutput extends CreateExperienceResponse,
66
73
  export declare class CreateExperienceCommand extends $Command<CreateExperienceCommandInput, CreateExperienceCommandOutput, KendraClientResolvedConfig> {
67
74
  readonly input: CreateExperienceCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: CreateExperienceCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateExperienceCommandInput, CreateExperienceCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateFaqRequest, CreateFaqResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateFaqCommand}.
8
10
  */
9
11
  export interface CreateFaqCommandInput extends CreateFaqRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateFaqCommand}.
13
17
  */
14
18
  export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
18
23
  * <p>Adding FAQs to an index is an asynchronous operation.</p>
19
24
  * <p>For an example of adding an FAQ to an index using Python and Java SDKs,
@@ -29,6 +34,8 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateFaqCommandInput - {@link CreateFaqCommandInput}
38
+ * @returns {@link CreateFaqCommandOutput}
32
39
  * @see {@link CreateFaqCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateFaqCommandOutput} for command's `response` shape.
34
41
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -67,11 +74,20 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
67
74
  export declare class CreateFaqCommand extends $Command<CreateFaqCommandInput, CreateFaqCommandOutput, KendraClientResolvedConfig> {
68
75
  readonly input: CreateFaqCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: CreateFaqCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateFaqCommandInput, CreateFaqCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateIndexRequest, CreateIndexResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateIndexCommand}.
8
10
  */
9
11
  export interface CreateIndexCommandInput extends CreateIndexRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateIndexCommand}.
13
17
  */
14
18
  export interface CreateIndexCommandOutput extends CreateIndexResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
18
23
  * if index creation has completed, check the <code>Status</code> field returned from a call to
19
24
  * <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when
@@ -34,6 +39,8 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param CreateIndexCommandInput - {@link CreateIndexCommandInput}
43
+ * @returns {@link CreateIndexCommandOutput}
37
44
  * @see {@link CreateIndexCommandInput} for command's `input` shape.
38
45
  * @see {@link CreateIndexCommandOutput} for command's `response` shape.
39
46
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -72,11 +79,20 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
72
79
  export declare class CreateIndexCommand extends $Command<CreateIndexCommandInput, CreateIndexCommandOutput, KendraClientResolvedConfig> {
73
80
  readonly input: CreateIndexCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: CreateIndexCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateIndexCommandInput, CreateIndexCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateQuerySuggestionsBlockListRequest, CreateQuerySuggestionsBlockListResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateQuerySuggestionsBlockListCommand}.
8
10
  */
9
11
  export interface CreateQuerySuggestionsBlockListCommandInput extends CreateQuerySuggestionsBlockListRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateQuerySuggestionsBlockListCommand}.
13
17
  */
14
18
  export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuerySuggestionsBlockListResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a block list to exlcude certain queries from suggestions.</p>
18
23
  * <p>Any query that contains words or phrases specified in the block
19
24
  * list is blocked or filtered out from being shown as a suggestion.</p>
@@ -39,6 +44,8 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param CreateQuerySuggestionsBlockListCommandInput - {@link CreateQuerySuggestionsBlockListCommandInput}
48
+ * @returns {@link CreateQuerySuggestionsBlockListCommandOutput}
42
49
  * @see {@link CreateQuerySuggestionsBlockListCommandInput} for command's `input` shape.
43
50
  * @see {@link CreateQuerySuggestionsBlockListCommandOutput} for command's `response` shape.
44
51
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -77,11 +84,20 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
77
84
  export declare class CreateQuerySuggestionsBlockListCommand extends $Command<CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {
78
85
  readonly input: CreateQuerySuggestionsBlockListCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: CreateQuerySuggestionsBlockListCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { CreateThesaurusRequest, CreateThesaurusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateThesaurusCommand}.
8
10
  */
9
11
  export interface CreateThesaurusCommandInput extends CreateThesaurusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateThesaurusCommand}.
13
17
  */
14
18
  export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a thesaurus for an index. The thesaurus
18
23
  * contains a list of synonyms in Solr format.</p>
19
24
  * <p>For an example of adding a thesaurus file to an index, see
@@ -29,6 +34,8 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateThesaurusCommandInput - {@link CreateThesaurusCommandInput}
38
+ * @returns {@link CreateThesaurusCommandOutput}
32
39
  * @see {@link CreateThesaurusCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateThesaurusCommandOutput} for command's `response` shape.
34
41
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -67,11 +74,20 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
67
74
  export declare class CreateThesaurusCommand extends $Command<CreateThesaurusCommandInput, CreateThesaurusCommandOutput, KendraClientResolvedConfig> {
68
75
  readonly input: CreateThesaurusCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: CreateThesaurusCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateThesaurusCommandInput, CreateThesaurusCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
5
  import { DeleteAccessControlConfigurationRequest, DeleteAccessControlConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAccessControlConfigurationCommand}.
8
10
  */
9
11
  export interface DeleteAccessControlConfigurationCommandInput extends DeleteAccessControlConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAccessControlConfigurationCommand}.
13
17
  */
14
18
  export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAccessControlConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an access control configuration that you created for your
18
23
  * documents in an index. This includes user and group access information
19
24
  * for your documents. This is useful for user context filtering, where search
@@ -28,6 +33,8 @@ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAcc
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteAccessControlConfigurationCommandInput - {@link DeleteAccessControlConfigurationCommandInput}
37
+ * @returns {@link DeleteAccessControlConfigurationCommandOutput}
31
38
  * @see {@link DeleteAccessControlConfigurationCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteAccessControlConfigurationCommandOutput} for command's `response` shape.
33
40
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAcc
61
68
  export declare class DeleteAccessControlConfigurationCommand extends $Command<DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
62
69
  readonly input: DeleteAccessControlConfigurationCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteAccessControlConfigurationCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }