@aws-sdk/client-connect 3.442.0 → 3.444.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.
Files changed (67) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/Connect.js +4 -0
  3. package/dist-cjs/commands/BatchPutContactCommand.js +51 -0
  4. package/dist-cjs/commands/CreatePersistentContactAssociationCommand.js +51 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +23 -2
  7. package/dist-cjs/models/models_1.js +1 -13
  8. package/dist-cjs/models/models_2.js +9 -1
  9. package/dist-cjs/protocols/Aws_restJson1.js +158 -9
  10. package/dist-es/Connect.js +4 -0
  11. package/dist-es/commands/BatchPutContactCommand.js +47 -0
  12. package/dist-es/commands/CreatePersistentContactAssociationCommand.js +47 -0
  13. package/dist-es/commands/index.js +2 -0
  14. package/dist-es/models/models_0.js +21 -0
  15. package/dist-es/models/models_1.js +0 -12
  16. package/dist-es/models/models_2.js +8 -0
  17. package/dist-es/protocols/Aws_restJson1.js +145 -0
  18. package/dist-types/Connect.d.ts +14 -0
  19. package/dist-types/ConnectClient.d.ts +4 -2
  20. package/dist-types/commands/BatchPutContactCommand.d.ts +133 -0
  21. package/dist-types/commands/CreatePersistentContactAssociationCommand.d.ts +98 -0
  22. package/dist-types/commands/CreateViewCommand.d.ts +7 -5
  23. package/dist-types/commands/CreateViewVersionCommand.d.ts +3 -3
  24. package/dist-types/commands/DeleteViewCommand.d.ts +2 -1
  25. package/dist-types/commands/DescribeTrafficDistributionGroupCommand.d.ts +2 -1
  26. package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribeUserHierarchyGroupCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeUserHierarchyStructureCommand.d.ts +1 -2
  29. package/dist-types/commands/DescribeViewCommand.d.ts +4 -4
  30. package/dist-types/commands/ListViewVersionsCommand.d.ts +2 -1
  31. package/dist-types/commands/ReplicateInstanceCommand.d.ts +2 -3
  32. package/dist-types/commands/StopContactCommand.d.ts +3 -0
  33. package/dist-types/commands/SuspendContactRecordingCommand.d.ts +3 -3
  34. package/dist-types/commands/UpdateContactFlowModuleMetadataCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateContactFlowNameCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateContactScheduleCommand.d.ts +1 -1
  37. package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +1 -2
  38. package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +1 -1
  39. package/dist-types/commands/UpdateInstanceAttributeCommand.d.ts +1 -1
  40. package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
  41. package/dist-types/commands/UpdateViewContentCommand.d.ts +6 -4
  42. package/dist-types/commands/index.d.ts +2 -0
  43. package/dist-types/models/models_0.d.ts +368 -398
  44. package/dist-types/models/models_1.d.ts +409 -253
  45. package/dist-types/models/models_2.d.ts +229 -7
  46. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  47. package/dist-types/ts3.4/Connect.d.ts +40 -0
  48. package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
  49. package/dist-types/ts3.4/commands/BatchPutContactCommand.d.ts +38 -0
  50. package/dist-types/ts3.4/commands/CreatePersistentContactAssociationCommand.d.ts +42 -0
  51. package/dist-types/ts3.4/commands/DescribeTrafficDistributionGroupCommand.d.ts +2 -4
  52. package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/DescribeUserHierarchyGroupCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/DescribeUserHierarchyStructureCommand.d.ts +4 -2
  55. package/dist-types/ts3.4/commands/UpdateContactFlowModuleMetadataCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/UpdateContactFlowNameCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/UpdateContactScheduleCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +4 -2
  59. package/dist-types/ts3.4/commands/UpdateHoursOfOperationCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/UpdateInstanceAttributeCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  63. package/dist-types/ts3.4/models/models_0.d.ts +77 -83
  64. package/dist-types/ts3.4/models/models_1.d.ts +81 -67
  65. package/dist-types/ts3.4/models/models_2.d.ts +62 -2
  66. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  67. package/package.json +1 -1
@@ -1089,6 +1089,194 @@ export interface BatchGetFlowAssociationResponse {
1089
1089
  */
1090
1090
  FlowAssociationSummaryList?: FlowAssociationSummary[];
1091
1091
  }
1092
+ /**
1093
+ * @public
1094
+ * <p>Information associated with a campaign.</p>
1095
+ */
1096
+ export interface Campaign {
1097
+ /**
1098
+ * @public
1099
+ * <p>A unique identifier for a campaign.</p>
1100
+ */
1101
+ CampaignId?: string;
1102
+ }
1103
+ /**
1104
+ * @public
1105
+ * @enum
1106
+ */
1107
+ export declare const EndpointType: {
1108
+ readonly CONTACT_FLOW: "CONTACT_FLOW";
1109
+ readonly TELEPHONE_NUMBER: "TELEPHONE_NUMBER";
1110
+ readonly VOIP: "VOIP";
1111
+ };
1112
+ /**
1113
+ * @public
1114
+ */
1115
+ export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
1116
+ /**
1117
+ * @public
1118
+ * <p>Information about the endpoint.</p>
1119
+ */
1120
+ export interface Endpoint {
1121
+ /**
1122
+ * @public
1123
+ * <p>Type of the endpoint.</p>
1124
+ */
1125
+ Type?: EndpointType;
1126
+ /**
1127
+ * @public
1128
+ * <p>Address of the endpoint.</p>
1129
+ */
1130
+ Address?: string;
1131
+ }
1132
+ /**
1133
+ * @public
1134
+ * <p>Request object with information to create a contact.</p>
1135
+ */
1136
+ export interface ContactDataRequest {
1137
+ /**
1138
+ * @public
1139
+ * <p>Endpoint associated with the Amazon Connect instance from which outbound contact will be
1140
+ * initiated for the campaign.</p>
1141
+ */
1142
+ SystemEndpoint?: Endpoint;
1143
+ /**
1144
+ * @public
1145
+ * <p>Endpoint of the customer for which contact will be initiated.</p>
1146
+ */
1147
+ CustomerEndpoint?: Endpoint;
1148
+ /**
1149
+ * @public
1150
+ * <p>Identifier to uniquely identify individual requests in the batch.</p>
1151
+ */
1152
+ RequestIdentifier?: string;
1153
+ /**
1154
+ * @public
1155
+ * <p>The identifier of the queue associated with the Amazon Connect instance in which
1156
+ * contacts that are created will be queued.</p>
1157
+ */
1158
+ QueueId?: string;
1159
+ /**
1160
+ * @public
1161
+ * <p>List of attributes to be stored in a contact.</p>
1162
+ */
1163
+ Attributes?: Record<string, string>;
1164
+ /**
1165
+ * @public
1166
+ * <p>Structure to store information associated with a campaign.</p>
1167
+ */
1168
+ Campaign?: Campaign;
1169
+ }
1170
+ /**
1171
+ * @public
1172
+ */
1173
+ export interface BatchPutContactRequest {
1174
+ /**
1175
+ * @public
1176
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1177
+ * request. If not provided, the Amazon Web Services
1178
+ * SDK populates this field. For more information about idempotency, see
1179
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1180
+ */
1181
+ ClientToken?: string;
1182
+ /**
1183
+ * @public
1184
+ * <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>
1185
+ */
1186
+ InstanceId: string | undefined;
1187
+ /**
1188
+ * @public
1189
+ * <p>List of individual contact requests.</p>
1190
+ */
1191
+ ContactDataRequestList: ContactDataRequest[] | undefined;
1192
+ }
1193
+ /**
1194
+ * @public
1195
+ * @enum
1196
+ */
1197
+ export declare const FailureReasonCode: {
1198
+ readonly IDEMPOTENCY_EXCEPTION: "IDEMPOTENCY_EXCEPTION";
1199
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
1200
+ readonly INVALID_ATTRIBUTE_KEY: "INVALID_ATTRIBUTE_KEY";
1201
+ readonly INVALID_CUSTOMER_ENDPOINT: "INVALID_CUSTOMER_ENDPOINT";
1202
+ readonly INVALID_QUEUE: "INVALID_QUEUE";
1203
+ readonly INVALID_SYSTEM_ENDPOINT: "INVALID_SYSTEM_ENDPOINT";
1204
+ readonly MISSING_CAMPAIGN: "MISSING_CAMPAIGN";
1205
+ readonly MISSING_CUSTOMER_ENDPOINT: "MISSING_CUSTOMER_ENDPOINT";
1206
+ readonly MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT: "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT";
1207
+ readonly REQUEST_THROTTLED: "REQUEST_THROTTLED";
1208
+ };
1209
+ /**
1210
+ * @public
1211
+ */
1212
+ export type FailureReasonCode = (typeof FailureReasonCode)[keyof typeof FailureReasonCode];
1213
+ /**
1214
+ * @public
1215
+ * <p>Request for which contact failed to be generated.</p>
1216
+ */
1217
+ export interface FailedRequest {
1218
+ /**
1219
+ * @public
1220
+ * <p>Request identifier provided in the API call in the ContactDataRequest to create a
1221
+ * contact.</p>
1222
+ */
1223
+ RequestIdentifier?: string;
1224
+ /**
1225
+ * @public
1226
+ * <p>Reason code for the failure.</p>
1227
+ */
1228
+ FailureReasonCode?: FailureReasonCode;
1229
+ /**
1230
+ * @public
1231
+ * <p>Why the request to create a contact failed.</p>
1232
+ */
1233
+ FailureReasonMessage?: string;
1234
+ }
1235
+ /**
1236
+ * @public
1237
+ * <p>Request for which contact was successfully created.</p>
1238
+ */
1239
+ export interface SuccessfulRequest {
1240
+ /**
1241
+ * @public
1242
+ * <p>Request identifier provided in the API call in the ContactDataRequest to create a
1243
+ * contact.</p>
1244
+ */
1245
+ RequestIdentifier?: string;
1246
+ /**
1247
+ * @public
1248
+ * <p>The contactId of the contact that was created successfully.</p>
1249
+ */
1250
+ ContactId?: string;
1251
+ }
1252
+ /**
1253
+ * @public
1254
+ */
1255
+ export interface BatchPutContactResponse {
1256
+ /**
1257
+ * @public
1258
+ * <p>List of requests for which contact was successfully created.</p>
1259
+ */
1260
+ SuccessfulRequestList?: SuccessfulRequest[];
1261
+ /**
1262
+ * @public
1263
+ * <p>List of requests for which contact creation failed.</p>
1264
+ */
1265
+ FailedRequestList?: FailedRequest[];
1266
+ }
1267
+ /**
1268
+ * @public
1269
+ * <p>An entity with the same name already exists.</p>
1270
+ */
1271
+ export declare class IdempotencyException extends __BaseException {
1272
+ readonly name: "IdempotencyException";
1273
+ readonly $fault: "client";
1274
+ Message?: string;
1275
+ /**
1276
+ * @internal
1277
+ */
1278
+ constructor(opts: __ExceptionOptionType<IdempotencyException, __BaseException>);
1279
+ }
1092
1280
  /**
1093
1281
  * @public
1094
1282
  */
@@ -1147,19 +1335,6 @@ export interface ClaimPhoneNumberResponse {
1147
1335
  */
1148
1336
  PhoneNumberArn?: string;
1149
1337
  }
1150
- /**
1151
- * @public
1152
- * <p>An entity with the same name already exists.</p>
1153
- */
1154
- export declare class IdempotencyException extends __BaseException {
1155
- readonly name: "IdempotencyException";
1156
- readonly $fault: "client";
1157
- Message?: string;
1158
- /**
1159
- * @internal
1160
- */
1161
- constructor(opts: __ExceptionOptionType<IdempotencyException, __BaseException>);
1162
- }
1163
1338
  /**
1164
1339
  * @public
1165
1340
  */
@@ -2175,6 +2350,154 @@ export interface CreateParticipantResponse {
2175
2350
  */
2176
2351
  ParticipantId?: string;
2177
2352
  }
2353
+ /**
2354
+ * @public
2355
+ * @enum
2356
+ */
2357
+ export declare const RehydrationType: {
2358
+ readonly ENTIRE_PAST_SESSION: "ENTIRE_PAST_SESSION";
2359
+ readonly FROM_SEGMENT: "FROM_SEGMENT";
2360
+ };
2361
+ /**
2362
+ * @public
2363
+ */
2364
+ export type RehydrationType = (typeof RehydrationType)[keyof typeof RehydrationType];
2365
+ /**
2366
+ * @public
2367
+ */
2368
+ export interface CreatePersistentContactAssociationRequest {
2369
+ /**
2370
+ * @public
2371
+ * <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>
2372
+ */
2373
+ InstanceId: string | undefined;
2374
+ /**
2375
+ * @public
2376
+ * <p>This is the contactId of the current contact that the
2377
+ * <code>CreatePersistentContactAssociation</code> API is being called from.</p>
2378
+ */
2379
+ InitialContactId: string | undefined;
2380
+ /**
2381
+ * @public
2382
+ * <p>The contactId chosen for rehydration depends on the type chosen.</p>
2383
+ * <ul>
2384
+ * <li>
2385
+ * <p>
2386
+ * <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat
2387
+ * contact of the specified past ended chat session. To use this type, provide the
2388
+ * <code>initialContactId</code> of the past ended chat session in the <code>sourceContactId</code> field. In
2389
+ * this type, Amazon Connect determines what the most recent chat contact on the past ended
2390
+ * chat session and uses it to start a persistent chat. </p>
2391
+ * </li>
2392
+ * <li>
2393
+ * <p>
2394
+ * <code>FROM_SEGMENT</code>: Rehydrates a chat from the specified past chat contact provided in the
2395
+ * <code>sourceContactId</code> field. </p>
2396
+ * </li>
2397
+ * </ul>
2398
+ * <p>The actual contactId used for rehydration is provided in the response of this API.</p>
2399
+ * <p>To illustrate how to use rehydration type, consider the following example: A customer starts
2400
+ * a chat session. Agent a1 accepts the chat and a conversation starts between the customer and
2401
+ * Agent a1. This first contact creates a contact ID <b>C1</b>. Agent a1
2402
+ * 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
2403
+ * 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
2404
+ * wants to resume their past chat session. At this point, the customer can have following use
2405
+ * cases: </p>
2406
+ * <ul>
2407
+ * <li>
2408
+ * <p>
2409
+ * <b>Use Case 1</b>: The customer wants to continue the past chat
2410
+ * session but they want to hide the post chat survey. For this they will use the following
2411
+ * configuration:</p>
2412
+ * <ul>
2413
+ * <li>
2414
+ * <p>
2415
+ * <b>Configuration</b>
2416
+ * </p>
2417
+ * <ul>
2418
+ * <li>
2419
+ * <p>SourceContactId = "C2"</p>
2420
+ * </li>
2421
+ * <li>
2422
+ * <p>RehydrationType = "FROM_SEGMENT"</p>
2423
+ * </li>
2424
+ * </ul>
2425
+ * </li>
2426
+ * <li>
2427
+ * <p>
2428
+ * <b>Expected behavior</b>
2429
+ * </p>
2430
+ * <ul>
2431
+ * <li>
2432
+ * <p>This starts a persistent chat session from the specified past ended contact (C2).
2433
+ * Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat
2434
+ * session. Note that chat segment C3 is dropped from the persistent chat session.</p>
2435
+ * </li>
2436
+ * </ul>
2437
+ * </li>
2438
+ * </ul>
2439
+ * </li>
2440
+ * <li>
2441
+ * <p>
2442
+ * <b>Use Case 2</b>: The customer wants to continue the past chat
2443
+ * session and see the transcript of the entire past engagement, including the post chat survey.
2444
+ * For this they will use the following configuration:</p>
2445
+ * <ul>
2446
+ * <li>
2447
+ * <p>
2448
+ * <b>Configuration</b>
2449
+ * </p>
2450
+ * <ul>
2451
+ * <li>
2452
+ * <p>SourceContactId = "C1"</p>
2453
+ * </li>
2454
+ * <li>
2455
+ * <p>RehydrationType = "ENTIRE_PAST_SESSION"</p>
2456
+ * </li>
2457
+ * </ul>
2458
+ * </li>
2459
+ * <li>
2460
+ * <p>
2461
+ * <b>Expected behavior</b>
2462
+ * </p>
2463
+ * <ul>
2464
+ * <li>
2465
+ * <p>This starts a persistent chat session from the most recently ended chat contact (C3).
2466
+ * Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent
2467
+ * chat session.</p>
2468
+ * </li>
2469
+ * </ul>
2470
+ * </li>
2471
+ * </ul>
2472
+ * </li>
2473
+ * </ul>
2474
+ */
2475
+ RehydrationType: RehydrationType | undefined;
2476
+ /**
2477
+ * @public
2478
+ * <p>The contactId from which a persistent chat session must be started.</p>
2479
+ */
2480
+ SourceContactId: string | undefined;
2481
+ /**
2482
+ * @public
2483
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2484
+ * request. If not provided, the Amazon Web Services
2485
+ * SDK populates this field. For more information about idempotency, see
2486
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2487
+ */
2488
+ ClientToken?: string;
2489
+ }
2490
+ /**
2491
+ * @public
2492
+ */
2493
+ export interface CreatePersistentContactAssociationResponse {
2494
+ /**
2495
+ * @public
2496
+ * <p>The contactId from which a persistent chat session is started. This field is populated only
2497
+ * for persistent chat.</p>
2498
+ */
2499
+ ContinuedFromContactId?: string;
2500
+ }
2178
2501
  /**
2179
2502
  * @public
2180
2503
  */
@@ -2759,7 +3082,7 @@ export interface RuleAction {
2759
3082
  * <p>Supported only for <code>TriggerEventSource</code> values:
2760
3083
  * <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> |
2761
3084
  * <code>OnPostChatAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> |
2762
- * <code>OnMetricDataUpdate</code>
3085
+ * <code>OnMetricDataUpdate</code>
2763
3086
  * </p>
2764
3087
  */
2765
3088
  SendNotificationAction?: SendNotificationActionDefinition;
@@ -2884,7 +3207,8 @@ export interface Application {
2884
3207
  Namespace?: string;
2885
3208
  /**
2886
3209
  * @public
2887
- * <p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code> permission is supported.</p>
3210
+ * <p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code>
3211
+ * permission is supported.</p>
2888
3212
  */
2889
3213
  ApplicationPermissions?: string[];
2890
3214
  }
@@ -3543,9 +3867,8 @@ export interface CreateUserHierarchyGroupResponse {
3543
3867
  }
3544
3868
  /**
3545
3869
  * @public
3546
- * <p>View content containing all content necessary to render a view except
3547
- * for runtime input data and the runtime input schema, which is auto-generated
3548
- * by this operation.</p>
3870
+ * <p>View content containing all content necessary to render a view except for runtime input data
3871
+ * and the runtime input schema, which is auto-generated by this operation.</p>
3549
3872
  */
3550
3873
  export interface ViewInputContent {
3551
3874
  /**
@@ -3583,19 +3906,20 @@ export interface CreateViewRequest {
3583
3906
  InstanceId: string | undefined;
3584
3907
  /**
3585
3908
  * @public
3586
- * <p>A unique Id for each create view request to avoid duplicate view creation. For example, the view
3587
- * is idempotent ClientToken is provided.</p>
3909
+ * <p>A unique Id for each create view request to avoid duplicate view creation. For example, the
3910
+ * view is idempotent ClientToken is provided.</p>
3588
3911
  */
3589
3912
  ClientToken?: string;
3590
3913
  /**
3591
3914
  * @public
3592
3915
  * <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
3593
- * <code>PUBLISHED</code> status will initiate validation on the content.</p>
3916
+ * <code>PUBLISHED</code> status will initiate validation on the content.</p>
3594
3917
  */
3595
3918
  Status: ViewStatus | undefined;
3596
3919
  /**
3597
3920
  * @public
3598
- * <p>View content containing all content necessary to render a view except for runtime input data.</p>
3921
+ * <p>View content containing all content necessary to render a view except for runtime input
3922
+ * data.</p>
3599
3923
  * <p>The total uncompressed content has a maximum file size of 400kB.</p>
3600
3924
  */
3601
3925
  Content: ViewInputContent | undefined;
@@ -3611,14 +3935,16 @@ export interface CreateViewRequest {
3611
3935
  Name: string | undefined;
3612
3936
  /**
3613
3937
  * @public
3614
- * <p>The tags associated with the view resource (not specific to view version).These tags can be used
3615
- * to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
3938
+ * <p>The tags associated with the view resource (not specific to view version).These tags can be
3939
+ * used to organize, track, or control access for this resource. For example, \{ "tags":
3940
+ * \{"key1":"value1", "key2":"value2"\} \}.</p>
3616
3941
  */
3617
3942
  Tags?: Record<string, string>;
3618
3943
  }
3619
3944
  /**
3620
3945
  * @public
3621
- * <p>View content containing all content necessary to render a view except for runtime input data.</p>
3946
+ * <p>View content containing all content necessary to render a view except for runtime input
3947
+ * data.</p>
3622
3948
  */
3623
3949
  export interface ViewContent {
3624
3950
  /**
@@ -3672,7 +3998,7 @@ export interface View {
3672
3998
  /**
3673
3999
  * @public
3674
4000
  * <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
3675
- * <code>PUBLISHED</code> status will initiate validation on the content.</p>
4001
+ * <code>PUBLISHED</code> status will initiate validation on the content.</p>
3676
4002
  */
3677
4003
  Status?: ViewStatus;
3678
4004
  /**
@@ -3697,7 +4023,8 @@ export interface View {
3697
4023
  VersionDescription?: string;
3698
4024
  /**
3699
4025
  * @public
3700
- * <p>View content containing all content necessary to render a view except for runtime input data.</p>
4026
+ * <p>View content containing all content necessary to render a view except for runtime input
4027
+ * data.</p>
3701
4028
  */
3702
4029
  Content?: ViewContent;
3703
4030
  /**
@@ -3712,7 +4039,8 @@ export interface View {
3712
4039
  CreatedTime?: Date;
3713
4040
  /**
3714
4041
  * @public
3715
- * <p>Latest timestamp of the <code>UpdateViewContent</code> or <code>CreateViewVersion</code> operations.</p>
4042
+ * <p>Latest timestamp of the <code>UpdateViewContent</code> or <code>CreateViewVersion</code>
4043
+ * operations.</p>
3716
4044
  */
3717
4045
  LastModifiedTime?: Date;
3718
4046
  /**
@@ -3790,12 +4118,14 @@ export declare class TooManyRequestsException extends __BaseException {
3790
4118
  export interface CreateViewVersionRequest {
3791
4119
  /**
3792
4120
  * @public
3793
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4121
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
4122
+ * the instance.</p>
3794
4123
  */
3795
4124
  InstanceId: string | undefined;
3796
4125
  /**
3797
4126
  * @public
3798
- * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
4127
+ * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
4128
+ * used.</p>
3799
4129
  */
3800
4130
  ViewId: string | undefined;
3801
4131
  /**
@@ -4237,12 +4567,14 @@ export interface DeleteUserHierarchyGroupRequest {
4237
4567
  export interface DeleteViewRequest {
4238
4568
  /**
4239
4569
  * @public
4240
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4570
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
4571
+ * the instance.</p>
4241
4572
  */
4242
4573
  InstanceId: string | undefined;
4243
4574
  /**
4244
4575
  * @public
4245
- * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
4576
+ * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
4577
+ * used.</p>
4246
4578
  */
4247
4579
  ViewId: string | undefined;
4248
4580
  }
@@ -4257,12 +4589,14 @@ export interface DeleteViewResponse {
4257
4589
  export interface DeleteViewVersionRequest {
4258
4590
  /**
4259
4591
  * @public
4260
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4592
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
4593
+ * the instance.</p>
4261
4594
  */
4262
4595
  InstanceId: string | undefined;
4263
4596
  /**
4264
4597
  * @public
4265
- * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
4598
+ * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
4599
+ * used.</p>
4266
4600
  */
4267
4601
  ViewId: string | undefined;
4268
4602
  /**
@@ -6152,370 +6486,6 @@ export declare const TrafficDistributionGroupStatus: {
6152
6486
  * @public
6153
6487
  */
6154
6488
  export type TrafficDistributionGroupStatus = (typeof TrafficDistributionGroupStatus)[keyof typeof TrafficDistributionGroupStatus];
6155
- /**
6156
- * @public
6157
- * <p>Information about a traffic distribution group.</p>
6158
- */
6159
- export interface TrafficDistributionGroup {
6160
- /**
6161
- * @public
6162
- * <p>The identifier of the traffic distribution group.
6163
- * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
6164
- * The ARN must be provided if the call is from the replicated Region.</p>
6165
- */
6166
- Id?: string;
6167
- /**
6168
- * @public
6169
- * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
6170
- */
6171
- Arn?: string;
6172
- /**
6173
- * @public
6174
- * <p>The name of the traffic distribution group.</p>
6175
- */
6176
- Name?: string;
6177
- /**
6178
- * @public
6179
- * <p>The description of the traffic distribution group.</p>
6180
- */
6181
- Description?: string;
6182
- /**
6183
- * @public
6184
- * <p>The Amazon Resource Name (ARN).</p>
6185
- */
6186
- InstanceArn?: string;
6187
- /**
6188
- * @public
6189
- * <p>The status of the traffic distribution group.</p>
6190
- * <ul>
6191
- * <li>
6192
- * <p>
6193
- * <code>CREATION_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet
6194
- * completed.</p>
6195
- * </li>
6196
- * <li>
6197
- * <p>
6198
- * <code>ACTIVE</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has succeeded.</p>
6199
- * </li>
6200
- * <li>
6201
- * <p>
6202
- * <code>CREATION_FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has failed.</p>
6203
- * </li>
6204
- * <li>
6205
- * <p>
6206
- * <code>PENDING_DELETION</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet
6207
- * completed.</p>
6208
- * </li>
6209
- * <li>
6210
- * <p>
6211
- * <code>DELETION_FAILED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation has failed.</p>
6212
- * </li>
6213
- * <li>
6214
- * <p>
6215
- * <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html">UpdateTrafficDistribution</a> operation is still in progress and has not yet
6216
- * completed.</p>
6217
- * </li>
6218
- * </ul>
6219
- */
6220
- Status?: TrafficDistributionGroupStatus;
6221
- /**
6222
- * @public
6223
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
6224
- */
6225
- Tags?: Record<string, string>;
6226
- /**
6227
- * @public
6228
- * <p>Whether this is the default traffic distribution group created during instance
6229
- * replication. The default traffic distribution group cannot be deleted by the
6230
- * <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
6231
- * part of the process for deleting a replica.</p>
6232
- * <note>
6233
- * <p>The <code>SignInConfig</code> distribution is available only on a
6234
- * default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the
6235
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html">TrafficDistributionGroup</a>
6236
- * data type). If you call
6237
- * <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>,
6238
- * an <code>InvalidRequestException</code> is returned.</p>
6239
- * </note>
6240
- */
6241
- IsDefault?: boolean;
6242
- }
6243
- /**
6244
- * @public
6245
- */
6246
- export interface DescribeTrafficDistributionGroupResponse {
6247
- /**
6248
- * @public
6249
- * <p>Information about the traffic distribution group.</p>
6250
- */
6251
- TrafficDistributionGroup?: TrafficDistributionGroup;
6252
- }
6253
- /**
6254
- * @public
6255
- */
6256
- export interface DescribeUserRequest {
6257
- /**
6258
- * @public
6259
- * <p>The identifier of the user account.</p>
6260
- */
6261
- UserId: string | undefined;
6262
- /**
6263
- * @public
6264
- * <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>
6265
- */
6266
- InstanceId: string | undefined;
6267
- }
6268
- /**
6269
- * @public
6270
- * <p>Contains information about a user account for an Amazon Connect instance.</p>
6271
- */
6272
- export interface User {
6273
- /**
6274
- * @public
6275
- * <p>The identifier of the user account.</p>
6276
- */
6277
- Id?: string;
6278
- /**
6279
- * @public
6280
- * <p>The Amazon Resource Name (ARN) of the user account.</p>
6281
- */
6282
- Arn?: string;
6283
- /**
6284
- * @public
6285
- * <p>The user name assigned to the user account.</p>
6286
- */
6287
- Username?: string;
6288
- /**
6289
- * @public
6290
- * <p>Information about the user identity.</p>
6291
- */
6292
- IdentityInfo?: UserIdentityInfo;
6293
- /**
6294
- * @public
6295
- * <p>Information about the phone configuration for the user.</p>
6296
- */
6297
- PhoneConfig?: UserPhoneConfig;
6298
- /**
6299
- * @public
6300
- * <p>The identifier of the user account in the directory used for identity management.</p>
6301
- */
6302
- DirectoryUserId?: string;
6303
- /**
6304
- * @public
6305
- * <p>The identifiers of the security profiles for the user.</p>
6306
- */
6307
- SecurityProfileIds?: string[];
6308
- /**
6309
- * @public
6310
- * <p>The identifier of the routing profile for the user.</p>
6311
- */
6312
- RoutingProfileId?: string;
6313
- /**
6314
- * @public
6315
- * <p>The identifier of the hierarchy group for the user.</p>
6316
- */
6317
- HierarchyGroupId?: string;
6318
- /**
6319
- * @public
6320
- * <p>The
6321
- * tags.</p>
6322
- */
6323
- Tags?: Record<string, string>;
6324
- /**
6325
- * @public
6326
- * <p>The timestamp when this resource was last modified.</p>
6327
- */
6328
- LastModifiedTime?: Date;
6329
- /**
6330
- * @public
6331
- * <p>The Amazon Web Services Region where this resource was last modified.</p>
6332
- */
6333
- LastModifiedRegion?: string;
6334
- }
6335
- /**
6336
- * @public
6337
- */
6338
- export interface DescribeUserResponse {
6339
- /**
6340
- * @public
6341
- * <p>Information about the user account and configuration settings.</p>
6342
- */
6343
- User?: User;
6344
- }
6345
- /**
6346
- * @public
6347
- */
6348
- export interface DescribeUserHierarchyGroupRequest {
6349
- /**
6350
- * @public
6351
- * <p>The identifier of the hierarchy group.</p>
6352
- */
6353
- HierarchyGroupId: string | undefined;
6354
- /**
6355
- * @public
6356
- * <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>
6357
- */
6358
- InstanceId: string | undefined;
6359
- }
6360
- /**
6361
- * @public
6362
- * <p>Contains summary information about a hierarchy group.</p>
6363
- */
6364
- export interface HierarchyGroupSummary {
6365
- /**
6366
- * @public
6367
- * <p>The identifier of the hierarchy group.</p>
6368
- */
6369
- Id?: string;
6370
- /**
6371
- * @public
6372
- * <p>The Amazon Resource Name (ARN) of the hierarchy group.</p>
6373
- */
6374
- Arn?: string;
6375
- /**
6376
- * @public
6377
- * <p>The name of the hierarchy group.</p>
6378
- */
6379
- Name?: string;
6380
- /**
6381
- * @public
6382
- * <p>The timestamp when this resource was last modified.</p>
6383
- */
6384
- LastModifiedTime?: Date;
6385
- /**
6386
- * @public
6387
- * <p>The Amazon Web Services Region where this resource was last modified.</p>
6388
- */
6389
- LastModifiedRegion?: string;
6390
- }
6391
- /**
6392
- * @public
6393
- * <p>Contains information about the levels of a hierarchy group.</p>
6394
- */
6395
- export interface HierarchyPath {
6396
- /**
6397
- * @public
6398
- * <p>Information about level one.</p>
6399
- */
6400
- LevelOne?: HierarchyGroupSummary;
6401
- /**
6402
- * @public
6403
- * <p>Information about level two.</p>
6404
- */
6405
- LevelTwo?: HierarchyGroupSummary;
6406
- /**
6407
- * @public
6408
- * <p>Information about level three.</p>
6409
- */
6410
- LevelThree?: HierarchyGroupSummary;
6411
- /**
6412
- * @public
6413
- * <p>Information about level four.</p>
6414
- */
6415
- LevelFour?: HierarchyGroupSummary;
6416
- /**
6417
- * @public
6418
- * <p>Information about level five.</p>
6419
- */
6420
- LevelFive?: HierarchyGroupSummary;
6421
- }
6422
- /**
6423
- * @public
6424
- * <p>Contains information about a hierarchy group.</p>
6425
- */
6426
- export interface HierarchyGroup {
6427
- /**
6428
- * @public
6429
- * <p>The identifier of the hierarchy group.</p>
6430
- */
6431
- Id?: string;
6432
- /**
6433
- * @public
6434
- * <p>The Amazon Resource Name (ARN) of the hierarchy group.</p>
6435
- */
6436
- Arn?: string;
6437
- /**
6438
- * @public
6439
- * <p>The name of the hierarchy group.</p>
6440
- */
6441
- Name?: string;
6442
- /**
6443
- * @public
6444
- * <p>The identifier of the level in the hierarchy group.</p>
6445
- */
6446
- LevelId?: string;
6447
- /**
6448
- * @public
6449
- * <p>Information about the levels in the hierarchy group.</p>
6450
- */
6451
- HierarchyPath?: HierarchyPath;
6452
- /**
6453
- * @public
6454
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
6455
- */
6456
- Tags?: Record<string, string>;
6457
- /**
6458
- * @public
6459
- * <p>The timestamp when this resource was last modified.</p>
6460
- */
6461
- LastModifiedTime?: Date;
6462
- /**
6463
- * @public
6464
- * <p>The Amazon Web Services Region where this resource was last modified.</p>
6465
- */
6466
- LastModifiedRegion?: string;
6467
- }
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
6489
  /**
6520
6490
  * @internal
6521
6491
  */