@aws-sdk/client-connect 3.799.0 → 3.803.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/dist-cjs/index.js +102 -3
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/models/models_1.js +20 -0
- package/dist-es/protocols/Aws_restJson1.js +67 -0
- package/dist-types/commands/CreateContactCommand.d.ts +3 -2
- package/dist-types/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +1 -2
- package/dist-types/commands/DescribeContactCommand.d.ts +46 -2
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricDataV2Command.d.ts +2 -2
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +2 -1
- package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +1 -1
- package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +3 -5
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +68 -37
- package/dist-types/models/models_1.d.ts +426 -360
- package/dist-types/models/models_2.d.ts +225 -192
- package/dist-types/models/models_3.d.ts +225 -7
- package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListPhoneNumbersV2Command.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListPredefinedAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQueueQuickConnectsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +18 -9
- package/dist-types/ts3.4/models/models_1.d.ts +62 -51
- package/dist-types/ts3.4/models/models_2.d.ts +51 -48
- package/dist-types/ts3.4/models/models_3.d.ts +56 -0
- package/package.json +4 -4
|
@@ -1,7 +1,231 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, MonitorCapability,
|
|
3
|
+
import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, MonitorCapability, ParticipantRole, QuickConnectType, Reference, RehydrationType, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateStatus, UseCaseType, UserPhoneConfig, UserProficiency, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
4
|
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* <p>Information about phone numbers that have been claimed to your Amazon Connect instance
|
|
7
|
+
* or traffic distribution group.</p>
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export interface ListPhoneNumbersSummary {
|
|
11
|
+
/**
|
|
12
|
+
* <p>A unique identifier for the phone number.</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
PhoneNumberId?: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
PhoneNumberArn?: string | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* <p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
PhoneNumber?: string | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>The ISO country code.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The type of phone number.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
PhoneNumberType?: PhoneNumberType | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
TargetArn?: string | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
43
|
+
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
44
|
+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
InstanceId?: string | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The description of the phone number.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
PhoneNumberDescription?: string | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>The claimed phone number ARN that was previously imported from the external service, such as
|
|
55
|
+
* Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
|
|
56
|
+
* looks like the ARN of the phone number that was imported from Amazon Web Services End User
|
|
57
|
+
* Messaging.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
SourcePhoneNumberArn?: string | undefined;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
export interface ListPhoneNumbersV2Response {
|
|
66
|
+
/**
|
|
67
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
NextToken?: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>Information about phone numbers that have been claimed to your Amazon Connect instances
|
|
73
|
+
* or traffic distribution groups.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
ListPhoneNumbersSummaryList?: ListPhoneNumbersSummary[] | undefined;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export interface ListPredefinedAttributesRequest {
|
|
82
|
+
/**
|
|
83
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
84
|
+
* Name (ARN) of the instance.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
InstanceId: string | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
90
|
+
* the next request to retrieve the next set of results.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
NextToken?: string | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The maximum number of results to return per page. </p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
MaxResults?: number | undefined;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* <p>Summary of a predefined attribute.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export interface PredefinedAttributeSummary {
|
|
105
|
+
/**
|
|
106
|
+
* <p>The name of the predefined attribute.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
Name?: string | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* <p>Last modified time.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
LastModifiedTime?: Date | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* <p>Last modified region.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
LastModifiedRegion?: string | undefined;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
export interface ListPredefinedAttributesResponse {
|
|
125
|
+
/**
|
|
126
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
NextToken?: string | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>Summary of the predefined attributes.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
PredefinedAttributeSummaryList?: PredefinedAttributeSummary[] | undefined;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export interface ListPromptsRequest {
|
|
140
|
+
/**
|
|
141
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
InstanceId: string | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
147
|
+
* the next request to retrieve the next set of results.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
NextToken?: string | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
MaxResults?: number | undefined;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* <p>Contains information about the prompt.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export interface PromptSummary {
|
|
162
|
+
/**
|
|
163
|
+
* <p>The identifier of the prompt.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
Id?: string | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
Arn?: string | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* <p>The name of the prompt.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
Name?: string | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
LastModifiedTime?: Date | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
LastModifiedRegion?: string | undefined;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
export interface ListPromptsResponse {
|
|
192
|
+
/**
|
|
193
|
+
* <p>Information about the prompts.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
PromptSummaryList?: PromptSummary[] | undefined;
|
|
197
|
+
/**
|
|
198
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
NextToken?: string | undefined;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
export interface ListQueueQuickConnectsRequest {
|
|
207
|
+
/**
|
|
208
|
+
* <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>
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
InstanceId: string | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>The identifier for the queue.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
QueueId: string | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
219
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
NextToken?: string | undefined;
|
|
223
|
+
/**
|
|
224
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
MaxResults?: number | undefined;
|
|
228
|
+
}
|
|
5
229
|
/**
|
|
6
230
|
* <p>Contains summary information about a quick connect.</p>
|
|
7
231
|
* @public
|
|
@@ -6493,197 +6717,6 @@ export interface UpdatePhoneNumberRequest {
|
|
|
6493
6717
|
*/
|
|
6494
6718
|
ClientToken?: string | undefined;
|
|
6495
6719
|
}
|
|
6496
|
-
/**
|
|
6497
|
-
* @public
|
|
6498
|
-
*/
|
|
6499
|
-
export interface UpdatePhoneNumberResponse {
|
|
6500
|
-
/**
|
|
6501
|
-
* <p>A unique identifier for the phone number.</p>
|
|
6502
|
-
* @public
|
|
6503
|
-
*/
|
|
6504
|
-
PhoneNumberId?: string | undefined;
|
|
6505
|
-
/**
|
|
6506
|
-
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
6507
|
-
* @public
|
|
6508
|
-
*/
|
|
6509
|
-
PhoneNumberArn?: string | undefined;
|
|
6510
|
-
}
|
|
6511
|
-
/**
|
|
6512
|
-
* @public
|
|
6513
|
-
*/
|
|
6514
|
-
export interface UpdatePhoneNumberMetadataRequest {
|
|
6515
|
-
/**
|
|
6516
|
-
* <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
|
|
6517
|
-
* @public
|
|
6518
|
-
*/
|
|
6519
|
-
PhoneNumberId: string | undefined;
|
|
6520
|
-
/**
|
|
6521
|
-
* <p>The description of the phone number.</p>
|
|
6522
|
-
* @public
|
|
6523
|
-
*/
|
|
6524
|
-
PhoneNumberDescription?: string | undefined;
|
|
6525
|
-
/**
|
|
6526
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6527
|
-
* request. If not provided, the Amazon Web Services
|
|
6528
|
-
* SDK populates this field. For more information about idempotency, see
|
|
6529
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6530
|
-
* @public
|
|
6531
|
-
*/
|
|
6532
|
-
ClientToken?: string | undefined;
|
|
6533
|
-
}
|
|
6534
|
-
/**
|
|
6535
|
-
* @public
|
|
6536
|
-
*/
|
|
6537
|
-
export interface UpdatePredefinedAttributeRequest {
|
|
6538
|
-
/**
|
|
6539
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
6540
|
-
* Name (ARN) of the instance.</p>
|
|
6541
|
-
* @public
|
|
6542
|
-
*/
|
|
6543
|
-
InstanceId: string | undefined;
|
|
6544
|
-
/**
|
|
6545
|
-
* <p>The name of the predefined attribute.</p>
|
|
6546
|
-
* @public
|
|
6547
|
-
*/
|
|
6548
|
-
Name: string | undefined;
|
|
6549
|
-
/**
|
|
6550
|
-
* <p>The values of the predefined attribute.</p>
|
|
6551
|
-
* @public
|
|
6552
|
-
*/
|
|
6553
|
-
Values?: PredefinedAttributeValues | undefined;
|
|
6554
|
-
}
|
|
6555
|
-
/**
|
|
6556
|
-
* @public
|
|
6557
|
-
*/
|
|
6558
|
-
export interface UpdatePromptRequest {
|
|
6559
|
-
/**
|
|
6560
|
-
* <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>
|
|
6561
|
-
* @public
|
|
6562
|
-
*/
|
|
6563
|
-
InstanceId: string | undefined;
|
|
6564
|
-
/**
|
|
6565
|
-
* <p>A unique identifier for the prompt.</p>
|
|
6566
|
-
* @public
|
|
6567
|
-
*/
|
|
6568
|
-
PromptId: string | undefined;
|
|
6569
|
-
/**
|
|
6570
|
-
* <p>The name of the prompt.</p>
|
|
6571
|
-
* @public
|
|
6572
|
-
*/
|
|
6573
|
-
Name?: string | undefined;
|
|
6574
|
-
/**
|
|
6575
|
-
* <p>A description of the prompt.</p>
|
|
6576
|
-
* @public
|
|
6577
|
-
*/
|
|
6578
|
-
Description?: string | undefined;
|
|
6579
|
-
/**
|
|
6580
|
-
* <p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the
|
|
6581
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a>
|
|
6582
|
-
* API instead of providing S3 URIs.</p>
|
|
6583
|
-
* @public
|
|
6584
|
-
*/
|
|
6585
|
-
S3Uri?: string | undefined;
|
|
6586
|
-
}
|
|
6587
|
-
/**
|
|
6588
|
-
* @public
|
|
6589
|
-
*/
|
|
6590
|
-
export interface UpdatePromptResponse {
|
|
6591
|
-
/**
|
|
6592
|
-
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
6593
|
-
* @public
|
|
6594
|
-
*/
|
|
6595
|
-
PromptARN?: string | undefined;
|
|
6596
|
-
/**
|
|
6597
|
-
* <p>A unique identifier for the prompt.</p>
|
|
6598
|
-
* @public
|
|
6599
|
-
*/
|
|
6600
|
-
PromptId?: string | undefined;
|
|
6601
|
-
}
|
|
6602
|
-
/**
|
|
6603
|
-
* @public
|
|
6604
|
-
*/
|
|
6605
|
-
export interface UpdateQueueHoursOfOperationRequest {
|
|
6606
|
-
/**
|
|
6607
|
-
* <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>
|
|
6608
|
-
* @public
|
|
6609
|
-
*/
|
|
6610
|
-
InstanceId: string | undefined;
|
|
6611
|
-
/**
|
|
6612
|
-
* <p>The identifier for the queue.</p>
|
|
6613
|
-
* @public
|
|
6614
|
-
*/
|
|
6615
|
-
QueueId: string | undefined;
|
|
6616
|
-
/**
|
|
6617
|
-
* <p>The identifier for the hours of operation.</p>
|
|
6618
|
-
* @public
|
|
6619
|
-
*/
|
|
6620
|
-
HoursOfOperationId: string | undefined;
|
|
6621
|
-
}
|
|
6622
|
-
/**
|
|
6623
|
-
* @public
|
|
6624
|
-
*/
|
|
6625
|
-
export interface UpdateQueueMaxContactsRequest {
|
|
6626
|
-
/**
|
|
6627
|
-
* <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>
|
|
6628
|
-
* @public
|
|
6629
|
-
*/
|
|
6630
|
-
InstanceId: string | undefined;
|
|
6631
|
-
/**
|
|
6632
|
-
* <p>The identifier for the queue.</p>
|
|
6633
|
-
* @public
|
|
6634
|
-
*/
|
|
6635
|
-
QueueId: string | undefined;
|
|
6636
|
-
/**
|
|
6637
|
-
* <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
|
|
6638
|
-
* @public
|
|
6639
|
-
*/
|
|
6640
|
-
MaxContacts?: number | undefined;
|
|
6641
|
-
}
|
|
6642
|
-
/**
|
|
6643
|
-
* @public
|
|
6644
|
-
*/
|
|
6645
|
-
export interface UpdateQueueNameRequest {
|
|
6646
|
-
/**
|
|
6647
|
-
* <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>
|
|
6648
|
-
* @public
|
|
6649
|
-
*/
|
|
6650
|
-
InstanceId: string | undefined;
|
|
6651
|
-
/**
|
|
6652
|
-
* <p>The identifier for the queue.</p>
|
|
6653
|
-
* @public
|
|
6654
|
-
*/
|
|
6655
|
-
QueueId: string | undefined;
|
|
6656
|
-
/**
|
|
6657
|
-
* <p>The name of the queue.</p>
|
|
6658
|
-
* @public
|
|
6659
|
-
*/
|
|
6660
|
-
Name?: string | undefined;
|
|
6661
|
-
/**
|
|
6662
|
-
* <p>The description of the queue.</p>
|
|
6663
|
-
* @public
|
|
6664
|
-
*/
|
|
6665
|
-
Description?: string | undefined;
|
|
6666
|
-
}
|
|
6667
|
-
/**
|
|
6668
|
-
* @public
|
|
6669
|
-
*/
|
|
6670
|
-
export interface UpdateQueueOutboundCallerConfigRequest {
|
|
6671
|
-
/**
|
|
6672
|
-
* <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>
|
|
6673
|
-
* @public
|
|
6674
|
-
*/
|
|
6675
|
-
InstanceId: string | undefined;
|
|
6676
|
-
/**
|
|
6677
|
-
* <p>The identifier for the queue.</p>
|
|
6678
|
-
* @public
|
|
6679
|
-
*/
|
|
6680
|
-
QueueId: string | undefined;
|
|
6681
|
-
/**
|
|
6682
|
-
* <p>The outbound caller ID name, number, and outbound whisper flow.</p>
|
|
6683
|
-
* @public
|
|
6684
|
-
*/
|
|
6685
|
-
OutboundCallerConfig: OutboundCallerConfig | undefined;
|
|
6686
|
-
}
|
|
6687
6720
|
/**
|
|
6688
6721
|
* @internal
|
|
6689
6722
|
*/
|
|
@@ -1,6 +1,197 @@
|
|
|
1
|
-
import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormQuestion, EvaluationFormScoringStrategy, InitiateAs, MediaConcurrency, OutboundEmailConfig, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
|
|
2
|
-
import { AnsweringMachineDetectionStatus, AttributeCondition, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, QueueStatus, RoutingCriteriaStepStatus, SignInConfig, TelephonyConfig, WisdomInfo } from "./models_1";
|
|
1
|
+
import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormQuestion, EvaluationFormScoringStrategy, InitiateAs, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, PredefinedAttributeValues, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
|
|
2
|
+
import { AnsweringMachineDetectionStatus, AttributeCondition, ContactDetails, ContactEvaluation, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, QueueStatus, RecordingInfo, RoutingCriteriaStepStatus, SignInConfig, TelephonyConfig, WisdomInfo } from "./models_1";
|
|
3
3
|
import { ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface UpdatePhoneNumberResponse {
|
|
8
|
+
/**
|
|
9
|
+
* <p>A unique identifier for the phone number.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
PhoneNumberId?: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
PhoneNumberArn?: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdatePhoneNumberMetadataRequest {
|
|
23
|
+
/**
|
|
24
|
+
* <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
PhoneNumberId: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <p>The description of the phone number.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
PhoneNumberDescription?: string | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
35
|
+
* request. If not provided, the Amazon Web Services
|
|
36
|
+
* SDK populates this field. For more information about idempotency, see
|
|
37
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
ClientToken?: string | undefined;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
export interface UpdatePredefinedAttributeRequest {
|
|
46
|
+
/**
|
|
47
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
48
|
+
* Name (ARN) of the instance.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
InstanceId: string | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* <p>The name of the predefined attribute.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
Name: string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The values of the predefined attribute.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
Values?: PredefinedAttributeValues | undefined;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface UpdatePromptRequest {
|
|
67
|
+
/**
|
|
68
|
+
* <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>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
InstanceId: string | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* <p>A unique identifier for the prompt.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
PromptId: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The name of the prompt.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
Name?: string | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>A description of the prompt.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
Description?: string | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* <p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the
|
|
89
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a>
|
|
90
|
+
* API instead of providing S3 URIs.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
S3Uri?: string | undefined;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface UpdatePromptResponse {
|
|
99
|
+
/**
|
|
100
|
+
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
PromptARN?: string | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>A unique identifier for the prompt.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
PromptId?: string | undefined;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export interface UpdateQueueHoursOfOperationRequest {
|
|
114
|
+
/**
|
|
115
|
+
* <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>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
InstanceId: string | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>The identifier for the queue.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
QueueId: string | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* <p>The identifier for the hours of operation.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
HoursOfOperationId: string | undefined;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export interface UpdateQueueMaxContactsRequest {
|
|
134
|
+
/**
|
|
135
|
+
* <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>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
InstanceId: string | undefined;
|
|
139
|
+
/**
|
|
140
|
+
* <p>The identifier for the queue.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
QueueId: string | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
MaxContacts?: number | undefined;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export interface UpdateQueueNameRequest {
|
|
154
|
+
/**
|
|
155
|
+
* <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>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
InstanceId: string | undefined;
|
|
159
|
+
/**
|
|
160
|
+
* <p>The identifier for the queue.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
QueueId: string | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>The name of the queue.</p>
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
Name?: string | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* <p>The description of the queue.</p>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
Description?: string | undefined;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
export interface UpdateQueueOutboundCallerConfigRequest {
|
|
179
|
+
/**
|
|
180
|
+
* <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>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
InstanceId: string | undefined;
|
|
184
|
+
/**
|
|
185
|
+
* <p>The identifier for the queue.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
QueueId: string | undefined;
|
|
189
|
+
/**
|
|
190
|
+
* <p>The outbound caller ID name, number, and outbound whisper flow.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
OutboundCallerConfig: OutboundCallerConfig | undefined;
|
|
194
|
+
}
|
|
4
195
|
/**
|
|
5
196
|
* @public
|
|
6
197
|
*/
|
|
@@ -962,8 +1153,8 @@ export interface CreateContactRequest {
|
|
|
962
1153
|
/**
|
|
963
1154
|
* <p>The channel for the contact</p>
|
|
964
1155
|
* <important>
|
|
965
|
-
* <p>CreateContact only supports the EMAIL and VOICE channels. The following information that
|
|
966
|
-
* channels are supported is incorrect. We are working to update this topic.</p>
|
|
1156
|
+
* <p>CreateContact only supports the EMAIL and VOICE channels. The following information that
|
|
1157
|
+
* states other channels are supported is incorrect. We are working to update this topic.</p>
|
|
967
1158
|
* </important>
|
|
968
1159
|
* @public
|
|
969
1160
|
*/
|
|
@@ -974,8 +1165,7 @@ export interface CreateContactRequest {
|
|
|
974
1165
|
* <p>CreateContact only supports the following initiation methods: </p>
|
|
975
1166
|
* <ul>
|
|
976
1167
|
* <li>
|
|
977
|
-
* <p>For EMAIL: OUTBOUND, AGENT_REPLY, and
|
|
978
|
-
* FLOW. </p>
|
|
1168
|
+
* <p>For EMAIL: OUTBOUND, AGENT_REPLY, and FLOW. </p>
|
|
979
1169
|
* </li>
|
|
980
1170
|
* <li>
|
|
981
1171
|
* <p>For VOICE: TRANSFER and the subtype connect:ExternalAudio. </p>
|
|
@@ -1030,7 +1220,8 @@ export interface CreateContactRequest {
|
|
|
1030
1220
|
/**
|
|
1031
1221
|
* <p>The ID of the previous contact when creating a transfer contact. This value can be provided
|
|
1032
1222
|
* only for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Integrate Amazon Connect Contact Lens
|
|
1033
|
-
* with external voice systems</a> in the <i>Amazon Connect Administrator
|
|
1223
|
+
* with external voice systems</a> in the <i>Amazon Connect Administrator
|
|
1224
|
+
* Guide</i>.</p>
|
|
1034
1225
|
* @public
|
|
1035
1226
|
*/
|
|
1036
1227
|
PreviousContactId?: string | undefined;
|
|
@@ -2938,6 +3129,33 @@ export interface Contact {
|
|
|
2938
3129
|
* @public
|
|
2939
3130
|
*/
|
|
2940
3131
|
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
3132
|
+
/**
|
|
3133
|
+
* <p>If recording was enabled, this is information about the recordings.</p>
|
|
3134
|
+
* @public
|
|
3135
|
+
*/
|
|
3136
|
+
Recordings?: RecordingInfo[] | undefined;
|
|
3137
|
+
/**
|
|
3138
|
+
* <p>The disconnect reason for the contact.</p>
|
|
3139
|
+
* @public
|
|
3140
|
+
*/
|
|
3141
|
+
DisconnectReason?: string | undefined;
|
|
3142
|
+
/**
|
|
3143
|
+
* <p>Information about the contact evaluations where the key is the FormId, which is a unique
|
|
3144
|
+
* identifier for the form.</p>
|
|
3145
|
+
* @public
|
|
3146
|
+
*/
|
|
3147
|
+
ContactEvaluations?: Record<string, ContactEvaluation> | undefined;
|
|
3148
|
+
/**
|
|
3149
|
+
* <p>A map of string key/value pairs that contain user-defined attributes which are lightly typed
|
|
3150
|
+
* within the contact. This object is used only for task contacts.</p>
|
|
3151
|
+
* @public
|
|
3152
|
+
*/
|
|
3153
|
+
ContactDetails?: ContactDetails | undefined;
|
|
3154
|
+
/**
|
|
3155
|
+
* <p>The attributes of the contact.</p>
|
|
3156
|
+
* @public
|
|
3157
|
+
*/
|
|
3158
|
+
Attributes?: Record<string, string> | undefined;
|
|
2941
3159
|
}
|
|
2942
3160
|
/**
|
|
2943
3161
|
* @public
|