@aws-sdk/client-wisdom 3.296.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 (44) hide show
  1. package/dist-types/Wisdom.d.ts +34 -2
  2. package/dist-types/WisdomClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAssistantCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateContentCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateSessionCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteAssistantCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteContentCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +16 -0
  12. package/dist-types/commands/GetAssistantAssociationCommand.d.ts +16 -0
  13. package/dist-types/commands/GetAssistantCommand.d.ts +16 -0
  14. package/dist-types/commands/GetContentCommand.d.ts +16 -0
  15. package/dist-types/commands/GetContentSummaryCommand.d.ts +16 -0
  16. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +16 -0
  17. package/dist-types/commands/GetRecommendationsCommand.d.ts +16 -0
  18. package/dist-types/commands/GetSessionCommand.d.ts +16 -0
  19. package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListAssistantsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListContentsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +16 -0
  25. package/dist-types/commands/QueryAssistantCommand.d.ts +16 -0
  26. package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +16 -0
  27. package/dist-types/commands/SearchContentCommand.d.ts +16 -0
  28. package/dist-types/commands/SearchSessionsCommand.d.ts +16 -0
  29. package/dist-types/commands/StartContentUploadCommand.d.ts +16 -0
  30. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateContentCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +18 -2
  34. package/dist-types/models/WisdomServiceException.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +271 -1
  36. package/dist-types/pagination/Interfaces.d.ts +3 -0
  37. package/dist-types/pagination/ListAssistantAssociationsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListAssistantsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListContentsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +3 -0
  41. package/dist-types/pagination/QueryAssistantPaginator.d.ts +3 -0
  42. package/dist-types/pagination/SearchContentPaginator.d.ts +3 -0
  43. package/dist-types/pagination/SearchSessionsPaginator.d.ts +3 -0
  44. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListKnowledgeBasesRequest, ListKnowledgeBasesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListKnowledgeBasesCommand}.
8
10
  */
9
11
  export interface ListKnowledgeBasesCommandInput extends ListKnowledgeBasesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListKnowledgeBasesCommand}.
13
17
  */
14
18
  export interface ListKnowledgeBasesCommandOutput extends ListKnowledgeBasesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the knowledge bases.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListKnowledgeBasesCommandOutput extends ListKnowledgeBasesRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListKnowledgeBasesCommandInput - {@link ListKnowledgeBasesCommandInput}
34
+ * @returns {@link ListKnowledgeBasesCommandOutput}
28
35
  * @see {@link ListKnowledgeBasesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListKnowledgeBasesCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -40,11 +47,20 @@ export interface ListKnowledgeBasesCommandOutput extends ListKnowledgeBasesRespo
40
47
  export declare class ListKnowledgeBasesCommand extends $Command<ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput, WisdomClientResolvedConfig> {
41
48
  readonly input: ListKnowledgeBasesCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: ListKnowledgeBasesCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags for the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -37,11 +44,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
37
44
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, WisdomClientResolvedConfig> {
38
45
  readonly input: ListTagsForResourceCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: ListTagsForResourceCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { NotifyRecommendationsReceivedRequest, NotifyRecommendationsReceivedResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link NotifyRecommendationsReceivedCommand}.
8
10
  */
9
11
  export interface NotifyRecommendationsReceivedCommandInput extends NotifyRecommendationsReceivedRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link NotifyRecommendationsReceivedCommand}.
13
17
  */
14
18
  export interface NotifyRecommendationsReceivedCommandOutput extends NotifyRecommendationsReceivedResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified recommendations from the specified assistant's queue of newly
18
23
  * available recommendations. You can use this API in conjunction with <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a> and a <code>waitTimeSeconds</code> input for long-polling
19
24
  * behavior and avoiding duplicate recommendations.</p>
@@ -27,6 +32,8 @@ export interface NotifyRecommendationsReceivedCommandOutput extends NotifyRecomm
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param NotifyRecommendationsReceivedCommandInput - {@link NotifyRecommendationsReceivedCommandInput}
36
+ * @returns {@link NotifyRecommendationsReceivedCommandOutput}
30
37
  * @see {@link NotifyRecommendationsReceivedCommandInput} for command's `input` shape.
31
38
  * @see {@link NotifyRecommendationsReceivedCommandOutput} for command's `response` shape.
32
39
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -45,11 +52,20 @@ export interface NotifyRecommendationsReceivedCommandOutput extends NotifyRecomm
45
52
  export declare class NotifyRecommendationsReceivedCommand extends $Command<NotifyRecommendationsReceivedCommandInput, NotifyRecommendationsReceivedCommandOutput, WisdomClientResolvedConfig> {
46
53
  readonly input: NotifyRecommendationsReceivedCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: NotifyRecommendationsReceivedCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<NotifyRecommendationsReceivedCommandInput, NotifyRecommendationsReceivedCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { QueryAssistantRequest, QueryAssistantResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link QueryAssistantCommand}.
8
10
  */
9
11
  export interface QueryAssistantCommandInput extends QueryAssistantRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link QueryAssistantCommand}.
13
17
  */
14
18
  export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Performs a manual search against the specified assistant. To retrieve recommendations for
18
23
  * an assistant, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __M
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param QueryAssistantCommandInput - {@link QueryAssistantCommandInput}
36
+ * @returns {@link QueryAssistantCommandOutput}
30
37
  * @see {@link QueryAssistantCommandInput} for command's `input` shape.
31
38
  * @see {@link QueryAssistantCommandOutput} for command's `response` shape.
32
39
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -45,11 +52,20 @@ export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __M
45
52
  export declare class QueryAssistantCommand extends $Command<QueryAssistantCommandInput, QueryAssistantCommandOutput, WisdomClientResolvedConfig> {
46
53
  readonly input: QueryAssistantCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: QueryAssistantCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<QueryAssistantCommandInput, QueryAssistantCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RemoveKnowledgeBaseTemplateUriRequest, RemoveKnowledgeBaseTemplateUriResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveKnowledgeBaseTemplateUriCommand}.
8
10
  */
9
11
  export interface RemoveKnowledgeBaseTemplateUriCommandInput extends RemoveKnowledgeBaseTemplateUriRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveKnowledgeBaseTemplateUriCommand}.
13
17
  */
14
18
  export interface RemoveKnowledgeBaseTemplateUriCommandOutput extends RemoveKnowledgeBaseTemplateUriResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a URI template from a knowledge base.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RemoveKnowledgeBaseTemplateUriCommandOutput extends RemoveKnowl
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RemoveKnowledgeBaseTemplateUriCommandInput - {@link RemoveKnowledgeBaseTemplateUriCommandInput}
34
+ * @returns {@link RemoveKnowledgeBaseTemplateUriCommandOutput}
28
35
  * @see {@link RemoveKnowledgeBaseTemplateUriCommandInput} for command's `input` shape.
29
36
  * @see {@link RemoveKnowledgeBaseTemplateUriCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -43,11 +50,20 @@ export interface RemoveKnowledgeBaseTemplateUriCommandOutput extends RemoveKnowl
43
50
  export declare class RemoveKnowledgeBaseTemplateUriCommand extends $Command<RemoveKnowledgeBaseTemplateUriCommandInput, RemoveKnowledgeBaseTemplateUriCommandOutput, WisdomClientResolvedConfig> {
44
51
  readonly input: RemoveKnowledgeBaseTemplateUriCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: RemoveKnowledgeBaseTemplateUriCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveKnowledgeBaseTemplateUriCommandInput, RemoveKnowledgeBaseTemplateUriCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SearchContentRequest, SearchContentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchContentCommand}.
8
10
  */
9
11
  export interface SearchContentCommandInput extends SearchContentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchContentCommand}.
13
17
  */
14
18
  export interface SearchContentCommandOutput extends SearchContentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Searches for content in a specified knowledge base. Can be used to get a specific content
18
23
  * resource by its name.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface SearchContentCommandOutput extends SearchContentResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param SearchContentCommandInput - {@link SearchContentCommandInput}
35
+ * @returns {@link SearchContentCommandOutput}
29
36
  * @see {@link SearchContentCommandInput} for command's `input` shape.
30
37
  * @see {@link SearchContentCommandOutput} for command's `response` shape.
31
38
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -44,11 +51,20 @@ export interface SearchContentCommandOutput extends SearchContentResponse, __Met
44
51
  export declare class SearchContentCommand extends $Command<SearchContentCommandInput, SearchContentCommandOutput, WisdomClientResolvedConfig> {
45
52
  readonly input: SearchContentCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: SearchContentCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchContentCommandInput, SearchContentCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SearchSessionsRequest, SearchSessionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchSessionsCommand}.
8
10
  */
9
11
  export interface SearchSessionsCommandInput extends SearchSessionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchSessionsCommand}.
13
17
  */
14
18
  export interface SearchSessionsCommandOutput extends SearchSessionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Searches for sessions.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SearchSessionsCommandOutput extends SearchSessionsResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param SearchSessionsCommandInput - {@link SearchSessionsCommandInput}
34
+ * @returns {@link SearchSessionsCommandOutput}
28
35
  * @see {@link SearchSessionsCommandInput} for command's `input` shape.
29
36
  * @see {@link SearchSessionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -43,11 +50,20 @@ export interface SearchSessionsCommandOutput extends SearchSessionsResponse, __M
43
50
  export declare class SearchSessionsCommand extends $Command<SearchSessionsCommandInput, SearchSessionsCommandOutput, WisdomClientResolvedConfig> {
44
51
  readonly input: SearchSessionsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: SearchSessionsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchSessionsCommandInput, SearchSessionsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartContentUploadRequest, StartContentUploadResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartContentUploadCommand}.
8
10
  */
9
11
  export interface StartContentUploadCommandInput extends StartContentUploadRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartContentUploadCommand}.
13
17
  */
14
18
  export interface StartContentUploadCommandOutput extends StartContentUploadResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get a URL to upload content to a knowledge base. To upload content, first make a PUT
18
23
  * request to the returned URL with your file, making sure to include the required headers. Then
19
24
  * use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html">CreateContent</a> to finalize the content creation process or <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html">UpdateContent</a> to modify an existing resource. You can only upload content to a
@@ -28,6 +33,8 @@ export interface StartContentUploadCommandOutput extends StartContentUploadRespo
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param StartContentUploadCommandInput - {@link StartContentUploadCommandInput}
37
+ * @returns {@link StartContentUploadCommandOutput}
31
38
  * @see {@link StartContentUploadCommandInput} for command's `input` shape.
32
39
  * @see {@link StartContentUploadCommandOutput} for command's `response` shape.
33
40
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -46,11 +53,20 @@ export interface StartContentUploadCommandOutput extends StartContentUploadRespo
46
53
  export declare class StartContentUploadCommand extends $Command<StartContentUploadCommandInput, StartContentUploadCommandOutput, WisdomClientResolvedConfig> {
47
54
  readonly input: StartContentUploadCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: StartContentUploadCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartContentUploadCommandInput, StartContentUploadCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds the specified tags to the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -40,11 +47,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
40
47
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, WisdomClientResolvedConfig> {
41
48
  readonly input: TagResourceCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: TagResourceCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified tags from the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -37,11 +44,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
37
44
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, WisdomClientResolvedConfig> {
38
45
  readonly input: UntagResourceCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: UntagResourceCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateContentRequest, UpdateContentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateContentCommand}.
8
10
  */
9
11
  export interface UpdateContentCommandInput extends UpdateContentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateContentCommand}.
13
17
  */
14
18
  export interface UpdateContentCommandOutput extends UpdateContentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates information about the content.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateContentCommandOutput extends UpdateContentResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateContentCommandInput - {@link UpdateContentCommandInput}
34
+ * @returns {@link UpdateContentCommandOutput}
28
35
  * @see {@link UpdateContentCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateContentCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -47,11 +54,20 @@ export interface UpdateContentCommandOutput extends UpdateContentResponse, __Met
47
54
  export declare class UpdateContentCommand extends $Command<UpdateContentCommandInput, UpdateContentCommandOutput, WisdomClientResolvedConfig> {
48
55
  readonly input: UpdateContentCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: UpdateContentCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateContentCommandInput, UpdateContentCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,21 +4,26 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateKnowledgeBaseTemplateUriRequest, UpdateKnowledgeBaseTemplateUriResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateKnowledgeBaseTemplateUriCommand}.
8
10
  */
9
11
  export interface UpdateKnowledgeBaseTemplateUriCommandInput extends UpdateKnowledgeBaseTemplateUriRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateKnowledgeBaseTemplateUriCommand}.
13
17
  */
14
18
  export interface UpdateKnowledgeBaseTemplateUriCommandOutput extends UpdateKnowledgeBaseTemplateUriResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the template URI of a knowledge base. This is only supported for knowledge bases
18
- * of type EXTERNAL. Include a single variable in <code>${variable}</code> format; this
23
+ * of type EXTERNAL. Include a single variable in <code>$\{variable\}</code> format; this
19
24
  * interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce
20
25
  * article, it has an <code>Id</code> value, and you can set the template URI to
21
- * <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*\/view</code>.
26
+ * <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view</code>.
22
27
  * </p>
23
28
  * @example
24
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -30,6 +35,8 @@ export interface UpdateKnowledgeBaseTemplateUriCommandOutput extends UpdateKnowl
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateKnowledgeBaseTemplateUriCommandInput - {@link UpdateKnowledgeBaseTemplateUriCommandInput}
39
+ * @returns {@link UpdateKnowledgeBaseTemplateUriCommandOutput}
33
40
  * @see {@link UpdateKnowledgeBaseTemplateUriCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateKnowledgeBaseTemplateUriCommandOutput} for command's `response` shape.
35
42
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -48,11 +55,20 @@ export interface UpdateKnowledgeBaseTemplateUriCommandOutput extends UpdateKnowl
48
55
  export declare class UpdateKnowledgeBaseTemplateUriCommand extends $Command<UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput, WisdomClientResolvedConfig> {
49
56
  readonly input: UpdateKnowledgeBaseTemplateUriCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: UpdateKnowledgeBaseTemplateUriCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Wisdom service.
4
6
  */
5
7
  export declare class WisdomServiceException extends __ServiceException {