@aws-sdk/client-connect 3.699.0 → 3.703.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist-cjs/index.js +123 -49
- package/dist-es/commands/CreateContactCommand.js +1 -1
- package/dist-es/commands/StartEmailContactCommand.js +1 -1
- package/dist-es/commands/StartTaskContactCommand.js +1 -1
- package/dist-es/commands/UpdateContactCommand.js +1 -1
- package/dist-es/models/models_0.js +6 -5
- package/dist-es/models/models_1.js +5 -0
- package/dist-es/models/models_2.js +13 -27
- package/dist-es/models/models_3.js +23 -0
- package/dist-es/protocols/Aws_restJson1.js +64 -8
- package/dist-types/Connect.d.ts +1 -1
- package/dist-types/ConnectClient.d.ts +1 -1
- package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactCommand.d.ts +13 -2
- package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -1
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -2
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +10 -0
- package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
- package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociatedContactsCommand.d.ts +2 -1
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -3
- package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -1
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
- package/dist-types/commands/SendOutboundEmailCommand.d.ts +6 -1
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +3 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
- package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/StartEmailContactCommand.d.ts +14 -2
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +14 -3
- package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +2 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +12 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateContactCommand.d.ts +33 -1
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +2 -2
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +87 -119
- package/dist-types/models/models_1.d.ts +238 -89
- package/dist-types/models/models_2.d.ts +442 -699
- package/dist-types/models/models_3.d.ts +598 -127
- package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +11 -21
- package/dist-types/ts3.4/models/models_1.d.ts +18 -6
- package/dist-types/ts3.4/models/models_2.d.ts +63 -96
- package/dist-types/ts3.4/models/models_3.d.ts +99 -27
- 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,
|
|
4
|
-
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RealTimeContactAnalysisSegmentAttachments, RealTimeContactAnalysisSegmentCategories, RealTimeContactAnalysisSegmentEvent, RealTimeContactAnalysisSegmentIssues, RealTimeContactAnalysisSegmentPostContactSummary,
|
|
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, 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
|
|
156
|
+
* policy set in the flow.</p>
|
|
222
157
|
* @public
|
|
223
158
|
*/
|
|
224
159
|
export declare class OutputTypeNotFoundException extends __BaseException {
|
|
@@ -1563,6 +1498,19 @@ export interface ResumeContactRequest {
|
|
|
1563
1498
|
*/
|
|
1564
1499
|
export interface ResumeContactResponse {
|
|
1565
1500
|
}
|
|
1501
|
+
/**
|
|
1502
|
+
* @public
|
|
1503
|
+
* @enum
|
|
1504
|
+
*/
|
|
1505
|
+
export declare const ContactRecordingType: {
|
|
1506
|
+
readonly AGENT: "AGENT";
|
|
1507
|
+
readonly IVR: "IVR";
|
|
1508
|
+
readonly SCREEN: "SCREEN";
|
|
1509
|
+
};
|
|
1510
|
+
/**
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
export type ContactRecordingType = (typeof ContactRecordingType)[keyof typeof ContactRecordingType];
|
|
1566
1514
|
/**
|
|
1567
1515
|
* @public
|
|
1568
1516
|
*/
|
|
@@ -1583,6 +1531,11 @@ export interface ResumeContactRecordingRequest {
|
|
|
1583
1531
|
* @public
|
|
1584
1532
|
*/
|
|
1585
1533
|
InitialContactId: string | undefined;
|
|
1534
|
+
/**
|
|
1535
|
+
* <p>The type of recording being operated on.</p>
|
|
1536
|
+
* @public
|
|
1537
|
+
*/
|
|
1538
|
+
ContactRecordingType?: ContactRecordingType | undefined;
|
|
1586
1539
|
}
|
|
1587
1540
|
/**
|
|
1588
1541
|
* @public
|
|
@@ -1749,7 +1702,7 @@ export interface ContactFlowModuleSearchFilter {
|
|
|
1749
1702
|
*/
|
|
1750
1703
|
export interface SearchContactFlowModulesResponse {
|
|
1751
1704
|
/**
|
|
1752
|
-
* <p>The search criteria to be used to return
|
|
1705
|
+
* <p>The search criteria to be used to return flow modules.</p>
|
|
1753
1706
|
* @public
|
|
1754
1707
|
*/
|
|
1755
1708
|
ContactFlowModules?: ContactFlowModule[] | undefined;
|
|
@@ -1759,7 +1712,7 @@ export interface SearchContactFlowModulesResponse {
|
|
|
1759
1712
|
*/
|
|
1760
1713
|
NextToken?: string | undefined;
|
|
1761
1714
|
/**
|
|
1762
|
-
* <p>The total number of
|
|
1715
|
+
* <p>The total number of flows which matched your search query.</p>
|
|
1763
1716
|
* @public
|
|
1764
1717
|
*/
|
|
1765
1718
|
ApproximateTotalCount?: number | undefined;
|
|
@@ -1801,7 +1754,7 @@ export interface SearchContactFlowsResponse {
|
|
|
1801
1754
|
*/
|
|
1802
1755
|
NextToken?: string | undefined;
|
|
1803
1756
|
/**
|
|
1804
|
-
* <p>The total number of
|
|
1757
|
+
* <p>The total number of flows which matched your search query.</p>
|
|
1805
1758
|
* @public
|
|
1806
1759
|
*/
|
|
1807
1760
|
ApproximateTotalCount?: number | undefined;
|
|
@@ -1860,8 +1813,7 @@ export interface Transcript {
|
|
|
1860
1813
|
MatchType?: SearchContactsMatchType | undefined;
|
|
1861
1814
|
}
|
|
1862
1815
|
/**
|
|
1863
|
-
* <p>A structure that defines search criteria for contacts using analysis outputs from Amazon
|
|
1864
|
-
* Connect Contact Lens.</p>
|
|
1816
|
+
* <p>A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.</p>
|
|
1865
1817
|
* @public
|
|
1866
1818
|
*/
|
|
1867
1819
|
export interface ContactAnalysis {
|
|
@@ -1872,7 +1824,7 @@ export interface ContactAnalysis {
|
|
|
1872
1824
|
Transcript?: Transcript | undefined;
|
|
1873
1825
|
}
|
|
1874
1826
|
/**
|
|
1875
|
-
* <p>The search criteria based on user-
|
|
1827
|
+
* <p>The search criteria based on user-defined contact attribute key and values to search
|
|
1876
1828
|
* on.</p>
|
|
1877
1829
|
* @public
|
|
1878
1830
|
*/
|
|
@@ -1908,33 +1860,35 @@ export interface SearchableContactAttributes {
|
|
|
1908
1860
|
MatchType?: SearchContactsMatchType | undefined;
|
|
1909
1861
|
}
|
|
1910
1862
|
/**
|
|
1911
|
-
* <p
|
|
1863
|
+
* <p>The search criteria based on searchable segment attribute key and values to search
|
|
1864
|
+
* on.</p>
|
|
1912
1865
|
* @public
|
|
1913
1866
|
*/
|
|
1914
1867
|
export interface SearchableSegmentAttributesCriteria {
|
|
1915
1868
|
/**
|
|
1916
|
-
* <p
|
|
1869
|
+
* <p>The key containing a searchable segment attribute.</p>
|
|
1917
1870
|
* @public
|
|
1918
1871
|
*/
|
|
1919
1872
|
Key: string | undefined;
|
|
1920
1873
|
/**
|
|
1921
|
-
* <p
|
|
1874
|
+
* <p>The list of values to search for within a searchable segment attribute.</p>
|
|
1922
1875
|
* @public
|
|
1923
1876
|
*/
|
|
1924
1877
|
Values: string[] | undefined;
|
|
1925
1878
|
}
|
|
1926
1879
|
/**
|
|
1927
|
-
* <p
|
|
1880
|
+
* <p>The search criteria based on searchable segment attributes of a contact</p>
|
|
1928
1881
|
* @public
|
|
1929
1882
|
*/
|
|
1930
1883
|
export interface SearchableSegmentAttributes {
|
|
1931
1884
|
/**
|
|
1932
|
-
* <p
|
|
1885
|
+
* <p>The list of criteria based on searchable segment attributes.</p>
|
|
1933
1886
|
* @public
|
|
1934
1887
|
*/
|
|
1935
1888
|
Criteria: SearchableSegmentAttributesCriteria[] | undefined;
|
|
1936
1889
|
/**
|
|
1937
|
-
* <p
|
|
1890
|
+
* <p>The match type combining search criteria using multiple searchable segment
|
|
1891
|
+
* attributes.</p>
|
|
1938
1892
|
* @public
|
|
1939
1893
|
*/
|
|
1940
1894
|
MatchType?: SearchContactsMatchType | undefined;
|
|
@@ -1987,7 +1941,7 @@ export interface SearchCriteria {
|
|
|
1987
1941
|
*/
|
|
1988
1942
|
SearchableContactAttributes?: SearchableContactAttributes | undefined;
|
|
1989
1943
|
/**
|
|
1990
|
-
* <p
|
|
1944
|
+
* <p>The search criteria based on searchable segment attributes of a contact.</p>
|
|
1991
1945
|
* @public
|
|
1992
1946
|
*/
|
|
1993
1947
|
SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined;
|
|
@@ -2129,12 +2083,14 @@ export interface ContactSearchSummaryQueueInfo {
|
|
|
2129
2083
|
EnqueueTimestamp?: Date | undefined;
|
|
2130
2084
|
}
|
|
2131
2085
|
/**
|
|
2132
|
-
* <p
|
|
2086
|
+
* <p>The value of a segment attribute. This is structured as a map with a single key-value pair.
|
|
2087
|
+
* The key 'valueString' indicates that the attribute type is a string, and its corresponding value
|
|
2088
|
+
* is the actual string value of the segment attribute.</p>
|
|
2133
2089
|
* @public
|
|
2134
2090
|
*/
|
|
2135
2091
|
export interface ContactSearchSummarySegmentAttributeValue {
|
|
2136
2092
|
/**
|
|
2137
|
-
* <p
|
|
2093
|
+
* <p>The value of a segment attribute represented as a string.</p>
|
|
2138
2094
|
* @public
|
|
2139
2095
|
*/
|
|
2140
2096
|
ValueString?: string | undefined;
|
|
@@ -2206,7 +2162,7 @@ export interface ContactSearchSummary {
|
|
|
2206
2162
|
*/
|
|
2207
2163
|
ScheduledTimestamp?: Date | undefined;
|
|
2208
2164
|
/**
|
|
2209
|
-
* <p
|
|
2165
|
+
* <p>Set of segment attributes for a contact.</p>
|
|
2210
2166
|
* @public
|
|
2211
2167
|
*/
|
|
2212
2168
|
SegmentAttributes?: Record<string, ContactSearchSummarySegmentAttributeValue> | undefined;
|
|
@@ -2232,7 +2188,7 @@ export interface SearchContactsResponse {
|
|
|
2232
2188
|
TotalCount?: number | undefined;
|
|
2233
2189
|
}
|
|
2234
2190
|
/**
|
|
2235
|
-
* <p
|
|
2191
|
+
* <p>Filters to be applied to search results.</p>
|
|
2236
2192
|
* @public
|
|
2237
2193
|
*/
|
|
2238
2194
|
export interface EmailAddressSearchFilter {
|
|
@@ -2254,32 +2210,32 @@ export interface EmailAddressSearchFilter {
|
|
|
2254
2210
|
TagFilter?: ControlPlaneTagFilter | undefined;
|
|
2255
2211
|
}
|
|
2256
2212
|
/**
|
|
2257
|
-
* <p
|
|
2213
|
+
* <p>Contains information about an email address for a contact center.</p>
|
|
2258
2214
|
* @public
|
|
2259
2215
|
*/
|
|
2260
2216
|
export interface EmailAddressMetadata {
|
|
2261
2217
|
/**
|
|
2262
|
-
* <p
|
|
2218
|
+
* <p>The identifier of the email address.</p>
|
|
2263
2219
|
* @public
|
|
2264
2220
|
*/
|
|
2265
2221
|
EmailAddressId?: string | undefined;
|
|
2266
2222
|
/**
|
|
2267
|
-
* <p
|
|
2223
|
+
* <p>The Amazon Resource Name (ARN) of the email address.</p>
|
|
2268
2224
|
* @public
|
|
2269
2225
|
*/
|
|
2270
2226
|
EmailAddressArn?: string | undefined;
|
|
2271
2227
|
/**
|
|
2272
|
-
* <p
|
|
2228
|
+
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
|
|
2273
2229
|
* @public
|
|
2274
2230
|
*/
|
|
2275
2231
|
EmailAddress?: string | undefined;
|
|
2276
2232
|
/**
|
|
2277
|
-
* <p
|
|
2233
|
+
* <p>The description of the email address.</p>
|
|
2278
2234
|
* @public
|
|
2279
2235
|
*/
|
|
2280
2236
|
Description?: string | undefined;
|
|
2281
2237
|
/**
|
|
2282
|
-
* <p
|
|
2238
|
+
* <p>The display name of email address.</p>
|
|
2283
2239
|
* @public
|
|
2284
2240
|
*/
|
|
2285
2241
|
DisplayName?: string | undefined;
|
|
@@ -2289,17 +2245,17 @@ export interface EmailAddressMetadata {
|
|
|
2289
2245
|
*/
|
|
2290
2246
|
export interface SearchEmailAddressesResponse {
|
|
2291
2247
|
/**
|
|
2292
|
-
* <p
|
|
2248
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2293
2249
|
* @public
|
|
2294
2250
|
*/
|
|
2295
2251
|
NextToken?: string | undefined;
|
|
2296
2252
|
/**
|
|
2297
|
-
* <p
|
|
2253
|
+
* <p>List of email addresses matching SearchFilter and SearchCriteria </p>
|
|
2298
2254
|
* @public
|
|
2299
2255
|
*/
|
|
2300
2256
|
EmailAddresses?: EmailAddressMetadata[] | undefined;
|
|
2301
2257
|
/**
|
|
2302
|
-
* <p
|
|
2258
|
+
* <p>The total number of email addresses which matched your search query.</p>
|
|
2303
2259
|
* @public
|
|
2304
2260
|
*/
|
|
2305
2261
|
ApproximateTotalCount?: number | undefined;
|
|
@@ -2625,7 +2581,7 @@ export interface SearchResourceTagsRequest {
|
|
|
2625
2581
|
*/
|
|
2626
2582
|
export interface TagSet {
|
|
2627
2583
|
/**
|
|
2628
|
-
* <p>The tag key in the
|
|
2584
|
+
* <p>The tag key in the TagSet.</p>
|
|
2629
2585
|
* @public
|
|
2630
2586
|
*/
|
|
2631
2587
|
key?: string | undefined;
|
|
@@ -3369,15 +3325,15 @@ export interface SendChatIntegrationEventRequest {
|
|
|
3369
3325
|
SourceId: string | undefined;
|
|
3370
3326
|
/**
|
|
3371
3327
|
* <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the
|
|
3372
|
-
* Amazon Connect instance and flow to be used to start chats. For
|
|
3373
|
-
* number destination of inbound
|
|
3328
|
+
* Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone
|
|
3329
|
+
* number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number
|
|
3374
3330
|
* ARN.</p>
|
|
3375
3331
|
* @public
|
|
3376
3332
|
*/
|
|
3377
3333
|
DestinationId: string | undefined;
|
|
3378
3334
|
/**
|
|
3379
3335
|
* <p>Classification of a channel. This is used in part to uniquely identify chat. </p>
|
|
3380
|
-
* <p>Valid value: <code>["connect:sms"]</code>
|
|
3336
|
+
* <p>Valid value: <code>["connect:sms", connect:"WhatsApp"]</code>
|
|
3381
3337
|
* </p>
|
|
3382
3338
|
* @public
|
|
3383
3339
|
*/
|
|
@@ -3412,28 +3368,28 @@ export interface SendChatIntegrationEventResponse {
|
|
|
3412
3368
|
NewChatCreated?: boolean | undefined;
|
|
3413
3369
|
}
|
|
3414
3370
|
/**
|
|
3415
|
-
* <p
|
|
3371
|
+
* <p>Contains information about a source or destination email address</p>
|
|
3416
3372
|
* @public
|
|
3417
3373
|
*/
|
|
3418
3374
|
export interface EmailAddressInfo {
|
|
3419
3375
|
/**
|
|
3420
|
-
* <p
|
|
3376
|
+
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
|
|
3421
3377
|
* @public
|
|
3422
3378
|
*/
|
|
3423
3379
|
EmailAddress: string | undefined;
|
|
3424
3380
|
/**
|
|
3425
|
-
* <p
|
|
3381
|
+
* <p>The display name of email address.</p>
|
|
3426
3382
|
* @public
|
|
3427
3383
|
*/
|
|
3428
3384
|
DisplayName?: string | undefined;
|
|
3429
3385
|
}
|
|
3430
3386
|
/**
|
|
3431
|
-
* <p
|
|
3387
|
+
* <p>The additional recipients information of outbound email.</p>
|
|
3432
3388
|
* @public
|
|
3433
3389
|
*/
|
|
3434
3390
|
export interface OutboundAdditionalRecipients {
|
|
3435
3391
|
/**
|
|
3436
|
-
* <p
|
|
3392
|
+
* <p>The additional CC email address recipients information.</p>
|
|
3437
3393
|
* @public
|
|
3438
3394
|
*/
|
|
3439
3395
|
CcEmailAddresses?: EmailAddressInfo[] | undefined;
|
|
@@ -3451,96 +3407,102 @@ export declare const OutboundMessageSourceType: {
|
|
|
3451
3407
|
*/
|
|
3452
3408
|
export type OutboundMessageSourceType = (typeof OutboundMessageSourceType)[keyof typeof OutboundMessageSourceType];
|
|
3453
3409
|
/**
|
|
3454
|
-
* <p
|
|
3410
|
+
* <p>Information about the raw email body content.</p>
|
|
3455
3411
|
* @public
|
|
3456
3412
|
*/
|
|
3457
3413
|
export interface OutboundRawMessage {
|
|
3458
3414
|
/**
|
|
3459
|
-
* <p
|
|
3415
|
+
* <p>The email subject.</p>
|
|
3460
3416
|
* @public
|
|
3461
3417
|
*/
|
|
3462
3418
|
Subject: string | undefined;
|
|
3463
3419
|
/**
|
|
3464
|
-
* <p
|
|
3420
|
+
* <p>The email message body.</p>
|
|
3465
3421
|
* @public
|
|
3466
3422
|
*/
|
|
3467
3423
|
Body: string | undefined;
|
|
3468
3424
|
/**
|
|
3469
|
-
* <p
|
|
3425
|
+
* <p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>
|
|
3470
3426
|
* @public
|
|
3471
3427
|
*/
|
|
3472
3428
|
ContentType: string | undefined;
|
|
3473
3429
|
}
|
|
3474
3430
|
/**
|
|
3475
|
-
* <p
|
|
3431
|
+
* <p>Information about the template attributes.</p>
|
|
3476
3432
|
* @public
|
|
3477
3433
|
*/
|
|
3478
3434
|
export interface TemplateAttributes {
|
|
3479
3435
|
/**
|
|
3480
|
-
* <p
|
|
3436
|
+
* <p>An object that specifies the custom attributes values to use for variables in the message
|
|
3437
|
+
* template. This object contains different categories of key-value pairs. Each key defines a
|
|
3438
|
+
* variable or placeholder in the message template. </p>
|
|
3481
3439
|
* @public
|
|
3482
3440
|
*/
|
|
3483
3441
|
CustomAttributes?: Record<string, string> | undefined;
|
|
3484
3442
|
/**
|
|
3485
|
-
* <p
|
|
3443
|
+
* <p>An object that specifies the customer profile attributes values to use for variables in the
|
|
3444
|
+
* message template. This object contains different categories of key-value pairs. Each key defines
|
|
3445
|
+
* a variable or placeholder in the message template. </p>
|
|
3486
3446
|
* @public
|
|
3487
3447
|
*/
|
|
3488
3448
|
CustomerProfileAttributes?: string | undefined;
|
|
3489
3449
|
}
|
|
3490
3450
|
/**
|
|
3491
|
-
* <p
|
|
3451
|
+
* <p>Information about template message configuration.</p>
|
|
3492
3452
|
* @public
|
|
3493
3453
|
*/
|
|
3494
3454
|
export interface TemplatedMessageConfig {
|
|
3495
3455
|
/**
|
|
3496
|
-
* <p
|
|
3456
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
3457
|
+
* the ARN.</p>
|
|
3497
3458
|
* @public
|
|
3498
3459
|
*/
|
|
3499
3460
|
KnowledgeBaseId: string | undefined;
|
|
3500
3461
|
/**
|
|
3501
|
-
* <p
|
|
3462
|
+
* <p>The identifier of the message template Id.</p>
|
|
3502
3463
|
* @public
|
|
3503
3464
|
*/
|
|
3504
3465
|
MessageTemplateId: string | undefined;
|
|
3505
3466
|
/**
|
|
3506
|
-
* <p
|
|
3467
|
+
* <p>Information about template attributes, that is, CustomAttributes or
|
|
3468
|
+
* CustomerProfileAttributes.</p>
|
|
3507
3469
|
* @public
|
|
3508
3470
|
*/
|
|
3509
3471
|
TemplateAttributes: TemplateAttributes | undefined;
|
|
3510
3472
|
}
|
|
3511
3473
|
/**
|
|
3512
|
-
* <p
|
|
3474
|
+
* <p>Information about email body content.</p>
|
|
3513
3475
|
* @public
|
|
3514
3476
|
*/
|
|
3515
3477
|
export interface OutboundEmailContent {
|
|
3516
3478
|
/**
|
|
3517
|
-
* <p
|
|
3479
|
+
* <p>The message source type, that is, <code>RAW</code> or <code>TEMPLATE</code>.</p>
|
|
3518
3480
|
* @public
|
|
3519
3481
|
*/
|
|
3520
3482
|
MessageSourceType: OutboundMessageSourceType | undefined;
|
|
3521
3483
|
/**
|
|
3522
|
-
* <p
|
|
3484
|
+
* <p>Information about template message configuration.</p>
|
|
3523
3485
|
* @public
|
|
3524
3486
|
*/
|
|
3525
3487
|
TemplatedMessageConfig?: TemplatedMessageConfig | undefined;
|
|
3526
3488
|
/**
|
|
3527
|
-
* <p
|
|
3489
|
+
* <p>The raw email body content.</p>
|
|
3528
3490
|
* @public
|
|
3529
3491
|
*/
|
|
3530
3492
|
RawMessage?: OutboundRawMessage | undefined;
|
|
3531
3493
|
}
|
|
3532
3494
|
/**
|
|
3533
|
-
* <p
|
|
3495
|
+
* <p>Information about the campaign.</p>
|
|
3534
3496
|
* @public
|
|
3535
3497
|
*/
|
|
3536
3498
|
export interface SourceCampaign {
|
|
3537
3499
|
/**
|
|
3538
|
-
* <p
|
|
3500
|
+
* <p>A unique identifier for a campaign.</p>
|
|
3539
3501
|
* @public
|
|
3540
3502
|
*/
|
|
3541
3503
|
CampaignId?: string | undefined;
|
|
3542
3504
|
/**
|
|
3543
|
-
* <p
|
|
3505
|
+
* <p>A unique identifier for a each request part of same campaign.</p>
|
|
3544
3506
|
* @public
|
|
3545
3507
|
*/
|
|
3546
3508
|
OutboundRequestId?: string | undefined;
|
|
@@ -3562,42 +3524,45 @@ export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType];
|
|
|
3562
3524
|
*/
|
|
3563
3525
|
export interface SendOutboundEmailRequest {
|
|
3564
3526
|
/**
|
|
3565
|
-
* <p
|
|
3527
|
+
* <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
3528
|
* @public
|
|
3567
3529
|
*/
|
|
3568
3530
|
InstanceId: string | undefined;
|
|
3569
3531
|
/**
|
|
3570
|
-
* <p
|
|
3532
|
+
* <p>The email address to be used for sending email.</p>
|
|
3571
3533
|
* @public
|
|
3572
3534
|
*/
|
|
3573
3535
|
FromEmailAddress: EmailAddressInfo | undefined;
|
|
3574
3536
|
/**
|
|
3575
|
-
* <p
|
|
3537
|
+
* <p>The email address to send the email to.</p>
|
|
3576
3538
|
* @public
|
|
3577
3539
|
*/
|
|
3578
3540
|
DestinationEmailAddress: EmailAddressInfo | undefined;
|
|
3579
3541
|
/**
|
|
3580
|
-
* <p
|
|
3542
|
+
* <p>The additional recipients address of the email in CC.</p>
|
|
3581
3543
|
* @public
|
|
3582
3544
|
*/
|
|
3583
3545
|
AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
|
|
3584
3546
|
/**
|
|
3585
|
-
* <p
|
|
3547
|
+
* <p>The email message body to be sent to the newly created email.</p>
|
|
3586
3548
|
* @public
|
|
3587
3549
|
*/
|
|
3588
3550
|
EmailMessage: OutboundEmailContent | undefined;
|
|
3589
3551
|
/**
|
|
3590
|
-
* <p
|
|
3552
|
+
* <p>Denotes the class of traffic.</p>
|
|
3591
3553
|
* @public
|
|
3592
3554
|
*/
|
|
3593
3555
|
TrafficType: TrafficType | undefined;
|
|
3594
3556
|
/**
|
|
3595
|
-
* <p
|
|
3557
|
+
* <p>A Campaign object need for Campaign traffic type.</p>
|
|
3596
3558
|
* @public
|
|
3597
3559
|
*/
|
|
3598
3560
|
SourceCampaign?: SourceCampaign | undefined;
|
|
3599
3561
|
/**
|
|
3600
|
-
* <p
|
|
3562
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3563
|
+
* request. If not provided, the Amazon Web Services
|
|
3564
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3565
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3601
3566
|
* @public
|
|
3602
3567
|
*/
|
|
3603
3568
|
ClientToken?: string | undefined;
|
|
@@ -3642,12 +3607,15 @@ export interface StartAttachedFileUploadRequest {
|
|
|
3642
3607
|
UrlExpiryInSeconds?: number | undefined;
|
|
3643
3608
|
/**
|
|
3644
3609
|
* <p>The use case for the file.</p>
|
|
3610
|
+
* <important>
|
|
3611
|
+
* <p> Only <code>ATTACHMENTS</code> are supported.</p>
|
|
3612
|
+
* </important>
|
|
3645
3613
|
* @public
|
|
3646
3614
|
*/
|
|
3647
3615
|
FileUseCaseType: FileUseCaseType | undefined;
|
|
3648
3616
|
/**
|
|
3649
|
-
* <p>The resource to which the attached file is (being) uploaded to.
|
|
3650
|
-
*
|
|
3617
|
+
* <p>The resource to which the attached file is (being) uploaded to. The supported resources are
|
|
3618
|
+
* <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
3619
|
* <note>
|
|
3652
3620
|
* <p>This value must be a valid ARN.</p>
|
|
3653
3621
|
* </note>
|
|
@@ -3794,109 +3762,6 @@ export interface PersistentChat {
|
|
|
3794
3762
|
*/
|
|
3795
3763
|
SourceContactId?: string | undefined;
|
|
3796
3764
|
}
|
|
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
3765
|
/**
|
|
3901
3766
|
* @public
|
|
3902
3767
|
*/
|
|
@@ -3968,6 +3833,17 @@ export interface StartContactEvaluationResponse {
|
|
|
3968
3833
|
*/
|
|
3969
3834
|
EvaluationArn: string | undefined;
|
|
3970
3835
|
}
|
|
3836
|
+
/**
|
|
3837
|
+
* @public
|
|
3838
|
+
* @enum
|
|
3839
|
+
*/
|
|
3840
|
+
export declare const IvrRecordingTrack: {
|
|
3841
|
+
readonly ALL: "ALL";
|
|
3842
|
+
};
|
|
3843
|
+
/**
|
|
3844
|
+
* @public
|
|
3845
|
+
*/
|
|
3846
|
+
export type IvrRecordingTrack = (typeof IvrRecordingTrack)[keyof typeof IvrRecordingTrack];
|
|
3971
3847
|
/**
|
|
3972
3848
|
* @public
|
|
3973
3849
|
* @enum
|
|
@@ -3991,6 +3867,11 @@ export interface VoiceRecordingConfiguration {
|
|
|
3991
3867
|
* @public
|
|
3992
3868
|
*/
|
|
3993
3869
|
VoiceRecordingTrack?: VoiceRecordingTrack | undefined;
|
|
3870
|
+
/**
|
|
3871
|
+
* <p>Identifies which IVR track is being recorded.</p>
|
|
3872
|
+
* @public
|
|
3873
|
+
*/
|
|
3874
|
+
IvrRecordingTrack?: IvrRecordingTrack | undefined;
|
|
3994
3875
|
}
|
|
3995
3876
|
/**
|
|
3996
3877
|
* @public
|
|
@@ -4063,33 +3944,33 @@ export interface StartContactStreamingResponse {
|
|
|
4063
3944
|
StreamingId: string | undefined;
|
|
4064
3945
|
}
|
|
4065
3946
|
/**
|
|
4066
|
-
* <p
|
|
3947
|
+
* <p>The additional TO CC recipients information of inbound email.</p>
|
|
4067
3948
|
* @public
|
|
4068
3949
|
*/
|
|
4069
3950
|
export interface InboundAdditionalRecipients {
|
|
4070
3951
|
/**
|
|
4071
|
-
* <p
|
|
3952
|
+
* <p>The additional recipients information present in to list.</p>
|
|
4072
3953
|
* @public
|
|
4073
3954
|
*/
|
|
4074
3955
|
ToAddresses?: EmailAddressInfo[] | undefined;
|
|
4075
3956
|
/**
|
|
4076
|
-
* <p
|
|
3957
|
+
* <p>The additional recipients information present in cc list.</p>
|
|
4077
3958
|
* @public
|
|
4078
3959
|
*/
|
|
4079
3960
|
CcAddresses?: EmailAddressInfo[] | undefined;
|
|
4080
3961
|
}
|
|
4081
3962
|
/**
|
|
4082
|
-
* <p
|
|
3963
|
+
* <p>Information about the email attachment files.</p>
|
|
4083
3964
|
* @public
|
|
4084
3965
|
*/
|
|
4085
3966
|
export interface EmailAttachment {
|
|
4086
3967
|
/**
|
|
4087
|
-
* <p
|
|
3968
|
+
* <p>A case-sensitive name of the attached file being uploaded.</p>
|
|
4088
3969
|
* @public
|
|
4089
3970
|
*/
|
|
4090
3971
|
FileName: string | undefined;
|
|
4091
3972
|
/**
|
|
4092
|
-
* <p
|
|
3973
|
+
* <p>The pre-signed URLs for the S3 bucket where the email attachment is stored.</p>
|
|
4093
3974
|
* @public
|
|
4094
3975
|
*/
|
|
4095
3976
|
S3Url: string | undefined;
|
|
@@ -4121,43 +4002,43 @@ export declare const EmailHeaderType: {
|
|
|
4121
4002
|
*/
|
|
4122
4003
|
export type EmailHeaderType = (typeof EmailHeaderType)[keyof typeof EmailHeaderType];
|
|
4123
4004
|
/**
|
|
4124
|
-
* <p
|
|
4005
|
+
* <p>Information about the raw email body content.</p>
|
|
4125
4006
|
* @public
|
|
4126
4007
|
*/
|
|
4127
4008
|
export interface InboundRawMessage {
|
|
4128
4009
|
/**
|
|
4129
|
-
* <p
|
|
4010
|
+
* <p>The email subject.</p>
|
|
4130
4011
|
* @public
|
|
4131
4012
|
*/
|
|
4132
4013
|
Subject: string | undefined;
|
|
4133
4014
|
/**
|
|
4134
|
-
* <p
|
|
4015
|
+
* <p>The email message body.</p>
|
|
4135
4016
|
* @public
|
|
4136
4017
|
*/
|
|
4137
4018
|
Body: string | undefined;
|
|
4138
4019
|
/**
|
|
4139
|
-
* <p
|
|
4020
|
+
* <p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>
|
|
4140
4021
|
* @public
|
|
4141
4022
|
*/
|
|
4142
4023
|
ContentType: string | undefined;
|
|
4143
4024
|
/**
|
|
4144
|
-
* <p
|
|
4025
|
+
* <p>Headers present in inbound email.</p>
|
|
4145
4026
|
* @public
|
|
4146
4027
|
*/
|
|
4147
4028
|
Headers?: Partial<Record<EmailHeaderType, string>> | undefined;
|
|
4148
4029
|
}
|
|
4149
4030
|
/**
|
|
4150
|
-
* <p
|
|
4031
|
+
* <p>Information about email body content.</p>
|
|
4151
4032
|
* @public
|
|
4152
4033
|
*/
|
|
4153
4034
|
export interface InboundEmailContent {
|
|
4154
4035
|
/**
|
|
4155
|
-
* <p
|
|
4036
|
+
* <p>The message source type, that is, <code>RAW</code>.</p>
|
|
4156
4037
|
* @public
|
|
4157
4038
|
*/
|
|
4158
4039
|
MessageSourceType: InboundMessageSourceType | undefined;
|
|
4159
4040
|
/**
|
|
4160
|
-
* <p
|
|
4041
|
+
* <p>The raw email body content.</p>
|
|
4161
4042
|
* @public
|
|
4162
4043
|
*/
|
|
4163
4044
|
RawMessage?: InboundRawMessage | undefined;
|
|
@@ -4165,371 +4046,161 @@ export interface InboundEmailContent {
|
|
|
4165
4046
|
/**
|
|
4166
4047
|
* @public
|
|
4167
4048
|
*/
|
|
4168
|
-
export interface
|
|
4049
|
+
export interface StartEmailContactResponse {
|
|
4169
4050
|
/**
|
|
4170
|
-
* <p
|
|
4051
|
+
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
4171
4052
|
* @public
|
|
4172
4053
|
*/
|
|
4173
|
-
|
|
4054
|
+
ContactId?: string | undefined;
|
|
4055
|
+
}
|
|
4056
|
+
/**
|
|
4057
|
+
* @public
|
|
4058
|
+
*/
|
|
4059
|
+
export interface StartOutboundChatContactResponse {
|
|
4174
4060
|
/**
|
|
4175
|
-
* <p
|
|
4061
|
+
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
4176
4062
|
* @public
|
|
4177
4063
|
*/
|
|
4178
|
-
|
|
4064
|
+
ContactId?: string | undefined;
|
|
4065
|
+
}
|
|
4066
|
+
/**
|
|
4067
|
+
* @public
|
|
4068
|
+
*/
|
|
4069
|
+
export interface StartOutboundEmailContactRequest {
|
|
4179
4070
|
/**
|
|
4180
|
-
* <p
|
|
4071
|
+
* <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
4072
|
* @public
|
|
4182
4073
|
*/
|
|
4183
|
-
|
|
4074
|
+
InstanceId: string | undefined;
|
|
4184
4075
|
/**
|
|
4185
|
-
* <p
|
|
4076
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
4186
4077
|
* @public
|
|
4187
4078
|
*/
|
|
4188
|
-
|
|
4079
|
+
ContactId: string | undefined;
|
|
4189
4080
|
/**
|
|
4190
|
-
* <p
|
|
4081
|
+
* <p>The email address associated with the instance.</p>
|
|
4191
4082
|
* @public
|
|
4192
4083
|
*/
|
|
4193
|
-
|
|
4084
|
+
FromEmailAddress?: EmailAddressInfo | undefined;
|
|
4194
4085
|
/**
|
|
4195
|
-
* <p
|
|
4086
|
+
* <p>The email address of the customer.</p>
|
|
4196
4087
|
* @public
|
|
4197
4088
|
*/
|
|
4198
|
-
|
|
4089
|
+
DestinationEmailAddress: EmailAddressInfo | undefined;
|
|
4199
4090
|
/**
|
|
4200
|
-
* <p
|
|
4091
|
+
* <p>The addtional recipients address of email in CC.</p>
|
|
4201
4092
|
* @public
|
|
4202
4093
|
*/
|
|
4203
|
-
|
|
4094
|
+
AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
|
|
4204
4095
|
/**
|
|
4205
|
-
* <p
|
|
4096
|
+
* <p>The email message body to be sent to the newly created email.</p>
|
|
4206
4097
|
* @public
|
|
4207
4098
|
*/
|
|
4208
|
-
|
|
4099
|
+
EmailMessage: OutboundEmailContent | undefined;
|
|
4209
4100
|
/**
|
|
4210
|
-
* <p
|
|
4101
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
4102
|
+
* request. If not provided, the Amazon Web Services
|
|
4103
|
+
* SDK populates this field. For more information about idempotency, see
|
|
4104
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
4211
4105
|
* @public
|
|
4212
4106
|
*/
|
|
4213
|
-
|
|
4107
|
+
ClientToken?: string | undefined;
|
|
4108
|
+
}
|
|
4109
|
+
/**
|
|
4110
|
+
* @public
|
|
4111
|
+
*/
|
|
4112
|
+
export interface StartOutboundEmailContactResponse {
|
|
4214
4113
|
/**
|
|
4215
|
-
* <p
|
|
4114
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
4216
4115
|
* @public
|
|
4217
4116
|
*/
|
|
4218
|
-
|
|
4117
|
+
ContactId?: string | undefined;
|
|
4118
|
+
}
|
|
4119
|
+
/**
|
|
4120
|
+
* <p>Outbound calls to the destination number are not allowed.</p>
|
|
4121
|
+
* @public
|
|
4122
|
+
*/
|
|
4123
|
+
export declare class DestinationNotAllowedException extends __BaseException {
|
|
4124
|
+
readonly name: "DestinationNotAllowedException";
|
|
4125
|
+
readonly $fault: "client";
|
|
4219
4126
|
/**
|
|
4220
|
-
* <p
|
|
4127
|
+
* <p>The message about the outbound calls.</p>
|
|
4221
4128
|
* @public
|
|
4222
4129
|
*/
|
|
4223
|
-
|
|
4130
|
+
Message?: string | undefined;
|
|
4224
4131
|
/**
|
|
4225
|
-
*
|
|
4226
|
-
* @public
|
|
4132
|
+
* @internal
|
|
4227
4133
|
*/
|
|
4228
|
-
|
|
4134
|
+
constructor(opts: __ExceptionOptionType<DestinationNotAllowedException, __BaseException>);
|
|
4135
|
+
}
|
|
4136
|
+
/**
|
|
4137
|
+
* <p>The contact is not permitted.</p>
|
|
4138
|
+
* @public
|
|
4139
|
+
*/
|
|
4140
|
+
export declare class OutboundContactNotPermittedException extends __BaseException {
|
|
4141
|
+
readonly name: "OutboundContactNotPermittedException";
|
|
4142
|
+
readonly $fault: "client";
|
|
4229
4143
|
/**
|
|
4230
|
-
* <p
|
|
4144
|
+
* <p>The message about the contact.</p>
|
|
4231
4145
|
* @public
|
|
4232
4146
|
*/
|
|
4233
|
-
|
|
4147
|
+
Message?: string | undefined;
|
|
4234
4148
|
/**
|
|
4235
|
-
*
|
|
4236
|
-
* @public
|
|
4149
|
+
* @internal
|
|
4237
4150
|
*/
|
|
4238
|
-
|
|
4151
|
+
constructor(opts: __ExceptionOptionType<OutboundContactNotPermittedException, __BaseException>);
|
|
4239
4152
|
}
|
|
4240
4153
|
/**
|
|
4154
|
+
* <p>Configuration of the answering machine detection.</p>
|
|
4241
4155
|
* @public
|
|
4242
4156
|
*/
|
|
4243
|
-
export interface
|
|
4157
|
+
export interface AnswerMachineDetectionConfig {
|
|
4158
|
+
/**
|
|
4159
|
+
* <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
|
|
4160
|
+
* call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
|
|
4161
|
+
* </p>
|
|
4162
|
+
* @public
|
|
4163
|
+
*/
|
|
4164
|
+
EnableAnswerMachineDetection?: boolean | undefined;
|
|
4244
4165
|
/**
|
|
4245
|
-
* <p
|
|
4166
|
+
* <p>Wait for the answering machine prompt.</p>
|
|
4246
4167
|
* @public
|
|
4247
4168
|
*/
|
|
4248
|
-
|
|
4169
|
+
AwaitAnswerMachinePrompt?: boolean | undefined;
|
|
4249
4170
|
}
|
|
4250
4171
|
/**
|
|
4251
4172
|
* @public
|
|
4252
4173
|
*/
|
|
4253
|
-
export interface
|
|
4174
|
+
export interface StartOutboundVoiceContactRequest {
|
|
4254
4175
|
/**
|
|
4255
|
-
* <p>
|
|
4176
|
+
* <p>The name of a voice contact that is shown to an agent in the Contact Control Panel
|
|
4177
|
+
* (CCP).</p>
|
|
4256
4178
|
* @public
|
|
4257
4179
|
*/
|
|
4258
|
-
|
|
4180
|
+
Name?: string | undefined;
|
|
4259
4181
|
/**
|
|
4260
|
-
* <p>
|
|
4182
|
+
* <p>A description of the voice contact that is shown to an agent in the Contact Control Panel
|
|
4183
|
+
* (CCP).</p>
|
|
4261
4184
|
* @public
|
|
4262
4185
|
*/
|
|
4263
|
-
|
|
4186
|
+
Description?: string | undefined;
|
|
4264
4187
|
/**
|
|
4265
|
-
* <p>
|
|
4266
|
-
*
|
|
4188
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
|
|
4189
|
+
* have the following reference types at the time of creation: <code>URL</code> |
|
|
4190
|
+
* <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>.
|
|
4191
|
+
* <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
|
|
4267
4192
|
* @public
|
|
4268
4193
|
*/
|
|
4269
|
-
|
|
4194
|
+
References?: Record<string, Reference> | undefined;
|
|
4270
4195
|
/**
|
|
4271
|
-
* <p>
|
|
4272
|
-
*
|
|
4273
|
-
*
|
|
4274
|
-
*
|
|
4275
|
-
*
|
|
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>
|
|
4196
|
+
* <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by
|
|
4197
|
+
* using <code>RelatedContactID</code> copies over contact attributes from the related contact to
|
|
4198
|
+
* the new contact. All updates to user-defined attributes in the new contact are limited to the
|
|
4199
|
+
* individual contact ID. There are no limits to the number of contacts that can be linked by using
|
|
4200
|
+
* <code>RelatedContactId</code>. </p>
|
|
4283
4201
|
* @public
|
|
4284
4202
|
*/
|
|
4285
|
-
|
|
4286
|
-
/**
|
|
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>
|
|
4288
|
-
* @public
|
|
4289
|
-
*/
|
|
4290
|
-
Attributes?: Record<string, string> | undefined;
|
|
4291
|
-
/**
|
|
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
|
|
4294
|
-
* Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
4295
|
-
* <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>
|
|
4303
|
-
* @public
|
|
4304
|
-
*/
|
|
4305
|
-
ContactFlowId: string | undefined;
|
|
4306
|
-
/**
|
|
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>
|
|
4310
|
-
* @public
|
|
4311
|
-
*/
|
|
4312
|
-
ChatDurationInMinutes?: number | undefined;
|
|
4313
|
-
/**
|
|
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;
|
|
4203
|
+
RelatedContactId?: string | undefined;
|
|
4533
4204
|
/**
|
|
4534
4205
|
* <p>The phone number of the customer, in E.164 format.</p>
|
|
4535
4206
|
* @public
|
|
@@ -4639,101 +4310,6 @@ export interface StartScreenSharingRequest {
|
|
|
4639
4310
|
*/
|
|
4640
4311
|
export interface StartScreenSharingResponse {
|
|
4641
4312
|
}
|
|
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
4313
|
/**
|
|
4738
4314
|
* @public
|
|
4739
4315
|
*/
|
|
@@ -5039,6 +4615,11 @@ export interface StopContactRecordingRequest {
|
|
|
5039
4615
|
* @public
|
|
5040
4616
|
*/
|
|
5041
4617
|
InitialContactId: string | undefined;
|
|
4618
|
+
/**
|
|
4619
|
+
* <p>The type of recording being operated on.</p>
|
|
4620
|
+
* @public
|
|
4621
|
+
*/
|
|
4622
|
+
ContactRecordingType?: ContactRecordingType | undefined;
|
|
5042
4623
|
}
|
|
5043
4624
|
/**
|
|
5044
4625
|
* @public
|
|
@@ -5142,6 +4723,11 @@ export interface SuspendContactRecordingRequest {
|
|
|
5142
4723
|
* @public
|
|
5143
4724
|
*/
|
|
5144
4725
|
InitialContactId: string | undefined;
|
|
4726
|
+
/**
|
|
4727
|
+
* <p>The type of recording being operated on.</p>
|
|
4728
|
+
* @public
|
|
4729
|
+
*/
|
|
4730
|
+
ContactRecordingType?: ContactRecordingType | undefined;
|
|
5145
4731
|
}
|
|
5146
4732
|
/**
|
|
5147
4733
|
* @public
|
|
@@ -5376,40 +4962,15 @@ export interface UpdateAuthenticationProfileRequest {
|
|
|
5376
4962
|
PeriodicSessionDuration?: number | undefined;
|
|
5377
4963
|
}
|
|
5378
4964
|
/**
|
|
4965
|
+
* <p>Information about a queue.</p>
|
|
5379
4966
|
* @public
|
|
5380
4967
|
*/
|
|
5381
|
-
export interface
|
|
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;
|
|
4968
|
+
export interface QueueInfoInput {
|
|
5387
4969
|
/**
|
|
5388
|
-
* <p>The identifier of the
|
|
5389
|
-
* first interaction with your contact center.</p>
|
|
4970
|
+
* <p>The identifier of the queue.</p>
|
|
5390
4971
|
* @public
|
|
5391
4972
|
*/
|
|
5392
|
-
|
|
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;
|
|
4973
|
+
Id?: string | undefined;
|
|
5413
4974
|
}
|
|
5414
4975
|
/**
|
|
5415
4976
|
* @public
|
|
@@ -5700,27 +5261,30 @@ export interface UpdateContactScheduleResponse {
|
|
|
5700
5261
|
*/
|
|
5701
5262
|
export interface UpdateEmailAddressMetadataRequest {
|
|
5702
5263
|
/**
|
|
5703
|
-
* <p
|
|
5264
|
+
* <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
5265
|
* @public
|
|
5705
5266
|
*/
|
|
5706
5267
|
InstanceId: string | undefined;
|
|
5707
5268
|
/**
|
|
5708
|
-
* <p
|
|
5269
|
+
* <p>The identifier of the email address.</p>
|
|
5709
5270
|
* @public
|
|
5710
5271
|
*/
|
|
5711
5272
|
EmailAddressId: string | undefined;
|
|
5712
5273
|
/**
|
|
5713
|
-
* <p
|
|
5274
|
+
* <p>The description of the email address.</p>
|
|
5714
5275
|
* @public
|
|
5715
5276
|
*/
|
|
5716
5277
|
Description?: string | undefined;
|
|
5717
5278
|
/**
|
|
5718
|
-
* <p
|
|
5279
|
+
* <p>The display name of email address.</p>
|
|
5719
5280
|
* @public
|
|
5720
5281
|
*/
|
|
5721
5282
|
DisplayName?: string | undefined;
|
|
5722
5283
|
/**
|
|
5723
|
-
* <p
|
|
5284
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
5285
|
+
* request. If not provided, the Amazon Web Services
|
|
5286
|
+
* SDK populates this field. For more information about idempotency, see
|
|
5287
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
5724
5288
|
* @public
|
|
5725
5289
|
*/
|
|
5726
5290
|
ClientToken?: string | undefined;
|
|
@@ -5730,12 +5294,12 @@ export interface UpdateEmailAddressMetadataRequest {
|
|
|
5730
5294
|
*/
|
|
5731
5295
|
export interface UpdateEmailAddressMetadataResponse {
|
|
5732
5296
|
/**
|
|
5733
|
-
* <p
|
|
5297
|
+
* <p>The identifier of the email address.</p>
|
|
5734
5298
|
* @public
|
|
5735
5299
|
*/
|
|
5736
5300
|
EmailAddressId?: string | undefined;
|
|
5737
5301
|
/**
|
|
5738
|
-
* <p
|
|
5302
|
+
* <p>The Amazon Resource Name (ARN) of the email address.</p>
|
|
5739
5303
|
* @public
|
|
5740
5304
|
*/
|
|
5741
5305
|
EmailAddressArn?: string | undefined;
|
|
@@ -6242,7 +5806,7 @@ export interface UpdateQueueOutboundCallerConfigRequest {
|
|
|
6242
5806
|
OutboundCallerConfig: OutboundCallerConfig | undefined;
|
|
6243
5807
|
}
|
|
6244
5808
|
/**
|
|
6245
|
-
* <p
|
|
5809
|
+
* <p>A conditional check failed.</p>
|
|
6246
5810
|
* @public
|
|
6247
5811
|
*/
|
|
6248
5812
|
export declare class ConditionalOperationFailedException extends __BaseException {
|
|
@@ -6259,17 +5823,17 @@ export declare class ConditionalOperationFailedException extends __BaseException
|
|
|
6259
5823
|
*/
|
|
6260
5824
|
export interface UpdateQueueOutboundEmailConfigRequest {
|
|
6261
5825
|
/**
|
|
6262
|
-
* <p
|
|
5826
|
+
* <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
5827
|
* @public
|
|
6264
5828
|
*/
|
|
6265
5829
|
InstanceId: string | undefined;
|
|
6266
5830
|
/**
|
|
6267
|
-
* <p
|
|
5831
|
+
* <p>The identifier for the queue.</p>
|
|
6268
5832
|
* @public
|
|
6269
5833
|
*/
|
|
6270
5834
|
QueueId: string | undefined;
|
|
6271
5835
|
/**
|
|
6272
|
-
* <p
|
|
5836
|
+
* <p>The outbound email address ID for a specified queue.</p>
|
|
6273
5837
|
* @public
|
|
6274
5838
|
*/
|
|
6275
5839
|
OutboundEmailConfig: OutboundEmailConfig | undefined;
|
|
@@ -6568,7 +6132,8 @@ export interface UpdateTaskTemplateRequest {
|
|
|
6568
6132
|
*/
|
|
6569
6133
|
ContactFlowId?: string | undefined;
|
|
6570
6134
|
/**
|
|
6571
|
-
* <p
|
|
6135
|
+
* <p>The ContactFlowId for the flow that will be run if this template is used to create a
|
|
6136
|
+
* self-assigned task.</p>
|
|
6572
6137
|
* @public
|
|
6573
6138
|
*/
|
|
6574
6139
|
SelfAssignFlowId?: string | undefined;
|
|
@@ -6630,7 +6195,8 @@ export interface UpdateTaskTemplateResponse {
|
|
|
6630
6195
|
*/
|
|
6631
6196
|
ContactFlowId?: string | undefined;
|
|
6632
6197
|
/**
|
|
6633
|
-
* <p
|
|
6198
|
+
* <p>The ContactFlowId for the flow that will be run if this template is used to create a
|
|
6199
|
+
* self-assigned task.</p>
|
|
6634
6200
|
* @public
|
|
6635
6201
|
*/
|
|
6636
6202
|
SelfAssignFlowId?: string | undefined;
|
|
@@ -6973,6 +6539,28 @@ export interface UpdateViewMetadataRequest {
|
|
|
6973
6539
|
*/
|
|
6974
6540
|
export interface UpdateViewMetadataResponse {
|
|
6975
6541
|
}
|
|
6542
|
+
/**
|
|
6543
|
+
* <p>A value for a segment attribute. This is structured as a map where the key is
|
|
6544
|
+
* <code>valueString</code> and the value is a string.</p>
|
|
6545
|
+
* @public
|
|
6546
|
+
*/
|
|
6547
|
+
export interface SegmentAttributeValue {
|
|
6548
|
+
/**
|
|
6549
|
+
* <p>The value of a segment attribute.</p>
|
|
6550
|
+
* @public
|
|
6551
|
+
*/
|
|
6552
|
+
ValueString?: string | undefined;
|
|
6553
|
+
/**
|
|
6554
|
+
* <p>The value of a segment attribute.</p>
|
|
6555
|
+
* @public
|
|
6556
|
+
*/
|
|
6557
|
+
ValueMap?: Record<string, SegmentAttributeValue> | undefined;
|
|
6558
|
+
/**
|
|
6559
|
+
* <p>The value of a segment attribute.</p>
|
|
6560
|
+
* @public
|
|
6561
|
+
*/
|
|
6562
|
+
ValueInteger?: number | undefined;
|
|
6563
|
+
}
|
|
6976
6564
|
/**
|
|
6977
6565
|
* <p>Information about an item from an evaluation form. The item must be either a section or a
|
|
6978
6566
|
* question.</p>
|
|
@@ -7104,6 +6692,169 @@ export interface ContactFlowModuleSearchCriteria {
|
|
|
7104
6692
|
*/
|
|
7105
6693
|
StringCondition?: StringCondition | undefined;
|
|
7106
6694
|
}
|
|
6695
|
+
/**
|
|
6696
|
+
* <p>The search criteria to be used to return flows.</p>
|
|
6697
|
+
* @public
|
|
6698
|
+
*/
|
|
6699
|
+
export interface ContactFlowSearchCriteria {
|
|
6700
|
+
/**
|
|
6701
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
6702
|
+
* condition.</p>
|
|
6703
|
+
* @public
|
|
6704
|
+
*/
|
|
6705
|
+
OrConditions?: ContactFlowSearchCriteria[] | undefined;
|
|
6706
|
+
/**
|
|
6707
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
6708
|
+
* condition.</p>
|
|
6709
|
+
* @public
|
|
6710
|
+
*/
|
|
6711
|
+
AndConditions?: ContactFlowSearchCriteria[] | undefined;
|
|
6712
|
+
/**
|
|
6713
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6714
|
+
* @public
|
|
6715
|
+
*/
|
|
6716
|
+
StringCondition?: StringCondition | undefined;
|
|
6717
|
+
/**
|
|
6718
|
+
* <p>The type of flow.</p>
|
|
6719
|
+
* @public
|
|
6720
|
+
*/
|
|
6721
|
+
TypeCondition?: ContactFlowType | undefined;
|
|
6722
|
+
/**
|
|
6723
|
+
* <p>The state of the flow.</p>
|
|
6724
|
+
* @public
|
|
6725
|
+
*/
|
|
6726
|
+
StateCondition?: ContactFlowState | undefined;
|
|
6727
|
+
/**
|
|
6728
|
+
* <p>The status of the flow.</p>
|
|
6729
|
+
* @public
|
|
6730
|
+
*/
|
|
6731
|
+
StatusCondition?: ContactFlowStatus | undefined;
|
|
6732
|
+
}
|
|
6733
|
+
/**
|
|
6734
|
+
* @public
|
|
6735
|
+
*/
|
|
6736
|
+
export interface CreateContactRequest {
|
|
6737
|
+
/**
|
|
6738
|
+
* <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>
|
|
6739
|
+
* @public
|
|
6740
|
+
*/
|
|
6741
|
+
InstanceId: string | undefined;
|
|
6742
|
+
/**
|
|
6743
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6744
|
+
* request. If not provided, the Amazon Web Services
|
|
6745
|
+
* SDK populates this field. For more information about idempotency, see
|
|
6746
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6747
|
+
* @public
|
|
6748
|
+
*/
|
|
6749
|
+
ClientToken?: string | undefined;
|
|
6750
|
+
/**
|
|
6751
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
6752
|
+
* @public
|
|
6753
|
+
*/
|
|
6754
|
+
RelatedContactId?: string | undefined;
|
|
6755
|
+
/**
|
|
6756
|
+
* <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>
|
|
6757
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
6758
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
6759
|
+
* @public
|
|
6760
|
+
*/
|
|
6761
|
+
Attributes?: Record<string, string> | undefined;
|
|
6762
|
+
/**
|
|
6763
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
6764
|
+
* the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL |
|
|
6765
|
+
* ATTACHMENT.</p>
|
|
6766
|
+
* @public
|
|
6767
|
+
*/
|
|
6768
|
+
References?: Record<string, Reference> | undefined;
|
|
6769
|
+
/**
|
|
6770
|
+
* <p>The channel for the contact</p>
|
|
6771
|
+
* @public
|
|
6772
|
+
*/
|
|
6773
|
+
Channel: Channel | undefined;
|
|
6774
|
+
/**
|
|
6775
|
+
* <p>Indicates how the contact was initiated.</p>
|
|
6776
|
+
* @public
|
|
6777
|
+
*/
|
|
6778
|
+
InitiationMethod: ContactInitiationMethod | undefined;
|
|
6779
|
+
/**
|
|
6780
|
+
* <p>Number of minutes the contact will be active for before expiring</p>
|
|
6781
|
+
* @public
|
|
6782
|
+
*/
|
|
6783
|
+
ExpiryDurationInMinutes?: number | undefined;
|
|
6784
|
+
/**
|
|
6785
|
+
* <p>User details for the contact</p>
|
|
6786
|
+
* @public
|
|
6787
|
+
*/
|
|
6788
|
+
UserInfo?: UserInfo | undefined;
|
|
6789
|
+
/**
|
|
6790
|
+
* <p>Initial state of the contact when it's created</p>
|
|
6791
|
+
* @public
|
|
6792
|
+
*/
|
|
6793
|
+
InitiateAs?: InitiateAs | undefined;
|
|
6794
|
+
/**
|
|
6795
|
+
* <p>The name of a the contact.</p>
|
|
6796
|
+
* @public
|
|
6797
|
+
*/
|
|
6798
|
+
Name?: string | undefined;
|
|
6799
|
+
/**
|
|
6800
|
+
* <p>A description of the contact.</p>
|
|
6801
|
+
* @public
|
|
6802
|
+
*/
|
|
6803
|
+
Description?: string | undefined;
|
|
6804
|
+
/**
|
|
6805
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
6806
|
+
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
6807
|
+
* They can be accessed in flows.</p>
|
|
6808
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
6809
|
+
* <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
|
|
6810
|
+
* <note>
|
|
6811
|
+
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
6812
|
+
* minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
|
|
6813
|
+
* \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
|
|
6814
|
+
* 135\}\}\}\}</code>. </p>
|
|
6815
|
+
* </note>
|
|
6816
|
+
* @public
|
|
6817
|
+
*/
|
|
6818
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
6819
|
+
}
|
|
6820
|
+
/**
|
|
6821
|
+
* @public
|
|
6822
|
+
*/
|
|
6823
|
+
export interface CreateEvaluationFormRequest {
|
|
6824
|
+
/**
|
|
6825
|
+
* <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>
|
|
6826
|
+
* @public
|
|
6827
|
+
*/
|
|
6828
|
+
InstanceId: string | undefined;
|
|
6829
|
+
/**
|
|
6830
|
+
* <p>A title of the evaluation form.</p>
|
|
6831
|
+
* @public
|
|
6832
|
+
*/
|
|
6833
|
+
Title: string | undefined;
|
|
6834
|
+
/**
|
|
6835
|
+
* <p>The description of the evaluation form.</p>
|
|
6836
|
+
* @public
|
|
6837
|
+
*/
|
|
6838
|
+
Description?: string | undefined;
|
|
6839
|
+
/**
|
|
6840
|
+
* <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>
|
|
6841
|
+
* @public
|
|
6842
|
+
*/
|
|
6843
|
+
Items: EvaluationFormItem[] | undefined;
|
|
6844
|
+
/**
|
|
6845
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
6846
|
+
* @public
|
|
6847
|
+
*/
|
|
6848
|
+
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
6849
|
+
/**
|
|
6850
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6851
|
+
* request. If not provided, the Amazon Web Services
|
|
6852
|
+
* SDK populates this field. For more information about idempotency, see
|
|
6853
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6854
|
+
* @public
|
|
6855
|
+
*/
|
|
6856
|
+
ClientToken?: string | undefined;
|
|
6857
|
+
}
|
|
7107
6858
|
/**
|
|
7108
6859
|
* @internal
|
|
7109
6860
|
*/
|
|
@@ -7212,10 +6963,6 @@ export declare const InboundRawMessageFilterSensitiveLog: (obj: InboundRawMessag
|
|
|
7212
6963
|
* @internal
|
|
7213
6964
|
*/
|
|
7214
6965
|
export declare const InboundEmailContentFilterSensitiveLog: (obj: InboundEmailContent) => any;
|
|
7215
|
-
/**
|
|
7216
|
-
* @internal
|
|
7217
|
-
*/
|
|
7218
|
-
export declare const StartEmailContactRequestFilterSensitiveLog: (obj: StartEmailContactRequest) => any;
|
|
7219
6966
|
/**
|
|
7220
6967
|
* @internal
|
|
7221
6968
|
*/
|
|
@@ -7224,10 +6971,6 @@ export declare const StartOutboundEmailContactRequestFilterSensitiveLog: (obj: S
|
|
|
7224
6971
|
* @internal
|
|
7225
6972
|
*/
|
|
7226
6973
|
export declare const StartOutboundVoiceContactRequestFilterSensitiveLog: (obj: StartOutboundVoiceContactRequest) => any;
|
|
7227
|
-
/**
|
|
7228
|
-
* @internal
|
|
7229
|
-
*/
|
|
7230
|
-
export declare const StartTaskContactRequestFilterSensitiveLog: (obj: StartTaskContactRequest) => any;
|
|
7231
6974
|
/**
|
|
7232
6975
|
* @internal
|
|
7233
6976
|
*/
|
|
@@ -7244,10 +6987,6 @@ export declare const ConnectionDataFilterSensitiveLog: (obj: ConnectionData) =>
|
|
|
7244
6987
|
* @internal
|
|
7245
6988
|
*/
|
|
7246
6989
|
export declare const StartWebRTCContactResponseFilterSensitiveLog: (obj: StartWebRTCContactResponse) => any;
|
|
7247
|
-
/**
|
|
7248
|
-
* @internal
|
|
7249
|
-
*/
|
|
7250
|
-
export declare const UpdateContactRequestFilterSensitiveLog: (obj: UpdateContactRequest) => any;
|
|
7251
6990
|
/**
|
|
7252
6991
|
* @internal
|
|
7253
6992
|
*/
|
|
@@ -7268,3 +7007,7 @@ export declare const UpdateViewContentResponseFilterSensitiveLog: (obj: UpdateVi
|
|
|
7268
7007
|
* @internal
|
|
7269
7008
|
*/
|
|
7270
7009
|
export declare const UpdateViewMetadataRequestFilterSensitiveLog: (obj: UpdateViewMetadataRequest) => any;
|
|
7010
|
+
/**
|
|
7011
|
+
* @internal
|
|
7012
|
+
*/
|
|
7013
|
+
export declare const CreateContactRequestFilterSensitiveLog: (obj: CreateContactRequest) => any;
|