@aws-sdk/client-connect 3.699.0 → 3.703.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 -1
- package/dist-cjs/index.js +123 -49
- package/dist-es/commands/CreateContactCommand.js +1 -1
- package/dist-es/commands/StartEmailContactCommand.js +1 -1
- package/dist-es/commands/StartTaskContactCommand.js +1 -1
- package/dist-es/commands/UpdateContactCommand.js +1 -1
- package/dist-es/models/models_0.js +6 -5
- package/dist-es/models/models_1.js +5 -0
- package/dist-es/models/models_2.js +13 -27
- package/dist-es/models/models_3.js +23 -0
- package/dist-es/protocols/Aws_restJson1.js +64 -8
- package/dist-types/Connect.d.ts +1 -1
- package/dist-types/ConnectClient.d.ts +1 -1
- package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactCommand.d.ts +13 -2
- package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -1
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -2
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +10 -0
- package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
- package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociatedContactsCommand.d.ts +2 -1
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -3
- package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -1
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
- package/dist-types/commands/SendOutboundEmailCommand.d.ts +6 -1
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +3 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
- package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/StartEmailContactCommand.d.ts +14 -2
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +14 -3
- package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +2 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +12 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateContactCommand.d.ts +33 -1
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +2 -2
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +87 -119
- package/dist-types/models/models_1.d.ts +238 -89
- package/dist-types/models/models_2.d.ts +442 -699
- package/dist-types/models/models_3.d.ts +598 -127
- package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +11 -21
- package/dist-types/ts3.4/models/models_1.d.ts +18 -6
- package/dist-types/ts3.4/models/models_2.d.ts +63 -96
- package/dist-types/ts3.4/models/models_3.d.ts +99 -27
- package/package.json +1 -1
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import {
|
|
4
|
+
import { StartOutboundChatContactResponse } from "../models/models_2";
|
|
5
|
+
import { StartOutboundChatContactRequest } from "../models/models_3";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -28,13 +29,13 @@ declare const StartOutboundChatContactCommand_base: {
|
|
|
28
29
|
};
|
|
29
30
|
/**
|
|
30
31
|
* <p>Initiates a new outbound SMS contact to a customer. Response of this API provides the
|
|
31
|
-
* ContactId of the outbound SMS contact created.</p>
|
|
32
|
+
* <code>ContactId</code> of the outbound SMS contact created.</p>
|
|
32
33
|
* <p>
|
|
33
34
|
* <b>SourceEndpoint</b> only supports Endpoints with
|
|
34
35
|
* <code>CONNECT_PHONENUMBER_ARN</code> as Type and <b>DestinationEndpoint</b> only supports Endpoints with <code>TELEPHONE_NUMBER</code> as
|
|
35
36
|
* Type. <b>ContactFlowId</b> initiates the flow to manage the new SMS
|
|
36
37
|
* contact created.</p>
|
|
37
|
-
* <p>This API can be used to initiate outbound SMS contacts for an agent or it can also deflect
|
|
38
|
+
* <p>This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect
|
|
38
39
|
* an ongoing contact to an outbound SMS contact by using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html">StartOutboundChatContact</a> Flow Action.</p>
|
|
39
40
|
* <p>For more information about using SMS in Amazon Connect, see the following topics in the
|
|
40
41
|
* <i>Amazon Connect Administrator Guide</i>:</p>
|
|
@@ -71,6 +72,16 @@ declare const StartOutboundChatContactCommand_base: {
|
|
|
71
72
|
* SegmentAttributes: { // SegmentAttributes // required
|
|
72
73
|
* "<keys>": { // SegmentAttributeValue
|
|
73
74
|
* ValueString: "STRING_VALUE",
|
|
75
|
+
* ValueMap: { // SegmentAttributeValueMap
|
|
76
|
+
* "<keys>": {
|
|
77
|
+
* ValueString: "STRING_VALUE",
|
|
78
|
+
* ValueMap: {
|
|
79
|
+
* "<keys>": "<SegmentAttributeValue>",
|
|
80
|
+
* },
|
|
81
|
+
* ValueInteger: Number("int"),
|
|
82
|
+
* },
|
|
83
|
+
* },
|
|
84
|
+
* ValueInteger: Number("int"),
|
|
74
85
|
* },
|
|
75
86
|
* },
|
|
76
87
|
* Attributes: { // Attributes
|
|
@@ -27,7 +27,8 @@ declare const StartOutboundEmailContactCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p
|
|
30
|
+
* <p>Initiates a flow to send an agent reply or outbound email contact (created from the
|
|
31
|
+
* CreateContact API) to a customer.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import {
|
|
4
|
+
import { StartTaskContactResponse } from "../models/models_2";
|
|
5
|
+
import { StartTaskContactRequest } from "../models/models_3";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -110,6 +111,16 @@ declare const StartTaskContactCommand_base: {
|
|
|
110
111
|
* SegmentAttributes: { // SegmentAttributes
|
|
111
112
|
* "<keys>": { // SegmentAttributeValue
|
|
112
113
|
* ValueString: "STRING_VALUE",
|
|
114
|
+
* ValueMap: { // SegmentAttributeValueMap
|
|
115
|
+
* "<keys>": {
|
|
116
|
+
* ValueString: "STRING_VALUE",
|
|
117
|
+
* ValueMap: {
|
|
118
|
+
* "<keys>": "<SegmentAttributeValue>",
|
|
119
|
+
* },
|
|
120
|
+
* ValueInteger: Number("int"),
|
|
121
|
+
* },
|
|
122
|
+
* },
|
|
123
|
+
* ValueInteger: Number("int"),
|
|
113
124
|
* },
|
|
114
125
|
* },
|
|
115
126
|
* };
|
|
@@ -43,6 +43,7 @@ declare const StopContactRecordingCommand_base: {
|
|
|
43
43
|
* InstanceId: "STRING_VALUE", // required
|
|
44
44
|
* ContactId: "STRING_VALUE", // required
|
|
45
45
|
* InitialContactId: "STRING_VALUE", // required
|
|
46
|
+
* ContactRecordingType: "AGENT" || "IVR" || "SCREEN",
|
|
46
47
|
* };
|
|
47
48
|
* const command = new StopContactRecordingCommand(input);
|
|
48
49
|
* const response = await client.send(command);
|
|
@@ -45,6 +45,7 @@ declare const SuspendContactRecordingCommand_base: {
|
|
|
45
45
|
* InstanceId: "STRING_VALUE", // required
|
|
46
46
|
* ContactId: "STRING_VALUE", // required
|
|
47
47
|
* InitialContactId: "STRING_VALUE", // required
|
|
48
|
+
* ContactRecordingType: "AGENT" || "IVR" || "SCREEN",
|
|
48
49
|
* };
|
|
49
50
|
* const command = new SuspendContactRecordingCommand(input);
|
|
50
51
|
* const response = await client.send(command);
|
|
@@ -29,8 +29,8 @@ declare const TagResourceCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Adds the specified tags to the specified resource.</p>
|
|
31
31
|
* <p>Some of the supported resource types are agents, routing profiles, queues, quick connects,
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates.
|
|
33
|
+
* For a complete list, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html">Tagging resources in Amazon Connect</a>.</p>
|
|
34
34
|
* <p>For sample policies that use tags, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html">Amazon Connect
|
|
35
35
|
* Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator
|
|
36
36
|
* Guide</i>.</p>
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import {
|
|
4
|
+
import { UpdateContactResponse } from "../models/models_2";
|
|
5
|
+
import { UpdateContactRequest } from "../models/models_3";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -57,8 +58,32 @@ declare const UpdateContactCommand_base: {
|
|
|
57
58
|
* SegmentAttributes: { // SegmentAttributes
|
|
58
59
|
* "<keys>": { // SegmentAttributeValue
|
|
59
60
|
* ValueString: "STRING_VALUE",
|
|
61
|
+
* ValueMap: { // SegmentAttributeValueMap
|
|
62
|
+
* "<keys>": {
|
|
63
|
+
* ValueString: "STRING_VALUE",
|
|
64
|
+
* ValueMap: {
|
|
65
|
+
* "<keys>": "<SegmentAttributeValue>",
|
|
66
|
+
* },
|
|
67
|
+
* ValueInteger: Number("int"),
|
|
68
|
+
* },
|
|
69
|
+
* },
|
|
70
|
+
* ValueInteger: Number("int"),
|
|
60
71
|
* },
|
|
61
72
|
* },
|
|
73
|
+
* QueueInfo: { // QueueInfoInput
|
|
74
|
+
* Id: "STRING_VALUE",
|
|
75
|
+
* },
|
|
76
|
+
* UserInfo: { // UserInfo
|
|
77
|
+
* UserId: "STRING_VALUE",
|
|
78
|
+
* },
|
|
79
|
+
* CustomerEndpoint: { // Endpoint
|
|
80
|
+
* Type: "TELEPHONE_NUMBER" || "VOIP" || "CONTACT_FLOW" || "CONNECT_PHONENUMBER_ARN" || "EMAIL_ADDRESS",
|
|
81
|
+
* Address: "STRING_VALUE",
|
|
82
|
+
* },
|
|
83
|
+
* SystemEndpoint: {
|
|
84
|
+
* Type: "TELEPHONE_NUMBER" || "VOIP" || "CONTACT_FLOW" || "CONNECT_PHONENUMBER_ARN" || "EMAIL_ADDRESS",
|
|
85
|
+
* Address: "STRING_VALUE",
|
|
86
|
+
* },
|
|
62
87
|
* };
|
|
63
88
|
* const command = new UpdateContactCommand(input);
|
|
64
89
|
* const response = await client.send(command);
|
|
@@ -72,6 +97,13 @@ declare const UpdateContactCommand_base: {
|
|
|
72
97
|
* @see {@link UpdateContactCommandOutput} for command's `response` shape.
|
|
73
98
|
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
74
99
|
*
|
|
100
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
101
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ConflictException} (client fault)
|
|
104
|
+
* <p>Operation cannot be performed at this time as there is a conflict with another operation or
|
|
105
|
+
* contact state.</p>
|
|
106
|
+
*
|
|
75
107
|
* @throws {@link InternalServiceException} (server fault)
|
|
76
108
|
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
77
109
|
*
|
|
@@ -31,7 +31,7 @@ declare const UpdateContactFlowContentCommand_base: {
|
|
|
31
31
|
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
32
32
|
* Flow language</a>.</p>
|
|
33
33
|
* <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content
|
|
34
|
-
* of a Flow. For example, <code>arn:aws:.../contact-flow/\{id\}:$SAVED</code>.
|
|
34
|
+
* of a Flow. For example, <code>arn:aws:.../contact-flow/\{id\}:$SAVED</code>. After a flow is
|
|
35
35
|
* published, <code>$SAVED</code> needs to be supplied to view saved content that has not been
|
|
36
36
|
* published.</p>
|
|
37
37
|
* @example
|
|
@@ -29,7 +29,7 @@ declare const UpdateContactFlowModuleContentCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates specified flow module for the specified Amazon Connect instance. </p>
|
|
31
31
|
* <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content
|
|
32
|
-
* of a Flow. For example, <code>arn:aws:.../contact-flow/\{id\}:$SAVED</code>.
|
|
32
|
+
* of a Flow. For example, <code>arn:aws:.../contact-flow/\{id\}:$SAVED</code>. After a flow is
|
|
33
33
|
* published, <code>$SAVED</code> needs to be supplied to view saved content that has not been
|
|
34
34
|
* published.</p>
|
|
35
35
|
* @example
|
|
@@ -27,7 +27,8 @@ declare const UpdateEmailAddressMetadataCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p
|
|
30
|
+
* <p>Updates an email address metadata. For more information about email addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html">Create email
|
|
31
|
+
* addresses</a> in the Amazon Connect Administrator Guide.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const UpdateQueueOutboundEmailConfigCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p
|
|
30
|
+
* <p>Updates the outbound email address Id for a specified queue.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -57,7 +57,7 @@ declare const UpdateQueueOutboundEmailConfigCommand_base: {
|
|
|
57
57
|
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ConditionalOperationFailedException} (client fault)
|
|
60
|
-
* <p
|
|
60
|
+
* <p>A conditional check failed.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link InternalServiceException} (server fault)
|
|
63
63
|
* <p>Request processing failed because of an error or failure with the service.</p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* are also limits to the number of requests that you can make per second. For more information, see
|
|
22
22
|
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
|
|
23
23
|
* Guide</i>.</p>
|
|
24
|
-
* <p>You can connect programmatically to an Amazon Web Services service
|
|
24
|
+
* <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For
|
|
25
25
|
* a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
|
|
26
26
|
*
|
|
27
27
|
* @packageDocumentation
|
|
@@ -161,33 +161,37 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
161
161
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* <p
|
|
164
|
+
* <p>Information about the email recipient</p>
|
|
165
165
|
* @public
|
|
166
166
|
*/
|
|
167
167
|
export interface EmailRecipient {
|
|
168
168
|
/**
|
|
169
|
-
* <p
|
|
169
|
+
* <p>Address of the email recipient.</p>
|
|
170
|
+
* <p>Type: String</p>
|
|
171
|
+
* <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
|
|
170
172
|
* @public
|
|
171
173
|
*/
|
|
172
174
|
Address?: string | undefined;
|
|
173
175
|
/**
|
|
174
|
-
* <p
|
|
176
|
+
* <p>Display name of the email recipient.</p>
|
|
177
|
+
* <p>Type: String</p>
|
|
178
|
+
* <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
|
|
175
179
|
* @public
|
|
176
180
|
*/
|
|
177
181
|
DisplayName?: string | undefined;
|
|
178
182
|
}
|
|
179
183
|
/**
|
|
180
|
-
* <p
|
|
184
|
+
* <p>List of additional email addresses for an email contact.</p>
|
|
181
185
|
* @public
|
|
182
186
|
*/
|
|
183
187
|
export interface AdditionalEmailRecipients {
|
|
184
188
|
/**
|
|
185
|
-
* <p
|
|
189
|
+
* <p>List of additional TO email recipients for an email contact.</p>
|
|
186
190
|
* @public
|
|
187
191
|
*/
|
|
188
192
|
ToList?: EmailRecipient[] | undefined;
|
|
189
193
|
/**
|
|
190
|
-
* <p
|
|
194
|
+
* <p>List of additional CC email recipients for an email contact.</p>
|
|
191
195
|
* @public
|
|
192
196
|
*/
|
|
193
197
|
CcList?: EmailRecipient[] | undefined;
|
|
@@ -995,7 +999,7 @@ export declare const AttachedFileServiceQuotaExceededExceptionReason: {
|
|
|
995
999
|
*/
|
|
996
1000
|
export type AttachedFileServiceQuotaExceededExceptionReason = (typeof AttachedFileServiceQuotaExceededExceptionReason)[keyof typeof AttachedFileServiceQuotaExceededExceptionReason];
|
|
997
1001
|
/**
|
|
998
|
-
* <p
|
|
1002
|
+
* <p>The reason for the exception.</p>
|
|
999
1003
|
* @public
|
|
1000
1004
|
*/
|
|
1001
1005
|
export type ServiceQuotaExceededExceptionReason = ServiceQuotaExceededExceptionReason.AttachedFileServiceQuotaExceededExceptionReasonMember | ServiceQuotaExceededExceptionReason.$UnknownMember;
|
|
@@ -1004,7 +1008,7 @@ export type ServiceQuotaExceededExceptionReason = ServiceQuotaExceededExceptionR
|
|
|
1004
1008
|
*/
|
|
1005
1009
|
export declare namespace ServiceQuotaExceededExceptionReason {
|
|
1006
1010
|
/**
|
|
1007
|
-
* <p
|
|
1011
|
+
* <p>Total file size of all files or total number of files exceeds the service quota</p>
|
|
1008
1012
|
* @public
|
|
1009
1013
|
*/
|
|
1010
1014
|
interface AttachedFileServiceQuotaExceededExceptionReasonMember {
|
|
@@ -1033,7 +1037,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
1033
1037
|
readonly $fault: "client";
|
|
1034
1038
|
Message?: string | undefined;
|
|
1035
1039
|
/**
|
|
1036
|
-
* <p
|
|
1040
|
+
* <p>The reason for the exception.</p>
|
|
1037
1041
|
* @public
|
|
1038
1042
|
*/
|
|
1039
1043
|
Reason?: ServiceQuotaExceededExceptionReason | undefined;
|
|
@@ -1181,9 +1185,11 @@ export interface AssociateDefaultVocabularyResponse {
|
|
|
1181
1185
|
* @enum
|
|
1182
1186
|
*/
|
|
1183
1187
|
export declare const FlowAssociationResourceType: {
|
|
1188
|
+
readonly ANALYTICS_CONNECTOR: "ANALYTICS_CONNECTOR";
|
|
1184
1189
|
readonly INBOUND_EMAIL: "INBOUND_EMAIL";
|
|
1185
1190
|
readonly OUTBOUND_EMAIL: "OUTBOUND_EMAIL";
|
|
1186
1191
|
readonly SMS_PHONE_NUMBER: "SMS_PHONE_NUMBER";
|
|
1192
|
+
readonly WHATSAPP_MESSAGING_PHONE_NUMBER: "WHATSAPP_MESSAGING_PHONE_NUMBER";
|
|
1187
1193
|
};
|
|
1188
1194
|
/**
|
|
1189
1195
|
* @public
|
|
@@ -1200,6 +1206,16 @@ export interface AssociateFlowRequest {
|
|
|
1200
1206
|
InstanceId: string | undefined;
|
|
1201
1207
|
/**
|
|
1202
1208
|
* <p>The identifier of the resource.</p>
|
|
1209
|
+
* <ul>
|
|
1210
|
+
* <li>
|
|
1211
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
|
|
1212
|
+
* </p>
|
|
1213
|
+
* </li>
|
|
1214
|
+
* <li>
|
|
1215
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
1216
|
+
* </p>
|
|
1217
|
+
* </li>
|
|
1218
|
+
* </ul>
|
|
1203
1219
|
* @public
|
|
1204
1220
|
*/
|
|
1205
1221
|
ResourceId: string | undefined;
|
|
@@ -1807,8 +1823,8 @@ export interface BatchGetAttachedFileMetadataRequest {
|
|
|
1807
1823
|
*/
|
|
1808
1824
|
InstanceId: string | undefined;
|
|
1809
1825
|
/**
|
|
1810
|
-
* <p>The resource to which the attached file is (being) uploaded to.
|
|
1811
|
-
*
|
|
1826
|
+
* <p>The resource to which the attached file is (being) uploaded to. The supported resources are
|
|
1827
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p>
|
|
1812
1828
|
* <note>
|
|
1813
1829
|
* <p>This value must be a valid ARN.</p>
|
|
1814
1830
|
* </note>
|
|
@@ -1990,9 +2006,11 @@ export interface BatchGetAttachedFileMetadataResponse {
|
|
|
1990
2006
|
* @enum
|
|
1991
2007
|
*/
|
|
1992
2008
|
export declare const ListFlowAssociationResourceType: {
|
|
2009
|
+
readonly ANALYTICS_CONNECTOR: "ANALYTICS_CONNECTOR";
|
|
1993
2010
|
readonly INBOUND_EMAIL: "INBOUND_EMAIL";
|
|
1994
2011
|
readonly OUTBOUND_EMAIL: "OUTBOUND_EMAIL";
|
|
1995
2012
|
readonly VOICE_PHONE_NUMBER: "VOICE_PHONE_NUMBER";
|
|
2013
|
+
readonly WHATSAPP_MESSAGING_PHONE_NUMBER: "WHATSAPP_MESSAGING_PHONE_NUMBER";
|
|
1996
2014
|
};
|
|
1997
2015
|
/**
|
|
1998
2016
|
* @public
|
|
@@ -2009,6 +2027,16 @@ export interface BatchGetFlowAssociationRequest {
|
|
|
2009
2027
|
InstanceId: string | undefined;
|
|
2010
2028
|
/**
|
|
2011
2029
|
* <p>A list of resource identifiers to retrieve flow associations.</p>
|
|
2030
|
+
* <ul>
|
|
2031
|
+
* <li>
|
|
2032
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
|
|
2033
|
+
* </p>
|
|
2034
|
+
* </li>
|
|
2035
|
+
* <li>
|
|
2036
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
2037
|
+
* </p>
|
|
2038
|
+
* </li>
|
|
2039
|
+
* </ul>
|
|
2012
2040
|
* @public
|
|
2013
2041
|
*/
|
|
2014
2042
|
ResourceIds: string[] | undefined;
|
|
@@ -2313,8 +2341,8 @@ export interface CompleteAttachedFileUploadRequest {
|
|
|
2313
2341
|
*/
|
|
2314
2342
|
FileId: string | undefined;
|
|
2315
2343
|
/**
|
|
2316
|
-
* <p>The resource to which the attached file is (being) uploaded to.
|
|
2317
|
-
*
|
|
2344
|
+
* <p>The resource to which the attached file is (being) uploaded to. The supported resources are
|
|
2345
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p>
|
|
2318
2346
|
* <note>
|
|
2319
2347
|
* <p>This value must be a valid ARN.</p>
|
|
2320
2348
|
* </note>
|
|
@@ -2469,125 +2497,43 @@ export interface Reference {
|
|
|
2469
2497
|
*/
|
|
2470
2498
|
Type: ReferenceType | undefined;
|
|
2471
2499
|
/**
|
|
2472
|
-
* <p
|
|
2500
|
+
* <p>Status of the attachment reference type.</p>
|
|
2473
2501
|
* @public
|
|
2474
2502
|
*/
|
|
2475
2503
|
Status?: ReferenceStatus | undefined;
|
|
2476
2504
|
/**
|
|
2477
|
-
* <p
|
|
2505
|
+
* <p>The Amazon Resource Name (ARN) of the reference</p>
|
|
2478
2506
|
* @public
|
|
2479
2507
|
*/
|
|
2480
2508
|
Arn?: string | undefined;
|
|
2481
2509
|
/**
|
|
2482
|
-
* <p
|
|
2510
|
+
* <p>Relevant details why the reference was not successfully created.</p>
|
|
2483
2511
|
* @public
|
|
2484
2512
|
*/
|
|
2485
2513
|
StatusReason?: string | undefined;
|
|
2486
2514
|
}
|
|
2487
2515
|
/**
|
|
2488
|
-
* <p>
|
|
2489
|
-
* <code>valueString</code> and the value is a string.</p>
|
|
2490
|
-
* @public
|
|
2491
|
-
*/
|
|
2492
|
-
export interface SegmentAttributeValue {
|
|
2493
|
-
/**
|
|
2494
|
-
* <p>The value of a segment attribute.</p>
|
|
2495
|
-
* @public
|
|
2496
|
-
*/
|
|
2497
|
-
ValueString?: string | undefined;
|
|
2498
|
-
}
|
|
2499
|
-
/**
|
|
2500
|
-
* <p></p>
|
|
2516
|
+
* <p>The user details for the contact.</p>
|
|
2501
2517
|
* @public
|
|
2502
2518
|
*/
|
|
2503
2519
|
export interface UserInfo {
|
|
2504
2520
|
/**
|
|
2505
|
-
* <p
|
|
2521
|
+
* <p>The user identifier for the contact.</p>
|
|
2506
2522
|
* @public
|
|
2507
2523
|
*/
|
|
2508
2524
|
UserId?: string | undefined;
|
|
2509
2525
|
}
|
|
2510
|
-
/**
|
|
2511
|
-
* @public
|
|
2512
|
-
*/
|
|
2513
|
-
export interface CreateContactRequest {
|
|
2514
|
-
/**
|
|
2515
|
-
* <p></p>
|
|
2516
|
-
* @public
|
|
2517
|
-
*/
|
|
2518
|
-
InstanceId: string | undefined;
|
|
2519
|
-
/**
|
|
2520
|
-
* <p></p>
|
|
2521
|
-
* @public
|
|
2522
|
-
*/
|
|
2523
|
-
ClientToken?: string | undefined;
|
|
2524
|
-
/**
|
|
2525
|
-
* <p></p>
|
|
2526
|
-
* @public
|
|
2527
|
-
*/
|
|
2528
|
-
RelatedContactId?: string | undefined;
|
|
2529
|
-
/**
|
|
2530
|
-
* <p></p>
|
|
2531
|
-
* @public
|
|
2532
|
-
*/
|
|
2533
|
-
Attributes?: Record<string, string> | undefined;
|
|
2534
|
-
/**
|
|
2535
|
-
* <p></p>
|
|
2536
|
-
* @public
|
|
2537
|
-
*/
|
|
2538
|
-
References?: Record<string, Reference> | undefined;
|
|
2539
|
-
/**
|
|
2540
|
-
* <p></p>
|
|
2541
|
-
* @public
|
|
2542
|
-
*/
|
|
2543
|
-
Channel: Channel | undefined;
|
|
2544
|
-
/**
|
|
2545
|
-
* <p></p>
|
|
2546
|
-
* @public
|
|
2547
|
-
*/
|
|
2548
|
-
InitiationMethod: ContactInitiationMethod | undefined;
|
|
2549
|
-
/**
|
|
2550
|
-
* <p></p>
|
|
2551
|
-
* @public
|
|
2552
|
-
*/
|
|
2553
|
-
ExpiryDurationInMinutes?: number | undefined;
|
|
2554
|
-
/**
|
|
2555
|
-
* <p></p>
|
|
2556
|
-
* @public
|
|
2557
|
-
*/
|
|
2558
|
-
UserInfo?: UserInfo | undefined;
|
|
2559
|
-
/**
|
|
2560
|
-
* <p></p>
|
|
2561
|
-
* @public
|
|
2562
|
-
*/
|
|
2563
|
-
InitiateAs?: InitiateAs | undefined;
|
|
2564
|
-
/**
|
|
2565
|
-
* <p></p>
|
|
2566
|
-
* @public
|
|
2567
|
-
*/
|
|
2568
|
-
Name?: string | undefined;
|
|
2569
|
-
/**
|
|
2570
|
-
* <p></p>
|
|
2571
|
-
* @public
|
|
2572
|
-
*/
|
|
2573
|
-
Description?: string | undefined;
|
|
2574
|
-
/**
|
|
2575
|
-
* <p></p>
|
|
2576
|
-
* @public
|
|
2577
|
-
*/
|
|
2578
|
-
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
2579
|
-
}
|
|
2580
2526
|
/**
|
|
2581
2527
|
* @public
|
|
2582
2528
|
*/
|
|
2583
2529
|
export interface CreateContactResponse {
|
|
2584
2530
|
/**
|
|
2585
|
-
* <p
|
|
2531
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2586
2532
|
* @public
|
|
2587
2533
|
*/
|
|
2588
2534
|
ContactId?: string | undefined;
|
|
2589
2535
|
/**
|
|
2590
|
-
* <p
|
|
2536
|
+
* <p>The Amazon Resource Name (ARN) of the created contact.</p>
|
|
2591
2537
|
* @public
|
|
2592
2538
|
*/
|
|
2593
2539
|
ContactArn?: string | undefined;
|
|
@@ -2839,32 +2785,35 @@ export interface CreateContactFlowVersionResponse {
|
|
|
2839
2785
|
*/
|
|
2840
2786
|
export interface CreateEmailAddressRequest {
|
|
2841
2787
|
/**
|
|
2842
|
-
* <p
|
|
2788
|
+
* <p>The description of the email address.</p>
|
|
2843
2789
|
* @public
|
|
2844
2790
|
*/
|
|
2845
2791
|
Description?: string | undefined;
|
|
2846
2792
|
/**
|
|
2847
|
-
* <p
|
|
2793
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
2848
2794
|
* @public
|
|
2849
2795
|
*/
|
|
2850
2796
|
InstanceId: string | undefined;
|
|
2851
2797
|
/**
|
|
2852
|
-
* <p
|
|
2798
|
+
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
|
|
2853
2799
|
* @public
|
|
2854
2800
|
*/
|
|
2855
2801
|
EmailAddress: string | undefined;
|
|
2856
2802
|
/**
|
|
2857
|
-
* <p
|
|
2803
|
+
* <p>The display name of email address</p>
|
|
2858
2804
|
* @public
|
|
2859
2805
|
*/
|
|
2860
2806
|
DisplayName?: string | undefined;
|
|
2861
2807
|
/**
|
|
2862
|
-
* <p
|
|
2808
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
2863
2809
|
* @public
|
|
2864
2810
|
*/
|
|
2865
2811
|
Tags?: Record<string, string> | undefined;
|
|
2866
2812
|
/**
|
|
2867
|
-
* <p
|
|
2813
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2814
|
+
* request. If not provided, the Amazon Web Services
|
|
2815
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2816
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2868
2817
|
* @public
|
|
2869
2818
|
*/
|
|
2870
2819
|
ClientToken?: string | undefined;
|
|
@@ -2874,12 +2823,12 @@ export interface CreateEmailAddressRequest {
|
|
|
2874
2823
|
*/
|
|
2875
2824
|
export interface CreateEmailAddressResponse {
|
|
2876
2825
|
/**
|
|
2877
|
-
* <p
|
|
2826
|
+
* <p>The identifier of the email address.</p>
|
|
2878
2827
|
* @public
|
|
2879
2828
|
*/
|
|
2880
2829
|
EmailAddressId?: string | undefined;
|
|
2881
2830
|
/**
|
|
2882
|
-
* <p
|
|
2831
|
+
* <p>The Amazon Resource Name (ARN) of the email address.</p>
|
|
2883
2832
|
* @public
|
|
2884
2833
|
*/
|
|
2885
2834
|
EmailAddressArn?: string | undefined;
|
|
@@ -3494,7 +3443,9 @@ export interface CreateInstanceResponse {
|
|
|
3494
3443
|
* @enum
|
|
3495
3444
|
*/
|
|
3496
3445
|
export declare const IntegrationType: {
|
|
3446
|
+
readonly ANALYTICS_CONNECTOR: "ANALYTICS_CONNECTOR";
|
|
3497
3447
|
readonly APPLICATION: "APPLICATION";
|
|
3448
|
+
readonly CALL_TRANSFER_CONNECTOR: "CALL_TRANSFER_CONNECTOR";
|
|
3498
3449
|
readonly CASES_DOMAIN: "CASES_DOMAIN";
|
|
3499
3450
|
readonly EVENT: "EVENT";
|
|
3500
3451
|
readonly FILE_SCANNER: "FILE_SCANNER";
|
|
@@ -3540,7 +3491,7 @@ export interface CreateIntegrationAssociationRequest {
|
|
|
3540
3491
|
/**
|
|
3541
3492
|
* <p>The Amazon Resource Name (ARN) of the integration.</p>
|
|
3542
3493
|
* <note>
|
|
3543
|
-
* <p>When integrating with Amazon
|
|
3494
|
+
* <p>When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging
|
|
3544
3495
|
* instances must be in the same account.</p>
|
|
3545
3496
|
* </note>
|
|
3546
3497
|
* @public
|
|
@@ -3950,12 +3901,12 @@ export interface OutboundCallerConfig {
|
|
|
3950
3901
|
OutboundFlowId?: string | undefined;
|
|
3951
3902
|
}
|
|
3952
3903
|
/**
|
|
3953
|
-
* <p
|
|
3904
|
+
* <p>The outbound email address Id.</p>
|
|
3954
3905
|
* @public
|
|
3955
3906
|
*/
|
|
3956
3907
|
export interface OutboundEmailConfig {
|
|
3957
3908
|
/**
|
|
3958
|
-
* <p
|
|
3909
|
+
* <p>The identifier of the email address.</p>
|
|
3959
3910
|
* @public
|
|
3960
3911
|
*/
|
|
3961
3912
|
OutboundEmailAddressId?: string | undefined;
|
|
@@ -3985,7 +3936,7 @@ export interface CreateQueueRequest {
|
|
|
3985
3936
|
*/
|
|
3986
3937
|
OutboundCallerConfig?: OutboundCallerConfig | undefined;
|
|
3987
3938
|
/**
|
|
3988
|
-
* <p
|
|
3939
|
+
* <p>The outbound email address ID for a specified queue.</p>
|
|
3989
3940
|
* @public
|
|
3990
3941
|
*/
|
|
3991
3942
|
OutboundEmailConfig?: OutboundEmailConfig | undefined;
|
|
@@ -4951,7 +4902,8 @@ export interface CreateTaskTemplateRequest {
|
|
|
4951
4902
|
*/
|
|
4952
4903
|
ContactFlowId?: string | undefined;
|
|
4953
4904
|
/**
|
|
4954
|
-
* <p
|
|
4905
|
+
* <p>The ContactFlowId for the flow that will be run if this template is used to create a
|
|
4906
|
+
* self-assigned task.</p>
|
|
4955
4907
|
* @public
|
|
4956
4908
|
*/
|
|
4957
4909
|
SelfAssignFlowId?: string | undefined;
|
|
@@ -5890,12 +5842,12 @@ export interface DeleteContactFlowModuleResponse {
|
|
|
5890
5842
|
*/
|
|
5891
5843
|
export interface DeleteEmailAddressRequest {
|
|
5892
5844
|
/**
|
|
5893
|
-
* <p
|
|
5845
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
5894
5846
|
* @public
|
|
5895
5847
|
*/
|
|
5896
5848
|
InstanceId: string | undefined;
|
|
5897
5849
|
/**
|
|
5898
|
-
* <p
|
|
5850
|
+
* <p>The identifier of the email address.</p>
|
|
5899
5851
|
* @public
|
|
5900
5852
|
*/
|
|
5901
5853
|
EmailAddressId: string | undefined;
|
|
@@ -6202,9 +6154,25 @@ export interface DeleteViewVersionRequest {
|
|
|
6202
6154
|
ViewVersion: number | undefined;
|
|
6203
6155
|
}
|
|
6204
6156
|
/**
|
|
6205
|
-
* @
|
|
6157
|
+
* @public
|
|
6158
|
+
*/
|
|
6159
|
+
export interface DeleteViewVersionResponse {
|
|
6160
|
+
}
|
|
6161
|
+
/**
|
|
6162
|
+
* @public
|
|
6206
6163
|
*/
|
|
6207
|
-
export
|
|
6164
|
+
export interface DeleteVocabularyRequest {
|
|
6165
|
+
/**
|
|
6166
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6167
|
+
* @public
|
|
6168
|
+
*/
|
|
6169
|
+
InstanceId: string | undefined;
|
|
6170
|
+
/**
|
|
6171
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
6172
|
+
* @public
|
|
6173
|
+
*/
|
|
6174
|
+
VocabularyId: string | undefined;
|
|
6175
|
+
}
|
|
6208
6176
|
/**
|
|
6209
6177
|
* @internal
|
|
6210
6178
|
*/
|