@aws-sdk/client-qconnect 3.665.0 → 3.666.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 (107) hide show
  1. package/README.md +166 -0
  2. package/dist-cjs/index.js +1501 -102
  3. package/dist-es/QConnect.js +38 -0
  4. package/dist-es/commands/CreateAIAgentCommand.js +22 -0
  5. package/dist-es/commands/CreateAIAgentVersionCommand.js +22 -0
  6. package/dist-es/commands/CreateAIPromptCommand.js +23 -0
  7. package/dist-es/commands/CreateAIPromptVersionCommand.js +23 -0
  8. package/dist-es/commands/CreateKnowledgeBaseCommand.js +2 -1
  9. package/dist-es/commands/DeleteAIAgentCommand.js +22 -0
  10. package/dist-es/commands/DeleteAIAgentVersionCommand.js +22 -0
  11. package/dist-es/commands/DeleteAIPromptCommand.js +22 -0
  12. package/dist-es/commands/DeleteAIPromptVersionCommand.js +22 -0
  13. package/dist-es/commands/GetAIAgentCommand.js +22 -0
  14. package/dist-es/commands/GetAIPromptCommand.js +23 -0
  15. package/dist-es/commands/GetKnowledgeBaseCommand.js +2 -1
  16. package/dist-es/commands/ListAIAgentVersionsCommand.js +22 -0
  17. package/dist-es/commands/ListAIAgentsCommand.js +22 -0
  18. package/dist-es/commands/ListAIPromptVersionsCommand.js +22 -0
  19. package/dist-es/commands/ListAIPromptsCommand.js +22 -0
  20. package/dist-es/commands/ListKnowledgeBasesCommand.js +2 -1
  21. package/dist-es/commands/RemoveAssistantAIAgentCommand.js +22 -0
  22. package/dist-es/commands/UpdateAIAgentCommand.js +22 -0
  23. package/dist-es/commands/UpdateAIPromptCommand.js +23 -0
  24. package/dist-es/commands/UpdateAssistantAIAgentCommand.js +22 -0
  25. package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +2 -1
  26. package/dist-es/commands/UpdateSessionDataCommand.js +23 -0
  27. package/dist-es/commands/index.js +19 -0
  28. package/dist-es/models/models_0.js +310 -46
  29. package/dist-es/pagination/ListAIAgentVersionsPaginator.js +4 -0
  30. package/dist-es/pagination/ListAIAgentsPaginator.js +4 -0
  31. package/dist-es/pagination/ListAIPromptVersionsPaginator.js +4 -0
  32. package/dist-es/pagination/ListAIPromptsPaginator.js +4 -0
  33. package/dist-es/pagination/index.js +4 -0
  34. package/dist-es/protocols/Aws_restJson1.js +692 -8
  35. package/dist-types/QConnect.d.ts +148 -1
  36. package/dist-types/QConnectClient.d.ts +36 -3
  37. package/dist-types/commands/CreateAIAgentCommand.d.ts +252 -0
  38. package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +180 -0
  39. package/dist-types/commands/CreateAIPromptCommand.d.ts +132 -0
  40. package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +120 -0
  41. package/dist-types/commands/CreateAssistantCommand.d.ts +5 -0
  42. package/dist-types/commands/CreateContentAssociationCommand.d.ts +5 -6
  43. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +108 -0
  44. package/dist-types/commands/CreateSessionCommand.d.ts +10 -0
  45. package/dist-types/commands/DeleteAIAgentCommand.d.ts +82 -0
  46. package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +89 -0
  47. package/dist-types/commands/DeleteAIPromptCommand.d.ts +82 -0
  48. package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +89 -0
  49. package/dist-types/commands/GetAIAgentCommand.d.ts +168 -0
  50. package/dist-types/commands/GetAIPromptCommand.d.ts +108 -0
  51. package/dist-types/commands/GetAssistantCommand.d.ts +5 -0
  52. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +56 -0
  53. package/dist-types/commands/GetRecommendationsCommand.d.ts +20 -0
  54. package/dist-types/commands/GetSessionCommand.d.ts +5 -0
  55. package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +176 -0
  56. package/dist-types/commands/ListAIAgentsCommand.d.ts +172 -0
  57. package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +111 -0
  58. package/dist-types/commands/ListAIPromptsCommand.d.ts +107 -0
  59. package/dist-types/commands/ListAssistantsCommand.d.ts +5 -0
  60. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +52 -0
  61. package/dist-types/commands/QueryAssistantCommand.d.ts +30 -1
  62. package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +83 -0
  63. package/dist-types/commands/UpdateAIAgentCommand.d.ts +244 -0
  64. package/dist-types/commands/UpdateAIPromptCommand.d.ts +121 -0
  65. package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +112 -0
  66. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +56 -0
  67. package/dist-types/commands/UpdateSessionCommand.d.ts +10 -0
  68. package/dist-types/commands/UpdateSessionDataCommand.d.ts +100 -0
  69. package/dist-types/commands/index.d.ts +19 -0
  70. package/dist-types/index.d.ts +15 -1
  71. package/dist-types/models/models_0.d.ts +2454 -275
  72. package/dist-types/pagination/ListAIAgentVersionsPaginator.d.ts +7 -0
  73. package/dist-types/pagination/ListAIAgentsPaginator.d.ts +7 -0
  74. package/dist-types/pagination/ListAIPromptVersionsPaginator.d.ts +7 -0
  75. package/dist-types/pagination/ListAIPromptsPaginator.d.ts +7 -0
  76. package/dist-types/pagination/index.d.ts +4 -0
  77. package/dist-types/protocols/Aws_restJson1.d.ts +171 -0
  78. package/dist-types/ts3.4/QConnect.d.ts +323 -0
  79. package/dist-types/ts3.4/QConnectClient.d.ts +116 -2
  80. package/dist-types/ts3.4/commands/CreateAIAgentCommand.d.ts +50 -0
  81. package/dist-types/ts3.4/commands/CreateAIAgentVersionCommand.d.ts +51 -0
  82. package/dist-types/ts3.4/commands/CreateAIPromptCommand.d.ts +50 -0
  83. package/dist-types/ts3.4/commands/CreateAIPromptVersionCommand.d.ts +51 -0
  84. package/dist-types/ts3.4/commands/DeleteAIAgentCommand.d.ts +50 -0
  85. package/dist-types/ts3.4/commands/DeleteAIAgentVersionCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/DeleteAIPromptCommand.d.ts +50 -0
  87. package/dist-types/ts3.4/commands/DeleteAIPromptVersionCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/GetAIAgentCommand.d.ts +47 -0
  89. package/dist-types/ts3.4/commands/GetAIPromptCommand.d.ts +47 -0
  90. package/dist-types/ts3.4/commands/ListAIAgentVersionsCommand.d.ts +51 -0
  91. package/dist-types/ts3.4/commands/ListAIAgentsCommand.d.ts +47 -0
  92. package/dist-types/ts3.4/commands/ListAIPromptVersionsCommand.d.ts +51 -0
  93. package/dist-types/ts3.4/commands/ListAIPromptsCommand.d.ts +50 -0
  94. package/dist-types/ts3.4/commands/RemoveAssistantAIAgentCommand.d.ts +51 -0
  95. package/dist-types/ts3.4/commands/UpdateAIAgentCommand.d.ts +50 -0
  96. package/dist-types/ts3.4/commands/UpdateAIPromptCommand.d.ts +50 -0
  97. package/dist-types/ts3.4/commands/UpdateAssistantAIAgentCommand.d.ts +51 -0
  98. package/dist-types/ts3.4/commands/UpdateSessionDataCommand.d.ts +51 -0
  99. package/dist-types/ts3.4/commands/index.d.ts +19 -0
  100. package/dist-types/ts3.4/models/models_0.d.ts +794 -103
  101. package/dist-types/ts3.4/pagination/ListAIAgentVersionsPaginator.d.ts +11 -0
  102. package/dist-types/ts3.4/pagination/ListAIAgentsPaginator.d.ts +11 -0
  103. package/dist-types/ts3.4/pagination/ListAIPromptVersionsPaginator.d.ts +11 -0
  104. package/dist-types/ts3.4/pagination/ListAIPromptsPaginator.d.ts +11 -0
  105. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  106. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +228 -0
  107. package/package.json +12 -12
@@ -0,0 +1,82 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeleteAIAgentRequest, DeleteAIAgentResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteAIAgentCommand}.
14
+ */
15
+ export interface DeleteAIAgentCommandInput extends DeleteAIAgentRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteAIAgentCommand}.
21
+ */
22
+ export interface DeleteAIAgentCommandOutput extends DeleteAIAgentResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteAIAgentCommand_base: {
25
+ new (input: DeleteAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIAgentCommandInput, DeleteAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIAgentCommandInput, DeleteAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes an Amazon Q in Connect AI Agent.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, DeleteAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, DeleteAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // DeleteAIAgentRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiAgentId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteAIAgentCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteAIAgentCommandInput - {@link DeleteAIAgentCommandInput}
48
+ * @returns {@link DeleteAIAgentCommandOutput}
49
+ * @see {@link DeleteAIAgentCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteAIAgentCommandOutput} for command's `response` shape.
51
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p>You do not have sufficient access to perform this action.</p>
55
+ *
56
+ * @throws {@link ResourceNotFoundException} (client fault)
57
+ * <p>The specified resource does not exist.</p>
58
+ *
59
+ * @throws {@link ThrottlingException} (client fault)
60
+ * <p>The throttling limit has been exceeded.</p>
61
+ *
62
+ * @throws {@link ValidationException} (client fault)
63
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
64
+ *
65
+ * @throws {@link QConnectServiceException}
66
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
67
+ *
68
+ * @public
69
+ */
70
+ export declare class DeleteAIAgentCommand extends DeleteAIAgentCommand_base {
71
+ /** @internal type navigation helper, not in runtime. */
72
+ protected static __types: {
73
+ api: {
74
+ input: DeleteAIAgentRequest;
75
+ output: {};
76
+ };
77
+ sdk: {
78
+ input: DeleteAIAgentCommandInput;
79
+ output: DeleteAIAgentCommandOutput;
80
+ };
81
+ };
82
+ }
@@ -0,0 +1,89 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeleteAIAgentVersionRequest, DeleteAIAgentVersionResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteAIAgentVersionCommand}.
14
+ */
15
+ export interface DeleteAIAgentVersionCommandInput extends DeleteAIAgentVersionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteAIAgentVersionCommand}.
21
+ */
22
+ export interface DeleteAIAgentVersionCommandOutput extends DeleteAIAgentVersionResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteAIAgentVersionCommand_base: {
25
+ new (input: DeleteAIAgentVersionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIAgentVersionCommandInput, DeleteAIAgentVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteAIAgentVersionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIAgentVersionCommandInput, DeleteAIAgentVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes an Amazon Q in Connect AI Agent Version.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, DeleteAIAgentVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, DeleteAIAgentVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // DeleteAIAgentVersionRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiAgentId: "STRING_VALUE", // required
40
+ * versionNumber: Number("long"), // required
41
+ * };
42
+ * const command = new DeleteAIAgentVersionCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeleteAIAgentVersionCommandInput - {@link DeleteAIAgentVersionCommandInput}
49
+ * @returns {@link DeleteAIAgentVersionCommandOutput}
50
+ * @see {@link DeleteAIAgentVersionCommandInput} for command's `input` shape.
51
+ * @see {@link DeleteAIAgentVersionCommandOutput} for command's `response` shape.
52
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p>You do not have sufficient access to perform this action.</p>
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>The request could not be processed because of conflict in the current state of the
59
+ * resource. For example, if you're using a <code>Create</code> API (such as
60
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
61
+ * same name) is being created or mutated.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The specified resource does not exist.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (client fault)
67
+ * <p>The throttling limit has been exceeded.</p>
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
71
+ *
72
+ * @throws {@link QConnectServiceException}
73
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
74
+ *
75
+ * @public
76
+ */
77
+ export declare class DeleteAIAgentVersionCommand extends DeleteAIAgentVersionCommand_base {
78
+ /** @internal type navigation helper, not in runtime. */
79
+ protected static __types: {
80
+ api: {
81
+ input: DeleteAIAgentVersionRequest;
82
+ output: {};
83
+ };
84
+ sdk: {
85
+ input: DeleteAIAgentVersionCommandInput;
86
+ output: DeleteAIAgentVersionCommandOutput;
87
+ };
88
+ };
89
+ }
@@ -0,0 +1,82 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeleteAIPromptRequest, DeleteAIPromptResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteAIPromptCommand}.
14
+ */
15
+ export interface DeleteAIPromptCommandInput extends DeleteAIPromptRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteAIPromptCommand}.
21
+ */
22
+ export interface DeleteAIPromptCommandOutput extends DeleteAIPromptResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteAIPromptCommand_base: {
25
+ new (input: DeleteAIPromptCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIPromptCommandInput, DeleteAIPromptCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteAIPromptCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIPromptCommandInput, DeleteAIPromptCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes an Amazon Q in Connect AI Prompt.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, DeleteAIPromptCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, DeleteAIPromptCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // DeleteAIPromptRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiPromptId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteAIPromptCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteAIPromptCommandInput - {@link DeleteAIPromptCommandInput}
48
+ * @returns {@link DeleteAIPromptCommandOutput}
49
+ * @see {@link DeleteAIPromptCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteAIPromptCommandOutput} for command's `response` shape.
51
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p>You do not have sufficient access to perform this action.</p>
55
+ *
56
+ * @throws {@link ResourceNotFoundException} (client fault)
57
+ * <p>The specified resource does not exist.</p>
58
+ *
59
+ * @throws {@link ThrottlingException} (client fault)
60
+ * <p>The throttling limit has been exceeded.</p>
61
+ *
62
+ * @throws {@link ValidationException} (client fault)
63
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
64
+ *
65
+ * @throws {@link QConnectServiceException}
66
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
67
+ *
68
+ * @public
69
+ */
70
+ export declare class DeleteAIPromptCommand extends DeleteAIPromptCommand_base {
71
+ /** @internal type navigation helper, not in runtime. */
72
+ protected static __types: {
73
+ api: {
74
+ input: DeleteAIPromptRequest;
75
+ output: {};
76
+ };
77
+ sdk: {
78
+ input: DeleteAIPromptCommandInput;
79
+ output: DeleteAIPromptCommandOutput;
80
+ };
81
+ };
82
+ }
@@ -0,0 +1,89 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeleteAIPromptVersionRequest, DeleteAIPromptVersionResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteAIPromptVersionCommand}.
14
+ */
15
+ export interface DeleteAIPromptVersionCommandInput extends DeleteAIPromptVersionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteAIPromptVersionCommand}.
21
+ */
22
+ export interface DeleteAIPromptVersionCommandOutput extends DeleteAIPromptVersionResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteAIPromptVersionCommand_base: {
25
+ new (input: DeleteAIPromptVersionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIPromptVersionCommandInput, DeleteAIPromptVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteAIPromptVersionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAIPromptVersionCommandInput, DeleteAIPromptVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Delete and Amazon Q in Connect AI Prompt version.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, DeleteAIPromptVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, DeleteAIPromptVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // DeleteAIPromptVersionRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiPromptId: "STRING_VALUE", // required
40
+ * versionNumber: Number("long"), // required
41
+ * };
42
+ * const command = new DeleteAIPromptVersionCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeleteAIPromptVersionCommandInput - {@link DeleteAIPromptVersionCommandInput}
49
+ * @returns {@link DeleteAIPromptVersionCommandOutput}
50
+ * @see {@link DeleteAIPromptVersionCommandInput} for command's `input` shape.
51
+ * @see {@link DeleteAIPromptVersionCommandOutput} for command's `response` shape.
52
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p>You do not have sufficient access to perform this action.</p>
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>The request could not be processed because of conflict in the current state of the
59
+ * resource. For example, if you're using a <code>Create</code> API (such as
60
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
61
+ * same name) is being created or mutated.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The specified resource does not exist.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (client fault)
67
+ * <p>The throttling limit has been exceeded.</p>
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
71
+ *
72
+ * @throws {@link QConnectServiceException}
73
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
74
+ *
75
+ * @public
76
+ */
77
+ export declare class DeleteAIPromptVersionCommand extends DeleteAIPromptVersionCommand_base {
78
+ /** @internal type navigation helper, not in runtime. */
79
+ protected static __types: {
80
+ api: {
81
+ input: DeleteAIPromptVersionRequest;
82
+ output: {};
83
+ };
84
+ sdk: {
85
+ input: DeleteAIPromptVersionCommandInput;
86
+ output: DeleteAIPromptVersionCommandOutput;
87
+ };
88
+ };
89
+ }
@@ -0,0 +1,168 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetAIAgentRequest, GetAIAgentResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetAIAgentCommand}.
14
+ */
15
+ export interface GetAIAgentCommandInput extends GetAIAgentRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAIAgentCommand}.
21
+ */
22
+ export interface GetAIAgentCommandOutput extends GetAIAgentResponse, __MetadataBearer {
23
+ }
24
+ declare const GetAIAgentCommand_base: {
25
+ new (input: GetAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<GetAIAgentCommandInput, GetAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<GetAIAgentCommandInput, GetAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Gets an Amazon Q in Connect AI Agent.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, GetAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, GetAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // GetAIAgentRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiAgentId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetAIAgentCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetAIAgentResponse
44
+ * // aiAgent: { // AIAgentData
45
+ * // assistantId: "STRING_VALUE", // required
46
+ * // assistantArn: "STRING_VALUE", // required
47
+ * // aiAgentId: "STRING_VALUE", // required
48
+ * // aiAgentArn: "STRING_VALUE", // required
49
+ * // name: "STRING_VALUE", // required
50
+ * // type: "STRING_VALUE", // required
51
+ * // configuration: { // AIAgentConfiguration Union: only one key present
52
+ * // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
53
+ * // answerGenerationAIPromptId: "STRING_VALUE",
54
+ * // associationConfigurations: [ // AssociationConfigurationList
55
+ * // { // AssociationConfiguration
56
+ * // associationId: "STRING_VALUE",
57
+ * // associationType: "STRING_VALUE",
58
+ * // associationConfigurationData: { // AssociationConfigurationData Union: only one key present
59
+ * // knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
60
+ * // contentTagFilter: { // TagFilter Union: only one key present
61
+ * // tagCondition: { // TagCondition
62
+ * // key: "STRING_VALUE", // required
63
+ * // value: "STRING_VALUE",
64
+ * // },
65
+ * // andConditions: [ // AndConditions
66
+ * // {
67
+ * // key: "STRING_VALUE", // required
68
+ * // value: "STRING_VALUE",
69
+ * // },
70
+ * // ],
71
+ * // orConditions: [ // OrConditions
72
+ * // { // OrCondition Union: only one key present
73
+ * // andConditions: [
74
+ * // "<TagCondition>",
75
+ * // ],
76
+ * // tagCondition: "<TagCondition>",
77
+ * // },
78
+ * // ],
79
+ * // },
80
+ * // maxResults: Number("int"),
81
+ * // overrideKnowledgeBaseSearchType: "STRING_VALUE",
82
+ * // },
83
+ * // },
84
+ * // },
85
+ * // ],
86
+ * // },
87
+ * // answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
88
+ * // intentLabelingGenerationAIPromptId: "STRING_VALUE",
89
+ * // queryReformulationAIPromptId: "STRING_VALUE",
90
+ * // answerGenerationAIPromptId: "STRING_VALUE",
91
+ * // associationConfigurations: [
92
+ * // {
93
+ * // associationId: "STRING_VALUE",
94
+ * // associationType: "STRING_VALUE",
95
+ * // associationConfigurationData: {// Union: only one key present
96
+ * // knowledgeBaseAssociationConfigurationData: {
97
+ * // contentTagFilter: {// Union: only one key present
98
+ * // tagCondition: "<TagCondition>",
99
+ * // andConditions: [
100
+ * // "<TagCondition>",
101
+ * // ],
102
+ * // orConditions: [
103
+ * // {// Union: only one key present
104
+ * // andConditions: [
105
+ * // "<TagCondition>",
106
+ * // ],
107
+ * // tagCondition: "<TagCondition>",
108
+ * // },
109
+ * // ],
110
+ * // },
111
+ * // maxResults: Number("int"),
112
+ * // overrideKnowledgeBaseSearchType: "STRING_VALUE",
113
+ * // },
114
+ * // },
115
+ * // },
116
+ * // ],
117
+ * // },
118
+ * // },
119
+ * // modifiedTime: new Date("TIMESTAMP"),
120
+ * // description: "STRING_VALUE",
121
+ * // visibilityStatus: "STRING_VALUE", // required
122
+ * // tags: { // Tags
123
+ * // "<keys>": "STRING_VALUE",
124
+ * // },
125
+ * // origin: "STRING_VALUE",
126
+ * // status: "STRING_VALUE",
127
+ * // },
128
+ * // versionNumber: Number("long"),
129
+ * // };
130
+ *
131
+ * ```
132
+ *
133
+ * @param GetAIAgentCommandInput - {@link GetAIAgentCommandInput}
134
+ * @returns {@link GetAIAgentCommandOutput}
135
+ * @see {@link GetAIAgentCommandInput} for command's `input` shape.
136
+ * @see {@link GetAIAgentCommandOutput} for command's `response` shape.
137
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
138
+ *
139
+ * @throws {@link AccessDeniedException} (client fault)
140
+ * <p>You do not have sufficient access to perform this action.</p>
141
+ *
142
+ * @throws {@link ResourceNotFoundException} (client fault)
143
+ * <p>The specified resource does not exist.</p>
144
+ *
145
+ * @throws {@link ThrottlingException} (client fault)
146
+ * <p>The throttling limit has been exceeded.</p>
147
+ *
148
+ * @throws {@link ValidationException} (client fault)
149
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
150
+ *
151
+ * @throws {@link QConnectServiceException}
152
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
153
+ *
154
+ * @public
155
+ */
156
+ export declare class GetAIAgentCommand extends GetAIAgentCommand_base {
157
+ /** @internal type navigation helper, not in runtime. */
158
+ protected static __types: {
159
+ api: {
160
+ input: GetAIAgentRequest;
161
+ output: GetAIAgentResponse;
162
+ };
163
+ sdk: {
164
+ input: GetAIAgentCommandInput;
165
+ output: GetAIAgentCommandOutput;
166
+ };
167
+ };
168
+ }
@@ -0,0 +1,108 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetAIPromptRequest, GetAIPromptResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetAIPromptCommand}.
14
+ */
15
+ export interface GetAIPromptCommandInput extends GetAIPromptRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAIPromptCommand}.
21
+ */
22
+ export interface GetAIPromptCommandOutput extends GetAIPromptResponse, __MetadataBearer {
23
+ }
24
+ declare const GetAIPromptCommand_base: {
25
+ new (input: GetAIPromptCommandInput): import("@smithy/smithy-client").CommandImpl<GetAIPromptCommandInput, GetAIPromptCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetAIPromptCommandInput): import("@smithy/smithy-client").CommandImpl<GetAIPromptCommandInput, GetAIPromptCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Gets and Amazon Q in Connect AI Prompt.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, GetAIPromptCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, GetAIPromptCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // GetAIPromptRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiPromptId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetAIPromptCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetAIPromptResponse
44
+ * // aiPrompt: { // AIPromptData
45
+ * // assistantId: "STRING_VALUE", // required
46
+ * // assistantArn: "STRING_VALUE", // required
47
+ * // aiPromptId: "STRING_VALUE", // required
48
+ * // aiPromptArn: "STRING_VALUE", // required
49
+ * // name: "STRING_VALUE", // required
50
+ * // type: "STRING_VALUE", // required
51
+ * // templateType: "STRING_VALUE", // required
52
+ * // modelId: "STRING_VALUE", // required
53
+ * // apiFormat: "STRING_VALUE", // required
54
+ * // templateConfiguration: { // AIPromptTemplateConfiguration Union: only one key present
55
+ * // textFullAIPromptEditTemplateConfiguration: { // TextFullAIPromptEditTemplateConfiguration
56
+ * // text: "STRING_VALUE", // required
57
+ * // },
58
+ * // },
59
+ * // modifiedTime: new Date("TIMESTAMP"),
60
+ * // description: "STRING_VALUE",
61
+ * // visibilityStatus: "STRING_VALUE", // required
62
+ * // tags: { // Tags
63
+ * // "<keys>": "STRING_VALUE",
64
+ * // },
65
+ * // origin: "STRING_VALUE",
66
+ * // status: "STRING_VALUE",
67
+ * // },
68
+ * // versionNumber: Number("long"),
69
+ * // };
70
+ *
71
+ * ```
72
+ *
73
+ * @param GetAIPromptCommandInput - {@link GetAIPromptCommandInput}
74
+ * @returns {@link GetAIPromptCommandOutput}
75
+ * @see {@link GetAIPromptCommandInput} for command's `input` shape.
76
+ * @see {@link GetAIPromptCommandOutput} for command's `response` shape.
77
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
78
+ *
79
+ * @throws {@link AccessDeniedException} (client fault)
80
+ * <p>You do not have sufficient access to perform this action.</p>
81
+ *
82
+ * @throws {@link ResourceNotFoundException} (client fault)
83
+ * <p>The specified resource does not exist.</p>
84
+ *
85
+ * @throws {@link ThrottlingException} (client fault)
86
+ * <p>The throttling limit has been exceeded.</p>
87
+ *
88
+ * @throws {@link ValidationException} (client fault)
89
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
90
+ *
91
+ * @throws {@link QConnectServiceException}
92
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
93
+ *
94
+ * @public
95
+ */
96
+ export declare class GetAIPromptCommand extends GetAIPromptCommand_base {
97
+ /** @internal type navigation helper, not in runtime. */
98
+ protected static __types: {
99
+ api: {
100
+ input: GetAIPromptRequest;
101
+ output: GetAIPromptResponse;
102
+ };
103
+ sdk: {
104
+ input: GetAIPromptCommandInput;
105
+ output: GetAIPromptCommandOutput;
106
+ };
107
+ };
108
+ }
@@ -59,6 +59,11 @@ declare const GetAssistantCommand_base: {
59
59
  * // capabilityConfiguration: { // AssistantCapabilityConfiguration
60
60
  * // type: "STRING_VALUE",
61
61
  * // },
62
+ * // aiAgentConfiguration: { // AIAgentConfigurationMap
63
+ * // "<keys>": { // AIAgentConfigurationData
64
+ * // aiAgentId: "STRING_VALUE", // required
65
+ * // },
66
+ * // },
62
67
  * // },
63
68
  * // };
64
69
  *