@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.
- package/README.md +1 -34
- package/dist-cjs/index.js +50 -14
- package/dist-es/models/models_0.js +12 -13
- package/dist-es/models/models_1.js +14 -1
- package/dist-es/protocols/Aws_restJson1.js +17 -1
- package/dist-types/QConnect.d.ts +1 -34
- package/dist-types/QConnectClient.d.ts +1 -34
- package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +2 -8
- package/dist-types/commands/CreateAIAgentCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIGuardrailCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIGuardrailVersionCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIPromptCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +5 -6
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +3 -9
- package/dist-types/commands/CreateAssistantCommand.d.ts +5 -6
- package/dist-types/commands/CreateContentAssociationCommand.d.ts +6 -25
- package/dist-types/commands/CreateContentCommand.d.ts +5 -6
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +6 -30
- package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +6 -11
- package/dist-types/commands/CreateMessageTemplateCommand.d.ts +3 -10
- package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +3 -16
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +5 -6
- package/dist-types/commands/CreateSessionCommand.d.ts +5 -7
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +2 -7
- package/dist-types/commands/DeleteAIAgentCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAIGuardrailCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAIGuardrailVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAIPromptCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAssistantCommand.d.ts +3 -0
- package/dist-types/commands/DeleteContentAssociationCommand.d.ts +4 -4
- package/dist-types/commands/DeleteContentCommand.d.ts +4 -4
- package/dist-types/commands/DeleteImportJobCommand.d.ts +4 -4
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +5 -13
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +2 -7
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +2 -9
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +3 -0
- package/dist-types/commands/GetAIAgentCommand.d.ts +3 -0
- package/dist-types/commands/GetAIGuardrailCommand.d.ts +3 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +3 -0
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +3 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +3 -0
- package/dist-types/commands/GetContentAssociationCommand.d.ts +4 -4
- package/dist-types/commands/GetContentCommand.d.ts +3 -0
- package/dist-types/commands/GetContentSummaryCommand.d.ts +3 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +3 -0
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +4 -6
- package/dist-types/commands/GetQuickResponseCommand.d.ts +3 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +1 -10
- package/dist-types/commands/GetSessionCommand.d.ts +3 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIGuardrailVersionsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIGuardrailsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIPromptsCommand.d.ts +3 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +3 -0
- package/dist-types/commands/ListContentAssociationsCommand.d.ts +4 -4
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -2
- package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +1 -3
- package/dist-types/commands/PutFeedbackCommand.d.ts +1 -2
- package/dist-types/commands/QueryAssistantCommand.d.ts +2 -11
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -2
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -5
- package/dist-types/commands/SearchContentCommand.d.ts +4 -2
- package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +3 -0
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +4 -3
- package/dist-types/commands/SearchSessionsCommand.d.ts +3 -0
- package/dist-types/commands/SendMessageCommand.d.ts +2 -7
- package/dist-types/commands/StartContentUploadCommand.d.ts +4 -6
- package/dist-types/commands/StartImportJobCommand.d.ts +6 -16
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAIGuardrailCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateContentCommand.d.ts +4 -2
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -6
- package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +2 -9
- package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +2 -9
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +5 -6
- package/dist-types/commands/UpdateSessionCommand.d.ts +4 -3
- package/dist-types/commands/UpdateSessionDataCommand.d.ts +3 -0
- package/dist-types/index.d.ts +1 -34
- package/dist-types/models/models_0.d.ts +229 -1216
- package/dist-types/models/models_1.d.ts +185 -393
- package/dist-types/ts3.4/models/models_0.d.ts +7 -25
- package/dist-types/ts3.4/models/models_1.d.ts +26 -1
- package/package.json +18 -18
|
@@ -27,25 +27,7 @@ declare const CreateContentAssociationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an association between a content resource in a knowledge base and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step guides</a>. Step-by-step guides offer instructions to agents for resolving
|
|
31
|
-
* common customer issues. You create a content association to integrate Amazon Q in Connect and
|
|
32
|
-
* step-by-step guides. </p>
|
|
33
|
-
* <p>After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a
|
|
34
|
-
* recommendation to an agent based on the intent that it's detected, it also provides them with
|
|
35
|
-
* the option to start the step-by-step guide that you have associated with the content.</p>
|
|
36
|
-
* <p>Note the following limitations:</p>
|
|
37
|
-
* <ul>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>You can create only one content association for each content resource in a knowledge
|
|
40
|
-
* base.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>You can associate a step-by-step guide with multiple content resources.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* </ul>
|
|
46
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with
|
|
47
|
-
* step-by-step guides</a> in the <i>Amazon Connect Administrator
|
|
48
|
-
* Guide</i>. </p>
|
|
30
|
+
* <p>Creates an association between a content resource in a knowledge base and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step guides</a>. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. </p> <p>After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.</p> <p>Note the following limitations:</p> <ul> <li> <p>You can create only one content association for each content resource in a knowledge base.</p> </li> <li> <p>You can associate a step-by-step guide with multiple content resources.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
49
31
|
* @example
|
|
50
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
33
|
* ```javascript
|
|
@@ -100,21 +82,20 @@ declare const CreateContentAssociationCommand_base: {
|
|
|
100
82
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
101
83
|
*
|
|
102
84
|
* @throws {@link ConflictException} (client fault)
|
|
103
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
104
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
105
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
106
|
-
* same name) is being created or mutated.</p>
|
|
85
|
+
* <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>
|
|
107
86
|
*
|
|
108
87
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
109
88
|
* <p>The specified resource does not exist.</p>
|
|
110
89
|
*
|
|
111
90
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
112
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
113
|
-
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
91
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
114
92
|
*
|
|
115
93
|
* @throws {@link ThrottlingException} (client fault)
|
|
116
94
|
* <p>The throttling limit has been exceeded.</p>
|
|
117
95
|
*
|
|
96
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
97
|
+
* <p>You do not have permission to perform this action.</p>
|
|
98
|
+
*
|
|
118
99
|
* @throws {@link ValidationException} (client fault)
|
|
119
100
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
120
101
|
*
|
|
@@ -85,17 +85,16 @@ declare const CreateContentCommand_base: {
|
|
|
85
85
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
86
86
|
*
|
|
87
87
|
* @throws {@link ConflictException} (client fault)
|
|
88
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
89
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
90
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
91
|
-
* same name) is being created or mutated.</p>
|
|
88
|
+
* <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>
|
|
92
89
|
*
|
|
93
90
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
91
|
* <p>The specified resource does not exist.</p>
|
|
95
92
|
*
|
|
96
93
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
97
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
98
|
-
*
|
|
94
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
97
|
+
* <p>You do not have permission to perform this action.</p>
|
|
99
98
|
*
|
|
100
99
|
* @throws {@link ValidationException} (client fault)
|
|
101
100
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
@@ -27,30 +27,7 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a knowledge base.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>When using this API, you cannot reuse <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a>
|
|
33
|
-
* DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do,
|
|
34
|
-
* you'll get an <code>InvalidRequestException</code> error. </p>
|
|
35
|
-
* <p>For example, you're programmatically managing your external knowledge base, and you want
|
|
36
|
-
* to add or remove one of the fields that is being ingested from Salesforce. Do the
|
|
37
|
-
* following:</p>
|
|
38
|
-
* <ol>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>Call <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different
|
|
47
|
-
* one.</p>
|
|
48
|
-
* </li>
|
|
49
|
-
* <li>
|
|
50
|
-
* <p>Call CreateKnowledgeBase.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* </ol>
|
|
53
|
-
* </note>
|
|
30
|
+
* <p>Creates a knowledge base.</p> <note> <p>When using this API, you cannot reuse <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a> DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an <code>InvalidRequestException</code> error. </p> <p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>
|
|
54
31
|
* @example
|
|
55
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
56
33
|
* ```javascript
|
|
@@ -231,14 +208,13 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
231
208
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
232
209
|
*
|
|
233
210
|
* @throws {@link ConflictException} (client fault)
|
|
234
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
235
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
236
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
237
|
-
* same name) is being created or mutated.</p>
|
|
211
|
+
* <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>
|
|
238
212
|
*
|
|
239
213
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
240
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
241
|
-
*
|
|
214
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
215
|
+
*
|
|
216
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
217
|
+
* <p>You do not have permission to perform this action.</p>
|
|
242
218
|
*
|
|
243
219
|
* @throws {@link ValidationException} (client fault)
|
|
244
220
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
@@ -27,11 +27,7 @@ declare const CreateMessageTemplateAttachmentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Uploads an attachment file to the specified Amazon Q in Connect message template. The name
|
|
31
|
-
* of the message template attachment has to be unique for each message template referenced by
|
|
32
|
-
* the <code>$LATEST</code> qualifier. The body of the attachment file should be encoded using
|
|
33
|
-
* base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned
|
|
34
|
-
* in response to download the uploaded file.</p>
|
|
30
|
+
* <p>Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the <code>$LATEST</code> qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -71,21 +67,20 @@ declare const CreateMessageTemplateAttachmentCommand_base: {
|
|
|
71
67
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
72
68
|
*
|
|
73
69
|
* @throws {@link ConflictException} (client fault)
|
|
74
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
75
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
76
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
77
|
-
* same name) is being created or mutated.</p>
|
|
70
|
+
* <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>
|
|
78
71
|
*
|
|
79
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
73
|
* <p>The specified resource does not exist.</p>
|
|
81
74
|
*
|
|
82
75
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
83
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
84
|
-
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
76
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
85
77
|
*
|
|
86
78
|
* @throws {@link ThrottlingException} (client fault)
|
|
87
79
|
* <p>The throttling limit has been exceeded.</p>
|
|
88
80
|
*
|
|
81
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
82
|
+
* <p>You do not have permission to perform this action.</p>
|
|
83
|
+
*
|
|
89
84
|
* @throws {@link ValidationException} (client fault)
|
|
90
85
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
91
86
|
*
|
|
@@ -27,10 +27,7 @@ declare const CreateMessageTemplateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an Amazon Q in Connect message template. The name of the message template has to
|
|
31
|
-
* be unique for each knowledge base. The channel subtype of the message template is immutable
|
|
32
|
-
* and cannot be modified after creation. After the message template is created, you can use the
|
|
33
|
-
* <code>$LATEST</code> qualifier to reference the created message template.</p>
|
|
30
|
+
* <p>Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the <code>$LATEST</code> qualifier to reference the created message template.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -309,17 +306,13 @@ declare const CreateMessageTemplateCommand_base: {
|
|
|
309
306
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
310
307
|
*
|
|
311
308
|
* @throws {@link ConflictException} (client fault)
|
|
312
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
313
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
314
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
315
|
-
* same name) is being created or mutated.</p>
|
|
309
|
+
* <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>
|
|
316
310
|
*
|
|
317
311
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
318
312
|
* <p>The specified resource does not exist.</p>
|
|
319
313
|
*
|
|
320
314
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
321
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
322
|
-
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
315
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
323
316
|
*
|
|
324
317
|
* @throws {@link ThrottlingException} (client fault)
|
|
325
318
|
* <p>The throttling limit has been exceeded.</p>
|
|
@@ -28,16 +28,7 @@ declare const CreateMessageTemplateVersionCommand_base: {
|
|
|
28
28
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
|
-
* <p>Creates a new Amazon Q in Connect message template version from the current content and
|
|
32
|
-
* configuration of a message template. Versions are immutable and monotonically increasing. Once
|
|
33
|
-
* a version is created, you can reference a specific version of the message template by passing
|
|
34
|
-
* in <code><message-template-id>:<versionNumber></code> as the message template
|
|
35
|
-
* identifier. An error is displayed if the supplied <code>messageTemplateContentSha256</code> is
|
|
36
|
-
* different from the <code>messageTemplateContentSha256</code> of the message template with
|
|
37
|
-
* <code>$LATEST</code> qualifier. If multiple <code>CreateMessageTemplateVersion</code>
|
|
38
|
-
* requests are made while the message template remains the same, only the first invocation
|
|
39
|
-
* creates a new version and the succeeding requests will return the same response as the first
|
|
40
|
-
* invocation.</p>
|
|
31
|
+
* <p>Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <code><message-template-id>:<versionNumber></code> as the message template identifier. An error is displayed if the supplied <code>messageTemplateContentSha256</code> is different from the <code>messageTemplateContentSha256</code> of the message template with <code>$LATEST</code> qualifier. If multiple <code>CreateMessageTemplateVersion</code> requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.</p>
|
|
41
32
|
* @example
|
|
42
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
34
|
* ```javascript
|
|
@@ -210,17 +201,13 @@ declare const CreateMessageTemplateVersionCommand_base: {
|
|
|
210
201
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
211
202
|
*
|
|
212
203
|
* @throws {@link ConflictException} (client fault)
|
|
213
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
214
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
215
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
216
|
-
* same name) is being created or mutated.</p>
|
|
204
|
+
* <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>
|
|
217
205
|
*
|
|
218
206
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
219
207
|
* <p>The specified resource does not exist.</p>
|
|
220
208
|
*
|
|
221
209
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
222
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
223
|
-
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
210
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
224
211
|
*
|
|
225
212
|
* @throws {@link ThrottlingException} (client fault)
|
|
226
213
|
* <p>The throttling limit has been exceeded.</p>
|
|
@@ -112,17 +112,16 @@ declare const CreateQuickResponseCommand_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 ResourceNotFoundException} (client fault)
|
|
121
118
|
* <p>The specified resource does not exist.</p>
|
|
122
119
|
*
|
|
123
120
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
124
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
125
|
-
*
|
|
121
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
124
|
+
* <p>You do not have permission to perform this action.</p>
|
|
126
125
|
*
|
|
127
126
|
* @throws {@link ValidationException} (client fault)
|
|
128
127
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
@@ -27,9 +27,7 @@ declare const CreateSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a session. A session is a contextual container used for generating
|
|
31
|
-
* recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which
|
|
32
|
-
* Amazon Q in Connect is enabled.</p>
|
|
30
|
+
* <p>Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new 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
|
|
@@ -125,14 +123,14 @@ declare const CreateSessionCommand_base: {
|
|
|
125
123
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
126
124
|
*
|
|
127
125
|
* @throws {@link ConflictException} (client fault)
|
|
128
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
129
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
130
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
131
|
-
* same name) is being created or mutated.</p>
|
|
126
|
+
* <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>
|
|
132
127
|
*
|
|
133
128
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
134
129
|
* <p>The specified resource does not exist.</p>
|
|
135
130
|
*
|
|
131
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
132
|
+
* <p>You do not have permission to perform this action.</p>
|
|
133
|
+
*
|
|
136
134
|
* @throws {@link ValidationException} (client fault)
|
|
137
135
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
138
136
|
*
|
|
@@ -27,9 +27,7 @@ declare const DeactivateMessageTemplateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deactivates a specific version of the Amazon Q in Connect message template . After the
|
|
31
|
-
* version is deactivated, you can no longer use the <code>$ACTIVE_VERSION</code> qualifier to
|
|
32
|
-
* reference the version in active status.</p>
|
|
30
|
+
* <p>Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the <code>$ACTIVE_VERSION</code> qualifier to reference the version in active status.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -61,10 +59,7 @@ declare const DeactivateMessageTemplateCommand_base: {
|
|
|
61
59
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
62
60
|
*
|
|
63
61
|
* @throws {@link ConflictException} (client fault)
|
|
64
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
65
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
66
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
67
|
-
* same name) is being created or mutated.</p>
|
|
62
|
+
* <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>
|
|
68
63
|
*
|
|
69
64
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
65
|
* <p>The specified resource does not exist.</p>
|
|
@@ -59,6 +59,9 @@ declare const DeleteAIAgentCommand_base: {
|
|
|
59
59
|
* @throws {@link ThrottlingException} (client fault)
|
|
60
60
|
* <p>The throttling limit has been exceeded.</p>
|
|
61
61
|
*
|
|
62
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
63
|
+
* <p>You do not have permission to perform this action.</p>
|
|
64
|
+
*
|
|
62
65
|
* @throws {@link ValidationException} (client fault)
|
|
63
66
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
64
67
|
*
|
|
@@ -55,10 +55,7 @@ declare const DeleteAIAgentVersionCommand_base: {
|
|
|
55
55
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
56
56
|
*
|
|
57
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>
|
|
58
|
+
* <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>
|
|
62
59
|
*
|
|
63
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
61
|
* <p>The specified resource does not exist.</p>
|
|
@@ -66,6 +63,9 @@ declare const DeleteAIAgentVersionCommand_base: {
|
|
|
66
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
67
64
|
* <p>The throttling limit has been exceeded.</p>
|
|
68
65
|
*
|
|
66
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
67
|
+
* <p>You do not have permission to perform this action.</p>
|
|
68
|
+
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
70
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
71
71
|
*
|
|
@@ -54,10 +54,7 @@ declare const DeleteAIGuardrailCommand_base: {
|
|
|
54
54
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
58
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
59
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
60
|
-
* same name) is being created or mutated.</p>
|
|
57
|
+
* <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>
|
|
61
58
|
*
|
|
62
59
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
60
|
* <p>The specified resource does not exist.</p>
|
|
@@ -65,6 +62,9 @@ declare const DeleteAIGuardrailCommand_base: {
|
|
|
65
62
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
63
|
* <p>The throttling limit has been exceeded.</p>
|
|
67
64
|
*
|
|
65
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
66
|
+
* <p>You do not have permission to perform this action.</p>
|
|
67
|
+
*
|
|
68
68
|
* @throws {@link ValidationException} (client fault)
|
|
69
69
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
70
70
|
*
|
|
@@ -55,10 +55,7 @@ declare const DeleteAIGuardrailVersionCommand_base: {
|
|
|
55
55
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
56
56
|
*
|
|
57
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>
|
|
58
|
+
* <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>
|
|
62
59
|
*
|
|
63
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
61
|
* <p>The specified resource does not exist.</p>
|
|
@@ -66,6 +63,9 @@ declare const DeleteAIGuardrailVersionCommand_base: {
|
|
|
66
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
67
64
|
* <p>The throttling limit has been exceeded.</p>
|
|
68
65
|
*
|
|
66
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
67
|
+
* <p>You do not have permission to perform this action.</p>
|
|
68
|
+
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
70
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
71
71
|
*
|
|
@@ -59,6 +59,9 @@ declare const DeleteAIPromptCommand_base: {
|
|
|
59
59
|
* @throws {@link ThrottlingException} (client fault)
|
|
60
60
|
* <p>The throttling limit has been exceeded.</p>
|
|
61
61
|
*
|
|
62
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
63
|
+
* <p>You do not have permission to perform this action.</p>
|
|
64
|
+
*
|
|
62
65
|
* @throws {@link ValidationException} (client fault)
|
|
63
66
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
64
67
|
*
|
|
@@ -55,10 +55,7 @@ declare const DeleteAIPromptVersionCommand_base: {
|
|
|
55
55
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
56
56
|
*
|
|
57
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>
|
|
58
|
+
* <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>
|
|
62
59
|
*
|
|
63
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
61
|
* <p>The specified resource does not exist.</p>
|
|
@@ -66,6 +63,9 @@ declare const DeleteAIPromptVersionCommand_base: {
|
|
|
66
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
67
64
|
* <p>The throttling limit has been exceeded.</p>
|
|
68
65
|
*
|
|
66
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
67
|
+
* <p>You do not have permission to perform this action.</p>
|
|
68
|
+
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
70
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
71
71
|
*
|
|
@@ -56,6 +56,9 @@ declare const DeleteAssistantAssociationCommand_base: {
|
|
|
56
56
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
57
|
* <p>The specified resource does not exist.</p>
|
|
58
58
|
*
|
|
59
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
60
|
+
* <p>You do not have permission to perform this action.</p>
|
|
61
|
+
*
|
|
59
62
|
* @throws {@link ValidationException} (client fault)
|
|
60
63
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
61
64
|
*
|
|
@@ -55,6 +55,9 @@ declare const DeleteAssistantCommand_base: {
|
|
|
55
55
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
56
56
|
* <p>The specified resource does not exist.</p>
|
|
57
57
|
*
|
|
58
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
59
|
+
* <p>You do not have permission to perform this action.</p>
|
|
60
|
+
*
|
|
58
61
|
* @throws {@link ValidationException} (client fault)
|
|
59
62
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
60
63
|
*
|
|
@@ -27,10 +27,7 @@ declare const DeleteContentAssociationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the content association. </p>
|
|
31
|
-
* <p>For more information about content associations--what they are and when they are used--see
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect
|
|
33
|
-
* Administrator Guide</i>. </p>
|
|
30
|
+
* <p>Deletes the content association. </p> <p>For more information about content associations--what they are and when they are used--see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -60,6 +57,9 @@ declare const DeleteContentAssociationCommand_base: {
|
|
|
60
57
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
58
|
* <p>The specified resource does not exist.</p>
|
|
62
59
|
*
|
|
60
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
61
|
+
* <p>You do not have permission to perform this action.</p>
|
|
62
|
+
*
|
|
63
63
|
* @throws {@link ValidationException} (client fault)
|
|
64
64
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
65
65
|
*
|
|
@@ -54,14 +54,14 @@ declare const DeleteContentCommand_base: {
|
|
|
54
54
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
58
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
59
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
60
|
-
* same name) is being created or mutated.</p>
|
|
57
|
+
* <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>
|
|
61
58
|
*
|
|
62
59
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
60
|
* <p>The specified resource does not exist.</p>
|
|
64
61
|
*
|
|
62
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
63
|
+
* <p>You do not have permission to perform this action.</p>
|
|
64
|
+
*
|
|
65
65
|
* @throws {@link ValidationException} (client fault)
|
|
66
66
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
67
67
|
*
|
|
@@ -54,14 +54,14 @@ declare const DeleteImportJobCommand_base: {
|
|
|
54
54
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
58
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
59
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
60
|
-
* same name) is being created or mutated.</p>
|
|
57
|
+
* <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>
|
|
61
58
|
*
|
|
62
59
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
60
|
* <p>The specified resource does not exist.</p>
|
|
64
61
|
*
|
|
62
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
63
|
+
* <p>You do not have permission to perform this action.</p>
|
|
64
|
+
*
|
|
65
65
|
* @throws {@link ValidationException} (client fault)
|
|
66
66
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
67
67
|
*
|
|
@@ -27,15 +27,7 @@ declare const DeleteKnowledgeBaseCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the knowledge base.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>When you use this API to delete an external knowledge base such as Salesforce or
|
|
33
|
-
* ServiceNow, you must also delete the <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a>
|
|
34
|
-
* DataIntegration. This is because you can't reuse the DataIntegration after it's been
|
|
35
|
-
* associated with an external knowledge base. However, you can delete and recreate it. See
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a> and <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> in the <i>Amazon AppIntegrations API
|
|
37
|
-
* Reference</i>.</p>
|
|
38
|
-
* </note>
|
|
30
|
+
* <p>Deletes the knowledge base.</p> <note> <p>When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a> DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a> and <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> in the <i>Amazon AppIntegrations API Reference</i>.</p> </note>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -61,14 +53,14 @@ declare const DeleteKnowledgeBaseCommand_base: {
|
|
|
61
53
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
62
54
|
*
|
|
63
55
|
* @throws {@link ConflictException} (client fault)
|
|
64
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
65
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
66
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
67
|
-
* same name) is being created or mutated.</p>
|
|
56
|
+
* <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>
|
|
68
57
|
*
|
|
69
58
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
59
|
* <p>The specified resource does not exist.</p>
|
|
71
60
|
*
|
|
61
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
62
|
+
* <p>You do not have permission to perform this action.</p>
|
|
63
|
+
*
|
|
72
64
|
* @throws {@link ValidationException} (client fault)
|
|
73
65
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
74
66
|
*
|
|
@@ -27,9 +27,7 @@ declare const DeleteMessageTemplateAttachmentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the attachment file from the Amazon Q in Connect message template that is
|
|
31
|
-
* referenced by <code>$LATEST</code> qualifier. Attachments on available message template
|
|
32
|
-
* versions will remain unchanged.</p>
|
|
30
|
+
* <p>Deletes the attachment file from the Amazon Q in Connect message template that is referenced by <code>$LATEST</code> qualifier. Attachments on available message template versions will remain unchanged.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -57,10 +55,7 @@ declare const DeleteMessageTemplateAttachmentCommand_base: {
|
|
|
57
55
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
58
56
|
*
|
|
59
57
|
* @throws {@link ConflictException} (client fault)
|
|
60
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
61
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
62
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
63
|
-
* same name) is being created or mutated.</p>
|
|
58
|
+
* <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>
|
|
64
59
|
*
|
|
65
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
61
|
* <p>The specified resource does not exist.</p>
|