@aws-sdk/client-connect 3.883.0 → 3.885.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/dist-cjs/index.js +41 -8
- package/dist-es/commands/SearchContactsCommand.js +2 -2
- package/dist-es/commands/UpdateParticipantAuthenticationCommand.js +1 -1
- package/dist-es/models/models_2.js +8 -6
- package/dist-es/models/models_3.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +25 -0
- package/dist-types/commands/CreateContactCommand.d.ts +8 -0
- package/dist-types/commands/CreatePredefinedAttributeCommand.d.ts +29 -4
- package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +8 -0
- package/dist-types/commands/DescribePredefinedAttributeCommand.d.ts +25 -4
- package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +2 -1
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -2
- package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +18 -4
- package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +25 -4
- package/dist-types/commands/StartChatContactCommand.d.ts +8 -0
- package/dist-types/commands/StartEmailContactCommand.d.ts +8 -0
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +8 -0
- package/dist-types/commands/StartTaskContactCommand.d.ts +8 -0
- package/dist-types/commands/UpdateContactCommand.d.ts +8 -0
- package/dist-types/commands/UpdateParticipantAuthenticationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +29 -4
- package/dist-types/models/models_0.d.ts +27 -16
- package/dist-types/models/models_1.d.ts +48 -47
- package/dist-types/models/models_2.d.ts +54 -45
- package/dist-types/models/models_3.d.ts +892 -823
- package/dist-types/ts3.4/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInstanceStorageConfigsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateParticipantAuthenticationCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +6 -5
- package/dist-types/ts3.4/models/models_1.d.ts +10 -12
- package/dist-types/ts3.4/models/models_2.d.ts +17 -11
- package/dist-types/ts3.4/models/models_3.d.ts +107 -91
- package/package.json +1 -1
|
@@ -1,6 +1,47 @@
|
|
|
1
|
-
import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormQuestion, EvaluationFormScoringStrategy, InitiateAs, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, PredefinedAttributeValues, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
|
|
1
|
+
import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormQuestion, EvaluationFormScoringStrategy, InitiateAs, InputPredefinedAttributeConfiguration, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, PredefinedAttributeValues, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
|
|
2
2
|
import { AnsweringMachineDetectionStatus, AttributeCondition, ChatMetrics, ContactDetails, ContactEvaluation, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, QueueStatus, RecordingInfo, RoutingCriteriaStepStatus, SignInConfig, TelephonyConfig, WisdomInfo } from "./models_1";
|
|
3
3
|
import { ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface UpdateParticipantAuthenticationRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The <code>state</code> query parameter that was provided by Cognito in the
|
|
10
|
+
* <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the
|
|
11
|
+
* <code>AuthenticationUrl</code> from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html">GetAuthenticationUrl</a>
|
|
12
|
+
* response.</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
State: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <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>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
InstanceId: string | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* <p>The <code>code</code> query parameter provided by Cognito in the
|
|
23
|
+
* <code>redirectUri</code>.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
Code?: string | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* <p>The <code>error</code> query parameter provided by Cognito in the
|
|
29
|
+
* <code>redirectUri</code>.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
Error?: string | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <p>The <code>error_description</code> parameter provided by Cognito in the
|
|
35
|
+
* <code>redirectUri</code>.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
ErrorDescription?: string | undefined;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export interface UpdateParticipantAuthenticationResponse {
|
|
44
|
+
}
|
|
4
45
|
/**
|
|
5
46
|
* @public
|
|
6
47
|
* @enum
|
|
@@ -265,6 +306,18 @@ export interface UpdatePredefinedAttributeRequest {
|
|
|
265
306
|
* @public
|
|
266
307
|
*/
|
|
267
308
|
Values?: PredefinedAttributeValues | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
Purposes?: string[] | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* <p>Custom metadata that is associated to predefined attributes to control behavior
|
|
316
|
+
* in upstream services, such as controlling
|
|
317
|
+
* how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined;
|
|
268
321
|
}
|
|
269
322
|
/**
|
|
270
323
|
* @public
|
|
@@ -1119,28 +1172,6 @@ export interface UpdateViewMetadataRequest {
|
|
|
1119
1172
|
*/
|
|
1120
1173
|
export interface UpdateViewMetadataResponse {
|
|
1121
1174
|
}
|
|
1122
|
-
/**
|
|
1123
|
-
* <p>A value for a segment attribute. This is structured as a map where the key is
|
|
1124
|
-
* <code>valueString</code> and the value is a string.</p>
|
|
1125
|
-
* @public
|
|
1126
|
-
*/
|
|
1127
|
-
export interface SegmentAttributeValue {
|
|
1128
|
-
/**
|
|
1129
|
-
* <p>The value of a segment attribute.</p>
|
|
1130
|
-
* @public
|
|
1131
|
-
*/
|
|
1132
|
-
ValueString?: string | undefined;
|
|
1133
|
-
/**
|
|
1134
|
-
* <p>The value of a segment attribute.</p>
|
|
1135
|
-
* @public
|
|
1136
|
-
*/
|
|
1137
|
-
ValueMap?: Record<string, SegmentAttributeValue> | undefined;
|
|
1138
|
-
/**
|
|
1139
|
-
* <p>The value of a segment attribute.</p>
|
|
1140
|
-
* @public
|
|
1141
|
-
*/
|
|
1142
|
-
ValueInteger?: number | undefined;
|
|
1143
|
-
}
|
|
1144
1175
|
/**
|
|
1145
1176
|
* <p>Information about an item from an evaluation form. The item must be either a section or a
|
|
1146
1177
|
* question.</p>
|
|
@@ -1320,129 +1351,6 @@ export interface ContactFlowSearchCriteria {
|
|
|
1320
1351
|
*/
|
|
1321
1352
|
StatusCondition?: ContactFlowStatus | undefined;
|
|
1322
1353
|
}
|
|
1323
|
-
/**
|
|
1324
|
-
* @public
|
|
1325
|
-
*/
|
|
1326
|
-
export interface CreateContactRequest {
|
|
1327
|
-
/**
|
|
1328
|
-
* <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>
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
InstanceId: string | undefined;
|
|
1332
|
-
/**
|
|
1333
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1334
|
-
* request. If not provided, the Amazon Web Services
|
|
1335
|
-
* SDK populates this field. For more information about idempotency, see
|
|
1336
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1337
|
-
* @public
|
|
1338
|
-
*/
|
|
1339
|
-
ClientToken?: string | undefined;
|
|
1340
|
-
/**
|
|
1341
|
-
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1342
|
-
* @public
|
|
1343
|
-
*/
|
|
1344
|
-
RelatedContactId?: string | undefined;
|
|
1345
|
-
/**
|
|
1346
|
-
* <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>
|
|
1347
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
1348
|
-
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
1349
|
-
* @public
|
|
1350
|
-
*/
|
|
1351
|
-
Attributes?: Record<string, string> | undefined;
|
|
1352
|
-
/**
|
|
1353
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
1354
|
-
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
1355
|
-
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code> | <code>ATTACHMENT</code>.</p>
|
|
1356
|
-
* @public
|
|
1357
|
-
*/
|
|
1358
|
-
References?: Record<string, Reference> | undefined;
|
|
1359
|
-
/**
|
|
1360
|
-
* <p>The channel for the contact.</p>
|
|
1361
|
-
* <important>
|
|
1362
|
-
* <p>The CHAT channel is not supported. The following information is incorrect. We're working to
|
|
1363
|
-
* correct it.</p>
|
|
1364
|
-
* </important>
|
|
1365
|
-
* @public
|
|
1366
|
-
*/
|
|
1367
|
-
Channel: Channel | undefined;
|
|
1368
|
-
/**
|
|
1369
|
-
* <p>Indicates how the contact was initiated. </p>
|
|
1370
|
-
* <important>
|
|
1371
|
-
* <p>CreateContact only supports the following initiation methods. Valid values by channel are: </p>
|
|
1372
|
-
* <ul>
|
|
1373
|
-
* <li>
|
|
1374
|
-
* <p>For VOICE: <code>TRANSFER</code> and the subtype <code>connect:ExternalAudio</code>
|
|
1375
|
-
* </p>
|
|
1376
|
-
* </li>
|
|
1377
|
-
* <li>
|
|
1378
|
-
* <p>For EMAIL: <code>OUTBOUND</code> | <code>AGENT_REPLY</code> | <code>FLOW</code>
|
|
1379
|
-
* </p>
|
|
1380
|
-
* </li>
|
|
1381
|
-
* <li>
|
|
1382
|
-
* <p>For TASK: <code>API</code>
|
|
1383
|
-
* </p>
|
|
1384
|
-
* </li>
|
|
1385
|
-
* </ul>
|
|
1386
|
-
* <p>The other channels listed below are incorrect. We're working to correct this
|
|
1387
|
-
* information.</p>
|
|
1388
|
-
* </important>
|
|
1389
|
-
* @public
|
|
1390
|
-
*/
|
|
1391
|
-
InitiationMethod: ContactInitiationMethod | undefined;
|
|
1392
|
-
/**
|
|
1393
|
-
* <p>Number of minutes the contact will be active for before expiring</p>
|
|
1394
|
-
* @public
|
|
1395
|
-
*/
|
|
1396
|
-
ExpiryDurationInMinutes?: number | undefined;
|
|
1397
|
-
/**
|
|
1398
|
-
* <p>User details for the contact</p>
|
|
1399
|
-
* <important>
|
|
1400
|
-
* <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and
|
|
1401
|
-
* <code>AGENT_REPLY</code> contact initiation methods.</p>
|
|
1402
|
-
* </important>
|
|
1403
|
-
* @public
|
|
1404
|
-
*/
|
|
1405
|
-
UserInfo?: UserInfo | undefined;
|
|
1406
|
-
/**
|
|
1407
|
-
* <p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated
|
|
1408
|
-
* with <code>COMPLETED</code> state.</p>
|
|
1409
|
-
* @public
|
|
1410
|
-
*/
|
|
1411
|
-
InitiateAs?: InitiateAs | undefined;
|
|
1412
|
-
/**
|
|
1413
|
-
* <p>The name of a the contact.</p>
|
|
1414
|
-
* @public
|
|
1415
|
-
*/
|
|
1416
|
-
Name?: string | undefined;
|
|
1417
|
-
/**
|
|
1418
|
-
* <p>A description of the contact.</p>
|
|
1419
|
-
* @public
|
|
1420
|
-
*/
|
|
1421
|
-
Description?: string | undefined;
|
|
1422
|
-
/**
|
|
1423
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
1424
|
-
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
1425
|
-
* They can be accessed in flows.</p>
|
|
1426
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
1427
|
-
* <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
|
|
1428
|
-
* <note>
|
|
1429
|
-
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
1430
|
-
* minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
|
|
1431
|
-
* \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
|
|
1432
|
-
* 135\}\}\}\}</code>. </p>
|
|
1433
|
-
* </note>
|
|
1434
|
-
* @public
|
|
1435
|
-
*/
|
|
1436
|
-
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
1437
|
-
/**
|
|
1438
|
-
* <p>The ID of the previous contact when creating a transfer contact. This value can be provided
|
|
1439
|
-
* only for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Integrate Amazon Connect Contact Lens
|
|
1440
|
-
* with external voice systems</a> in the <i>Amazon Connect Administrator
|
|
1441
|
-
* Guide</i>.</p>
|
|
1442
|
-
* @public
|
|
1443
|
-
*/
|
|
1444
|
-
PreviousContactId?: string | undefined;
|
|
1445
|
-
}
|
|
1446
1354
|
/**
|
|
1447
1355
|
* @public
|
|
1448
1356
|
*/
|
|
@@ -1862,1190 +1770,1347 @@ export interface SecurityProfileSearchCriteria {
|
|
|
1862
1770
|
StringCondition?: StringCondition | undefined;
|
|
1863
1771
|
}
|
|
1864
1772
|
/**
|
|
1773
|
+
* <p>A value for a segment attribute. This is structured as a map where the key is
|
|
1774
|
+
* <code>valueString</code> and the value is a string.</p>
|
|
1865
1775
|
* @public
|
|
1866
1776
|
*/
|
|
1867
|
-
export interface
|
|
1777
|
+
export interface SegmentAttributeValue {
|
|
1868
1778
|
/**
|
|
1869
|
-
* <p>The
|
|
1779
|
+
* <p>The value of a segment attribute.</p>
|
|
1870
1780
|
* @public
|
|
1871
1781
|
*/
|
|
1872
|
-
|
|
1782
|
+
ValueString?: string | undefined;
|
|
1873
1783
|
/**
|
|
1874
|
-
* <p>The
|
|
1875
|
-
* To
|
|
1876
|
-
* see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page,
|
|
1877
|
-
* under the name of the flow, choose <b>Show additional flow
|
|
1878
|
-
* information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
1879
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
1880
|
-
* </p>
|
|
1784
|
+
* <p>The value of a segment attribute.</p>
|
|
1881
1785
|
* @public
|
|
1882
1786
|
*/
|
|
1883
|
-
|
|
1787
|
+
ValueMap?: Record<string, SegmentAttributeValue> | undefined;
|
|
1884
1788
|
/**
|
|
1885
|
-
* <p>
|
|
1886
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
1887
|
-
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
1789
|
+
* <p>The value of a segment attribute.</p>
|
|
1888
1790
|
* @public
|
|
1889
1791
|
*/
|
|
1890
|
-
|
|
1792
|
+
ValueInteger?: number | undefined;
|
|
1891
1793
|
/**
|
|
1892
|
-
* <p>
|
|
1794
|
+
* <p>The value of a segment attribute. This is only supported for system-defined attributes, not
|
|
1795
|
+
* for user-defined attributes.</p>
|
|
1893
1796
|
* @public
|
|
1894
1797
|
*/
|
|
1895
|
-
|
|
1798
|
+
ValueList?: SegmentAttributeValue[] | undefined;
|
|
1896
1799
|
/**
|
|
1897
|
-
* <p>The
|
|
1800
|
+
* <p>The value of a segment attribute that has to be a valid ARN. This is only supported for
|
|
1801
|
+
* system-defined attributes, not for user-defined attributes.</p>
|
|
1898
1802
|
* @public
|
|
1899
1803
|
*/
|
|
1900
|
-
|
|
1804
|
+
ValueArn?: string | undefined;
|
|
1805
|
+
}
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
export interface UpdateEvaluationFormRequest {
|
|
1901
1810
|
/**
|
|
1902
|
-
* <p>
|
|
1903
|
-
* request. If not provided, the Amazon Web Services
|
|
1904
|
-
* SDK populates this field. For more information about idempotency, see
|
|
1905
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1811
|
+
* <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>
|
|
1906
1812
|
* @public
|
|
1907
1813
|
*/
|
|
1908
|
-
|
|
1814
|
+
InstanceId: string | undefined;
|
|
1909
1815
|
/**
|
|
1910
|
-
* <p>The
|
|
1911
|
-
* duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
|
|
1912
|
-
* configurable time is 10,080 minutes (7 days).</p>
|
|
1816
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1913
1817
|
* @public
|
|
1914
1818
|
*/
|
|
1915
|
-
|
|
1819
|
+
EvaluationFormId: string | undefined;
|
|
1916
1820
|
/**
|
|
1917
|
-
* <p>
|
|
1918
|
-
* <code>text/markdown</code>, <code>application/json</code>,
|
|
1919
|
-
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
1920
|
-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
1921
|
-
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
1922
|
-
* supported type in the list. For example, all the following lists are valid because they contain
|
|
1923
|
-
* <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
|
|
1924
|
-
* <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
|
|
1925
|
-
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
1926
|
-
* <note>
|
|
1927
|
-
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
|
|
1928
|
-
* use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
|
|
1929
|
-
* view</a> flow block.</p>
|
|
1930
|
-
* </note>
|
|
1821
|
+
* <p>A version of the evaluation form to update.</p>
|
|
1931
1822
|
* @public
|
|
1932
1823
|
*/
|
|
1933
|
-
|
|
1824
|
+
EvaluationFormVersion: number | undefined;
|
|
1934
1825
|
/**
|
|
1935
|
-
* <p>
|
|
1936
|
-
* 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>
|
|
1826
|
+
* <p>A flag indicating whether the operation must create a new version.</p>
|
|
1937
1827
|
* @public
|
|
1938
1828
|
*/
|
|
1939
|
-
|
|
1829
|
+
CreateNewVersion?: boolean | undefined;
|
|
1940
1830
|
/**
|
|
1941
|
-
* <p>
|
|
1942
|
-
* chat starting.</p>
|
|
1943
|
-
* <note>
|
|
1944
|
-
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
|
|
1945
|
-
* </note>
|
|
1831
|
+
* <p>A title of the evaluation form.</p>
|
|
1946
1832
|
* @public
|
|
1947
1833
|
*/
|
|
1948
|
-
|
|
1834
|
+
Title: string | undefined;
|
|
1949
1835
|
/**
|
|
1950
|
-
* <p>
|
|
1951
|
-
*
|
|
1952
|
-
|
|
1953
|
-
|
|
1954
|
-
|
|
1836
|
+
* <p>The description of the evaluation form.</p>
|
|
1837
|
+
* @public
|
|
1838
|
+
*/
|
|
1839
|
+
Description?: string | undefined;
|
|
1840
|
+
/**
|
|
1841
|
+
* <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>
|
|
1842
|
+
* @public
|
|
1843
|
+
*/
|
|
1844
|
+
Items: EvaluationFormItem[] | undefined;
|
|
1845
|
+
/**
|
|
1846
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
1847
|
+
* @public
|
|
1848
|
+
*/
|
|
1849
|
+
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
1850
|
+
/**
|
|
1851
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1852
|
+
* request. If not provided, the Amazon Web Services
|
|
1853
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1854
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1855
|
+
* @public
|
|
1856
|
+
*/
|
|
1857
|
+
ClientToken?: string | undefined;
|
|
1858
|
+
}
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>The search criteria to be used to return userHierarchyGroup.</p>
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1863
|
+
export interface UserHierarchyGroupSearchCriteria {
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
1874
|
+
/**
|
|
1875
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
1955
1876
|
* <note>
|
|
1956
|
-
* <p>The
|
|
1957
|
-
* <code>
|
|
1958
|
-
* the SupportedMessagingContentTypes field of this API in order to set
|
|
1959
|
-
* <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
|
|
1960
|
-
* \}\}</code>.</p>
|
|
1877
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
1878
|
+
* <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
1961
1879
|
* </note>
|
|
1962
1880
|
* @public
|
|
1963
1881
|
*/
|
|
1964
|
-
|
|
1882
|
+
StringCondition?: StringCondition | undefined;
|
|
1883
|
+
}
|
|
1884
|
+
/**
|
|
1885
|
+
* <p>The search criteria to be used to return users.</p>
|
|
1886
|
+
* <note>
|
|
1887
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
1888
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
1889
|
+
* outside of this range will throw invalid results. </p>
|
|
1890
|
+
* </note>
|
|
1891
|
+
* @public
|
|
1892
|
+
*/
|
|
1893
|
+
export interface UserSearchCriteria {
|
|
1965
1894
|
/**
|
|
1966
|
-
* <p>
|
|
1967
|
-
*
|
|
1895
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
1896
|
+
* condition.</p>
|
|
1968
1897
|
* @public
|
|
1969
1898
|
*/
|
|
1970
|
-
|
|
1899
|
+
OrConditions?: UserSearchCriteria[] | undefined;
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.
|
|
1902
|
+
* </p>
|
|
1903
|
+
* @public
|
|
1904
|
+
*/
|
|
1905
|
+
AndConditions?: UserSearchCriteria[] | undefined;
|
|
1906
|
+
/**
|
|
1907
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
1908
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>Username</code>,
|
|
1909
|
+
* <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>,
|
|
1910
|
+
* <code>SecurityProfileId</code>, <code>ResourceId</code>.</p>
|
|
1911
|
+
* @public
|
|
1912
|
+
*/
|
|
1913
|
+
StringCondition?: StringCondition | undefined;
|
|
1914
|
+
/**
|
|
1915
|
+
* <p>A leaf node condition which can be used to specify a List condition to search users with
|
|
1916
|
+
* attributes included in Lists like Proficiencies.</p>
|
|
1917
|
+
* @public
|
|
1918
|
+
*/
|
|
1919
|
+
ListCondition?: ListCondition | undefined;
|
|
1920
|
+
/**
|
|
1921
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
1922
|
+
* @public
|
|
1923
|
+
*/
|
|
1924
|
+
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
1971
1925
|
}
|
|
1972
1926
|
/**
|
|
1973
1927
|
* @public
|
|
1974
1928
|
*/
|
|
1975
|
-
export interface
|
|
1929
|
+
export interface DescribeContactEvaluationResponse {
|
|
1976
1930
|
/**
|
|
1977
|
-
* <p>
|
|
1931
|
+
* <p>Information about the evaluation form completed for a specific contact.</p>
|
|
1978
1932
|
* @public
|
|
1979
1933
|
*/
|
|
1980
|
-
|
|
1934
|
+
Evaluation: Evaluation | undefined;
|
|
1981
1935
|
/**
|
|
1982
|
-
* <p>
|
|
1936
|
+
* <p>Information about the evaluation form.</p>
|
|
1983
1937
|
* @public
|
|
1984
1938
|
*/
|
|
1985
|
-
|
|
1939
|
+
EvaluationForm: EvaluationFormContent | undefined;
|
|
1940
|
+
}
|
|
1941
|
+
/**
|
|
1942
|
+
* @public
|
|
1943
|
+
*/
|
|
1944
|
+
export interface DescribeEvaluationFormResponse {
|
|
1986
1945
|
/**
|
|
1987
|
-
* <p>
|
|
1946
|
+
* <p>Information about the evaluation form.</p>
|
|
1988
1947
|
* @public
|
|
1989
1948
|
*/
|
|
1990
|
-
|
|
1949
|
+
EvaluationForm: EvaluationForm | undefined;
|
|
1950
|
+
}
|
|
1951
|
+
/**
|
|
1952
|
+
* <p>Step defines the list of agents to be routed or route based on the agent requirements such
|
|
1953
|
+
* as ProficiencyLevel, Name, or Value.</p>
|
|
1954
|
+
* @public
|
|
1955
|
+
*/
|
|
1956
|
+
export interface RoutingCriteriaInputStep {
|
|
1991
1957
|
/**
|
|
1992
|
-
* <p>
|
|
1958
|
+
* <p>An object to specify the expiration of a routing step.</p>
|
|
1993
1959
|
* @public
|
|
1994
1960
|
*/
|
|
1995
|
-
|
|
1961
|
+
Expiry?: RoutingCriteriaInputStepExpiry | undefined;
|
|
1996
1962
|
/**
|
|
1997
|
-
* <p>A
|
|
1998
|
-
* have the following reference types at the time of creation: <code>URL</code> |
|
|
1999
|
-
* <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code>. <code>EMAIL</code> |
|
|
2000
|
-
* <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported reference type during
|
|
2001
|
-
* email creation.</p>
|
|
1963
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
2002
1964
|
* @public
|
|
2003
1965
|
*/
|
|
2004
|
-
|
|
1966
|
+
Expression?: Expression | undefined;
|
|
1967
|
+
}
|
|
1968
|
+
/**
|
|
1969
|
+
* @public
|
|
1970
|
+
*/
|
|
1971
|
+
export interface SearchAgentStatusesRequest {
|
|
2005
1972
|
/**
|
|
2006
|
-
* <p>The
|
|
1973
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
1974
|
+
* the instance.</p>
|
|
2007
1975
|
* @public
|
|
2008
1976
|
*/
|
|
2009
|
-
|
|
1977
|
+
InstanceId: string | undefined;
|
|
2010
1978
|
/**
|
|
2011
|
-
* <p>The
|
|
1979
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
1980
|
+
* the next request to retrieve the next set of results.</p>
|
|
2012
1981
|
* @public
|
|
2013
1982
|
*/
|
|
2014
|
-
|
|
1983
|
+
NextToken?: string | undefined;
|
|
2015
1984
|
/**
|
|
2016
|
-
* <p>The
|
|
1985
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2017
1986
|
* @public
|
|
2018
1987
|
*/
|
|
2019
|
-
|
|
1988
|
+
MaxResults?: number | undefined;
|
|
2020
1989
|
/**
|
|
2021
|
-
* <p>
|
|
1990
|
+
* <p>Filters to be applied to search results.</p>
|
|
2022
1991
|
* @public
|
|
2023
1992
|
*/
|
|
2024
|
-
|
|
1993
|
+
SearchFilter?: AgentStatusSearchFilter | undefined;
|
|
2025
1994
|
/**
|
|
2026
|
-
* <p>The
|
|
2027
|
-
* on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
2028
|
-
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
2029
|
-
* part of the ARN, shown here in bold: </p>
|
|
2030
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
2031
|
-
* </p>
|
|
1995
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
2032
1996
|
* @public
|
|
2033
1997
|
*/
|
|
2034
|
-
|
|
1998
|
+
SearchCriteria?: AgentStatusSearchCriteria | undefined;
|
|
1999
|
+
}
|
|
2000
|
+
/**
|
|
2001
|
+
* @public
|
|
2002
|
+
*/
|
|
2003
|
+
export interface SearchContactFlowModulesRequest {
|
|
2035
2004
|
/**
|
|
2036
|
-
* <p>The
|
|
2037
|
-
*
|
|
2038
|
-
* the new email contact. All updates to user-defined attributes in the new email contact are
|
|
2039
|
-
* limited to the individual contact ID. There are no limits to the number of contacts that can be
|
|
2040
|
-
* linked by using <code>RelatedContactId</code>. </p>
|
|
2005
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
2006
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
2041
2007
|
* @public
|
|
2042
2008
|
*/
|
|
2043
|
-
|
|
2009
|
+
InstanceId: string | undefined;
|
|
2044
2010
|
/**
|
|
2045
|
-
* <p>
|
|
2046
|
-
*
|
|
2047
|
-
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2011
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
2012
|
+
* the next request to retrieve the next set of results.</p>
|
|
2048
2013
|
* @public
|
|
2049
2014
|
*/
|
|
2050
|
-
|
|
2015
|
+
NextToken?: string | undefined;
|
|
2051
2016
|
/**
|
|
2052
|
-
* <p>
|
|
2053
|
-
*
|
|
2054
|
-
|
|
2055
|
-
|
|
2056
|
-
|
|
2017
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2018
|
+
* @public
|
|
2019
|
+
*/
|
|
2020
|
+
MaxResults?: number | undefined;
|
|
2021
|
+
/**
|
|
2022
|
+
* <p>Filters to be applied to search results.</p>
|
|
2023
|
+
* @public
|
|
2024
|
+
*/
|
|
2025
|
+
SearchFilter?: ContactFlowModuleSearchFilter | undefined;
|
|
2026
|
+
/**
|
|
2027
|
+
* <p>The search criteria to be used to return flow modules.</p>
|
|
2057
2028
|
* <note>
|
|
2058
|
-
* <p>
|
|
2059
|
-
*
|
|
2060
|
-
*
|
|
2061
|
-
* "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
|
|
2029
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
2030
|
+
* minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2031
|
+
* outside of this range will result in invalid results.</p>
|
|
2062
2032
|
* </note>
|
|
2063
2033
|
* @public
|
|
2064
2034
|
*/
|
|
2065
|
-
|
|
2035
|
+
SearchCriteria?: ContactFlowModuleSearchCriteria | undefined;
|
|
2036
|
+
}
|
|
2037
|
+
/**
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
export interface SearchContactFlowsRequest {
|
|
2066
2041
|
/**
|
|
2067
|
-
* <p>
|
|
2068
|
-
*
|
|
2069
|
-
* SDK populates this field. For more information about idempotency, see
|
|
2070
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2042
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
2043
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
2071
2044
|
* @public
|
|
2072
2045
|
*/
|
|
2073
|
-
|
|
2046
|
+
InstanceId: string | undefined;
|
|
2047
|
+
/**
|
|
2048
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
2049
|
+
* the next request to retrieve the next set of results.</p>
|
|
2050
|
+
* @public
|
|
2051
|
+
*/
|
|
2052
|
+
NextToken?: string | undefined;
|
|
2053
|
+
/**
|
|
2054
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2055
|
+
* @public
|
|
2056
|
+
*/
|
|
2057
|
+
MaxResults?: number | undefined;
|
|
2058
|
+
/**
|
|
2059
|
+
* <p>Filters to be applied to search results.</p>
|
|
2060
|
+
* @public
|
|
2061
|
+
*/
|
|
2062
|
+
SearchFilter?: ContactFlowSearchFilter | undefined;
|
|
2063
|
+
/**
|
|
2064
|
+
* <p>The search criteria to be used to return flows.</p>
|
|
2065
|
+
* <note>
|
|
2066
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
2067
|
+
* minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2068
|
+
* outside of this range will result in invalid results.</p>
|
|
2069
|
+
* </note>
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
SearchCriteria?: ContactFlowSearchCriteria | undefined;
|
|
2074
2073
|
}
|
|
2075
2074
|
/**
|
|
2076
2075
|
* @public
|
|
2077
2076
|
*/
|
|
2078
|
-
export interface
|
|
2077
|
+
export interface SearchEmailAddressesRequest {
|
|
2079
2078
|
/**
|
|
2080
|
-
* <p>
|
|
2079
|
+
* <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>
|
|
2081
2080
|
* @public
|
|
2082
2081
|
*/
|
|
2083
|
-
|
|
2082
|
+
InstanceId: string | undefined;
|
|
2084
2083
|
/**
|
|
2085
|
-
* <p>
|
|
2084
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2086
2085
|
* @public
|
|
2087
2086
|
*/
|
|
2088
|
-
|
|
2087
|
+
MaxResults?: number | undefined;
|
|
2089
2088
|
/**
|
|
2090
|
-
* <p>The
|
|
2091
|
-
*
|
|
2089
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2090
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2091
|
+
* @public
|
|
2092
|
+
*/
|
|
2093
|
+
NextToken?: string | undefined;
|
|
2094
|
+
/**
|
|
2095
|
+
* <p>The search criteria to be used to return email addresses.</p>
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
SearchCriteria?: EmailAddressSearchCriteria | undefined;
|
|
2099
|
+
/**
|
|
2100
|
+
* <p>Filters to be applied to search results.</p>
|
|
2101
|
+
* @public
|
|
2102
|
+
*/
|
|
2103
|
+
SearchFilter?: EmailAddressSearchFilter | undefined;
|
|
2104
|
+
}
|
|
2105
|
+
/**
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
export interface SearchHoursOfOperationOverridesRequest {
|
|
2109
|
+
/**
|
|
2110
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
2092
2111
|
* @public
|
|
2093
2112
|
*/
|
|
2094
2113
|
InstanceId: string | undefined;
|
|
2095
2114
|
/**
|
|
2096
|
-
* <p>
|
|
2097
|
-
*
|
|
2098
|
-
* flows.</p>
|
|
2099
|
-
* <ul>
|
|
2100
|
-
* <li>
|
|
2101
|
-
* <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
|
|
2102
|
-
* </li>
|
|
2103
|
-
* <li>
|
|
2104
|
-
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and
|
|
2105
|
-
* <code>connect:SMS</code>.</p>
|
|
2106
|
-
* </li>
|
|
2107
|
-
* </ul>
|
|
2115
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
2116
|
+
* the next request to retrieve the next set of results. </p>
|
|
2108
2117
|
* @public
|
|
2109
2118
|
*/
|
|
2110
|
-
|
|
2119
|
+
NextToken?: string | undefined;
|
|
2111
2120
|
/**
|
|
2112
|
-
* <p>
|
|
2121
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2113
2122
|
* @public
|
|
2114
2123
|
*/
|
|
2115
|
-
|
|
2124
|
+
MaxResults?: number | undefined;
|
|
2116
2125
|
/**
|
|
2117
|
-
* <p>
|
|
2118
|
-
* console user interface, on the navigation menu go to <b>Routing, Contact
|
|
2119
|
-
* Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
2120
|
-
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
2121
|
-
* part of the ARN, shown here in bold:</p>
|
|
2122
|
-
* <ul>
|
|
2123
|
-
* <li>
|
|
2124
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
|
|
2125
|
-
* </p>
|
|
2126
|
-
* </li>
|
|
2127
|
-
* </ul>
|
|
2126
|
+
* <p>Filters to be applied to search results.</p>
|
|
2128
2127
|
* @public
|
|
2129
2128
|
*/
|
|
2130
|
-
|
|
2129
|
+
SearchFilter?: HoursOfOperationSearchFilter | undefined;
|
|
2131
2130
|
/**
|
|
2132
|
-
* <p>The
|
|
2133
|
-
* duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
|
|
2134
|
-
* configurable time is 10,080 minutes (7 days).</p>
|
|
2131
|
+
* <p>The search criteria to be used to return hours of operations overrides.</p>
|
|
2135
2132
|
* @public
|
|
2136
2133
|
*/
|
|
2137
|
-
|
|
2134
|
+
SearchCriteria?: HoursOfOperationOverrideSearchCriteria | undefined;
|
|
2135
|
+
}
|
|
2136
|
+
/**
|
|
2137
|
+
* @public
|
|
2138
|
+
*/
|
|
2139
|
+
export interface SearchHoursOfOperationsRequest {
|
|
2138
2140
|
/**
|
|
2139
|
-
* <p>The
|
|
2141
|
+
* <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>
|
|
2140
2142
|
* @public
|
|
2141
2143
|
*/
|
|
2142
|
-
|
|
2144
|
+
InstanceId: string | undefined;
|
|
2143
2145
|
/**
|
|
2144
|
-
* <p>
|
|
2146
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2147
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2145
2148
|
* @public
|
|
2146
2149
|
*/
|
|
2147
|
-
|
|
2150
|
+
NextToken?: string | undefined;
|
|
2148
2151
|
/**
|
|
2149
|
-
* <p>The
|
|
2150
|
-
* contact starting.</p>
|
|
2152
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2151
2153
|
* @public
|
|
2152
2154
|
*/
|
|
2153
|
-
|
|
2155
|
+
MaxResults?: number | undefined;
|
|
2154
2156
|
/**
|
|
2155
|
-
* <p>
|
|
2156
|
-
*
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
*
|
|
2161
|
-
*
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
*
|
|
2171
|
-
*
|
|
2172
|
-
* </li>
|
|
2173
|
-
* <li>
|
|
2174
|
-
* <p>
|
|
2175
|
-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>
|
|
2176
|
-
* </p>
|
|
2177
|
-
* </li>
|
|
2178
|
-
* </ul>
|
|
2179
|
-
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
2180
|
-
* supported type in the list. For example, all the following lists are valid because they contain
|
|
2181
|
-
* <code>text/plain</code>:</p>
|
|
2182
|
-
* <ul>
|
|
2183
|
-
* <li>
|
|
2184
|
-
* <p>
|
|
2185
|
-
* <code>[text/plain, text/markdown, application/json]</code>
|
|
2186
|
-
* </p>
|
|
2187
|
-
* </li>
|
|
2188
|
-
* <li>
|
|
2189
|
-
* <p>
|
|
2190
|
-
* <code>[text/markdown, text/plain]</code>
|
|
2191
|
-
* </p>
|
|
2192
|
-
* </li>
|
|
2193
|
-
* <li>
|
|
2194
|
-
* <p>
|
|
2195
|
-
* <code>[text/plain, application/json,
|
|
2196
|
-
* application/vnd.amazonaws.connect.message.interactive.response]</code>
|
|
2197
|
-
* </p>
|
|
2198
|
-
* </li>
|
|
2199
|
-
* </ul>
|
|
2157
|
+
* <p>Filters to be applied to search results.</p>
|
|
2158
|
+
* @public
|
|
2159
|
+
*/
|
|
2160
|
+
SearchFilter?: HoursOfOperationSearchFilter | undefined;
|
|
2161
|
+
/**
|
|
2162
|
+
* <p>The search criteria to be used to return hours of operations.</p>
|
|
2163
|
+
* @public
|
|
2164
|
+
*/
|
|
2165
|
+
SearchCriteria?: HoursOfOperationSearchCriteria | undefined;
|
|
2166
|
+
}
|
|
2167
|
+
/**
|
|
2168
|
+
* @public
|
|
2169
|
+
*/
|
|
2170
|
+
export interface SearchPredefinedAttributesRequest {
|
|
2171
|
+
/**
|
|
2172
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
2173
|
+
* Name (ARN) of the instance.</p>
|
|
2200
2174
|
* @public
|
|
2201
2175
|
*/
|
|
2202
|
-
|
|
2176
|
+
InstanceId: string | undefined;
|
|
2203
2177
|
/**
|
|
2204
|
-
* <p>
|
|
2205
|
-
*
|
|
2206
|
-
* idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making
|
|
2207
|
-
* retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a
|
|
2208
|
-
* contact is already started, the contact ID is returned.</p>
|
|
2178
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
2179
|
+
* the next request to retrieve the next set of results.</p>
|
|
2209
2180
|
* @public
|
|
2210
2181
|
*/
|
|
2211
|
-
|
|
2182
|
+
NextToken?: string | undefined;
|
|
2183
|
+
/**
|
|
2184
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2185
|
+
* @public
|
|
2186
|
+
*/
|
|
2187
|
+
MaxResults?: number | undefined;
|
|
2188
|
+
/**
|
|
2189
|
+
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
2190
|
+
* @public
|
|
2191
|
+
*/
|
|
2192
|
+
SearchCriteria?: PredefinedAttributeSearchCriteria | undefined;
|
|
2212
2193
|
}
|
|
2213
2194
|
/**
|
|
2214
2195
|
* @public
|
|
2215
2196
|
*/
|
|
2216
|
-
export interface
|
|
2197
|
+
export interface SearchPromptsRequest {
|
|
2217
2198
|
/**
|
|
2218
2199
|
* <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>
|
|
2219
2200
|
* @public
|
|
2220
2201
|
*/
|
|
2221
2202
|
InstanceId: string | undefined;
|
|
2222
2203
|
/**
|
|
2223
|
-
* <p>The
|
|
2224
|
-
*
|
|
2225
|
-
* every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
|
|
2204
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2205
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2226
2206
|
* @public
|
|
2227
2207
|
*/
|
|
2228
|
-
|
|
2208
|
+
NextToken?: string | undefined;
|
|
2229
2209
|
/**
|
|
2230
|
-
* <p>The
|
|
2231
|
-
* on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
2232
|
-
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
2233
|
-
* part of the ARN, shown here in bold: </p>
|
|
2234
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
2235
|
-
* </p>
|
|
2210
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2236
2211
|
* @public
|
|
2237
2212
|
*/
|
|
2238
|
-
|
|
2213
|
+
MaxResults?: number | undefined;
|
|
2239
2214
|
/**
|
|
2240
|
-
* <p>
|
|
2241
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
2242
|
-
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2215
|
+
* <p>Filters to be applied to search results.</p>
|
|
2243
2216
|
* @public
|
|
2244
2217
|
*/
|
|
2245
|
-
|
|
2218
|
+
SearchFilter?: PromptSearchFilter | undefined;
|
|
2246
2219
|
/**
|
|
2247
|
-
* <p>The
|
|
2220
|
+
* <p>The search criteria to be used to return prompts.</p>
|
|
2248
2221
|
* @public
|
|
2249
2222
|
*/
|
|
2250
|
-
|
|
2223
|
+
SearchCriteria?: PromptSearchCriteria | undefined;
|
|
2224
|
+
}
|
|
2225
|
+
/**
|
|
2226
|
+
* @public
|
|
2227
|
+
*/
|
|
2228
|
+
export interface SearchQueuesRequest {
|
|
2251
2229
|
/**
|
|
2252
|
-
* <p>
|
|
2253
|
-
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
2254
|
-
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
|
|
2255
|
-
* supported reference type during task creation.</p>
|
|
2230
|
+
* <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>
|
|
2256
2231
|
* @public
|
|
2257
2232
|
*/
|
|
2258
|
-
|
|
2233
|
+
InstanceId: string | undefined;
|
|
2259
2234
|
/**
|
|
2260
|
-
* <p>
|
|
2261
|
-
*
|
|
2235
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2236
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2262
2237
|
* @public
|
|
2263
2238
|
*/
|
|
2264
|
-
|
|
2239
|
+
NextToken?: string | undefined;
|
|
2265
2240
|
/**
|
|
2266
|
-
* <p>
|
|
2267
|
-
* request. If not provided, the Amazon Web Services
|
|
2268
|
-
* SDK populates this field. For more information about idempotency, see
|
|
2269
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2241
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2270
2242
|
* @public
|
|
2271
2243
|
*/
|
|
2272
|
-
|
|
2244
|
+
MaxResults?: number | undefined;
|
|
2273
2245
|
/**
|
|
2274
|
-
* <p>
|
|
2246
|
+
* <p>Filters to be applied to search results.</p>
|
|
2275
2247
|
* @public
|
|
2276
2248
|
*/
|
|
2277
|
-
|
|
2249
|
+
SearchFilter?: QueueSearchFilter | undefined;
|
|
2278
2250
|
/**
|
|
2279
|
-
* <p>
|
|
2280
|
-
*
|
|
2251
|
+
* <p>The search criteria to be used to return queues.</p>
|
|
2252
|
+
* <note>
|
|
2253
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
2254
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2255
|
+
* outside of this range will throw invalid results. </p>
|
|
2256
|
+
* </note>
|
|
2281
2257
|
* @public
|
|
2282
2258
|
*/
|
|
2283
|
-
|
|
2259
|
+
SearchCriteria?: QueueSearchCriteria | undefined;
|
|
2260
|
+
}
|
|
2261
|
+
/**
|
|
2262
|
+
* @public
|
|
2263
|
+
*/
|
|
2264
|
+
export interface SearchQuickConnectsRequest {
|
|
2284
2265
|
/**
|
|
2285
|
-
* <p>The identifier
|
|
2286
|
-
* flow that is defined on agent or queue quick connect. For more information about quick connects,
|
|
2287
|
-
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
|
|
2288
|
-
* connects</a>.</p>
|
|
2266
|
+
* <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>
|
|
2289
2267
|
* @public
|
|
2290
2268
|
*/
|
|
2291
|
-
|
|
2269
|
+
InstanceId: string | undefined;
|
|
2292
2270
|
/**
|
|
2293
|
-
* <p>The
|
|
2294
|
-
*
|
|
2295
|
-
* related task contact to the new task contact. All updates to user-defined attributes in the new
|
|
2296
|
-
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked
|
|
2297
|
-
* by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
|
|
2298
|
-
* be linked by using <code>RelatedContactId</code>. </p>
|
|
2271
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2272
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2299
2273
|
* @public
|
|
2300
2274
|
*/
|
|
2301
|
-
|
|
2275
|
+
NextToken?: string | undefined;
|
|
2302
2276
|
/**
|
|
2303
|
-
* <p>
|
|
2304
|
-
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
2305
|
-
* They can be accessed in flows.</p>
|
|
2306
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
2307
|
-
* <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for
|
|
2308
|
-
* the User who created a task.</p>
|
|
2309
|
-
* <note>
|
|
2310
|
-
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
2311
|
-
* minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
|
|
2312
|
-
* \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
|
|
2313
|
-
* 135\}\}\}\}</code>. </p>
|
|
2314
|
-
* <p>To set the created by user, a valid AgentResourceId must be supplied, with
|
|
2315
|
-
* <code>SegmentAttributes</code> like \{ <code>"connect:CreatedByUser" \{ "ValueString":
|
|
2316
|
-
* "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
|
|
2317
|
-
* </p>
|
|
2318
|
-
* </note>
|
|
2277
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2319
2278
|
* @public
|
|
2320
2279
|
*/
|
|
2321
|
-
|
|
2280
|
+
MaxResults?: number | undefined;
|
|
2281
|
+
/**
|
|
2282
|
+
* <p>Filters to be applied to search results.</p>
|
|
2283
|
+
* @public
|
|
2284
|
+
*/
|
|
2285
|
+
SearchFilter?: QuickConnectSearchFilter | undefined;
|
|
2286
|
+
/**
|
|
2287
|
+
* <p>The search criteria to be used to return quick connects.</p>
|
|
2288
|
+
* @public
|
|
2289
|
+
*/
|
|
2290
|
+
SearchCriteria?: QuickConnectSearchCriteria | undefined;
|
|
2322
2291
|
}
|
|
2323
2292
|
/**
|
|
2324
2293
|
* @public
|
|
2325
2294
|
*/
|
|
2326
|
-
export interface
|
|
2295
|
+
export interface SearchRoutingProfilesRequest {
|
|
2327
2296
|
/**
|
|
2328
2297
|
* <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>
|
|
2329
2298
|
* @public
|
|
2330
2299
|
*/
|
|
2331
2300
|
InstanceId: string | undefined;
|
|
2332
2301
|
/**
|
|
2333
|
-
* <p>The
|
|
2334
|
-
*
|
|
2302
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2303
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2335
2304
|
* @public
|
|
2336
2305
|
*/
|
|
2337
|
-
|
|
2306
|
+
NextToken?: string | undefined;
|
|
2338
2307
|
/**
|
|
2339
|
-
* <p>The
|
|
2308
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2340
2309
|
* @public
|
|
2341
2310
|
*/
|
|
2342
|
-
|
|
2311
|
+
MaxResults?: number | undefined;
|
|
2343
2312
|
/**
|
|
2344
|
-
* <p>
|
|
2313
|
+
* <p>Filters to be applied to search results.</p>
|
|
2345
2314
|
* @public
|
|
2346
2315
|
*/
|
|
2347
|
-
|
|
2316
|
+
SearchFilter?: RoutingProfileSearchFilter | undefined;
|
|
2348
2317
|
/**
|
|
2349
|
-
* <p>
|
|
2318
|
+
* <p>The search criteria to be used to return routing profiles.</p>
|
|
2319
|
+
* <note>
|
|
2320
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
2321
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2322
|
+
* outside of this range will throw invalid results. </p>
|
|
2323
|
+
* </note>
|
|
2350
2324
|
* @public
|
|
2351
2325
|
*/
|
|
2352
|
-
|
|
2326
|
+
SearchCriteria?: RoutingProfileSearchCriteria | undefined;
|
|
2327
|
+
}
|
|
2328
|
+
/**
|
|
2329
|
+
* @public
|
|
2330
|
+
*/
|
|
2331
|
+
export interface SearchSecurityProfilesRequest {
|
|
2353
2332
|
/**
|
|
2354
|
-
* <p>
|
|
2355
|
-
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
2356
|
-
* They can be accessed in flows.</p>
|
|
2357
|
-
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
2358
|
-
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
2359
|
-
* <p>Currently Contact Expiry is the only segment attribute which can be updated by using the
|
|
2360
|
-
* UpdateContact API.</p>
|
|
2333
|
+
* <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>
|
|
2361
2334
|
* @public
|
|
2362
2335
|
*/
|
|
2363
|
-
|
|
2336
|
+
InstanceId: string | undefined;
|
|
2364
2337
|
/**
|
|
2365
|
-
* <p>
|
|
2366
|
-
*
|
|
2367
|
-
* analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
2368
|
-
* the <i>
|
|
2369
|
-
* Amazon Connect Administrator Guide</i>.</p>
|
|
2338
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2339
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2370
2340
|
* @public
|
|
2371
2341
|
*/
|
|
2372
|
-
|
|
2342
|
+
NextToken?: string | undefined;
|
|
2373
2343
|
/**
|
|
2374
|
-
* <p>
|
|
2375
|
-
* for external audio contacts. It is used when you integrate third-party systems with Contact Lens for
|
|
2376
|
-
* analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
2377
|
-
* the <i>
|
|
2378
|
-
* Amazon Connect Administrator Guide</i>.</p>
|
|
2344
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2379
2345
|
* @public
|
|
2380
2346
|
*/
|
|
2381
|
-
|
|
2347
|
+
MaxResults?: number | undefined;
|
|
2382
2348
|
/**
|
|
2383
|
-
* <p>The
|
|
2384
|
-
*
|
|
2385
|
-
*
|
|
2386
|
-
*
|
|
2349
|
+
* <p>The search criteria to be used to return security profiles. </p>
|
|
2350
|
+
* <note>
|
|
2351
|
+
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
|
|
2352
|
+
* maximum of 25 characters. Any queries with character lengths outside of this range will throw
|
|
2353
|
+
* invalid results.</p>
|
|
2354
|
+
* </note>
|
|
2355
|
+
* <note>
|
|
2356
|
+
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
2357
|
+
* </p>
|
|
2358
|
+
* </note>
|
|
2387
2359
|
* @public
|
|
2388
2360
|
*/
|
|
2389
|
-
|
|
2361
|
+
SearchCriteria?: SecurityProfileSearchCriteria | undefined;
|
|
2390
2362
|
/**
|
|
2391
|
-
* <p>
|
|
2392
|
-
* the phone number of the external system such as the contact center. This value can only be
|
|
2393
|
-
* updated for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens
|
|
2394
|
-
* integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
2363
|
+
* <p>Filters to be applied to search results.</p>
|
|
2395
2364
|
* @public
|
|
2396
2365
|
*/
|
|
2397
|
-
|
|
2366
|
+
SearchFilter?: SecurityProfilesSearchFilter | undefined;
|
|
2398
2367
|
}
|
|
2399
2368
|
/**
|
|
2400
2369
|
* @public
|
|
2401
2370
|
*/
|
|
2402
|
-
export interface
|
|
2371
|
+
export interface SearchUserHierarchyGroupsRequest {
|
|
2403
2372
|
/**
|
|
2404
|
-
* <p>The identifier of the Amazon Connect instance. You can
|
|
2373
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
2374
|
+
* the instance.</p>
|
|
2405
2375
|
* @public
|
|
2406
2376
|
*/
|
|
2407
2377
|
InstanceId: string | undefined;
|
|
2408
2378
|
/**
|
|
2409
|
-
* <p>The
|
|
2379
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
2380
|
+
* the next request to retrieve the next set of results.</p>
|
|
2410
2381
|
* @public
|
|
2411
2382
|
*/
|
|
2412
|
-
|
|
2383
|
+
NextToken?: string | undefined;
|
|
2413
2384
|
/**
|
|
2414
|
-
* <p>
|
|
2385
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2415
2386
|
* @public
|
|
2416
2387
|
*/
|
|
2417
|
-
|
|
2388
|
+
MaxResults?: number | undefined;
|
|
2418
2389
|
/**
|
|
2419
|
-
* <p>
|
|
2390
|
+
* <p>Filters to be applied to search results.</p>
|
|
2420
2391
|
* @public
|
|
2421
2392
|
*/
|
|
2422
|
-
|
|
2393
|
+
SearchFilter?: UserHierarchyGroupSearchFilter | undefined;
|
|
2423
2394
|
/**
|
|
2424
|
-
* <p>
|
|
2395
|
+
* <p>The search criteria to be used to return UserHierarchyGroups.</p>
|
|
2425
2396
|
* @public
|
|
2426
2397
|
*/
|
|
2427
|
-
|
|
2398
|
+
SearchCriteria?: UserHierarchyGroupSearchCriteria | undefined;
|
|
2399
|
+
}
|
|
2400
|
+
/**
|
|
2401
|
+
* @public
|
|
2402
|
+
*/
|
|
2403
|
+
export interface SearchUsersRequest {
|
|
2428
2404
|
/**
|
|
2429
|
-
* <p>The
|
|
2405
|
+
* <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>
|
|
2430
2406
|
* @public
|
|
2431
2407
|
*/
|
|
2432
|
-
|
|
2408
|
+
InstanceId: string | undefined;
|
|
2409
|
+
/**
|
|
2410
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2411
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2412
|
+
* @public
|
|
2413
|
+
*/
|
|
2414
|
+
NextToken?: string | undefined;
|
|
2433
2415
|
/**
|
|
2434
|
-
* <p>
|
|
2416
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2435
2417
|
* @public
|
|
2436
2418
|
*/
|
|
2437
|
-
|
|
2419
|
+
MaxResults?: number | undefined;
|
|
2438
2420
|
/**
|
|
2439
|
-
* <p>
|
|
2421
|
+
* <p>Filters to be applied to search results.</p>
|
|
2440
2422
|
* @public
|
|
2441
2423
|
*/
|
|
2442
|
-
|
|
2424
|
+
SearchFilter?: UserSearchFilter | undefined;
|
|
2443
2425
|
/**
|
|
2444
|
-
* <p>
|
|
2445
|
-
*
|
|
2446
|
-
*
|
|
2447
|
-
*
|
|
2426
|
+
* <p>The search criteria to be used to return users.</p>
|
|
2427
|
+
* <note>
|
|
2428
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
2429
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2430
|
+
* outside of this range will throw invalid results. </p>
|
|
2431
|
+
* </note>
|
|
2448
2432
|
* @public
|
|
2449
2433
|
*/
|
|
2450
|
-
|
|
2434
|
+
SearchCriteria?: UserSearchCriteria | undefined;
|
|
2451
2435
|
}
|
|
2452
2436
|
/**
|
|
2453
|
-
* <p>
|
|
2437
|
+
* <p>Step signifies the criteria to be used for routing to an agent</p>
|
|
2454
2438
|
* @public
|
|
2455
2439
|
*/
|
|
2456
|
-
export interface
|
|
2440
|
+
export interface Step {
|
|
2457
2441
|
/**
|
|
2458
|
-
* <p>
|
|
2442
|
+
* <p>An object to specify the expiration of a routing step.</p>
|
|
2459
2443
|
* @public
|
|
2460
2444
|
*/
|
|
2461
|
-
|
|
2445
|
+
Expiry?: Expiry | undefined;
|
|
2462
2446
|
/**
|
|
2463
|
-
* <p>A
|
|
2447
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
2464
2448
|
* @public
|
|
2465
2449
|
*/
|
|
2466
|
-
|
|
2450
|
+
Expression?: Expression | undefined;
|
|
2467
2451
|
/**
|
|
2468
|
-
* <p>
|
|
2469
|
-
* <note>
|
|
2470
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
2471
|
-
* <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
2472
|
-
* </note>
|
|
2452
|
+
* <p>Represents status of the Routing step.</p>
|
|
2473
2453
|
* @public
|
|
2474
2454
|
*/
|
|
2475
|
-
|
|
2455
|
+
Status?: RoutingCriteriaStepStatus | undefined;
|
|
2476
2456
|
}
|
|
2477
2457
|
/**
|
|
2478
|
-
* <p>The search criteria to be used to return users.</p>
|
|
2479
|
-
* <note>
|
|
2480
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
2481
|
-
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2482
|
-
* outside of this range will throw invalid results. </p>
|
|
2483
|
-
* </note>
|
|
2484
2458
|
* @public
|
|
2485
2459
|
*/
|
|
2486
|
-
export interface
|
|
2487
|
-
/**
|
|
2488
|
-
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
2489
|
-
* condition.</p>
|
|
2490
|
-
* @public
|
|
2491
|
-
*/
|
|
2492
|
-
OrConditions?: UserSearchCriteria[] | undefined;
|
|
2460
|
+
export interface CreateContactRequest {
|
|
2493
2461
|
/**
|
|
2494
|
-
* <p>
|
|
2495
|
-
* </p>
|
|
2462
|
+
* <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>
|
|
2496
2463
|
* @public
|
|
2497
2464
|
*/
|
|
2498
|
-
|
|
2465
|
+
InstanceId: string | undefined;
|
|
2499
2466
|
/**
|
|
2500
|
-
* <p>A
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2503
|
-
*
|
|
2467
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2468
|
+
* request. If not provided, the Amazon Web Services
|
|
2469
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2470
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2504
2471
|
* @public
|
|
2505
2472
|
*/
|
|
2506
|
-
|
|
2473
|
+
ClientToken?: string | undefined;
|
|
2507
2474
|
/**
|
|
2508
|
-
* <p>
|
|
2509
|
-
* attributes included in Lists like Proficiencies.</p>
|
|
2475
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2510
2476
|
* @public
|
|
2511
2477
|
*/
|
|
2512
|
-
|
|
2478
|
+
RelatedContactId?: string | undefined;
|
|
2513
2479
|
/**
|
|
2514
|
-
* <p>A
|
|
2480
|
+
* <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>
|
|
2481
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
2482
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2515
2483
|
* @public
|
|
2516
2484
|
*/
|
|
2517
|
-
|
|
2518
|
-
}
|
|
2519
|
-
/**
|
|
2520
|
-
* @public
|
|
2521
|
-
*/
|
|
2522
|
-
export interface DescribeContactEvaluationResponse {
|
|
2485
|
+
Attributes?: Record<string, string> | undefined;
|
|
2523
2486
|
/**
|
|
2524
|
-
* <p>
|
|
2487
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
2488
|
+
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
2489
|
+
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code> | <code>ATTACHMENT</code>.</p>
|
|
2525
2490
|
* @public
|
|
2526
2491
|
*/
|
|
2527
|
-
|
|
2492
|
+
References?: Record<string, Reference> | undefined;
|
|
2528
2493
|
/**
|
|
2529
|
-
* <p>
|
|
2494
|
+
* <p>The channel for the contact.</p>
|
|
2495
|
+
* <important>
|
|
2496
|
+
* <p>The CHAT channel is not supported. The following information is incorrect. We're working to
|
|
2497
|
+
* correct it.</p>
|
|
2498
|
+
* </important>
|
|
2530
2499
|
* @public
|
|
2531
2500
|
*/
|
|
2532
|
-
|
|
2533
|
-
}
|
|
2534
|
-
/**
|
|
2535
|
-
* @public
|
|
2536
|
-
*/
|
|
2537
|
-
export interface DescribeEvaluationFormResponse {
|
|
2501
|
+
Channel: Channel | undefined;
|
|
2538
2502
|
/**
|
|
2539
|
-
* <p>
|
|
2503
|
+
* <p>Indicates how the contact was initiated. </p>
|
|
2504
|
+
* <important>
|
|
2505
|
+
* <p>CreateContact only supports the following initiation methods. Valid values by channel are: </p>
|
|
2506
|
+
* <ul>
|
|
2507
|
+
* <li>
|
|
2508
|
+
* <p>For VOICE: <code>TRANSFER</code> and the subtype <code>connect:ExternalAudio</code>
|
|
2509
|
+
* </p>
|
|
2510
|
+
* </li>
|
|
2511
|
+
* <li>
|
|
2512
|
+
* <p>For EMAIL: <code>OUTBOUND</code> | <code>AGENT_REPLY</code> | <code>FLOW</code>
|
|
2513
|
+
* </p>
|
|
2514
|
+
* </li>
|
|
2515
|
+
* <li>
|
|
2516
|
+
* <p>For TASK: <code>API</code>
|
|
2517
|
+
* </p>
|
|
2518
|
+
* </li>
|
|
2519
|
+
* </ul>
|
|
2520
|
+
* <p>The other channels listed below are incorrect. We're working to correct this
|
|
2521
|
+
* information.</p>
|
|
2522
|
+
* </important>
|
|
2540
2523
|
* @public
|
|
2541
2524
|
*/
|
|
2542
|
-
|
|
2543
|
-
}
|
|
2544
|
-
/**
|
|
2545
|
-
* <p>Step defines the list of agents to be routed or route based on the agent requirements such
|
|
2546
|
-
* as ProficiencyLevel, Name, or Value.</p>
|
|
2547
|
-
* @public
|
|
2548
|
-
*/
|
|
2549
|
-
export interface RoutingCriteriaInputStep {
|
|
2525
|
+
InitiationMethod: ContactInitiationMethod | undefined;
|
|
2550
2526
|
/**
|
|
2551
|
-
* <p>
|
|
2527
|
+
* <p>Number of minutes the contact will be active for before expiring</p>
|
|
2552
2528
|
* @public
|
|
2553
2529
|
*/
|
|
2554
|
-
|
|
2530
|
+
ExpiryDurationInMinutes?: number | undefined;
|
|
2555
2531
|
/**
|
|
2556
|
-
* <p>
|
|
2532
|
+
* <p>User details for the contact</p>
|
|
2533
|
+
* <important>
|
|
2534
|
+
* <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and
|
|
2535
|
+
* <code>AGENT_REPLY</code> contact initiation methods.</p>
|
|
2536
|
+
* </important>
|
|
2557
2537
|
* @public
|
|
2558
2538
|
*/
|
|
2559
|
-
|
|
2560
|
-
}
|
|
2561
|
-
/**
|
|
2562
|
-
* @public
|
|
2563
|
-
*/
|
|
2564
|
-
export interface SearchAgentStatusesRequest {
|
|
2539
|
+
UserInfo?: UserInfo | undefined;
|
|
2565
2540
|
/**
|
|
2566
|
-
* <p>
|
|
2567
|
-
*
|
|
2541
|
+
* <p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated
|
|
2542
|
+
* with <code>COMPLETED</code> state.</p>
|
|
2568
2543
|
* @public
|
|
2569
2544
|
*/
|
|
2570
|
-
|
|
2545
|
+
InitiateAs?: InitiateAs | undefined;
|
|
2571
2546
|
/**
|
|
2572
|
-
* <p>The
|
|
2573
|
-
* the next request to retrieve the next set of results.</p>
|
|
2547
|
+
* <p>The name of a the contact.</p>
|
|
2574
2548
|
* @public
|
|
2575
2549
|
*/
|
|
2576
|
-
|
|
2550
|
+
Name?: string | undefined;
|
|
2577
2551
|
/**
|
|
2578
|
-
* <p>
|
|
2552
|
+
* <p>A description of the contact.</p>
|
|
2579
2553
|
* @public
|
|
2580
2554
|
*/
|
|
2581
|
-
|
|
2555
|
+
Description?: string | undefined;
|
|
2582
2556
|
/**
|
|
2583
|
-
* <p>
|
|
2557
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
2558
|
+
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
2559
|
+
* They can be accessed in flows.</p>
|
|
2560
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
2561
|
+
* <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
|
|
2562
|
+
* <note>
|
|
2563
|
+
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
2564
|
+
* minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
|
|
2565
|
+
* \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
|
|
2566
|
+
* 135\}\}\}\}</code>. </p>
|
|
2567
|
+
* </note>
|
|
2584
2568
|
* @public
|
|
2585
2569
|
*/
|
|
2586
|
-
|
|
2570
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
2587
2571
|
/**
|
|
2588
|
-
* <p>The
|
|
2572
|
+
* <p>The ID of the previous contact when creating a transfer contact. This value can be provided
|
|
2573
|
+
* only for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Integrate Amazon Connect Contact Lens
|
|
2574
|
+
* with external voice systems</a> in the <i>Amazon Connect Administrator
|
|
2575
|
+
* Guide</i>.</p>
|
|
2589
2576
|
* @public
|
|
2590
2577
|
*/
|
|
2591
|
-
|
|
2578
|
+
PreviousContactId?: string | undefined;
|
|
2592
2579
|
}
|
|
2593
2580
|
/**
|
|
2594
2581
|
* @public
|
|
2595
2582
|
*/
|
|
2596
|
-
export interface
|
|
2583
|
+
export interface StartChatContactRequest {
|
|
2597
2584
|
/**
|
|
2598
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
2599
|
-
* Amazon Resource Name (ARN) of the instance.</p>
|
|
2585
|
+
* <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>
|
|
2600
2586
|
* @public
|
|
2601
2587
|
*/
|
|
2602
2588
|
InstanceId: string | undefined;
|
|
2603
2589
|
/**
|
|
2604
|
-
* <p>The
|
|
2605
|
-
*
|
|
2590
|
+
* <p>The identifier of the flow for initiating the chat.
|
|
2591
|
+
* To
|
|
2592
|
+
* see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page,
|
|
2593
|
+
* under the name of the flow, choose <b>Show additional flow
|
|
2594
|
+
* information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
2595
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
2596
|
+
* </p>
|
|
2606
2597
|
* @public
|
|
2607
2598
|
*/
|
|
2608
|
-
|
|
2599
|
+
ContactFlowId: string | undefined;
|
|
2609
2600
|
/**
|
|
2610
|
-
* <p>The
|
|
2601
|
+
* <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>
|
|
2602
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
2603
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2611
2604
|
* @public
|
|
2612
2605
|
*/
|
|
2613
|
-
|
|
2606
|
+
Attributes?: Record<string, string> | undefined;
|
|
2614
2607
|
/**
|
|
2615
|
-
* <p>
|
|
2608
|
+
* <p>Information identifying the participant.</p>
|
|
2616
2609
|
* @public
|
|
2617
2610
|
*/
|
|
2618
|
-
|
|
2611
|
+
ParticipantDetails: ParticipantDetails | undefined;
|
|
2619
2612
|
/**
|
|
2620
|
-
* <p>The
|
|
2621
|
-
* <note>
|
|
2622
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
2623
|
-
* minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2624
|
-
* outside of this range will result in invalid results.</p>
|
|
2625
|
-
* </note>
|
|
2613
|
+
* <p>The initial message to be sent to the newly created chat.</p>
|
|
2626
2614
|
* @public
|
|
2627
2615
|
*/
|
|
2628
|
-
|
|
2629
|
-
}
|
|
2630
|
-
/**
|
|
2631
|
-
* @public
|
|
2632
|
-
*/
|
|
2633
|
-
export interface SearchContactFlowsRequest {
|
|
2616
|
+
InitialMessage?: ChatMessage | undefined;
|
|
2634
2617
|
/**
|
|
2635
|
-
* <p>
|
|
2636
|
-
*
|
|
2618
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2619
|
+
* request. If not provided, the Amazon Web Services
|
|
2620
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2621
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2622
|
+
* @public
|
|
2623
|
+
*/
|
|
2624
|
+
ClientToken?: string | undefined;
|
|
2625
|
+
/**
|
|
2626
|
+
* <p>The total duration of the newly started chat session. If not specified, the chat session
|
|
2627
|
+
* duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
|
|
2628
|
+
* configurable time is 10,080 minutes (7 days).</p>
|
|
2629
|
+
* @public
|
|
2630
|
+
*/
|
|
2631
|
+
ChatDurationInMinutes?: number | undefined;
|
|
2632
|
+
/**
|
|
2633
|
+
* <p>The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
2634
|
+
* <code>text/markdown</code>, <code>application/json</code>,
|
|
2635
|
+
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
2636
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
2637
|
+
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
2638
|
+
* supported type in the list. For example, all the following lists are valid because they contain
|
|
2639
|
+
* <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
|
|
2640
|
+
* <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
|
|
2641
|
+
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
2642
|
+
* <note>
|
|
2643
|
+
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
|
|
2644
|
+
* use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
|
|
2645
|
+
* view</a> flow block.</p>
|
|
2646
|
+
* </note>
|
|
2637
2647
|
* @public
|
|
2638
2648
|
*/
|
|
2639
|
-
|
|
2649
|
+
SupportedMessagingContentTypes?: string[] | undefined;
|
|
2640
2650
|
/**
|
|
2641
|
-
* <p>
|
|
2642
|
-
*
|
|
2651
|
+
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
2652
|
+
* 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>
|
|
2643
2653
|
* @public
|
|
2644
2654
|
*/
|
|
2645
|
-
|
|
2655
|
+
PersistentChat?: PersistentChat | undefined;
|
|
2646
2656
|
/**
|
|
2647
|
-
* <p>The
|
|
2657
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
2658
|
+
* chat starting.</p>
|
|
2659
|
+
* <note>
|
|
2660
|
+
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
|
|
2661
|
+
* </note>
|
|
2648
2662
|
* @public
|
|
2649
2663
|
*/
|
|
2650
|
-
|
|
2664
|
+
RelatedContactId?: string | undefined;
|
|
2651
2665
|
/**
|
|
2652
|
-
* <p>
|
|
2666
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
2667
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
|
|
2668
|
+
* flows.</p>
|
|
2669
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
2670
|
+
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
2671
|
+
* <note>
|
|
2672
|
+
* <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
|
|
2673
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
|
|
2674
|
+
* the SupportedMessagingContentTypes field of this API in order to set
|
|
2675
|
+
* <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
|
|
2676
|
+
* \}\}</code>.</p>
|
|
2677
|
+
* </note>
|
|
2653
2678
|
* @public
|
|
2654
2679
|
*/
|
|
2655
|
-
|
|
2680
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
2656
2681
|
/**
|
|
2657
|
-
* <p>The
|
|
2658
|
-
*
|
|
2659
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
2660
|
-
* minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2661
|
-
* outside of this range will result in invalid results.</p>
|
|
2662
|
-
* </note>
|
|
2682
|
+
* <p>The customer's identification number. For example, the <code>CustomerId</code> may be a
|
|
2683
|
+
* customer number from your CRM.</p>
|
|
2663
2684
|
* @public
|
|
2664
2685
|
*/
|
|
2665
|
-
|
|
2686
|
+
CustomerId?: string | undefined;
|
|
2666
2687
|
}
|
|
2667
2688
|
/**
|
|
2668
2689
|
* @public
|
|
2669
2690
|
*/
|
|
2670
|
-
export interface
|
|
2691
|
+
export interface StartEmailContactRequest {
|
|
2671
2692
|
/**
|
|
2672
2693
|
* <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>
|
|
2673
2694
|
* @public
|
|
2674
2695
|
*/
|
|
2675
2696
|
InstanceId: string | undefined;
|
|
2676
2697
|
/**
|
|
2677
|
-
* <p>The
|
|
2678
|
-
* @public
|
|
2679
|
-
*/
|
|
2680
|
-
MaxResults?: number | undefined;
|
|
2681
|
-
/**
|
|
2682
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2683
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
2698
|
+
* <p>The email address of the customer.</p>
|
|
2684
2699
|
* @public
|
|
2685
2700
|
*/
|
|
2686
|
-
|
|
2701
|
+
FromEmailAddress: EmailAddressInfo | undefined;
|
|
2687
2702
|
/**
|
|
2688
|
-
* <p>The
|
|
2703
|
+
* <p>The email address associated with the Amazon Connect instance.</p>
|
|
2689
2704
|
* @public
|
|
2690
2705
|
*/
|
|
2691
|
-
|
|
2706
|
+
DestinationEmailAddress: string | undefined;
|
|
2692
2707
|
/**
|
|
2693
|
-
* <p>
|
|
2708
|
+
* <p>A description of the email contact.</p>
|
|
2694
2709
|
* @public
|
|
2695
2710
|
*/
|
|
2696
|
-
|
|
2697
|
-
}
|
|
2698
|
-
/**
|
|
2699
|
-
* @public
|
|
2700
|
-
*/
|
|
2701
|
-
export interface SearchHoursOfOperationOverridesRequest {
|
|
2711
|
+
Description?: string | undefined;
|
|
2702
2712
|
/**
|
|
2703
|
-
* <p>
|
|
2713
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can
|
|
2714
|
+
* have the following reference types at the time of creation: <code>URL</code> |
|
|
2715
|
+
* <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code>. <code>EMAIL</code> |
|
|
2716
|
+
* <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported reference type during
|
|
2717
|
+
* email creation.</p>
|
|
2704
2718
|
* @public
|
|
2705
2719
|
*/
|
|
2706
|
-
|
|
2720
|
+
References?: Record<string, Reference> | undefined;
|
|
2707
2721
|
/**
|
|
2708
|
-
* <p>The
|
|
2709
|
-
* the next request to retrieve the next set of results. </p>
|
|
2722
|
+
* <p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
2710
2723
|
* @public
|
|
2711
2724
|
*/
|
|
2712
|
-
|
|
2725
|
+
Name?: string | undefined;
|
|
2713
2726
|
/**
|
|
2714
|
-
* <p>The
|
|
2727
|
+
* <p>The email message body to be sent to the newly created email.</p>
|
|
2715
2728
|
* @public
|
|
2716
2729
|
*/
|
|
2717
|
-
|
|
2730
|
+
EmailMessage: InboundEmailContent | undefined;
|
|
2718
2731
|
/**
|
|
2719
|
-
* <p>
|
|
2732
|
+
* <p>The additional recipients address of the email.</p>
|
|
2720
2733
|
* @public
|
|
2721
2734
|
*/
|
|
2722
|
-
|
|
2735
|
+
AdditionalRecipients?: InboundAdditionalRecipients | undefined;
|
|
2723
2736
|
/**
|
|
2724
|
-
* <p>
|
|
2737
|
+
* <p>List of S3 presigned URLs of email attachments and their file name. </p>
|
|
2725
2738
|
* @public
|
|
2726
2739
|
*/
|
|
2727
|
-
|
|
2728
|
-
}
|
|
2729
|
-
/**
|
|
2730
|
-
* @public
|
|
2731
|
-
*/
|
|
2732
|
-
export interface SearchHoursOfOperationsRequest {
|
|
2740
|
+
Attachments?: EmailAttachment[] | undefined;
|
|
2733
2741
|
/**
|
|
2734
|
-
* <p>The identifier of the
|
|
2742
|
+
* <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website,
|
|
2743
|
+
* on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
2744
|
+
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
2745
|
+
* part of the ARN, shown here in bold: </p>
|
|
2746
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
2747
|
+
* </p>
|
|
2735
2748
|
* @public
|
|
2736
2749
|
*/
|
|
2737
|
-
|
|
2750
|
+
ContactFlowId?: string | undefined;
|
|
2738
2751
|
/**
|
|
2739
|
-
* <p>The
|
|
2740
|
-
*
|
|
2752
|
+
* <p>The contactId that is related to this contact. Linking emails together by using
|
|
2753
|
+
* <code>RelatedContactID</code> copies over contact attributes from the related email contact to
|
|
2754
|
+
* the new email contact. All updates to user-defined attributes in the new email contact are
|
|
2755
|
+
* limited to the individual contact ID. There are no limits to the number of contacts that can be
|
|
2756
|
+
* linked by using <code>RelatedContactId</code>. </p>
|
|
2741
2757
|
* @public
|
|
2742
2758
|
*/
|
|
2743
|
-
|
|
2759
|
+
RelatedContactId?: string | undefined;
|
|
2744
2760
|
/**
|
|
2745
|
-
* <p>The
|
|
2761
|
+
* <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>
|
|
2762
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
2763
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2746
2764
|
* @public
|
|
2747
2765
|
*/
|
|
2748
|
-
|
|
2766
|
+
Attributes?: Record<string, string> | undefined;
|
|
2749
2767
|
/**
|
|
2750
|
-
* <p>
|
|
2768
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
2769
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
|
|
2770
|
+
* flows.</p>
|
|
2771
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
2772
|
+
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
2773
|
+
* <note>
|
|
2774
|
+
* <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer
|
|
2775
|
+
* number of minutes the contact will be active for before expiring, with
|
|
2776
|
+
* <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{
|
|
2777
|
+
* "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
|
|
2778
|
+
* </note>
|
|
2751
2779
|
* @public
|
|
2752
2780
|
*/
|
|
2753
|
-
|
|
2781
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
2754
2782
|
/**
|
|
2755
|
-
* <p>
|
|
2783
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2784
|
+
* request. If not provided, the Amazon Web Services
|
|
2785
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2786
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2756
2787
|
* @public
|
|
2757
2788
|
*/
|
|
2758
|
-
|
|
2789
|
+
ClientToken?: string | undefined;
|
|
2759
2790
|
}
|
|
2760
2791
|
/**
|
|
2761
2792
|
* @public
|
|
2762
2793
|
*/
|
|
2763
|
-
export interface
|
|
2764
|
-
/**
|
|
2765
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
2766
|
-
* Name (ARN) of the instance.</p>
|
|
2767
|
-
* @public
|
|
2768
|
-
*/
|
|
2769
|
-
InstanceId: string | undefined;
|
|
2770
|
-
/**
|
|
2771
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
2772
|
-
* the next request to retrieve the next set of results.</p>
|
|
2773
|
-
* @public
|
|
2774
|
-
*/
|
|
2775
|
-
NextToken?: string | undefined;
|
|
2794
|
+
export interface StartOutboundChatContactRequest {
|
|
2776
2795
|
/**
|
|
2777
|
-
* <p>
|
|
2796
|
+
* <p>Information about the endpoint.</p>
|
|
2778
2797
|
* @public
|
|
2779
2798
|
*/
|
|
2780
|
-
|
|
2799
|
+
SourceEndpoint: Endpoint | undefined;
|
|
2781
2800
|
/**
|
|
2782
|
-
* <p>
|
|
2801
|
+
* <p>Information about the endpoint.</p>
|
|
2783
2802
|
* @public
|
|
2784
2803
|
*/
|
|
2785
|
-
|
|
2786
|
-
}
|
|
2787
|
-
/**
|
|
2788
|
-
* @public
|
|
2789
|
-
*/
|
|
2790
|
-
export interface SearchPromptsRequest {
|
|
2804
|
+
DestinationEndpoint: Endpoint | undefined;
|
|
2791
2805
|
/**
|
|
2792
|
-
* <p>The identifier of the Amazon Connect instance. You can
|
|
2806
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
2807
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
2793
2808
|
* @public
|
|
2794
2809
|
*/
|
|
2795
2810
|
InstanceId: string | undefined;
|
|
2796
2811
|
/**
|
|
2797
|
-
* <p>
|
|
2798
|
-
*
|
|
2812
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
2813
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
|
|
2814
|
+
* flows.</p>
|
|
2815
|
+
* <ul>
|
|
2816
|
+
* <li>
|
|
2817
|
+
* <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
|
|
2818
|
+
* </li>
|
|
2819
|
+
* <li>
|
|
2820
|
+
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and
|
|
2821
|
+
* <code>connect:SMS</code>.</p>
|
|
2822
|
+
* </li>
|
|
2823
|
+
* </ul>
|
|
2799
2824
|
* @public
|
|
2800
2825
|
*/
|
|
2801
|
-
|
|
2826
|
+
SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
|
|
2802
2827
|
/**
|
|
2803
|
-
* <p>The
|
|
2828
|
+
* <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>
|
|
2804
2829
|
* @public
|
|
2805
2830
|
*/
|
|
2806
|
-
|
|
2831
|
+
Attributes?: Record<string, string> | undefined;
|
|
2807
2832
|
/**
|
|
2808
|
-
* <p>
|
|
2833
|
+
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect
|
|
2834
|
+
* console user interface, on the navigation menu go to <b>Routing, Contact
|
|
2835
|
+
* Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
2836
|
+
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
2837
|
+
* part of the ARN, shown here in bold:</p>
|
|
2838
|
+
* <ul>
|
|
2839
|
+
* <li>
|
|
2840
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
|
|
2841
|
+
* </p>
|
|
2842
|
+
* </li>
|
|
2843
|
+
* </ul>
|
|
2809
2844
|
* @public
|
|
2810
2845
|
*/
|
|
2811
|
-
|
|
2846
|
+
ContactFlowId: string | undefined;
|
|
2812
2847
|
/**
|
|
2813
|
-
* <p>The
|
|
2848
|
+
* <p>The total duration of the newly started chat session. If not specified, the chat session
|
|
2849
|
+
* duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
|
|
2850
|
+
* configurable time is 10,080 minutes (7 days).</p>
|
|
2814
2851
|
* @public
|
|
2815
2852
|
*/
|
|
2816
|
-
|
|
2817
|
-
}
|
|
2818
|
-
/**
|
|
2819
|
-
* @public
|
|
2820
|
-
*/
|
|
2821
|
-
export interface SearchQueuesRequest {
|
|
2853
|
+
ChatDurationInMinutes?: number | undefined;
|
|
2822
2854
|
/**
|
|
2823
|
-
* <p>The
|
|
2855
|
+
* <p>The customer's details.</p>
|
|
2824
2856
|
* @public
|
|
2825
2857
|
*/
|
|
2826
|
-
|
|
2858
|
+
ParticipantDetails?: ParticipantDetails | undefined;
|
|
2827
2859
|
/**
|
|
2828
|
-
* <p>
|
|
2829
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
2860
|
+
* <p>A chat message.</p>
|
|
2830
2861
|
* @public
|
|
2831
2862
|
*/
|
|
2832
|
-
|
|
2863
|
+
InitialSystemMessage?: ChatMessage | undefined;
|
|
2833
2864
|
/**
|
|
2834
|
-
* <p>The
|
|
2865
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
2866
|
+
* contact starting.</p>
|
|
2835
2867
|
* @public
|
|
2836
2868
|
*/
|
|
2837
|
-
|
|
2869
|
+
RelatedContactId?: string | undefined;
|
|
2838
2870
|
/**
|
|
2839
|
-
* <p>
|
|
2871
|
+
* <p>The supported chat message content types. Supported types are:</p>
|
|
2872
|
+
* <ul>
|
|
2873
|
+
* <li>
|
|
2874
|
+
* <p>
|
|
2875
|
+
* <code>text/plain</code>
|
|
2876
|
+
* </p>
|
|
2877
|
+
* </li>
|
|
2878
|
+
* <li>
|
|
2879
|
+
* <p>
|
|
2880
|
+
* <code>text/markdown</code>
|
|
2881
|
+
* </p>
|
|
2882
|
+
* </li>
|
|
2883
|
+
* <li>
|
|
2884
|
+
* <p>
|
|
2885
|
+
* <code>application/json,
|
|
2886
|
+
* application/vnd.amazonaws.connect.message.interactive</code>
|
|
2887
|
+
* </p>
|
|
2888
|
+
* </li>
|
|
2889
|
+
* <li>
|
|
2890
|
+
* <p>
|
|
2891
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>
|
|
2892
|
+
* </p>
|
|
2893
|
+
* </li>
|
|
2894
|
+
* </ul>
|
|
2895
|
+
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
2896
|
+
* supported type in the list. For example, all the following lists are valid because they contain
|
|
2897
|
+
* <code>text/plain</code>:</p>
|
|
2898
|
+
* <ul>
|
|
2899
|
+
* <li>
|
|
2900
|
+
* <p>
|
|
2901
|
+
* <code>[text/plain, text/markdown, application/json]</code>
|
|
2902
|
+
* </p>
|
|
2903
|
+
* </li>
|
|
2904
|
+
* <li>
|
|
2905
|
+
* <p>
|
|
2906
|
+
* <code>[text/markdown, text/plain]</code>
|
|
2907
|
+
* </p>
|
|
2908
|
+
* </li>
|
|
2909
|
+
* <li>
|
|
2910
|
+
* <p>
|
|
2911
|
+
* <code>[text/plain, application/json,
|
|
2912
|
+
* application/vnd.amazonaws.connect.message.interactive.response]</code>
|
|
2913
|
+
* </p>
|
|
2914
|
+
* </li>
|
|
2915
|
+
* </ul>
|
|
2840
2916
|
* @public
|
|
2841
2917
|
*/
|
|
2842
|
-
|
|
2918
|
+
SupportedMessagingContentTypes?: string[] | undefined;
|
|
2843
2919
|
/**
|
|
2844
|
-
* <p>
|
|
2845
|
-
*
|
|
2846
|
-
*
|
|
2847
|
-
*
|
|
2848
|
-
*
|
|
2849
|
-
* </note>
|
|
2920
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2921
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
2922
|
+
* idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making
|
|
2923
|
+
* retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a
|
|
2924
|
+
* contact is already started, the contact ID is returned.</p>
|
|
2850
2925
|
* @public
|
|
2851
2926
|
*/
|
|
2852
|
-
|
|
2927
|
+
ClientToken?: string | undefined;
|
|
2853
2928
|
}
|
|
2854
2929
|
/**
|
|
2855
2930
|
* @public
|
|
2856
2931
|
*/
|
|
2857
|
-
export interface
|
|
2932
|
+
export interface StartTaskContactRequest {
|
|
2858
2933
|
/**
|
|
2859
2934
|
* <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>
|
|
2860
2935
|
* @public
|
|
2861
2936
|
*/
|
|
2862
2937
|
InstanceId: string | undefined;
|
|
2863
2938
|
/**
|
|
2864
|
-
* <p>The
|
|
2865
|
-
*
|
|
2866
|
-
*
|
|
2867
|
-
*/
|
|
2868
|
-
NextToken?: string | undefined;
|
|
2869
|
-
/**
|
|
2870
|
-
* <p>The maximum number of results to return per page.</p>
|
|
2939
|
+
* <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
|
|
2940
|
+
* attributes to task contacts linked using the same <code>PreviousContactID</code> will affect
|
|
2941
|
+
* every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
|
|
2871
2942
|
* @public
|
|
2872
2943
|
*/
|
|
2873
|
-
|
|
2944
|
+
PreviousContactId?: string | undefined;
|
|
2874
2945
|
/**
|
|
2875
|
-
* <p>
|
|
2946
|
+
* <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
|
|
2947
|
+
* on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
2948
|
+
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
2949
|
+
* part of the ARN, shown here in bold: </p>
|
|
2950
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
2951
|
+
* </p>
|
|
2876
2952
|
* @public
|
|
2877
2953
|
*/
|
|
2878
|
-
|
|
2954
|
+
ContactFlowId?: string | undefined;
|
|
2879
2955
|
/**
|
|
2880
|
-
* <p>The
|
|
2956
|
+
* <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>
|
|
2957
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
2958
|
+
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2881
2959
|
* @public
|
|
2882
2960
|
*/
|
|
2883
|
-
|
|
2884
|
-
}
|
|
2885
|
-
/**
|
|
2886
|
-
* @public
|
|
2887
|
-
*/
|
|
2888
|
-
export interface SearchRoutingProfilesRequest {
|
|
2961
|
+
Attributes?: Record<string, string> | undefined;
|
|
2889
2962
|
/**
|
|
2890
|
-
* <p>The
|
|
2963
|
+
* <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
2891
2964
|
* @public
|
|
2892
2965
|
*/
|
|
2893
|
-
|
|
2966
|
+
Name: string | undefined;
|
|
2894
2967
|
/**
|
|
2895
|
-
* <p>
|
|
2896
|
-
*
|
|
2968
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
2969
|
+
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
2970
|
+
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
|
|
2971
|
+
* supported reference type during task creation.</p>
|
|
2897
2972
|
* @public
|
|
2898
2973
|
*/
|
|
2899
|
-
|
|
2974
|
+
References?: Record<string, Reference> | undefined;
|
|
2900
2975
|
/**
|
|
2901
|
-
* <p>
|
|
2976
|
+
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
2977
|
+
* (CCP).</p>
|
|
2902
2978
|
* @public
|
|
2903
2979
|
*/
|
|
2904
|
-
|
|
2980
|
+
Description?: string | undefined;
|
|
2905
2981
|
/**
|
|
2906
|
-
* <p>
|
|
2982
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2983
|
+
* request. If not provided, the Amazon Web Services
|
|
2984
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2985
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2907
2986
|
* @public
|
|
2908
2987
|
*/
|
|
2909
|
-
|
|
2988
|
+
ClientToken?: string | undefined;
|
|
2910
2989
|
/**
|
|
2911
|
-
* <p>The
|
|
2912
|
-
* <note>
|
|
2913
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
2914
|
-
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
2915
|
-
* outside of this range will throw invalid results. </p>
|
|
2916
|
-
* </note>
|
|
2990
|
+
* <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>
|
|
2917
2991
|
* @public
|
|
2918
2992
|
*/
|
|
2919
|
-
|
|
2920
|
-
}
|
|
2921
|
-
/**
|
|
2922
|
-
* @public
|
|
2923
|
-
*/
|
|
2924
|
-
export interface SearchSecurityProfilesRequest {
|
|
2993
|
+
ScheduledTime?: Date | undefined;
|
|
2925
2994
|
/**
|
|
2926
|
-
* <p>
|
|
2995
|
+
* <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
|
|
2996
|
+
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
2927
2997
|
* @public
|
|
2928
2998
|
*/
|
|
2929
|
-
|
|
2999
|
+
TaskTemplateId?: string | undefined;
|
|
2930
3000
|
/**
|
|
2931
|
-
* <p>The
|
|
2932
|
-
*
|
|
3001
|
+
* <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
|
|
3002
|
+
* flow that is defined on agent or queue quick connect. For more information about quick connects,
|
|
3003
|
+
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
|
|
3004
|
+
* connects</a>.</p>
|
|
2933
3005
|
* @public
|
|
2934
3006
|
*/
|
|
2935
|
-
|
|
3007
|
+
QuickConnectId?: string | undefined;
|
|
2936
3008
|
/**
|
|
2937
|
-
* <p>The
|
|
3009
|
+
* <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
|
|
3010
|
+
* tasks together by using <code>RelatedContactID</code> copies over contact attributes from the
|
|
3011
|
+
* related task contact to the new task contact. All updates to user-defined attributes in the new
|
|
3012
|
+
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked
|
|
3013
|
+
* by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
|
|
3014
|
+
* be linked by using <code>RelatedContactId</code>. </p>
|
|
2938
3015
|
* @public
|
|
2939
3016
|
*/
|
|
2940
|
-
|
|
3017
|
+
RelatedContactId?: string | undefined;
|
|
2941
3018
|
/**
|
|
2942
|
-
* <p>
|
|
2943
|
-
*
|
|
2944
|
-
*
|
|
2945
|
-
*
|
|
2946
|
-
*
|
|
2947
|
-
*
|
|
3019
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
3020
|
+
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
3021
|
+
* They can be accessed in flows.</p>
|
|
3022
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
3023
|
+
* <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for
|
|
3024
|
+
* the User who created a task.</p>
|
|
2948
3025
|
* <note>
|
|
2949
|
-
* <p>
|
|
2950
|
-
*
|
|
3026
|
+
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
3027
|
+
* minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
|
|
3028
|
+
* \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
|
|
3029
|
+
* 135\}\}\}\}</code>. </p>
|
|
3030
|
+
* <p>To set the created by user, a valid AgentResourceId must be supplied, with
|
|
3031
|
+
* <code>SegmentAttributes</code> like \{ <code>"connect:CreatedByUser" \{ "ValueString":
|
|
3032
|
+
* "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
|
|
3033
|
+
* </p>
|
|
2951
3034
|
* </note>
|
|
2952
3035
|
* @public
|
|
2953
3036
|
*/
|
|
2954
|
-
|
|
2955
|
-
/**
|
|
2956
|
-
* <p>Filters to be applied to search results.</p>
|
|
2957
|
-
* @public
|
|
2958
|
-
*/
|
|
2959
|
-
SearchFilter?: SecurityProfilesSearchFilter | undefined;
|
|
3037
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
2960
3038
|
}
|
|
2961
3039
|
/**
|
|
2962
3040
|
* @public
|
|
2963
3041
|
*/
|
|
2964
|
-
export interface
|
|
3042
|
+
export interface UpdateContactRequest {
|
|
2965
3043
|
/**
|
|
2966
|
-
* <p>The identifier of the Amazon Connect instance. You can find the
|
|
2967
|
-
* the instance.</p>
|
|
3044
|
+
* <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>
|
|
2968
3045
|
* @public
|
|
2969
3046
|
*/
|
|
2970
3047
|
InstanceId: string | undefined;
|
|
2971
3048
|
/**
|
|
2972
|
-
* <p>The
|
|
2973
|
-
*
|
|
2974
|
-
* @public
|
|
2975
|
-
*/
|
|
2976
|
-
NextToken?: string | undefined;
|
|
2977
|
-
/**
|
|
2978
|
-
* <p>The maximum number of results to return per page.</p>
|
|
2979
|
-
* @public
|
|
2980
|
-
*/
|
|
2981
|
-
MaxResults?: number | undefined;
|
|
2982
|
-
/**
|
|
2983
|
-
* <p>Filters to be applied to search results.</p>
|
|
2984
|
-
* @public
|
|
2985
|
-
*/
|
|
2986
|
-
SearchFilter?: UserHierarchyGroupSearchFilter | undefined;
|
|
2987
|
-
/**
|
|
2988
|
-
* <p>The search criteria to be used to return UserHierarchyGroups.</p>
|
|
3049
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
3050
|
+
* first interaction with your contact center.</p>
|
|
2989
3051
|
* @public
|
|
2990
3052
|
*/
|
|
2991
|
-
|
|
2992
|
-
}
|
|
2993
|
-
/**
|
|
2994
|
-
* @public
|
|
2995
|
-
*/
|
|
2996
|
-
export interface SearchUsersRequest {
|
|
3053
|
+
ContactId: string | undefined;
|
|
2997
3054
|
/**
|
|
2998
|
-
* <p>The
|
|
3055
|
+
* <p>The name of the contact.</p>
|
|
2999
3056
|
* @public
|
|
3000
3057
|
*/
|
|
3001
|
-
|
|
3058
|
+
Name?: string | undefined;
|
|
3002
3059
|
/**
|
|
3003
|
-
* <p>The
|
|
3004
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
3060
|
+
* <p>The description of the contact.</p>
|
|
3005
3061
|
* @public
|
|
3006
3062
|
*/
|
|
3007
|
-
|
|
3063
|
+
Description?: string | undefined;
|
|
3008
3064
|
/**
|
|
3009
|
-
* <p>
|
|
3065
|
+
* <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
|
|
3010
3066
|
* @public
|
|
3011
3067
|
*/
|
|
3012
|
-
|
|
3068
|
+
References?: Record<string, Reference> | undefined;
|
|
3013
3069
|
/**
|
|
3014
|
-
* <p>
|
|
3070
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
3071
|
+
* contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
|
|
3072
|
+
* They can be accessed in flows.</p>
|
|
3073
|
+
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
3074
|
+
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
3075
|
+
* <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined
|
|
3076
|
+
* attributes, can be updated by using the UpdateContact API.</p>
|
|
3015
3077
|
* @public
|
|
3016
3078
|
*/
|
|
3017
|
-
|
|
3079
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
3018
3080
|
/**
|
|
3019
|
-
* <p>
|
|
3020
|
-
*
|
|
3021
|
-
*
|
|
3022
|
-
*
|
|
3023
|
-
*
|
|
3024
|
-
* </note>
|
|
3081
|
+
* <p> Information about the queue associated with a contact. This parameter can only be updated
|
|
3082
|
+
* for external audio contacts. It is used when you integrate third-party systems with Contact Lens for
|
|
3083
|
+
* analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
3084
|
+
* the <i>
|
|
3085
|
+
* Amazon Connect Administrator Guide</i>.</p>
|
|
3025
3086
|
* @public
|
|
3026
3087
|
*/
|
|
3027
|
-
|
|
3028
|
-
}
|
|
3029
|
-
/**
|
|
3030
|
-
* <p>Step signifies the criteria to be used for routing to an agent</p>
|
|
3031
|
-
* @public
|
|
3032
|
-
*/
|
|
3033
|
-
export interface Step {
|
|
3088
|
+
QueueInfo?: QueueInfoInput | undefined;
|
|
3034
3089
|
/**
|
|
3035
|
-
* <p>
|
|
3090
|
+
* <p>Information about the agent associated with a contact. This parameter can only be updated
|
|
3091
|
+
* for external audio contacts. It is used when you integrate third-party systems with Contact Lens for
|
|
3092
|
+
* analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
3093
|
+
* the <i>
|
|
3094
|
+
* Amazon Connect Administrator Guide</i>.</p>
|
|
3036
3095
|
* @public
|
|
3037
3096
|
*/
|
|
3038
|
-
|
|
3097
|
+
UserInfo?: UserInfo | undefined;
|
|
3039
3098
|
/**
|
|
3040
|
-
* <p>
|
|
3099
|
+
* <p>The endpoint of the customer for which the contact was initiated. For external audio
|
|
3100
|
+
* contacts, this is usually the end customer's phone number. This value can only be updated for
|
|
3101
|
+
* external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens
|
|
3102
|
+
* integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
3041
3103
|
* @public
|
|
3042
3104
|
*/
|
|
3043
|
-
|
|
3105
|
+
CustomerEndpoint?: Endpoint | undefined;
|
|
3044
3106
|
/**
|
|
3045
|
-
* <p>
|
|
3107
|
+
* <p>External system endpoint for the contact was initiated. For external audio contacts, this is
|
|
3108
|
+
* the phone number of the external system such as the contact center. This value can only be
|
|
3109
|
+
* updated for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens
|
|
3110
|
+
* integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
3046
3111
|
* @public
|
|
3047
3112
|
*/
|
|
3048
|
-
|
|
3113
|
+
SystemEndpoint?: Endpoint | undefined;
|
|
3049
3114
|
}
|
|
3050
3115
|
/**
|
|
3051
3116
|
* <p>Latest routing criteria on the contact.</p>
|
|
@@ -3386,6 +3451,10 @@ export interface DescribeContactResponse {
|
|
|
3386
3451
|
*/
|
|
3387
3452
|
Contact?: Contact | undefined;
|
|
3388
3453
|
}
|
|
3454
|
+
/**
|
|
3455
|
+
* @internal
|
|
3456
|
+
*/
|
|
3457
|
+
export declare const UpdateParticipantAuthenticationRequestFilterSensitiveLog: (obj: UpdateParticipantAuthenticationRequest) => any;
|
|
3389
3458
|
/**
|
|
3390
3459
|
* @internal
|
|
3391
3460
|
*/
|