@aws-sdk/client-connect 3.925.0 → 3.926.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 +16 -0
- package/dist-cjs/index.js +590 -146
- package/dist-es/Connect.js +4 -0
- package/dist-es/commands/CreateViewCommand.js +2 -1
- package/dist-es/commands/CreateViewVersionCommand.js +1 -1
- package/dist-es/commands/SearchContactEvaluationsCommand.js +22 -0
- package/dist-es/commands/SearchEvaluationFormsCommand.js +22 -0
- package/dist-es/commands/StartOutboundVoiceContactCommand.js +1 -1
- package/dist-es/commands/StartTaskContactCommand.js +1 -1
- package/dist-es/commands/StartWebRTCContactCommand.js +1 -1
- package/dist-es/commands/UpdateContactCommand.js +1 -1
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +29 -56
- package/dist-es/models/models_1.js +92 -20
- package/dist-es/models/models_2.js +50 -76
- package/dist-es/models/models_3.js +85 -0
- package/dist-es/protocols/Aws_restJson1.js +291 -4
- package/dist-types/Connect.d.ts +14 -0
- package/dist-types/ConnectClient.d.ts +4 -2
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +96 -4
- package/dist-types/commands/CreateViewCommand.d.ts +2 -1
- package/dist-types/commands/CreateViewVersionCommand.d.ts +1 -1
- package/dist-types/commands/CreateVocabularyCommand.d.ts +1 -1
- package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAttachedFileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +147 -4
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +93 -4
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +1 -1
- package/dist-types/commands/ListBotsCommand.d.ts +2 -1
- package/dist-types/commands/ListContactEvaluationsCommand.d.ts +10 -1
- package/dist-types/commands/ListContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/commands/ListContactFlowVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListContactFlowsCommand.d.ts +1 -1
- package/dist-types/commands/ListContactReferencesCommand.d.ts +1 -1
- package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListEvaluationFormsCommand.d.ts +1 -1
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +241 -0
- package/dist-types/commands/SearchEvaluationFormsCommand.d.ts +222 -0
- package/dist-types/commands/StartChatContactCommand.d.ts +1 -1
- package/dist-types/commands/StartContactEvaluationCommand.d.ts +6 -0
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/commands/StartScreenSharingCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +1 -2
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +1 -1
- package/dist-types/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +4 -1
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/TagContactCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TransferContactCommand.d.ts +1 -1
- package/dist-types/commands/UntagContactCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts +2 -2
- package/dist-types/commands/UpdateContactAttributesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactCommand.d.ts +1 -2
- package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +3 -0
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +93 -4
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +225 -309
- package/dist-types/models/models_1.d.ts +602 -845
- package/dist-types/models/models_2.d.ts +3819 -3480
- package/dist-types/models/models_3.d.ts +3116 -1848
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Connect.d.ts +34 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateViewVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateVocabularyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAttachedFileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListContactFlowVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListContactFlowsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListContactReferencesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListEvaluationFormsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchContactEvaluationsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchEvaluationFormsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartScreenSharingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/StartWebRTCContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SubmitContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TransferContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +89 -94
- package/dist-types/ts3.4/models/models_1.d.ts +197 -256
- package/dist-types/ts3.4/models/models_2.d.ts +399 -249
- package/dist-types/ts3.4/models/models_3.d.ts +426 -74
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +5 -5
|
@@ -1,6 +1,261 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AgentStatusType, AliasConfiguration, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, LexBot, LexV2Bot, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig,
|
|
3
|
+
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AgentStatusType, AliasConfiguration, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, LexBot, LexV2Bot, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, StorageType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface CreateViewResponse {
|
|
8
|
+
/**
|
|
9
|
+
* <p>A view resource object. Contains metadata and content necessary to render the view.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
View?: View | undefined;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
* @enum
|
|
17
|
+
*/
|
|
18
|
+
export declare const ResourceType: {
|
|
19
|
+
readonly CONTACT: "CONTACT";
|
|
20
|
+
readonly CONTACT_FLOW: "CONTACT_FLOW";
|
|
21
|
+
readonly HIERARCHY_GROUP: "HIERARCHY_GROUP";
|
|
22
|
+
readonly HIERARCHY_LEVEL: "HIERARCHY_LEVEL";
|
|
23
|
+
readonly INSTANCE: "INSTANCE";
|
|
24
|
+
readonly PARTICIPANT: "PARTICIPANT";
|
|
25
|
+
readonly PHONE_NUMBER: "PHONE_NUMBER";
|
|
26
|
+
readonly USER: "USER";
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
32
|
+
/**
|
|
33
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
34
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
35
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
36
|
+
* and then try again.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export declare class ResourceInUseException extends __BaseException {
|
|
40
|
+
readonly name: "ResourceInUseException";
|
|
41
|
+
readonly $fault: "client";
|
|
42
|
+
Message?: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The type of resource.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
ResourceType?: ResourceType | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The identifier for the resource.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
ResourceId?: string | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* <p>Displayed when rate-related API limits are exceeded.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export declare class TooManyRequestsException extends __BaseException {
|
|
63
|
+
readonly name: "TooManyRequestsException";
|
|
64
|
+
readonly $fault: "client";
|
|
65
|
+
Message?: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* @internal
|
|
68
|
+
*/
|
|
69
|
+
constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export interface CreateViewVersionRequest {
|
|
75
|
+
/**
|
|
76
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
77
|
+
* the instance.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
InstanceId: string | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
83
|
+
* used.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
ViewId: string | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* <p>The description for the version being published.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
VersionDescription?: string | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* <p>Indicates the checksum value of the latest published view content.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
ViewContentSha256?: string | undefined;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export interface CreateViewVersionResponse {
|
|
102
|
+
/**
|
|
103
|
+
* <p>All view data is contained within the View object.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
View?: View | undefined;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export interface CreateVocabularyRequest {
|
|
112
|
+
/**
|
|
113
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
114
|
+
* request. If not provided, the Amazon Web Services
|
|
115
|
+
* SDK populates this field. For more information about idempotency, see
|
|
116
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. If a create request is received more than once with same client token,
|
|
117
|
+
* subsequent requests return the previous response without creating a vocabulary again.</p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
ClientToken?: string | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* <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>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
InstanceId: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* <p>A unique name of the custom vocabulary.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
VocabularyName: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
133
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
134
|
+
* </p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
LanguageCode: VocabularyLanguageCode | undefined;
|
|
138
|
+
/**
|
|
139
|
+
* <p>The content of the custom vocabulary in plain-text format with a table of values. Each row
|
|
140
|
+
* in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>,
|
|
141
|
+
* <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
|
|
142
|
+
* characters. The size limit is 50KB. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create a custom
|
|
143
|
+
* vocabulary using a table</a>.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
Content: string | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
Tags?: Record<string, string> | undefined;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* @enum
|
|
156
|
+
*/
|
|
157
|
+
export declare const VocabularyState: {
|
|
158
|
+
readonly ACTIVE: "ACTIVE";
|
|
159
|
+
readonly CREATION_FAILED: "CREATION_FAILED";
|
|
160
|
+
readonly CREATION_IN_PROGRESS: "CREATION_IN_PROGRESS";
|
|
161
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export type VocabularyState = (typeof VocabularyState)[keyof typeof VocabularyState];
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
export interface CreateVocabularyResponse {
|
|
171
|
+
/**
|
|
172
|
+
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
VocabularyArn: string | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
VocabularyId: string | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
State: VocabularyState | undefined;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
export interface DeactivateEvaluationFormRequest {
|
|
191
|
+
/**
|
|
192
|
+
* <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>
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
InstanceId: string | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
EvaluationFormId: string | undefined;
|
|
201
|
+
/**
|
|
202
|
+
* <p>A version of the evaluation form. If the version property is not provided, the latest version of the
|
|
203
|
+
* evaluation form is deactivated.</p>
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
EvaluationFormVersion: number | undefined;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
export interface DeactivateEvaluationFormResponse {
|
|
212
|
+
/**
|
|
213
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
EvaluationFormId: string | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
EvaluationFormArn: string | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* <p>The version of the deactivated evaluation form resource.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
EvaluationFormVersion: number | undefined;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Request to DeleteAttachedFile API
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
export interface DeleteAttachedFileRequest {
|
|
233
|
+
/**
|
|
234
|
+
* <p>The unique identifier of the Connect instance.</p>
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
InstanceId: string | undefined;
|
|
238
|
+
/**
|
|
239
|
+
* <p>The unique identifier of the attached file resource.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
FileId: string | undefined;
|
|
243
|
+
/**
|
|
244
|
+
* <p>The resource to which the attached file is (being) uploaded to. <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Cases</a> are the only
|
|
245
|
+
* current supported resource.</p>
|
|
246
|
+
* <note>
|
|
247
|
+
* <p>This value must be a valid ARN.</p>
|
|
248
|
+
* </note>
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
AssociatedResourceArn: string | undefined;
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* Response from DeleteAttachedFile API
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
export interface DeleteAttachedFileResponse {
|
|
258
|
+
}
|
|
4
259
|
/**
|
|
5
260
|
* @public
|
|
6
261
|
*/
|
|
@@ -533,7 +788,7 @@ export interface DescribeAuthenticationProfileRequest {
|
|
|
533
788
|
}
|
|
534
789
|
/**
|
|
535
790
|
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
536
|
-
* request access to this API, contact Amazon Web
|
|
791
|
+
* request access to this API, contact Amazon Web Services Support.</p>
|
|
537
792
|
* <p>Information about an authentication profile. An authentication profile is a resource that
|
|
538
793
|
* stores the authentication settings for users in your contact center. You use authentication
|
|
539
794
|
* profiles to set up IP address range restrictions and session timeouts. For more information, see
|
|
@@ -1224,69 +1479,278 @@ export interface DescribeContactEvaluationRequest {
|
|
|
1224
1479
|
EvaluationId: string | undefined;
|
|
1225
1480
|
}
|
|
1226
1481
|
/**
|
|
1227
|
-
* <p>Information about answer data for a contact evaluation. Answer data must be either string,
|
|
1228
|
-
* numeric, or not applicable.</p>
|
|
1229
1482
|
* @public
|
|
1483
|
+
* @enum
|
|
1230
1484
|
*/
|
|
1231
|
-
export
|
|
1485
|
+
export declare const QuestionRuleCategoryAutomationCondition: {
|
|
1486
|
+
readonly NOT_PRESENT: "NOT_PRESENT";
|
|
1487
|
+
readonly PRESENT: "PRESENT";
|
|
1488
|
+
};
|
|
1232
1489
|
/**
|
|
1233
1490
|
* @public
|
|
1234
1491
|
*/
|
|
1235
|
-
export
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
StringValue: string;
|
|
1242
|
-
NumericValue?: never;
|
|
1243
|
-
NotApplicable?: never;
|
|
1244
|
-
$unknown?: never;
|
|
1245
|
-
}
|
|
1492
|
+
export type QuestionRuleCategoryAutomationCondition = (typeof QuestionRuleCategoryAutomationCondition)[keyof typeof QuestionRuleCategoryAutomationCondition];
|
|
1493
|
+
/**
|
|
1494
|
+
* <p>The milliseconds offset for transcript reference in suggested answer.</p>
|
|
1495
|
+
* @public
|
|
1496
|
+
*/
|
|
1497
|
+
export interface EvaluationSuggestedAnswerTranscriptMillisecondOffsets {
|
|
1246
1498
|
/**
|
|
1247
|
-
* <p>
|
|
1499
|
+
* <p>Offset in milliseconds from the beginning of the transcript.</p>
|
|
1248
1500
|
* @public
|
|
1249
1501
|
*/
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1502
|
+
BeginOffsetMillis: number | undefined;
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* <p>Information about the point of interest in transcript provided to evaluation.</p>
|
|
1506
|
+
* @public
|
|
1507
|
+
*/
|
|
1508
|
+
export interface EvaluationTranscriptPointOfInterest {
|
|
1256
1509
|
/**
|
|
1257
|
-
* <p>
|
|
1510
|
+
* <p>Offset in milliseconds from the beginning of transcript.</p>
|
|
1258
1511
|
* @public
|
|
1259
1512
|
*/
|
|
1260
|
-
|
|
1261
|
-
StringValue?: never;
|
|
1262
|
-
NumericValue?: never;
|
|
1263
|
-
NotApplicable: boolean;
|
|
1264
|
-
$unknown?: never;
|
|
1265
|
-
}
|
|
1513
|
+
MillisecondOffsets?: EvaluationSuggestedAnswerTranscriptMillisecondOffsets | undefined;
|
|
1266
1514
|
/**
|
|
1515
|
+
* <p>Segment of transcript.</p>
|
|
1267
1516
|
* @public
|
|
1268
1517
|
*/
|
|
1269
|
-
|
|
1270
|
-
StringValue?: never;
|
|
1271
|
-
NumericValue?: never;
|
|
1272
|
-
NotApplicable?: never;
|
|
1273
|
-
$unknown: [string, any];
|
|
1274
|
-
}
|
|
1275
|
-
interface Visitor<T> {
|
|
1276
|
-
StringValue: (value: string) => T;
|
|
1277
|
-
NumericValue: (value: number) => T;
|
|
1278
|
-
NotApplicable: (value: boolean) => T;
|
|
1279
|
-
_: (name: string, value: any) => T;
|
|
1280
|
-
}
|
|
1281
|
-
const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
|
|
1518
|
+
TranscriptSegment?: string | undefined;
|
|
1282
1519
|
}
|
|
1283
1520
|
/**
|
|
1284
|
-
* <p>
|
|
1521
|
+
* <p>The Contact Lens category used by evaluation automation.</p>
|
|
1285
1522
|
* @public
|
|
1286
1523
|
*/
|
|
1287
|
-
export interface
|
|
1524
|
+
export interface EvaluationAutomationRuleCategory {
|
|
1288
1525
|
/**
|
|
1289
|
-
* <p>
|
|
1526
|
+
* <p>A category label.</p>
|
|
1527
|
+
* @public
|
|
1528
|
+
*/
|
|
1529
|
+
Category: string | undefined;
|
|
1530
|
+
/**
|
|
1531
|
+
* <p>An automation condition for a Contact Lens category.</p>
|
|
1532
|
+
* @public
|
|
1533
|
+
*/
|
|
1534
|
+
Condition: QuestionRuleCategoryAutomationCondition | undefined;
|
|
1535
|
+
/**
|
|
1536
|
+
* <p>A point of interest in a contact transcript that indicates match of condition.</p>
|
|
1537
|
+
* @public
|
|
1538
|
+
*/
|
|
1539
|
+
PointsOfInterest?: EvaluationTranscriptPointOfInterest[] | undefined;
|
|
1540
|
+
}
|
|
1541
|
+
/**
|
|
1542
|
+
* <p>Analysis details providing explanation for Contact Lens automation decision.</p>
|
|
1543
|
+
* @public
|
|
1544
|
+
*/
|
|
1545
|
+
export interface EvaluationContactLensAnswerAnalysisDetails {
|
|
1546
|
+
/**
|
|
1547
|
+
* <p>A list of match rule categories.</p>
|
|
1548
|
+
* @public
|
|
1549
|
+
*/
|
|
1550
|
+
MatchedRuleCategories?: EvaluationAutomationRuleCategory[] | undefined;
|
|
1551
|
+
}
|
|
1552
|
+
/**
|
|
1553
|
+
* <p>An analysis for a generative AI answer to the question.</p>
|
|
1554
|
+
* @public
|
|
1555
|
+
*/
|
|
1556
|
+
export interface EvaluationGenAIAnswerAnalysisDetails {
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>Generative AI automation answer justification.</p>
|
|
1559
|
+
* @public
|
|
1560
|
+
*/
|
|
1561
|
+
Justification?: string | undefined;
|
|
1562
|
+
/**
|
|
1563
|
+
* <p>Generative AI automation answer analysis points of interest.</p>
|
|
1564
|
+
* @public
|
|
1565
|
+
*/
|
|
1566
|
+
PointsOfInterest?: EvaluationTranscriptPointOfInterest[] | undefined;
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* <p>Detailed analysis results of the automated answer to the evaluation question.</p>
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
export type EvaluationQuestionAnswerAnalysisDetails = EvaluationQuestionAnswerAnalysisDetails.ContactLensMember | EvaluationQuestionAnswerAnalysisDetails.GenAIMember | EvaluationQuestionAnswerAnalysisDetails.$UnknownMember;
|
|
1573
|
+
/**
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1576
|
+
export declare namespace EvaluationQuestionAnswerAnalysisDetails {
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>Analysis results from the generative AI automation for the question.</p>
|
|
1579
|
+
* @public
|
|
1580
|
+
*/
|
|
1581
|
+
interface GenAIMember {
|
|
1582
|
+
GenAI: EvaluationGenAIAnswerAnalysisDetails;
|
|
1583
|
+
ContactLens?: never;
|
|
1584
|
+
$unknown?: never;
|
|
1585
|
+
}
|
|
1586
|
+
/**
|
|
1587
|
+
* <p>Analysis results from the Contact Lens automation for the question.</p>
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
interface ContactLensMember {
|
|
1591
|
+
GenAI?: never;
|
|
1592
|
+
ContactLens: EvaluationContactLensAnswerAnalysisDetails;
|
|
1593
|
+
$unknown?: never;
|
|
1594
|
+
}
|
|
1595
|
+
/**
|
|
1596
|
+
* @public
|
|
1597
|
+
*/
|
|
1598
|
+
interface $UnknownMember {
|
|
1599
|
+
GenAI?: never;
|
|
1600
|
+
ContactLens?: never;
|
|
1601
|
+
$unknown: [string, any];
|
|
1602
|
+
}
|
|
1603
|
+
interface Visitor<T> {
|
|
1604
|
+
GenAI: (value: EvaluationGenAIAnswerAnalysisDetails) => T;
|
|
1605
|
+
ContactLens: (value: EvaluationContactLensAnswerAnalysisDetails) => T;
|
|
1606
|
+
_: (name: string, value: any) => T;
|
|
1607
|
+
}
|
|
1608
|
+
const visit: <T>(value: EvaluationQuestionAnswerAnalysisDetails, visitor: Visitor<T>) => T;
|
|
1609
|
+
}
|
|
1610
|
+
/**
|
|
1611
|
+
* @public
|
|
1612
|
+
* @enum
|
|
1613
|
+
*/
|
|
1614
|
+
export declare const EvaluationQuestionAnswerAnalysisType: {
|
|
1615
|
+
readonly CONTACT_LENS_DATA: "CONTACT_LENS_DATA";
|
|
1616
|
+
readonly GEN_AI: "GEN_AI";
|
|
1617
|
+
};
|
|
1618
|
+
/**
|
|
1619
|
+
* @public
|
|
1620
|
+
*/
|
|
1621
|
+
export type EvaluationQuestionAnswerAnalysisType = (typeof EvaluationQuestionAnswerAnalysisType)[keyof typeof EvaluationQuestionAnswerAnalysisType];
|
|
1622
|
+
/**
|
|
1623
|
+
* @public
|
|
1624
|
+
* @enum
|
|
1625
|
+
*/
|
|
1626
|
+
export declare const EvaluationTranscriptType: {
|
|
1627
|
+
readonly RAW: "RAW";
|
|
1628
|
+
readonly REDACTED: "REDACTED";
|
|
1629
|
+
};
|
|
1630
|
+
/**
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
export type EvaluationTranscriptType = (typeof EvaluationTranscriptType)[keyof typeof EvaluationTranscriptType];
|
|
1634
|
+
/**
|
|
1635
|
+
* <p>Details of the input data used for automated question processing.</p>
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
export interface EvaluationQuestionInputDetails {
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>Transcript type.</p>
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
TranscriptType?: EvaluationTranscriptType | undefined;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* @public
|
|
1647
|
+
* @enum
|
|
1648
|
+
*/
|
|
1649
|
+
export declare const EvaluationSuggestedAnswerStatus: {
|
|
1650
|
+
readonly FAILED: "FAILED";
|
|
1651
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1652
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1653
|
+
};
|
|
1654
|
+
/**
|
|
1655
|
+
* @public
|
|
1656
|
+
*/
|
|
1657
|
+
export type EvaluationSuggestedAnswerStatus = (typeof EvaluationSuggestedAnswerStatus)[keyof typeof EvaluationSuggestedAnswerStatus];
|
|
1658
|
+
/**
|
|
1659
|
+
* <p>Information about answer data for a contact evaluation. Answer data must be either string,
|
|
1660
|
+
* numeric, or not applicable.</p>
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.$UnknownMember;
|
|
1664
|
+
/**
|
|
1665
|
+
* @public
|
|
1666
|
+
*/
|
|
1667
|
+
export declare namespace EvaluationAnswerData {
|
|
1668
|
+
/**
|
|
1669
|
+
* <p>The string value for an answer in a contact evaluation.</p>
|
|
1670
|
+
* @public
|
|
1671
|
+
*/
|
|
1672
|
+
interface StringValueMember {
|
|
1673
|
+
StringValue: string;
|
|
1674
|
+
NumericValue?: never;
|
|
1675
|
+
NotApplicable?: never;
|
|
1676
|
+
$unknown?: never;
|
|
1677
|
+
}
|
|
1678
|
+
/**
|
|
1679
|
+
* <p>The numeric value for an answer in a contact evaluation.</p>
|
|
1680
|
+
* @public
|
|
1681
|
+
*/
|
|
1682
|
+
interface NumericValueMember {
|
|
1683
|
+
StringValue?: never;
|
|
1684
|
+
NumericValue: number;
|
|
1685
|
+
NotApplicable?: never;
|
|
1686
|
+
$unknown?: never;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* <p>The flag to mark the question as not applicable.</p>
|
|
1690
|
+
* @public
|
|
1691
|
+
*/
|
|
1692
|
+
interface NotApplicableMember {
|
|
1693
|
+
StringValue?: never;
|
|
1694
|
+
NumericValue?: never;
|
|
1695
|
+
NotApplicable: boolean;
|
|
1696
|
+
$unknown?: never;
|
|
1697
|
+
}
|
|
1698
|
+
/**
|
|
1699
|
+
* @public
|
|
1700
|
+
*/
|
|
1701
|
+
interface $UnknownMember {
|
|
1702
|
+
StringValue?: never;
|
|
1703
|
+
NumericValue?: never;
|
|
1704
|
+
NotApplicable?: never;
|
|
1705
|
+
$unknown: [string, any];
|
|
1706
|
+
}
|
|
1707
|
+
interface Visitor<T> {
|
|
1708
|
+
StringValue: (value: string) => T;
|
|
1709
|
+
NumericValue: (value: number) => T;
|
|
1710
|
+
NotApplicable: (value: boolean) => T;
|
|
1711
|
+
_: (name: string, value: any) => T;
|
|
1712
|
+
}
|
|
1713
|
+
const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
|
|
1714
|
+
}
|
|
1715
|
+
/**
|
|
1716
|
+
* <p>The information about the suggested answer for the question.</p>
|
|
1717
|
+
* @public
|
|
1718
|
+
*/
|
|
1719
|
+
export interface EvaluationSuggestedAnswer {
|
|
1720
|
+
/**
|
|
1721
|
+
* <p>Information about answer data for a contact evaluation. Answer data must be either string,
|
|
1722
|
+
* numeric, or not applicable.</p>
|
|
1723
|
+
* @public
|
|
1724
|
+
*/
|
|
1725
|
+
Value?: EvaluationAnswerData | undefined;
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The status of the suggested answer. D</p>
|
|
1728
|
+
* @public
|
|
1729
|
+
*/
|
|
1730
|
+
Status: EvaluationSuggestedAnswerStatus | undefined;
|
|
1731
|
+
/**
|
|
1732
|
+
* <p>Details about the input used to question automation.</p>
|
|
1733
|
+
* @public
|
|
1734
|
+
*/
|
|
1735
|
+
Input?: EvaluationQuestionInputDetails | undefined;
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>Type of analysis used to provide suggested answer.</p>
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
AnalysisType: EvaluationQuestionAnswerAnalysisType | undefined;
|
|
1741
|
+
/**
|
|
1742
|
+
* <p>Detailed analysis results.</p>
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1745
|
+
AnalysisDetails?: EvaluationQuestionAnswerAnalysisDetails | undefined;
|
|
1746
|
+
}
|
|
1747
|
+
/**
|
|
1748
|
+
* <p>Information about output answers for a contact evaluation.</p>
|
|
1749
|
+
* @public
|
|
1750
|
+
*/
|
|
1751
|
+
export interface EvaluationAnswerOutput {
|
|
1752
|
+
/**
|
|
1753
|
+
* <p>The value for an answer in a contact evaluation.</p>
|
|
1290
1754
|
* @public
|
|
1291
1755
|
*/
|
|
1292
1756
|
Value?: EvaluationAnswerData | undefined;
|
|
@@ -1295,6 +1759,73 @@ export interface EvaluationAnswerOutput {
|
|
|
1295
1759
|
* @public
|
|
1296
1760
|
*/
|
|
1297
1761
|
SystemSuggestedValue?: EvaluationAnswerData | undefined;
|
|
1762
|
+
/**
|
|
1763
|
+
* <p>Automation suggested answers for the questions.</p>
|
|
1764
|
+
* @public
|
|
1765
|
+
*/
|
|
1766
|
+
SuggestedAnswers?: EvaluationSuggestedAnswer[] | undefined;
|
|
1767
|
+
}
|
|
1768
|
+
/**
|
|
1769
|
+
* @public
|
|
1770
|
+
* @enum
|
|
1771
|
+
*/
|
|
1772
|
+
export declare const EvaluationType: {
|
|
1773
|
+
readonly CALIBRATION: "CALIBRATION";
|
|
1774
|
+
readonly STANDARD: "STANDARD";
|
|
1775
|
+
};
|
|
1776
|
+
/**
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1779
|
+
export type EvaluationType = (typeof EvaluationType)[keyof typeof EvaluationType];
|
|
1780
|
+
/**
|
|
1781
|
+
* <p>Information about the evaluation acknowledgement.</p>
|
|
1782
|
+
* @public
|
|
1783
|
+
*/
|
|
1784
|
+
export interface EvaluationAcknowledgement {
|
|
1785
|
+
/**
|
|
1786
|
+
* <p>When the agent acknowledged the evaluation.</p>
|
|
1787
|
+
* @public
|
|
1788
|
+
*/
|
|
1789
|
+
AcknowledgedTime: Date | undefined;
|
|
1790
|
+
/**
|
|
1791
|
+
* <p>The agent who acknowledged the evaluation.</p>
|
|
1792
|
+
* @public
|
|
1793
|
+
*/
|
|
1794
|
+
AcknowledgedBy: string | undefined;
|
|
1795
|
+
/**
|
|
1796
|
+
* <p>A comment from the agent when they confirmed they acknowledged the evaluation.</p>
|
|
1797
|
+
* @public
|
|
1798
|
+
*/
|
|
1799
|
+
AcknowledgerComment?: string | undefined;
|
|
1800
|
+
}
|
|
1801
|
+
/**
|
|
1802
|
+
* @public
|
|
1803
|
+
* @enum
|
|
1804
|
+
*/
|
|
1805
|
+
export declare const AutoEvaluationStatus: {
|
|
1806
|
+
readonly FAILED: "FAILED";
|
|
1807
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1808
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1809
|
+
};
|
|
1810
|
+
/**
|
|
1811
|
+
* @public
|
|
1812
|
+
*/
|
|
1813
|
+
export type AutoEvaluationStatus = (typeof AutoEvaluationStatus)[keyof typeof AutoEvaluationStatus];
|
|
1814
|
+
/**
|
|
1815
|
+
* <p>Details about automated evaluations.</p>
|
|
1816
|
+
* @public
|
|
1817
|
+
*/
|
|
1818
|
+
export interface AutoEvaluationDetails {
|
|
1819
|
+
/**
|
|
1820
|
+
* <p>Whether automated evaluation is enabled.</p>
|
|
1821
|
+
* @public
|
|
1822
|
+
*/
|
|
1823
|
+
AutoEvaluationEnabled: boolean | undefined;
|
|
1824
|
+
/**
|
|
1825
|
+
* <p>The status of the contact auto-evaluation. </p>
|
|
1826
|
+
* @public
|
|
1827
|
+
*/
|
|
1828
|
+
AutoEvaluationStatus?: AutoEvaluationStatus | undefined;
|
|
1298
1829
|
}
|
|
1299
1830
|
/**
|
|
1300
1831
|
* <p>Information about scores of a contact evaluation item (section or question).</p>
|
|
@@ -1338,11 +1869,26 @@ export interface EvaluationMetadata {
|
|
|
1338
1869
|
* @public
|
|
1339
1870
|
*/
|
|
1340
1871
|
ContactAgentId?: string | undefined;
|
|
1872
|
+
/**
|
|
1873
|
+
* <p>The calibration session ID that this evaluation belongs to.</p>
|
|
1874
|
+
* @public
|
|
1875
|
+
*/
|
|
1876
|
+
CalibrationSessionId?: string | undefined;
|
|
1341
1877
|
/**
|
|
1342
1878
|
* <p>The overall score of the contact evaluation.</p>
|
|
1343
1879
|
* @public
|
|
1344
1880
|
*/
|
|
1345
1881
|
Score?: EvaluationScore | undefined;
|
|
1882
|
+
/**
|
|
1883
|
+
* <p>Information related to automated evaluation.</p>
|
|
1884
|
+
* @public
|
|
1885
|
+
*/
|
|
1886
|
+
AutoEvaluation?: AutoEvaluationDetails | undefined;
|
|
1887
|
+
/**
|
|
1888
|
+
* <p>Information related to evaluation acknowledgement.</p>
|
|
1889
|
+
* @public
|
|
1890
|
+
*/
|
|
1891
|
+
Acknowledgement?: EvaluationAcknowledgement | undefined;
|
|
1346
1892
|
}
|
|
1347
1893
|
/**
|
|
1348
1894
|
* <p>Information about notes for a contact evaluation.</p>
|
|
@@ -1423,6 +1969,11 @@ export interface Evaluation {
|
|
|
1423
1969
|
* @public
|
|
1424
1970
|
*/
|
|
1425
1971
|
LastModifiedTime: Date | undefined;
|
|
1972
|
+
/**
|
|
1973
|
+
* <p>Type of the evaluation. </p>
|
|
1974
|
+
* @public
|
|
1975
|
+
*/
|
|
1976
|
+
EvaluationType?: EvaluationType | undefined;
|
|
1426
1977
|
/**
|
|
1427
1978
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1428
1979
|
* @public
|
|
@@ -8234,7 +8785,7 @@ export interface ListAuthenticationProfilesRequest {
|
|
|
8234
8785
|
}
|
|
8235
8786
|
/**
|
|
8236
8787
|
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
8237
|
-
* request access to this API, contact Amazon Web
|
|
8788
|
+
* request access to this API, contact Amazon Web Services Support.</p>
|
|
8238
8789
|
* <p>A summary of a given authentication profile.</p>
|
|
8239
8790
|
* @public
|
|
8240
8791
|
*/
|
|
@@ -8343,807 +8894,13 @@ export interface LexBotConfig {
|
|
|
8343
8894
|
LexV2Bot?: LexV2Bot | undefined;
|
|
8344
8895
|
}
|
|
8345
8896
|
/**
|
|
8346
|
-
* @
|
|
8897
|
+
* @internal
|
|
8347
8898
|
*/
|
|
8348
|
-
export
|
|
8349
|
-
/**
|
|
8350
|
-
* <p>The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots
|
|
8351
|
-
* associated with the specified instance.</p>
|
|
8352
|
-
* @public
|
|
8353
|
-
*/
|
|
8354
|
-
LexBots?: LexBotConfig[] | undefined;
|
|
8355
|
-
/**
|
|
8356
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8357
|
-
* @public
|
|
8358
|
-
*/
|
|
8359
|
-
NextToken?: string | undefined;
|
|
8360
|
-
}
|
|
8899
|
+
export declare const CreateViewResponseFilterSensitiveLog: (obj: CreateViewResponse) => any;
|
|
8361
8900
|
/**
|
|
8362
|
-
* @
|
|
8901
|
+
* @internal
|
|
8363
8902
|
*/
|
|
8364
|
-
export
|
|
8365
|
-
/**
|
|
8366
|
-
* <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>
|
|
8367
|
-
* @public
|
|
8368
|
-
*/
|
|
8369
|
-
InstanceId: string | undefined;
|
|
8370
|
-
/**
|
|
8371
|
-
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
8372
|
-
* @public
|
|
8373
|
-
*/
|
|
8374
|
-
ContactId: string | undefined;
|
|
8375
|
-
/**
|
|
8376
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8377
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8378
|
-
* <important>
|
|
8379
|
-
* <p>This is not expected to be set because the value returned in the previous response is
|
|
8380
|
-
* always null.</p>
|
|
8381
|
-
* </important>
|
|
8382
|
-
* @public
|
|
8383
|
-
*/
|
|
8384
|
-
NextToken?: string | undefined;
|
|
8385
|
-
}
|
|
8386
|
-
/**
|
|
8387
|
-
* <p>Summary information about a contact evaluation.</p>
|
|
8388
|
-
* @public
|
|
8389
|
-
*/
|
|
8390
|
-
export interface EvaluationSummary {
|
|
8391
|
-
/**
|
|
8392
|
-
* <p>A unique identifier for the contact evaluation.</p>
|
|
8393
|
-
* @public
|
|
8394
|
-
*/
|
|
8395
|
-
EvaluationId: string | undefined;
|
|
8396
|
-
/**
|
|
8397
|
-
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
8398
|
-
* @public
|
|
8399
|
-
*/
|
|
8400
|
-
EvaluationArn: string | undefined;
|
|
8401
|
-
/**
|
|
8402
|
-
* <p>A title of the evaluation form.</p>
|
|
8403
|
-
* @public
|
|
8404
|
-
*/
|
|
8405
|
-
EvaluationFormTitle: string | undefined;
|
|
8406
|
-
/**
|
|
8407
|
-
* <p>The unique identifier for the evaluation form.</p>
|
|
8408
|
-
* @public
|
|
8409
|
-
*/
|
|
8410
|
-
EvaluationFormId: string | undefined;
|
|
8411
|
-
/**
|
|
8412
|
-
* <p>The status of the contact evaluation.</p>
|
|
8413
|
-
* @public
|
|
8414
|
-
*/
|
|
8415
|
-
Status: EvaluationStatus | undefined;
|
|
8416
|
-
/**
|
|
8417
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
|
|
8418
|
-
* @public
|
|
8419
|
-
*/
|
|
8420
|
-
EvaluatorArn: string | undefined;
|
|
8421
|
-
/**
|
|
8422
|
-
* <p>The overall score of the contact evaluation.</p>
|
|
8423
|
-
* @public
|
|
8424
|
-
*/
|
|
8425
|
-
Score?: EvaluationScore | undefined;
|
|
8426
|
-
/**
|
|
8427
|
-
* <p>The timestamp for when the evaluation was created.</p>
|
|
8428
|
-
* @public
|
|
8429
|
-
*/
|
|
8430
|
-
CreatedTime: Date | undefined;
|
|
8431
|
-
/**
|
|
8432
|
-
* <p>The timestamp for when the evaluation was last updated.</p>
|
|
8433
|
-
* @public
|
|
8434
|
-
*/
|
|
8435
|
-
LastModifiedTime: Date | undefined;
|
|
8436
|
-
}
|
|
8437
|
-
/**
|
|
8438
|
-
* @public
|
|
8439
|
-
*/
|
|
8440
|
-
export interface ListContactEvaluationsResponse {
|
|
8441
|
-
/**
|
|
8442
|
-
* <p>Provides details about a list of contact evaluations belonging to an instance.</p>
|
|
8443
|
-
* @public
|
|
8444
|
-
*/
|
|
8445
|
-
EvaluationSummaryList: EvaluationSummary[] | undefined;
|
|
8446
|
-
/**
|
|
8447
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8448
|
-
* <important>
|
|
8449
|
-
* <p>This is always returned as null in the response.</p>
|
|
8450
|
-
* </important>
|
|
8451
|
-
* @public
|
|
8452
|
-
*/
|
|
8453
|
-
NextToken?: string | undefined;
|
|
8454
|
-
}
|
|
8455
|
-
/**
|
|
8456
|
-
* @public
|
|
8457
|
-
*/
|
|
8458
|
-
export interface ListContactFlowModulesRequest {
|
|
8459
|
-
/**
|
|
8460
|
-
* <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>
|
|
8461
|
-
* @public
|
|
8462
|
-
*/
|
|
8463
|
-
InstanceId: string | undefined;
|
|
8464
|
-
/**
|
|
8465
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8466
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8467
|
-
* @public
|
|
8468
|
-
*/
|
|
8469
|
-
NextToken?: string | undefined;
|
|
8470
|
-
/**
|
|
8471
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8472
|
-
* @public
|
|
8473
|
-
*/
|
|
8474
|
-
MaxResults?: number | undefined;
|
|
8475
|
-
/**
|
|
8476
|
-
* <p>The state of the flow module.</p>
|
|
8477
|
-
* @public
|
|
8478
|
-
*/
|
|
8479
|
-
ContactFlowModuleState?: ContactFlowModuleState | undefined;
|
|
8480
|
-
}
|
|
8481
|
-
/**
|
|
8482
|
-
* <p>Contains summary information about a flow.</p>
|
|
8483
|
-
* @public
|
|
8484
|
-
*/
|
|
8485
|
-
export interface ContactFlowModuleSummary {
|
|
8486
|
-
/**
|
|
8487
|
-
* <p>The identifier of the flow module.</p>
|
|
8488
|
-
* @public
|
|
8489
|
-
*/
|
|
8490
|
-
Id?: string | undefined;
|
|
8491
|
-
/**
|
|
8492
|
-
* <p>The Amazon Resource Name (ARN) of the flow module.</p>
|
|
8493
|
-
* @public
|
|
8494
|
-
*/
|
|
8495
|
-
Arn?: string | undefined;
|
|
8496
|
-
/**
|
|
8497
|
-
* <p>The name of the flow module.</p>
|
|
8498
|
-
* @public
|
|
8499
|
-
*/
|
|
8500
|
-
Name?: string | undefined;
|
|
8501
|
-
/**
|
|
8502
|
-
* <p>The type of flow module.</p>
|
|
8503
|
-
* @public
|
|
8504
|
-
*/
|
|
8505
|
-
State?: ContactFlowModuleState | undefined;
|
|
8506
|
-
}
|
|
8507
|
-
/**
|
|
8508
|
-
* @public
|
|
8509
|
-
*/
|
|
8510
|
-
export interface ListContactFlowModulesResponse {
|
|
8511
|
-
/**
|
|
8512
|
-
* <p>Information about the flow module.</p>
|
|
8513
|
-
* @public
|
|
8514
|
-
*/
|
|
8515
|
-
ContactFlowModulesSummaryList?: ContactFlowModuleSummary[] | undefined;
|
|
8516
|
-
/**
|
|
8517
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8518
|
-
* @public
|
|
8519
|
-
*/
|
|
8520
|
-
NextToken?: string | undefined;
|
|
8521
|
-
}
|
|
8522
|
-
/**
|
|
8523
|
-
* @public
|
|
8524
|
-
*/
|
|
8525
|
-
export interface ListContactFlowsRequest {
|
|
8526
|
-
/**
|
|
8527
|
-
* <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>
|
|
8528
|
-
* @public
|
|
8529
|
-
*/
|
|
8530
|
-
InstanceId: string | undefined;
|
|
8531
|
-
/**
|
|
8532
|
-
* <p>The type of flow.</p>
|
|
8533
|
-
* @public
|
|
8534
|
-
*/
|
|
8535
|
-
ContactFlowTypes?: ContactFlowType[] | undefined;
|
|
8536
|
-
/**
|
|
8537
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8538
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8539
|
-
* @public
|
|
8540
|
-
*/
|
|
8541
|
-
NextToken?: string | undefined;
|
|
8542
|
-
/**
|
|
8543
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8544
|
-
* @public
|
|
8545
|
-
*/
|
|
8546
|
-
MaxResults?: number | undefined;
|
|
8547
|
-
}
|
|
8548
|
-
/**
|
|
8549
|
-
* <p>Contains summary information about a flow.</p>
|
|
8550
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
8551
|
-
* Flow language</a>.</p>
|
|
8552
|
-
* @public
|
|
8553
|
-
*/
|
|
8554
|
-
export interface ContactFlowSummary {
|
|
8555
|
-
/**
|
|
8556
|
-
* <p>The identifier of the flow.</p>
|
|
8557
|
-
* @public
|
|
8558
|
-
*/
|
|
8559
|
-
Id?: string | undefined;
|
|
8560
|
-
/**
|
|
8561
|
-
* <p>The Amazon Resource Name (ARN) of the flow.</p>
|
|
8562
|
-
* @public
|
|
8563
|
-
*/
|
|
8564
|
-
Arn?: string | undefined;
|
|
8565
|
-
/**
|
|
8566
|
-
* <p>The name of the flow.</p>
|
|
8567
|
-
* @public
|
|
8568
|
-
*/
|
|
8569
|
-
Name?: string | undefined;
|
|
8570
|
-
/**
|
|
8571
|
-
* <p>The type of flow.</p>
|
|
8572
|
-
* @public
|
|
8573
|
-
*/
|
|
8574
|
-
ContactFlowType?: ContactFlowType | undefined;
|
|
8575
|
-
/**
|
|
8576
|
-
* <p>The type of flow.</p>
|
|
8577
|
-
* @public
|
|
8578
|
-
*/
|
|
8579
|
-
ContactFlowState?: ContactFlowState | undefined;
|
|
8580
|
-
/**
|
|
8581
|
-
* <p>The status of the flow.</p>
|
|
8582
|
-
* @public
|
|
8583
|
-
*/
|
|
8584
|
-
ContactFlowStatus?: ContactFlowStatus | undefined;
|
|
8585
|
-
}
|
|
8586
|
-
/**
|
|
8587
|
-
* @public
|
|
8588
|
-
*/
|
|
8589
|
-
export interface ListContactFlowsResponse {
|
|
8590
|
-
/**
|
|
8591
|
-
* <p>Information about the flows.</p>
|
|
8592
|
-
* @public
|
|
8593
|
-
*/
|
|
8594
|
-
ContactFlowSummaryList?: ContactFlowSummary[] | undefined;
|
|
8595
|
-
/**
|
|
8596
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8597
|
-
* @public
|
|
8598
|
-
*/
|
|
8599
|
-
NextToken?: string | undefined;
|
|
8600
|
-
}
|
|
8601
|
-
/**
|
|
8602
|
-
* @public
|
|
8603
|
-
*/
|
|
8604
|
-
export interface ListContactFlowVersionsRequest {
|
|
8605
|
-
/**
|
|
8606
|
-
* <p>The identifier of the Amazon Connect instance.</p>
|
|
8607
|
-
* @public
|
|
8608
|
-
*/
|
|
8609
|
-
InstanceId: string | undefined;
|
|
8610
|
-
/**
|
|
8611
|
-
* <p>The identifier of the flow.</p>
|
|
8612
|
-
* @public
|
|
8613
|
-
*/
|
|
8614
|
-
ContactFlowId: string | undefined;
|
|
8615
|
-
/**
|
|
8616
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8617
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8618
|
-
* @public
|
|
8619
|
-
*/
|
|
8620
|
-
NextToken?: string | undefined;
|
|
8621
|
-
/**
|
|
8622
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8623
|
-
* @public
|
|
8624
|
-
*/
|
|
8625
|
-
MaxResults?: number | undefined;
|
|
8626
|
-
}
|
|
8627
|
-
/**
|
|
8628
|
-
* <p>A summary of a flow version's metadata.</p>
|
|
8629
|
-
* @public
|
|
8630
|
-
*/
|
|
8631
|
-
export interface ContactFlowVersionSummary {
|
|
8632
|
-
/**
|
|
8633
|
-
* <p>The Amazon Resource Name (ARN) of the view version.</p>
|
|
8634
|
-
* @public
|
|
8635
|
-
*/
|
|
8636
|
-
Arn?: string | undefined;
|
|
8637
|
-
/**
|
|
8638
|
-
* <p>The description of the flow version.</p>
|
|
8639
|
-
* @public
|
|
8640
|
-
*/
|
|
8641
|
-
VersionDescription?: string | undefined;
|
|
8642
|
-
/**
|
|
8643
|
-
* <p>The identifier of the flow version.</p>
|
|
8644
|
-
* @public
|
|
8645
|
-
*/
|
|
8646
|
-
Version?: number | undefined;
|
|
8647
|
-
}
|
|
8648
|
-
/**
|
|
8649
|
-
* @public
|
|
8650
|
-
*/
|
|
8651
|
-
export interface ListContactFlowVersionsResponse {
|
|
8652
|
-
/**
|
|
8653
|
-
* <p>A list of flow version summaries.</p>
|
|
8654
|
-
* @public
|
|
8655
|
-
*/
|
|
8656
|
-
ContactFlowVersionSummaryList?: ContactFlowVersionSummary[] | undefined;
|
|
8657
|
-
/**
|
|
8658
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8659
|
-
* @public
|
|
8660
|
-
*/
|
|
8661
|
-
NextToken?: string | undefined;
|
|
8662
|
-
}
|
|
8663
|
-
/**
|
|
8664
|
-
* @public
|
|
8665
|
-
*/
|
|
8666
|
-
export interface ListContactReferencesRequest {
|
|
8667
|
-
/**
|
|
8668
|
-
* <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>
|
|
8669
|
-
* @public
|
|
8670
|
-
*/
|
|
8671
|
-
InstanceId: string | undefined;
|
|
8672
|
-
/**
|
|
8673
|
-
* <p>The identifier of the initial contact.</p>
|
|
8674
|
-
* @public
|
|
8675
|
-
*/
|
|
8676
|
-
ContactId: string | undefined;
|
|
8677
|
-
/**
|
|
8678
|
-
* <p>The type of reference.</p>
|
|
8679
|
-
* @public
|
|
8680
|
-
*/
|
|
8681
|
-
ReferenceTypes: ReferenceType[] | undefined;
|
|
8682
|
-
/**
|
|
8683
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8684
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8685
|
-
* <important>
|
|
8686
|
-
* <p>This is not expected to be set, because the value returned in the previous response is
|
|
8687
|
-
* always null.</p>
|
|
8688
|
-
* </important>
|
|
8689
|
-
* @public
|
|
8690
|
-
*/
|
|
8691
|
-
NextToken?: string | undefined;
|
|
8692
|
-
}
|
|
8693
|
-
/**
|
|
8694
|
-
* <p>Information about a reference when the <code>referenceType</code> is
|
|
8695
|
-
* <code>ATTACHMENT</code>. Otherwise, null.</p>
|
|
8696
|
-
* @public
|
|
8697
|
-
*/
|
|
8698
|
-
export interface AttachmentReference {
|
|
8699
|
-
/**
|
|
8700
|
-
* <p>Identifier of the attachment reference.</p>
|
|
8701
|
-
* @public
|
|
8702
|
-
*/
|
|
8703
|
-
Name?: string | undefined;
|
|
8704
|
-
/**
|
|
8705
|
-
* <p>The location path of the attachment reference.</p>
|
|
8706
|
-
* @public
|
|
8707
|
-
*/
|
|
8708
|
-
Value?: string | undefined;
|
|
8709
|
-
/**
|
|
8710
|
-
* <p>Status of the attachment reference type.</p>
|
|
8711
|
-
* @public
|
|
8712
|
-
*/
|
|
8713
|
-
Status?: ReferenceStatus | undefined;
|
|
8714
|
-
/**
|
|
8715
|
-
* <p>The Amazon Resource Name (ARN) of the attachment reference.</p>
|
|
8716
|
-
* @public
|
|
8717
|
-
*/
|
|
8718
|
-
Arn?: string | undefined;
|
|
8719
|
-
}
|
|
8720
|
-
/**
|
|
8721
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>.
|
|
8722
|
-
* Otherwise, null.</p>
|
|
8723
|
-
* @public
|
|
8724
|
-
*/
|
|
8725
|
-
export interface DateReference {
|
|
8726
|
-
/**
|
|
8727
|
-
* <p>Identifier of the date reference.</p>
|
|
8728
|
-
* @public
|
|
8729
|
-
*/
|
|
8730
|
-
Name?: string | undefined;
|
|
8731
|
-
/**
|
|
8732
|
-
* <p>A valid date.</p>
|
|
8733
|
-
* @public
|
|
8734
|
-
*/
|
|
8735
|
-
Value?: string | undefined;
|
|
8736
|
-
}
|
|
8737
|
-
/**
|
|
8738
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
|
|
8739
|
-
* Otherwise, null.</p>
|
|
8740
|
-
* @public
|
|
8741
|
-
*/
|
|
8742
|
-
export interface EmailReference {
|
|
8743
|
-
/**
|
|
8744
|
-
* <p>Identifier of the email reference.</p>
|
|
8745
|
-
* @public
|
|
8746
|
-
*/
|
|
8747
|
-
Name?: string | undefined;
|
|
8748
|
-
/**
|
|
8749
|
-
* <p>A valid email address.</p>
|
|
8750
|
-
* @public
|
|
8751
|
-
*/
|
|
8752
|
-
Value?: string | undefined;
|
|
8753
|
-
}
|
|
8754
|
-
/**
|
|
8755
|
-
* <p>Information about the reference when the referenceType is <code>EMAIL_MESSAGE</code>.
|
|
8756
|
-
* Otherwise, null.</p>
|
|
8757
|
-
* @public
|
|
8758
|
-
*/
|
|
8759
|
-
export interface EmailMessageReference {
|
|
8760
|
-
/**
|
|
8761
|
-
* <p>The name of the email message reference</p>
|
|
8762
|
-
* @public
|
|
8763
|
-
*/
|
|
8764
|
-
Name?: string | undefined;
|
|
8765
|
-
/**
|
|
8766
|
-
* <p>The Amazon Resource Name (ARN) of the email message reference</p>
|
|
8767
|
-
* @public
|
|
8768
|
-
*/
|
|
8769
|
-
Arn?: string | undefined;
|
|
8770
|
-
}
|
|
8771
|
-
/**
|
|
8772
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
|
|
8773
|
-
* Otherwise, null.</p>
|
|
8774
|
-
* @public
|
|
8775
|
-
*/
|
|
8776
|
-
export interface NumberReference {
|
|
8777
|
-
/**
|
|
8778
|
-
* <p>Identifier of the number reference.</p>
|
|
8779
|
-
* @public
|
|
8780
|
-
*/
|
|
8781
|
-
Name?: string | undefined;
|
|
8782
|
-
/**
|
|
8783
|
-
* <p>A valid number.</p>
|
|
8784
|
-
* @public
|
|
8785
|
-
*/
|
|
8786
|
-
Value?: string | undefined;
|
|
8787
|
-
}
|
|
8788
|
-
/**
|
|
8789
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
|
|
8790
|
-
* Otherwise, null.</p>
|
|
8791
|
-
* @public
|
|
8792
|
-
*/
|
|
8793
|
-
export interface StringReference {
|
|
8794
|
-
/**
|
|
8795
|
-
* <p>Identifier of the string reference.</p>
|
|
8796
|
-
* @public
|
|
8797
|
-
*/
|
|
8798
|
-
Name?: string | undefined;
|
|
8799
|
-
/**
|
|
8800
|
-
* <p>A valid string.</p>
|
|
8801
|
-
* @public
|
|
8802
|
-
*/
|
|
8803
|
-
Value?: string | undefined;
|
|
8804
|
-
}
|
|
8805
|
-
/**
|
|
8806
|
-
* <p>The URL reference.</p>
|
|
8807
|
-
* @public
|
|
8808
|
-
*/
|
|
8809
|
-
export interface UrlReference {
|
|
8810
|
-
/**
|
|
8811
|
-
* <p>Identifier of the URL reference.</p>
|
|
8812
|
-
* @public
|
|
8813
|
-
*/
|
|
8814
|
-
Name?: string | undefined;
|
|
8815
|
-
/**
|
|
8816
|
-
* <p>A valid URL.</p>
|
|
8817
|
-
* @public
|
|
8818
|
-
*/
|
|
8819
|
-
Value?: string | undefined;
|
|
8820
|
-
}
|
|
8821
|
-
/**
|
|
8822
|
-
* <p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only
|
|
8823
|
-
* one non null field between the URL and attachment based on the reference type.</p>
|
|
8824
|
-
* @public
|
|
8825
|
-
*/
|
|
8826
|
-
export type ReferenceSummary = ReferenceSummary.AttachmentMember | ReferenceSummary.DateMember | ReferenceSummary.EmailMember | ReferenceSummary.EmailMessageMember | ReferenceSummary.NumberMember | ReferenceSummary.StringMember | ReferenceSummary.UrlMember | ReferenceSummary.$UnknownMember;
|
|
8827
|
-
/**
|
|
8828
|
-
* @public
|
|
8829
|
-
*/
|
|
8830
|
-
export declare namespace ReferenceSummary {
|
|
8831
|
-
/**
|
|
8832
|
-
* <p>Information about the reference when the <code>referenceType</code> is <code>URL</code>.
|
|
8833
|
-
* Otherwise, null.</p>
|
|
8834
|
-
* @public
|
|
8835
|
-
*/
|
|
8836
|
-
interface UrlMember {
|
|
8837
|
-
Url: UrlReference;
|
|
8838
|
-
Attachment?: never;
|
|
8839
|
-
EmailMessage?: never;
|
|
8840
|
-
String?: never;
|
|
8841
|
-
Number?: never;
|
|
8842
|
-
Date?: never;
|
|
8843
|
-
Email?: never;
|
|
8844
|
-
$unknown?: never;
|
|
8845
|
-
}
|
|
8846
|
-
/**
|
|
8847
|
-
* <p>Information about the reference when the <code>referenceType</code> is
|
|
8848
|
-
* <code>ATTACHMENT</code>. Otherwise, null.</p>
|
|
8849
|
-
* @public
|
|
8850
|
-
*/
|
|
8851
|
-
interface AttachmentMember {
|
|
8852
|
-
Url?: never;
|
|
8853
|
-
Attachment: AttachmentReference;
|
|
8854
|
-
EmailMessage?: never;
|
|
8855
|
-
String?: never;
|
|
8856
|
-
Number?: never;
|
|
8857
|
-
Date?: never;
|
|
8858
|
-
Email?: never;
|
|
8859
|
-
$unknown?: never;
|
|
8860
|
-
}
|
|
8861
|
-
/**
|
|
8862
|
-
* <p>Information about the reference when the referenceType is <code>EMAIL_MESSAGE</code>.
|
|
8863
|
-
* Otherwise, null.</p>
|
|
8864
|
-
* @public
|
|
8865
|
-
*/
|
|
8866
|
-
interface EmailMessageMember {
|
|
8867
|
-
Url?: never;
|
|
8868
|
-
Attachment?: never;
|
|
8869
|
-
EmailMessage: EmailMessageReference;
|
|
8870
|
-
String?: never;
|
|
8871
|
-
Number?: never;
|
|
8872
|
-
Date?: never;
|
|
8873
|
-
Email?: never;
|
|
8874
|
-
$unknown?: never;
|
|
8875
|
-
}
|
|
8876
|
-
/**
|
|
8877
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
|
|
8878
|
-
* Otherwise, null.</p>
|
|
8879
|
-
* @public
|
|
8880
|
-
*/
|
|
8881
|
-
interface StringMember {
|
|
8882
|
-
Url?: never;
|
|
8883
|
-
Attachment?: never;
|
|
8884
|
-
EmailMessage?: never;
|
|
8885
|
-
String: StringReference;
|
|
8886
|
-
Number?: never;
|
|
8887
|
-
Date?: never;
|
|
8888
|
-
Email?: never;
|
|
8889
|
-
$unknown?: never;
|
|
8890
|
-
}
|
|
8891
|
-
/**
|
|
8892
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
|
|
8893
|
-
* Otherwise, null.</p>
|
|
8894
|
-
* @public
|
|
8895
|
-
*/
|
|
8896
|
-
interface NumberMember {
|
|
8897
|
-
Url?: never;
|
|
8898
|
-
Attachment?: never;
|
|
8899
|
-
EmailMessage?: never;
|
|
8900
|
-
String?: never;
|
|
8901
|
-
Number: NumberReference;
|
|
8902
|
-
Date?: never;
|
|
8903
|
-
Email?: never;
|
|
8904
|
-
$unknown?: never;
|
|
8905
|
-
}
|
|
8906
|
-
/**
|
|
8907
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>.
|
|
8908
|
-
* Otherwise, null.</p>
|
|
8909
|
-
* @public
|
|
8910
|
-
*/
|
|
8911
|
-
interface DateMember {
|
|
8912
|
-
Url?: never;
|
|
8913
|
-
Attachment?: never;
|
|
8914
|
-
EmailMessage?: never;
|
|
8915
|
-
String?: never;
|
|
8916
|
-
Number?: never;
|
|
8917
|
-
Date: DateReference;
|
|
8918
|
-
Email?: never;
|
|
8919
|
-
$unknown?: never;
|
|
8920
|
-
}
|
|
8921
|
-
/**
|
|
8922
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
|
|
8923
|
-
* Otherwise, null.</p>
|
|
8924
|
-
* @public
|
|
8925
|
-
*/
|
|
8926
|
-
interface EmailMember {
|
|
8927
|
-
Url?: never;
|
|
8928
|
-
Attachment?: never;
|
|
8929
|
-
EmailMessage?: never;
|
|
8930
|
-
String?: never;
|
|
8931
|
-
Number?: never;
|
|
8932
|
-
Date?: never;
|
|
8933
|
-
Email: EmailReference;
|
|
8934
|
-
$unknown?: never;
|
|
8935
|
-
}
|
|
8936
|
-
/**
|
|
8937
|
-
* @public
|
|
8938
|
-
*/
|
|
8939
|
-
interface $UnknownMember {
|
|
8940
|
-
Url?: never;
|
|
8941
|
-
Attachment?: never;
|
|
8942
|
-
EmailMessage?: never;
|
|
8943
|
-
String?: never;
|
|
8944
|
-
Number?: never;
|
|
8945
|
-
Date?: never;
|
|
8946
|
-
Email?: never;
|
|
8947
|
-
$unknown: [string, any];
|
|
8948
|
-
}
|
|
8949
|
-
interface Visitor<T> {
|
|
8950
|
-
Url: (value: UrlReference) => T;
|
|
8951
|
-
Attachment: (value: AttachmentReference) => T;
|
|
8952
|
-
EmailMessage: (value: EmailMessageReference) => T;
|
|
8953
|
-
String: (value: StringReference) => T;
|
|
8954
|
-
Number: (value: NumberReference) => T;
|
|
8955
|
-
Date: (value: DateReference) => T;
|
|
8956
|
-
Email: (value: EmailReference) => T;
|
|
8957
|
-
_: (name: string, value: any) => T;
|
|
8958
|
-
}
|
|
8959
|
-
const visit: <T>(value: ReferenceSummary, visitor: Visitor<T>) => T;
|
|
8960
|
-
}
|
|
8961
|
-
/**
|
|
8962
|
-
* @public
|
|
8963
|
-
*/
|
|
8964
|
-
export interface ListContactReferencesResponse {
|
|
8965
|
-
/**
|
|
8966
|
-
* <p>Information about the flows.</p>
|
|
8967
|
-
* @public
|
|
8968
|
-
*/
|
|
8969
|
-
ReferenceSummaryList?: ReferenceSummary[] | undefined;
|
|
8970
|
-
/**
|
|
8971
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8972
|
-
* <important>
|
|
8973
|
-
* <p>This is always returned as null in the response.</p>
|
|
8974
|
-
* </important>
|
|
8975
|
-
* @public
|
|
8976
|
-
*/
|
|
8977
|
-
NextToken?: string | undefined;
|
|
8978
|
-
}
|
|
8979
|
-
/**
|
|
8980
|
-
* @public
|
|
8981
|
-
*/
|
|
8982
|
-
export interface ListDefaultVocabulariesRequest {
|
|
8983
|
-
/**
|
|
8984
|
-
* <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>
|
|
8985
|
-
* @public
|
|
8986
|
-
*/
|
|
8987
|
-
InstanceId: string | undefined;
|
|
8988
|
-
/**
|
|
8989
|
-
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
8990
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
8991
|
-
* </p>
|
|
8992
|
-
* @public
|
|
8993
|
-
*/
|
|
8994
|
-
LanguageCode?: VocabularyLanguageCode | undefined;
|
|
8995
|
-
/**
|
|
8996
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8997
|
-
* @public
|
|
8998
|
-
*/
|
|
8999
|
-
MaxResults?: number | undefined;
|
|
9000
|
-
/**
|
|
9001
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
9002
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
9003
|
-
* @public
|
|
9004
|
-
*/
|
|
9005
|
-
NextToken?: string | undefined;
|
|
9006
|
-
}
|
|
9007
|
-
/**
|
|
9008
|
-
* <p>Contains information about a default vocabulary.</p>
|
|
9009
|
-
* @public
|
|
9010
|
-
*/
|
|
9011
|
-
export interface DefaultVocabulary {
|
|
9012
|
-
/**
|
|
9013
|
-
* <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>
|
|
9014
|
-
* @public
|
|
9015
|
-
*/
|
|
9016
|
-
InstanceId: string | undefined;
|
|
9017
|
-
/**
|
|
9018
|
-
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
9019
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
9020
|
-
* </p>
|
|
9021
|
-
* @public
|
|
9022
|
-
*/
|
|
9023
|
-
LanguageCode: VocabularyLanguageCode | undefined;
|
|
9024
|
-
/**
|
|
9025
|
-
* <p>The identifier of the custom vocabulary.</p>
|
|
9026
|
-
* @public
|
|
9027
|
-
*/
|
|
9028
|
-
VocabularyId: string | undefined;
|
|
9029
|
-
/**
|
|
9030
|
-
* <p>A unique name of the custom vocabulary.</p>
|
|
9031
|
-
* @public
|
|
9032
|
-
*/
|
|
9033
|
-
VocabularyName: string | undefined;
|
|
9034
|
-
}
|
|
9035
|
-
/**
|
|
9036
|
-
* @public
|
|
9037
|
-
*/
|
|
9038
|
-
export interface ListDefaultVocabulariesResponse {
|
|
9039
|
-
/**
|
|
9040
|
-
* <p>A list of default vocabularies.</p>
|
|
9041
|
-
* @public
|
|
9042
|
-
*/
|
|
9043
|
-
DefaultVocabularyList: DefaultVocabulary[] | undefined;
|
|
9044
|
-
/**
|
|
9045
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
9046
|
-
* @public
|
|
9047
|
-
*/
|
|
9048
|
-
NextToken?: string | undefined;
|
|
9049
|
-
}
|
|
9050
|
-
/**
|
|
9051
|
-
* @public
|
|
9052
|
-
*/
|
|
9053
|
-
export interface ListEvaluationFormsRequest {
|
|
9054
|
-
/**
|
|
9055
|
-
* <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>
|
|
9056
|
-
* @public
|
|
9057
|
-
*/
|
|
9058
|
-
InstanceId: string | undefined;
|
|
9059
|
-
/**
|
|
9060
|
-
* <p>The maximum number of results to return per page.</p>
|
|
9061
|
-
* @public
|
|
9062
|
-
*/
|
|
9063
|
-
MaxResults?: number | undefined;
|
|
9064
|
-
/**
|
|
9065
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
9066
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
9067
|
-
* @public
|
|
9068
|
-
*/
|
|
9069
|
-
NextToken?: string | undefined;
|
|
9070
|
-
}
|
|
9071
|
-
/**
|
|
9072
|
-
* <p>Summary information about an evaluation form.</p>
|
|
9073
|
-
* @public
|
|
9074
|
-
*/
|
|
9075
|
-
export interface EvaluationFormSummary {
|
|
9076
|
-
/**
|
|
9077
|
-
* <p>The unique identifier for the evaluation form.</p>
|
|
9078
|
-
* @public
|
|
9079
|
-
*/
|
|
9080
|
-
EvaluationFormId: string | undefined;
|
|
9081
|
-
/**
|
|
9082
|
-
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
9083
|
-
* @public
|
|
9084
|
-
*/
|
|
9085
|
-
EvaluationFormArn: string | undefined;
|
|
9086
|
-
/**
|
|
9087
|
-
* <p>A title of the evaluation form.</p>
|
|
9088
|
-
* @public
|
|
9089
|
-
*/
|
|
9090
|
-
Title: string | undefined;
|
|
9091
|
-
/**
|
|
9092
|
-
* <p>The timestamp for when the evaluation form was created.</p>
|
|
9093
|
-
* @public
|
|
9094
|
-
*/
|
|
9095
|
-
CreatedTime: Date | undefined;
|
|
9096
|
-
/**
|
|
9097
|
-
* <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
|
|
9098
|
-
* @public
|
|
9099
|
-
*/
|
|
9100
|
-
CreatedBy: string | undefined;
|
|
9101
|
-
/**
|
|
9102
|
-
* <p>The timestamp for when the evaluation form was last updated.</p>
|
|
9103
|
-
* @public
|
|
9104
|
-
*/
|
|
9105
|
-
LastModifiedTime: Date | undefined;
|
|
9106
|
-
/**
|
|
9107
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
|
|
9108
|
-
* @public
|
|
9109
|
-
*/
|
|
9110
|
-
LastModifiedBy: string | undefined;
|
|
9111
|
-
/**
|
|
9112
|
-
* <p>The timestamp for when the evaluation form was last activated.</p>
|
|
9113
|
-
* @public
|
|
9114
|
-
*/
|
|
9115
|
-
LastActivatedTime?: Date | undefined;
|
|
9116
|
-
/**
|
|
9117
|
-
* <p> The Amazon Resource Name (ARN) of the user who last activated the evaluation form.</p>
|
|
9118
|
-
* @public
|
|
9119
|
-
*/
|
|
9120
|
-
LastActivatedBy?: string | undefined;
|
|
9121
|
-
/**
|
|
9122
|
-
* <p>The version number of the latest evaluation form version.</p>
|
|
9123
|
-
* @public
|
|
9124
|
-
*/
|
|
9125
|
-
LatestVersion: number | undefined;
|
|
9126
|
-
/**
|
|
9127
|
-
* <p>The version of the active evaluation form version.</p>
|
|
9128
|
-
* @public
|
|
9129
|
-
*/
|
|
9130
|
-
ActiveVersion?: number | undefined;
|
|
9131
|
-
}
|
|
9132
|
-
/**
|
|
9133
|
-
* @public
|
|
9134
|
-
*/
|
|
9135
|
-
export interface ListEvaluationFormsResponse {
|
|
9136
|
-
/**
|
|
9137
|
-
* <p>Provides details about a list of evaluation forms belonging to an instance.</p>
|
|
9138
|
-
* @public
|
|
9139
|
-
*/
|
|
9140
|
-
EvaluationFormSummaryList: EvaluationFormSummary[] | undefined;
|
|
9141
|
-
/**
|
|
9142
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
9143
|
-
* @public
|
|
9144
|
-
*/
|
|
9145
|
-
NextToken?: string | undefined;
|
|
9146
|
-
}
|
|
8903
|
+
export declare const CreateViewVersionResponseFilterSensitiveLog: (obj: CreateViewVersionResponse) => any;
|
|
9147
8904
|
/**
|
|
9148
8905
|
* @internal
|
|
9149
8906
|
*/
|