@aws-sdk/client-connect 3.699.0 → 3.701.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 (55) hide show
  1. package/dist-cjs/index.js +96 -47
  2. package/dist-es/commands/CreateContactCommand.js +1 -1
  3. package/dist-es/commands/StartEmailContactCommand.js +1 -1
  4. package/dist-es/commands/StartTaskContactCommand.js +1 -1
  5. package/dist-es/commands/UpdateContactCommand.js +1 -1
  6. package/dist-es/models/models_0.js +0 -5
  7. package/dist-es/models/models_1.js +5 -0
  8. package/dist-es/models/models_2.js +5 -27
  9. package/dist-es/models/models_3.js +23 -0
  10. package/dist-es/protocols/Aws_restJson1.js +57 -8
  11. package/dist-types/commands/CreateContactCommand.d.ts +13 -2
  12. package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -1
  13. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
  14. package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -2
  16. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
  17. package/dist-types/commands/DescribeContactCommand.d.ts +10 -0
  18. package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
  19. package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
  20. package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
  21. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +2 -1
  22. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
  23. package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -3
  24. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -1
  25. package/dist-types/commands/SendOutboundEmailCommand.d.ts +6 -1
  26. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +3 -1
  27. package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
  28. package/dist-types/commands/StartEmailContactCommand.d.ts +14 -2
  29. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +12 -1
  30. package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +2 -1
  31. package/dist-types/commands/StartTaskContactCommand.d.ts +12 -1
  32. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  33. package/dist-types/commands/UpdateContactCommand.d.ts +12 -1
  34. package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +2 -1
  37. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +2 -2
  38. package/dist-types/models/models_0.d.ts +60 -118
  39. package/dist-types/models/models_1.d.ts +117 -71
  40. package/dist-types/models/models_2.d.ts +544 -718
  41. package/dist-types/models/models_3.d.ts +545 -246
  42. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +2 -4
  43. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +4 -2
  45. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
  46. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
  47. package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
  48. package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  50. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  51. package/dist-types/ts3.4/models/models_0.d.ts +5 -21
  52. package/dist-types/ts3.4/models/models_1.d.ts +18 -6
  53. package/dist-types/ts3.4/models/models_2.d.ts +76 -97
  54. package/dist-types/ts3.4/models/models_3.d.ts +96 -58
  55. package/package.json +1 -1
@@ -1,72 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, Endpoint, EvaluationFormQuestion, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, OutboundEmailConfig, ParticipantRole, PredefinedAttributeValues, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SegmentAttributeValue, StringComparisonType, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
- import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RealTimeContactAnalysisSegmentAttachments, RealTimeContactAnalysisSegmentCategories, RealTimeContactAnalysisSegmentEvent, RealTimeContactAnalysisSegmentIssues, RealTimeContactAnalysisSegmentPostContactSummary, RealTimeContactAnalysisSupportedChannel, RealTimeContactAnalysisTimeData, RealTimeContactAnalysisTranscriptItemRedaction, RoutingProfile, SignInConfig, SortOrder, TelephonyConfig, TrafficDistributionGroupStatus } from "./models_1";
5
- /**
6
- * @public
7
- * @enum
8
- */
9
- export declare const RealTimeContactAnalysisSentimentLabel: {
10
- readonly NEGATIVE: "NEGATIVE";
11
- readonly NEUTRAL: "NEUTRAL";
12
- readonly POSITIVE: "POSITIVE";
13
- };
14
- /**
15
- * @public
16
- */
17
- export type RealTimeContactAnalysisSentimentLabel = (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel];
18
- /**
19
- * <p>The analyzed transcript segment.</p>
20
- * @public
21
- */
22
- export interface RealTimeContactAnalysisSegmentTranscript {
23
- /**
24
- * <p>The identifier of the transcript.</p>
25
- * @public
26
- */
27
- Id: string | undefined;
28
- /**
29
- * <p>The identifier of the participant.</p>
30
- * @public
31
- */
32
- ParticipantId: string | undefined;
33
- /**
34
- * <p>The role of the participant. For example, is it a customer, agent, or system.</p>
35
- * @public
36
- */
37
- ParticipantRole: ParticipantRole | undefined;
38
- /**
39
- * <p>The display name of the participant.</p>
40
- * @public
41
- */
42
- DisplayName?: string | undefined;
43
- /**
44
- * <p>The content of the transcript. Can be redacted.</p>
45
- * @public
46
- */
47
- Content: string | undefined;
48
- /**
49
- * <p>The type of content of the item. For example, <code>text/plain</code>.</p>
50
- * @public
51
- */
52
- ContentType?: string | undefined;
53
- /**
54
- * <p>Field describing the time of the event. It can have different representations of time.</p>
55
- * @public
56
- */
57
- Time: RealTimeContactAnalysisTimeData | undefined;
58
- /**
59
- * <p>Object describing redaction that was applied to the transcript. If transcript has the field
60
- * it means part of the transcript was redacted.</p>
61
- * @public
62
- */
63
- Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined;
64
- /**
65
- * <p>The sentiment detected for this piece of transcript.</p>
66
- * @public
67
- */
68
- Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined;
69
- }
3
+ import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EvaluationFormQuestion, EvaluationFormScoringStrategy, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InitiateAs, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, OutboundEmailConfig, ParticipantRole, PredefinedAttributeValues, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
+ import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RealTimeContactAnalysisSegmentAttachments, RealTimeContactAnalysisSegmentCategories, RealTimeContactAnalysisSegmentEvent, RealTimeContactAnalysisSegmentIssues, RealTimeContactAnalysisSegmentPostContactSummary, RealTimeContactAnalysisSegmentTranscript, RealTimeContactAnalysisSupportedChannel, RoutingProfile, SignInConfig, SortOrder, TelephonyConfig, TrafficDistributionGroupStatus } from "./models_1";
70
5
  /**
71
6
  * <p>An analyzed segment for a real-time analysis session.</p>
72
7
  * @public
@@ -218,7 +153,7 @@ export interface ListRealtimeContactAnalysisSegmentsV2Response {
218
153
  /**
219
154
  * <p>Thrown for analyzed content when requested OutputType was not enabled for a given contact.
220
155
  * For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction
221
- * policy set in Contact flow.</p>
156
+ * policy set in the flow.</p>
222
157
  * @public
223
158
  */
224
159
  export declare class OutputTypeNotFoundException extends __BaseException {
@@ -1749,7 +1684,7 @@ export interface ContactFlowModuleSearchFilter {
1749
1684
  */
1750
1685
  export interface SearchContactFlowModulesResponse {
1751
1686
  /**
1752
- * <p>The search criteria to be used to return contact flow modules.</p>
1687
+ * <p>The search criteria to be used to return flow modules.</p>
1753
1688
  * @public
1754
1689
  */
1755
1690
  ContactFlowModules?: ContactFlowModule[] | undefined;
@@ -1759,7 +1694,7 @@ export interface SearchContactFlowModulesResponse {
1759
1694
  */
1760
1695
  NextToken?: string | undefined;
1761
1696
  /**
1762
- * <p>The total number of contact flows which matched your search query.</p>
1697
+ * <p>The total number of flows which matched your search query.</p>
1763
1698
  * @public
1764
1699
  */
1765
1700
  ApproximateTotalCount?: number | undefined;
@@ -1801,7 +1736,7 @@ export interface SearchContactFlowsResponse {
1801
1736
  */
1802
1737
  NextToken?: string | undefined;
1803
1738
  /**
1804
- * <p>The total number of contact flows which matched your search query.</p>
1739
+ * <p>The total number of flows which matched your search query.</p>
1805
1740
  * @public
1806
1741
  */
1807
1742
  ApproximateTotalCount?: number | undefined;
@@ -1860,8 +1795,7 @@ export interface Transcript {
1860
1795
  MatchType?: SearchContactsMatchType | undefined;
1861
1796
  }
1862
1797
  /**
1863
- * <p>A structure that defines search criteria for contacts using analysis outputs from Amazon
1864
- * Connect Contact Lens.</p>
1798
+ * <p>A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.</p>
1865
1799
  * @public
1866
1800
  */
1867
1801
  export interface ContactAnalysis {
@@ -1872,7 +1806,7 @@ export interface ContactAnalysis {
1872
1806
  Transcript?: Transcript | undefined;
1873
1807
  }
1874
1808
  /**
1875
- * <p>The search criteria based on user-defned contact attribute key and values to search
1809
+ * <p>The search criteria based on user-defined contact attribute key and values to search
1876
1810
  * on.</p>
1877
1811
  * @public
1878
1812
  */
@@ -1908,33 +1842,35 @@ export interface SearchableContactAttributes {
1908
1842
  MatchType?: SearchContactsMatchType | undefined;
1909
1843
  }
1910
1844
  /**
1911
- * <p></p>
1845
+ * <p>The search criteria based on searchable segment attribute key and values to search
1846
+ * on.</p>
1912
1847
  * @public
1913
1848
  */
1914
1849
  export interface SearchableSegmentAttributesCriteria {
1915
1850
  /**
1916
- * <p></p>
1851
+ * <p>The key containing a searchable segment attribute.</p>
1917
1852
  * @public
1918
1853
  */
1919
1854
  Key: string | undefined;
1920
1855
  /**
1921
- * <p></p>
1856
+ * <p>The list of values to search for within a searchable segment attribute.</p>
1922
1857
  * @public
1923
1858
  */
1924
1859
  Values: string[] | undefined;
1925
1860
  }
1926
1861
  /**
1927
- * <p></p>
1862
+ * <p>The search criteria based on searchable segment attributes of a contact</p>
1928
1863
  * @public
1929
1864
  */
1930
1865
  export interface SearchableSegmentAttributes {
1931
1866
  /**
1932
- * <p></p>
1867
+ * <p>The list of criteria based on searchable segment attributes.</p>
1933
1868
  * @public
1934
1869
  */
1935
1870
  Criteria: SearchableSegmentAttributesCriteria[] | undefined;
1936
1871
  /**
1937
- * <p></p>
1872
+ * <p>The match type combining search criteria using multiple searchable segment
1873
+ * attributes.</p>
1938
1874
  * @public
1939
1875
  */
1940
1876
  MatchType?: SearchContactsMatchType | undefined;
@@ -1987,7 +1923,7 @@ export interface SearchCriteria {
1987
1923
  */
1988
1924
  SearchableContactAttributes?: SearchableContactAttributes | undefined;
1989
1925
  /**
1990
- * <p></p>
1926
+ * <p>The search criteria based on searchable segment attributes of a contact.</p>
1991
1927
  * @public
1992
1928
  */
1993
1929
  SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined;
@@ -2129,12 +2065,14 @@ export interface ContactSearchSummaryQueueInfo {
2129
2065
  EnqueueTimestamp?: Date | undefined;
2130
2066
  }
2131
2067
  /**
2132
- * <p></p>
2068
+ * <p>The value of a segment attribute. This is structured as a map with a single key-value pair.
2069
+ * The key 'valueString' indicates that the attribute type is a string, and its corresponding value
2070
+ * is the actual string value of the segment attribute.</p>
2133
2071
  * @public
2134
2072
  */
2135
2073
  export interface ContactSearchSummarySegmentAttributeValue {
2136
2074
  /**
2137
- * <p></p>
2075
+ * <p>The value of a segment attribute represented as a string.</p>
2138
2076
  * @public
2139
2077
  */
2140
2078
  ValueString?: string | undefined;
@@ -2206,7 +2144,7 @@ export interface ContactSearchSummary {
2206
2144
  */
2207
2145
  ScheduledTimestamp?: Date | undefined;
2208
2146
  /**
2209
- * <p></p>
2147
+ * <p>Set of segment attributes for a contact.</p>
2210
2148
  * @public
2211
2149
  */
2212
2150
  SegmentAttributes?: Record<string, ContactSearchSummarySegmentAttributeValue> | undefined;
@@ -2232,7 +2170,7 @@ export interface SearchContactsResponse {
2232
2170
  TotalCount?: number | undefined;
2233
2171
  }
2234
2172
  /**
2235
- * <p></p>
2173
+ * <p>Filters to be applied to search results.</p>
2236
2174
  * @public
2237
2175
  */
2238
2176
  export interface EmailAddressSearchFilter {
@@ -2254,32 +2192,32 @@ export interface EmailAddressSearchFilter {
2254
2192
  TagFilter?: ControlPlaneTagFilter | undefined;
2255
2193
  }
2256
2194
  /**
2257
- * <p></p>
2195
+ * <p>Contains information about an email address for a contact center.</p>
2258
2196
  * @public
2259
2197
  */
2260
2198
  export interface EmailAddressMetadata {
2261
2199
  /**
2262
- * <p></p>
2200
+ * <p>The identifier of the email address.</p>
2263
2201
  * @public
2264
2202
  */
2265
2203
  EmailAddressId?: string | undefined;
2266
2204
  /**
2267
- * <p></p>
2205
+ * <p>The Amazon Resource Name (ARN) of the email address.</p>
2268
2206
  * @public
2269
2207
  */
2270
2208
  EmailAddressArn?: string | undefined;
2271
2209
  /**
2272
- * <p></p>
2210
+ * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
2273
2211
  * @public
2274
2212
  */
2275
2213
  EmailAddress?: string | undefined;
2276
2214
  /**
2277
- * <p></p>
2215
+ * <p>The description of the email address.</p>
2278
2216
  * @public
2279
2217
  */
2280
2218
  Description?: string | undefined;
2281
2219
  /**
2282
- * <p></p>
2220
+ * <p>The display name of email address.</p>
2283
2221
  * @public
2284
2222
  */
2285
2223
  DisplayName?: string | undefined;
@@ -2289,17 +2227,17 @@ export interface EmailAddressMetadata {
2289
2227
  */
2290
2228
  export interface SearchEmailAddressesResponse {
2291
2229
  /**
2292
- * <p></p>
2230
+ * <p>If there are additional results, this is the token for the next set of results.</p>
2293
2231
  * @public
2294
2232
  */
2295
2233
  NextToken?: string | undefined;
2296
2234
  /**
2297
- * <p></p>
2235
+ * <p>List of email addresses matching SearchFilter and SearchCriteria </p>
2298
2236
  * @public
2299
2237
  */
2300
2238
  EmailAddresses?: EmailAddressMetadata[] | undefined;
2301
2239
  /**
2302
- * <p></p>
2240
+ * <p>The total number of email addresses which matched your search query.</p>
2303
2241
  * @public
2304
2242
  */
2305
2243
  ApproximateTotalCount?: number | undefined;
@@ -3412,28 +3350,28 @@ export interface SendChatIntegrationEventResponse {
3412
3350
  NewChatCreated?: boolean | undefined;
3413
3351
  }
3414
3352
  /**
3415
- * <p></p>
3353
+ * <p>Contains information about a source or destination email address</p>
3416
3354
  * @public
3417
3355
  */
3418
3356
  export interface EmailAddressInfo {
3419
3357
  /**
3420
- * <p></p>
3358
+ * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
3421
3359
  * @public
3422
3360
  */
3423
3361
  EmailAddress: string | undefined;
3424
3362
  /**
3425
- * <p></p>
3363
+ * <p>The display name of email address.</p>
3426
3364
  * @public
3427
3365
  */
3428
3366
  DisplayName?: string | undefined;
3429
3367
  }
3430
3368
  /**
3431
- * <p></p>
3369
+ * <p>The additional recipients information of outbound email.</p>
3432
3370
  * @public
3433
3371
  */
3434
3372
  export interface OutboundAdditionalRecipients {
3435
3373
  /**
3436
- * <p></p>
3374
+ * <p>The additional CC email address recipients information.</p>
3437
3375
  * @public
3438
3376
  */
3439
3377
  CcEmailAddresses?: EmailAddressInfo[] | undefined;
@@ -3451,96 +3389,102 @@ export declare const OutboundMessageSourceType: {
3451
3389
  */
3452
3390
  export type OutboundMessageSourceType = (typeof OutboundMessageSourceType)[keyof typeof OutboundMessageSourceType];
3453
3391
  /**
3454
- * <p></p>
3392
+ * <p>Information about the raw email body content.</p>
3455
3393
  * @public
3456
3394
  */
3457
3395
  export interface OutboundRawMessage {
3458
3396
  /**
3459
- * <p></p>
3397
+ * <p>The email subject.</p>
3460
3398
  * @public
3461
3399
  */
3462
3400
  Subject: string | undefined;
3463
3401
  /**
3464
- * <p></p>
3402
+ * <p>The email message body.</p>
3465
3403
  * @public
3466
3404
  */
3467
3405
  Body: string | undefined;
3468
3406
  /**
3469
- * <p></p>
3407
+ * <p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>
3470
3408
  * @public
3471
3409
  */
3472
3410
  ContentType: string | undefined;
3473
3411
  }
3474
3412
  /**
3475
- * <p></p>
3413
+ * <p>Information about the template attributes.</p>
3476
3414
  * @public
3477
3415
  */
3478
3416
  export interface TemplateAttributes {
3479
3417
  /**
3480
- * <p></p>
3418
+ * <p>An object that specifies the custom attributes values to use for variables in the message
3419
+ * template. This object contains different categories of key-value pairs. Each key defines a
3420
+ * variable or placeholder in the message template. </p>
3481
3421
  * @public
3482
3422
  */
3483
3423
  CustomAttributes?: Record<string, string> | undefined;
3484
3424
  /**
3485
- * <p></p>
3425
+ * <p>An object that specifies the customer profile attributes values to use for variables in the
3426
+ * message template. This object contains different categories of key-value pairs. Each key defines
3427
+ * a variable or placeholder in the message template. </p>
3486
3428
  * @public
3487
3429
  */
3488
3430
  CustomerProfileAttributes?: string | undefined;
3489
3431
  }
3490
3432
  /**
3491
- * <p></p>
3433
+ * <p>Information about template message configuration.</p>
3492
3434
  * @public
3493
3435
  */
3494
3436
  export interface TemplatedMessageConfig {
3495
3437
  /**
3496
- * <p></p>
3438
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
3439
+ * the ARN.</p>
3497
3440
  * @public
3498
3441
  */
3499
3442
  KnowledgeBaseId: string | undefined;
3500
3443
  /**
3501
- * <p></p>
3444
+ * <p>The identifier of the message template Id.</p>
3502
3445
  * @public
3503
3446
  */
3504
3447
  MessageTemplateId: string | undefined;
3505
3448
  /**
3506
- * <p></p>
3449
+ * <p>Information about template attributes, that is, CustomAttributes or
3450
+ * CustomerProfileAttributes.</p>
3507
3451
  * @public
3508
3452
  */
3509
3453
  TemplateAttributes: TemplateAttributes | undefined;
3510
3454
  }
3511
3455
  /**
3512
- * <p></p>
3456
+ * <p>Information about email body content.</p>
3513
3457
  * @public
3514
3458
  */
3515
3459
  export interface OutboundEmailContent {
3516
3460
  /**
3517
- * <p></p>
3461
+ * <p>The message source type, that is, <code>RAW</code> or <code>TEMPLATE</code>.</p>
3518
3462
  * @public
3519
3463
  */
3520
3464
  MessageSourceType: OutboundMessageSourceType | undefined;
3521
3465
  /**
3522
- * <p></p>
3466
+ * <p>Information about template message configuration.</p>
3523
3467
  * @public
3524
3468
  */
3525
3469
  TemplatedMessageConfig?: TemplatedMessageConfig | undefined;
3526
3470
  /**
3527
- * <p></p>
3471
+ * <p>The raw email body content.</p>
3528
3472
  * @public
3529
3473
  */
3530
3474
  RawMessage?: OutboundRawMessage | undefined;
3531
3475
  }
3532
3476
  /**
3533
- * <p></p>
3477
+ * <p>Information about the campaign.</p>
3534
3478
  * @public
3535
3479
  */
3536
3480
  export interface SourceCampaign {
3537
3481
  /**
3538
- * <p></p>
3482
+ * <p>A unique identifier for a campaign.</p>
3539
3483
  * @public
3540
3484
  */
3541
3485
  CampaignId?: string | undefined;
3542
3486
  /**
3543
- * <p></p>
3487
+ * <p>A unique identifier for a each request part of same campaign.</p>
3544
3488
  * @public
3545
3489
  */
3546
3490
  OutboundRequestId?: string | undefined;
@@ -3562,42 +3506,45 @@ export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType];
3562
3506
  */
3563
3507
  export interface SendOutboundEmailRequest {
3564
3508
  /**
3565
- * <p></p>
3509
+ * <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>
3566
3510
  * @public
3567
3511
  */
3568
3512
  InstanceId: string | undefined;
3569
3513
  /**
3570
- * <p></p>
3514
+ * <p>The email address to be used for sending email.</p>
3571
3515
  * @public
3572
3516
  */
3573
3517
  FromEmailAddress: EmailAddressInfo | undefined;
3574
3518
  /**
3575
- * <p></p>
3519
+ * <p>The email address to send the email to.</p>
3576
3520
  * @public
3577
3521
  */
3578
3522
  DestinationEmailAddress: EmailAddressInfo | undefined;
3579
3523
  /**
3580
- * <p></p>
3524
+ * <p>The additional recipients address of the email in CC.</p>
3581
3525
  * @public
3582
3526
  */
3583
3527
  AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
3584
3528
  /**
3585
- * <p></p>
3529
+ * <p>The email message body to be sent to the newly created email.</p>
3586
3530
  * @public
3587
3531
  */
3588
3532
  EmailMessage: OutboundEmailContent | undefined;
3589
3533
  /**
3590
- * <p></p>
3534
+ * <p>Denotes the class of traffic.</p>
3591
3535
  * @public
3592
3536
  */
3593
3537
  TrafficType: TrafficType | undefined;
3594
3538
  /**
3595
- * <p></p>
3539
+ * <p>A Campaign object need for Campaign traffic type.</p>
3596
3540
  * @public
3597
3541
  */
3598
3542
  SourceCampaign?: SourceCampaign | undefined;
3599
3543
  /**
3600
- * <p></p>
3544
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3545
+ * request. If not provided, the Amazon Web Services
3546
+ * SDK populates this field. For more information about idempotency, see
3547
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3601
3548
  * @public
3602
3549
  */
3603
3550
  ClientToken?: string | undefined;
@@ -3642,12 +3589,15 @@ export interface StartAttachedFileUploadRequest {
3642
3589
  UrlExpiryInSeconds?: number | undefined;
3643
3590
  /**
3644
3591
  * <p>The use case for the file.</p>
3592
+ * <important>
3593
+ * <p> Only <code>ATTACHMENTS</code> are supported.</p>
3594
+ * </important>
3645
3595
  * @public
3646
3596
  */
3647
3597
  FileUseCaseType: FileUseCaseType | undefined;
3648
3598
  /**
3649
- * <p>The resource to which the attached file is (being) uploaded to. <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Cases</a> are the only
3650
- * current supported resource.</p>
3599
+ * <p>The resource to which the attached file is (being) uploaded to. The supported resources are
3600
+ * <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>
3651
3601
  * <note>
3652
3602
  * <p>This value must be a valid ARN.</p>
3653
3603
  * </note>
@@ -3794,109 +3744,6 @@ export interface PersistentChat {
3794
3744
  */
3795
3745
  SourceContactId?: string | undefined;
3796
3746
  }
3797
- /**
3798
- * @public
3799
- */
3800
- export interface StartChatContactRequest {
3801
- /**
3802
- * <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>
3803
- * @public
3804
- */
3805
- InstanceId: string | undefined;
3806
- /**
3807
- * <p>The identifier of the flow for initiating the chat.
3808
- * To
3809
- * see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the
3810
- * flow page, under the name of the flow, choose <b>Show additional flow
3811
- * information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
3812
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
3813
- * </p>
3814
- * @public
3815
- */
3816
- ContactFlowId: string | undefined;
3817
- /**
3818
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
3819
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
3820
- * can include only alphanumeric, dash, and underscore characters.</p>
3821
- * @public
3822
- */
3823
- Attributes?: Record<string, string> | undefined;
3824
- /**
3825
- * <p>Information identifying the participant.</p>
3826
- * @public
3827
- */
3828
- ParticipantDetails: ParticipantDetails | undefined;
3829
- /**
3830
- * <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
3831
- * flow, the initial message is not delivered to the Lex bot.</p>
3832
- * @public
3833
- */
3834
- InitialMessage?: ChatMessage | undefined;
3835
- /**
3836
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3837
- * request. If not provided, the Amazon Web Services
3838
- * SDK populates this field. For more information about idempotency, see
3839
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3840
- * @public
3841
- */
3842
- ClientToken?: string | undefined;
3843
- /**
3844
- * <p>The total duration of the newly started chat session. If not specified, the chat session
3845
- * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
3846
- * configurable time is 10,080 minutes (7 days).</p>
3847
- * @public
3848
- */
3849
- ChatDurationInMinutes?: number | undefined;
3850
- /**
3851
- * <p>The supported chat message content types. Supported types are <code>text/plain</code>,
3852
- * <code>text/markdown</code>, <code>application/json</code>,
3853
- * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
3854
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
3855
- * <p>Content types must always contain <code>text/plain</code>. You can then put any other
3856
- * supported type in the list. For example, all the following lists are valid because they contain
3857
- * <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
3858
- * <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
3859
- * application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
3860
- * <note>
3861
- * <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
3862
- * use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
3863
- * view</a> flow block.</p>
3864
- * </note>
3865
- * @public
3866
- */
3867
- SupportedMessagingContentTypes?: string[] | undefined;
3868
- /**
3869
- * <p>Enable persistent chats. For more information about enabling persistent chat, and for
3870
- * example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
3871
- * @public
3872
- */
3873
- PersistentChat?: PersistentChat | undefined;
3874
- /**
3875
- * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
3876
- * chat starting.</p>
3877
- * <note>
3878
- * <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
3879
- * </note>
3880
- * @public
3881
- */
3882
- RelatedContactId?: string | undefined;
3883
- /**
3884
- * <p>A set of system defined key-value pairs stored on individual contact segments using an
3885
- * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
3886
- * flows.</p>
3887
- * <p>Attribute keys can include only alphanumeric, -, and _.</p>
3888
- * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
3889
- * <note>
3890
- * <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
3891
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
3892
- * the SupportedMessagingContentTypes field of this API in order to set
3893
- * <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
3894
- * \}\}</code>.</p>
3895
- * </note>
3896
- * @public
3897
- */
3898
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
3899
- }
3900
3747
  /**
3901
3748
  * @public
3902
3749
  */
@@ -4063,33 +3910,33 @@ export interface StartContactStreamingResponse {
4063
3910
  StreamingId: string | undefined;
4064
3911
  }
4065
3912
  /**
4066
- * <p></p>
3913
+ * <p>The additional TO CC recipients information of inbound email.</p>
4067
3914
  * @public
4068
3915
  */
4069
3916
  export interface InboundAdditionalRecipients {
4070
3917
  /**
4071
- * <p></p>
3918
+ * <p>The additional recipients information present in to list.</p>
4072
3919
  * @public
4073
3920
  */
4074
3921
  ToAddresses?: EmailAddressInfo[] | undefined;
4075
3922
  /**
4076
- * <p></p>
3923
+ * <p>The additional recipients information present in cc list.</p>
4077
3924
  * @public
4078
3925
  */
4079
3926
  CcAddresses?: EmailAddressInfo[] | undefined;
4080
3927
  }
4081
3928
  /**
4082
- * <p></p>
3929
+ * <p>Information about the email attachment files.</p>
4083
3930
  * @public
4084
3931
  */
4085
3932
  export interface EmailAttachment {
4086
3933
  /**
4087
- * <p></p>
3934
+ * <p>A case-sensitive name of the attached file being uploaded.</p>
4088
3935
  * @public
4089
3936
  */
4090
3937
  FileName: string | undefined;
4091
3938
  /**
4092
- * <p></p>
3939
+ * <p>The pre-signed URLs for the S3 bucket where the email attachment is stored.</p>
4093
3940
  * @public
4094
3941
  */
4095
3942
  S3Url: string | undefined;
@@ -4121,43 +3968,43 @@ export declare const EmailHeaderType: {
4121
3968
  */
4122
3969
  export type EmailHeaderType = (typeof EmailHeaderType)[keyof typeof EmailHeaderType];
4123
3970
  /**
4124
- * <p></p>
3971
+ * <p>Information about the raw email body content.</p>
4125
3972
  * @public
4126
3973
  */
4127
3974
  export interface InboundRawMessage {
4128
3975
  /**
4129
- * <p></p>
3976
+ * <p>The email subject.</p>
4130
3977
  * @public
4131
3978
  */
4132
3979
  Subject: string | undefined;
4133
3980
  /**
4134
- * <p></p>
3981
+ * <p>The email message body.</p>
4135
3982
  * @public
4136
3983
  */
4137
3984
  Body: string | undefined;
4138
3985
  /**
4139
- * <p></p>
3986
+ * <p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>
4140
3987
  * @public
4141
3988
  */
4142
3989
  ContentType: string | undefined;
4143
3990
  /**
4144
- * <p></p>
3991
+ * <p>Headers present in inbound email.</p>
4145
3992
  * @public
4146
3993
  */
4147
3994
  Headers?: Partial<Record<EmailHeaderType, string>> | undefined;
4148
3995
  }
4149
3996
  /**
4150
- * <p></p>
3997
+ * <p>Information about email body content.</p>
4151
3998
  * @public
4152
3999
  */
4153
4000
  export interface InboundEmailContent {
4154
4001
  /**
4155
- * <p></p>
4002
+ * <p>The message source type, that is, <code>RAW</code>.</p>
4156
4003
  * @public
4157
4004
  */
4158
4005
  MessageSourceType: InboundMessageSourceType | undefined;
4159
4006
  /**
4160
- * <p></p>
4007
+ * <p>The raw email body content.</p>
4161
4008
  * @public
4162
4009
  */
4163
4010
  RawMessage?: InboundRawMessage | undefined;
@@ -4165,400 +4012,190 @@ export interface InboundEmailContent {
4165
4012
  /**
4166
4013
  * @public
4167
4014
  */
4168
- export interface StartEmailContactRequest {
4015
+ export interface StartEmailContactResponse {
4169
4016
  /**
4170
- * <p></p>
4017
+ * <p>The identifier of this contact within the Amazon Connect instance.</p>
4171
4018
  * @public
4172
4019
  */
4173
- InstanceId: string | undefined;
4020
+ ContactId?: string | undefined;
4021
+ }
4022
+ /**
4023
+ * @public
4024
+ */
4025
+ export interface StartOutboundChatContactResponse {
4174
4026
  /**
4175
- * <p></p>
4027
+ * <p>The identifier of this contact within the Amazon Connect instance.</p>
4176
4028
  * @public
4177
4029
  */
4178
- FromEmailAddress: EmailAddressInfo | undefined;
4030
+ ContactId?: string | undefined;
4031
+ }
4032
+ /**
4033
+ * @public
4034
+ */
4035
+ export interface StartOutboundEmailContactRequest {
4179
4036
  /**
4180
- * <p></p>
4037
+ * <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>
4181
4038
  * @public
4182
4039
  */
4183
- DestinationEmailAddress: string | undefined;
4040
+ InstanceId: string | undefined;
4184
4041
  /**
4185
- * <p></p>
4042
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
4186
4043
  * @public
4187
4044
  */
4188
- Description?: string | undefined;
4045
+ ContactId: string | undefined;
4189
4046
  /**
4190
- * <p></p>
4047
+ * <p>The email address associated with the instance.</p>
4191
4048
  * @public
4192
4049
  */
4193
- References?: Record<string, Reference> | undefined;
4050
+ FromEmailAddress?: EmailAddressInfo | undefined;
4194
4051
  /**
4195
- * <p></p>
4052
+ * <p>The email address of the customer.</p>
4196
4053
  * @public
4197
4054
  */
4198
- Name?: string | undefined;
4055
+ DestinationEmailAddress: EmailAddressInfo | undefined;
4199
4056
  /**
4200
- * <p></p>
4057
+ * <p>The addtional recipients address of email in CC.</p>
4201
4058
  * @public
4202
4059
  */
4203
- EmailMessage: InboundEmailContent | undefined;
4060
+ AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
4204
4061
  /**
4205
- * <p></p>
4062
+ * <p>The email message body to be sent to the newly created email.</p>
4206
4063
  * @public
4207
4064
  */
4208
- AdditionalRecipients?: InboundAdditionalRecipients | undefined;
4065
+ EmailMessage: OutboundEmailContent | undefined;
4209
4066
  /**
4210
- * <p></p>
4067
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4068
+ * request. If not provided, the Amazon Web Services
4069
+ * SDK populates this field. For more information about idempotency, see
4070
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4211
4071
  * @public
4212
4072
  */
4213
- Attachments?: EmailAttachment[] | undefined;
4073
+ ClientToken?: string | undefined;
4074
+ }
4075
+ /**
4076
+ * @public
4077
+ */
4078
+ export interface StartOutboundEmailContactResponse {
4214
4079
  /**
4215
- * <p></p>
4080
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
4216
4081
  * @public
4217
4082
  */
4218
- ContactFlowId?: string | undefined;
4083
+ ContactId?: string | undefined;
4084
+ }
4085
+ /**
4086
+ * <p>Outbound calls to the destination number are not allowed.</p>
4087
+ * @public
4088
+ */
4089
+ export declare class DestinationNotAllowedException extends __BaseException {
4090
+ readonly name: "DestinationNotAllowedException";
4091
+ readonly $fault: "client";
4219
4092
  /**
4220
- * <p></p>
4093
+ * <p>The message about the outbound calls.</p>
4221
4094
  * @public
4222
4095
  */
4223
- RelatedContactId?: string | undefined;
4096
+ Message?: string | undefined;
4224
4097
  /**
4225
- * <p></p>
4226
- * @public
4098
+ * @internal
4227
4099
  */
4228
- Attributes?: Record<string, string> | undefined;
4100
+ constructor(opts: __ExceptionOptionType<DestinationNotAllowedException, __BaseException>);
4101
+ }
4102
+ /**
4103
+ * <p>The contact is not permitted.</p>
4104
+ * @public
4105
+ */
4106
+ export declare class OutboundContactNotPermittedException extends __BaseException {
4107
+ readonly name: "OutboundContactNotPermittedException";
4108
+ readonly $fault: "client";
4229
4109
  /**
4230
- * <p></p>
4110
+ * <p>The message about the contact.</p>
4231
4111
  * @public
4232
4112
  */
4233
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
4113
+ Message?: string | undefined;
4234
4114
  /**
4235
- * <p></p>
4236
- * @public
4115
+ * @internal
4237
4116
  */
4238
- ClientToken?: string | undefined;
4117
+ constructor(opts: __ExceptionOptionType<OutboundContactNotPermittedException, __BaseException>);
4239
4118
  }
4240
4119
  /**
4120
+ * <p>Configuration of the answering machine detection.</p>
4241
4121
  * @public
4242
4122
  */
4243
- export interface StartEmailContactResponse {
4123
+ export interface AnswerMachineDetectionConfig {
4124
+ /**
4125
+ * <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
4126
+ * call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
4127
+ * </p>
4128
+ * @public
4129
+ */
4130
+ EnableAnswerMachineDetection?: boolean | undefined;
4244
4131
  /**
4245
- * <p></p>
4132
+ * <p>Wait for the answering machine prompt.</p>
4246
4133
  * @public
4247
4134
  */
4248
- ContactId?: string | undefined;
4135
+ AwaitAnswerMachinePrompt?: boolean | undefined;
4249
4136
  }
4250
4137
  /**
4251
4138
  * @public
4252
4139
  */
4253
- export interface StartOutboundChatContactRequest {
4140
+ export interface StartOutboundVoiceContactRequest {
4254
4141
  /**
4255
- * <p>Information about the endpoint.</p>
4142
+ * <p>The name of a voice contact that is shown to an agent in the Contact Control Panel
4143
+ * (CCP).</p>
4256
4144
  * @public
4257
4145
  */
4258
- SourceEndpoint: Endpoint | undefined;
4146
+ Name?: string | undefined;
4259
4147
  /**
4260
- * <p>Information about the endpoint.</p>
4148
+ * <p>A description of the voice contact that is shown to an agent in the Contact Control Panel
4149
+ * (CCP).</p>
4261
4150
  * @public
4262
4151
  */
4263
- DestinationEndpoint: Endpoint | undefined;
4152
+ Description?: string | undefined;
4264
4153
  /**
4265
- * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
4266
- * Amazon Resource Name (ARN) of the instance.</p>
4154
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
4155
+ * have the following reference types at the time of creation: <code>URL</code> |
4156
+ * <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>.
4157
+ * <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
4267
4158
  * @public
4268
4159
  */
4269
- InstanceId: string | undefined;
4160
+ References?: Record<string, Reference> | undefined;
4270
4161
  /**
4271
- * <p>A set of system defined key-value pairs stored on individual contact segments using an
4272
- * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
4273
- * flows.</p>
4274
- * <ul>
4275
- * <li>
4276
- * <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
4277
- * </li>
4278
- * <li>
4279
- * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and
4280
- * <code>connect:SMS</code>.</p>
4281
- * </li>
4282
- * </ul>
4162
+ * <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by
4163
+ * using <code>RelatedContactID</code> copies over contact attributes from the related contact to
4164
+ * the new contact. All updates to user-defined attributes in the new contact are limited to the
4165
+ * individual contact ID. There are no limits to the number of contacts that can be linked by using
4166
+ * <code>RelatedContactId</code>. </p>
4283
4167
  * @public
4284
4168
  */
4285
- SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
4169
+ RelatedContactId?: string | undefined;
4286
4170
  /**
4287
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
4171
+ * <p>The phone number of the customer, in E.164 format.</p>
4288
4172
  * @public
4289
4173
  */
4290
- Attributes?: Record<string, string> | undefined;
4174
+ DestinationPhoneNumber: string | undefined;
4291
4175
  /**
4292
- * <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect
4293
- * console user interface, on the navigation menu go to <b>Routing, Contact
4176
+ * <p>The
4177
+ * identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the
4178
+ * navigation menu go to <b>Routing</b>, <b>Contact
4294
4179
  * Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
4295
4180
  * <b>Show additional flow information</b>. The ContactFlowId is the last
4296
- * part of the ARN, shown here in bold:</p>
4297
- * <ul>
4298
- * <li>
4299
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
4300
- * </p>
4301
- * </li>
4302
- * </ul>
4181
+ * part of the ARN, shown here in bold: </p>
4182
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
4183
+ * </p>
4303
4184
  * @public
4304
4185
  */
4305
4186
  ContactFlowId: string | undefined;
4306
4187
  /**
4307
- * <p>The total duration of the newly started chat session. If not specified, the chat session
4308
- * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
4309
- * configurable time is 10,080 minutes (7 days).</p>
4188
+ * <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>
4310
4189
  * @public
4311
4190
  */
4312
- ChatDurationInMinutes?: number | undefined;
4191
+ InstanceId: string | undefined;
4313
4192
  /**
4314
- * <p>The customer's details.</p>
4315
- * @public
4316
- */
4317
- ParticipantDetails?: ParticipantDetails | undefined;
4318
- /**
4319
- * <p>A chat message.</p>
4320
- * @public
4321
- */
4322
- InitialSystemMessage?: ChatMessage | undefined;
4323
- /**
4324
- * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
4325
- * contact starting.</p>
4326
- * @public
4327
- */
4328
- RelatedContactId?: string | undefined;
4329
- /**
4330
- * <p>The supported chat message content types. Supported types are:</p>
4331
- * <ul>
4332
- * <li>
4333
- * <p>
4334
- * <code>text/plain</code>
4335
- * </p>
4336
- * </li>
4337
- * <li>
4338
- * <p>
4339
- * <code>text/markdown</code>
4340
- * </p>
4341
- * </li>
4342
- * <li>
4343
- * <p>
4344
- * <code>application/json,
4345
- * application/vnd.amazonaws.connect.message.interactive</code>
4346
- * </p>
4347
- * </li>
4348
- * <li>
4349
- * <p>
4350
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code>
4351
- * </p>
4352
- * </li>
4353
- * </ul>
4354
- * <p>Content types must always contain <code>text/plain</code>. You can then put any other
4355
- * supported type in the list. For example, all the following lists are valid because they contain
4356
- * <code>text/plain</code>:</p>
4357
- * <ul>
4358
- * <li>
4359
- * <p>
4360
- * <code>[text/plain, text/markdown, application/json]</code>
4361
- * </p>
4362
- * </li>
4363
- * <li>
4364
- * <p>
4365
- * <code>[text/markdown, text/plain]</code>
4366
- * </p>
4367
- * </li>
4368
- * <li>
4369
- * <p>
4370
- * <code>[text/plain, application/json,
4371
- * application/vnd.amazonaws.connect.message.interactive.response]</code>
4372
- * </p>
4373
- * </li>
4374
- * </ul>
4375
- * @public
4376
- */
4377
- SupportedMessagingContentTypes?: string[] | undefined;
4378
- /**
4379
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4380
- * request. If not provided, the AWS SDK populates this field. For more information about
4381
- * idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making
4382
- * retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a
4383
- * contact is already started, the contact ID is returned.</p>
4384
- * @public
4385
- */
4386
- ClientToken?: string | undefined;
4387
- }
4388
- /**
4389
- * @public
4390
- */
4391
- export interface StartOutboundChatContactResponse {
4392
- /**
4393
- * <p>The identifier of this contact within the Amazon Connect instance.</p>
4394
- * @public
4395
- */
4396
- ContactId?: string | undefined;
4397
- }
4398
- /**
4399
- * @public
4400
- */
4401
- export interface StartOutboundEmailContactRequest {
4402
- /**
4403
- * <p></p>
4404
- * @public
4405
- */
4406
- InstanceId: string | undefined;
4407
- /**
4408
- * <p></p>
4409
- * @public
4410
- */
4411
- ContactId: string | undefined;
4412
- /**
4413
- * <p></p>
4414
- * @public
4415
- */
4416
- FromEmailAddress?: EmailAddressInfo | undefined;
4417
- /**
4418
- * <p></p>
4419
- * @public
4420
- */
4421
- DestinationEmailAddress: EmailAddressInfo | undefined;
4422
- /**
4423
- * <p></p>
4424
- * @public
4425
- */
4426
- AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
4427
- /**
4428
- * <p></p>
4429
- * @public
4430
- */
4431
- EmailMessage: OutboundEmailContent | undefined;
4432
- /**
4433
- * <p></p>
4434
- * @public
4435
- */
4436
- ClientToken?: string | undefined;
4437
- }
4438
- /**
4439
- * @public
4440
- */
4441
- export interface StartOutboundEmailContactResponse {
4442
- /**
4443
- * <p></p>
4444
- * @public
4445
- */
4446
- ContactId?: string | undefined;
4447
- }
4448
- /**
4449
- * <p>Outbound calls to the destination number are not allowed.</p>
4450
- * @public
4451
- */
4452
- export declare class DestinationNotAllowedException extends __BaseException {
4453
- readonly name: "DestinationNotAllowedException";
4454
- readonly $fault: "client";
4455
- /**
4456
- * <p>The message about the outbound calls.</p>
4457
- * @public
4458
- */
4459
- Message?: string | undefined;
4460
- /**
4461
- * @internal
4462
- */
4463
- constructor(opts: __ExceptionOptionType<DestinationNotAllowedException, __BaseException>);
4464
- }
4465
- /**
4466
- * <p>The contact is not permitted.</p>
4467
- * @public
4468
- */
4469
- export declare class OutboundContactNotPermittedException extends __BaseException {
4470
- readonly name: "OutboundContactNotPermittedException";
4471
- readonly $fault: "client";
4472
- /**
4473
- * <p>The message about the contact.</p>
4474
- * @public
4475
- */
4476
- Message?: string | undefined;
4477
- /**
4478
- * @internal
4479
- */
4480
- constructor(opts: __ExceptionOptionType<OutboundContactNotPermittedException, __BaseException>);
4481
- }
4482
- /**
4483
- * <p>Configuration of the answering machine detection.</p>
4484
- * @public
4485
- */
4486
- export interface AnswerMachineDetectionConfig {
4487
- /**
4488
- * <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
4489
- * call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
4490
- * </p>
4491
- * @public
4492
- */
4493
- EnableAnswerMachineDetection?: boolean | undefined;
4494
- /**
4495
- * <p>Wait for the answering machine prompt.</p>
4496
- * @public
4497
- */
4498
- AwaitAnswerMachinePrompt?: boolean | undefined;
4499
- }
4500
- /**
4501
- * @public
4502
- */
4503
- export interface StartOutboundVoiceContactRequest {
4504
- /**
4505
- * <p>The name of a voice contact that is shown to an agent in the Contact Control Panel
4506
- * (CCP).</p>
4507
- * @public
4508
- */
4509
- Name?: string | undefined;
4510
- /**
4511
- * <p>A description of the voice contact that is shown to an agent in the Contact Control Panel
4512
- * (CCP).</p>
4513
- * @public
4514
- */
4515
- Description?: string | undefined;
4516
- /**
4517
- * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
4518
- * have the following reference types at the time of creation: <code>URL</code> |
4519
- * <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>.
4520
- * <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
4521
- * @public
4522
- */
4523
- References?: Record<string, Reference> | undefined;
4524
- /**
4525
- * <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by
4526
- * using <code>RelatedContactID</code> copies over contact attributes from the related contact to
4527
- * the new contact. All updates to user-defined attributes in the new contact are limited to the
4528
- * individual contact ID. There are no limits to the number of contacts that can be linked by using
4529
- * <code>RelatedContactId</code>. </p>
4530
- * @public
4531
- */
4532
- RelatedContactId?: string | undefined;
4533
- /**
4534
- * <p>The phone number of the customer, in E.164 format.</p>
4535
- * @public
4536
- */
4537
- DestinationPhoneNumber: string | undefined;
4538
- /**
4539
- * <p>The
4540
- * identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the
4541
- * navigation menu go to <b>Routing</b>, <b>Contact
4542
- * Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
4543
- * <b>Show additional flow information</b>. The ContactFlowId is the last
4544
- * part of the ARN, shown here in bold: </p>
4545
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
4546
- * </p>
4547
- * @public
4548
- */
4549
- ContactFlowId: string | undefined;
4550
- /**
4551
- * <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>
4552
- * @public
4553
- */
4554
- InstanceId: string | undefined;
4555
- /**
4556
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4557
- * request. If not provided, the Amazon Web Services
4558
- * SDK populates this field. For more information about idempotency, see
4559
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started,
4560
- * the contact ID is returned.
4561
- * </p>
4193
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4194
+ * request. If not provided, the Amazon Web Services
4195
+ * SDK populates this field. For more information about idempotency, see
4196
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started,
4197
+ * the contact ID is returned.
4198
+ * </p>
4562
4199
  * @public
4563
4200
  */
4564
4201
  ClientToken?: string | undefined;
@@ -4639,101 +4276,6 @@ export interface StartScreenSharingRequest {
4639
4276
  */
4640
4277
  export interface StartScreenSharingResponse {
4641
4278
  }
4642
- /**
4643
- * @public
4644
- */
4645
- export interface StartTaskContactRequest {
4646
- /**
4647
- * <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>
4648
- * @public
4649
- */
4650
- InstanceId: string | undefined;
4651
- /**
4652
- * <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
4653
- * attributes to task contacts linked using the same <code>PreviousContactID</code> will affect
4654
- * every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
4655
- * @public
4656
- */
4657
- PreviousContactId?: string | undefined;
4658
- /**
4659
- * <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
4660
- * on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
4661
- * <b>Show additional flow information</b>. The ContactFlowId is the last
4662
- * part of the ARN, shown here in bold: </p>
4663
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
4664
- * </p>
4665
- * @public
4666
- */
4667
- ContactFlowId?: string | undefined;
4668
- /**
4669
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
4670
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
4671
- * can include only alphanumeric, dash, and underscore characters.</p>
4672
- * @public
4673
- */
4674
- Attributes?: Record<string, string> | undefined;
4675
- /**
4676
- * <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
4677
- * @public
4678
- */
4679
- Name: string | undefined;
4680
- /**
4681
- * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
4682
- * the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
4683
- * <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
4684
- * supported reference type during task creation.</p>
4685
- * @public
4686
- */
4687
- References?: Record<string, Reference> | undefined;
4688
- /**
4689
- * <p>A description of the task that is shown to an agent in the Contact Control Panel
4690
- * (CCP).</p>
4691
- * @public
4692
- */
4693
- Description?: string | undefined;
4694
- /**
4695
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4696
- * request. If not provided, the Amazon Web Services
4697
- * SDK populates this field. For more information about idempotency, see
4698
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4699
- * @public
4700
- */
4701
- ClientToken?: string | undefined;
4702
- /**
4703
- * <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
4704
- * @public
4705
- */
4706
- ScheduledTime?: Date | undefined;
4707
- /**
4708
- * <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the
4709
- * <i>Amazon Connect Administrator Guide</i>. </p>
4710
- * @public
4711
- */
4712
- TaskTemplateId?: string | undefined;
4713
- /**
4714
- * <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
4715
- * flow that is defined on agent or queue quick connect. For more information about quick connects,
4716
- * see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
4717
- * connects</a>.</p>
4718
- * @public
4719
- */
4720
- QuickConnectId?: string | undefined;
4721
- /**
4722
- * <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking
4723
- * tasks together by using <code>RelatedContactID</code> copies over contact attributes from the
4724
- * related task contact to the new task contact. All updates to user-defined attributes in the new
4725
- * task contact are limited to the individual contact ID, unlike what happens when tasks are linked
4726
- * by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
4727
- * be linked by using <code>RelatedContactId</code>. </p>
4728
- * @public
4729
- */
4730
- RelatedContactId?: string | undefined;
4731
- /**
4732
- * <p></p>
4733
- * @public
4734
- */
4735
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
4736
- }
4737
4279
  /**
4738
4280
  * @public
4739
4281
  */
@@ -5375,42 +4917,6 @@ export interface UpdateAuthenticationProfileRequest {
5375
4917
  */
5376
4918
  PeriodicSessionDuration?: number | undefined;
5377
4919
  }
5378
- /**
5379
- * @public
5380
- */
5381
- export interface UpdateContactRequest {
5382
- /**
5383
- * <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>
5384
- * @public
5385
- */
5386
- InstanceId: string | undefined;
5387
- /**
5388
- * <p>The identifier of the contact. This is the identifier of the contact associated with the
5389
- * first interaction with your contact center.</p>
5390
- * @public
5391
- */
5392
- ContactId: string | undefined;
5393
- /**
5394
- * <p>The name of the contact.</p>
5395
- * @public
5396
- */
5397
- Name?: string | undefined;
5398
- /**
5399
- * <p>The description of the contact.</p>
5400
- * @public
5401
- */
5402
- Description?: string | undefined;
5403
- /**
5404
- * <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
5405
- * @public
5406
- */
5407
- References?: Record<string, Reference> | undefined;
5408
- /**
5409
- * <p></p>
5410
- * @public
5411
- */
5412
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
5413
- }
5414
4920
  /**
5415
4921
  * @public
5416
4922
  */
@@ -5700,27 +5206,30 @@ export interface UpdateContactScheduleResponse {
5700
5206
  */
5701
5207
  export interface UpdateEmailAddressMetadataRequest {
5702
5208
  /**
5703
- * <p></p>
5209
+ * <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>
5704
5210
  * @public
5705
5211
  */
5706
5212
  InstanceId: string | undefined;
5707
5213
  /**
5708
- * <p></p>
5214
+ * <p>The identifier of the email address.</p>
5709
5215
  * @public
5710
5216
  */
5711
5217
  EmailAddressId: string | undefined;
5712
5218
  /**
5713
- * <p></p>
5219
+ * <p>The description of the email address.</p>
5714
5220
  * @public
5715
5221
  */
5716
5222
  Description?: string | undefined;
5717
5223
  /**
5718
- * <p></p>
5224
+ * <p>The display name of email address.</p>
5719
5225
  * @public
5720
5226
  */
5721
5227
  DisplayName?: string | undefined;
5722
5228
  /**
5723
- * <p></p>
5229
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5230
+ * request. If not provided, the Amazon Web Services
5231
+ * SDK populates this field. For more information about idempotency, see
5232
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5724
5233
  * @public
5725
5234
  */
5726
5235
  ClientToken?: string | undefined;
@@ -5730,12 +5239,12 @@ export interface UpdateEmailAddressMetadataRequest {
5730
5239
  */
5731
5240
  export interface UpdateEmailAddressMetadataResponse {
5732
5241
  /**
5733
- * <p></p>
5242
+ * <p>The identifier of the email address.</p>
5734
5243
  * @public
5735
5244
  */
5736
5245
  EmailAddressId?: string | undefined;
5737
5246
  /**
5738
- * <p></p>
5247
+ * <p>The Amazon Resource Name (ARN) of the email address.</p>
5739
5248
  * @public
5740
5249
  */
5741
5250
  EmailAddressArn?: string | undefined;
@@ -6242,7 +5751,7 @@ export interface UpdateQueueOutboundCallerConfigRequest {
6242
5751
  OutboundCallerConfig: OutboundCallerConfig | undefined;
6243
5752
  }
6244
5753
  /**
6245
- * <p></p>
5754
+ * <p>A conditional check failed.</p>
6246
5755
  * @public
6247
5756
  */
6248
5757
  export declare class ConditionalOperationFailedException extends __BaseException {
@@ -6259,17 +5768,17 @@ export declare class ConditionalOperationFailedException extends __BaseException
6259
5768
  */
6260
5769
  export interface UpdateQueueOutboundEmailConfigRequest {
6261
5770
  /**
6262
- * <p></p>
5771
+ * <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>
6263
5772
  * @public
6264
5773
  */
6265
5774
  InstanceId: string | undefined;
6266
5775
  /**
6267
- * <p></p>
5776
+ * <p>The identifier for the queue.</p>
6268
5777
  * @public
6269
5778
  */
6270
5779
  QueueId: string | undefined;
6271
5780
  /**
6272
- * <p></p>
5781
+ * <p>The outbound email address ID for a specified queue.</p>
6273
5782
  * @public
6274
5783
  */
6275
5784
  OutboundEmailConfig: OutboundEmailConfig | undefined;
@@ -6568,7 +6077,8 @@ export interface UpdateTaskTemplateRequest {
6568
6077
  */
6569
6078
  ContactFlowId?: string | undefined;
6570
6079
  /**
6571
- * <p></p>
6080
+ * <p>The ContactFlowId for the flow that will be run if this template is used to create a
6081
+ * self-assigned task.</p>
6572
6082
  * @public
6573
6083
  */
6574
6084
  SelfAssignFlowId?: string | undefined;
@@ -6630,7 +6140,8 @@ export interface UpdateTaskTemplateResponse {
6630
6140
  */
6631
6141
  ContactFlowId?: string | undefined;
6632
6142
  /**
6633
- * <p></p>
6143
+ * <p>The ContactFlowId for the flow that will be run if this template is used to create a
6144
+ * self-assigned task.</p>
6634
6145
  * @public
6635
6146
  */
6636
6147
  SelfAssignFlowId?: string | undefined;
@@ -6973,6 +6484,28 @@ export interface UpdateViewMetadataRequest {
6973
6484
  */
6974
6485
  export interface UpdateViewMetadataResponse {
6975
6486
  }
6487
+ /**
6488
+ * <p>A value for a segment attribute. This is structured as a map where the key is
6489
+ * <code>valueString</code> and the value is a string.</p>
6490
+ * @public
6491
+ */
6492
+ export interface SegmentAttributeValue {
6493
+ /**
6494
+ * <p>The value of a segment attribute.</p>
6495
+ * @public
6496
+ */
6497
+ ValueString?: string | undefined;
6498
+ /**
6499
+ * <p>The value of a segment attribute.</p>
6500
+ * @public
6501
+ */
6502
+ ValueMap?: Record<string, SegmentAttributeValue> | undefined;
6503
+ /**
6504
+ * <p>The value of a segment attribute.</p>
6505
+ * @public
6506
+ */
6507
+ ValueInteger?: number | undefined;
6508
+ }
6976
6509
  /**
6977
6510
  * <p>Information about an item from an evaluation form. The item must be either a section or a
6978
6511
  * question.</p>
@@ -7104,6 +6637,307 @@ export interface ContactFlowModuleSearchCriteria {
7104
6637
  */
7105
6638
  StringCondition?: StringCondition | undefined;
7106
6639
  }
6640
+ /**
6641
+ * <p>The search criteria to be used to return flows.</p>
6642
+ * @public
6643
+ */
6644
+ export interface ContactFlowSearchCriteria {
6645
+ /**
6646
+ * <p>A list of conditions which would be applied together with an <code>OR</code>
6647
+ * condition.</p>
6648
+ * @public
6649
+ */
6650
+ OrConditions?: ContactFlowSearchCriteria[] | undefined;
6651
+ /**
6652
+ * <p>A list of conditions which would be applied together with an <code>AND</code>
6653
+ * condition.</p>
6654
+ * @public
6655
+ */
6656
+ AndConditions?: ContactFlowSearchCriteria[] | undefined;
6657
+ /**
6658
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6659
+ * @public
6660
+ */
6661
+ StringCondition?: StringCondition | undefined;
6662
+ /**
6663
+ * <p>The type of flow.</p>
6664
+ * @public
6665
+ */
6666
+ TypeCondition?: ContactFlowType | undefined;
6667
+ /**
6668
+ * <p>The state of the flow.</p>
6669
+ * @public
6670
+ */
6671
+ StateCondition?: ContactFlowState | undefined;
6672
+ /**
6673
+ * <p>The status of the flow.</p>
6674
+ * @public
6675
+ */
6676
+ StatusCondition?: ContactFlowStatus | undefined;
6677
+ }
6678
+ /**
6679
+ * @public
6680
+ */
6681
+ export interface CreateContactRequest {
6682
+ /**
6683
+ * <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>
6684
+ * @public
6685
+ */
6686
+ InstanceId: string | undefined;
6687
+ /**
6688
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6689
+ * request. If not provided, the Amazon Web Services
6690
+ * SDK populates this field. For more information about idempotency, see
6691
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6692
+ * @public
6693
+ */
6694
+ ClientToken?: string | undefined;
6695
+ /**
6696
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
6697
+ * @public
6698
+ */
6699
+ RelatedContactId?: string | undefined;
6700
+ /**
6701
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
6702
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
6703
+ * can include only alphanumeric, dash, and underscore characters.</p>
6704
+ * @public
6705
+ */
6706
+ Attributes?: Record<string, string> | undefined;
6707
+ /**
6708
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
6709
+ * the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL |
6710
+ * ATTACHMENT.</p>
6711
+ * @public
6712
+ */
6713
+ References?: Record<string, Reference> | undefined;
6714
+ /**
6715
+ * <p>The channel for the contact</p>
6716
+ * @public
6717
+ */
6718
+ Channel: Channel | undefined;
6719
+ /**
6720
+ * <p>Indicates how the contact was initiated.</p>
6721
+ * @public
6722
+ */
6723
+ InitiationMethod: ContactInitiationMethod | undefined;
6724
+ /**
6725
+ * <p>Number of minutes the contact will be active for before expiring</p>
6726
+ * @public
6727
+ */
6728
+ ExpiryDurationInMinutes?: number | undefined;
6729
+ /**
6730
+ * <p>User details for the contact</p>
6731
+ * @public
6732
+ */
6733
+ UserInfo?: UserInfo | undefined;
6734
+ /**
6735
+ * <p>Initial state of the contact when it's created</p>
6736
+ * @public
6737
+ */
6738
+ InitiateAs?: InitiateAs | undefined;
6739
+ /**
6740
+ * <p>The name of a the contact.</p>
6741
+ * @public
6742
+ */
6743
+ Name?: string | undefined;
6744
+ /**
6745
+ * <p>A description of the contact.</p>
6746
+ * @public
6747
+ */
6748
+ Description?: string | undefined;
6749
+ /**
6750
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique
6751
+ * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
6752
+ * They can be accessed in flows.</p>
6753
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
6754
+ * <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
6755
+ * <note>
6756
+ * <p>To set contact expiry, a ValueMap must be specified containing the integer number of
6757
+ * minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
6758
+ * \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
6759
+ * 135\}\}\}\}</code>. </p>
6760
+ * </note>
6761
+ * @public
6762
+ */
6763
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
6764
+ }
6765
+ /**
6766
+ * @public
6767
+ */
6768
+ export interface CreateEvaluationFormRequest {
6769
+ /**
6770
+ * <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>
6771
+ * @public
6772
+ */
6773
+ InstanceId: string | undefined;
6774
+ /**
6775
+ * <p>A title of the evaluation form.</p>
6776
+ * @public
6777
+ */
6778
+ Title: string | undefined;
6779
+ /**
6780
+ * <p>The description of the evaluation form.</p>
6781
+ * @public
6782
+ */
6783
+ Description?: string | undefined;
6784
+ /**
6785
+ * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
6786
+ * @public
6787
+ */
6788
+ Items: EvaluationFormItem[] | undefined;
6789
+ /**
6790
+ * <p>A scoring strategy of the evaluation form.</p>
6791
+ * @public
6792
+ */
6793
+ ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
6794
+ /**
6795
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6796
+ * request. If not provided, the Amazon Web Services
6797
+ * SDK populates this field. For more information about idempotency, see
6798
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6799
+ * @public
6800
+ */
6801
+ ClientToken?: string | undefined;
6802
+ }
6803
+ /**
6804
+ * <p>The search criteria to be used to return email addresses.</p>
6805
+ * @public
6806
+ */
6807
+ export interface EmailAddressSearchCriteria {
6808
+ /**
6809
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
6810
+ * @public
6811
+ */
6812
+ OrConditions?: EmailAddressSearchCriteria[] | undefined;
6813
+ /**
6814
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
6815
+ * @public
6816
+ */
6817
+ AndConditions?: EmailAddressSearchCriteria[] | undefined;
6818
+ /**
6819
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6820
+ * @public
6821
+ */
6822
+ StringCondition?: StringCondition | undefined;
6823
+ }
6824
+ /**
6825
+ * <p>Information about the evaluation form.</p>
6826
+ * @public
6827
+ */
6828
+ export interface EvaluationForm {
6829
+ /**
6830
+ * <p>The unique identifier for the evaluation form.</p>
6831
+ * @public
6832
+ */
6833
+ EvaluationFormId: string | undefined;
6834
+ /**
6835
+ * <p>A version of the evaluation form.</p>
6836
+ * @public
6837
+ */
6838
+ EvaluationFormVersion: number | undefined;
6839
+ /**
6840
+ * <p>The flag indicating whether the evaluation form is locked for changes.</p>
6841
+ * @public
6842
+ */
6843
+ Locked: boolean | undefined;
6844
+ /**
6845
+ * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
6846
+ * @public
6847
+ */
6848
+ EvaluationFormArn: string | undefined;
6849
+ /**
6850
+ * <p>A title of the evaluation form.</p>
6851
+ * @public
6852
+ */
6853
+ Title: string | undefined;
6854
+ /**
6855
+ * <p>The description of the evaluation form.</p>
6856
+ * @public
6857
+ */
6858
+ Description?: string | undefined;
6859
+ /**
6860
+ * <p>The status of the evaluation form.</p>
6861
+ * @public
6862
+ */
6863
+ Status: EvaluationFormVersionStatus | undefined;
6864
+ /**
6865
+ * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
6866
+ * @public
6867
+ */
6868
+ Items: EvaluationFormItem[] | undefined;
6869
+ /**
6870
+ * <p>A scoring strategy of the evaluation form.</p>
6871
+ * @public
6872
+ */
6873
+ ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
6874
+ /**
6875
+ * <p>The timestamp for when the evaluation form was created.</p>
6876
+ * @public
6877
+ */
6878
+ CreatedTime: Date | undefined;
6879
+ /**
6880
+ * <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
6881
+ * @public
6882
+ */
6883
+ CreatedBy: string | undefined;
6884
+ /**
6885
+ * <p>The timestamp for when the evaluation form was last updated.</p>
6886
+ * @public
6887
+ */
6888
+ LastModifiedTime: Date | undefined;
6889
+ /**
6890
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
6891
+ * @public
6892
+ */
6893
+ LastModifiedBy: string | undefined;
6894
+ /**
6895
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
6896
+ * @public
6897
+ */
6898
+ Tags?: Record<string, string> | undefined;
6899
+ }
6900
+ /**
6901
+ * <p>Information about an evaluation form used in a contact evaluation.</p>
6902
+ * @public
6903
+ */
6904
+ export interface EvaluationFormContent {
6905
+ /**
6906
+ * <p>A version of the evaluation form.</p>
6907
+ * @public
6908
+ */
6909
+ EvaluationFormVersion: number | undefined;
6910
+ /**
6911
+ * <p>The unique identifier for the evaluation form.</p>
6912
+ * @public
6913
+ */
6914
+ EvaluationFormId: string | undefined;
6915
+ /**
6916
+ * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
6917
+ * @public
6918
+ */
6919
+ EvaluationFormArn: string | undefined;
6920
+ /**
6921
+ * <p>A title of the evaluation form.</p>
6922
+ * @public
6923
+ */
6924
+ Title: string | undefined;
6925
+ /**
6926
+ * <p>The description of the evaluation form.</p>
6927
+ * @public
6928
+ */
6929
+ Description?: string | undefined;
6930
+ /**
6931
+ * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
6932
+ * @public
6933
+ */
6934
+ Items: EvaluationFormItem[] | undefined;
6935
+ /**
6936
+ * <p>A scoring strategy of the evaluation form.</p>
6937
+ * @public
6938
+ */
6939
+ ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
6940
+ }
7107
6941
  /**
7108
6942
  * @internal
7109
6943
  */
@@ -7212,10 +7046,6 @@ export declare const InboundRawMessageFilterSensitiveLog: (obj: InboundRawMessag
7212
7046
  * @internal
7213
7047
  */
7214
7048
  export declare const InboundEmailContentFilterSensitiveLog: (obj: InboundEmailContent) => any;
7215
- /**
7216
- * @internal
7217
- */
7218
- export declare const StartEmailContactRequestFilterSensitiveLog: (obj: StartEmailContactRequest) => any;
7219
7049
  /**
7220
7050
  * @internal
7221
7051
  */
@@ -7224,10 +7054,6 @@ export declare const StartOutboundEmailContactRequestFilterSensitiveLog: (obj: S
7224
7054
  * @internal
7225
7055
  */
7226
7056
  export declare const StartOutboundVoiceContactRequestFilterSensitiveLog: (obj: StartOutboundVoiceContactRequest) => any;
7227
- /**
7228
- * @internal
7229
- */
7230
- export declare const StartTaskContactRequestFilterSensitiveLog: (obj: StartTaskContactRequest) => any;
7231
7057
  /**
7232
7058
  * @internal
7233
7059
  */
@@ -7244,10 +7070,6 @@ export declare const ConnectionDataFilterSensitiveLog: (obj: ConnectionData) =>
7244
7070
  * @internal
7245
7071
  */
7246
7072
  export declare const StartWebRTCContactResponseFilterSensitiveLog: (obj: StartWebRTCContactResponse) => any;
7247
- /**
7248
- * @internal
7249
- */
7250
- export declare const UpdateContactRequestFilterSensitiveLog: (obj: UpdateContactRequest) => any;
7251
7073
  /**
7252
7074
  * @internal
7253
7075
  */
@@ -7268,3 +7090,7 @@ export declare const UpdateViewContentResponseFilterSensitiveLog: (obj: UpdateVi
7268
7090
  * @internal
7269
7091
  */
7270
7092
  export declare const UpdateViewMetadataRequestFilterSensitiveLog: (obj: UpdateViewMetadataRequest) => any;
7093
+ /**
7094
+ * @internal
7095
+ */
7096
+ export declare const CreateContactRequestFilterSensitiveLog: (obj: CreateContactRequest) => any;