@aws-sdk/client-qconnect 3.835.0 → 3.840.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 (92) hide show
  1. package/README.md +1 -34
  2. package/dist-cjs/index.js +50 -14
  3. package/dist-es/models/models_0.js +12 -13
  4. package/dist-es/models/models_1.js +14 -1
  5. package/dist-es/protocols/Aws_restJson1.js +17 -1
  6. package/dist-types/QConnect.d.ts +1 -34
  7. package/dist-types/QConnectClient.d.ts +1 -34
  8. package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +2 -8
  9. package/dist-types/commands/CreateAIAgentCommand.d.ts +5 -6
  10. package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +5 -6
  11. package/dist-types/commands/CreateAIGuardrailCommand.d.ts +5 -6
  12. package/dist-types/commands/CreateAIGuardrailVersionCommand.d.ts +5 -6
  13. package/dist-types/commands/CreateAIPromptCommand.d.ts +5 -6
  14. package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +5 -6
  15. package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +3 -9
  16. package/dist-types/commands/CreateAssistantCommand.d.ts +5 -6
  17. package/dist-types/commands/CreateContentAssociationCommand.d.ts +6 -25
  18. package/dist-types/commands/CreateContentCommand.d.ts +5 -6
  19. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +6 -30
  20. package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +6 -11
  21. package/dist-types/commands/CreateMessageTemplateCommand.d.ts +3 -10
  22. package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +3 -16
  23. package/dist-types/commands/CreateQuickResponseCommand.d.ts +5 -6
  24. package/dist-types/commands/CreateSessionCommand.d.ts +5 -7
  25. package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +2 -7
  26. package/dist-types/commands/DeleteAIAgentCommand.d.ts +3 -0
  27. package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +4 -4
  28. package/dist-types/commands/DeleteAIGuardrailCommand.d.ts +4 -4
  29. package/dist-types/commands/DeleteAIGuardrailVersionCommand.d.ts +4 -4
  30. package/dist-types/commands/DeleteAIPromptCommand.d.ts +3 -0
  31. package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +4 -4
  32. package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +3 -0
  33. package/dist-types/commands/DeleteAssistantCommand.d.ts +3 -0
  34. package/dist-types/commands/DeleteContentAssociationCommand.d.ts +4 -4
  35. package/dist-types/commands/DeleteContentCommand.d.ts +4 -4
  36. package/dist-types/commands/DeleteImportJobCommand.d.ts +4 -4
  37. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +5 -13
  38. package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +2 -7
  39. package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +2 -9
  40. package/dist-types/commands/DeleteQuickResponseCommand.d.ts +3 -0
  41. package/dist-types/commands/GetAIAgentCommand.d.ts +3 -0
  42. package/dist-types/commands/GetAIGuardrailCommand.d.ts +3 -0
  43. package/dist-types/commands/GetAIPromptCommand.d.ts +3 -0
  44. package/dist-types/commands/GetAssistantAssociationCommand.d.ts +3 -0
  45. package/dist-types/commands/GetAssistantCommand.d.ts +3 -0
  46. package/dist-types/commands/GetContentAssociationCommand.d.ts +4 -4
  47. package/dist-types/commands/GetContentCommand.d.ts +3 -0
  48. package/dist-types/commands/GetContentSummaryCommand.d.ts +3 -0
  49. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +3 -0
  50. package/dist-types/commands/GetMessageTemplateCommand.d.ts +4 -6
  51. package/dist-types/commands/GetQuickResponseCommand.d.ts +3 -0
  52. package/dist-types/commands/GetRecommendationsCommand.d.ts +1 -10
  53. package/dist-types/commands/GetSessionCommand.d.ts +3 -0
  54. package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +3 -0
  55. package/dist-types/commands/ListAIAgentsCommand.d.ts +3 -0
  56. package/dist-types/commands/ListAIGuardrailVersionsCommand.d.ts +3 -0
  57. package/dist-types/commands/ListAIGuardrailsCommand.d.ts +3 -0
  58. package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +3 -0
  59. package/dist-types/commands/ListAIPromptsCommand.d.ts +3 -0
  60. package/dist-types/commands/ListAssistantsCommand.d.ts +3 -0
  61. package/dist-types/commands/ListContentAssociationsCommand.d.ts +4 -4
  62. package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -2
  63. package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -2
  64. package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +1 -3
  65. package/dist-types/commands/PutFeedbackCommand.d.ts +1 -2
  66. package/dist-types/commands/QueryAssistantCommand.d.ts +2 -11
  67. package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -2
  68. package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -5
  69. package/dist-types/commands/SearchContentCommand.d.ts +4 -2
  70. package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +3 -0
  71. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +4 -3
  72. package/dist-types/commands/SearchSessionsCommand.d.ts +3 -0
  73. package/dist-types/commands/SendMessageCommand.d.ts +2 -7
  74. package/dist-types/commands/StartContentUploadCommand.d.ts +4 -6
  75. package/dist-types/commands/StartImportJobCommand.d.ts +6 -16
  76. package/dist-types/commands/UpdateAIAgentCommand.d.ts +4 -4
  77. package/dist-types/commands/UpdateAIGuardrailCommand.d.ts +4 -4
  78. package/dist-types/commands/UpdateAIPromptCommand.d.ts +4 -4
  79. package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +1 -2
  80. package/dist-types/commands/UpdateContentCommand.d.ts +4 -2
  81. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -6
  82. package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +2 -9
  83. package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +2 -9
  84. package/dist-types/commands/UpdateQuickResponseCommand.d.ts +5 -6
  85. package/dist-types/commands/UpdateSessionCommand.d.ts +4 -3
  86. package/dist-types/commands/UpdateSessionDataCommand.d.ts +3 -0
  87. package/dist-types/index.d.ts +1 -34
  88. package/dist-types/models/models_0.d.ts +229 -1216
  89. package/dist-types/models/models_1.d.ts +185 -393
  90. package/dist-types/ts3.4/models/models_0.d.ts +7 -25
  91. package/dist-types/ts3.4/models/models_1.d.ts +26 -1
  92. package/package.json +18 -18
@@ -87,10 +87,7 @@ declare const UpdateAIPromptCommand_base: {
87
87
  * <p>You do not have sufficient access to perform this action.</p>
88
88
  *
89
89
  * @throws {@link ConflictException} (client fault)
90
- * <p>The request could not be processed because of conflict in the current state of the
91
- * resource. For example, if you're using a <code>Create</code> API (such as
92
- * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
93
- * same name) is being created or mutated.</p>
90
+ * <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
94
91
  *
95
92
  * @throws {@link ResourceNotFoundException} (client fault)
96
93
  * <p>The specified resource does not exist.</p>
@@ -98,6 +95,9 @@ declare const UpdateAIPromptCommand_base: {
98
95
  * @throws {@link ThrottlingException} (client fault)
99
96
  * <p>The throttling limit has been exceeded.</p>
100
97
  *
98
+ * @throws {@link UnauthorizedException} (client fault)
99
+ * <p>You do not have permission to perform this action.</p>
100
+ *
101
101
  * @throws {@link ValidationException} (client fault)
102
102
  * <p>The input fails to satisfy the constraints specified by a service.</p>
103
103
  *
@@ -27,8 +27,7 @@ declare const UpdateAssistantAIAgentCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the AI Agent that is set for use by default on an Amazon Q in Connect
31
- * Assistant.</p>
30
+ * <p>Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -83,12 +83,14 @@ declare const UpdateContentCommand_base: {
83
83
  * <p>You do not have sufficient access to perform this action.</p>
84
84
  *
85
85
  * @throws {@link PreconditionFailedException} (client fault)
86
- * <p>The provided <code>revisionId</code> does not match, indicating the content has been
87
- * modified since it was last read.</p>
86
+ * <p>The provided <code>revisionId</code> does not match, indicating the content has been modified since it was last read.</p>
88
87
  *
89
88
  * @throws {@link ResourceNotFoundException} (client fault)
90
89
  * <p>The specified resource does not exist.</p>
91
90
  *
91
+ * @throws {@link UnauthorizedException} (client fault)
92
+ * <p>You do not have permission to perform this action.</p>
93
+ *
92
94
  * @throws {@link ValidationException} (client fault)
93
95
  * <p>The input fails to satisfy the constraints specified by a service.</p>
94
96
  *
@@ -27,12 +27,7 @@ declare const UpdateKnowledgeBaseTemplateUriCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the template URI of a knowledge base. This is only supported for knowledge bases
31
- * of type EXTERNAL. Include a single variable in <code>$\{variable\}</code> format; this
32
- * interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce
33
- * article, it has an <code>Id</code> value, and you can set the template URI to
34
- * <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view</code>.
35
- * </p>
30
+ * <p>Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in <code>$\{variable\}</code> format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an <code>Id</code> value, and you can set the template URI to <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view</code>. </p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,11 +27,7 @@ declare const UpdateMessageTemplateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the Amazon Q in Connect message template. Partial update is supported. If any
31
- * field is not supplied, it will remain unchanged for the message template that is referenced by
32
- * the <code>$LATEST</code> qualifier. Any modification will only apply to the message template
33
- * that is referenced by the <code>$LATEST</code> qualifier. The fields for all available
34
- * versions will remain unchanged.</p>
30
+ * <p>Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the <code>$LATEST</code> qualifier. Any modification will only apply to the message template that is referenced by the <code>$LATEST</code> qualifier. The fields for all available versions will remain unchanged.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -298,10 +294,7 @@ declare const UpdateMessageTemplateCommand_base: {
298
294
  * <p>You do not have sufficient access to perform this action.</p>
299
295
  *
300
296
  * @throws {@link ConflictException} (client fault)
301
- * <p>The request could not be processed because of conflict in the current state of the
302
- * resource. For example, if you're using a <code>Create</code> API (such as
303
- * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
304
- * same name) is being created or mutated.</p>
297
+ * <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
305
298
  *
306
299
  * @throws {@link ResourceNotFoundException} (client fault)
307
300
  * <p>The specified resource does not exist.</p>
@@ -27,11 +27,7 @@ declare const UpdateMessageTemplateMetadataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the Amazon Q in Connect message template metadata. Note that any modification to
31
- * the message template’s name, description and grouping configuration will applied to the
32
- * message template pointed by the <code>$LATEST</code> qualifier and all available versions.
33
- * Partial update is supported. If any field is not supplied, it will remain unchanged for the
34
- * message template.</p>
30
+ * <p>Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the <code>$LATEST</code> qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -199,10 +195,7 @@ declare const UpdateMessageTemplateMetadataCommand_base: {
199
195
  * <p>You do not have sufficient access to perform this action.</p>
200
196
  *
201
197
  * @throws {@link ConflictException} (client fault)
202
- * <p>The request could not be processed because of conflict in the current state of the
203
- * resource. For example, if you're using a <code>Create</code> API (such as
204
- * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
205
- * same name) is being created or mutated.</p>
198
+ * <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
206
199
  *
207
200
  * @throws {@link ResourceNotFoundException} (client fault)
208
201
  * <p>The specified resource does not exist.</p>
@@ -112,18 +112,17 @@ declare const UpdateQuickResponseCommand_base: {
112
112
  * <p>You do not have sufficient access to perform this action.</p>
113
113
  *
114
114
  * @throws {@link ConflictException} (client fault)
115
- * <p>The request could not be processed because of conflict in the current state of the
116
- * resource. For example, if you're using a <code>Create</code> API (such as
117
- * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
118
- * same name) is being created or mutated.</p>
115
+ * <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
119
116
  *
120
117
  * @throws {@link PreconditionFailedException} (client fault)
121
- * <p>The provided <code>revisionId</code> does not match, indicating the content has been
122
- * modified since it was last read.</p>
118
+ * <p>The provided <code>revisionId</code> does not match, indicating the content has been modified since it was last read.</p>
123
119
  *
124
120
  * @throws {@link ResourceNotFoundException} (client fault)
125
121
  * <p>The specified resource does not exist.</p>
126
122
  *
123
+ * @throws {@link UnauthorizedException} (client fault)
124
+ * <p>You do not have permission to perform this action.</p>
125
+ *
127
126
  * @throws {@link ValidationException} (client fault)
128
127
  * <p>The input fails to satisfy the constraints specified by a service.</p>
129
128
  *
@@ -27,9 +27,7 @@ declare const UpdateSessionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates a session. A session is a contextual container used for generating
31
- * recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on
32
- * which Amazon Q in Connect is enabled.</p>
30
+ * <p>Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -123,6 +121,9 @@ declare const UpdateSessionCommand_base: {
123
121
  * @throws {@link ResourceNotFoundException} (client fault)
124
122
  * <p>The specified resource does not exist.</p>
125
123
  *
124
+ * @throws {@link UnauthorizedException} (client fault)
125
+ * <p>You do not have permission to perform this action.</p>
126
+ *
126
127
  * @throws {@link ValidationException} (client fault)
127
128
  * <p>The input fails to satisfy the constraints specified by a service.</p>
128
129
  *
@@ -77,6 +77,9 @@ declare const UpdateSessionDataCommand_base: {
77
77
  * @throws {@link ResourceNotFoundException} (client fault)
78
78
  * <p>The specified resource does not exist.</p>
79
79
  *
80
+ * @throws {@link UnauthorizedException} (client fault)
81
+ * <p>You do not have permission to perform this action.</p>
82
+ *
80
83
  * @throws {@link ValidationException} (client fault)
81
84
  * <p>The input fails to satisfy the constraints specified by a service.</p>
82
85
  *
@@ -1,38 +1,5 @@
1
1
  /**
2
- * <ul>
3
- * <li>
4
- * <p>
5
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Q_Connect.html">Amazon Q
6
- * actions</a>
7
- * </p>
8
- * </li>
9
- * <li>
10
- * <p>
11
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Q_Connect.html">Amazon Q data
12
- * types</a>
13
- * </p>
14
- * </li>
15
- * </ul>
16
- * <note>
17
- * <p>
18
- * <b>Powered by Amazon Bedrock</b>: Amazon Web Services implements <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html">automated abuse
19
- * detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
20
- * the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
21
- * artificial intelligence (AI).</p>
22
- * </note>
23
- * <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
24
- * evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
25
- * center agents resolve customer issues quickly and accurately.</p>
26
- * <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
27
- * analytics and natural language understanding (NLU). It then provides agents with immediate,
28
- * real-time generative responses and suggested actions, and links to relevant documents and
29
- * articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
30
- * customer requests.</p>
31
- * <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
32
- * manage content by uploading custom files.</p>
33
- * <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html">Use Amazon Q in Connect for generative AI
34
- * powered agent assistance in real-time</a> in the <i>Amazon Connect
35
- * Administrator Guide</i>.</p>
2
+ * <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Q_Connect.html">Amazon Q actions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Q_Connect.html">Amazon Q data types</a> </p> </li> </ul> <note> <p> <b>Powered by Amazon Bedrock</b>: Amazon Web Services implements <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html">automated abuse detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).</p> </note> <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.</p> <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.</p> <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html">Use Amazon Q in Connect for generative AI powered agent assistance in real-time</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
36
3
  *
37
4
  * @packageDocumentation
38
5
  */