@aws-sdk/client-connect 3.974.0 → 3.975.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 (92) hide show
  1. package/README.md +77 -0
  2. package/dist-cjs/index.js +548 -24
  3. package/dist-es/Connect.js +22 -0
  4. package/dist-es/commands/CreateTestCaseCommand.js +16 -0
  5. package/dist-es/commands/DeleteTestCaseCommand.js +16 -0
  6. package/dist-es/commands/DescribeTestCaseCommand.js +16 -0
  7. package/dist-es/commands/GetTestCaseExecutionSummaryCommand.js +16 -0
  8. package/dist-es/commands/ListTestCaseExecutionRecordsCommand.js +16 -0
  9. package/dist-es/commands/ListTestCaseExecutionsCommand.js +16 -0
  10. package/dist-es/commands/ListTestCasesCommand.js +16 -0
  11. package/dist-es/commands/SearchTestCasesCommand.js +16 -0
  12. package/dist-es/commands/StartTestCaseExecutionCommand.js +16 -0
  13. package/dist-es/commands/StopTestCaseExecutionCommand.js +16 -0
  14. package/dist-es/commands/UpdateTestCaseCommand.js +16 -0
  15. package/dist-es/commands/index.js +11 -0
  16. package/dist-es/models/enums.js +20 -0
  17. package/dist-es/models/errors.js +14 -0
  18. package/dist-es/pagination/ListTestCasesPaginator.js +4 -0
  19. package/dist-es/pagination/SearchTestCasesPaginator.js +4 -0
  20. package/dist-es/pagination/index.js +2 -0
  21. package/dist-es/schemas/schemas_0.js +307 -25
  22. package/dist-types/Connect.d.ts +77 -0
  23. package/dist-types/ConnectClient.d.ts +13 -2
  24. package/dist-types/commands/CreateTestCaseCommand.d.ts +127 -0
  25. package/dist-types/commands/CreateWorkspacePageCommand.d.ts +1 -1
  26. package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
  27. package/dist-types/commands/DeleteTestCaseCommand.d.ts +91 -0
  28. package/dist-types/commands/DescribeTestCaseCommand.d.ts +116 -0
  29. package/dist-types/commands/GetTestCaseExecutionSummaryCommand.d.ts +101 -0
  30. package/dist-types/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +2 -1
  31. package/dist-types/commands/ListApprovedOriginsCommand.d.ts +1 -1
  32. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +1 -1
  34. package/dist-types/commands/ListBotsCommand.d.ts +1 -1
  35. package/dist-types/commands/ListTestCaseExecutionRecordsCommand.d.ts +105 -0
  36. package/dist-types/commands/ListTestCaseExecutionsCommand.d.ts +111 -0
  37. package/dist-types/commands/ListTestCasesCommand.d.ts +104 -0
  38. package/dist-types/commands/SearchTestCasesCommand.d.ts +167 -0
  39. package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
  40. package/dist-types/commands/SendOutboundEmailCommand.d.ts +1 -1
  41. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -1
  42. package/dist-types/commands/StartChatContactCommand.d.ts +1 -2
  43. package/dist-types/commands/StartTestCaseExecutionCommand.d.ts +99 -0
  44. package/dist-types/commands/StopTestCaseExecutionCommand.d.ts +93 -0
  45. package/dist-types/commands/UpdateTestCaseCommand.d.ts +112 -0
  46. package/dist-types/commands/index.d.ts +11 -0
  47. package/dist-types/models/enums.d.ts +52 -0
  48. package/dist-types/models/errors.d.ts +17 -0
  49. package/dist-types/models/models_0.d.ts +113 -84
  50. package/dist-types/models/models_1.d.ts +267 -282
  51. package/dist-types/models/models_2.d.ts +578 -599
  52. package/dist-types/models/models_3.d.ts +774 -3
  53. package/dist-types/pagination/ListTestCasesPaginator.d.ts +7 -0
  54. package/dist-types/pagination/SearchTestCasesPaginator.d.ts +7 -0
  55. package/dist-types/pagination/index.d.ts +2 -0
  56. package/dist-types/schemas/schemas_0.d.ts +43 -0
  57. package/dist-types/ts3.4/Connect.d.ts +187 -0
  58. package/dist-types/ts3.4/ConnectClient.d.ts +66 -0
  59. package/dist-types/ts3.4/commands/CreateTestCaseCommand.d.ts +50 -0
  60. package/dist-types/ts3.4/commands/CreateWorkspacePageCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/DeleteTestCaseCommand.d.ts +50 -0
  63. package/dist-types/ts3.4/commands/DescribeTestCaseCommand.d.ts +50 -0
  64. package/dist-types/ts3.4/commands/GetTestCaseExecutionSummaryCommand.d.ts +51 -0
  65. package/dist-types/ts3.4/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +2 -4
  66. package/dist-types/ts3.4/commands/ListApprovedOriginsCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/ListAssociatedContactsCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListAuthenticationProfilesCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/ListTestCaseExecutionRecordsCommand.d.ts +51 -0
  71. package/dist-types/ts3.4/commands/ListTestCaseExecutionsCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/ListTestCasesCommand.d.ts +50 -0
  73. package/dist-types/ts3.4/commands/SearchTestCasesCommand.d.ts +48 -0
  74. package/dist-types/ts3.4/commands/SendChatIntegrationEventCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/SendOutboundEmailCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/StartAttachedFileUploadCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +4 -2
  78. package/dist-types/ts3.4/commands/StartTestCaseExecutionCommand.d.ts +51 -0
  79. package/dist-types/ts3.4/commands/StopTestCaseExecutionCommand.d.ts +51 -0
  80. package/dist-types/ts3.4/commands/UpdateTestCaseCommand.d.ts +50 -0
  81. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  82. package/dist-types/ts3.4/models/enums.d.ts +28 -0
  83. package/dist-types/ts3.4/models/errors.d.ts +8 -0
  84. package/dist-types/ts3.4/models/models_0.d.ts +28 -19
  85. package/dist-types/ts3.4/models/models_1.d.ts +65 -67
  86. package/dist-types/ts3.4/models/models_2.d.ts +137 -121
  87. package/dist-types/ts3.4/models/models_3.d.ts +167 -10
  88. package/dist-types/ts3.4/pagination/ListTestCasesPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/SearchTestCasesPaginator.d.ts +11 -0
  90. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  91. package/dist-types/ts3.4/schemas/schemas_0.d.ts +43 -0
  92. package/package.json +9 -9
@@ -1,6 +1,286 @@
1
- import { ArtifactStatus, AutoEvaluationStatus, BooleanComparisonType, Channel, ChatEventType, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InstanceStatus, InstanceStorageResourceType, IntegrationType, ListFlowAssociationResourceType, MediaType, MonitorCapability, NumberComparisonType, OutboundMessageSourceType, ParticipantRole, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RehydrationType, ResponseMode, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, SourceType, StringComparisonType, TargetListType, TaskTemplateStatus, TrafficDistributionGroupStatus, TrafficType, UseCaseType, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState } from "./enums";
2
- import { type AgentHierarchyGroups, type ControlPlaneAttributeFilter, type CreatedByInfo, type DataTableLockVersion, type StringCondition, type UserPhoneConfig, ActionSummary, AgentStatus, AliasConfiguration, Application, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, PrimaryValueResponse, SecurityProfileItem, TagCondition, UserProficiency, View } from "./models_0";
3
- import { type EvaluationContactParticipant, type EvaluationScore, Attribute, ContactFlow, ContactFlowModule, DataTable, DataTableAttribute, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, HoursOfOperationsIdentifier, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile } from "./models_1";
1
+ import { ArtifactStatus, AutoEvaluationStatus, BooleanComparisonType, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, HierarchyGroupMatchType, InstanceStatus, InstanceStorageResourceType, IntegrationType, LexVersion, ListFlowAssociationResourceType, MediaType, MonitorCapability, NumberComparisonType, ParticipantRole, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, SourceType, StringComparisonType, TargetListType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, UseCaseType, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState } from "./enums";
2
+ import { type AgentHierarchyGroups, type ControlPlaneAttributeFilter, type DataTableLockVersion, type LexV2Bot, type StringCondition, type UserPhoneConfig, ActionSummary, AgentStatus, AliasConfiguration, Application, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, PrimaryValueResponse, SecurityProfileItem, TagCondition, UserProficiency, View } from "./models_0";
3
+ import { type EvaluationContactParticipant, type EvaluationScore, AnalyticsDataSetsResult, Attribute, ContactFlow, ContactFlowModule, DataTable, DataTableAttribute, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, HoursOfOperationsIdentifier, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase } from "./models_1";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface ListAnalyticsDataLakeDataSetsResponse {
8
+ /**
9
+ * <p>An array of successful results: <code>DataSetId</code>, <code>DataSetName</code>. This is a paginated API, so
10
+ * <code>nextToken</code> is given if there are more results to be returned.</p>
11
+ * @public
12
+ */
13
+ Results?: AnalyticsDataSetsResult[] | undefined;
14
+ /**
15
+ * <p>If there are additional results, this is the token for the next set of results.</p>
16
+ * @public
17
+ */
18
+ NextToken?: string | undefined;
19
+ }
20
+ /**
21
+ * @public
22
+ */
23
+ export interface ListApprovedOriginsRequest {
24
+ /**
25
+ * <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>
26
+ * @public
27
+ */
28
+ InstanceId: string | undefined;
29
+ /**
30
+ * <p>The token for the next set of results. Use the value returned in the previous
31
+ * response in the next request to retrieve the next set of results.</p>
32
+ * @public
33
+ */
34
+ NextToken?: string | undefined;
35
+ /**
36
+ * <p>The maximum number of results to return per page.</p>
37
+ * @public
38
+ */
39
+ MaxResults?: number | undefined;
40
+ }
41
+ /**
42
+ * @public
43
+ */
44
+ export interface ListApprovedOriginsResponse {
45
+ /**
46
+ * <p>The approved origins.</p>
47
+ * @public
48
+ */
49
+ Origins?: string[] | undefined;
50
+ /**
51
+ * <p>If there are additional results, this is the token for the next set of results.</p>
52
+ * @public
53
+ */
54
+ NextToken?: string | undefined;
55
+ }
56
+ /**
57
+ * @public
58
+ */
59
+ export interface ListAssociatedContactsRequest {
60
+ /**
61
+ * <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>
62
+ * @public
63
+ */
64
+ InstanceId: string | undefined;
65
+ /**
66
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
67
+ * @public
68
+ */
69
+ ContactId: string | undefined;
70
+ /**
71
+ * <p>The maximum number of results to return per page. </p>
72
+ * @public
73
+ */
74
+ MaxResults?: number | undefined;
75
+ /**
76
+ * <p>The token for the next set of results. Use the value returned in the previous
77
+ * response in the next request to retrieve the next set of results.</p>
78
+ * @public
79
+ */
80
+ NextToken?: string | undefined;
81
+ }
82
+ /**
83
+ * <p>Contact summary of a contact in contact tree associated with unique identifier.</p>
84
+ * @public
85
+ */
86
+ export interface AssociatedContactSummary {
87
+ /**
88
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
89
+ * @public
90
+ */
91
+ ContactId?: string | undefined;
92
+ /**
93
+ * <p>The Amazon Resource Name (ARN) of the contact</p>
94
+ * @public
95
+ */
96
+ ContactArn?: string | undefined;
97
+ /**
98
+ * <p>The date and time this contact was initiated, in UTC time.</p>
99
+ * @public
100
+ */
101
+ InitiationTimestamp?: Date | undefined;
102
+ /**
103
+ * <p>The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer
104
+ * scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact
105
+ * ended.</p>
106
+ * @public
107
+ */
108
+ DisconnectTimestamp?: Date | undefined;
109
+ /**
110
+ * <p>If this contact is related to other contacts, this is the ID of the initial contact.</p>
111
+ * @public
112
+ */
113
+ InitialContactId?: string | undefined;
114
+ /**
115
+ * <p>If this contact is not the first contact, this is the ID of the previous contact.</p>
116
+ * @public
117
+ */
118
+ PreviousContactId?: string | undefined;
119
+ /**
120
+ * <p>The contactId that is related to this contact.</p>
121
+ * @public
122
+ */
123
+ RelatedContactId?: string | undefined;
124
+ /**
125
+ * <p>Indicates how the contact was initiated.</p>
126
+ * @public
127
+ */
128
+ InitiationMethod?: ContactInitiationMethod | undefined;
129
+ /**
130
+ * <p>How the contact reached your contact center.</p>
131
+ * @public
132
+ */
133
+ Channel?: Channel | undefined;
134
+ }
135
+ /**
136
+ * @public
137
+ */
138
+ export interface ListAssociatedContactsResponse {
139
+ /**
140
+ * <p>List of the contact summary for all the contacts in contact tree associated with unique identifier.</p>
141
+ * @public
142
+ */
143
+ ContactSummaryList?: AssociatedContactSummary[] | undefined;
144
+ /**
145
+ * <p>If there are additional results, this is the token for the next set of results.</p>
146
+ * @public
147
+ */
148
+ NextToken?: string | undefined;
149
+ }
150
+ /**
151
+ * @public
152
+ */
153
+ export interface ListAuthenticationProfilesRequest {
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 maximum number of results to return per page.</p>
161
+ * @public
162
+ */
163
+ MaxResults?: number | undefined;
164
+ /**
165
+ * <p>The token for the next set of results. Use the value returned in the previous
166
+ * response in the next request to retrieve the next set of results.</p>
167
+ * @public
168
+ */
169
+ NextToken?: string | undefined;
170
+ }
171
+ /**
172
+ * <p>This API is in preview release for Amazon Connect and is subject to change. To
173
+ * request access to this API, contact Amazon Web Services Support.</p>
174
+ * <p>A summary of a given authentication profile.</p>
175
+ * @public
176
+ */
177
+ export interface AuthenticationProfileSummary {
178
+ /**
179
+ * <p>The unique identifier of the authentication profile.</p>
180
+ * @public
181
+ */
182
+ Id?: string | undefined;
183
+ /**
184
+ * <p>The Amazon Resource Name (ARN) of the authentication profile summary.</p>
185
+ * @public
186
+ */
187
+ Arn?: string | undefined;
188
+ /**
189
+ * <p>The name of the authentication profile summary.</p>
190
+ * @public
191
+ */
192
+ Name?: string | undefined;
193
+ /**
194
+ * <p>Shows whether the authentication profile is the default authentication profile for the Amazon Connect
195
+ * instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless
196
+ * overridden by another authentication profile.</p>
197
+ * @public
198
+ */
199
+ IsDefault?: boolean | undefined;
200
+ /**
201
+ * <p>The timestamp when the authentication profile summary was last modified.</p>
202
+ * @public
203
+ */
204
+ LastModifiedTime?: Date | undefined;
205
+ /**
206
+ * <p>The Amazon Web Services Region when the authentication profile summary was last modified.</p>
207
+ * @public
208
+ */
209
+ LastModifiedRegion?: string | undefined;
210
+ }
211
+ /**
212
+ * @public
213
+ */
214
+ export interface ListAuthenticationProfilesResponse {
215
+ /**
216
+ * <p>A summary of a given authentication profile.</p>
217
+ * @public
218
+ */
219
+ AuthenticationProfileSummaryList?: AuthenticationProfileSummary[] | undefined;
220
+ /**
221
+ * <p>If there are additional results, this is the token for the next set of results.</p>
222
+ * @public
223
+ */
224
+ NextToken?: string | undefined;
225
+ }
226
+ /**
227
+ * @public
228
+ */
229
+ export interface ListBotsRequest {
230
+ /**
231
+ * <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>
232
+ * @public
233
+ */
234
+ InstanceId: string | undefined;
235
+ /**
236
+ * <p>The token for the next set of results. Use the value returned in the previous
237
+ * response in the next request to retrieve the next set of results.</p>
238
+ * @public
239
+ */
240
+ NextToken?: string | undefined;
241
+ /**
242
+ * <p>The maximum number of results to return per page.</p>
243
+ * @public
244
+ */
245
+ MaxResults?: number | undefined;
246
+ /**
247
+ * <p>The version of Amazon Lex or Amazon Lex V2.</p>
248
+ * @public
249
+ */
250
+ LexVersion: LexVersion | undefined;
251
+ }
252
+ /**
253
+ * <p>Configuration information of an Amazon Lex or Amazon Lex V2 bot.</p>
254
+ * @public
255
+ */
256
+ export interface LexBotConfig {
257
+ /**
258
+ * <p>Configuration information of an Amazon Lex bot.</p>
259
+ * @public
260
+ */
261
+ LexBot?: LexBot | undefined;
262
+ /**
263
+ * <p>Configuration information of an Amazon Lex V2 bot.</p>
264
+ * @public
265
+ */
266
+ LexV2Bot?: LexV2Bot | undefined;
267
+ }
268
+ /**
269
+ * @public
270
+ */
271
+ export interface ListBotsResponse {
272
+ /**
273
+ * <p>The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified
274
+ * instance.</p>
275
+ * @public
276
+ */
277
+ LexBots?: LexBotConfig[] | undefined;
278
+ /**
279
+ * <p>If there are additional results, this is the token for the next set of results.</p>
280
+ * @public
281
+ */
282
+ NextToken?: string | undefined;
283
+ }
4
284
  /**
5
285
  * @public
6
286
  */
@@ -3781,12 +4061,27 @@ export interface ListTaskTemplatesResponse {
3781
4061
  /**
3782
4062
  * @public
3783
4063
  */
3784
- export interface ListTrafficDistributionGroupsRequest {
4064
+ export interface ListTestCaseExecutionRecordsRequest {
3785
4065
  /**
3786
- * <p>The maximum number of results to return per page.</p>
4066
+ * <p>The identifier of the Amazon Connect instance.</p>
3787
4067
  * @public
3788
4068
  */
3789
- MaxResults?: number | undefined;
4069
+ InstanceId: string | undefined;
4070
+ /**
4071
+ * <p>The identifier of the test case.</p>
4072
+ * @public
4073
+ */
4074
+ TestCaseId: string | undefined;
4075
+ /**
4076
+ * <p>The identifier of the test case execution.</p>
4077
+ * @public
4078
+ */
4079
+ TestCaseExecutionId: string | undefined;
4080
+ /**
4081
+ * <p>Filter execution records by status.</p>
4082
+ * @public
4083
+ */
4084
+ Status?: TestCaseExecutionStatus | undefined;
3790
4085
  /**
3791
4086
  * <p>The token for the next set of results. Use the value returned in the previous
3792
4087
  * response in the next request to retrieve the next set of results.</p>
@@ -3794,40 +4089,271 @@ export interface ListTrafficDistributionGroupsRequest {
3794
4089
  */
3795
4090
  NextToken?: string | undefined;
3796
4091
  /**
3797
- * <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>
4092
+ * <p>The maximum number of results to return per page.</p>
3798
4093
  * @public
3799
4094
  */
3800
- InstanceId?: string | undefined;
4095
+ MaxResults?: number | undefined;
3801
4096
  }
3802
4097
  /**
3803
- * <p>Information about traffic distribution groups.</p>
4098
+ * <p>Contains information about a test case execution record.</p>
3804
4099
  * @public
3805
4100
  */
3806
- export interface TrafficDistributionGroupSummary {
4101
+ export interface ExecutionRecord {
3807
4102
  /**
3808
- * <p>The identifier of the traffic distribution group.
3809
- * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
3810
- * The ARN must be provided if the call is from the replicated Region.</p>
4103
+ * <p>The identifier of the execution record.</p>
3811
4104
  * @public
3812
4105
  */
3813
- Id?: string | undefined;
4106
+ ObservationId?: string | undefined;
3814
4107
  /**
3815
- * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
4108
+ * <p>The status of the action execution.</p>
3816
4109
  * @public
3817
4110
  */
3818
- Arn?: string | undefined;
4111
+ Status?: ExecutionRecordStatus | undefined;
3819
4112
  /**
3820
- * <p>The name of the traffic distribution group.</p>
4113
+ * <p>The timestamp when the action was executed.</p>
3821
4114
  * @public
3822
4115
  */
3823
- Name?: string | undefined;
4116
+ Timestamp?: Date | undefined;
3824
4117
  /**
3825
- * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
4118
+ * <p>The details of the executed record.</p>
3826
4119
  * @public
3827
4120
  */
3828
- InstanceArn?: string | undefined;
4121
+ Record?: string | undefined;
4122
+ }
4123
+ /**
4124
+ * @public
4125
+ */
4126
+ export interface ListTestCaseExecutionRecordsResponse {
3829
4127
  /**
3830
- * <p>The status of the traffic distribution group. </p>
4128
+ * <p>An array of test case execution record objects.</p>
4129
+ * @public
4130
+ */
4131
+ ExecutionRecords?: ExecutionRecord[] | undefined;
4132
+ /**
4133
+ * <p>If there are additional results, this is the token for the next set of results.</p>
4134
+ * @public
4135
+ */
4136
+ NextToken?: string | undefined;
4137
+ }
4138
+ /**
4139
+ * @public
4140
+ */
4141
+ export interface ListTestCaseExecutionsRequest {
4142
+ /**
4143
+ * <p>The identifier of the Amazon Connect instance.</p>
4144
+ * @public
4145
+ */
4146
+ InstanceId: string | undefined;
4147
+ /**
4148
+ * <p>Filter executions by test case identifier.</p>
4149
+ * @public
4150
+ */
4151
+ TestCaseId?: string | undefined;
4152
+ /**
4153
+ * <p>Filter executions by test case name.</p>
4154
+ * @public
4155
+ */
4156
+ TestCaseName?: string | undefined;
4157
+ /**
4158
+ * <p>Filter executions that started after this time.</p>
4159
+ * @public
4160
+ */
4161
+ StartTime?: Date | undefined;
4162
+ /**
4163
+ * <p>Filter executions that started before this time.</p>
4164
+ * @public
4165
+ */
4166
+ EndTime?: Date | undefined;
4167
+ /**
4168
+ * <p>Filter executions by status.</p>
4169
+ * @public
4170
+ */
4171
+ Status?: TestCaseExecutionStatus | undefined;
4172
+ /**
4173
+ * <p>The token for the next set of results. Use the value returned in the previous
4174
+ * response in the next request to retrieve the next set of results.</p>
4175
+ * @public
4176
+ */
4177
+ NextToken?: string | undefined;
4178
+ /**
4179
+ * <p>The maximum number of results to return per page.</p>
4180
+ * @public
4181
+ */
4182
+ MaxResults?: number | undefined;
4183
+ }
4184
+ /**
4185
+ * <p>Contains information about a test case execution.</p>
4186
+ * @public
4187
+ */
4188
+ export interface TestCaseExecution {
4189
+ /**
4190
+ * <p>The timestamp when the test case execution started.</p>
4191
+ * @public
4192
+ */
4193
+ StartTime?: Date | undefined;
4194
+ /**
4195
+ * <p>The timestamp when the test case execution ended.</p>
4196
+ * @public
4197
+ */
4198
+ EndTime?: Date | undefined;
4199
+ /**
4200
+ * <p>The identifier of the test case execution.</p>
4201
+ * @public
4202
+ */
4203
+ TestCaseExecutionId?: string | undefined;
4204
+ /**
4205
+ * <p>The identifier of the test case.</p>
4206
+ * @public
4207
+ */
4208
+ TestCaseId?: string | undefined;
4209
+ /**
4210
+ * <p>The status of the test case execution.</p>
4211
+ * @public
4212
+ */
4213
+ TestCaseExecutionStatus?: TestCaseExecutionStatus | undefined;
4214
+ /**
4215
+ * <p>The tags used to organize, track, or control access for this resource.</p>
4216
+ * @public
4217
+ */
4218
+ Tags?: Record<string, string> | undefined;
4219
+ }
4220
+ /**
4221
+ * @public
4222
+ */
4223
+ export interface ListTestCaseExecutionsResponse {
4224
+ /**
4225
+ * <p>An array of test case execution summary objects.</p>
4226
+ * @public
4227
+ */
4228
+ TestCaseExecutions?: TestCaseExecution[] | undefined;
4229
+ /**
4230
+ * <p>If there are additional results, this is the token for the next set of results.</p>
4231
+ * @public
4232
+ */
4233
+ NextToken?: string | undefined;
4234
+ }
4235
+ /**
4236
+ * @public
4237
+ */
4238
+ export interface ListTestCasesRequest {
4239
+ /**
4240
+ * <p>The identifier of the Amazon Connect instance.</p>
4241
+ * @public
4242
+ */
4243
+ InstanceId: string | undefined;
4244
+ /**
4245
+ * <p>The token for the next set of results. Use the value returned in the previous
4246
+ * response in the next request to retrieve the next set of results.</p>
4247
+ * @public
4248
+ */
4249
+ NextToken?: string | undefined;
4250
+ /**
4251
+ * <p>The maximum number of results to return per page.</p>
4252
+ * @public
4253
+ */
4254
+ MaxResults?: number | undefined;
4255
+ }
4256
+ /**
4257
+ * <p>Contains summary information about a test case.</p>
4258
+ * @public
4259
+ */
4260
+ export interface TestCaseSummary {
4261
+ /**
4262
+ * <p>The identifier of the test case.</p>
4263
+ * @public
4264
+ */
4265
+ Id?: string | undefined;
4266
+ /**
4267
+ * <p>The Amazon Resource Name (ARN) of the test case.</p>
4268
+ * @public
4269
+ */
4270
+ Arn?: string | undefined;
4271
+ /**
4272
+ * <p>The name of the test case.</p>
4273
+ * @public
4274
+ */
4275
+ Name?: string | undefined;
4276
+ /**
4277
+ * <p>The status of the test case.</p>
4278
+ * @public
4279
+ */
4280
+ Status?: TestCaseStatus | undefined;
4281
+ /**
4282
+ * <p>The time at which the test case was last modified.</p>
4283
+ * @public
4284
+ */
4285
+ LastModifiedTime?: Date | undefined;
4286
+ /**
4287
+ * <p>The region in which the test case was last modified.</p>
4288
+ * @public
4289
+ */
4290
+ LastModifiedRegion?: string | undefined;
4291
+ }
4292
+ /**
4293
+ * @public
4294
+ */
4295
+ export interface ListTestCasesResponse {
4296
+ /**
4297
+ * <p>Information about the tests.</p>
4298
+ * @public
4299
+ */
4300
+ TestCaseSummaryList?: TestCaseSummary[] | undefined;
4301
+ /**
4302
+ * <p>If there are additional results, this is the token for the next set of results.</p>
4303
+ * @public
4304
+ */
4305
+ NextToken?: string | undefined;
4306
+ }
4307
+ /**
4308
+ * @public
4309
+ */
4310
+ export interface ListTrafficDistributionGroupsRequest {
4311
+ /**
4312
+ * <p>The maximum number of results to return per page.</p>
4313
+ * @public
4314
+ */
4315
+ MaxResults?: number | undefined;
4316
+ /**
4317
+ * <p>The token for the next set of results. Use the value returned in the previous
4318
+ * response in the next request to retrieve the next set of results.</p>
4319
+ * @public
4320
+ */
4321
+ NextToken?: string | undefined;
4322
+ /**
4323
+ * <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>
4324
+ * @public
4325
+ */
4326
+ InstanceId?: string | undefined;
4327
+ }
4328
+ /**
4329
+ * <p>Information about traffic distribution groups.</p>
4330
+ * @public
4331
+ */
4332
+ export interface TrafficDistributionGroupSummary {
4333
+ /**
4334
+ * <p>The identifier of the traffic distribution group.
4335
+ * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
4336
+ * The ARN must be provided if the call is from the replicated Region.</p>
4337
+ * @public
4338
+ */
4339
+ Id?: string | undefined;
4340
+ /**
4341
+ * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
4342
+ * @public
4343
+ */
4344
+ Arn?: string | undefined;
4345
+ /**
4346
+ * <p>The name of the traffic distribution group.</p>
4347
+ * @public
4348
+ */
4349
+ Name?: string | undefined;
4350
+ /**
4351
+ * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
4352
+ * @public
4353
+ */
4354
+ InstanceArn?: string | undefined;
4355
+ /**
4356
+ * <p>The status of the traffic distribution group. </p>
3831
4357
  * <ul>
3832
4358
  * <li>
3833
4359
  * <p>
@@ -6399,6 +6925,37 @@ export interface SearchSecurityProfilesResponse {
6399
6925
  */
6400
6926
  ApproximateTotalCount?: number | undefined;
6401
6927
  }
6928
+ /**
6929
+ * <p>Filters to be applied to search results.</p>
6930
+ * @public
6931
+ */
6932
+ export interface TestCaseSearchFilter {
6933
+ /**
6934
+ * <p>An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where: Top level list specifies conditions that need to be applied with OR operator. Inner list specifies conditions that need to be applied with AND operator.</p>
6935
+ * @public
6936
+ */
6937
+ TagFilter?: ControlPlaneTagFilter | undefined;
6938
+ }
6939
+ /**
6940
+ * @public
6941
+ */
6942
+ export interface SearchTestCasesResponse {
6943
+ /**
6944
+ * <p>Information about the test cases.</p>
6945
+ * @public
6946
+ */
6947
+ TestCases?: TestCase[] | undefined;
6948
+ /**
6949
+ * <p>If there are additional results, this is the token for the next set of results.</p>
6950
+ * @public
6951
+ */
6952
+ NextToken?: string | undefined;
6953
+ /**
6954
+ * <p>The total number of test cases which matched your search query.</p>
6955
+ * @public
6956
+ */
6957
+ ApproximateTotalCount?: number | undefined;
6958
+ }
6402
6959
  /**
6403
6960
  * <p>Filters to be applied to search results.</p>
6404
6961
  * @public
@@ -6980,581 +7537,3 @@ export interface SearchWorkspacesResponse {
6980
7537
  */
6981
7538
  ApproximateTotalCount?: number | undefined;
6982
7539
  }
6983
- /**
6984
- * <p>Chat integration event containing payload to perform different chat actions such as:</p>
6985
- * <ul>
6986
- * <li>
6987
- * <p>Sending a chat message</p>
6988
- * </li>
6989
- * <li>
6990
- * <p>Sending a chat event, such as typing</p>
6991
- * </li>
6992
- * <li>
6993
- * <p>Disconnecting from a chat</p>
6994
- * </li>
6995
- * </ul>
6996
- * @public
6997
- */
6998
- export interface ChatEvent {
6999
- /**
7000
- * <p>Type of chat integration event. </p>
7001
- * @public
7002
- */
7003
- Type: ChatEventType | undefined;
7004
- /**
7005
- * <p>Type of content. This is required when <code>Type</code> is <code>MESSAGE</code> or <code>EVENT</code>. </p>
7006
- * <ul>
7007
- * <li>
7008
- * <p>For allowed message content types, see the <code>ContentType</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic
7009
- * in the <i>Amazon Connect Participant Service API Reference</i>.</p>
7010
- * </li>
7011
- * <li>
7012
- * <p>For allowed event content types, see the <code>ContentType</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html">SendEvent</a> topic in the <i>Amazon Connect Participant Service API Reference</i>. </p>
7013
- * </li>
7014
- * </ul>
7015
- * @public
7016
- */
7017
- ContentType?: string | undefined;
7018
- /**
7019
- * <p>Content of the message or event. This is required when <code>Type</code> is <code>MESSAGE</code> and for certain
7020
- * <code>ContentTypes</code> when <code>Type</code> is <code>EVENT</code>.</p>
7021
- * <ul>
7022
- * <li>
7023
- * <p>For allowed message content, see the <code>Content</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic in the
7024
- * <i>Amazon Connect Participant Service API Reference</i>.</p>
7025
- * </li>
7026
- * <li>
7027
- * <p>For allowed event content, see the <code>Content</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html">SendEvent</a> topic in the <i>Amazon Connect Participant Service API Reference</i>. </p>
7028
- * </li>
7029
- * </ul>
7030
- * @public
7031
- */
7032
- Content?: string | undefined;
7033
- }
7034
- /**
7035
- * <p>The customer's details.</p>
7036
- * @public
7037
- */
7038
- export interface ParticipantDetails {
7039
- /**
7040
- * <p>Display name of the participant.</p>
7041
- * @public
7042
- */
7043
- DisplayName: string | undefined;
7044
- }
7045
- /**
7046
- * <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
7047
- * @public
7048
- */
7049
- export interface ChatStreamingConfiguration {
7050
- /**
7051
- * <p>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish
7052
- * real-time message streaming for chat conversations.</p>
7053
- * @public
7054
- */
7055
- StreamingEndpointArn: string | undefined;
7056
- }
7057
- /**
7058
- * <p>Payload of chat properties to apply when starting a new contact.</p>
7059
- * @public
7060
- */
7061
- export interface NewSessionDetails {
7062
- /**
7063
- * <p> The supported chat message content types. Supported types are <code>text/plain</code>,
7064
- * <code>text/markdown</code>, <code>application/json</code>,
7065
- * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
7066
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
7067
- * <p>Content types must always contain <code> text/plain</code>. You can then put any other supported type in the
7068
- * list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain,
7069
- * text/markdown, application/json]</code>, <code> [text/markdown, text/plain]</code>, <code>[text/plain,
7070
- * application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
7071
- * @public
7072
- */
7073
- SupportedMessagingContentTypes?: string[] | undefined;
7074
- /**
7075
- * <p>The customer's details.</p>
7076
- * @public
7077
- */
7078
- ParticipantDetails?: ParticipantDetails | undefined;
7079
- /**
7080
- * <p> A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They
7081
- * can be accessed in flows just like any other contact attributes. </p>
7082
- * <p> There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
7083
- * alphanumeric, dash, and underscore characters. </p>
7084
- * @public
7085
- */
7086
- Attributes?: Record<string, string> | undefined;
7087
- /**
7088
- * <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
7089
- * @public
7090
- */
7091
- StreamingConfiguration?: ChatStreamingConfiguration | undefined;
7092
- }
7093
- /**
7094
- * @public
7095
- */
7096
- export interface SendChatIntegrationEventRequest {
7097
- /**
7098
- * <p>External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the
7099
- * E164 phone number of the chat customer participant.</p>
7100
- * @public
7101
- */
7102
- SourceId: string | undefined;
7103
- /**
7104
- * <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect
7105
- * instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound
7106
- * Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.</p>
7107
- * @public
7108
- */
7109
- DestinationId: string | undefined;
7110
- /**
7111
- * <p>Classification of a channel. This is used in part to uniquely identify chat. </p>
7112
- * <p>Valid value: <code>["connect:sms", connect:"WhatsApp"]</code>
7113
- * </p>
7114
- * @public
7115
- */
7116
- Subtype?: string | undefined;
7117
- /**
7118
- * <p>Chat integration event payload</p>
7119
- * @public
7120
- */
7121
- Event: ChatEvent | undefined;
7122
- /**
7123
- * <p>Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat,
7124
- * this is ignored.</p>
7125
- * @public
7126
- */
7127
- NewSessionDetails?: NewSessionDetails | undefined;
7128
- }
7129
- /**
7130
- * @public
7131
- */
7132
- export interface SendChatIntegrationEventResponse {
7133
- /**
7134
- * <p>Identifier of chat contact used to handle integration event. This may be null if the integration event is not
7135
- * valid without an already existing chat contact.</p>
7136
- * @public
7137
- */
7138
- InitialContactId?: string | undefined;
7139
- /**
7140
- * <p>Whether handling the integration event resulted in creating a new chat or acting on existing chat.</p>
7141
- * @public
7142
- */
7143
- NewChatCreated?: boolean | undefined;
7144
- }
7145
- /**
7146
- * <p>Contains information about a source or destination email address.</p>
7147
- * @public
7148
- */
7149
- export interface EmailAddressInfo {
7150
- /**
7151
- * <p>The email address, including the domain.</p>
7152
- * @public
7153
- */
7154
- EmailAddress: string | undefined;
7155
- /**
7156
- * <p>The display name of email address.</p>
7157
- * @public
7158
- */
7159
- DisplayName?: string | undefined;
7160
- }
7161
- /**
7162
- * <p>Information about the additional recipients of outbound email.</p>
7163
- * @public
7164
- */
7165
- export interface OutboundAdditionalRecipients {
7166
- /**
7167
- * <p>Information about the <b>additional</b> CC email address recipients. Email recipients
7168
- * are limited to 50 total addresses: 1 required recipient in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SendOutboundEmail.html#API_SendOutboundEmail_RequestBody">DestinationEmailAddress</a> field and up to 49 recipients in the 'CcEmailAddresses' field.</p>
7169
- * @public
7170
- */
7171
- CcEmailAddresses?: EmailAddressInfo[] | undefined;
7172
- }
7173
- /**
7174
- * <p>Information about the raw email body content.</p>
7175
- * @public
7176
- */
7177
- export interface OutboundRawMessage {
7178
- /**
7179
- * <p>The email subject.</p>
7180
- * @public
7181
- */
7182
- Subject: string | undefined;
7183
- /**
7184
- * <p>The email message body.</p>
7185
- * @public
7186
- */
7187
- Body: string | undefined;
7188
- /**
7189
- * <p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>
7190
- * @public
7191
- */
7192
- ContentType: string | undefined;
7193
- }
7194
- /**
7195
- * <p>Information about the template attributes.</p>
7196
- * @public
7197
- */
7198
- export interface TemplateAttributes {
7199
- /**
7200
- * <p>An object that specifies the custom attributes values to use for variables in the message template. This object
7201
- * contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template.
7202
- * </p>
7203
- * @public
7204
- */
7205
- CustomAttributes?: Record<string, string> | undefined;
7206
- /**
7207
- * <p>An object that specifies the customer profile attributes values to use for variables in the message template.
7208
- * This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the
7209
- * message template. </p>
7210
- * @public
7211
- */
7212
- CustomerProfileAttributes?: string | undefined;
7213
- }
7214
- /**
7215
- * <p>Information about template message configuration.</p>
7216
- * @public
7217
- */
7218
- export interface TemplatedMessageConfig {
7219
- /**
7220
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
7221
- * @public
7222
- */
7223
- KnowledgeBaseId: string | undefined;
7224
- /**
7225
- * <p>The identifier of the message template Id.</p>
7226
- * @public
7227
- */
7228
- MessageTemplateId: string | undefined;
7229
- /**
7230
- * <p>Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes.</p>
7231
- * @public
7232
- */
7233
- TemplateAttributes: TemplateAttributes | undefined;
7234
- }
7235
- /**
7236
- * <p>Information about email body content.</p>
7237
- * @public
7238
- */
7239
- export interface OutboundEmailContent {
7240
- /**
7241
- * <p>The message source type, that is, <code>RAW</code> or <code>TEMPLATE</code>.</p>
7242
- * @public
7243
- */
7244
- MessageSourceType: OutboundMessageSourceType | undefined;
7245
- /**
7246
- * <p>Information about template message configuration.</p>
7247
- * @public
7248
- */
7249
- TemplatedMessageConfig?: TemplatedMessageConfig | undefined;
7250
- /**
7251
- * <p>The raw email body content.</p>
7252
- * @public
7253
- */
7254
- RawMessage?: OutboundRawMessage | undefined;
7255
- }
7256
- /**
7257
- * <p>Information about the campaign.</p>
7258
- * @public
7259
- */
7260
- export interface SourceCampaign {
7261
- /**
7262
- * <p>A unique identifier for a campaign.</p>
7263
- * @public
7264
- */
7265
- CampaignId?: string | undefined;
7266
- /**
7267
- * <p>A unique identifier for a each request part of same campaign.</p>
7268
- * @public
7269
- */
7270
- OutboundRequestId?: string | undefined;
7271
- }
7272
- /**
7273
- * @public
7274
- */
7275
- export interface SendOutboundEmailRequest {
7276
- /**
7277
- * <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>
7278
- * @public
7279
- */
7280
- InstanceId: string | undefined;
7281
- /**
7282
- * <p>The email address to be used for sending email.</p>
7283
- * @public
7284
- */
7285
- FromEmailAddress: EmailAddressInfo | undefined;
7286
- /**
7287
- * <p>The email address to send the email to.</p>
7288
- * @public
7289
- */
7290
- DestinationEmailAddress: EmailAddressInfo | undefined;
7291
- /**
7292
- * <p>The additional recipients address of the email in CC.</p>
7293
- * @public
7294
- */
7295
- AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
7296
- /**
7297
- * <p>The email message body to be sent to the newly created email.</p>
7298
- * @public
7299
- */
7300
- EmailMessage: OutboundEmailContent | undefined;
7301
- /**
7302
- * <p>Denotes the class of traffic.</p>
7303
- * <note>
7304
- * <p>Only the CAMPAIGN traffic type is supported.</p>
7305
- * </note>
7306
- * @public
7307
- */
7308
- TrafficType: TrafficType | undefined;
7309
- /**
7310
- * <p>A Campaign object need for Campaign traffic type.</p>
7311
- * @public
7312
- */
7313
- SourceCampaign?: SourceCampaign | undefined;
7314
- /**
7315
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
7316
- * request. If not provided, the Amazon Web Services
7317
- * SDK populates this field. For more information about idempotency, see
7318
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
7319
- * @public
7320
- */
7321
- ClientToken?: string | undefined;
7322
- }
7323
- /**
7324
- * @public
7325
- */
7326
- export interface SendOutboundEmailResponse {
7327
- }
7328
- /**
7329
- * @public
7330
- */
7331
- export interface StartAttachedFileUploadRequest {
7332
- /**
7333
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
7334
- * request. If not provided, the Amazon Web Services
7335
- * SDK populates this field. For more information about idempotency, see
7336
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
7337
- * @public
7338
- */
7339
- ClientToken?: string | undefined;
7340
- /**
7341
- * <p>The unique identifier of the Amazon Connect instance.</p>
7342
- * @public
7343
- */
7344
- InstanceId: string | undefined;
7345
- /**
7346
- * <p>A case-sensitive name of the attached file being uploaded.</p>
7347
- * @public
7348
- */
7349
- FileName: string | undefined;
7350
- /**
7351
- * <p>The size of the attached file in bytes.</p>
7352
- * @public
7353
- */
7354
- FileSizeInBytes: number | undefined;
7355
- /**
7356
- * <p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>
7357
- * @public
7358
- */
7359
- UrlExpiryInSeconds?: number | undefined;
7360
- /**
7361
- * <p>The use case for the file.</p>
7362
- * <important>
7363
- * <p> Only <code>ATTACHMENTS</code> are supported.</p>
7364
- * </important>
7365
- * @public
7366
- */
7367
- FileUseCaseType: FileUseCaseType | undefined;
7368
- /**
7369
- * <p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p>
7370
- * <note>
7371
- * <p>This value must be a valid ARN.</p>
7372
- * </note>
7373
- * @public
7374
- */
7375
- AssociatedResourceArn: string | undefined;
7376
- /**
7377
- * <p>Represents the identity that created the file.</p>
7378
- * @public
7379
- */
7380
- CreatedBy?: CreatedByInfo | undefined;
7381
- /**
7382
- * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags":
7383
- * \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
7384
- * @public
7385
- */
7386
- Tags?: Record<string, string> | undefined;
7387
- }
7388
- /**
7389
- * <p>Fields required when uploading an attached file. </p>
7390
- * @public
7391
- */
7392
- export interface UploadUrlMetadata {
7393
- /**
7394
- * <p>A pre-signed S3 URL that should be used for uploading the attached file. </p>
7395
- * @public
7396
- */
7397
- Url?: string | undefined;
7398
- /**
7399
- * <p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
7400
- * <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2019-11-08T02:41:28.172Z</code>.</p>
7401
- * @public
7402
- */
7403
- UrlExpiry?: string | undefined;
7404
- /**
7405
- * <p>A map of headers that should be provided when uploading the attached file. </p>
7406
- * @public
7407
- */
7408
- HeadersToInclude?: Record<string, string> | undefined;
7409
- }
7410
- /**
7411
- * Response from StartAttachedFileUpload API.
7412
- * @public
7413
- */
7414
- export interface StartAttachedFileUploadResponse {
7415
- /**
7416
- * <p>The unique identifier of the attached file resource (ARN).</p>
7417
- * @public
7418
- */
7419
- FileArn?: string | undefined;
7420
- /**
7421
- * <p>The unique identifier of the attached file resource.</p>
7422
- * @public
7423
- */
7424
- FileId?: string | undefined;
7425
- /**
7426
- * <p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
7427
- * <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2024-05-03T02:41:28.172Z</code>.</p>
7428
- * @public
7429
- */
7430
- CreationTime?: string | undefined;
7431
- /**
7432
- * <p>The current status of the attached file.</p>
7433
- * @public
7434
- */
7435
- FileStatus?: FileStatusType | undefined;
7436
- /**
7437
- * <p>Represents the identity that created the file.</p>
7438
- * @public
7439
- */
7440
- CreatedBy?: CreatedByInfo | undefined;
7441
- /**
7442
- * <p>The headers to be provided while uploading the file to the URL.</p>
7443
- * @public
7444
- */
7445
- UploadUrlMetadata?: UploadUrlMetadata | undefined;
7446
- }
7447
- /**
7448
- * <p>A chat message.</p>
7449
- * @public
7450
- */
7451
- export interface ChatMessage {
7452
- /**
7453
- * <p>The type of the content. Supported types are <code>text/plain</code>, <code>text/markdown</code>,
7454
- * <code>application/json</code>, and
7455
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
7456
- * @public
7457
- */
7458
- ContentType: string | undefined;
7459
- /**
7460
- * <p>The content of the chat message. </p>
7461
- * <ul>
7462
- * <li>
7463
- * <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are Minimum of 1, Maximum
7464
- * of 1024. </p>
7465
- * </li>
7466
- * <li>
7467
- * <p>For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of 12000. </p>
7468
- * </li>
7469
- * <li>
7470
- * <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length Constraints are
7471
- * Minimum of 1, Maximum of 12288.</p>
7472
- * </li>
7473
- * </ul>
7474
- * @public
7475
- */
7476
- Content: string | undefined;
7477
- }
7478
- /**
7479
- * <p> The configuration of the participant. </p>
7480
- * @public
7481
- */
7482
- export interface ParticipantConfiguration {
7483
- /**
7484
- * <p> The mode in which responses should be sent to the participant. </p>
7485
- * @public
7486
- */
7487
- ResponseMode?: ResponseMode | undefined;
7488
- }
7489
- /**
7490
- * <p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how
7491
- * to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable
7492
- * persistent chat</a>.</p>
7493
- * @public
7494
- */
7495
- export interface PersistentChat {
7496
- /**
7497
- * <p>The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for
7498
- * persistent chat. </p>
7499
- * <ul>
7500
- * <li>
7501
- * <p>
7502
- * <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat contact of the
7503
- * specified past ended chat session. To use this type, provide the <code>initialContactId</code> of the past ended
7504
- * chat session in the <code>sourceContactId</code> field. In this type, Amazon Connect determines the most recent
7505
- * chat contact on the specified chat session that has ended, and uses it to start a persistent chat. </p>
7506
- * </li>
7507
- * <li>
7508
- * <p>
7509
- * <code>FROM_SEGMENT</code>: Rehydrates a chat from the past chat contact that is specified in the
7510
- * <code>sourceContactId</code> field. </p>
7511
- * </li>
7512
- * </ul>
7513
- * <p>The actual contactId used for rehydration is provided in the response of this API. </p>
7514
- * @public
7515
- */
7516
- RehydrationType?: RehydrationType | undefined;
7517
- /**
7518
- * <p>The contactId from which a persistent chat session must be started.</p>
7519
- * @public
7520
- */
7521
- SourceContactId?: string | undefined;
7522
- }
7523
- /**
7524
- * @public
7525
- */
7526
- export interface StartChatContactResponse {
7527
- /**
7528
- * <p>The identifier of this contact within the Amazon Connect instance. </p>
7529
- * @public
7530
- */
7531
- ContactId?: string | undefined;
7532
- /**
7533
- * <p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat
7534
- * lifecycle.</p>
7535
- * @public
7536
- */
7537
- ParticipantId?: string | undefined;
7538
- /**
7539
- * <p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat participant.</p>
7540
- * @public
7541
- */
7542
- ParticipantToken?: string | undefined;
7543
- /**
7544
- * <p>The contactId from which a persistent chat session is started. This field is populated only for persistent
7545
- * chats.</p>
7546
- * @public
7547
- */
7548
- ContinuedFromContactId?: string | undefined;
7549
- }
7550
- /**
7551
- * <p>Configuration information about automated evaluations.</p>
7552
- * @public
7553
- */
7554
- export interface AutoEvaluationConfiguration {
7555
- /**
7556
- * <p>Whether automated evaluations are enabled.</p>
7557
- * @public
7558
- */
7559
- Enabled: boolean | undefined;
7560
- }