@aws-sdk/client-connect 3.441.0 → 3.443.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 +8 -0
- package/dist-cjs/Connect.js +2 -0
- package/dist-cjs/commands/CreatePersistentContactAssociationCommand.js +51 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +6 -2
- package/dist-cjs/models/models_1.js +1 -13
- package/dist-cjs/models/models_2.js +9 -1
- package/dist-cjs/protocols/Aws_restJson1.js +84 -9
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/CreatePersistentContactAssociationCommand.js +47 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/models/models_1.js +0 -12
- package/dist-es/models/models_2.js +8 -0
- package/dist-es/protocols/Aws_restJson1.js +73 -0
- package/dist-types/Connect.d.ts +7 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/CreatePersistentContactAssociationCommand.d.ts +98 -0
- package/dist-types/commands/CreateViewCommand.d.ts +7 -5
- package/dist-types/commands/CreateViewVersionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteViewCommand.d.ts +2 -1
- package/dist-types/commands/DescribeUserHierarchyGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeUserHierarchyStructureCommand.d.ts +1 -2
- package/dist-types/commands/DescribeViewCommand.d.ts +4 -4
- package/dist-types/commands/ListViewVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ReplicateInstanceCommand.d.ts +2 -3
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +3 -3
- package/dist-types/commands/UpdateViewContentCommand.d.ts +6 -4
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +180 -72
- package/dist-types/models/models_1.d.ts +106 -59
- package/dist-types/models/models_2.d.ts +34 -6
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/Connect.d.ts +23 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreatePersistentContactAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeUserHierarchyGroupCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeUserHierarchyStructureCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +16 -13
- package/dist-types/ts3.4/models/models_1.d.ts +15 -19
- package/dist-types/ts3.4/models/models_2.d.ts +12 -2
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +1 -1
|
@@ -2175,6 +2175,154 @@ export interface CreateParticipantResponse {
|
|
|
2175
2175
|
*/
|
|
2176
2176
|
ParticipantId?: string;
|
|
2177
2177
|
}
|
|
2178
|
+
/**
|
|
2179
|
+
* @public
|
|
2180
|
+
* @enum
|
|
2181
|
+
*/
|
|
2182
|
+
export declare const RehydrationType: {
|
|
2183
|
+
readonly ENTIRE_PAST_SESSION: "ENTIRE_PAST_SESSION";
|
|
2184
|
+
readonly FROM_SEGMENT: "FROM_SEGMENT";
|
|
2185
|
+
};
|
|
2186
|
+
/**
|
|
2187
|
+
* @public
|
|
2188
|
+
*/
|
|
2189
|
+
export type RehydrationType = (typeof RehydrationType)[keyof typeof RehydrationType];
|
|
2190
|
+
/**
|
|
2191
|
+
* @public
|
|
2192
|
+
*/
|
|
2193
|
+
export interface CreatePersistentContactAssociationRequest {
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
* <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>
|
|
2197
|
+
*/
|
|
2198
|
+
InstanceId: string | undefined;
|
|
2199
|
+
/**
|
|
2200
|
+
* @public
|
|
2201
|
+
* <p>This is the contactId of the current contact that the
|
|
2202
|
+
* <code>CreatePersistentContactAssociation</code> API is being called from.</p>
|
|
2203
|
+
*/
|
|
2204
|
+
InitialContactId: string | undefined;
|
|
2205
|
+
/**
|
|
2206
|
+
* @public
|
|
2207
|
+
* <p>The contactId chosen for rehydration depends on the type chosen.</p>
|
|
2208
|
+
* <ul>
|
|
2209
|
+
* <li>
|
|
2210
|
+
* <p>
|
|
2211
|
+
* <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat
|
|
2212
|
+
* contact of the specified past ended chat session. To use this type, provide the
|
|
2213
|
+
* <code>initialContactId</code> of the past ended chat session in the <code>sourceContactId</code> field. In
|
|
2214
|
+
* this type, Amazon Connect determines what the most recent chat contact on the past ended
|
|
2215
|
+
* chat session and uses it to start a persistent chat. </p>
|
|
2216
|
+
* </li>
|
|
2217
|
+
* <li>
|
|
2218
|
+
* <p>
|
|
2219
|
+
* <code>FROM_SEGMENT</code>: Rehydrates a chat from the specified past chat contact provided in the
|
|
2220
|
+
* <code>sourceContactId</code> field. </p>
|
|
2221
|
+
* </li>
|
|
2222
|
+
* </ul>
|
|
2223
|
+
* <p>The actual contactId used for rehydration is provided in the response of this API.</p>
|
|
2224
|
+
* <p>To illustrate how to use rehydration type, consider the following example: A customer starts
|
|
2225
|
+
* a chat session. Agent a1 accepts the chat and a conversation starts between the customer and
|
|
2226
|
+
* Agent a1. This first contact creates a contact ID <b>C1</b>. Agent a1
|
|
2227
|
+
* then transfers the chat to Agent a2. This creates another contact ID <b>C2</b>. At this point Agent a2 ends the chat. The customer is forwarded to the
|
|
2228
|
+
* disconnect flow for a post chat survey that creates another contact ID <b>C3</b>. After the chat survey, the chat session ends. Later, the customer returns and
|
|
2229
|
+
* wants to resume their past chat session. At this point, the customer can have following use
|
|
2230
|
+
* cases: </p>
|
|
2231
|
+
* <ul>
|
|
2232
|
+
* <li>
|
|
2233
|
+
* <p>
|
|
2234
|
+
* <b>Use Case 1</b>: The customer wants to continue the past chat
|
|
2235
|
+
* session but they want to hide the post chat survey. For this they will use the following
|
|
2236
|
+
* configuration:</p>
|
|
2237
|
+
* <ul>
|
|
2238
|
+
* <li>
|
|
2239
|
+
* <p>
|
|
2240
|
+
* <b>Configuration</b>
|
|
2241
|
+
* </p>
|
|
2242
|
+
* <ul>
|
|
2243
|
+
* <li>
|
|
2244
|
+
* <p>SourceContactId = "C2"</p>
|
|
2245
|
+
* </li>
|
|
2246
|
+
* <li>
|
|
2247
|
+
* <p>RehydrationType = "FROM_SEGMENT"</p>
|
|
2248
|
+
* </li>
|
|
2249
|
+
* </ul>
|
|
2250
|
+
* </li>
|
|
2251
|
+
* <li>
|
|
2252
|
+
* <p>
|
|
2253
|
+
* <b>Expected behavior</b>
|
|
2254
|
+
* </p>
|
|
2255
|
+
* <ul>
|
|
2256
|
+
* <li>
|
|
2257
|
+
* <p>This starts a persistent chat session from the specified past ended contact (C2).
|
|
2258
|
+
* Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat
|
|
2259
|
+
* session. Note that chat segment C3 is dropped from the persistent chat session.</p>
|
|
2260
|
+
* </li>
|
|
2261
|
+
* </ul>
|
|
2262
|
+
* </li>
|
|
2263
|
+
* </ul>
|
|
2264
|
+
* </li>
|
|
2265
|
+
* <li>
|
|
2266
|
+
* <p>
|
|
2267
|
+
* <b>Use Case 2</b>: The customer wants to continue the past chat
|
|
2268
|
+
* session and see the transcript of the entire past engagement, including the post chat survey.
|
|
2269
|
+
* For this they will use the following configuration:</p>
|
|
2270
|
+
* <ul>
|
|
2271
|
+
* <li>
|
|
2272
|
+
* <p>
|
|
2273
|
+
* <b>Configuration</b>
|
|
2274
|
+
* </p>
|
|
2275
|
+
* <ul>
|
|
2276
|
+
* <li>
|
|
2277
|
+
* <p>SourceContactId = "C1"</p>
|
|
2278
|
+
* </li>
|
|
2279
|
+
* <li>
|
|
2280
|
+
* <p>RehydrationType = "ENTIRE_PAST_SESSION"</p>
|
|
2281
|
+
* </li>
|
|
2282
|
+
* </ul>
|
|
2283
|
+
* </li>
|
|
2284
|
+
* <li>
|
|
2285
|
+
* <p>
|
|
2286
|
+
* <b>Expected behavior</b>
|
|
2287
|
+
* </p>
|
|
2288
|
+
* <ul>
|
|
2289
|
+
* <li>
|
|
2290
|
+
* <p>This starts a persistent chat session from the most recently ended chat contact (C3).
|
|
2291
|
+
* Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent
|
|
2292
|
+
* chat session.</p>
|
|
2293
|
+
* </li>
|
|
2294
|
+
* </ul>
|
|
2295
|
+
* </li>
|
|
2296
|
+
* </ul>
|
|
2297
|
+
* </li>
|
|
2298
|
+
* </ul>
|
|
2299
|
+
*/
|
|
2300
|
+
RehydrationType: RehydrationType | undefined;
|
|
2301
|
+
/**
|
|
2302
|
+
* @public
|
|
2303
|
+
* <p>The contactId from which a persistent chat session must be started.</p>
|
|
2304
|
+
*/
|
|
2305
|
+
SourceContactId: string | undefined;
|
|
2306
|
+
/**
|
|
2307
|
+
* @public
|
|
2308
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2309
|
+
* request. If not provided, the Amazon Web Services
|
|
2310
|
+
* SDK populates this field. For more information about idempotency, see
|
|
2311
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2312
|
+
*/
|
|
2313
|
+
ClientToken?: string;
|
|
2314
|
+
}
|
|
2315
|
+
/**
|
|
2316
|
+
* @public
|
|
2317
|
+
*/
|
|
2318
|
+
export interface CreatePersistentContactAssociationResponse {
|
|
2319
|
+
/**
|
|
2320
|
+
* @public
|
|
2321
|
+
* <p>The contactId from which a persistent chat session is started. This field is populated only
|
|
2322
|
+
* for persistent chat.</p>
|
|
2323
|
+
*/
|
|
2324
|
+
ContinuedFromContactId?: string;
|
|
2325
|
+
}
|
|
2178
2326
|
/**
|
|
2179
2327
|
* @public
|
|
2180
2328
|
*/
|
|
@@ -2759,7 +2907,7 @@ export interface RuleAction {
|
|
|
2759
2907
|
* <p>Supported only for <code>TriggerEventSource</code> values:
|
|
2760
2908
|
* <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> |
|
|
2761
2909
|
* <code>OnPostChatAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> |
|
|
2762
|
-
*
|
|
2910
|
+
* <code>OnMetricDataUpdate</code>
|
|
2763
2911
|
* </p>
|
|
2764
2912
|
*/
|
|
2765
2913
|
SendNotificationAction?: SendNotificationActionDefinition;
|
|
@@ -2884,7 +3032,8 @@ export interface Application {
|
|
|
2884
3032
|
Namespace?: string;
|
|
2885
3033
|
/**
|
|
2886
3034
|
* @public
|
|
2887
|
-
* <p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code>
|
|
3035
|
+
* <p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code>
|
|
3036
|
+
* permission is supported.</p>
|
|
2888
3037
|
*/
|
|
2889
3038
|
ApplicationPermissions?: string[];
|
|
2890
3039
|
}
|
|
@@ -3543,9 +3692,8 @@ export interface CreateUserHierarchyGroupResponse {
|
|
|
3543
3692
|
}
|
|
3544
3693
|
/**
|
|
3545
3694
|
* @public
|
|
3546
|
-
* <p>View content containing all content necessary to render a view except
|
|
3547
|
-
*
|
|
3548
|
-
* by this operation.</p>
|
|
3695
|
+
* <p>View content containing all content necessary to render a view except for runtime input data
|
|
3696
|
+
* and the runtime input schema, which is auto-generated by this operation.</p>
|
|
3549
3697
|
*/
|
|
3550
3698
|
export interface ViewInputContent {
|
|
3551
3699
|
/**
|
|
@@ -3583,19 +3731,20 @@ export interface CreateViewRequest {
|
|
|
3583
3731
|
InstanceId: string | undefined;
|
|
3584
3732
|
/**
|
|
3585
3733
|
* @public
|
|
3586
|
-
* <p>A unique Id for each create view request to avoid duplicate view creation. For example, the
|
|
3587
|
-
* is idempotent ClientToken is provided.</p>
|
|
3734
|
+
* <p>A unique Id for each create view request to avoid duplicate view creation. For example, the
|
|
3735
|
+
* view is idempotent ClientToken is provided.</p>
|
|
3588
3736
|
*/
|
|
3589
3737
|
ClientToken?: string;
|
|
3590
3738
|
/**
|
|
3591
3739
|
* @public
|
|
3592
3740
|
* <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
|
|
3593
|
-
*
|
|
3741
|
+
* <code>PUBLISHED</code> status will initiate validation on the content.</p>
|
|
3594
3742
|
*/
|
|
3595
3743
|
Status: ViewStatus | undefined;
|
|
3596
3744
|
/**
|
|
3597
3745
|
* @public
|
|
3598
|
-
* <p>View content containing all content necessary to render a view except for runtime input
|
|
3746
|
+
* <p>View content containing all content necessary to render a view except for runtime input
|
|
3747
|
+
* data.</p>
|
|
3599
3748
|
* <p>The total uncompressed content has a maximum file size of 400kB.</p>
|
|
3600
3749
|
*/
|
|
3601
3750
|
Content: ViewInputContent | undefined;
|
|
@@ -3611,14 +3760,16 @@ export interface CreateViewRequest {
|
|
|
3611
3760
|
Name: string | undefined;
|
|
3612
3761
|
/**
|
|
3613
3762
|
* @public
|
|
3614
|
-
* <p>The tags associated with the view resource (not specific to view version).These tags can be
|
|
3615
|
-
* to organize, track, or control access for this resource. For example, \{ "tags":
|
|
3763
|
+
* <p>The tags associated with the view resource (not specific to view version).These tags can be
|
|
3764
|
+
* used to organize, track, or control access for this resource. For example, \{ "tags":
|
|
3765
|
+
* \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
3616
3766
|
*/
|
|
3617
3767
|
Tags?: Record<string, string>;
|
|
3618
3768
|
}
|
|
3619
3769
|
/**
|
|
3620
3770
|
* @public
|
|
3621
|
-
* <p>View content containing all content necessary to render a view except for runtime input
|
|
3771
|
+
* <p>View content containing all content necessary to render a view except for runtime input
|
|
3772
|
+
* data.</p>
|
|
3622
3773
|
*/
|
|
3623
3774
|
export interface ViewContent {
|
|
3624
3775
|
/**
|
|
@@ -3672,7 +3823,7 @@ export interface View {
|
|
|
3672
3823
|
/**
|
|
3673
3824
|
* @public
|
|
3674
3825
|
* <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
|
|
3675
|
-
*
|
|
3826
|
+
* <code>PUBLISHED</code> status will initiate validation on the content.</p>
|
|
3676
3827
|
*/
|
|
3677
3828
|
Status?: ViewStatus;
|
|
3678
3829
|
/**
|
|
@@ -3697,7 +3848,8 @@ export interface View {
|
|
|
3697
3848
|
VersionDescription?: string;
|
|
3698
3849
|
/**
|
|
3699
3850
|
* @public
|
|
3700
|
-
* <p>View content containing all content necessary to render a view except for runtime input
|
|
3851
|
+
* <p>View content containing all content necessary to render a view except for runtime input
|
|
3852
|
+
* data.</p>
|
|
3701
3853
|
*/
|
|
3702
3854
|
Content?: ViewContent;
|
|
3703
3855
|
/**
|
|
@@ -3712,7 +3864,8 @@ export interface View {
|
|
|
3712
3864
|
CreatedTime?: Date;
|
|
3713
3865
|
/**
|
|
3714
3866
|
* @public
|
|
3715
|
-
* <p>Latest timestamp of the <code>UpdateViewContent</code> or <code>CreateViewVersion</code>
|
|
3867
|
+
* <p>Latest timestamp of the <code>UpdateViewContent</code> or <code>CreateViewVersion</code>
|
|
3868
|
+
* operations.</p>
|
|
3716
3869
|
*/
|
|
3717
3870
|
LastModifiedTime?: Date;
|
|
3718
3871
|
/**
|
|
@@ -3790,12 +3943,14 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
3790
3943
|
export interface CreateViewVersionRequest {
|
|
3791
3944
|
/**
|
|
3792
3945
|
* @public
|
|
3793
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
3946
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
3947
|
+
* the instance.</p>
|
|
3794
3948
|
*/
|
|
3795
3949
|
InstanceId: string | undefined;
|
|
3796
3950
|
/**
|
|
3797
3951
|
* @public
|
|
3798
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
3952
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
3953
|
+
* used.</p>
|
|
3799
3954
|
*/
|
|
3800
3955
|
ViewId: string | undefined;
|
|
3801
3956
|
/**
|
|
@@ -4237,12 +4392,14 @@ export interface DeleteUserHierarchyGroupRequest {
|
|
|
4237
4392
|
export interface DeleteViewRequest {
|
|
4238
4393
|
/**
|
|
4239
4394
|
* @public
|
|
4240
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
4395
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
4396
|
+
* the instance.</p>
|
|
4241
4397
|
*/
|
|
4242
4398
|
InstanceId: string | undefined;
|
|
4243
4399
|
/**
|
|
4244
4400
|
* @public
|
|
4245
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
4401
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
4402
|
+
* used.</p>
|
|
4246
4403
|
*/
|
|
4247
4404
|
ViewId: string | undefined;
|
|
4248
4405
|
}
|
|
@@ -4257,12 +4414,14 @@ export interface DeleteViewResponse {
|
|
|
4257
4414
|
export interface DeleteViewVersionRequest {
|
|
4258
4415
|
/**
|
|
4259
4416
|
* @public
|
|
4260
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
4417
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
4418
|
+
* the instance.</p>
|
|
4261
4419
|
*/
|
|
4262
4420
|
InstanceId: string | undefined;
|
|
4263
4421
|
/**
|
|
4264
4422
|
* @public
|
|
4265
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
4423
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
4424
|
+
* used.</p>
|
|
4266
4425
|
*/
|
|
4267
4426
|
ViewId: string | undefined;
|
|
4268
4427
|
/**
|
|
@@ -6465,57 +6624,6 @@ export interface HierarchyGroup {
|
|
|
6465
6624
|
*/
|
|
6466
6625
|
LastModifiedRegion?: string;
|
|
6467
6626
|
}
|
|
6468
|
-
/**
|
|
6469
|
-
* @public
|
|
6470
|
-
*/
|
|
6471
|
-
export interface DescribeUserHierarchyGroupResponse {
|
|
6472
|
-
/**
|
|
6473
|
-
* @public
|
|
6474
|
-
* <p>Information about the hierarchy group.</p>
|
|
6475
|
-
*/
|
|
6476
|
-
HierarchyGroup?: HierarchyGroup;
|
|
6477
|
-
}
|
|
6478
|
-
/**
|
|
6479
|
-
* @public
|
|
6480
|
-
*/
|
|
6481
|
-
export interface DescribeUserHierarchyStructureRequest {
|
|
6482
|
-
/**
|
|
6483
|
-
* @public
|
|
6484
|
-
* <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>
|
|
6485
|
-
*/
|
|
6486
|
-
InstanceId: string | undefined;
|
|
6487
|
-
}
|
|
6488
|
-
/**
|
|
6489
|
-
* @public
|
|
6490
|
-
* <p>Contains information about a hierarchy level.</p>
|
|
6491
|
-
*/
|
|
6492
|
-
export interface HierarchyLevel {
|
|
6493
|
-
/**
|
|
6494
|
-
* @public
|
|
6495
|
-
* <p>The identifier of the hierarchy level.</p>
|
|
6496
|
-
*/
|
|
6497
|
-
Id?: string;
|
|
6498
|
-
/**
|
|
6499
|
-
* @public
|
|
6500
|
-
* <p>The Amazon Resource Name (ARN) of the hierarchy level.</p>
|
|
6501
|
-
*/
|
|
6502
|
-
Arn?: string;
|
|
6503
|
-
/**
|
|
6504
|
-
* @public
|
|
6505
|
-
* <p>The name of the hierarchy level.</p>
|
|
6506
|
-
*/
|
|
6507
|
-
Name?: string;
|
|
6508
|
-
/**
|
|
6509
|
-
* @public
|
|
6510
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
6511
|
-
*/
|
|
6512
|
-
LastModifiedTime?: Date;
|
|
6513
|
-
/**
|
|
6514
|
-
* @public
|
|
6515
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
6516
|
-
*/
|
|
6517
|
-
LastModifiedRegion?: string;
|
|
6518
|
-
}
|
|
6519
6627
|
/**
|
|
6520
6628
|
* @internal
|
|
6521
6629
|
*/
|
|
@@ -1,6 +1,57 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Application, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, DirectoryType, Distribution, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName,
|
|
3
|
+
import { ActionSummary, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Application, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, DirectoryType, Distribution, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MonitorCapability, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QuickConnect, QuickConnectType, Reference, ReferenceType, RehydrationType, RoutingProfile, RoutingProfileQueueReference, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, UseCaseType, UserPhoneConfig, View, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface DescribeUserHierarchyGroupResponse {
|
|
8
|
+
/**
|
|
9
|
+
* @public
|
|
10
|
+
* <p>Information about the hierarchy group.</p>
|
|
11
|
+
*/
|
|
12
|
+
HierarchyGroup?: HierarchyGroup;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export interface DescribeUserHierarchyStructureRequest {
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* <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>
|
|
21
|
+
*/
|
|
22
|
+
InstanceId: string | undefined;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Contains information about a hierarchy level.</p>
|
|
27
|
+
*/
|
|
28
|
+
export interface HierarchyLevel {
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
* <p>The identifier of the hierarchy level.</p>
|
|
32
|
+
*/
|
|
33
|
+
Id?: string;
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
* <p>The Amazon Resource Name (ARN) of the hierarchy level.</p>
|
|
37
|
+
*/
|
|
38
|
+
Arn?: string;
|
|
39
|
+
/**
|
|
40
|
+
* @public
|
|
41
|
+
* <p>The name of the hierarchy level.</p>
|
|
42
|
+
*/
|
|
43
|
+
Name?: string;
|
|
44
|
+
/**
|
|
45
|
+
* @public
|
|
46
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
47
|
+
*/
|
|
48
|
+
LastModifiedTime?: Date;
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
52
|
+
*/
|
|
53
|
+
LastModifiedRegion?: string;
|
|
54
|
+
}
|
|
4
55
|
/**
|
|
5
56
|
* @public
|
|
6
57
|
* <p>Contains information about a hierarchy structure.</p>
|
|
@@ -48,7 +99,8 @@ export interface DescribeUserHierarchyStructureResponse {
|
|
|
48
99
|
export interface DescribeViewRequest {
|
|
49
100
|
/**
|
|
50
101
|
* @public
|
|
51
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
102
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
103
|
+
* the instance.</p>
|
|
52
104
|
*/
|
|
53
105
|
InstanceId: string | undefined;
|
|
54
106
|
/**
|
|
@@ -1488,10 +1540,10 @@ export interface IntervalDetails {
|
|
|
1488
1540
|
* @public
|
|
1489
1541
|
* <p>
|
|
1490
1542
|
* <code>IntervalPeriod</code>: An aggregated grouping applied to request metrics. Valid
|
|
1491
|
-
*
|
|
1492
|
-
*
|
|
1543
|
+
* <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code> |
|
|
1544
|
+
* <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>. </p>
|
|
1493
1545
|
* <p>For example, if <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>,
|
|
1494
|
-
*
|
|
1546
|
+
* <code>StartTime</code> and <code>EndTime</code> differs by 1 day, then Amazon Connect
|
|
1495
1547
|
* returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By
|
|
1496
1548
|
* default Amazon Connect aggregates results based on the <code>TOTAL</code> interval period. </p>
|
|
1497
1549
|
* <p>The following list describes restrictions on <code>StartTime</code> and <code>EndTime</code>
|
|
@@ -1500,12 +1552,12 @@ export interface IntervalDetails {
|
|
|
1500
1552
|
* <li>
|
|
1501
1553
|
* <p>
|
|
1502
1554
|
* <code>FIFTEEN_MIN</code>: The difference between <code>StartTime</code> and
|
|
1503
|
-
*
|
|
1555
|
+
* <code>EndTime</code> must be less than 3 days.</p>
|
|
1504
1556
|
* </li>
|
|
1505
1557
|
* <li>
|
|
1506
1558
|
* <p>
|
|
1507
1559
|
* <code>THIRTY_MIN</code>: The difference between <code>StartTime</code> and
|
|
1508
|
-
*
|
|
1560
|
+
* <code>EndTime</code> must be less than 3 days.</p>
|
|
1509
1561
|
* </li>
|
|
1510
1562
|
* <li>
|
|
1511
1563
|
* <p>
|
|
@@ -2014,6 +2066,34 @@ export interface GetMetricDataV2Request {
|
|
|
2014
2066
|
* <p>Unit: Seconds</p>
|
|
2015
2067
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
2016
2068
|
* </dd>
|
|
2069
|
+
* <dt>PERCENT_NON_TALK_TIME</dt>
|
|
2070
|
+
* <dd>
|
|
2071
|
+
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
|
|
2072
|
+
* analytics.</p>
|
|
2073
|
+
* <p>Unit: Percentage</p>
|
|
2074
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
2075
|
+
* </dd>
|
|
2076
|
+
* <dt>PERCENT_TALK_TIME</dt>
|
|
2077
|
+
* <dd>
|
|
2078
|
+
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
|
|
2079
|
+
* analytics.</p>
|
|
2080
|
+
* <p>Unit: Percentage</p>
|
|
2081
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
2082
|
+
* </dd>
|
|
2083
|
+
* <dt>PERCENT_TALK_TIME_AGENT</dt>
|
|
2084
|
+
* <dd>
|
|
2085
|
+
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
|
|
2086
|
+
* analytics.</p>
|
|
2087
|
+
* <p>Unit: Percentage</p>
|
|
2088
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
2089
|
+
* </dd>
|
|
2090
|
+
* <dt>PERCENT_TALK_TIME_CUSTOMER</dt>
|
|
2091
|
+
* <dd>
|
|
2092
|
+
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
|
|
2093
|
+
* analytics.</p>
|
|
2094
|
+
* <p>Unit: Percentage</p>
|
|
2095
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
2096
|
+
* </dd>
|
|
2017
2097
|
* <dt>SERVICE_LEVEL</dt>
|
|
2018
2098
|
* <dd>
|
|
2019
2099
|
* <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
|
|
@@ -2102,7 +2182,7 @@ export interface MetricInterval {
|
|
|
2102
2182
|
* @public
|
|
2103
2183
|
* <p>The timestamp, in UNIX Epoch time format. End time is based on the interval period selected.
|
|
2104
2184
|
* For example, If <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>,
|
|
2105
|
-
*
|
|
2185
|
+
* <code>StartTime</code> and <code>EndTime</code> in the API request differs by 1 day, then 48
|
|
2106
2186
|
* results are returned in the response. Each result is aggregated by the 30 minutes period, with
|
|
2107
2187
|
* each <code>StartTime</code> and <code>EndTime</code> differing by 30 minutes. </p>
|
|
2108
2188
|
*/
|
|
@@ -3771,9 +3851,9 @@ export interface ListPhoneNumbersV2Request {
|
|
|
3771
3851
|
* @public
|
|
3772
3852
|
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
3773
3853
|
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
3774
|
-
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. If both <code>TargetArn</code> and <code>InstanceId</code> are not
|
|
3775
|
-
* claimed to all the Amazon Connect instances belonging to your
|
|
3776
|
-
* the request.</p>
|
|
3854
|
+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. If both <code>TargetArn</code> and <code>InstanceId</code> are not
|
|
3855
|
+
* provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your
|
|
3856
|
+
* account in the same AWS Region as the request.</p>
|
|
3777
3857
|
*/
|
|
3778
3858
|
InstanceId?: string;
|
|
3779
3859
|
/**
|
|
@@ -5081,7 +5161,8 @@ export interface ListUsersResponse {
|
|
|
5081
5161
|
export interface ListViewsRequest {
|
|
5082
5162
|
/**
|
|
5083
5163
|
* @public
|
|
5084
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
5164
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
5165
|
+
* the instance.</p>
|
|
5085
5166
|
*/
|
|
5086
5167
|
InstanceId: string | undefined;
|
|
5087
5168
|
/**
|
|
@@ -5091,8 +5172,8 @@ export interface ListViewsRequest {
|
|
|
5091
5172
|
Type?: ViewType;
|
|
5092
5173
|
/**
|
|
5093
5174
|
* @public
|
|
5094
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5095
|
-
* retrieve the next set of results.</p>
|
|
5175
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5176
|
+
* the next request to retrieve the next set of results.</p>
|
|
5096
5177
|
*/
|
|
5097
5178
|
NextToken?: string;
|
|
5098
5179
|
/**
|
|
@@ -5129,7 +5210,7 @@ export interface ViewSummary {
|
|
|
5129
5210
|
/**
|
|
5130
5211
|
* @public
|
|
5131
5212
|
* <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
|
|
5132
|
-
*
|
|
5213
|
+
* <code>PUBLISHED</code> status will initiate validation on the content.</p>
|
|
5133
5214
|
*/
|
|
5134
5215
|
Status?: ViewStatus;
|
|
5135
5216
|
/**
|
|
@@ -5149,8 +5230,8 @@ export interface ListViewsResponse {
|
|
|
5149
5230
|
ViewsSummaryList?: ViewSummary[];
|
|
5150
5231
|
/**
|
|
5151
5232
|
* @public
|
|
5152
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5153
|
-
* retrieve the next set of results.</p>
|
|
5233
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5234
|
+
* the next request to retrieve the next set of results.</p>
|
|
5154
5235
|
*/
|
|
5155
5236
|
NextToken?: string;
|
|
5156
5237
|
}
|
|
@@ -5160,18 +5241,20 @@ export interface ListViewsResponse {
|
|
|
5160
5241
|
export interface ListViewVersionsRequest {
|
|
5161
5242
|
/**
|
|
5162
5243
|
* @public
|
|
5163
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
5244
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
5245
|
+
* the instance.</p>
|
|
5164
5246
|
*/
|
|
5165
5247
|
InstanceId: string | undefined;
|
|
5166
5248
|
/**
|
|
5167
5249
|
* @public
|
|
5168
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
5250
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
5251
|
+
* used.</p>
|
|
5169
5252
|
*/
|
|
5170
5253
|
ViewId: string | undefined;
|
|
5171
5254
|
/**
|
|
5172
5255
|
* @public
|
|
5173
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5174
|
-
* retrieve the next set of results.</p>
|
|
5256
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5257
|
+
* the next request to retrieve the next set of results.</p>
|
|
5175
5258
|
*/
|
|
5176
5259
|
NextToken?: string;
|
|
5177
5260
|
/**
|
|
@@ -5232,8 +5315,8 @@ export interface ListViewVersionsResponse {
|
|
|
5232
5315
|
ViewVersionSummaryList?: ViewVersionSummary[];
|
|
5233
5316
|
/**
|
|
5234
5317
|
* @public
|
|
5235
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5236
|
-
* retrieve the next set of results.</p>
|
|
5318
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5319
|
+
* the next request to retrieve the next set of results.</p>
|
|
5237
5320
|
*/
|
|
5238
5321
|
NextToken?: string;
|
|
5239
5322
|
}
|
|
@@ -6262,18 +6345,6 @@ export interface ParticipantDetails {
|
|
|
6262
6345
|
*/
|
|
6263
6346
|
DisplayName: string | undefined;
|
|
6264
6347
|
}
|
|
6265
|
-
/**
|
|
6266
|
-
* @public
|
|
6267
|
-
* @enum
|
|
6268
|
-
*/
|
|
6269
|
-
export declare const RehydrationType: {
|
|
6270
|
-
readonly ENTIRE_PAST_SESSION: "ENTIRE_PAST_SESSION";
|
|
6271
|
-
readonly FROM_SEGMENT: "FROM_SEGMENT";
|
|
6272
|
-
};
|
|
6273
|
-
/**
|
|
6274
|
-
* @public
|
|
6275
|
-
*/
|
|
6276
|
-
export type RehydrationType = (typeof RehydrationType)[keyof typeof RehydrationType];
|
|
6277
6348
|
/**
|
|
6278
6349
|
* @public
|
|
6279
6350
|
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
@@ -7499,30 +7570,6 @@ export interface UpdateInstanceStorageConfigRequest {
|
|
|
7499
7570
|
*/
|
|
7500
7571
|
StorageConfig: InstanceStorageConfig | undefined;
|
|
7501
7572
|
}
|
|
7502
|
-
/**
|
|
7503
|
-
* @public
|
|
7504
|
-
* @enum
|
|
7505
|
-
*/
|
|
7506
|
-
export declare const TimerEligibleParticipantRoles: {
|
|
7507
|
-
readonly AGENT: "AGENT";
|
|
7508
|
-
readonly CUSTOMER: "CUSTOMER";
|
|
7509
|
-
};
|
|
7510
|
-
/**
|
|
7511
|
-
* @public
|
|
7512
|
-
*/
|
|
7513
|
-
export type TimerEligibleParticipantRoles = (typeof TimerEligibleParticipantRoles)[keyof typeof TimerEligibleParticipantRoles];
|
|
7514
|
-
/**
|
|
7515
|
-
* @public
|
|
7516
|
-
* @enum
|
|
7517
|
-
*/
|
|
7518
|
-
export declare const ParticipantTimerType: {
|
|
7519
|
-
readonly DISCONNECT_NONCUSTOMER: "DISCONNECT_NONCUSTOMER";
|
|
7520
|
-
readonly IDLE: "IDLE";
|
|
7521
|
-
};
|
|
7522
|
-
/**
|
|
7523
|
-
* @public
|
|
7524
|
-
*/
|
|
7525
|
-
export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType];
|
|
7526
7573
|
/**
|
|
7527
7574
|
* @internal
|
|
7528
7575
|
*/
|