@aws-sdk/client-connect 3.696.0 → 3.699.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +88 -0
- package/dist-cjs/index.js +968 -115
- package/dist-es/Connect.js +22 -0
- package/dist-es/commands/CreateContactCommand.js +23 -0
- package/dist-es/commands/CreateEmailAddressCommand.js +23 -0
- package/dist-es/commands/DeleteEmailAddressCommand.js +22 -0
- package/dist-es/commands/DescribeContactCommand.js +1 -1
- package/dist-es/commands/DescribeEmailAddressCommand.js +23 -0
- package/dist-es/commands/ListAssociatedContactsCommand.js +22 -0
- package/dist-es/commands/SearchEmailAddressesCommand.js +23 -0
- package/dist-es/commands/SendOutboundEmailCommand.js +23 -0
- package/dist-es/commands/StartEmailContactCommand.js +23 -0
- package/dist-es/commands/StartOutboundEmailContactCommand.js +23 -0
- package/dist-es/commands/UpdateEmailAddressMetadataCommand.js +23 -0
- package/dist-es/commands/UpdateQueueOutboundEmailConfigCommand.js +22 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +72 -24
- package/dist-es/models/models_1.js +24 -45
- package/dist-es/models/models_2.js +162 -17
- package/dist-es/models/models_3.js +10 -0
- package/dist-es/protocols/Aws_restJson1.js +417 -6
- package/dist-types/Connect.d.ts +77 -0
- package/dist-types/ConnectClient.d.ts +13 -2
- package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/AssociateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/AssociateRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetAttachedFileMetadataCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/BatchPutContactCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactCommand.d.ts +128 -0
- package/dist-types/commands/CreateEmailAddressCommand.d.ts +109 -0
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/CreateQueueCommand.d.ts +3 -0
- package/dist-types/commands/CreateRoutingProfileCommand.d.ts +2 -2
- package/dist-types/commands/CreateRuleCommand.d.ts +5 -2
- package/dist-types/commands/CreateTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEmailAddressCommand.d.ts +91 -0
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAgentStatusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +29 -4
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEmailAddressCommand.d.ts +99 -0
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQueueCommand.d.ts +3 -0
- package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRuleCommand.d.ts +5 -2
- package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/commands/GetAttachedFileCommand.d.ts +1 -1
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +2 -2
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/ListAssociatedContactsCommand.d.ts +102 -0
- package/dist-types/commands/ListContactReferencesCommand.d.ts +7 -2
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +2 -1
- package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +2 -2
- package/dist-types/commands/ListRoutingProfilesCommand.d.ts +1 -1
- package/dist-types/commands/ListRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityKeysCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfileApplicationsCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -2
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +2 -1
- package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +2 -1
- package/dist-types/commands/SearchContactFlowsCommand.d.ts +2 -1
- package/dist-types/commands/SearchContactsCommand.d.ts +20 -4
- package/dist-types/commands/SearchEmailAddressesCommand.d.ts +146 -0
- package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +2 -1
- package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SearchPromptsCommand.d.ts +2 -1
- package/dist-types/commands/SearchQueuesCommand.d.ts +5 -1
- package/dist-types/commands/SearchQuickConnectsCommand.d.ts +2 -1
- package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +3 -2
- package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -1
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -1
- package/dist-types/commands/SearchUsersCommand.d.ts +2 -1
- package/dist-types/commands/SendOutboundEmailCommand.d.ts +130 -0
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -1
- package/dist-types/commands/StartEmailContactCommand.d.ts +150 -0
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -2
- package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +128 -0
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +5 -2
- package/dist-types/commands/StartTaskContactCommand.d.ts +10 -2
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +5 -2
- package/dist-types/commands/UpdateContactCommand.d.ts +10 -2
- package/dist-types/commands/UpdateContactRoutingDataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +97 -0
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +94 -0
- package/dist-types/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +5 -2
- package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +4 -2
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +389 -335
- package/dist-types/models/models_1.d.ts +560 -663
- package/dist-types/models/models_2.d.ts +3752 -3728
- package/dist-types/models/models_3.d.ts +1351 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/Connect.d.ts +187 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateEmailAddressCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteEmailAddressCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAgentStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeContactCommand.d.ts +2 -2
- package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeEmailAddressCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssociatedContactsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoutingProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityKeysCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityProfileApplicationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityProfilePermissionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchContactFlowsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchEmailAddressesCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchHoursOfOperationsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchPredefinedAttributesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchPromptsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchQueuesCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/SendOutboundEmailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartOutboundEmailContactCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateContactRoutingDataCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateEmailAddressMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +143 -95
- package/dist-types/ts3.4/models/models_1.d.ts +160 -230
- package/dist-types/ts3.4/models/models_2.d.ts +451 -290
- package/dist-types/ts3.4/models/models_3.d.ts +325 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +4 -4
|
@@ -0,0 +1,1351 @@
|
|
|
1
|
+
import { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, EvaluationFormScoringStrategy, SegmentAttributeValue, StringCondition } from "./models_0";
|
|
2
|
+
import { AnsweringMachineDetectionStatus, AttributeCondition, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, RoutingCriteriaStepStatus, WisdomInfo } from "./models_1";
|
|
3
|
+
import { AgentStatusSearchCriteria, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, EmailAddressSearchFilter, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchFilter, ListCondition, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
|
|
4
|
+
/**
|
|
5
|
+
* <p>The search criteria to be used to return contact flows.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ContactFlowSearchCriteria {
|
|
9
|
+
/**
|
|
10
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
11
|
+
* condition.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
OrConditions?: ContactFlowSearchCriteria[] | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
17
|
+
* condition.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
AndConditions?: ContactFlowSearchCriteria[] | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
StringCondition?: StringCondition | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>The type of flow.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
TypeCondition?: ContactFlowType | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The state of the flow.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
StateCondition?: ContactFlowState | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The status of the flow.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
StatusCondition?: ContactFlowStatus | undefined;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
export interface CreateEvaluationFormRequest {
|
|
46
|
+
/**
|
|
47
|
+
* <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>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
InstanceId: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>A title of the evaluation form.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
Title: string | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The description of the evaluation form.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
Description?: string | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* <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>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
Items: EvaluationFormItem[] | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
73
|
+
* request. If not provided, the Amazon Web Services
|
|
74
|
+
* SDK populates this field. For more information about idempotency, see
|
|
75
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
ClientToken?: string | undefined;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* <p></p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export interface EmailAddressSearchCriteria {
|
|
85
|
+
/**
|
|
86
|
+
* <p></p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
OrConditions?: EmailAddressSearchCriteria[] | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* <p></p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
AndConditions?: EmailAddressSearchCriteria[] | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
StringCondition?: StringCondition | undefined;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* <p>Information about the evaluation form.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export interface EvaluationForm {
|
|
106
|
+
/**
|
|
107
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
EvaluationFormId: string | undefined;
|
|
111
|
+
/**
|
|
112
|
+
* <p>A version of the evaluation form.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
EvaluationFormVersion: number | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>The flag indicating whether the evaluation form is locked for changes.</p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
Locked: boolean | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
EvaluationFormArn: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* <p>A title of the evaluation form.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
Title: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>The description of the evaluation form.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
Description?: string | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The status of the evaluation form.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
Status: EvaluationFormVersionStatus | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <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>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
Items: EvaluationFormItem[] | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The timestamp for when the evaluation form was created.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
CreatedTime: Date | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
CreatedBy: string | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>The timestamp for when the evaluation form was last updated.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
LastModifiedTime: Date | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
LastModifiedBy: string | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
Tags?: Record<string, string> | undefined;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* <p>Information about an evaluation form used in a contact evaluation.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export interface EvaluationFormContent {
|
|
182
|
+
/**
|
|
183
|
+
* <p>A version of the evaluation form.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
EvaluationFormVersion: number | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
EvaluationFormId: string | undefined;
|
|
192
|
+
/**
|
|
193
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
EvaluationFormArn: string | undefined;
|
|
197
|
+
/**
|
|
198
|
+
* <p>A title of the evaluation form.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
Title: string | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* <p>The description of the evaluation form.</p>
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
Description?: string | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* <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>
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
Items: EvaluationFormItem[] | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
export interface Expression {
|
|
223
|
+
/**
|
|
224
|
+
* <p>An object to specify the predefined attribute condition.</p>
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
AttributeCondition?: AttributeCondition | undefined;
|
|
228
|
+
/**
|
|
229
|
+
* <p>List of routing expressions which will be AND-ed together.</p>
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
AndExpression?: Expression[] | undefined;
|
|
233
|
+
/**
|
|
234
|
+
* <p>List of routing expressions which will be OR-ed together.</p>
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
OrExpression?: Expression[] | undefined;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* <p>The search criteria to be used to return hours of operations.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export interface HoursOfOperationSearchCriteria {
|
|
244
|
+
/**
|
|
245
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
256
|
+
* <note>
|
|
257
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
258
|
+
* <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
|
|
259
|
+
* </note>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
StringCondition?: StringCondition | undefined;
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
export interface PredefinedAttributeSearchCriteria {
|
|
269
|
+
/**
|
|
270
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
271
|
+
* condition.</p>
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
275
|
+
/**
|
|
276
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
277
|
+
* condition.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
StringCondition?: StringCondition | undefined;
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* <p>The search criteria to be used to return prompts.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
export interface PromptSearchCriteria {
|
|
292
|
+
/**
|
|
293
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
OrConditions?: PromptSearchCriteria[] | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
AndConditions?: PromptSearchCriteria[] | undefined;
|
|
302
|
+
/**
|
|
303
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
304
|
+
* <note>
|
|
305
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
306
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
307
|
+
* </note>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
StringCondition?: StringCondition | undefined;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* <p>The search criteria to be used to return queues.</p>
|
|
314
|
+
* <note>
|
|
315
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
316
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
317
|
+
* outside of this range will throw invalid results. </p>
|
|
318
|
+
* </note>
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
export interface QueueSearchCriteria {
|
|
322
|
+
/**
|
|
323
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
OrConditions?: QueueSearchCriteria[] | undefined;
|
|
327
|
+
/**
|
|
328
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
AndConditions?: QueueSearchCriteria[] | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
334
|
+
* <note>
|
|
335
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
336
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
337
|
+
* </note>
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
StringCondition?: StringCondition | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* <p>The type of queue.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
QueueTypeCondition?: SearchableQueueType | undefined;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* <p>The search criteria to be used to return quick connects.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
export interface QuickConnectSearchCriteria {
|
|
352
|
+
/**
|
|
353
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
OrConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
357
|
+
/**
|
|
358
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
AndConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
364
|
+
* <note>
|
|
365
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
366
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
367
|
+
* </note>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
StringCondition?: StringCondition | undefined;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* <p>The search criteria to be used to return routing profiles.</p>
|
|
374
|
+
* <note>
|
|
375
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
376
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
377
|
+
* outside of this range will throw invalid results. </p>
|
|
378
|
+
* </note>
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
export interface RoutingProfileSearchCriteria {
|
|
382
|
+
/**
|
|
383
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
384
|
+
* @public
|
|
385
|
+
*/
|
|
386
|
+
OrConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
387
|
+
/**
|
|
388
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
389
|
+
* @public
|
|
390
|
+
*/
|
|
391
|
+
AndConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
392
|
+
/**
|
|
393
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
394
|
+
* <note>
|
|
395
|
+
* <p>The currently supported values for <code>FieldName</code> are
|
|
396
|
+
* <code>associatedQueueIds</code>, <code>name</code>, <code>description</code>, and
|
|
397
|
+
* <code>resourceID</code>.</p>
|
|
398
|
+
* </note>
|
|
399
|
+
* @public
|
|
400
|
+
*/
|
|
401
|
+
StringCondition?: StringCondition | undefined;
|
|
402
|
+
}
|
|
403
|
+
/**
|
|
404
|
+
* <p>The search criteria to be used to return security profiles.</p>
|
|
405
|
+
* <note>
|
|
406
|
+
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
|
|
407
|
+
* maximum of 25 characters. Any queries with character lengths outside of this range will throw
|
|
408
|
+
* invalid results.</p>
|
|
409
|
+
* </note>
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
export interface SecurityProfileSearchCriteria {
|
|
413
|
+
/**
|
|
414
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
OrConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
AndConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
StringCondition?: StringCondition | undefined;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
export interface UpdateEvaluationFormRequest {
|
|
433
|
+
/**
|
|
434
|
+
* <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>
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
InstanceId: string | undefined;
|
|
438
|
+
/**
|
|
439
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
EvaluationFormId: string | undefined;
|
|
443
|
+
/**
|
|
444
|
+
* <p>A version of the evaluation form to update.</p>
|
|
445
|
+
* @public
|
|
446
|
+
*/
|
|
447
|
+
EvaluationFormVersion: number | undefined;
|
|
448
|
+
/**
|
|
449
|
+
* <p>A flag indicating whether the operation must create a new version.</p>
|
|
450
|
+
* @public
|
|
451
|
+
*/
|
|
452
|
+
CreateNewVersion?: boolean | undefined;
|
|
453
|
+
/**
|
|
454
|
+
* <p>A title of the evaluation form.</p>
|
|
455
|
+
* @public
|
|
456
|
+
*/
|
|
457
|
+
Title: string | undefined;
|
|
458
|
+
/**
|
|
459
|
+
* <p>The description of the evaluation form.</p>
|
|
460
|
+
* @public
|
|
461
|
+
*/
|
|
462
|
+
Description?: string | undefined;
|
|
463
|
+
/**
|
|
464
|
+
* <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>
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
Items: EvaluationFormItem[] | undefined;
|
|
468
|
+
/**
|
|
469
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
|
|
473
|
+
/**
|
|
474
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
475
|
+
* request. If not provided, the Amazon Web Services
|
|
476
|
+
* SDK populates this field. For more information about idempotency, see
|
|
477
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
ClientToken?: string | undefined;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* <p>The search criteria to be used to return userHierarchyGroup.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
export interface UserHierarchyGroupSearchCriteria {
|
|
487
|
+
/**
|
|
488
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
499
|
+
* <note>
|
|
500
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
501
|
+
* <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
502
|
+
* </note>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
StringCondition?: StringCondition | undefined;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* <p>The search criteria to be used to return users.</p>
|
|
509
|
+
* <note>
|
|
510
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
511
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
512
|
+
* outside of this range will throw invalid results. </p>
|
|
513
|
+
* </note>
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
export interface UserSearchCriteria {
|
|
517
|
+
/**
|
|
518
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
519
|
+
* condition.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
OrConditions?: UserSearchCriteria[] | undefined;
|
|
523
|
+
/**
|
|
524
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.
|
|
525
|
+
* </p>
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
AndConditions?: UserSearchCriteria[] | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
531
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>Username</code>,
|
|
532
|
+
* <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>,
|
|
533
|
+
* <code>SecurityProfileId</code>, <code>ResourceId</code>.</p>
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
StringCondition?: StringCondition | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>A leaf node condition which can be used to specify a List condition to search users with
|
|
539
|
+
* attributes included in Lists like Proficiencies.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
ListCondition?: ListCondition | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
export interface DescribeContactEvaluationResponse {
|
|
553
|
+
/**
|
|
554
|
+
* <p>Information about the evaluation form completed for a specific contact.</p>
|
|
555
|
+
* @public
|
|
556
|
+
*/
|
|
557
|
+
Evaluation: Evaluation | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>Information about the evaluation form.</p>
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
EvaluationForm: EvaluationFormContent | undefined;
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
export interface DescribeEvaluationFormResponse {
|
|
568
|
+
/**
|
|
569
|
+
* <p>Information about the evaluation form.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
EvaluationForm: EvaluationForm | undefined;
|
|
573
|
+
}
|
|
574
|
+
/**
|
|
575
|
+
* <p>Step defines the list of agents to be routed or route based on the agent requirements such
|
|
576
|
+
* as ProficiencyLevel, Name, or Value.</p>
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
export interface RoutingCriteriaInputStep {
|
|
580
|
+
/**
|
|
581
|
+
* <p>An object to specify the expiration of a routing step.</p>
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
Expiry?: RoutingCriteriaInputStepExpiry | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
Expression?: Expression | undefined;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
export interface SearchAgentStatusesRequest {
|
|
595
|
+
/**
|
|
596
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
597
|
+
* the instance.</p>
|
|
598
|
+
* @public
|
|
599
|
+
*/
|
|
600
|
+
InstanceId: string | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
603
|
+
* the next request to retrieve the next set of results.</p>
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
NextToken?: string | undefined;
|
|
607
|
+
/**
|
|
608
|
+
* <p>The maximum number of results to return per page.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
MaxResults?: number | undefined;
|
|
612
|
+
/**
|
|
613
|
+
* <p>Filters to be applied to search results.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
SearchFilter?: AgentStatusSearchFilter | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
SearchCriteria?: AgentStatusSearchCriteria | undefined;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
export interface SearchContactFlowModulesRequest {
|
|
627
|
+
/**
|
|
628
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
629
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
InstanceId: string | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
635
|
+
* the next request to retrieve the next set of results.</p>
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
NextToken?: string | undefined;
|
|
639
|
+
/**
|
|
640
|
+
* <p>The maximum number of results to return per page.</p>
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
643
|
+
MaxResults?: number | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* <p>Filters to be applied to search results.</p>
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
SearchFilter?: ContactFlowModuleSearchFilter | undefined;
|
|
649
|
+
/**
|
|
650
|
+
* <p>The search criteria to be used to return contact flow modules.</p>
|
|
651
|
+
* <note>
|
|
652
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
653
|
+
* minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
654
|
+
* outside of this range will result in invalid results.</p>
|
|
655
|
+
* </note>
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
SearchCriteria?: ContactFlowModuleSearchCriteria | undefined;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
export interface SearchContactFlowsRequest {
|
|
664
|
+
/**
|
|
665
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
666
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
InstanceId: string | undefined;
|
|
670
|
+
/**
|
|
671
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
672
|
+
* the next request to retrieve the next set of results.</p>
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
NextToken?: string | undefined;
|
|
676
|
+
/**
|
|
677
|
+
* <p>The maximum number of results to return per page.</p>
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
MaxResults?: number | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* <p>Filters to be applied to search results.</p>
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
SearchFilter?: ContactFlowSearchFilter | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>The search criteria to be used to return flows.</p>
|
|
688
|
+
* <note>
|
|
689
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
690
|
+
* minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
691
|
+
* outside of this range will result in invalid results.</p>
|
|
692
|
+
* </note>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
SearchCriteria?: ContactFlowSearchCriteria | undefined;
|
|
696
|
+
}
|
|
697
|
+
/**
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
export interface SearchEmailAddressesRequest {
|
|
701
|
+
/**
|
|
702
|
+
* <p></p>
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
InstanceId: string | undefined;
|
|
706
|
+
/**
|
|
707
|
+
* <p></p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
MaxResults?: number | undefined;
|
|
711
|
+
/**
|
|
712
|
+
* <p></p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
NextToken?: string | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p></p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
SearchCriteria?: EmailAddressSearchCriteria | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p></p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
SearchFilter?: EmailAddressSearchFilter | undefined;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
export interface SearchHoursOfOperationsRequest {
|
|
731
|
+
/**
|
|
732
|
+
* <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>
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
InstanceId: string | undefined;
|
|
736
|
+
/**
|
|
737
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
738
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
NextToken?: string | undefined;
|
|
742
|
+
/**
|
|
743
|
+
* <p>The maximum number of results to return per page.</p>
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
MaxResults?: number | undefined;
|
|
747
|
+
/**
|
|
748
|
+
* <p>Filters to be applied to search results.</p>
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
SearchFilter?: HoursOfOperationSearchFilter | undefined;
|
|
752
|
+
/**
|
|
753
|
+
* <p>The search criteria to be used to return hours of operations.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
SearchCriteria?: HoursOfOperationSearchCriteria | undefined;
|
|
757
|
+
}
|
|
758
|
+
/**
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
export interface SearchPredefinedAttributesRequest {
|
|
762
|
+
/**
|
|
763
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
764
|
+
* Name (ARN) of the instance.</p>
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
InstanceId: string | undefined;
|
|
768
|
+
/**
|
|
769
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
770
|
+
* the next request to retrieve the next set of results.</p>
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
NextToken?: string | undefined;
|
|
774
|
+
/**
|
|
775
|
+
* <p>The maximum number of results to return per page.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
MaxResults?: number | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
781
|
+
* @public
|
|
782
|
+
*/
|
|
783
|
+
SearchCriteria?: PredefinedAttributeSearchCriteria | undefined;
|
|
784
|
+
}
|
|
785
|
+
/**
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
export interface SearchPromptsRequest {
|
|
789
|
+
/**
|
|
790
|
+
* <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>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
InstanceId: string | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
796
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
NextToken?: string | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p>The maximum number of results to return per page.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
MaxResults?: number | undefined;
|
|
805
|
+
/**
|
|
806
|
+
* <p>Filters to be applied to search results.</p>
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
SearchFilter?: PromptSearchFilter | undefined;
|
|
810
|
+
/**
|
|
811
|
+
* <p>The search criteria to be used to return prompts.</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
SearchCriteria?: PromptSearchCriteria | undefined;
|
|
815
|
+
}
|
|
816
|
+
/**
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
export interface SearchQueuesRequest {
|
|
820
|
+
/**
|
|
821
|
+
* <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>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
InstanceId: string | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
827
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
828
|
+
* @public
|
|
829
|
+
*/
|
|
830
|
+
NextToken?: string | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* <p>The maximum number of results to return per page.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
MaxResults?: number | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* <p>Filters to be applied to search results.</p>
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
SearchFilter?: QueueSearchFilter | undefined;
|
|
841
|
+
/**
|
|
842
|
+
* <p>The search criteria to be used to return queues.</p>
|
|
843
|
+
* <note>
|
|
844
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
845
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
846
|
+
* outside of this range will throw invalid results. </p>
|
|
847
|
+
* </note>
|
|
848
|
+
* @public
|
|
849
|
+
*/
|
|
850
|
+
SearchCriteria?: QueueSearchCriteria | undefined;
|
|
851
|
+
}
|
|
852
|
+
/**
|
|
853
|
+
* @public
|
|
854
|
+
*/
|
|
855
|
+
export interface SearchQuickConnectsRequest {
|
|
856
|
+
/**
|
|
857
|
+
* <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>
|
|
858
|
+
* @public
|
|
859
|
+
*/
|
|
860
|
+
InstanceId: string | undefined;
|
|
861
|
+
/**
|
|
862
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
863
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
864
|
+
* @public
|
|
865
|
+
*/
|
|
866
|
+
NextToken?: string | undefined;
|
|
867
|
+
/**
|
|
868
|
+
* <p>The maximum number of results to return per page.</p>
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
MaxResults?: number | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* <p>Filters to be applied to search results.</p>
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
SearchFilter?: QuickConnectSearchFilter | undefined;
|
|
877
|
+
/**
|
|
878
|
+
* <p>The search criteria to be used to return quick connects.</p>
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
SearchCriteria?: QuickConnectSearchCriteria | undefined;
|
|
882
|
+
}
|
|
883
|
+
/**
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
export interface SearchRoutingProfilesRequest {
|
|
887
|
+
/**
|
|
888
|
+
* <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>
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
InstanceId: string | undefined;
|
|
892
|
+
/**
|
|
893
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
894
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
NextToken?: string | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* <p>The maximum number of results to return per page.</p>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
MaxResults?: number | undefined;
|
|
903
|
+
/**
|
|
904
|
+
* <p>Filters to be applied to search results.</p>
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
SearchFilter?: RoutingProfileSearchFilter | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* <p>The search criteria to be used to return routing profiles.</p>
|
|
910
|
+
* <note>
|
|
911
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
912
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
913
|
+
* outside of this range will throw invalid results. </p>
|
|
914
|
+
* </note>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
SearchCriteria?: RoutingProfileSearchCriteria | undefined;
|
|
918
|
+
}
|
|
919
|
+
/**
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
export interface SearchSecurityProfilesRequest {
|
|
923
|
+
/**
|
|
924
|
+
* <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>
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
InstanceId: string | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
930
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
NextToken?: string | undefined;
|
|
934
|
+
/**
|
|
935
|
+
* <p>The maximum number of results to return per page.</p>
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
MaxResults?: number | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* <p>The search criteria to be used to return security profiles. </p>
|
|
941
|
+
* <note>
|
|
942
|
+
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
|
|
943
|
+
* maximum of 25 characters. Any queries with character lengths outside of this range will throw
|
|
944
|
+
* invalid results.</p>
|
|
945
|
+
* </note>
|
|
946
|
+
* <note>
|
|
947
|
+
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
948
|
+
* </p>
|
|
949
|
+
* </note>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
SearchCriteria?: SecurityProfileSearchCriteria | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>Filters to be applied to search results.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
SearchFilter?: SecurityProfilesSearchFilter | undefined;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* @public
|
|
961
|
+
*/
|
|
962
|
+
export interface SearchUserHierarchyGroupsRequest {
|
|
963
|
+
/**
|
|
964
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
965
|
+
* the instance.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
InstanceId: string | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
971
|
+
* the next request to retrieve the next set of results.</p>
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
NextToken?: string | undefined;
|
|
975
|
+
/**
|
|
976
|
+
* <p>The maximum number of results to return per page.</p>
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
MaxResults?: number | undefined;
|
|
980
|
+
/**
|
|
981
|
+
* <p>Filters to be applied to search results.</p>
|
|
982
|
+
* @public
|
|
983
|
+
*/
|
|
984
|
+
SearchFilter?: UserHierarchyGroupSearchFilter | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>The search criteria to be used to return UserHierarchyGroups.</p>
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
SearchCriteria?: UserHierarchyGroupSearchCriteria | undefined;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* @public
|
|
993
|
+
*/
|
|
994
|
+
export interface SearchUsersRequest {
|
|
995
|
+
/**
|
|
996
|
+
* <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>
|
|
997
|
+
* <note>
|
|
998
|
+
* <p>InstanceID is a required field. The "Required: No" below is incorrect.</p>
|
|
999
|
+
* </note>
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
InstanceId: string | undefined;
|
|
1003
|
+
/**
|
|
1004
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1005
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
NextToken?: string | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
MaxResults?: number | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* <p>Filters to be applied to search results.</p>
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
SearchFilter?: UserSearchFilter | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* <p>The search criteria to be used to return users.</p>
|
|
1021
|
+
* <note>
|
|
1022
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
1023
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
1024
|
+
* outside of this range will throw invalid results. </p>
|
|
1025
|
+
* </note>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
SearchCriteria?: UserSearchCriteria | undefined;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* <p>Step signifies the criteria to be used for routing to an agent</p>
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
export interface Step {
|
|
1035
|
+
/**
|
|
1036
|
+
* <p>An object to specify the expiration of a routing step.</p>
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
Expiry?: Expiry | undefined;
|
|
1040
|
+
/**
|
|
1041
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
1044
|
+
Expression?: Expression | undefined;
|
|
1045
|
+
/**
|
|
1046
|
+
* <p>Represents status of the Routing step.</p>
|
|
1047
|
+
* @public
|
|
1048
|
+
*/
|
|
1049
|
+
Status?: RoutingCriteriaStepStatus | undefined;
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>Latest routing criteria on the contact.</p>
|
|
1053
|
+
* @public
|
|
1054
|
+
*/
|
|
1055
|
+
export interface RoutingCriteria {
|
|
1056
|
+
/**
|
|
1057
|
+
* <p>List of routing steps. When Amazon Connect does not find an available agent meeting the
|
|
1058
|
+
* requirements in a step for a given step duration, the routing criteria will move on to the next
|
|
1059
|
+
* step sequentially until a join is completed with an agent. When all steps are exhausted, the
|
|
1060
|
+
* contact will be offered to any agent in the queue.</p>
|
|
1061
|
+
* @public
|
|
1062
|
+
*/
|
|
1063
|
+
Steps?: Step[] | undefined;
|
|
1064
|
+
/**
|
|
1065
|
+
* <p>The timestamp indicating when the routing criteria is set to active. A routing criteria is
|
|
1066
|
+
* activated when contact is transferred to a queue. ActivationTimestamp will be set on routing
|
|
1067
|
+
* criteria for contacts in agent queue even though Routing criteria is never activated for contacts
|
|
1068
|
+
* in agent queue.</p>
|
|
1069
|
+
* @public
|
|
1070
|
+
*/
|
|
1071
|
+
ActivationTimestamp?: Date | undefined;
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>Information about the index of the routing criteria.</p>
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
Index?: number | undefined;
|
|
1077
|
+
}
|
|
1078
|
+
/**
|
|
1079
|
+
* <p>An object to define the RoutingCriteria.</p>
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
1082
|
+
export interface RoutingCriteriaInput {
|
|
1083
|
+
/**
|
|
1084
|
+
* <p>When Amazon Connect does not find an available agent meeting the requirements in a step
|
|
1085
|
+
* for
|
|
1086
|
+
a given step duration, the routing criteria will move on to the next step sequentially until
|
|
1087
|
+
* a
|
|
1088
|
+
join is completed with an agent. When all steps are exhausted, the contact will be offered to
|
|
1089
|
+
* any agent in the queue.</p>
|
|
1090
|
+
* @public
|
|
1091
|
+
*/
|
|
1092
|
+
Steps?: RoutingCriteriaInputStep[] | undefined;
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* <p>Contains information about a contact.</p>
|
|
1096
|
+
* @public
|
|
1097
|
+
*/
|
|
1098
|
+
export interface Contact {
|
|
1099
|
+
/**
|
|
1100
|
+
* <p>The Amazon Resource Name (ARN) for the contact.</p>
|
|
1101
|
+
* @public
|
|
1102
|
+
*/
|
|
1103
|
+
Arn?: string | undefined;
|
|
1104
|
+
/**
|
|
1105
|
+
* <p>The identifier for the contact.</p>
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
Id?: string | undefined;
|
|
1109
|
+
/**
|
|
1110
|
+
* <p>If this contact is related to other contacts, this is the ID of the initial contact.</p>
|
|
1111
|
+
* @public
|
|
1112
|
+
*/
|
|
1113
|
+
InitialContactId?: string | undefined;
|
|
1114
|
+
/**
|
|
1115
|
+
* <p>If this contact is not the first contact, this is the ID of the previous contact.</p>
|
|
1116
|
+
* @public
|
|
1117
|
+
*/
|
|
1118
|
+
PreviousContactId?: string | undefined;
|
|
1119
|
+
/**
|
|
1120
|
+
* <p></p>
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1123
|
+
ContactAssociationId?: string | undefined;
|
|
1124
|
+
/**
|
|
1125
|
+
* <p>Indicates how the contact was initiated.</p>
|
|
1126
|
+
* @public
|
|
1127
|
+
*/
|
|
1128
|
+
InitiationMethod?: ContactInitiationMethod | undefined;
|
|
1129
|
+
/**
|
|
1130
|
+
* <p>The name of the contact.</p>
|
|
1131
|
+
* @public
|
|
1132
|
+
*/
|
|
1133
|
+
Name?: string | undefined;
|
|
1134
|
+
/**
|
|
1135
|
+
* <p>The description of the contact.</p>
|
|
1136
|
+
* @public
|
|
1137
|
+
*/
|
|
1138
|
+
Description?: string | undefined;
|
|
1139
|
+
/**
|
|
1140
|
+
* <p>How the contact reached your contact center.</p>
|
|
1141
|
+
* @public
|
|
1142
|
+
*/
|
|
1143
|
+
Channel?: Channel | undefined;
|
|
1144
|
+
/**
|
|
1145
|
+
* <p>If this contact was queued, this contains information about the queue. </p>
|
|
1146
|
+
* @public
|
|
1147
|
+
*/
|
|
1148
|
+
QueueInfo?: QueueInfo | undefined;
|
|
1149
|
+
/**
|
|
1150
|
+
* <p>Information about the agent who accepted the contact.</p>
|
|
1151
|
+
* @public
|
|
1152
|
+
*/
|
|
1153
|
+
AgentInfo?: AgentInfo | undefined;
|
|
1154
|
+
/**
|
|
1155
|
+
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
|
|
1156
|
+
* when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
|
|
1157
|
+
* <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
|
|
1158
|
+
* and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For <code>API</code>,
|
|
1159
|
+
* this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent
|
|
1160
|
+
* started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor
|
|
1161
|
+
* started listening to a contact.</p>
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
InitiationTimestamp?: Date | undefined;
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>The timestamp when the customer endpoint disconnected from Amazon Connect.</p>
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
DisconnectTimestamp?: Date | undefined;
|
|
1170
|
+
/**
|
|
1171
|
+
* <p>The timestamp when contact was last updated.</p>
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
LastUpdateTimestamp?: Date | undefined;
|
|
1175
|
+
/**
|
|
1176
|
+
* <p>The timestamp when the contact was last paused.</p>
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
LastPausedTimestamp?: Date | undefined;
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>The timestamp when the contact was last resumed.</p>
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1184
|
+
LastResumedTimestamp?: Date | undefined;
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>Total pause count for a contact.</p>
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
TotalPauseCount?: number | undefined;
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>Total pause duration for a contact in seconds.</p>
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
TotalPauseDurationInSeconds?: number | undefined;
|
|
1195
|
+
/**
|
|
1196
|
+
* <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
|
|
1197
|
+
* </p>
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1200
|
+
ScheduledTimestamp?: Date | undefined;
|
|
1201
|
+
/**
|
|
1202
|
+
* <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid">related</a> to this
|
|
1203
|
+
* contact.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
RelatedContactId?: string | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>Information about Amazon Connect Wisdom.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
WisdomInfo?: WisdomInfo | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* <p></p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
CustomerEndpoint?: EndpointInfo | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p></p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
SystemEndpoint?: EndpointInfo | undefined;
|
|
1222
|
+
/**
|
|
1223
|
+
* <p>An integer that represents the queue time adjust to be applied to the contact, in seconds
|
|
1224
|
+
* (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority
|
|
1225
|
+
* is specified. Must be statically defined and a valid integer value.</p>
|
|
1226
|
+
* @public
|
|
1227
|
+
*/
|
|
1228
|
+
QueueTimeAdjustmentSeconds?: number | undefined;
|
|
1229
|
+
/**
|
|
1230
|
+
* <p>An integer that represents the queue priority to be applied to the contact (lower priorities
|
|
1231
|
+
* are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified.
|
|
1232
|
+
* Must be statically defined, must be larger than zero, and a valid integer value. Default Value is
|
|
1233
|
+
* 5.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
QueuePriority?: number | undefined;
|
|
1237
|
+
/**
|
|
1238
|
+
* <p>Tags associated with the contact. This contains both Amazon Web Services generated and
|
|
1239
|
+
* user-defined tags.</p>
|
|
1240
|
+
* @public
|
|
1241
|
+
*/
|
|
1242
|
+
Tags?: Record<string, string> | undefined;
|
|
1243
|
+
/**
|
|
1244
|
+
* <p>The timestamp when customer endpoint connected to Amazon Connect.</p>
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
ConnectedToSystemTimestamp?: Date | undefined;
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>Latest routing criteria on the contact.</p>
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
RoutingCriteria?: RoutingCriteria | undefined;
|
|
1253
|
+
/**
|
|
1254
|
+
* <p>Information about the Customer on the contact.</p>
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
Customer?: Customer | undefined;
|
|
1258
|
+
/**
|
|
1259
|
+
* <p>Information associated with a campaign.</p>
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
Campaign?: Campaign | undefined;
|
|
1263
|
+
/**
|
|
1264
|
+
* <p>Indicates how an <a href="https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html">outbound campaign</a> call is
|
|
1265
|
+
* actually disposed if the contact is connected to Amazon Connect.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
AnsweringMachineDetectionStatus?: AnsweringMachineDetectionStatus | undefined;
|
|
1269
|
+
/**
|
|
1270
|
+
* <p>Information about customer’s voice activity.</p>
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
CustomerVoiceActivity?: CustomerVoiceActivity | undefined;
|
|
1274
|
+
/**
|
|
1275
|
+
* <p>Information about the quality of the participant's media connection.</p>
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
QualityMetrics?: QualityMetrics | undefined;
|
|
1279
|
+
/**
|
|
1280
|
+
* <p>Information about the call disconnect experience.</p>
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
DisconnectDetails?: DisconnectDetails | undefined;
|
|
1284
|
+
/**
|
|
1285
|
+
* <p></p>
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined;
|
|
1289
|
+
/**
|
|
1290
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
1291
|
+
* attribute map. The attributes are standard Amazon Connect attributes and can be accessed in
|
|
1292
|
+
* flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used
|
|
1293
|
+
* to show channel subtype. For example, <code>connect:Guide</code> or
|
|
1294
|
+
* <code>connect:SMS</code>.</p>
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
1298
|
+
}
|
|
1299
|
+
/**
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
export interface UpdateContactRoutingDataRequest {
|
|
1303
|
+
/**
|
|
1304
|
+
* <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>
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
InstanceId: string | undefined;
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
ContactId: string | undefined;
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
|
|
1315
|
+
* to agents on a first-come, first-serve basis. This means that changing their amount of time in
|
|
1316
|
+
* queue compared to others also changes their position in queue.</p>
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
QueueTimeAdjustmentSeconds?: number | undefined;
|
|
1320
|
+
/**
|
|
1321
|
+
* <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
|
|
1322
|
+
* raise the priority of a contact compared to other contacts in the queue by assigning them a
|
|
1323
|
+
* higher priority, such as 1 or 2.</p>
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
QueuePriority?: number | undefined;
|
|
1327
|
+
/**
|
|
1328
|
+
* <p>Updates the routing criteria on the contact. These properties can be used to change how a
|
|
1329
|
+
* contact is routed within the queue.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
RoutingCriteria?: RoutingCriteriaInput | undefined;
|
|
1333
|
+
}
|
|
1334
|
+
/**
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
export interface DescribeContactResponse {
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>Information about the contact.</p>
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
Contact?: Contact | undefined;
|
|
1343
|
+
}
|
|
1344
|
+
/**
|
|
1345
|
+
* @internal
|
|
1346
|
+
*/
|
|
1347
|
+
export declare const ContactFilterSensitiveLog: (obj: Contact) => any;
|
|
1348
|
+
/**
|
|
1349
|
+
* @internal
|
|
1350
|
+
*/
|
|
1351
|
+
export declare const DescribeContactResponseFilterSensitiveLog: (obj: DescribeContactResponse) => any;
|