@aws-sdk/client-connect 3.709.0 → 3.712.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/README.md +56 -0
  2. package/dist-cjs/index.js +471 -95
  3. package/dist-es/Connect.js +14 -0
  4. package/dist-es/commands/CreateHoursOfOperationOverrideCommand.js +22 -0
  5. package/dist-es/commands/DeleteHoursOfOperationOverrideCommand.js +22 -0
  6. package/dist-es/commands/DescribeHoursOfOperationOverrideCommand.js +22 -0
  7. package/dist-es/commands/GetEffectiveHoursOfOperationsCommand.js +22 -0
  8. package/dist-es/commands/ListHoursOfOperationOverridesCommand.js +22 -0
  9. package/dist-es/commands/SearchHoursOfOperationOverridesCommand.js +22 -0
  10. package/dist-es/commands/UpdateHoursOfOperationOverrideCommand.js +22 -0
  11. package/dist-es/commands/UpdateUserIdentityInfoCommand.js +1 -1
  12. package/dist-es/commands/UpdateViewContentCommand.js +1 -1
  13. package/dist-es/commands/UpdateViewMetadataCommand.js +1 -1
  14. package/dist-es/commands/index.js +7 -0
  15. package/dist-es/models/models_0.js +9 -0
  16. package/dist-es/models/models_1.js +0 -17
  17. package/dist-es/models/models_2.js +37 -40
  18. package/dist-es/models/models_3.js +27 -0
  19. package/dist-es/pagination/ListHoursOfOperationOverridesPaginator.js +4 -0
  20. package/dist-es/pagination/SearchHoursOfOperationOverridesPaginator.js +4 -0
  21. package/dist-es/pagination/index.js +2 -0
  22. package/dist-es/protocols/Aws_restJson1.js +225 -1
  23. package/dist-types/Connect.d.ts +49 -0
  24. package/dist-types/ConnectClient.d.ts +9 -2
  25. package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +111 -0
  26. package/dist-types/commands/CreateQueueCommand.d.ts +1 -2
  27. package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +87 -0
  28. package/dist-types/commands/DeleteTaskTemplateCommand.d.ts +1 -1
  29. package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
  30. package/dist-types/commands/DeleteUseCaseCommand.d.ts +1 -1
  31. package/dist-types/commands/DeleteUserCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribeHoursOfOperationOverrideCommand.d.ts +109 -0
  33. package/dist-types/commands/GetEffectiveHoursOfOperationsCommand.d.ts +106 -0
  34. package/dist-types/commands/ListHoursOfOperationOverridesCommand.d.ts +115 -0
  35. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -2
  36. package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +4 -0
  37. package/dist-types/commands/SearchHoursOfOperationOverridesCommand.d.ts +168 -0
  38. package/dist-types/commands/UpdateHoursOfOperationOverrideCommand.d.ts +109 -0
  39. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +1 -1
  40. package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +2 -1
  41. package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
  42. package/dist-types/commands/UpdateUserHierarchyCommand.d.ts +1 -1
  43. package/dist-types/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
  44. package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
  45. package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
  46. package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
  47. package/dist-types/commands/UpdateUserProficienciesCommand.d.ts +1 -1
  48. package/dist-types/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
  49. package/dist-types/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
  50. package/dist-types/commands/UpdateViewContentCommand.d.ts +1 -1
  51. package/dist-types/commands/UpdateViewMetadataCommand.d.ts +1 -1
  52. package/dist-types/commands/index.d.ts +7 -0
  53. package/dist-types/models/models_0.d.ts +134 -73
  54. package/dist-types/models/models_1.d.ts +274 -314
  55. package/dist-types/models/models_2.d.ts +443 -486
  56. package/dist-types/models/models_3.d.ts +532 -3
  57. package/dist-types/pagination/ListHoursOfOperationOverridesPaginator.d.ts +7 -0
  58. package/dist-types/pagination/SearchHoursOfOperationOverridesPaginator.d.ts +7 -0
  59. package/dist-types/pagination/index.d.ts +2 -0
  60. package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
  61. package/dist-types/ts3.4/Connect.d.ts +119 -0
  62. package/dist-types/ts3.4/ConnectClient.d.ts +42 -0
  63. package/dist-types/ts3.4/commands/CreateHoursOfOperationOverrideCommand.d.ts +51 -0
  64. package/dist-types/ts3.4/commands/DeleteHoursOfOperationOverrideCommand.d.ts +47 -0
  65. package/dist-types/ts3.4/commands/DeleteTaskTemplateCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/DeleteUseCaseCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/DescribeHoursOfOperationOverrideCommand.d.ts +51 -0
  70. package/dist-types/ts3.4/commands/GetEffectiveHoursOfOperationsCommand.d.ts +51 -0
  71. package/dist-types/ts3.4/commands/ListHoursOfOperationOverridesCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +4 -2
  73. package/dist-types/ts3.4/commands/SearchHoursOfOperationOverridesCommand.d.ts +49 -0
  74. package/dist-types/ts3.4/commands/UpdateHoursOfOperationOverrideCommand.d.ts +47 -0
  75. package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts +2 -4
  76. package/dist-types/ts3.4/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/UpdateUserHierarchyCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/UpdateUserProficienciesCommand.d.ts +1 -1
  83. package/dist-types/ts3.4/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
  84. package/dist-types/ts3.4/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
  85. package/dist-types/ts3.4/commands/UpdateViewContentCommand.d.ts +1 -1
  86. package/dist-types/ts3.4/commands/UpdateViewMetadataCommand.d.ts +1 -1
  87. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  88. package/dist-types/ts3.4/models/models_0.d.ts +36 -18
  89. package/dist-types/ts3.4/models/models_1.d.ts +68 -99
  90. package/dist-types/ts3.4/models/models_2.d.ts +142 -157
  91. package/dist-types/ts3.4/models/models_3.d.ts +163 -2
  92. package/dist-types/ts3.4/pagination/ListHoursOfOperationOverridesPaginator.d.ts +11 -0
  93. package/dist-types/ts3.4/pagination/SearchHoursOfOperationOverridesPaginator.d.ts +11 -0
  94. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  95. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
  96. package/package.json +5 -5
@@ -1,6 +1,77 @@
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, ParticipantCapabilities, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
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
+ }
4
75
  /**
5
76
  * @public
6
77
  */
@@ -1082,6 +1153,83 @@ export interface DescribeHoursOfOperationResponse {
1082
1153
  */
1083
1154
  HoursOfOperation?: HoursOfOperation | undefined;
1084
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
+ }
1085
1233
  /**
1086
1234
  * @public
1087
1235
  */
@@ -4019,6 +4167,78 @@ export interface GetCurrentUserDataResponse {
4019
4167
  */
4020
4168
  ApproximateTotalCount?: number | undefined;
4021
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
+ }
4022
4242
  /**
4023
4243
  * @public
4024
4244
  */
@@ -7502,6 +7722,59 @@ export interface ListFlowAssociationsResponse {
7502
7722
  */
7503
7723
  NextToken?: string | undefined;
7504
7724
  }
7725
+ /**
7726
+ * @public
7727
+ */
7728
+ export interface ListHoursOfOperationOverridesRequest {
7729
+ /**
7730
+ * <p>The identifier of the Amazon Connect instance.</p>
7731
+ * @public
7732
+ */
7733
+ InstanceId: string | undefined;
7734
+ /**
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>
7742
+ * @public
7743
+ */
7744
+ NextToken?: string | undefined;
7745
+ /**
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>
7748
+ * @public
7749
+ */
7750
+ MaxResults?: number | undefined;
7751
+ }
7752
+ /**
7753
+ * @public
7754
+ */
7755
+ export interface ListHoursOfOperationOverridesResponse {
7756
+ /**
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
+ }
7505
7778
  /**
7506
7779
  * @public
7507
7780
  */
@@ -8474,319 +8747,6 @@ export declare const RealTimeContactAnalysisSegmentType: {
8474
8747
  * @public
8475
8748
  */
8476
8749
  export type RealTimeContactAnalysisSegmentType = (typeof RealTimeContactAnalysisSegmentType)[keyof typeof RealTimeContactAnalysisSegmentType];
8477
- /**
8478
- * @public
8479
- */
8480
- export interface ListRealtimeContactAnalysisSegmentsV2Request {
8481
- /**
8482
- * <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>
8483
- * @public
8484
- */
8485
- InstanceId: string | undefined;
8486
- /**
8487
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
8488
- * @public
8489
- */
8490
- ContactId: string | undefined;
8491
- /**
8492
- * <p>The maximum number of results to return per page.</p>
8493
- * @public
8494
- */
8495
- MaxResults?: number | undefined;
8496
- /**
8497
- * <p>The token for the next set of results. Use the value returned in the previous
8498
- * response in the next request to retrieve the next set of results.</p>
8499
- * @public
8500
- */
8501
- NextToken?: string | undefined;
8502
- /**
8503
- * <p>The Contact Lens output type to be returned.</p>
8504
- * @public
8505
- */
8506
- OutputType: RealTimeContactAnalysisOutputType | undefined;
8507
- /**
8508
- * <p>Enum with segment types . Each value corresponds to a segment type returned in the segments
8509
- * list of the API. Each segment type has its own structure. Different channels may have different
8510
- * sets of supported segment types.</p>
8511
- * @public
8512
- */
8513
- SegmentTypes: RealTimeContactAnalysisSegmentType[] | undefined;
8514
- }
8515
- /**
8516
- * @public
8517
- * @enum
8518
- */
8519
- export declare const RealTimeContactAnalysisSupportedChannel: {
8520
- readonly CHAT: "CHAT";
8521
- readonly VOICE: "VOICE";
8522
- };
8523
- /**
8524
- * @public
8525
- */
8526
- export type RealTimeContactAnalysisSupportedChannel = (typeof RealTimeContactAnalysisSupportedChannel)[keyof typeof RealTimeContactAnalysisSupportedChannel];
8527
- /**
8528
- * @public
8529
- * @enum
8530
- */
8531
- export declare const ArtifactStatus: {
8532
- readonly APPROVED: "APPROVED";
8533
- readonly IN_PROGRESS: "IN_PROGRESS";
8534
- readonly REJECTED: "REJECTED";
8535
- };
8536
- /**
8537
- * @public
8538
- */
8539
- export type ArtifactStatus = (typeof ArtifactStatus)[keyof typeof ArtifactStatus];
8540
- /**
8541
- * <p>Object that describes attached file. </p>
8542
- * @public
8543
- */
8544
- export interface RealTimeContactAnalysisAttachment {
8545
- /**
8546
- * <p>A case-sensitive name of the attachment being uploaded. Can be redacted.</p>
8547
- * @public
8548
- */
8549
- AttachmentName: string | undefined;
8550
- /**
8551
- * <p>Describes the MIME file type of the attachment. For a list of supported file types, see
8552
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html">Feature
8553
- * specifications</a> in the <i>Amazon Connect Administrator
8554
- * Guide</i>.</p>
8555
- * @public
8556
- */
8557
- ContentType?: string | undefined;
8558
- /**
8559
- * <p>A unique identifier for the attachment.</p>
8560
- * @public
8561
- */
8562
- AttachmentId: string | undefined;
8563
- /**
8564
- * <p>Status of the attachment.</p>
8565
- * @public
8566
- */
8567
- Status?: ArtifactStatus | undefined;
8568
- }
8569
- /**
8570
- * <p>Object describing time with which the segment is associated. It can have different
8571
- * representations of time. Currently supported: absoluteTime</p>
8572
- * @public
8573
- */
8574
- export type RealTimeContactAnalysisTimeData = RealTimeContactAnalysisTimeData.AbsoluteTimeMember | RealTimeContactAnalysisTimeData.$UnknownMember;
8575
- /**
8576
- * @public
8577
- */
8578
- export declare namespace RealTimeContactAnalysisTimeData {
8579
- /**
8580
- * <p>Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
8581
- * 2019-11-08T02:41:28.172Z.</p>
8582
- * @public
8583
- */
8584
- interface AbsoluteTimeMember {
8585
- AbsoluteTime: Date;
8586
- $unknown?: never;
8587
- }
8588
- /**
8589
- * @public
8590
- */
8591
- interface $UnknownMember {
8592
- AbsoluteTime?: never;
8593
- $unknown: [string, any];
8594
- }
8595
- interface Visitor<T> {
8596
- AbsoluteTime: (value: Date) => T;
8597
- _: (name: string, value: any) => T;
8598
- }
8599
- const visit: <T>(value: RealTimeContactAnalysisTimeData, visitor: Visitor<T>) => T;
8600
- }
8601
- /**
8602
- * <p>Segment containing list of attachments.</p>
8603
- * @public
8604
- */
8605
- export interface RealTimeContactAnalysisSegmentAttachments {
8606
- /**
8607
- * <p>The identifier of the segment.</p>
8608
- * @public
8609
- */
8610
- Id: string | undefined;
8611
- /**
8612
- * <p>The identifier of the participant.</p>
8613
- * @public
8614
- */
8615
- ParticipantId: string | undefined;
8616
- /**
8617
- * <p>The role of the participant. For example, is it a customer, agent, or system.</p>
8618
- * @public
8619
- */
8620
- ParticipantRole: ParticipantRole | undefined;
8621
- /**
8622
- * <p>The display name of the participant. Can be redacted. </p>
8623
- * @public
8624
- */
8625
- DisplayName?: string | undefined;
8626
- /**
8627
- * <p>List of objects describing an individual attachment.</p>
8628
- * @public
8629
- */
8630
- Attachments: RealTimeContactAnalysisAttachment[] | undefined;
8631
- /**
8632
- * <p>Field describing the time of the event. It can have different representations of time.</p>
8633
- * @public
8634
- */
8635
- Time: RealTimeContactAnalysisTimeData | undefined;
8636
- }
8637
- /**
8638
- * <p>Begin and end offsets for a part of text.</p>
8639
- * @public
8640
- */
8641
- export interface RealTimeContactAnalysisCharacterInterval {
8642
- /**
8643
- * <p>The beginning of the character interval.</p>
8644
- * @public
8645
- */
8646
- BeginOffsetChar: number | undefined;
8647
- /**
8648
- * <p>The end of the character interval.</p>
8649
- * @public
8650
- */
8651
- EndOffsetChar: number | undefined;
8652
- }
8653
- /**
8654
- * <p>Transcript representation containing Id and list of character intervals that are associated
8655
- * with analysis data. For example, this object within a
8656
- * <code>RealTimeContactAnalysisPointOfInterest</code> in <code>Category.MatchedDetails</code>
8657
- * would have character interval describing part of the text that matched category.</p>
8658
- * @public
8659
- */
8660
- export interface RealTimeContactAnalysisTranscriptItemWithCharacterOffsets {
8661
- /**
8662
- * <p>Transcript identifier. Matches the identifier from one of the TranscriptSegments.</p>
8663
- * @public
8664
- */
8665
- Id: string | undefined;
8666
- /**
8667
- * <p>List of character intervals within transcript content/text.</p>
8668
- * @public
8669
- */
8670
- CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined;
8671
- }
8672
- /**
8673
- * <p>The section of the contact transcript segment that category rule was detected.</p>
8674
- * @public
8675
- */
8676
- export interface RealTimeContactAnalysisPointOfInterest {
8677
- /**
8678
- * <p>List of the transcript items (segments) that are associated with a given point of interest.
8679
- * </p>
8680
- * @public
8681
- */
8682
- TranscriptItems?: RealTimeContactAnalysisTranscriptItemWithCharacterOffsets[] | undefined;
8683
- }
8684
- /**
8685
- * <p>Provides information about the category rule that was matched.</p>
8686
- * @public
8687
- */
8688
- export interface RealTimeContactAnalysisCategoryDetails {
8689
- /**
8690
- * <p>List of PointOfInterest - objects describing a single match of a rule.</p>
8691
- * @public
8692
- */
8693
- PointsOfInterest: RealTimeContactAnalysisPointOfInterest[] | undefined;
8694
- }
8695
- /**
8696
- * <p>The matched category rules.</p>
8697
- * @public
8698
- */
8699
- export interface RealTimeContactAnalysisSegmentCategories {
8700
- /**
8701
- * <p>Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.</p>
8702
- * @public
8703
- */
8704
- MatchedDetails: Record<string, RealTimeContactAnalysisCategoryDetails> | undefined;
8705
- }
8706
- /**
8707
- * <p>Segment type describing a contact event.</p>
8708
- * @public
8709
- */
8710
- export interface RealTimeContactAnalysisSegmentEvent {
8711
- /**
8712
- * <p>The identifier of the contact event.</p>
8713
- * @public
8714
- */
8715
- Id: string | undefined;
8716
- /**
8717
- * <p>The identifier of the participant.</p>
8718
- * @public
8719
- */
8720
- ParticipantId?: string | undefined;
8721
- /**
8722
- * <p>The role of the participant. For example, is it a customer, agent, or system.</p>
8723
- * @public
8724
- */
8725
- ParticipantRole?: ParticipantRole | undefined;
8726
- /**
8727
- * <p>The display name of the participant. Can be redacted.</p>
8728
- * @public
8729
- */
8730
- DisplayName?: string | undefined;
8731
- /**
8732
- * <p>Type of the event. For example,
8733
- * <code>application/vnd.amazonaws.connect.event.participant.left</code>.</p>
8734
- * @public
8735
- */
8736
- EventType: string | undefined;
8737
- /**
8738
- * <p>Field describing the time of the event. It can have different representations of time.</p>
8739
- * @public
8740
- */
8741
- Time: RealTimeContactAnalysisTimeData | undefined;
8742
- }
8743
- /**
8744
- * <p>Transcript representation containing Id, Content and list of character intervals that are
8745
- * associated with analysis data. For example, this object within an issue detected would describe
8746
- * both content that contains identified issue and intervals where that content is taken
8747
- * from.</p>
8748
- * @public
8749
- */
8750
- export interface RealTimeContactAnalysisTranscriptItemWithContent {
8751
- /**
8752
- * <p>Part of the transcript content that contains identified issue. Can be redacted</p>
8753
- * @public
8754
- */
8755
- Content?: string | undefined;
8756
- /**
8757
- * <p>Transcript identifier. Matches the identifier from one of the TranscriptSegments.</p>
8758
- * @public
8759
- */
8760
- Id: string | undefined;
8761
- /**
8762
- * <p>Begin and end offsets for a part of text.</p>
8763
- * @public
8764
- */
8765
- CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined;
8766
- }
8767
- /**
8768
- * <p>Potential issues that are detected based on an artificial intelligence analysis of each turn
8769
- * in the conversation.</p>
8770
- * @public
8771
- */
8772
- export interface RealTimeContactAnalysisIssueDetected {
8773
- /**
8774
- * <p>List of the transcript items (segments) that are associated with a given issue.</p>
8775
- * @public
8776
- */
8777
- TranscriptItems: RealTimeContactAnalysisTranscriptItemWithContent[] | undefined;
8778
- }
8779
- /**
8780
- * <p>Segment type containing a list of detected issues.</p>
8781
- * @public
8782
- */
8783
- export interface RealTimeContactAnalysisSegmentIssues {
8784
- /**
8785
- * <p>List of the issues detected.</p>
8786
- * @public
8787
- */
8788
- IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined;
8789
- }
8790
8750
  /**
8791
8751
  * @internal
8792
8752
  */