@aws-sdk/client-connect 3.703.0 → 3.711.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 +74 -2
- package/dist-cjs/index.js +583 -109
- package/dist-es/Connect.js +18 -0
- package/dist-es/commands/CreateContactCommand.js +1 -1
- package/dist-es/commands/CreateHoursOfOperationOverrideCommand.js +22 -0
- package/dist-es/commands/CreatePushNotificationRegistrationCommand.js +22 -0
- package/dist-es/commands/DeleteHoursOfOperationOverrideCommand.js +22 -0
- package/dist-es/commands/DeletePushNotificationRegistrationCommand.js +22 -0
- package/dist-es/commands/DescribeHoursOfOperationOverrideCommand.js +22 -0
- package/dist-es/commands/GetEffectiveHoursOfOperationsCommand.js +22 -0
- package/dist-es/commands/ListHoursOfOperationOverridesCommand.js +22 -0
- package/dist-es/commands/SearchHoursOfOperationOverridesCommand.js +22 -0
- package/dist-es/commands/UpdateHoursOfOperationOverrideCommand.js +22 -0
- package/dist-es/commands/UpdateUserIdentityInfoCommand.js +1 -1
- package/dist-es/commands/UpdateViewContentCommand.js +1 -1
- package/dist-es/commands/UpdateViewMetadataCommand.js +1 -1
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +14 -0
- package/dist-es/models/models_1.js +0 -33
- package/dist-es/models/models_2.js +53 -45
- package/dist-es/models/models_3.js +32 -0
- package/dist-es/pagination/ListHoursOfOperationOverridesPaginator.js +4 -0
- package/dist-es/pagination/SearchHoursOfOperationOverridesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +280 -1
- package/dist-types/Connect.d.ts +65 -2
- package/dist-types/ConnectClient.d.ts +13 -4
- package/dist-types/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +111 -0
- package/dist-types/commands/CreatePushNotificationRegistrationCommand.d.ts +101 -0
- package/dist-types/commands/CreateQueueCommand.d.ts +1 -2
- package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +87 -0
- package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +86 -0
- package/dist-types/commands/DeleteTaskTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUseCaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +1 -2
- package/dist-types/commands/DescribeHoursOfOperationOverrideCommand.d.ts +109 -0
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -2
- package/dist-types/commands/GetEffectiveHoursOfOperationsCommand.d.ts +106 -0
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +2 -3
- package/dist-types/commands/ListHoursOfOperationOverridesCommand.d.ts +115 -0
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -2
- package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +4 -0
- package/dist-types/commands/SearchHoursOfOperationOverridesCommand.d.ts +168 -0
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +2 -2
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateHoursOfOperationOverrideCommand.d.ts +109 -0
- package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserHierarchyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserProficienciesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateViewContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateViewMetadataCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +250 -154
- package/dist-types/models/models_1.d.ts +384 -496
- package/dist-types/models/models_2.d.ts +3508 -3653
- package/dist-types/models/models_3.d.ts +791 -7
- package/dist-types/pagination/ListHoursOfOperationOverridesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchHoursOfOperationOverridesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +81 -0
- package/dist-types/ts3.4/Connect.d.ts +165 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateHoursOfOperationOverrideCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreatePushNotificationRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteHoursOfOperationOverrideCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteTaskTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteUseCaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeHoursOfOperationOverrideCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetEffectiveHoursOfOperationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListHoursOfOperationOverridesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchHoursOfOperationOverridesCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/UpdateHoursOfOperationOverrideCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserHierarchyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserProficienciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateViewContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateViewMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +64 -37
- package/dist-types/ts3.4/models/models_1.d.ts +87 -142
- package/dist-types/ts3.4/models/models_2.d.ts +185 -212
- package/dist-types/ts3.4/models/models_3.d.ts +218 -5
- package/dist-types/ts3.4/pagination/ListHoursOfOperationOverridesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchHoursOfOperationOverridesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +108 -0
- package/package.json +35 -35
|
@@ -1,6 +1,156 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig,
|
|
3
|
+
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface DeleteTaskTemplateRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <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>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
InstanceId: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>A unique identifier for the task template.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
TaskTemplateId: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteTaskTemplateResponse {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export interface DeleteTrafficDistributionGroupRequest {
|
|
28
|
+
/**
|
|
29
|
+
* <p>The identifier of the traffic distribution group.
|
|
30
|
+
* This can be the ID or the ARN of the traffic distribution group.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
TrafficDistributionGroupId: string | undefined;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
export interface DeleteTrafficDistributionGroupResponse {
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export interface DeleteUseCaseRequest {
|
|
44
|
+
/**
|
|
45
|
+
* <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>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
InstanceId: string | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* <p>The identifier for the integration association.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
IntegrationAssociationId: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The identifier for the use case.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
UseCaseId: string | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export interface DeleteUserRequest {
|
|
64
|
+
/**
|
|
65
|
+
* <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>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
InstanceId: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The identifier of the user.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
UserId: string | undefined;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export interface DeleteUserHierarchyGroupRequest {
|
|
79
|
+
/**
|
|
80
|
+
* <p>The identifier of the hierarchy group.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
HierarchyGroupId: string | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* <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>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
InstanceId: string | undefined;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export interface DeleteViewRequest {
|
|
94
|
+
/**
|
|
95
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
96
|
+
* the instance.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
InstanceId: string | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
102
|
+
* used.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
ViewId: string | undefined;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export interface DeleteViewResponse {
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export interface DeleteViewVersionRequest {
|
|
116
|
+
/**
|
|
117
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
118
|
+
* the instance.</p>
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
InstanceId: string | undefined;
|
|
122
|
+
/**
|
|
123
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
124
|
+
* used.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
ViewId: string | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* <p>The version number of the view.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
ViewVersion: number | undefined;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export interface DeleteViewVersionResponse {
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
export interface DeleteVocabularyRequest {
|
|
143
|
+
/**
|
|
144
|
+
* <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>
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
InstanceId: string | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
VocabularyId: string | undefined;
|
|
153
|
+
}
|
|
4
154
|
/**
|
|
5
155
|
* @public
|
|
6
156
|
*/
|
|
@@ -1003,6 +1153,83 @@ export interface DescribeHoursOfOperationResponse {
|
|
|
1003
1153
|
*/
|
|
1004
1154
|
HoursOfOperation?: HoursOfOperation | undefined;
|
|
1005
1155
|
}
|
|
1156
|
+
/**
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
export interface DescribeHoursOfOperationOverrideRequest {
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
InstanceId: string | undefined;
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>The identifier for the hours of operation.</p>
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
HoursOfOperationId: string | undefined;
|
|
1170
|
+
/**
|
|
1171
|
+
* <p>The identifier for the hours of operation override.</p>
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
HoursOfOperationOverrideId: string | undefined;
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
* <p>Information about the hours of operations override.</p>
|
|
1178
|
+
* @public
|
|
1179
|
+
*/
|
|
1180
|
+
export interface HoursOfOperationOverride {
|
|
1181
|
+
/**
|
|
1182
|
+
* <p>The identifier for the hours of operation override.</p>
|
|
1183
|
+
* @public
|
|
1184
|
+
*/
|
|
1185
|
+
HoursOfOperationOverrideId?: string | undefined;
|
|
1186
|
+
/**
|
|
1187
|
+
* <p>The identifier for the hours of operation.</p>
|
|
1188
|
+
* @public
|
|
1189
|
+
*/
|
|
1190
|
+
HoursOfOperationId?: string | undefined;
|
|
1191
|
+
/**
|
|
1192
|
+
* <p>The Amazon Resource Name (ARN) for the hours of operation.</p>
|
|
1193
|
+
* @public
|
|
1194
|
+
*/
|
|
1195
|
+
HoursOfOperationArn?: string | undefined;
|
|
1196
|
+
/**
|
|
1197
|
+
* <p>The name of the hours of operation override.</p>
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1200
|
+
Name?: string | undefined;
|
|
1201
|
+
/**
|
|
1202
|
+
* <p>The description of the hours of operation override.</p>
|
|
1203
|
+
* @public
|
|
1204
|
+
*/
|
|
1205
|
+
Description?: string | undefined;
|
|
1206
|
+
/**
|
|
1207
|
+
* <p>Configuration information for the hours of operation override: day, start time, and end
|
|
1208
|
+
* time.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
Config?: HoursOfOperationOverrideConfig[] | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* <p>The date from which the hours of operation override would be effective.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
EffectiveFrom?: string | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>The date till which the hours of operation override would be effective.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
EffectiveTill?: string | undefined;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
export interface DescribeHoursOfOperationOverrideResponse {
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>Information about the hours of operations override. </p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
HoursOfOperationOverride?: HoursOfOperationOverride | undefined;
|
|
1232
|
+
}
|
|
1006
1233
|
/**
|
|
1007
1234
|
* @public
|
|
1008
1235
|
*/
|
|
@@ -1704,8 +1931,9 @@ export interface ClaimedPhoneNumberSummary {
|
|
|
1704
1931
|
PhoneNumberStatus?: PhoneNumberStatus | undefined;
|
|
1705
1932
|
/**
|
|
1706
1933
|
* <p>The claimed phone number ARN that was previously imported from the external service, such as
|
|
1707
|
-
*
|
|
1708
|
-
* that was imported from Amazon Web Services End User
|
|
1934
|
+
* Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
|
|
1935
|
+
* looks like the ARN of the phone number that was imported from Amazon Web Services End User
|
|
1936
|
+
* Messaging.</p>
|
|
1709
1937
|
* @public
|
|
1710
1938
|
*/
|
|
1711
1939
|
SourcePhoneNumberArn?: string | undefined;
|
|
@@ -2912,11 +3140,13 @@ export interface DisassociateFlowRequest {
|
|
|
2912
3140
|
* <p>The identifier of the resource.</p>
|
|
2913
3141
|
* <ul>
|
|
2914
3142
|
* <li>
|
|
2915
|
-
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
3143
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
3144
|
+
* <code>SMS_PHONE_NUMBER</code>
|
|
2916
3145
|
* </p>
|
|
2917
3146
|
* </li>
|
|
2918
3147
|
* <li>
|
|
2919
|
-
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
3148
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
3149
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
2920
3150
|
* </p>
|
|
2921
3151
|
* </li>
|
|
2922
3152
|
* </ul>
|
|
@@ -3937,6 +4167,78 @@ export interface GetCurrentUserDataResponse {
|
|
|
3937
4167
|
*/
|
|
3938
4168
|
ApproximateTotalCount?: number | undefined;
|
|
3939
4169
|
}
|
|
4170
|
+
/**
|
|
4171
|
+
* @public
|
|
4172
|
+
*/
|
|
4173
|
+
export interface GetEffectiveHoursOfOperationsRequest {
|
|
4174
|
+
/**
|
|
4175
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
4176
|
+
* @public
|
|
4177
|
+
*/
|
|
4178
|
+
InstanceId: string | undefined;
|
|
4179
|
+
/**
|
|
4180
|
+
* <p>The identifier for the hours of operation.</p>
|
|
4181
|
+
* @public
|
|
4182
|
+
*/
|
|
4183
|
+
HoursOfOperationId: string | undefined;
|
|
4184
|
+
/**
|
|
4185
|
+
* <p>The Date from when the hours of operation are listed.</p>
|
|
4186
|
+
* @public
|
|
4187
|
+
*/
|
|
4188
|
+
FromDate: string | undefined;
|
|
4189
|
+
/**
|
|
4190
|
+
* <p>The Date until when the hours of operation are listed.</p>
|
|
4191
|
+
* @public
|
|
4192
|
+
*/
|
|
4193
|
+
ToDate: string | undefined;
|
|
4194
|
+
}
|
|
4195
|
+
/**
|
|
4196
|
+
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
4197
|
+
* @public
|
|
4198
|
+
*/
|
|
4199
|
+
export interface OperationalHour {
|
|
4200
|
+
/**
|
|
4201
|
+
* <p>The start time that your contact center opens.</p>
|
|
4202
|
+
* @public
|
|
4203
|
+
*/
|
|
4204
|
+
Start?: OverrideTimeSlice | undefined;
|
|
4205
|
+
/**
|
|
4206
|
+
* <p>The end time that your contact center closes.</p>
|
|
4207
|
+
* @public
|
|
4208
|
+
*/
|
|
4209
|
+
End?: OverrideTimeSlice | undefined;
|
|
4210
|
+
}
|
|
4211
|
+
/**
|
|
4212
|
+
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
4213
|
+
* @public
|
|
4214
|
+
*/
|
|
4215
|
+
export interface EffectiveHoursOfOperations {
|
|
4216
|
+
/**
|
|
4217
|
+
* <p>The date that the hours of operation or overrides applies to.</p>
|
|
4218
|
+
* @public
|
|
4219
|
+
*/
|
|
4220
|
+
Date?: string | undefined;
|
|
4221
|
+
/**
|
|
4222
|
+
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
4223
|
+
* @public
|
|
4224
|
+
*/
|
|
4225
|
+
OperationalHours?: OperationalHour[] | undefined;
|
|
4226
|
+
}
|
|
4227
|
+
/**
|
|
4228
|
+
* @public
|
|
4229
|
+
*/
|
|
4230
|
+
export interface GetEffectiveHoursOfOperationsResponse {
|
|
4231
|
+
/**
|
|
4232
|
+
* <p>Information about the effective hours of operations</p>
|
|
4233
|
+
* @public
|
|
4234
|
+
*/
|
|
4235
|
+
EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined;
|
|
4236
|
+
/**
|
|
4237
|
+
* <p>The time zone for the hours of operation.</p>
|
|
4238
|
+
* @public
|
|
4239
|
+
*/
|
|
4240
|
+
TimeZone?: string | undefined;
|
|
4241
|
+
}
|
|
3940
4242
|
/**
|
|
3941
4243
|
* @public
|
|
3942
4244
|
*/
|
|
@@ -4024,11 +4326,13 @@ export interface GetFlowAssociationRequest {
|
|
|
4024
4326
|
* <p>The identifier of the resource.</p>
|
|
4025
4327
|
* <ul>
|
|
4026
4328
|
* <li>
|
|
4027
|
-
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
4329
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
4330
|
+
* <code>SMS_PHONE_NUMBER</code>
|
|
4028
4331
|
* </p>
|
|
4029
4332
|
* </li>
|
|
4030
4333
|
* <li>
|
|
4031
|
-
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
4334
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
4335
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
4032
4336
|
* </p>
|
|
4033
4337
|
* </li>
|
|
4034
4338
|
* </ul>
|
|
@@ -4558,18 +4862,14 @@ export interface MetricFilterV2 {
|
|
|
4558
4862
|
* <p>For valid values of the metric-level filter <code>FLOWS_OUTCOME_TYPE</code>, see the
|
|
4559
4863
|
* description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flow outcome</a> metric in the <i>Amazon Connect Administrator
|
|
4560
4864
|
* Guide</i>.</p>
|
|
4561
|
-
* <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see
|
|
4562
|
-
* description for the
|
|
4563
|
-
*
|
|
4564
|
-
*
|
|
4565
|
-
* in the <i>Amazon Connect Administrator
|
|
4566
|
-
* Guide</i>.</p>
|
|
4567
|
-
* <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the description for
|
|
4568
|
-
* the
|
|
4569
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents completed</a>
|
|
4570
|
-
*
|
|
4571
|
-
* metric in the <i>Amazon Connect Administrator
|
|
4865
|
+
* <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see
|
|
4866
|
+
* the description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot
|
|
4867
|
+
* conversations completed</a> in the <i>Amazon Connect Administrator
|
|
4572
4868
|
* Guide</i>.</p>
|
|
4869
|
+
* <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the
|
|
4870
|
+
* description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents
|
|
4871
|
+
* completed</a> metric in the <i>Amazon Connect Administrator
|
|
4872
|
+
* Guide</i>.</p>
|
|
4573
4873
|
* @public
|
|
4574
4874
|
*/
|
|
4575
4875
|
MetricFilterValues?: string[] | undefined;
|
|
@@ -6102,8 +6402,8 @@ export interface ImportPhoneNumberRequest {
|
|
|
6102
6402
|
*/
|
|
6103
6403
|
InstanceId: string | undefined;
|
|
6104
6404
|
/**
|
|
6105
|
-
* <p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks
|
|
6106
|
-
* import from Amazon Web Services End User Messaging.</p>
|
|
6405
|
+
* <p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks
|
|
6406
|
+
* like the ARN of the phone number to import from Amazon Web Services End User Messaging.</p>
|
|
6107
6407
|
* @public
|
|
6108
6408
|
*/
|
|
6109
6409
|
SourcePhoneNumberArn: string | undefined;
|
|
@@ -7425,31 +7725,84 @@ export interface ListFlowAssociationsResponse {
|
|
|
7425
7725
|
/**
|
|
7426
7726
|
* @public
|
|
7427
7727
|
*/
|
|
7428
|
-
export interface
|
|
7728
|
+
export interface ListHoursOfOperationOverridesRequest {
|
|
7429
7729
|
/**
|
|
7430
|
-
* <p>The identifier of the Amazon Connect instance
|
|
7730
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
7431
7731
|
* @public
|
|
7432
7732
|
*/
|
|
7433
7733
|
InstanceId: string | undefined;
|
|
7434
7734
|
/**
|
|
7435
|
-
* <p>The
|
|
7436
|
-
*
|
|
7735
|
+
* <p>The identifier for the hours of operation</p>
|
|
7736
|
+
* @public
|
|
7737
|
+
*/
|
|
7738
|
+
HoursOfOperationId: string | undefined;
|
|
7739
|
+
/**
|
|
7740
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
7741
|
+
* the next request to retrieve the next set of results.</p>
|
|
7437
7742
|
* @public
|
|
7438
7743
|
*/
|
|
7439
7744
|
NextToken?: string | undefined;
|
|
7440
7745
|
/**
|
|
7441
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100
|
|
7746
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100. Valid
|
|
7747
|
+
* Range: Minimum value of 1. Maximum value of 1000.</p>
|
|
7442
7748
|
* @public
|
|
7443
7749
|
*/
|
|
7444
7750
|
MaxResults?: number | undefined;
|
|
7445
7751
|
}
|
|
7446
7752
|
/**
|
|
7447
|
-
* <p>Contains summary information about hours of operation for a contact center.</p>
|
|
7448
7753
|
* @public
|
|
7449
7754
|
*/
|
|
7450
|
-
export interface
|
|
7755
|
+
export interface ListHoursOfOperationOverridesResponse {
|
|
7451
7756
|
/**
|
|
7452
|
-
* <p>The
|
|
7757
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
7758
|
+
* the next request to retrieve the next set of results.</p>
|
|
7759
|
+
* @public
|
|
7760
|
+
*/
|
|
7761
|
+
NextToken?: string | undefined;
|
|
7762
|
+
/**
|
|
7763
|
+
* <p>Information about the hours of operation override.</p>
|
|
7764
|
+
* @public
|
|
7765
|
+
*/
|
|
7766
|
+
HoursOfOperationOverrideList?: HoursOfOperationOverride[] | undefined;
|
|
7767
|
+
/**
|
|
7768
|
+
* <p>The AWS Region where this resource was last modified.</p>
|
|
7769
|
+
* @public
|
|
7770
|
+
*/
|
|
7771
|
+
LastModifiedRegion?: string | undefined;
|
|
7772
|
+
/**
|
|
7773
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
7774
|
+
* @public
|
|
7775
|
+
*/
|
|
7776
|
+
LastModifiedTime?: Date | undefined;
|
|
7777
|
+
}
|
|
7778
|
+
/**
|
|
7779
|
+
* @public
|
|
7780
|
+
*/
|
|
7781
|
+
export interface ListHoursOfOperationsRequest {
|
|
7782
|
+
/**
|
|
7783
|
+
* <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>
|
|
7784
|
+
* @public
|
|
7785
|
+
*/
|
|
7786
|
+
InstanceId: string | undefined;
|
|
7787
|
+
/**
|
|
7788
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7789
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
7790
|
+
* @public
|
|
7791
|
+
*/
|
|
7792
|
+
NextToken?: string | undefined;
|
|
7793
|
+
/**
|
|
7794
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
7795
|
+
* @public
|
|
7796
|
+
*/
|
|
7797
|
+
MaxResults?: number | undefined;
|
|
7798
|
+
}
|
|
7799
|
+
/**
|
|
7800
|
+
* <p>Contains summary information about hours of operation for a contact center.</p>
|
|
7801
|
+
* @public
|
|
7802
|
+
*/
|
|
7803
|
+
export interface HoursOfOperationSummary {
|
|
7804
|
+
/**
|
|
7805
|
+
* <p>The identifier of the hours of operation.</p>
|
|
7453
7806
|
* @public
|
|
7454
7807
|
*/
|
|
7455
7808
|
Id?: string | undefined;
|
|
@@ -7999,8 +8352,9 @@ export interface ListPhoneNumbersSummary {
|
|
|
7999
8352
|
PhoneNumberDescription?: string | undefined;
|
|
8000
8353
|
/**
|
|
8001
8354
|
* <p>The claimed phone number ARN that was previously imported from the external service, such as
|
|
8002
|
-
*
|
|
8003
|
-
* that was imported from Amazon Web Services End User
|
|
8355
|
+
* Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
|
|
8356
|
+
* looks like the ARN of the phone number that was imported from Amazon Web Services End User
|
|
8357
|
+
* Messaging.</p>
|
|
8004
8358
|
* @public
|
|
8005
8359
|
*/
|
|
8006
8360
|
SourcePhoneNumberArn?: string | undefined;
|
|
@@ -8393,472 +8747,6 @@ export declare const RealTimeContactAnalysisSegmentType: {
|
|
|
8393
8747
|
* @public
|
|
8394
8748
|
*/
|
|
8395
8749
|
export type RealTimeContactAnalysisSegmentType = (typeof RealTimeContactAnalysisSegmentType)[keyof typeof RealTimeContactAnalysisSegmentType];
|
|
8396
|
-
/**
|
|
8397
|
-
* @public
|
|
8398
|
-
*/
|
|
8399
|
-
export interface ListRealtimeContactAnalysisSegmentsV2Request {
|
|
8400
|
-
/**
|
|
8401
|
-
* <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>
|
|
8402
|
-
* @public
|
|
8403
|
-
*/
|
|
8404
|
-
InstanceId: string | undefined;
|
|
8405
|
-
/**
|
|
8406
|
-
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
8407
|
-
* @public
|
|
8408
|
-
*/
|
|
8409
|
-
ContactId: string | undefined;
|
|
8410
|
-
/**
|
|
8411
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8412
|
-
* @public
|
|
8413
|
-
*/
|
|
8414
|
-
MaxResults?: number | undefined;
|
|
8415
|
-
/**
|
|
8416
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8417
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8418
|
-
* @public
|
|
8419
|
-
*/
|
|
8420
|
-
NextToken?: string | undefined;
|
|
8421
|
-
/**
|
|
8422
|
-
* <p>The Contact Lens output type to be returned.</p>
|
|
8423
|
-
* @public
|
|
8424
|
-
*/
|
|
8425
|
-
OutputType: RealTimeContactAnalysisOutputType | undefined;
|
|
8426
|
-
/**
|
|
8427
|
-
* <p>Enum with segment types . Each value corresponds to a segment type returned in the segments
|
|
8428
|
-
* list of the API. Each segment type has its own structure. Different channels may have different
|
|
8429
|
-
* sets of supported segment types.</p>
|
|
8430
|
-
* @public
|
|
8431
|
-
*/
|
|
8432
|
-
SegmentTypes: RealTimeContactAnalysisSegmentType[] | undefined;
|
|
8433
|
-
}
|
|
8434
|
-
/**
|
|
8435
|
-
* @public
|
|
8436
|
-
* @enum
|
|
8437
|
-
*/
|
|
8438
|
-
export declare const RealTimeContactAnalysisSupportedChannel: {
|
|
8439
|
-
readonly CHAT: "CHAT";
|
|
8440
|
-
readonly VOICE: "VOICE";
|
|
8441
|
-
};
|
|
8442
|
-
/**
|
|
8443
|
-
* @public
|
|
8444
|
-
*/
|
|
8445
|
-
export type RealTimeContactAnalysisSupportedChannel = (typeof RealTimeContactAnalysisSupportedChannel)[keyof typeof RealTimeContactAnalysisSupportedChannel];
|
|
8446
|
-
/**
|
|
8447
|
-
* @public
|
|
8448
|
-
* @enum
|
|
8449
|
-
*/
|
|
8450
|
-
export declare const ArtifactStatus: {
|
|
8451
|
-
readonly APPROVED: "APPROVED";
|
|
8452
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
8453
|
-
readonly REJECTED: "REJECTED";
|
|
8454
|
-
};
|
|
8455
|
-
/**
|
|
8456
|
-
* @public
|
|
8457
|
-
*/
|
|
8458
|
-
export type ArtifactStatus = (typeof ArtifactStatus)[keyof typeof ArtifactStatus];
|
|
8459
|
-
/**
|
|
8460
|
-
* <p>Object that describes attached file. </p>
|
|
8461
|
-
* @public
|
|
8462
|
-
*/
|
|
8463
|
-
export interface RealTimeContactAnalysisAttachment {
|
|
8464
|
-
/**
|
|
8465
|
-
* <p>A case-sensitive name of the attachment being uploaded. Can be redacted.</p>
|
|
8466
|
-
* @public
|
|
8467
|
-
*/
|
|
8468
|
-
AttachmentName: string | undefined;
|
|
8469
|
-
/**
|
|
8470
|
-
* <p>Describes the MIME file type of the attachment. For a list of supported file types, see
|
|
8471
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html">Feature
|
|
8472
|
-
* specifications</a> in the <i>Amazon Connect Administrator
|
|
8473
|
-
* Guide</i>.</p>
|
|
8474
|
-
* @public
|
|
8475
|
-
*/
|
|
8476
|
-
ContentType?: string | undefined;
|
|
8477
|
-
/**
|
|
8478
|
-
* <p>A unique identifier for the attachment.</p>
|
|
8479
|
-
* @public
|
|
8480
|
-
*/
|
|
8481
|
-
AttachmentId: string | undefined;
|
|
8482
|
-
/**
|
|
8483
|
-
* <p>Status of the attachment.</p>
|
|
8484
|
-
* @public
|
|
8485
|
-
*/
|
|
8486
|
-
Status?: ArtifactStatus | undefined;
|
|
8487
|
-
}
|
|
8488
|
-
/**
|
|
8489
|
-
* <p>Object describing time with which the segment is associated. It can have different
|
|
8490
|
-
* representations of time. Currently supported: absoluteTime</p>
|
|
8491
|
-
* @public
|
|
8492
|
-
*/
|
|
8493
|
-
export type RealTimeContactAnalysisTimeData = RealTimeContactAnalysisTimeData.AbsoluteTimeMember | RealTimeContactAnalysisTimeData.$UnknownMember;
|
|
8494
|
-
/**
|
|
8495
|
-
* @public
|
|
8496
|
-
*/
|
|
8497
|
-
export declare namespace RealTimeContactAnalysisTimeData {
|
|
8498
|
-
/**
|
|
8499
|
-
* <p>Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
8500
|
-
* 2019-11-08T02:41:28.172Z.</p>
|
|
8501
|
-
* @public
|
|
8502
|
-
*/
|
|
8503
|
-
interface AbsoluteTimeMember {
|
|
8504
|
-
AbsoluteTime: Date;
|
|
8505
|
-
$unknown?: never;
|
|
8506
|
-
}
|
|
8507
|
-
/**
|
|
8508
|
-
* @public
|
|
8509
|
-
*/
|
|
8510
|
-
interface $UnknownMember {
|
|
8511
|
-
AbsoluteTime?: never;
|
|
8512
|
-
$unknown: [string, any];
|
|
8513
|
-
}
|
|
8514
|
-
interface Visitor<T> {
|
|
8515
|
-
AbsoluteTime: (value: Date) => T;
|
|
8516
|
-
_: (name: string, value: any) => T;
|
|
8517
|
-
}
|
|
8518
|
-
const visit: <T>(value: RealTimeContactAnalysisTimeData, visitor: Visitor<T>) => T;
|
|
8519
|
-
}
|
|
8520
|
-
/**
|
|
8521
|
-
* <p>Segment containing list of attachments.</p>
|
|
8522
|
-
* @public
|
|
8523
|
-
*/
|
|
8524
|
-
export interface RealTimeContactAnalysisSegmentAttachments {
|
|
8525
|
-
/**
|
|
8526
|
-
* <p>The identifier of the segment.</p>
|
|
8527
|
-
* @public
|
|
8528
|
-
*/
|
|
8529
|
-
Id: string | undefined;
|
|
8530
|
-
/**
|
|
8531
|
-
* <p>The identifier of the participant.</p>
|
|
8532
|
-
* @public
|
|
8533
|
-
*/
|
|
8534
|
-
ParticipantId: string | undefined;
|
|
8535
|
-
/**
|
|
8536
|
-
* <p>The role of the participant. For example, is it a customer, agent, or system.</p>
|
|
8537
|
-
* @public
|
|
8538
|
-
*/
|
|
8539
|
-
ParticipantRole: ParticipantRole | undefined;
|
|
8540
|
-
/**
|
|
8541
|
-
* <p>The display name of the participant. Can be redacted. </p>
|
|
8542
|
-
* @public
|
|
8543
|
-
*/
|
|
8544
|
-
DisplayName?: string | undefined;
|
|
8545
|
-
/**
|
|
8546
|
-
* <p>List of objects describing an individual attachment.</p>
|
|
8547
|
-
* @public
|
|
8548
|
-
*/
|
|
8549
|
-
Attachments: RealTimeContactAnalysisAttachment[] | undefined;
|
|
8550
|
-
/**
|
|
8551
|
-
* <p>Field describing the time of the event. It can have different representations of time.</p>
|
|
8552
|
-
* @public
|
|
8553
|
-
*/
|
|
8554
|
-
Time: RealTimeContactAnalysisTimeData | undefined;
|
|
8555
|
-
}
|
|
8556
|
-
/**
|
|
8557
|
-
* <p>Begin and end offsets for a part of text.</p>
|
|
8558
|
-
* @public
|
|
8559
|
-
*/
|
|
8560
|
-
export interface RealTimeContactAnalysisCharacterInterval {
|
|
8561
|
-
/**
|
|
8562
|
-
* <p>The beginning of the character interval.</p>
|
|
8563
|
-
* @public
|
|
8564
|
-
*/
|
|
8565
|
-
BeginOffsetChar: number | undefined;
|
|
8566
|
-
/**
|
|
8567
|
-
* <p>The end of the character interval.</p>
|
|
8568
|
-
* @public
|
|
8569
|
-
*/
|
|
8570
|
-
EndOffsetChar: number | undefined;
|
|
8571
|
-
}
|
|
8572
|
-
/**
|
|
8573
|
-
* <p>Transcript representation containing Id and list of character intervals that are associated
|
|
8574
|
-
* with analysis data. For example, this object within a
|
|
8575
|
-
* <code>RealTimeContactAnalysisPointOfInterest</code> in <code>Category.MatchedDetails</code>
|
|
8576
|
-
* would have character interval describing part of the text that matched category.</p>
|
|
8577
|
-
* @public
|
|
8578
|
-
*/
|
|
8579
|
-
export interface RealTimeContactAnalysisTranscriptItemWithCharacterOffsets {
|
|
8580
|
-
/**
|
|
8581
|
-
* <p>Transcript identifier. Matches the identifier from one of the TranscriptSegments.</p>
|
|
8582
|
-
* @public
|
|
8583
|
-
*/
|
|
8584
|
-
Id: string | undefined;
|
|
8585
|
-
/**
|
|
8586
|
-
* <p>List of character intervals within transcript content/text.</p>
|
|
8587
|
-
* @public
|
|
8588
|
-
*/
|
|
8589
|
-
CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined;
|
|
8590
|
-
}
|
|
8591
|
-
/**
|
|
8592
|
-
* <p>The section of the contact transcript segment that category rule was detected.</p>
|
|
8593
|
-
* @public
|
|
8594
|
-
*/
|
|
8595
|
-
export interface RealTimeContactAnalysisPointOfInterest {
|
|
8596
|
-
/**
|
|
8597
|
-
* <p>List of the transcript items (segments) that are associated with a given point of interest.
|
|
8598
|
-
* </p>
|
|
8599
|
-
* @public
|
|
8600
|
-
*/
|
|
8601
|
-
TranscriptItems?: RealTimeContactAnalysisTranscriptItemWithCharacterOffsets[] | undefined;
|
|
8602
|
-
}
|
|
8603
|
-
/**
|
|
8604
|
-
* <p>Provides information about the category rule that was matched.</p>
|
|
8605
|
-
* @public
|
|
8606
|
-
*/
|
|
8607
|
-
export interface RealTimeContactAnalysisCategoryDetails {
|
|
8608
|
-
/**
|
|
8609
|
-
* <p>List of PointOfInterest - objects describing a single match of a rule.</p>
|
|
8610
|
-
* @public
|
|
8611
|
-
*/
|
|
8612
|
-
PointsOfInterest: RealTimeContactAnalysisPointOfInterest[] | undefined;
|
|
8613
|
-
}
|
|
8614
|
-
/**
|
|
8615
|
-
* <p>The matched category rules.</p>
|
|
8616
|
-
* @public
|
|
8617
|
-
*/
|
|
8618
|
-
export interface RealTimeContactAnalysisSegmentCategories {
|
|
8619
|
-
/**
|
|
8620
|
-
* <p>Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.</p>
|
|
8621
|
-
* @public
|
|
8622
|
-
*/
|
|
8623
|
-
MatchedDetails: Record<string, RealTimeContactAnalysisCategoryDetails> | undefined;
|
|
8624
|
-
}
|
|
8625
|
-
/**
|
|
8626
|
-
* <p>Segment type describing a contact event.</p>
|
|
8627
|
-
* @public
|
|
8628
|
-
*/
|
|
8629
|
-
export interface RealTimeContactAnalysisSegmentEvent {
|
|
8630
|
-
/**
|
|
8631
|
-
* <p>The identifier of the contact event.</p>
|
|
8632
|
-
* @public
|
|
8633
|
-
*/
|
|
8634
|
-
Id: string | undefined;
|
|
8635
|
-
/**
|
|
8636
|
-
* <p>The identifier of the participant.</p>
|
|
8637
|
-
* @public
|
|
8638
|
-
*/
|
|
8639
|
-
ParticipantId?: string | undefined;
|
|
8640
|
-
/**
|
|
8641
|
-
* <p>The role of the participant. For example, is it a customer, agent, or system.</p>
|
|
8642
|
-
* @public
|
|
8643
|
-
*/
|
|
8644
|
-
ParticipantRole?: ParticipantRole | undefined;
|
|
8645
|
-
/**
|
|
8646
|
-
* <p>The display name of the participant. Can be redacted.</p>
|
|
8647
|
-
* @public
|
|
8648
|
-
*/
|
|
8649
|
-
DisplayName?: string | undefined;
|
|
8650
|
-
/**
|
|
8651
|
-
* <p>Type of the event. For example,
|
|
8652
|
-
* <code>application/vnd.amazonaws.connect.event.participant.left</code>.</p>
|
|
8653
|
-
* @public
|
|
8654
|
-
*/
|
|
8655
|
-
EventType: string | undefined;
|
|
8656
|
-
/**
|
|
8657
|
-
* <p>Field describing the time of the event. It can have different representations of time.</p>
|
|
8658
|
-
* @public
|
|
8659
|
-
*/
|
|
8660
|
-
Time: RealTimeContactAnalysisTimeData | undefined;
|
|
8661
|
-
}
|
|
8662
|
-
/**
|
|
8663
|
-
* <p>Transcript representation containing Id, Content and list of character intervals that are
|
|
8664
|
-
* associated with analysis data. For example, this object within an issue detected would describe
|
|
8665
|
-
* both content that contains identified issue and intervals where that content is taken
|
|
8666
|
-
* from.</p>
|
|
8667
|
-
* @public
|
|
8668
|
-
*/
|
|
8669
|
-
export interface RealTimeContactAnalysisTranscriptItemWithContent {
|
|
8670
|
-
/**
|
|
8671
|
-
* <p>Part of the transcript content that contains identified issue. Can be redacted</p>
|
|
8672
|
-
* @public
|
|
8673
|
-
*/
|
|
8674
|
-
Content?: string | undefined;
|
|
8675
|
-
/**
|
|
8676
|
-
* <p>Transcript identifier. Matches the identifier from one of the TranscriptSegments.</p>
|
|
8677
|
-
* @public
|
|
8678
|
-
*/
|
|
8679
|
-
Id: string | undefined;
|
|
8680
|
-
/**
|
|
8681
|
-
* <p>Begin and end offsets for a part of text.</p>
|
|
8682
|
-
* @public
|
|
8683
|
-
*/
|
|
8684
|
-
CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined;
|
|
8685
|
-
}
|
|
8686
|
-
/**
|
|
8687
|
-
* <p>Potential issues that are detected based on an artificial intelligence analysis of each turn
|
|
8688
|
-
* in the conversation.</p>
|
|
8689
|
-
* @public
|
|
8690
|
-
*/
|
|
8691
|
-
export interface RealTimeContactAnalysisIssueDetected {
|
|
8692
|
-
/**
|
|
8693
|
-
* <p>List of the transcript items (segments) that are associated with a given issue.</p>
|
|
8694
|
-
* @public
|
|
8695
|
-
*/
|
|
8696
|
-
TranscriptItems: RealTimeContactAnalysisTranscriptItemWithContent[] | undefined;
|
|
8697
|
-
}
|
|
8698
|
-
/**
|
|
8699
|
-
* <p>Segment type containing a list of detected issues.</p>
|
|
8700
|
-
* @public
|
|
8701
|
-
*/
|
|
8702
|
-
export interface RealTimeContactAnalysisSegmentIssues {
|
|
8703
|
-
/**
|
|
8704
|
-
* <p>List of the issues detected.</p>
|
|
8705
|
-
* @public
|
|
8706
|
-
*/
|
|
8707
|
-
IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined;
|
|
8708
|
-
}
|
|
8709
|
-
/**
|
|
8710
|
-
* @public
|
|
8711
|
-
* @enum
|
|
8712
|
-
*/
|
|
8713
|
-
export declare const RealTimeContactAnalysisPostContactSummaryFailureCode: {
|
|
8714
|
-
readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
|
|
8715
|
-
readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
|
|
8716
|
-
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
8717
|
-
readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
|
|
8718
|
-
readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
|
|
8719
|
-
};
|
|
8720
|
-
/**
|
|
8721
|
-
* @public
|
|
8722
|
-
*/
|
|
8723
|
-
export type RealTimeContactAnalysisPostContactSummaryFailureCode = (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode];
|
|
8724
|
-
/**
|
|
8725
|
-
* @public
|
|
8726
|
-
* @enum
|
|
8727
|
-
*/
|
|
8728
|
-
export declare const RealTimeContactAnalysisPostContactSummaryStatus: {
|
|
8729
|
-
readonly COMPLETED: "COMPLETED";
|
|
8730
|
-
readonly FAILED: "FAILED";
|
|
8731
|
-
};
|
|
8732
|
-
/**
|
|
8733
|
-
* @public
|
|
8734
|
-
*/
|
|
8735
|
-
export type RealTimeContactAnalysisPostContactSummaryStatus = (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus];
|
|
8736
|
-
/**
|
|
8737
|
-
* <p>Information about the post-contact summary for a real-time contact segment.</p>
|
|
8738
|
-
* @public
|
|
8739
|
-
*/
|
|
8740
|
-
export interface RealTimeContactAnalysisSegmentPostContactSummary {
|
|
8741
|
-
/**
|
|
8742
|
-
* <p>The content of the summary.</p>
|
|
8743
|
-
* @public
|
|
8744
|
-
*/
|
|
8745
|
-
Content?: string | undefined;
|
|
8746
|
-
/**
|
|
8747
|
-
* <p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>
|
|
8748
|
-
* @public
|
|
8749
|
-
*/
|
|
8750
|
-
Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
|
|
8751
|
-
/**
|
|
8752
|
-
* <p>If the summary failed to be generated, one of the following failure codes occurs:</p>
|
|
8753
|
-
* <ul>
|
|
8754
|
-
* <li>
|
|
8755
|
-
* <p>
|
|
8756
|
-
* <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service
|
|
8757
|
-
* quota.</p>
|
|
8758
|
-
* </li>
|
|
8759
|
-
* <li>
|
|
8760
|
-
* <p>
|
|
8761
|
-
* <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least
|
|
8762
|
-
* one turn from both the participants in order to generate the summary.</p>
|
|
8763
|
-
* </li>
|
|
8764
|
-
* <li>
|
|
8765
|
-
* <p>
|
|
8766
|
-
* <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it
|
|
8767
|
-
* failed to meet system safety guidelines.</p>
|
|
8768
|
-
* </li>
|
|
8769
|
-
* <li>
|
|
8770
|
-
* <p>
|
|
8771
|
-
* <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're
|
|
8772
|
-
* using a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a> that isn't supported by generative AI-powered post-contact summaries.
|
|
8773
|
-
* </p>
|
|
8774
|
-
* </li>
|
|
8775
|
-
* <li>
|
|
8776
|
-
* <p>
|
|
8777
|
-
* <code>INTERNAL_ERROR</code>: Internal system error.</p>
|
|
8778
|
-
* </li>
|
|
8779
|
-
* </ul>
|
|
8780
|
-
* @public
|
|
8781
|
-
*/
|
|
8782
|
-
FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode | undefined;
|
|
8783
|
-
}
|
|
8784
|
-
/**
|
|
8785
|
-
* <p>Object describing redaction applied to the segment.</p>
|
|
8786
|
-
* @public
|
|
8787
|
-
*/
|
|
8788
|
-
export interface RealTimeContactAnalysisTranscriptItemRedaction {
|
|
8789
|
-
/**
|
|
8790
|
-
* <p>List of character intervals each describing a part of the text that was redacted. For
|
|
8791
|
-
* <code>OutputType.Raw</code>, part of the original text that contains data that can be redacted.
|
|
8792
|
-
* For <code> OutputType.Redacted</code>, part of the string with redaction tag.</p>
|
|
8793
|
-
* @public
|
|
8794
|
-
*/
|
|
8795
|
-
CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined;
|
|
8796
|
-
}
|
|
8797
|
-
/**
|
|
8798
|
-
* @public
|
|
8799
|
-
* @enum
|
|
8800
|
-
*/
|
|
8801
|
-
export declare const RealTimeContactAnalysisSentimentLabel: {
|
|
8802
|
-
readonly NEGATIVE: "NEGATIVE";
|
|
8803
|
-
readonly NEUTRAL: "NEUTRAL";
|
|
8804
|
-
readonly POSITIVE: "POSITIVE";
|
|
8805
|
-
};
|
|
8806
|
-
/**
|
|
8807
|
-
* @public
|
|
8808
|
-
*/
|
|
8809
|
-
export type RealTimeContactAnalysisSentimentLabel = (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel];
|
|
8810
|
-
/**
|
|
8811
|
-
* <p>The analyzed transcript segment.</p>
|
|
8812
|
-
* @public
|
|
8813
|
-
*/
|
|
8814
|
-
export interface RealTimeContactAnalysisSegmentTranscript {
|
|
8815
|
-
/**
|
|
8816
|
-
* <p>The identifier of the transcript.</p>
|
|
8817
|
-
* @public
|
|
8818
|
-
*/
|
|
8819
|
-
Id: string | undefined;
|
|
8820
|
-
/**
|
|
8821
|
-
* <p>The identifier of the participant.</p>
|
|
8822
|
-
* @public
|
|
8823
|
-
*/
|
|
8824
|
-
ParticipantId: string | undefined;
|
|
8825
|
-
/**
|
|
8826
|
-
* <p>The role of the participant. For example, is it a customer, agent, or system.</p>
|
|
8827
|
-
* @public
|
|
8828
|
-
*/
|
|
8829
|
-
ParticipantRole: ParticipantRole | undefined;
|
|
8830
|
-
/**
|
|
8831
|
-
* <p>The display name of the participant.</p>
|
|
8832
|
-
* @public
|
|
8833
|
-
*/
|
|
8834
|
-
DisplayName?: string | undefined;
|
|
8835
|
-
/**
|
|
8836
|
-
* <p>The content of the transcript. Can be redacted.</p>
|
|
8837
|
-
* @public
|
|
8838
|
-
*/
|
|
8839
|
-
Content: string | undefined;
|
|
8840
|
-
/**
|
|
8841
|
-
* <p>The type of content of the item. For example, <code>text/plain</code>.</p>
|
|
8842
|
-
* @public
|
|
8843
|
-
*/
|
|
8844
|
-
ContentType?: string | undefined;
|
|
8845
|
-
/**
|
|
8846
|
-
* <p>Field describing the time of the event. It can have different representations of time.</p>
|
|
8847
|
-
* @public
|
|
8848
|
-
*/
|
|
8849
|
-
Time: RealTimeContactAnalysisTimeData | undefined;
|
|
8850
|
-
/**
|
|
8851
|
-
* <p>Object describing redaction that was applied to the transcript. If transcript has the field
|
|
8852
|
-
* it means part of the transcript was redacted.</p>
|
|
8853
|
-
* @public
|
|
8854
|
-
*/
|
|
8855
|
-
Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined;
|
|
8856
|
-
/**
|
|
8857
|
-
* <p>The sentiment detected for this piece of transcript.</p>
|
|
8858
|
-
* @public
|
|
8859
|
-
*/
|
|
8860
|
-
Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined;
|
|
8861
|
-
}
|
|
8862
8750
|
/**
|
|
8863
8751
|
* @internal
|
|
8864
8752
|
*/
|