@aws-sdk/client-connect 3.380.0 → 3.385.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 (35) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/Connect.js +2 -0
  3. package/dist-cjs/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.js +46 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoint/ruleset.js +1 -1
  6. package/dist-cjs/models/models_0.js +6 -6
  7. package/dist-cjs/models/models_1.js +5 -1
  8. package/dist-cjs/protocols/Aws_restJson1.js +72 -5
  9. package/dist-es/Connect.js +2 -0
  10. package/dist-es/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.js +42 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/endpoint/ruleset.js +1 -1
  13. package/dist-es/models/models_0.js +4 -4
  14. package/dist-es/models/models_1.js +4 -0
  15. package/dist-es/protocols/Aws_restJson1.js +65 -0
  16. package/dist-types/Connect.d.ts +7 -0
  17. package/dist-types/ConnectClient.d.ts +3 -2
  18. package/dist-types/commands/CreateRoutingProfileCommand.d.ts +1 -0
  19. package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +1 -0
  20. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +1 -0
  21. package/dist-types/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +92 -0
  22. package/dist-types/commands/index.d.ts +1 -0
  23. package/dist-types/models/models_0.d.ts +738 -12
  24. package/dist-types/models/models_1.d.ts +940 -57
  25. package/dist-types/models/models_2.d.ts +134 -1
  26. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  27. package/dist-types/ts3.4/Connect.d.ts +23 -0
  28. package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
  29. package/dist-types/ts3.4/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +38 -0
  30. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  31. package/dist-types/ts3.4/models/models_0.d.ts +8 -5
  32. package/dist-types/ts3.4/models/models_1.d.ts +11 -15
  33. package/dist-types/ts3.4/models/models_2.d.ts +14 -2
  34. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  35. package/package.json +5 -5
@@ -33,6 +33,7 @@ export type ActionType = (typeof ActionType)[keyof typeof ActionType];
33
33
  */
34
34
  export interface ActionSummary {
35
35
  /**
36
+ * @public
36
37
  * <p>The action type.</p>
37
38
  */
38
39
  ActionType: ActionType | string | undefined;
@@ -42,14 +43,17 @@ export interface ActionSummary {
42
43
  */
43
44
  export interface ActivateEvaluationFormRequest {
44
45
  /**
46
+ * @public
45
47
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
46
48
  */
47
49
  InstanceId: string | undefined;
48
50
  /**
51
+ * @public
49
52
  * <p>The unique identifier for the evaluation form.</p>
50
53
  */
51
54
  EvaluationFormId: string | undefined;
52
55
  /**
56
+ * @public
53
57
  * <p>The version of the evaluation form to activate. If the version property is not provided, the
54
58
  * latest version of the evaluation form is activated.</p>
55
59
  */
@@ -60,14 +64,17 @@ export interface ActivateEvaluationFormRequest {
60
64
  */
61
65
  export interface ActivateEvaluationFormResponse {
62
66
  /**
67
+ * @public
63
68
  * <p>The unique identifier for the evaluation form.</p>
64
69
  */
65
70
  EvaluationFormId: string | undefined;
66
71
  /**
72
+ * @public
67
73
  * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
68
74
  */
69
75
  EvaluationFormArn: string | undefined;
70
76
  /**
77
+ * @public
71
78
  * <p>A version of the evaluation form.</p>
72
79
  */
73
80
  EvaluationFormVersion: number | undefined;
@@ -80,6 +87,7 @@ export declare class InternalServiceException extends __BaseException {
80
87
  readonly name: "InternalServiceException";
81
88
  readonly $fault: "server";
82
89
  /**
90
+ * @public
83
91
  * <p>The message.</p>
84
92
  */
85
93
  Message?: string;
@@ -96,6 +104,7 @@ export declare class InvalidParameterException extends __BaseException {
96
104
  readonly name: "InvalidParameterException";
97
105
  readonly $fault: "client";
98
106
  /**
107
+ * @public
99
108
  * <p>The message about the parameters.</p>
100
109
  */
101
110
  Message?: string;
@@ -125,6 +134,7 @@ export declare class ResourceNotFoundException extends __BaseException {
125
134
  readonly name: "ResourceNotFoundException";
126
135
  readonly $fault: "client";
127
136
  /**
137
+ * @public
128
138
  * <p>The message about the resource.</p>
129
139
  */
130
140
  Message?: string;
@@ -146,6 +156,18 @@ export declare class ThrottlingException extends __BaseException {
146
156
  */
147
157
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
148
158
  }
159
+ /**
160
+ * @public
161
+ * @enum
162
+ */
163
+ export declare const AgentAvailabilityTimer: {
164
+ readonly TIME_SINCE_LAST_ACTIVITY: "TIME_SINCE_LAST_ACTIVITY";
165
+ readonly TIME_SINCE_LAST_INBOUND: "TIME_SINCE_LAST_INBOUND";
166
+ };
167
+ /**
168
+ * @public
169
+ */
170
+ export type AgentAvailabilityTimer = (typeof AgentAvailabilityTimer)[keyof typeof AgentAvailabilityTimer];
149
171
  /**
150
172
  * @public
151
173
  * @enum
@@ -203,10 +225,12 @@ export type ContactInitiationMethod = (typeof ContactInitiationMethod)[keyof typ
203
225
  */
204
226
  export interface QueueReference {
205
227
  /**
228
+ * @public
206
229
  * <p>The identifier of the queue.</p>
207
230
  */
208
231
  Id?: string;
209
232
  /**
233
+ * @public
210
234
  * <p>The Amazon Resource Name (ARN) of the queue.</p>
211
235
  */
212
236
  Arn?: string;
@@ -218,30 +242,37 @@ export interface QueueReference {
218
242
  */
219
243
  export interface AgentContactReference {
220
244
  /**
245
+ * @public
221
246
  * <p>The identifier of the contact in this instance of Amazon Connect. </p>
222
247
  */
223
248
  ContactId?: string;
224
249
  /**
250
+ * @public
225
251
  * <p>The channel of the contact.</p>
226
252
  */
227
253
  Channel?: Channel | string;
228
254
  /**
255
+ * @public
229
256
  * <p>How the contact was initiated.</p>
230
257
  */
231
258
  InitiationMethod?: ContactInitiationMethod | string;
232
259
  /**
260
+ * @public
233
261
  * <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">state of the contact</a>.</p>
234
262
  */
235
263
  AgentContactState?: ContactState | string;
236
264
  /**
265
+ * @public
237
266
  * <p>The epoch timestamp when the contact state started.</p>
238
267
  */
239
268
  StateStartTimestamp?: Date;
240
269
  /**
270
+ * @public
241
271
  * <p>The time at which the contact was connected to an agent.</p>
242
272
  */
243
273
  ConnectedToAgentTimestamp?: Date;
244
274
  /**
275
+ * @public
245
276
  * <p>Contains information about a queue resource for which metrics are returned.</p>
246
277
  */
247
278
  Queue?: QueueReference;
@@ -252,10 +283,12 @@ export interface AgentContactReference {
252
283
  */
253
284
  export interface AgentInfo {
254
285
  /**
286
+ * @public
255
287
  * <p>The identifier of the agent who accepted the contact.</p>
256
288
  */
257
289
  Id?: string;
258
290
  /**
291
+ * @public
259
292
  * <p>The timestamp when the contact was connected to the agent.</p>
260
293
  */
261
294
  ConnectedToAgentTimestamp?: Date;
@@ -291,34 +324,42 @@ export type AgentStatusType = (typeof AgentStatusType)[keyof typeof AgentStatusT
291
324
  */
292
325
  export interface AgentStatus {
293
326
  /**
327
+ * @public
294
328
  * <p>The Amazon Resource Name (ARN) of the agent status.</p>
295
329
  */
296
330
  AgentStatusARN?: string;
297
331
  /**
332
+ * @public
298
333
  * <p>The identifier of the agent status.</p>
299
334
  */
300
335
  AgentStatusId?: string;
301
336
  /**
337
+ * @public
302
338
  * <p>The name of the agent status.</p>
303
339
  */
304
340
  Name?: string;
305
341
  /**
342
+ * @public
306
343
  * <p>The description of the agent status.</p>
307
344
  */
308
345
  Description?: string;
309
346
  /**
347
+ * @public
310
348
  * <p>The type of agent status.</p>
311
349
  */
312
350
  Type?: AgentStatusType | string;
313
351
  /**
352
+ * @public
314
353
  * <p>The display order of the agent status.</p>
315
354
  */
316
355
  DisplayOrder?: number;
317
356
  /**
357
+ * @public
318
358
  * <p>The state of the agent status.</p>
319
359
  */
320
360
  State?: AgentStatusState | string;
321
361
  /**
362
+ * @public
322
363
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
323
364
  */
324
365
  Tags?: Record<string, string>;
@@ -329,14 +370,17 @@ export interface AgentStatus {
329
370
  */
330
371
  export interface AgentStatusReference {
331
372
  /**
373
+ * @public
332
374
  * <p>The start timestamp of the agent's status.</p>
333
375
  */
334
376
  StatusStartTimestamp?: Date;
335
377
  /**
378
+ * @public
336
379
  * <p>The Amazon Resource Name (ARN) of the agent's status.</p>
337
380
  */
338
381
  StatusArn?: string;
339
382
  /**
383
+ * @public
340
384
  * <p>The name of the agent status.</p>
341
385
  */
342
386
  StatusName?: string;
@@ -347,18 +391,22 @@ export interface AgentStatusReference {
347
391
  */
348
392
  export interface AgentStatusSummary {
349
393
  /**
394
+ * @public
350
395
  * <p>The identifier for an agent status.</p>
351
396
  */
352
397
  Id?: string;
353
398
  /**
399
+ * @public
354
400
  * <p>The Amazon Resource Name (ARN) for the agent status.</p>
355
401
  */
356
402
  Arn?: string;
357
403
  /**
404
+ * @public
358
405
  * <p>The name of the agent status.</p>
359
406
  */
360
407
  Name?: string;
361
408
  /**
409
+ * @public
362
410
  * <p>The type of the agent status.</p>
363
411
  */
364
412
  Type?: AgentStatusType | string;
@@ -380,10 +428,12 @@ export type MonitorCapability = (typeof MonitorCapability)[keyof typeof MonitorC
380
428
  */
381
429
  export interface AssociateApprovedOriginRequest {
382
430
  /**
431
+ * @public
383
432
  * <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>
384
433
  */
385
434
  InstanceId: string | undefined;
386
435
  /**
436
+ * @public
387
437
  * <p>The domain to add to your allow list.</p>
388
438
  */
389
439
  Origin: string | undefined;
@@ -396,6 +446,7 @@ export declare class InvalidRequestException extends __BaseException {
396
446
  readonly name: "InvalidRequestException";
397
447
  readonly $fault: "client";
398
448
  /**
449
+ * @public
399
450
  * <p>The message about the request.</p>
400
451
  */
401
452
  Message?: string;
@@ -423,10 +474,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
423
474
  */
424
475
  export interface LexBot {
425
476
  /**
477
+ * @public
426
478
  * <p>The name of the Amazon Lex bot.</p>
427
479
  */
428
480
  Name: string | undefined;
429
481
  /**
482
+ * @public
430
483
  * <p>The Amazon Web Services Region where the Amazon Lex bot was created.</p>
431
484
  */
432
485
  LexRegion: string | undefined;
@@ -437,6 +490,7 @@ export interface LexBot {
437
490
  */
438
491
  export interface LexV2Bot {
439
492
  /**
493
+ * @public
440
494
  * <p>The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.</p>
441
495
  */
442
496
  AliasArn?: string;
@@ -446,14 +500,17 @@ export interface LexV2Bot {
446
500
  */
447
501
  export interface AssociateBotRequest {
448
502
  /**
503
+ * @public
449
504
  * <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>
450
505
  */
451
506
  InstanceId: string | undefined;
452
507
  /**
508
+ * @public
453
509
  * <p>Configuration information of an Amazon Lex bot.</p>
454
510
  */
455
511
  LexBot?: LexBot;
456
512
  /**
513
+ * @public
457
514
  * <p>The Amazon Lex V2 bot to associate with the instance.</p>
458
515
  */
459
516
  LexV2Bot?: LexV2Bot;
@@ -466,6 +523,7 @@ export declare class LimitExceededException extends __BaseException {
466
523
  readonly name: "LimitExceededException";
467
524
  readonly $fault: "client";
468
525
  /**
526
+ * @public
469
527
  * <p>The message about the limit.</p>
470
528
  */
471
529
  Message?: string;
@@ -512,16 +570,19 @@ export type VocabularyLanguageCode = (typeof VocabularyLanguageCode)[keyof typeo
512
570
  */
513
571
  export interface AssociateDefaultVocabularyRequest {
514
572
  /**
573
+ * @public
515
574
  * <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>
516
575
  */
517
576
  InstanceId: string | undefined;
518
577
  /**
578
+ * @public
519
579
  * <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
520
580
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
521
581
  * </p>
522
582
  */
523
583
  LanguageCode: VocabularyLanguageCode | string | undefined;
524
584
  /**
585
+ * @public
525
586
  * <p>The identifier of the custom vocabulary. If this is empty, the default is set to none.</p>
526
587
  */
527
588
  VocabularyId?: string;
@@ -557,6 +618,7 @@ export type InstanceStorageResourceType = (typeof InstanceStorageResourceType)[k
557
618
  */
558
619
  export interface KinesisFirehoseConfig {
559
620
  /**
621
+ * @public
560
622
  * <p>The Amazon Resource Name (ARN) of the delivery stream.</p>
561
623
  */
562
624
  FirehoseArn: string | undefined;
@@ -567,6 +629,7 @@ export interface KinesisFirehoseConfig {
567
629
  */
568
630
  export interface KinesisStreamConfig {
569
631
  /**
632
+ * @public
570
633
  * <p>The Amazon Resource Name (ARN) of the data stream.</p>
571
634
  */
572
635
  StreamArn: string | undefined;
@@ -588,10 +651,12 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
588
651
  */
589
652
  export interface EncryptionConfig {
590
653
  /**
654
+ * @public
591
655
  * <p>The type of encryption.</p>
592
656
  */
593
657
  EncryptionType: EncryptionType | string | undefined;
594
658
  /**
659
+ * @public
595
660
  * <p>The full ARN of the encryption key. </p>
596
661
  * <note>
597
662
  * <p>Be sure to provide the full ARN of the encryption key, not just the ID.</p>
@@ -609,16 +674,19 @@ export interface EncryptionConfig {
609
674
  */
610
675
  export interface KinesisVideoStreamConfig {
611
676
  /**
677
+ * @public
612
678
  * <p>The prefix of the video stream.</p>
613
679
  */
614
680
  Prefix: string | undefined;
615
681
  /**
682
+ * @public
616
683
  * <p>The number of hours data is retained in the stream. Kinesis Video Streams retains the data
617
684
  * in a data store that is associated with the stream.</p>
618
685
  * <p>The default value is 0, indicating that the stream does not persist data.</p>
619
686
  */
620
687
  RetentionPeriodHours: number | undefined;
621
688
  /**
689
+ * @public
622
690
  * <p>The encryption configuration.</p>
623
691
  */
624
692
  EncryptionConfig: EncryptionConfig | undefined;
@@ -629,14 +697,17 @@ export interface KinesisVideoStreamConfig {
629
697
  */
630
698
  export interface S3Config {
631
699
  /**
700
+ * @public
632
701
  * <p>The S3 bucket name.</p>
633
702
  */
634
703
  BucketName: string | undefined;
635
704
  /**
705
+ * @public
636
706
  * <p>The S3 bucket prefix.</p>
637
707
  */
638
708
  BucketPrefix: string | undefined;
639
709
  /**
710
+ * @public
640
711
  * <p>The Amazon S3 encryption configuration.</p>
641
712
  */
642
713
  EncryptionConfig?: EncryptionConfig;
@@ -661,27 +732,33 @@ export type StorageType = (typeof StorageType)[keyof typeof StorageType];
661
732
  */
662
733
  export interface InstanceStorageConfig {
663
734
  /**
735
+ * @public
664
736
  * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
665
737
  */
666
738
  AssociationId?: string;
667
739
  /**
740
+ * @public
668
741
  * <p>A valid storage type.</p>
669
742
  */
670
743
  StorageType: StorageType | string | undefined;
671
744
  /**
745
+ * @public
672
746
  * <p>The S3 bucket
673
747
  * configuration.</p>
674
748
  */
675
749
  S3Config?: S3Config;
676
750
  /**
751
+ * @public
677
752
  * <p>The configuration of the Kinesis video stream.</p>
678
753
  */
679
754
  KinesisVideoStreamConfig?: KinesisVideoStreamConfig;
680
755
  /**
756
+ * @public
681
757
  * <p>The configuration of the Kinesis data stream.</p>
682
758
  */
683
759
  KinesisStreamConfig?: KinesisStreamConfig;
684
760
  /**
761
+ * @public
685
762
  * <p>The configuration of the Kinesis Firehose delivery stream.</p>
686
763
  */
687
764
  KinesisFirehoseConfig?: KinesisFirehoseConfig;
@@ -691,14 +768,17 @@ export interface InstanceStorageConfig {
691
768
  */
692
769
  export interface AssociateInstanceStorageConfigRequest {
693
770
  /**
771
+ * @public
694
772
  * <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>
695
773
  */
696
774
  InstanceId: string | undefined;
697
775
  /**
776
+ * @public
698
777
  * <p>A valid resource type.</p>
699
778
  */
700
779
  ResourceType: InstanceStorageResourceType | string | undefined;
701
780
  /**
781
+ * @public
702
782
  * <p>A valid storage type.</p>
703
783
  */
704
784
  StorageConfig: InstanceStorageConfig | undefined;
@@ -708,6 +788,7 @@ export interface AssociateInstanceStorageConfigRequest {
708
788
  */
709
789
  export interface AssociateInstanceStorageConfigResponse {
710
790
  /**
791
+ * @public
711
792
  * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
712
793
  */
713
794
  AssociationId?: string;
@@ -717,10 +798,12 @@ export interface AssociateInstanceStorageConfigResponse {
717
798
  */
718
799
  export interface AssociateLambdaFunctionRequest {
719
800
  /**
801
+ * @public
720
802
  * <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>
721
803
  */
722
804
  InstanceId: string | undefined;
723
805
  /**
806
+ * @public
724
807
  * <p>The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters
725
808
  * allowed is 140.</p>
726
809
  */
@@ -731,10 +814,12 @@ export interface AssociateLambdaFunctionRequest {
731
814
  */
732
815
  export interface AssociateLexBotRequest {
733
816
  /**
817
+ * @public
734
818
  * <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>
735
819
  */
736
820
  InstanceId: string | undefined;
737
821
  /**
822
+ * @public
738
823
  * <p>The Amazon Lex bot to associate with the instance.</p>
739
824
  */
740
825
  LexBot: LexBot | undefined;
@@ -744,14 +829,17 @@ export interface AssociateLexBotRequest {
744
829
  */
745
830
  export interface AssociatePhoneNumberContactFlowRequest {
746
831
  /**
832
+ * @public
747
833
  * <p>A unique identifier for the phone number.</p>
748
834
  */
749
835
  PhoneNumberId: string | undefined;
750
836
  /**
837
+ * @public
751
838
  * <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>
752
839
  */
753
840
  InstanceId: string | undefined;
754
841
  /**
842
+ * @public
755
843
  * <p>The identifier of the flow.</p>
756
844
  */
757
845
  ContactFlowId: string | undefined;
@@ -761,14 +849,17 @@ export interface AssociatePhoneNumberContactFlowRequest {
761
849
  */
762
850
  export interface AssociateQueueQuickConnectsRequest {
763
851
  /**
852
+ * @public
764
853
  * <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>
765
854
  */
766
855
  InstanceId: string | undefined;
767
856
  /**
857
+ * @public
768
858
  * <p>The identifier for the queue.</p>
769
859
  */
770
860
  QueueId: string | undefined;
771
861
  /**
862
+ * @public
772
863
  * <p>The quick connects to associate with this queue.</p>
773
864
  */
774
865
  QuickConnectIds: string[] | undefined;
@@ -779,10 +870,12 @@ export interface AssociateQueueQuickConnectsRequest {
779
870
  */
780
871
  export interface RoutingProfileQueueReference {
781
872
  /**
873
+ * @public
782
874
  * <p>The identifier for the queue.</p>
783
875
  */
784
876
  QueueId: string | undefined;
785
877
  /**
878
+ * @public
786
879
  * <p>The channels agents can handle in the Contact Control Panel (CCP) for this routing
787
880
  * profile.</p>
788
881
  */
@@ -795,16 +888,19 @@ export interface RoutingProfileQueueReference {
795
888
  */
796
889
  export interface RoutingProfileQueueConfig {
797
890
  /**
891
+ * @public
798
892
  * <p>Contains information about a queue resource.</p>
799
893
  */
800
894
  QueueReference: RoutingProfileQueueReference | undefined;
801
895
  /**
896
+ * @public
802
897
  * <p>The order in which contacts are to be handled for the queue. For more information, see
803
898
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and
804
899
  * delay</a>.</p>
805
900
  */
806
901
  Priority: number | undefined;
807
902
  /**
903
+ * @public
808
904
  * <p>The delay, in seconds, a contact should be in the queue before they are routed to an
809
905
  * available agent. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and
810
906
  * delay</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
@@ -816,14 +912,17 @@ export interface RoutingProfileQueueConfig {
816
912
  */
817
913
  export interface AssociateRoutingProfileQueuesRequest {
818
914
  /**
915
+ * @public
819
916
  * <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>
820
917
  */
821
918
  InstanceId: string | undefined;
822
919
  /**
920
+ * @public
823
921
  * <p>The identifier of the routing profile.</p>
824
922
  */
825
923
  RoutingProfileId: string | undefined;
826
924
  /**
925
+ * @public
827
926
  * <p>The queues to associate with this routing profile.</p>
828
927
  */
829
928
  QueueConfigs: RoutingProfileQueueConfig[] | undefined;
@@ -833,10 +932,12 @@ export interface AssociateRoutingProfileQueuesRequest {
833
932
  */
834
933
  export interface AssociateSecurityKeyRequest {
835
934
  /**
935
+ * @public
836
936
  * <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>
837
937
  */
838
938
  InstanceId: string | undefined;
839
939
  /**
940
+ * @public
840
941
  * <p>A valid security key in PEM format.</p>
841
942
  */
842
943
  Key: string | undefined;
@@ -846,6 +947,7 @@ export interface AssociateSecurityKeyRequest {
846
947
  */
847
948
  export interface AssociateSecurityKeyResponse {
848
949
  /**
950
+ * @public
849
951
  * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
850
952
  */
851
953
  AssociationId?: string;
@@ -855,23 +957,28 @@ export interface AssociateSecurityKeyResponse {
855
957
  */
856
958
  export interface ClaimPhoneNumberRequest {
857
959
  /**
960
+ * @public
858
961
  * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
859
962
  */
860
963
  TargetArn: string | undefined;
861
964
  /**
965
+ * @public
862
966
  * <p>The phone number you want to claim. Phone numbers are formatted <code>[+] [country code]
863
967
  * [subscriber number including area code]</code>.</p>
864
968
  */
865
969
  PhoneNumber: string | undefined;
866
970
  /**
971
+ * @public
867
972
  * <p>The description of the phone number.</p>
868
973
  */
869
974
  PhoneNumberDescription?: string;
870
975
  /**
976
+ * @public
871
977
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
872
978
  */
873
979
  Tags?: Record<string, string>;
874
980
  /**
981
+ * @public
875
982
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
876
983
  * request. If not provided, the Amazon Web Services
877
984
  * SDK populates this field. For more information about idempotency, see
@@ -886,10 +993,12 @@ export interface ClaimPhoneNumberRequest {
886
993
  */
887
994
  export interface ClaimPhoneNumberResponse {
888
995
  /**
996
+ * @public
889
997
  * <p>A unique identifier for the phone number.</p>
890
998
  */
891
999
  PhoneNumberId?: string;
892
1000
  /**
1001
+ * @public
893
1002
  * <p>The Amazon Resource Name (ARN) of the phone number.</p>
894
1003
  */
895
1004
  PhoneNumberArn?: string;
@@ -912,26 +1021,32 @@ export declare class IdempotencyException extends __BaseException {
912
1021
  */
913
1022
  export interface CreateAgentStatusRequest {
914
1023
  /**
1024
+ * @public
915
1025
  * <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>
916
1026
  */
917
1027
  InstanceId: string | undefined;
918
1028
  /**
1029
+ * @public
919
1030
  * <p>The name of the status.</p>
920
1031
  */
921
1032
  Name: string | undefined;
922
1033
  /**
1034
+ * @public
923
1035
  * <p>The description of the status.</p>
924
1036
  */
925
1037
  Description?: string;
926
1038
  /**
1039
+ * @public
927
1040
  * <p>The state of the status.</p>
928
1041
  */
929
1042
  State: AgentStatusState | string | undefined;
930
1043
  /**
1044
+ * @public
931
1045
  * <p>The display order of the status.</p>
932
1046
  */
933
1047
  DisplayOrder?: number;
934
1048
  /**
1049
+ * @public
935
1050
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
936
1051
  */
937
1052
  Tags?: Record<string, string>;
@@ -941,10 +1056,12 @@ export interface CreateAgentStatusRequest {
941
1056
  */
942
1057
  export interface CreateAgentStatusResponse {
943
1058
  /**
1059
+ * @public
944
1060
  * <p>The Amazon Resource Name (ARN) of the agent status.</p>
945
1061
  */
946
1062
  AgentStatusARN?: string;
947
1063
  /**
1064
+ * @public
948
1065
  * <p>The identifier of the agent status.</p>
949
1066
  */
950
1067
  AgentStatusId?: string;
@@ -986,27 +1103,33 @@ export type ContactFlowType = (typeof ContactFlowType)[keyof typeof ContactFlowT
986
1103
  */
987
1104
  export interface CreateContactFlowRequest {
988
1105
  /**
1106
+ * @public
989
1107
  * <p>The identifier of the Amazon Connect instance.</p>
990
1108
  */
991
1109
  InstanceId: string | undefined;
992
1110
  /**
1111
+ * @public
993
1112
  * <p>The name of the flow.</p>
994
1113
  */
995
1114
  Name: string | undefined;
996
1115
  /**
1116
+ * @public
997
1117
  * <p>The type of the flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a flow type</a> in the <i>Amazon Connect Administrator
998
1118
  * Guide</i>.</p>
999
1119
  */
1000
1120
  Type: ContactFlowType | string | undefined;
1001
1121
  /**
1122
+ * @public
1002
1123
  * <p>The description of the flow. </p>
1003
1124
  */
1004
1125
  Description?: string;
1005
1126
  /**
1127
+ * @public
1006
1128
  * <p>The content of the flow. </p>
1007
1129
  */
1008
1130
  Content: string | undefined;
1009
1131
  /**
1132
+ * @public
1010
1133
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1011
1134
  */
1012
1135
  Tags?: Record<string, string>;
@@ -1016,10 +1139,12 @@ export interface CreateContactFlowRequest {
1016
1139
  */
1017
1140
  export interface CreateContactFlowResponse {
1018
1141
  /**
1142
+ * @public
1019
1143
  * <p>The identifier of the flow.</p>
1020
1144
  */
1021
1145
  ContactFlowId?: string;
1022
1146
  /**
1147
+ * @public
1023
1148
  * <p>The Amazon Resource Name (ARN) of the flow.</p>
1024
1149
  */
1025
1150
  ContactFlowArn?: string;
@@ -1030,6 +1155,7 @@ export interface CreateContactFlowResponse {
1030
1155
  */
1031
1156
  export interface ProblemDetail {
1032
1157
  /**
1158
+ * @public
1033
1159
  * <p>The problem detail's message.</p>
1034
1160
  */
1035
1161
  message?: string;
@@ -1042,6 +1168,7 @@ export declare class InvalidContactFlowException extends __BaseException {
1042
1168
  readonly name: "InvalidContactFlowException";
1043
1169
  readonly $fault: "client";
1044
1170
  /**
1171
+ * @public
1045
1172
  * <p>The problems with the flow. Please fix before trying again.</p>
1046
1173
  */
1047
1174
  problems?: ProblemDetail[];
@@ -1055,26 +1182,32 @@ export declare class InvalidContactFlowException extends __BaseException {
1055
1182
  */
1056
1183
  export interface CreateContactFlowModuleRequest {
1057
1184
  /**
1185
+ * @public
1058
1186
  * <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>
1059
1187
  */
1060
1188
  InstanceId: string | undefined;
1061
1189
  /**
1190
+ * @public
1062
1191
  * <p>The name of the flow module.</p>
1063
1192
  */
1064
1193
  Name: string | undefined;
1065
1194
  /**
1195
+ * @public
1066
1196
  * <p>The description of the flow module. </p>
1067
1197
  */
1068
1198
  Description?: string;
1069
1199
  /**
1200
+ * @public
1070
1201
  * <p>The content of the flow module.</p>
1071
1202
  */
1072
1203
  Content: string | undefined;
1073
1204
  /**
1205
+ * @public
1074
1206
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1075
1207
  */
1076
1208
  Tags?: Record<string, string>;
1077
1209
  /**
1210
+ * @public
1078
1211
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1079
1212
  * request. If not provided, the Amazon Web Services
1080
1213
  * SDK populates this field. For more information about idempotency, see
@@ -1087,10 +1220,12 @@ export interface CreateContactFlowModuleRequest {
1087
1220
  */
1088
1221
  export interface CreateContactFlowModuleResponse {
1089
1222
  /**
1223
+ * @public
1090
1224
  * <p>The identifier of the flow module.</p>
1091
1225
  */
1092
1226
  Id?: string;
1093
1227
  /**
1228
+ * @public
1094
1229
  * <p>The Amazon Resource Name (ARN) of the flow module.</p>
1095
1230
  */
1096
1231
  Arn?: string;
@@ -1164,6 +1299,7 @@ export type NumericQuestionPropertyAutomationLabel = (typeof NumericQuestionProp
1164
1299
  */
1165
1300
  export interface NumericQuestionPropertyValueAutomation {
1166
1301
  /**
1302
+ * @public
1167
1303
  * <p>The property label of the automation.</p>
1168
1304
  */
1169
1305
  Label: NumericQuestionPropertyAutomationLabel | string | undefined;
@@ -1178,12 +1314,16 @@ export type EvaluationFormNumericQuestionAutomation = EvaluationFormNumericQuest
1178
1314
  */
1179
1315
  export declare namespace EvaluationFormNumericQuestionAutomation {
1180
1316
  /**
1317
+ * @public
1181
1318
  * <p>The property value of the automation.</p>
1182
1319
  */
1183
1320
  interface PropertyValueMember {
1184
1321
  PropertyValue: NumericQuestionPropertyValueAutomation;
1185
1322
  $unknown?: never;
1186
1323
  }
1324
+ /**
1325
+ * @public
1326
+ */
1187
1327
  interface $UnknownMember {
1188
1328
  PropertyValue?: never;
1189
1329
  $unknown: [string, any];
@@ -1200,18 +1340,22 @@ export declare namespace EvaluationFormNumericQuestionAutomation {
1200
1340
  */
1201
1341
  export interface EvaluationFormNumericQuestionOption {
1202
1342
  /**
1343
+ * @public
1203
1344
  * <p>The minimum answer value of the range option.</p>
1204
1345
  */
1205
1346
  MinValue: number | undefined;
1206
1347
  /**
1348
+ * @public
1207
1349
  * <p>The maximum answer value of the range option.</p>
1208
1350
  */
1209
1351
  MaxValue: number | undefined;
1210
1352
  /**
1353
+ * @public
1211
1354
  * <p>The score assigned to answer values within the range option.</p>
1212
1355
  */
1213
1356
  Score?: number;
1214
1357
  /**
1358
+ * @public
1215
1359
  * <p>The flag to mark the option as automatic fail. If an automatic fail answer is provided, the
1216
1360
  * overall evaluation gets a score of 0.</p>
1217
1361
  */
@@ -1223,18 +1367,22 @@ export interface EvaluationFormNumericQuestionOption {
1223
1367
  */
1224
1368
  export interface EvaluationFormNumericQuestionProperties {
1225
1369
  /**
1370
+ * @public
1226
1371
  * <p>The minimum answer value.</p>
1227
1372
  */
1228
1373
  MinValue: number | undefined;
1229
1374
  /**
1375
+ * @public
1230
1376
  * <p>The maximum answer value.</p>
1231
1377
  */
1232
1378
  MaxValue: number | undefined;
1233
1379
  /**
1380
+ * @public
1234
1381
  * <p>The scoring options of the numeric question.</p>
1235
1382
  */
1236
1383
  Options?: EvaluationFormNumericQuestionOption[];
1237
1384
  /**
1385
+ * @public
1238
1386
  * <p>The automation properties of the numeric question.</p>
1239
1387
  */
1240
1388
  Automation?: EvaluationFormNumericQuestionAutomation;
@@ -1258,10 +1406,12 @@ export type SingleSelectQuestionRuleCategoryAutomationCondition = (typeof Single
1258
1406
  */
1259
1407
  export interface SingleSelectQuestionRuleCategoryAutomation {
1260
1408
  /**
1409
+ * @public
1261
1410
  * <p> The category name, as defined in Rules.</p>
1262
1411
  */
1263
1412
  Category: string | undefined;
1264
1413
  /**
1414
+ * @public
1265
1415
  * <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,
1266
1416
  * then the option is applied when the contact data includes the category. Similarly, if the
1267
1417
  * condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not
@@ -1269,6 +1419,7 @@ export interface SingleSelectQuestionRuleCategoryAutomation {
1269
1419
  */
1270
1420
  Condition: SingleSelectQuestionRuleCategoryAutomationCondition | string | undefined;
1271
1421
  /**
1422
+ * @public
1272
1423
  * <p>The identifier of the answer option.</p>
1273
1424
  */
1274
1425
  OptionRefId: string | undefined;
@@ -1283,12 +1434,16 @@ export type EvaluationFormSingleSelectQuestionAutomationOption = EvaluationFormS
1283
1434
  */
1284
1435
  export declare namespace EvaluationFormSingleSelectQuestionAutomationOption {
1285
1436
  /**
1437
+ * @public
1286
1438
  * <p>The automation option based on a rule category for the single select question.</p>
1287
1439
  */
1288
1440
  interface RuleCategoryMember {
1289
1441
  RuleCategory: SingleSelectQuestionRuleCategoryAutomation;
1290
1442
  $unknown?: never;
1291
1443
  }
1444
+ /**
1445
+ * @public
1446
+ */
1292
1447
  interface $UnknownMember {
1293
1448
  RuleCategory?: never;
1294
1449
  $unknown: [string, any];
@@ -1307,10 +1462,12 @@ export declare namespace EvaluationFormSingleSelectQuestionAutomationOption {
1307
1462
  */
1308
1463
  export interface EvaluationFormSingleSelectQuestionAutomation {
1309
1464
  /**
1465
+ * @public
1310
1466
  * <p>The automation options of the single select question.</p>
1311
1467
  */
1312
1468
  Options: EvaluationFormSingleSelectQuestionAutomationOption[] | undefined;
1313
1469
  /**
1470
+ * @public
1314
1471
  * <p>The identifier of the default answer option, when none of the automation options match the
1315
1472
  * criteria.</p>
1316
1473
  */
@@ -1334,19 +1491,23 @@ export type EvaluationFormSingleSelectQuestionDisplayMode = (typeof EvaluationFo
1334
1491
  */
1335
1492
  export interface EvaluationFormSingleSelectQuestionOption {
1336
1493
  /**
1494
+ * @public
1337
1495
  * <p>The identifier of the answer option. An identifier must be unique within the
1338
1496
  * question.</p>
1339
1497
  */
1340
1498
  RefId: string | undefined;
1341
1499
  /**
1500
+ * @public
1342
1501
  * <p>The title of the answer option.</p>
1343
1502
  */
1344
1503
  Text: string | undefined;
1345
1504
  /**
1505
+ * @public
1346
1506
  * <p>The score assigned to the answer option.</p>
1347
1507
  */
1348
1508
  Score?: number;
1349
1509
  /**
1510
+ * @public
1350
1511
  * <p>The flag to mark the option as automatic fail. If an automatic fail answer is provided, the
1351
1512
  * overall evaluation gets a score of 0.</p>
1352
1513
  */
@@ -1358,14 +1519,17 @@ export interface EvaluationFormSingleSelectQuestionOption {
1358
1519
  */
1359
1520
  export interface EvaluationFormSingleSelectQuestionProperties {
1360
1521
  /**
1522
+ * @public
1361
1523
  * <p>The answer options of the single select question.</p>
1362
1524
  */
1363
1525
  Options: EvaluationFormSingleSelectQuestionOption[] | undefined;
1364
1526
  /**
1527
+ * @public
1365
1528
  * <p>The display mode of the single select question.</p>
1366
1529
  */
1367
1530
  DisplayAs?: EvaluationFormSingleSelectQuestionDisplayMode | string;
1368
1531
  /**
1532
+ * @public
1369
1533
  * <p>The display mode of the single select question.</p>
1370
1534
  */
1371
1535
  Automation?: EvaluationFormSingleSelectQuestionAutomation;
@@ -1381,6 +1545,7 @@ export type EvaluationFormQuestionTypeProperties = EvaluationFormQuestionTypePro
1381
1545
  */
1382
1546
  export declare namespace EvaluationFormQuestionTypeProperties {
1383
1547
  /**
1548
+ * @public
1384
1549
  * <p>The properties of the numeric question.</p>
1385
1550
  */
1386
1551
  interface NumericMember {
@@ -1389,6 +1554,7 @@ export declare namespace EvaluationFormQuestionTypeProperties {
1389
1554
  $unknown?: never;
1390
1555
  }
1391
1556
  /**
1557
+ * @public
1392
1558
  * <p>The properties of the numeric question.</p>
1393
1559
  */
1394
1560
  interface SingleSelectMember {
@@ -1396,6 +1562,9 @@ export declare namespace EvaluationFormQuestionTypeProperties {
1396
1562
  SingleSelect: EvaluationFormSingleSelectQuestionProperties;
1397
1563
  $unknown?: never;
1398
1564
  }
1565
+ /**
1566
+ * @public
1567
+ */
1399
1568
  interface $UnknownMember {
1400
1569
  Numeric?: never;
1401
1570
  SingleSelect?: never;
@@ -1414,32 +1583,39 @@ export declare namespace EvaluationFormQuestionTypeProperties {
1414
1583
  */
1415
1584
  export interface EvaluationFormQuestion {
1416
1585
  /**
1586
+ * @public
1417
1587
  * <p>The title of the question.</p>
1418
1588
  */
1419
1589
  Title: string | undefined;
1420
1590
  /**
1591
+ * @public
1421
1592
  * <p>The instructions of the section.</p>
1422
1593
  */
1423
1594
  Instructions?: string;
1424
1595
  /**
1596
+ * @public
1425
1597
  * <p>The identifier of the question. An identifier must be unique within the evaluation
1426
1598
  * form.</p>
1427
1599
  */
1428
1600
  RefId: string | undefined;
1429
1601
  /**
1602
+ * @public
1430
1603
  * <p>The flag to enable not applicable answers to the question.</p>
1431
1604
  */
1432
1605
  NotApplicableEnabled?: boolean;
1433
1606
  /**
1607
+ * @public
1434
1608
  * <p>The type of the question.</p>
1435
1609
  */
1436
1610
  QuestionType: EvaluationFormQuestionType | string | undefined;
1437
1611
  /**
1612
+ * @public
1438
1613
  * <p>The properties of the type of question. Text questions do not have to define question type
1439
1614
  * properties.</p>
1440
1615
  */
1441
1616
  QuestionTypeProperties?: EvaluationFormQuestionTypeProperties;
1442
1617
  /**
1618
+ * @public
1443
1619
  * <p>The scoring weight of the section.</p>
1444
1620
  */
1445
1621
  Weight?: number;
@@ -1474,10 +1650,12 @@ export type EvaluationFormScoringStatus = (typeof EvaluationFormScoringStatus)[k
1474
1650
  */
1475
1651
  export interface EvaluationFormScoringStrategy {
1476
1652
  /**
1653
+ * @public
1477
1654
  * <p>The scoring mode of the evaluation form.</p>
1478
1655
  */
1479
1656
  Mode: EvaluationFormScoringMode | string | undefined;
1480
1657
  /**
1658
+ * @public
1481
1659
  * <p>The scoring status of the evaluation form.</p>
1482
1660
  */
1483
1661
  Status: EvaluationFormScoringStatus | string | undefined;
@@ -1487,10 +1665,12 @@ export interface EvaluationFormScoringStrategy {
1487
1665
  */
1488
1666
  export interface CreateEvaluationFormResponse {
1489
1667
  /**
1668
+ * @public
1490
1669
  * <p>The unique identifier for the evaluation form.</p>
1491
1670
  */
1492
1671
  EvaluationFormId: string | undefined;
1493
1672
  /**
1673
+ * @public
1494
1674
  * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
1495
1675
  */
1496
1676
  EvaluationFormArn: string | undefined;
@@ -1518,10 +1698,12 @@ export type HoursOfOperationDays = (typeof HoursOfOperationDays)[keyof typeof Ho
1518
1698
  */
1519
1699
  export interface HoursOfOperationTimeSlice {
1520
1700
  /**
1701
+ * @public
1521
1702
  * <p>The hours.</p>
1522
1703
  */
1523
1704
  Hours: number | undefined;
1524
1705
  /**
1706
+ * @public
1525
1707
  * <p>The minutes.</p>
1526
1708
  */
1527
1709
  Minutes: number | undefined;
@@ -1532,14 +1714,17 @@ export interface HoursOfOperationTimeSlice {
1532
1714
  */
1533
1715
  export interface HoursOfOperationConfig {
1534
1716
  /**
1717
+ * @public
1535
1718
  * <p>The day that the hours of operation applies to.</p>
1536
1719
  */
1537
1720
  Day: HoursOfOperationDays | string | undefined;
1538
1721
  /**
1722
+ * @public
1539
1723
  * <p>The start time that your contact center opens.</p>
1540
1724
  */
1541
1725
  StartTime: HoursOfOperationTimeSlice | undefined;
1542
1726
  /**
1727
+ * @public
1543
1728
  * <p>The end time that your contact center closes.</p>
1544
1729
  */
1545
1730
  EndTime: HoursOfOperationTimeSlice | undefined;
@@ -1549,26 +1734,32 @@ export interface HoursOfOperationConfig {
1549
1734
  */
1550
1735
  export interface CreateHoursOfOperationRequest {
1551
1736
  /**
1737
+ * @public
1552
1738
  * <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>
1553
1739
  */
1554
1740
  InstanceId: string | undefined;
1555
1741
  /**
1742
+ * @public
1556
1743
  * <p>The name of the hours of operation.</p>
1557
1744
  */
1558
1745
  Name: string | undefined;
1559
1746
  /**
1747
+ * @public
1560
1748
  * <p>The description of the hours of operation.</p>
1561
1749
  */
1562
1750
  Description?: string;
1563
1751
  /**
1752
+ * @public
1564
1753
  * <p>The time zone of the hours of operation.</p>
1565
1754
  */
1566
1755
  TimeZone: string | undefined;
1567
1756
  /**
1757
+ * @public
1568
1758
  * <p>Configuration information for the hours of operation: day, start time, and end time.</p>
1569
1759
  */
1570
1760
  Config: HoursOfOperationConfig[] | undefined;
1571
1761
  /**
1762
+ * @public
1572
1763
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1573
1764
  */
1574
1765
  Tags?: Record<string, string>;
@@ -1578,10 +1769,12 @@ export interface CreateHoursOfOperationRequest {
1578
1769
  */
1579
1770
  export interface CreateHoursOfOperationResponse {
1580
1771
  /**
1772
+ * @public
1581
1773
  * <p>The identifier for the hours of operation.</p>
1582
1774
  */
1583
1775
  HoursOfOperationId?: string;
1584
1776
  /**
1777
+ * @public
1585
1778
  * <p>The Amazon Resource Name (ARN) for the hours of operation.</p>
1586
1779
  */
1587
1780
  HoursOfOperationArn?: string;
@@ -1604,26 +1797,32 @@ export type DirectoryType = (typeof DirectoryType)[keyof typeof DirectoryType];
1604
1797
  */
1605
1798
  export interface CreateInstanceRequest {
1606
1799
  /**
1800
+ * @public
1607
1801
  * <p>The idempotency token.</p>
1608
1802
  */
1609
1803
  ClientToken?: string;
1610
1804
  /**
1805
+ * @public
1611
1806
  * <p>The type of identity management for your Amazon Connect users.</p>
1612
1807
  */
1613
1808
  IdentityManagementType: DirectoryType | string | undefined;
1614
1809
  /**
1810
+ * @public
1615
1811
  * <p>The name for your instance.</p>
1616
1812
  */
1617
1813
  InstanceAlias?: string;
1618
1814
  /**
1815
+ * @public
1619
1816
  * <p>The identifier for the directory.</p>
1620
1817
  */
1621
1818
  DirectoryId?: string;
1622
1819
  /**
1820
+ * @public
1623
1821
  * <p>Your contact center handles incoming contacts.</p>
1624
1822
  */
1625
1823
  InboundCallsEnabled: boolean | undefined;
1626
1824
  /**
1825
+ * @public
1627
1826
  * <p>Your contact center allows outbound calls.</p>
1628
1827
  */
1629
1828
  OutboundCallsEnabled: boolean | undefined;
@@ -1633,10 +1832,12 @@ export interface CreateInstanceRequest {
1633
1832
  */
1634
1833
  export interface CreateInstanceResponse {
1635
1834
  /**
1835
+ * @public
1636
1836
  * <p>The identifier for the instance.</p>
1637
1837
  */
1638
1838
  Id?: string;
1639
1839
  /**
1840
+ * @public
1640
1841
  * <p>The Amazon Resource Name (ARN) of the instance.</p>
1641
1842
  */
1642
1843
  Arn?: string;
@@ -1674,14 +1875,17 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
1674
1875
  */
1675
1876
  export interface CreateIntegrationAssociationRequest {
1676
1877
  /**
1878
+ * @public
1677
1879
  * <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>
1678
1880
  */
1679
1881
  InstanceId: string | undefined;
1680
1882
  /**
1883
+ * @public
1681
1884
  * <p>The type of information to be ingested.</p>
1682
1885
  */
1683
1886
  IntegrationType: IntegrationType | string | undefined;
1684
1887
  /**
1888
+ * @public
1685
1889
  * <p>The Amazon Resource Name (ARN) of the integration.</p>
1686
1890
  * <note>
1687
1891
  * <p>When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint
@@ -1690,18 +1894,22 @@ export interface CreateIntegrationAssociationRequest {
1690
1894
  */
1691
1895
  IntegrationArn: string | undefined;
1692
1896
  /**
1897
+ * @public
1693
1898
  * <p>The URL for the external application. This field is only required for the EVENT integration type.</p>
1694
1899
  */
1695
1900
  SourceApplicationUrl?: string;
1696
1901
  /**
1902
+ * @public
1697
1903
  * <p>The name of the external application. This field is only required for the EVENT integration type.</p>
1698
1904
  */
1699
1905
  SourceApplicationName?: string;
1700
1906
  /**
1907
+ * @public
1701
1908
  * <p>The type of the data source. This field is only required for the EVENT integration type.</p>
1702
1909
  */
1703
1910
  SourceType?: SourceType | string;
1704
1911
  /**
1912
+ * @public
1705
1913
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1706
1914
  */
1707
1915
  Tags?: Record<string, string>;
@@ -1711,10 +1919,12 @@ export interface CreateIntegrationAssociationRequest {
1711
1919
  */
1712
1920
  export interface CreateIntegrationAssociationResponse {
1713
1921
  /**
1922
+ * @public
1714
1923
  * <p>The identifier for the integration association.</p>
1715
1924
  */
1716
1925
  IntegrationAssociationId?: string;
1717
1926
  /**
1927
+ * @public
1718
1928
  * <p>The Amazon Resource Name (ARN) for the association.</p>
1719
1929
  */
1720
1930
  IntegrationAssociationArn?: string;
@@ -1739,10 +1949,12 @@ export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantR
1739
1949
  */
1740
1950
  export interface ParticipantDetailsToAdd {
1741
1951
  /**
1952
+ * @public
1742
1953
  * <p>The role of the participant being added.</p>
1743
1954
  */
1744
1955
  ParticipantRole?: ParticipantRole | string;
1745
1956
  /**
1957
+ * @public
1746
1958
  * <p>The display name of the participant.</p>
1747
1959
  */
1748
1960
  DisplayName?: string;
@@ -1752,14 +1964,17 @@ export interface ParticipantDetailsToAdd {
1752
1964
  */
1753
1965
  export interface CreateParticipantRequest {
1754
1966
  /**
1967
+ * @public
1755
1968
  * <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>
1756
1969
  */
1757
1970
  InstanceId: string | undefined;
1758
1971
  /**
1972
+ * @public
1759
1973
  * <p>The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.</p>
1760
1974
  */
1761
1975
  ContactId: string | undefined;
1762
1976
  /**
1977
+ * @public
1763
1978
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1764
1979
  * request. If not provided, the Amazon Web Services
1765
1980
  * SDK populates this field. For more information about idempotency, see
@@ -1767,6 +1982,7 @@ export interface CreateParticipantRequest {
1767
1982
  */
1768
1983
  ClientToken?: string;
1769
1984
  /**
1985
+ * @public
1770
1986
  * <p>Information identifying the participant.</p>
1771
1987
  * <important>
1772
1988
  * <p>The only Valid value for <code>ParticipantRole</code> is <code>CUSTOM_BOT</code>. </p>
@@ -1782,11 +1998,13 @@ export interface CreateParticipantRequest {
1782
1998
  */
1783
1999
  export interface ParticipantTokenCredentials {
1784
2000
  /**
2001
+ * @public
1785
2002
  * <p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat
1786
2003
  * participant. </p>
1787
2004
  */
1788
2005
  ParticipantToken?: string;
1789
2006
  /**
2007
+ * @public
1790
2008
  * <p>The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ.
1791
2009
  * For example, 2019-11-08T02:41:28.172Z.</p>
1792
2010
  */
@@ -1797,11 +2015,13 @@ export interface ParticipantTokenCredentials {
1797
2015
  */
1798
2016
  export interface CreateParticipantResponse {
1799
2017
  /**
2018
+ * @public
1800
2019
  * <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
1801
2020
  * participant token is valid for the lifetime of a chat participant.</p>
1802
2021
  */
1803
2022
  ParticipantCredentials?: ParticipantTokenCredentials;
1804
2023
  /**
2024
+ * @public
1805
2025
  * <p>The identifier for a chat participant. The participantId for a chat participant is the same
1806
2026
  * throughout the chat lifecycle.</p>
1807
2027
  */
@@ -1812,22 +2032,27 @@ export interface CreateParticipantResponse {
1812
2032
  */
1813
2033
  export interface CreatePromptRequest {
1814
2034
  /**
2035
+ * @public
1815
2036
  * <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>
1816
2037
  */
1817
2038
  InstanceId: string | undefined;
1818
2039
  /**
2040
+ * @public
1819
2041
  * <p>The name of the prompt.</p>
1820
2042
  */
1821
2043
  Name: string | undefined;
1822
2044
  /**
2045
+ * @public
1823
2046
  * <p>The description of the prompt.</p>
1824
2047
  */
1825
2048
  Description?: string;
1826
2049
  /**
2050
+ * @public
1827
2051
  * <p>The URI for the S3 bucket where the prompt is stored.</p>
1828
2052
  */
1829
2053
  S3Uri: string | undefined;
1830
2054
  /**
2055
+ * @public
1831
2056
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1832
2057
  */
1833
2058
  Tags?: Record<string, string>;
@@ -1837,10 +2062,12 @@ export interface CreatePromptRequest {
1837
2062
  */
1838
2063
  export interface CreatePromptResponse {
1839
2064
  /**
2065
+ * @public
1840
2066
  * <p>The Amazon Resource Name (ARN) of the prompt.</p>
1841
2067
  */
1842
2068
  PromptARN?: string;
1843
2069
  /**
2070
+ * @public
1844
2071
  * <p>A unique identifier for the prompt.</p>
1845
2072
  */
1846
2073
  PromptId?: string;
@@ -1851,14 +2078,17 @@ export interface CreatePromptResponse {
1851
2078
  */
1852
2079
  export interface OutboundCallerConfig {
1853
2080
  /**
2081
+ * @public
1854
2082
  * <p>The caller ID name.</p>
1855
2083
  */
1856
2084
  OutboundCallerIdName?: string;
1857
2085
  /**
2086
+ * @public
1858
2087
  * <p>The caller ID number.</p>
1859
2088
  */
1860
2089
  OutboundCallerIdNumberId?: string;
1861
2090
  /**
2091
+ * @public
1862
2092
  * <p>The outbound whisper flow to be used during an outbound call.</p>
1863
2093
  */
1864
2094
  OutboundFlowId?: string;
@@ -1868,34 +2098,42 @@ export interface OutboundCallerConfig {
1868
2098
  */
1869
2099
  export interface CreateQueueRequest {
1870
2100
  /**
2101
+ * @public
1871
2102
  * <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>
1872
2103
  */
1873
2104
  InstanceId: string | undefined;
1874
2105
  /**
2106
+ * @public
1875
2107
  * <p>The name of the queue.</p>
1876
2108
  */
1877
2109
  Name: string | undefined;
1878
2110
  /**
2111
+ * @public
1879
2112
  * <p>The description of the queue.</p>
1880
2113
  */
1881
2114
  Description?: string;
1882
2115
  /**
2116
+ * @public
1883
2117
  * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
1884
2118
  */
1885
2119
  OutboundCallerConfig?: OutboundCallerConfig;
1886
2120
  /**
2121
+ * @public
1887
2122
  * <p>The identifier for the hours of operation.</p>
1888
2123
  */
1889
2124
  HoursOfOperationId: string | undefined;
1890
2125
  /**
2126
+ * @public
1891
2127
  * <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
1892
2128
  */
1893
2129
  MaxContacts?: number;
1894
2130
  /**
2131
+ * @public
1895
2132
  * <p>The quick connects available to agents who are working the queue.</p>
1896
2133
  */
1897
2134
  QuickConnectIds?: string[];
1898
2135
  /**
2136
+ * @public
1899
2137
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1900
2138
  */
1901
2139
  Tags?: Record<string, string>;
@@ -1905,10 +2143,12 @@ export interface CreateQueueRequest {
1905
2143
  */
1906
2144
  export interface CreateQueueResponse {
1907
2145
  /**
2146
+ * @public
1908
2147
  * <p>The Amazon Resource Name (ARN) of the queue.</p>
1909
2148
  */
1910
2149
  QueueArn?: string;
1911
2150
  /**
2151
+ * @public
1912
2152
  * <p>The identifier for the queue.</p>
1913
2153
  */
1914
2154
  QueueId?: string;
@@ -1919,6 +2159,7 @@ export interface CreateQueueResponse {
1919
2159
  */
1920
2160
  export interface PhoneNumberQuickConnectConfig {
1921
2161
  /**
2162
+ * @public
1922
2163
  * <p>The phone number in E.164 format.</p>
1923
2164
  */
1924
2165
  PhoneNumber: string | undefined;
@@ -1930,10 +2171,12 @@ export interface PhoneNumberQuickConnectConfig {
1930
2171
  */
1931
2172
  export interface QueueQuickConnectConfig {
1932
2173
  /**
2174
+ * @public
1933
2175
  * <p>The identifier for the queue.</p>
1934
2176
  */
1935
2177
  QueueId: string | undefined;
1936
2178
  /**
2179
+ * @public
1937
2180
  * <p>The identifier of the flow.</p>
1938
2181
  */
1939
2182
  ContactFlowId: string | undefined;
@@ -1958,10 +2201,12 @@ export type QuickConnectType = (typeof QuickConnectType)[keyof typeof QuickConne
1958
2201
  */
1959
2202
  export interface UserQuickConnectConfig {
1960
2203
  /**
2204
+ * @public
1961
2205
  * <p>The identifier of the user.</p>
1962
2206
  */
1963
2207
  UserId: string | undefined;
1964
2208
  /**
2209
+ * @public
1965
2210
  * <p>The identifier of the flow.</p>
1966
2211
  */
1967
2212
  ContactFlowId: string | undefined;
@@ -1972,19 +2217,23 @@ export interface UserQuickConnectConfig {
1972
2217
  */
1973
2218
  export interface QuickConnectConfig {
1974
2219
  /**
2220
+ * @public
1975
2221
  * <p>The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are
1976
2222
  * prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). </p>
1977
2223
  */
1978
2224
  QuickConnectType: QuickConnectType | string | undefined;
1979
2225
  /**
2226
+ * @public
1980
2227
  * <p>The user configuration. This is required only if QuickConnectType is USER.</p>
1981
2228
  */
1982
2229
  UserConfig?: UserQuickConnectConfig;
1983
2230
  /**
2231
+ * @public
1984
2232
  * <p>The queue configuration. This is required only if QuickConnectType is QUEUE.</p>
1985
2233
  */
1986
2234
  QueueConfig?: QueueQuickConnectConfig;
1987
2235
  /**
2236
+ * @public
1988
2237
  * <p>The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.</p>
1989
2238
  */
1990
2239
  PhoneConfig?: PhoneNumberQuickConnectConfig;
@@ -1994,22 +2243,27 @@ export interface QuickConnectConfig {
1994
2243
  */
1995
2244
  export interface CreateQuickConnectRequest {
1996
2245
  /**
2246
+ * @public
1997
2247
  * <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>
1998
2248
  */
1999
2249
  InstanceId: string | undefined;
2000
2250
  /**
2251
+ * @public
2001
2252
  * <p>The name of the quick connect.</p>
2002
2253
  */
2003
2254
  Name: string | undefined;
2004
2255
  /**
2256
+ * @public
2005
2257
  * <p>The description of the quick connect.</p>
2006
2258
  */
2007
2259
  Description?: string;
2008
2260
  /**
2261
+ * @public
2009
2262
  * <p>Configuration settings for the quick connect.</p>
2010
2263
  */
2011
2264
  QuickConnectConfig: QuickConnectConfig | undefined;
2012
2265
  /**
2266
+ * @public
2013
2267
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2014
2268
  */
2015
2269
  Tags?: Record<string, string>;
@@ -2019,10 +2273,12 @@ export interface CreateQuickConnectRequest {
2019
2273
  */
2020
2274
  export interface CreateQuickConnectResponse {
2021
2275
  /**
2276
+ * @public
2022
2277
  * <p>The Amazon Resource Name (ARN) for the quick connect. </p>
2023
2278
  */
2024
2279
  QuickConnectARN?: string;
2025
2280
  /**
2281
+ * @public
2026
2282
  * <p>The identifier for the quick connect. </p>
2027
2283
  */
2028
2284
  QuickConnectId?: string;
@@ -2046,6 +2302,7 @@ export type BehaviorType = (typeof BehaviorType)[keyof typeof BehaviorType];
2046
2302
  */
2047
2303
  export interface CrossChannelBehavior {
2048
2304
  /**
2305
+ * @public
2049
2306
  * <p>Specifies the other channels that can be routed to an agent handling their current
2050
2307
  * channel.</p>
2051
2308
  */
@@ -2058,10 +2315,12 @@ export interface CrossChannelBehavior {
2058
2315
  */
2059
2316
  export interface MediaConcurrency {
2060
2317
  /**
2318
+ * @public
2061
2319
  * <p>The channels that agents can handle in the Contact Control Panel (CCP).</p>
2062
2320
  */
2063
2321
  Channel: Channel | string | undefined;
2064
2322
  /**
2323
+ * @public
2065
2324
  * <p>The number of contacts an agent can have on a channel simultaneously.</p>
2066
2325
  * <p>Valid Range for <code>VOICE</code>: Minimum value of 1. Maximum value of 1.</p>
2067
2326
  * <p>Valid Range for <code>CHAT</code>: Minimum value of 1. Maximum value of 10.</p>
@@ -2069,6 +2328,7 @@ export interface MediaConcurrency {
2069
2328
  */
2070
2329
  Concurrency: number | undefined;
2071
2330
  /**
2331
+ * @public
2072
2332
  * <p>Defines the cross-channel routing behavior for each channel that is enabled for this Routing
2073
2333
  * Profile. For example, this allows you to offer an agent a different contact from another channel
2074
2334
  * when they are currently working with a contact from a Voice channel.</p>
@@ -2080,22 +2340,27 @@ export interface MediaConcurrency {
2080
2340
  */
2081
2341
  export interface CreateRoutingProfileRequest {
2082
2342
  /**
2343
+ * @public
2083
2344
  * <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>
2084
2345
  */
2085
2346
  InstanceId: string | undefined;
2086
2347
  /**
2348
+ * @public
2087
2349
  * <p>The name of the routing profile. Must not be more than 127 characters.</p>
2088
2350
  */
2089
2351
  Name: string | undefined;
2090
2352
  /**
2353
+ * @public
2091
2354
  * <p>Description of the routing profile. Must not be more than 250 characters.</p>
2092
2355
  */
2093
2356
  Description: string | undefined;
2094
2357
  /**
2358
+ * @public
2095
2359
  * <p>The default outbound queue for the routing profile.</p>
2096
2360
  */
2097
2361
  DefaultOutboundQueueId: string | undefined;
2098
2362
  /**
2363
+ * @public
2099
2364
  * <p>The inbound queues associated with the routing profile. If no queue is added, the agent can
2100
2365
  * make only outbound calls.</p>
2101
2366
  * <p>The limit of 10 array members applies to the maximum number of
@@ -2106,24 +2371,37 @@ export interface CreateRoutingProfileRequest {
2106
2371
  */
2107
2372
  QueueConfigs?: RoutingProfileQueueConfig[];
2108
2373
  /**
2374
+ * @public
2109
2375
  * <p>The channels that agents can handle in the Contact Control Panel (CCP) for this routing
2110
2376
  * profile.</p>
2111
2377
  */
2112
2378
  MediaConcurrencies: MediaConcurrency[] | undefined;
2113
2379
  /**
2380
+ * @public
2114
2381
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2115
2382
  */
2116
2383
  Tags?: Record<string, string>;
2384
+ /**
2385
+ * @public
2386
+ * <p>Whether agents with this routing profile
2387
+ * will have their routing order calculated based on
2388
+ * <i>time since their last inbound
2389
+ * contact</i> or <i>longest idle
2390
+ * time</i>. </p>
2391
+ */
2392
+ AgentAvailabilityTimer?: AgentAvailabilityTimer | string;
2117
2393
  }
2118
2394
  /**
2119
2395
  * @public
2120
2396
  */
2121
2397
  export interface CreateRoutingProfileResponse {
2122
2398
  /**
2399
+ * @public
2123
2400
  * <p>The Amazon Resource Name (ARN) of the routing profile.</p>
2124
2401
  */
2125
2402
  RoutingProfileArn?: string;
2126
2403
  /**
2404
+ * @public
2127
2405
  * <p>The identifier of the routing profile.</p>
2128
2406
  */
2129
2407
  RoutingProfileId?: string;
@@ -2144,6 +2422,7 @@ export interface AssignContactCategoryActionDefinition {
2144
2422
  */
2145
2423
  export interface EventBridgeActionDefinition {
2146
2424
  /**
2425
+ * @public
2147
2426
  * <p>The name.</p>
2148
2427
  */
2149
2428
  Name: string | undefined;
@@ -2176,10 +2455,12 @@ export type NotificationDeliveryType = (typeof NotificationDeliveryType)[keyof t
2176
2455
  */
2177
2456
  export interface NotificationRecipientType {
2178
2457
  /**
2458
+ * @public
2179
2459
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}. Amazon Connect users with the specified tags will be notified.</p>
2180
2460
  */
2181
2461
  UserTags?: Record<string, string>;
2182
2462
  /**
2463
+ * @public
2183
2464
  * <p>A list of user IDs.</p>
2184
2465
  */
2185
2466
  UserIds?: string[];
@@ -2190,10 +2471,12 @@ export interface NotificationRecipientType {
2190
2471
  */
2191
2472
  export interface SendNotificationActionDefinition {
2192
2473
  /**
2474
+ * @public
2193
2475
  * <p>Notification delivery method.</p>
2194
2476
  */
2195
2477
  DeliveryMethod: NotificationDeliveryType | string | undefined;
2196
2478
  /**
2479
+ * @public
2197
2480
  * <p>The subject of the email if the delivery method is <code>EMAIL</code>.
2198
2481
  * Supports variable injection. For more information, see
2199
2482
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
@@ -2201,16 +2484,19 @@ export interface SendNotificationActionDefinition {
2201
2484
  */
2202
2485
  Subject?: string;
2203
2486
  /**
2487
+ * @public
2204
2488
  * <p>Notification content. Supports variable injection. For more information, see
2205
2489
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
2206
2490
  * in the <i>Amazon Connect Administrators Guide</i>.</p>
2207
2491
  */
2208
2492
  Content: string | undefined;
2209
2493
  /**
2494
+ * @public
2210
2495
  * <p>Content type format.</p>
2211
2496
  */
2212
2497
  ContentType: NotificationContentType | string | undefined;
2213
2498
  /**
2499
+ * @public
2214
2500
  * <p>Notification recipient.</p>
2215
2501
  */
2216
2502
  Recipient: NotificationRecipientType | undefined;
@@ -2238,11 +2524,13 @@ export type ReferenceType = (typeof ReferenceType)[keyof typeof ReferenceType];
2238
2524
  */
2239
2525
  export interface Reference {
2240
2526
  /**
2527
+ * @public
2241
2528
  * <p>A valid value for the reference. For example, for a URL reference, a formatted URL that is
2242
2529
  * displayed to an agent in the Contact Control Panel (CCP).</p>
2243
2530
  */
2244
2531
  Value: string | undefined;
2245
2532
  /**
2533
+ * @public
2246
2534
  * <p>The type of the reference. <code>DATE</code> must be of type Epoch timestamp.
2247
2535
  * </p>
2248
2536
  */
@@ -2254,22 +2542,26 @@ export interface Reference {
2254
2542
  */
2255
2543
  export interface TaskActionDefinition {
2256
2544
  /**
2545
+ * @public
2257
2546
  * <p>The name. Supports variable injection. For more information, see
2258
2547
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
2259
2548
  * in the <i>Amazon Connect Administrators Guide</i>.</p>
2260
2549
  */
2261
2550
  Name: string | undefined;
2262
2551
  /**
2552
+ * @public
2263
2553
  * <p>The description. Supports variable injection. For more information, see
2264
2554
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
2265
2555
  * in the <i>Amazon Connect Administrators Guide</i>.</p>
2266
2556
  */
2267
2557
  Description?: string;
2268
2558
  /**
2559
+ * @public
2269
2560
  * <p>The identifier of the flow.</p>
2270
2561
  */
2271
2562
  ContactFlowId: string | undefined;
2272
2563
  /**
2564
+ * @public
2273
2565
  * <p>Information about the reference when the <code>referenceType</code> is <code>URL</code>.
2274
2566
  * Otherwise, null. (Supports variable injection in the <code>Value</code> field.)</p>
2275
2567
  */
@@ -2281,10 +2573,12 @@ export interface TaskActionDefinition {
2281
2573
  */
2282
2574
  export interface RuleAction {
2283
2575
  /**
2576
+ * @public
2284
2577
  * <p>The type of action that creates a rule.</p>
2285
2578
  */
2286
2579
  ActionType: ActionType | string | undefined;
2287
2580
  /**
2581
+ * @public
2288
2582
  * <p>Information about the task action. This field is required if <code>TriggerEventSource</code>
2289
2583
  * is one of the following values: <code>OnZendeskTicketCreate</code> |
2290
2584
  * <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code>
@@ -2292,14 +2586,17 @@ export interface RuleAction {
2292
2586
  */
2293
2587
  TaskAction?: TaskActionDefinition;
2294
2588
  /**
2589
+ * @public
2295
2590
  * <p>Information about the EventBridge action.</p>
2296
2591
  */
2297
2592
  EventBridgeAction?: EventBridgeActionDefinition;
2298
2593
  /**
2594
+ * @public
2299
2595
  * <p>Information about the contact category action.</p>
2300
2596
  */
2301
2597
  AssignContactCategoryAction?: AssignContactCategoryActionDefinition;
2302
2598
  /**
2599
+ * @public
2303
2600
  * <p>Information about the send notification action.</p>
2304
2601
  */
2305
2602
  SendNotificationAction?: SendNotificationActionDefinition;
@@ -2342,10 +2639,12 @@ export type EventSourceName = (typeof EventSourceName)[keyof typeof EventSourceN
2342
2639
  */
2343
2640
  export interface RuleTriggerEventSource {
2344
2641
  /**
2642
+ * @public
2345
2643
  * <p>The name of the event source.</p>
2346
2644
  */
2347
2645
  EventSourceName: EventSourceName | string | undefined;
2348
2646
  /**
2647
+ * @public
2349
2648
  * <p>The identifier for the integration association.</p>
2350
2649
  */
2351
2650
  IntegrationAssociationId?: string;
@@ -2355,30 +2654,37 @@ export interface RuleTriggerEventSource {
2355
2654
  */
2356
2655
  export interface CreateRuleRequest {
2357
2656
  /**
2657
+ * @public
2358
2658
  * <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>
2359
2659
  */
2360
2660
  InstanceId: string | undefined;
2361
2661
  /**
2662
+ * @public
2362
2663
  * <p>A unique name for the rule.</p>
2363
2664
  */
2364
2665
  Name: string | undefined;
2365
2666
  /**
2667
+ * @public
2366
2668
  * <p>The event source to trigger the rule.</p>
2367
2669
  */
2368
2670
  TriggerEventSource: RuleTriggerEventSource | undefined;
2369
2671
  /**
2672
+ * @public
2370
2673
  * <p>The conditions of the rule.</p>
2371
2674
  */
2372
2675
  Function: string | undefined;
2373
2676
  /**
2677
+ * @public
2374
2678
  * <p>A list of actions to be run when the rule is triggered.</p>
2375
2679
  */
2376
2680
  Actions: RuleAction[] | undefined;
2377
2681
  /**
2682
+ * @public
2378
2683
  * <p>The publish status of the rule.</p>
2379
2684
  */
2380
2685
  PublishStatus: RulePublishStatus | string | undefined;
2381
2686
  /**
2687
+ * @public
2382
2688
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2383
2689
  * request. If not provided, the Amazon Web Services
2384
2690
  * SDK populates this field. For more information about idempotency, see
@@ -2391,10 +2697,12 @@ export interface CreateRuleRequest {
2391
2697
  */
2392
2698
  export interface CreateRuleResponse {
2393
2699
  /**
2700
+ * @public
2394
2701
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
2395
2702
  */
2396
2703
  RuleArn: string | undefined;
2397
2704
  /**
2705
+ * @public
2398
2706
  * <p>A unique identifier for the rule.</p>
2399
2707
  */
2400
2708
  RuleId: string | undefined;
@@ -2404,31 +2712,38 @@ export interface CreateRuleResponse {
2404
2712
  */
2405
2713
  export interface CreateSecurityProfileRequest {
2406
2714
  /**
2715
+ * @public
2407
2716
  * <p>The name of the security profile.</p>
2408
2717
  */
2409
2718
  SecurityProfileName: string | undefined;
2410
2719
  /**
2720
+ * @public
2411
2721
  * <p>The description of the security profile.</p>
2412
2722
  */
2413
2723
  Description?: string;
2414
2724
  /**
2725
+ * @public
2415
2726
  * <p>Permissions assigned to the security profile. For a list of valid permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security
2416
2727
  * profile permissions</a>. </p>
2417
2728
  */
2418
2729
  Permissions?: string[];
2419
2730
  /**
2731
+ * @public
2420
2732
  * <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>
2421
2733
  */
2422
2734
  InstanceId: string | undefined;
2423
2735
  /**
2736
+ * @public
2424
2737
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2425
2738
  */
2426
2739
  Tags?: Record<string, string>;
2427
2740
  /**
2741
+ * @public
2428
2742
  * <p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>
2429
2743
  */
2430
2744
  AllowedAccessControlTags?: Record<string, string>;
2431
2745
  /**
2746
+ * @public
2432
2747
  * <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code> |
2433
2748
  * <code>SecurityProfile</code> | <code>Queue</code> | <code>RoutingProfile</code>
2434
2749
  * </p>
@@ -2440,10 +2755,12 @@ export interface CreateSecurityProfileRequest {
2440
2755
  */
2441
2756
  export interface CreateSecurityProfileResponse {
2442
2757
  /**
2758
+ * @public
2443
2759
  * <p>The identifier for the security profle.</p>
2444
2760
  */
2445
2761
  SecurityProfileId?: string;
2446
2762
  /**
2763
+ * @public
2447
2764
  * <p>The Amazon Resource Name (ARN) for the security profile.</p>
2448
2765
  */
2449
2766
  SecurityProfileArn?: string;
@@ -2454,6 +2771,7 @@ export interface CreateSecurityProfileResponse {
2454
2771
  */
2455
2772
  export interface TaskTemplateFieldIdentifier {
2456
2773
  /**
2774
+ * @public
2457
2775
  * <p>The name of the task template field.</p>
2458
2776
  */
2459
2777
  Name?: string;
@@ -2464,6 +2782,7 @@ export interface TaskTemplateFieldIdentifier {
2464
2782
  */
2465
2783
  export interface InvisibleFieldInfo {
2466
2784
  /**
2785
+ * @public
2467
2786
  * <p>Identifier of the invisible field.</p>
2468
2787
  */
2469
2788
  Id?: TaskTemplateFieldIdentifier;
@@ -2474,6 +2793,7 @@ export interface InvisibleFieldInfo {
2474
2793
  */
2475
2794
  export interface ReadOnlyFieldInfo {
2476
2795
  /**
2796
+ * @public
2477
2797
  * <p>Identifier of the read-only field.</p>
2478
2798
  */
2479
2799
  Id?: TaskTemplateFieldIdentifier;
@@ -2484,6 +2804,7 @@ export interface ReadOnlyFieldInfo {
2484
2804
  */
2485
2805
  export interface RequiredFieldInfo {
2486
2806
  /**
2807
+ * @public
2487
2808
  * <p>The unique identifier for the field.</p>
2488
2809
  */
2489
2810
  Id?: TaskTemplateFieldIdentifier;
@@ -2494,14 +2815,17 @@ export interface RequiredFieldInfo {
2494
2815
  */
2495
2816
  export interface TaskTemplateConstraints {
2496
2817
  /**
2818
+ * @public
2497
2819
  * <p>Lists the fields that are required to be filled by agents.</p>
2498
2820
  */
2499
2821
  RequiredFields?: RequiredFieldInfo[];
2500
2822
  /**
2823
+ * @public
2501
2824
  * <p>Lists the fields that are read-only to agents, and cannot be edited.</p>
2502
2825
  */
2503
2826
  ReadOnlyFields?: ReadOnlyFieldInfo[];
2504
2827
  /**
2828
+ * @public
2505
2829
  * <p>Lists the fields that are invisible to agents.</p>
2506
2830
  */
2507
2831
  InvisibleFields?: InvisibleFieldInfo[];
@@ -2512,10 +2836,12 @@ export interface TaskTemplateConstraints {
2512
2836
  */
2513
2837
  export interface TaskTemplateDefaultFieldValue {
2514
2838
  /**
2839
+ * @public
2515
2840
  * <p>Identifier of a field. </p>
2516
2841
  */
2517
2842
  Id?: TaskTemplateFieldIdentifier;
2518
2843
  /**
2844
+ * @public
2519
2845
  * <p>Default value for the field.</p>
2520
2846
  */
2521
2847
  DefaultValue?: string;
@@ -2526,6 +2852,7 @@ export interface TaskTemplateDefaultFieldValue {
2526
2852
  */
2527
2853
  export interface TaskTemplateDefaults {
2528
2854
  /**
2855
+ * @public
2529
2856
  * <p>Default value for the field.</p>
2530
2857
  */
2531
2858
  DefaultFieldValues?: TaskTemplateDefaultFieldValue[];
@@ -2558,18 +2885,22 @@ export type TaskTemplateFieldType = (typeof TaskTemplateFieldType)[keyof typeof
2558
2885
  */
2559
2886
  export interface TaskTemplateField {
2560
2887
  /**
2888
+ * @public
2561
2889
  * <p>The unique identifier for the field.</p>
2562
2890
  */
2563
2891
  Id: TaskTemplateFieldIdentifier | undefined;
2564
2892
  /**
2893
+ * @public
2565
2894
  * <p>The description of the field.</p>
2566
2895
  */
2567
2896
  Description?: string;
2568
2897
  /**
2898
+ * @public
2569
2899
  * <p>Indicates the type of field.</p>
2570
2900
  */
2571
2901
  Type?: TaskTemplateFieldType | string;
2572
2902
  /**
2903
+ * @public
2573
2904
  * <p>A list of options for a single select field.</p>
2574
2905
  */
2575
2906
  SingleSelectOptions?: string[];
@@ -2591,40 +2922,49 @@ export type TaskTemplateStatus = (typeof TaskTemplateStatus)[keyof typeof TaskTe
2591
2922
  */
2592
2923
  export interface CreateTaskTemplateRequest {
2593
2924
  /**
2925
+ * @public
2594
2926
  * <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>
2595
2927
  */
2596
2928
  InstanceId: string | undefined;
2597
2929
  /**
2930
+ * @public
2598
2931
  * <p>The name of the task template.</p>
2599
2932
  */
2600
2933
  Name: string | undefined;
2601
2934
  /**
2935
+ * @public
2602
2936
  * <p>The description of the task template.</p>
2603
2937
  */
2604
2938
  Description?: string;
2605
2939
  /**
2940
+ * @public
2606
2941
  * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
2607
2942
  */
2608
2943
  ContactFlowId?: string;
2609
2944
  /**
2945
+ * @public
2610
2946
  * <p>Constraints that are applicable to the fields listed.</p>
2611
2947
  */
2612
2948
  Constraints?: TaskTemplateConstraints;
2613
2949
  /**
2950
+ * @public
2614
2951
  * <p>The default values for fields when a task is created by referencing this template.</p>
2615
2952
  */
2616
2953
  Defaults?: TaskTemplateDefaults;
2617
2954
  /**
2955
+ * @public
2618
2956
  * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
2619
2957
  * Tasks can only be created from <code>ACTIVE</code> templates.
2620
2958
  * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created. </p>
2621
2959
  */
2622
2960
  Status?: TaskTemplateStatus | string;
2623
2961
  /**
2962
+ * @public
2624
2963
  * <p>Fields that are part of the template.</p>
2625
2964
  */
2626
2965
  Fields: TaskTemplateField[] | undefined;
2627
2966
  /**
2967
+ * @public
2628
2968
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2629
2969
  * request. If not provided, the Amazon Web Services
2630
2970
  * SDK populates this field. For more information about idempotency, see
@@ -2637,10 +2977,12 @@ export interface CreateTaskTemplateRequest {
2637
2977
  */
2638
2978
  export interface CreateTaskTemplateResponse {
2639
2979
  /**
2980
+ * @public
2640
2981
  * <p>The identifier of the task template resource.</p>
2641
2982
  */
2642
2983
  Id: string | undefined;
2643
2984
  /**
2985
+ * @public
2644
2986
  * <p>The Amazon Resource Name (ARN) for the task template resource.</p>
2645
2987
  */
2646
2988
  Arn: string | undefined;
@@ -2667,14 +3009,17 @@ export type PropertyValidationExceptionReason = (typeof PropertyValidationExcept
2667
3009
  */
2668
3010
  export interface PropertyValidationExceptionProperty {
2669
3011
  /**
3012
+ * @public
2670
3013
  * <p>The full property path.</p>
2671
3014
  */
2672
3015
  PropertyPath: string | undefined;
2673
3016
  /**
3017
+ * @public
2674
3018
  * <p>Why the property is not valid.</p>
2675
3019
  */
2676
3020
  Reason: PropertyValidationExceptionReason | string | undefined;
2677
3021
  /**
3022
+ * @public
2678
3023
  * <p>A message describing why the property is not valid.</p>
2679
3024
  */
2680
3025
  Message: string | undefined;
@@ -2698,19 +3043,23 @@ export declare class PropertyValidationException extends __BaseException {
2698
3043
  */
2699
3044
  export interface CreateTrafficDistributionGroupRequest {
2700
3045
  /**
3046
+ * @public
2701
3047
  * <p>The name for the traffic distribution group. </p>
2702
3048
  */
2703
3049
  Name: string | undefined;
2704
3050
  /**
3051
+ * @public
2705
3052
  * <p>A description for the traffic distribution group.</p>
2706
3053
  */
2707
3054
  Description?: string;
2708
3055
  /**
3056
+ * @public
2709
3057
  * <p>The identifier of the Amazon Connect instance that has been replicated. You can find the
2710
3058
  * <code>instanceId</code> in the ARN of the instance.</p>
2711
3059
  */
2712
3060
  InstanceId: string | undefined;
2713
3061
  /**
3062
+ * @public
2714
3063
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2715
3064
  * request. If not provided, the Amazon Web Services
2716
3065
  * SDK populates this field. For more information about idempotency, see
@@ -2718,6 +3067,7 @@ export interface CreateTrafficDistributionGroupRequest {
2718
3067
  */
2719
3068
  ClientToken?: string;
2720
3069
  /**
3070
+ * @public
2721
3071
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2722
3072
  */
2723
3073
  Tags?: Record<string, string>;
@@ -2727,12 +3077,14 @@ export interface CreateTrafficDistributionGroupRequest {
2727
3077
  */
2728
3078
  export interface CreateTrafficDistributionGroupResponse {
2729
3079
  /**
3080
+ * @public
2730
3081
  * <p>The identifier of the traffic distribution group.
2731
3082
  * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
2732
3083
  * The ARN must be provided if the call is from the replicated Region.</p>
2733
3084
  */
2734
3085
  Id?: string;
2735
3086
  /**
3087
+ * @public
2736
3088
  * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
2737
3089
  */
2738
3090
  Arn?: string;
@@ -2767,19 +3119,23 @@ export type UseCaseType = (typeof UseCaseType)[keyof typeof UseCaseType];
2767
3119
  */
2768
3120
  export interface CreateUseCaseRequest {
2769
3121
  /**
3122
+ * @public
2770
3123
  * <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>
2771
3124
  */
2772
3125
  InstanceId: string | undefined;
2773
3126
  /**
3127
+ * @public
2774
3128
  * <p>The identifier for the integration association.</p>
2775
3129
  */
2776
3130
  IntegrationAssociationId: string | undefined;
2777
3131
  /**
3132
+ * @public
2778
3133
  * <p>The type of use case to associate to the integration association. Each integration
2779
3134
  * association can have only one of each use case type.</p>
2780
3135
  */
2781
3136
  UseCaseType: UseCaseType | string | undefined;
2782
3137
  /**
3138
+ * @public
2783
3139
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2784
3140
  */
2785
3141
  Tags?: Record<string, string>;
@@ -2789,10 +3145,12 @@ export interface CreateUseCaseRequest {
2789
3145
  */
2790
3146
  export interface CreateUseCaseResponse {
2791
3147
  /**
3148
+ * @public
2792
3149
  * <p>The identifier of the use case.</p>
2793
3150
  */
2794
3151
  UseCaseId?: string;
2795
3152
  /**
3153
+ * @public
2796
3154
  * <p>The Amazon Resource Name (ARN) for the use case.</p>
2797
3155
  */
2798
3156
  UseCaseArn?: string;
@@ -2803,21 +3161,25 @@ export interface CreateUseCaseResponse {
2803
3161
  */
2804
3162
  export interface UserIdentityInfo {
2805
3163
  /**
3164
+ * @public
2806
3165
  * <p>The first name. This is required if you are using Amazon Connect or SAML for identity
2807
3166
  * management.</p>
2808
3167
  */
2809
3168
  FirstName?: string;
2810
3169
  /**
3170
+ * @public
2811
3171
  * <p>The last name. This is required if you are using Amazon Connect or SAML for identity
2812
3172
  * management.</p>
2813
3173
  */
2814
3174
  LastName?: string;
2815
3175
  /**
3176
+ * @public
2816
3177
  * <p>The email address. If you are using SAML for identity management and include this parameter,
2817
3178
  * an error is returned.</p>
2818
3179
  */
2819
3180
  Email?: string;
2820
3181
  /**
3182
+ * @public
2821
3183
  * <p>The user's secondary email address. If you provide a secondary email, the user receives
2822
3184
  * email notifications - other than password reset notifications - to this email address instead of
2823
3185
  * to their primary email address.</p>
@@ -2826,6 +3188,7 @@ export interface UserIdentityInfo {
2826
3188
  */
2827
3189
  SecondaryEmail?: string;
2828
3190
  /**
3191
+ * @public
2829
3192
  * <p>The user's mobile number.</p>
2830
3193
  */
2831
3194
  Mobile?: string;
@@ -2848,14 +3211,17 @@ export type PhoneType = (typeof PhoneType)[keyof typeof PhoneType];
2848
3211
  */
2849
3212
  export interface UserPhoneConfig {
2850
3213
  /**
3214
+ * @public
2851
3215
  * <p>The phone type.</p>
2852
3216
  */
2853
3217
  PhoneType: PhoneType | string | undefined;
2854
3218
  /**
3219
+ * @public
2855
3220
  * <p>The Auto accept setting.</p>
2856
3221
  */
2857
3222
  AutoAccept?: boolean;
2858
3223
  /**
3224
+ * @public
2859
3225
  * <p>The After Call Work (ACW) timeout setting, in seconds.</p>
2860
3226
  * <note>
2861
3227
  * <p>When returned by a <code>SearchUsers</code> call, <code>AfterContactWorkTimeLimit</code> is
@@ -2864,6 +3230,7 @@ export interface UserPhoneConfig {
2864
3230
  */
2865
3231
  AfterContactWorkTimeLimit?: number;
2866
3232
  /**
3233
+ * @public
2867
3234
  * <p>The phone number for the user's desk phone.</p>
2868
3235
  */
2869
3236
  DeskPhoneNumber?: string;
@@ -2873,24 +3240,29 @@ export interface UserPhoneConfig {
2873
3240
  */
2874
3241
  export interface CreateUserRequest {
2875
3242
  /**
3243
+ * @public
2876
3244
  * <p>The user name for the account. For instances not using SAML for identity management, the
2877
3245
  * user name can include up to 20 characters. If you are using SAML for identity management, the
2878
3246
  * user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.</p>
2879
3247
  */
2880
3248
  Username: string | undefined;
2881
3249
  /**
3250
+ * @public
2882
3251
  * <p>The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.</p>
2883
3252
  */
2884
3253
  Password?: string;
2885
3254
  /**
3255
+ * @public
2886
3256
  * <p>The information about the identity of the user.</p>
2887
3257
  */
2888
3258
  IdentityInfo?: UserIdentityInfo;
2889
3259
  /**
3260
+ * @public
2890
3261
  * <p>The phone settings for the user.</p>
2891
3262
  */
2892
3263
  PhoneConfig: UserPhoneConfig | undefined;
2893
3264
  /**
3265
+ * @public
2894
3266
  * <p>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users.
2895
3267
  * If you include the identifier, we assume that Amazon Connect cannot access the directory.
2896
3268
  * Otherwise, the identity information is used to authenticate users from your directory.</p>
@@ -2901,22 +3273,27 @@ export interface CreateUserRequest {
2901
3273
  */
2902
3274
  DirectoryUserId?: string;
2903
3275
  /**
3276
+ * @public
2904
3277
  * <p>The identifier of the security profile for the user.</p>
2905
3278
  */
2906
3279
  SecurityProfileIds: string[] | undefined;
2907
3280
  /**
3281
+ * @public
2908
3282
  * <p>The identifier of the routing profile for the user.</p>
2909
3283
  */
2910
3284
  RoutingProfileId: string | undefined;
2911
3285
  /**
3286
+ * @public
2912
3287
  * <p>The identifier of the hierarchy group for the user.</p>
2913
3288
  */
2914
3289
  HierarchyGroupId?: string;
2915
3290
  /**
3291
+ * @public
2916
3292
  * <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>
2917
3293
  */
2918
3294
  InstanceId: string | undefined;
2919
3295
  /**
3296
+ * @public
2920
3297
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2921
3298
  */
2922
3299
  Tags?: Record<string, string>;
@@ -2926,10 +3303,12 @@ export interface CreateUserRequest {
2926
3303
  */
2927
3304
  export interface CreateUserResponse {
2928
3305
  /**
3306
+ * @public
2929
3307
  * <p>The identifier of the user account.</p>
2930
3308
  */
2931
3309
  UserId?: string;
2932
3310
  /**
3311
+ * @public
2933
3312
  * <p>The Amazon Resource Name (ARN) of the user account.</p>
2934
3313
  */
2935
3314
  UserArn?: string;
@@ -2939,19 +3318,23 @@ export interface CreateUserResponse {
2939
3318
  */
2940
3319
  export interface CreateUserHierarchyGroupRequest {
2941
3320
  /**
3321
+ * @public
2942
3322
  * <p>The name of the user hierarchy group. Must not be more than 100 characters.</p>
2943
3323
  */
2944
3324
  Name: string | undefined;
2945
3325
  /**
3326
+ * @public
2946
3327
  * <p>The identifier for the parent hierarchy group. The user hierarchy is created at level one if
2947
3328
  * the parent group ID is null.</p>
2948
3329
  */
2949
3330
  ParentGroupId?: string;
2950
3331
  /**
3332
+ * @public
2951
3333
  * <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>
2952
3334
  */
2953
3335
  InstanceId: string | undefined;
2954
3336
  /**
3337
+ * @public
2955
3338
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
2956
3339
  */
2957
3340
  Tags?: Record<string, string>;
@@ -2961,10 +3344,12 @@ export interface CreateUserHierarchyGroupRequest {
2961
3344
  */
2962
3345
  export interface CreateUserHierarchyGroupResponse {
2963
3346
  /**
3347
+ * @public
2964
3348
  * <p>The identifier of the hierarchy group.</p>
2965
3349
  */
2966
3350
  HierarchyGroupId?: string;
2967
3351
  /**
3352
+ * @public
2968
3353
  * <p>The Amazon Resource Name (ARN) of the hierarchy group. </p>
2969
3354
  */
2970
3355
  HierarchyGroupArn?: string;
@@ -2974,6 +3359,7 @@ export interface CreateUserHierarchyGroupResponse {
2974
3359
  */
2975
3360
  export interface CreateVocabularyRequest {
2976
3361
  /**
3362
+ * @public
2977
3363
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2978
3364
  * request. If not provided, the Amazon Web Services
2979
3365
  * SDK populates this field. For more information about idempotency, see
@@ -2982,20 +3368,24 @@ export interface CreateVocabularyRequest {
2982
3368
  */
2983
3369
  ClientToken?: string;
2984
3370
  /**
3371
+ * @public
2985
3372
  * <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>
2986
3373
  */
2987
3374
  InstanceId: string | undefined;
2988
3375
  /**
3376
+ * @public
2989
3377
  * <p>A unique name of the custom vocabulary.</p>
2990
3378
  */
2991
3379
  VocabularyName: string | undefined;
2992
3380
  /**
3381
+ * @public
2993
3382
  * <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
2994
3383
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
2995
3384
  * </p>
2996
3385
  */
2997
3386
  LanguageCode: VocabularyLanguageCode | string | undefined;
2998
3387
  /**
3388
+ * @public
2999
3389
  * <p>The content of the custom vocabulary in plain-text format with a table of values. Each row
3000
3390
  * in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>,
3001
3391
  * <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
@@ -3004,6 +3394,7 @@ export interface CreateVocabularyRequest {
3004
3394
  */
3005
3395
  Content: string | undefined;
3006
3396
  /**
3397
+ * @public
3007
3398
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
3008
3399
  */
3009
3400
  Tags?: Record<string, string>;
@@ -3027,14 +3418,17 @@ export type VocabularyState = (typeof VocabularyState)[keyof typeof VocabularySt
3027
3418
  */
3028
3419
  export interface CreateVocabularyResponse {
3029
3420
  /**
3421
+ * @public
3030
3422
  * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
3031
3423
  */
3032
3424
  VocabularyArn: string | undefined;
3033
3425
  /**
3426
+ * @public
3034
3427
  * <p>The identifier of the custom vocabulary.</p>
3035
3428
  */
3036
3429
  VocabularyId: string | undefined;
3037
3430
  /**
3431
+ * @public
3038
3432
  * <p>The current state of the custom vocabulary.</p>
3039
3433
  */
3040
3434
  State: VocabularyState | string | undefined;
@@ -3044,14 +3438,17 @@ export interface CreateVocabularyResponse {
3044
3438
  */
3045
3439
  export interface DeactivateEvaluationFormRequest {
3046
3440
  /**
3441
+ * @public
3047
3442
  * <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>
3048
3443
  */
3049
3444
  InstanceId: string | undefined;
3050
3445
  /**
3446
+ * @public
3051
3447
  * <p>The unique identifier for the evaluation form.</p>
3052
3448
  */
3053
3449
  EvaluationFormId: string | undefined;
3054
3450
  /**
3451
+ * @public
3055
3452
  * <p>A version of the evaluation form. If the version property is not provided, the latest version of the
3056
3453
  * evaluation form is deactivated.</p>
3057
3454
  */
@@ -3062,14 +3459,17 @@ export interface DeactivateEvaluationFormRequest {
3062
3459
  */
3063
3460
  export interface DeactivateEvaluationFormResponse {
3064
3461
  /**
3462
+ * @public
3065
3463
  * <p>The unique identifier for the evaluation form.</p>
3066
3464
  */
3067
3465
  EvaluationFormId: string | undefined;
3068
3466
  /**
3467
+ * @public
3069
3468
  * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
3070
3469
  */
3071
3470
  EvaluationFormArn: string | undefined;
3072
3471
  /**
3472
+ * @public
3073
3473
  * <p>The version of the deactivated evaluation form resource.</p>
3074
3474
  */
3075
3475
  EvaluationFormVersion: number | undefined;
@@ -3079,10 +3479,12 @@ export interface DeactivateEvaluationFormResponse {
3079
3479
  */
3080
3480
  export interface DeleteContactEvaluationRequest {
3081
3481
  /**
3482
+ * @public
3082
3483
  * <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>
3083
3484
  */
3084
3485
  InstanceId: string | undefined;
3085
3486
  /**
3487
+ * @public
3086
3488
  * <p>A unique identifier for the contact evaluation.</p>
3087
3489
  */
3088
3490
  EvaluationId: string | undefined;
@@ -3092,10 +3494,12 @@ export interface DeleteContactEvaluationRequest {
3092
3494
  */
3093
3495
  export interface DeleteContactFlowRequest {
3094
3496
  /**
3497
+ * @public
3095
3498
  * <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>
3096
3499
  */
3097
3500
  InstanceId: string | undefined;
3098
3501
  /**
3502
+ * @public
3099
3503
  * <p>The identifier of the flow.</p>
3100
3504
  */
3101
3505
  ContactFlowId: string | undefined;
@@ -3110,10 +3514,12 @@ export interface DeleteContactFlowResponse {
3110
3514
  */
3111
3515
  export interface DeleteContactFlowModuleRequest {
3112
3516
  /**
3517
+ * @public
3113
3518
  * <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>
3114
3519
  */
3115
3520
  InstanceId: string | undefined;
3116
3521
  /**
3522
+ * @public
3117
3523
  * <p>The identifier of the flow module.</p>
3118
3524
  */
3119
3525
  ContactFlowModuleId: string | undefined;
@@ -3128,14 +3534,17 @@ export interface DeleteContactFlowModuleResponse {
3128
3534
  */
3129
3535
  export interface DeleteEvaluationFormRequest {
3130
3536
  /**
3537
+ * @public
3131
3538
  * <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>
3132
3539
  */
3133
3540
  InstanceId: string | undefined;
3134
3541
  /**
3542
+ * @public
3135
3543
  * <p>The unique identifier for the evaluation form.</p>
3136
3544
  */
3137
3545
  EvaluationFormId: string | undefined;
3138
3546
  /**
3547
+ * @public
3139
3548
  * <p>The unique identifier for the evaluation form.</p>
3140
3549
  */
3141
3550
  EvaluationFormVersion?: number;
@@ -3145,10 +3554,12 @@ export interface DeleteEvaluationFormRequest {
3145
3554
  */
3146
3555
  export interface DeleteHoursOfOperationRequest {
3147
3556
  /**
3557
+ * @public
3148
3558
  * <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>
3149
3559
  */
3150
3560
  InstanceId: string | undefined;
3151
3561
  /**
3562
+ * @public
3152
3563
  * <p>The identifier for the hours of operation.</p>
3153
3564
  */
3154
3565
  HoursOfOperationId: string | undefined;
@@ -3158,6 +3569,7 @@ export interface DeleteHoursOfOperationRequest {
3158
3569
  */
3159
3570
  export interface DeleteInstanceRequest {
3160
3571
  /**
3572
+ * @public
3161
3573
  * <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>
3162
3574
  */
3163
3575
  InstanceId: string | undefined;
@@ -3167,10 +3579,12 @@ export interface DeleteInstanceRequest {
3167
3579
  */
3168
3580
  export interface DeleteIntegrationAssociationRequest {
3169
3581
  /**
3582
+ * @public
3170
3583
  * <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>
3171
3584
  */
3172
3585
  InstanceId: string | undefined;
3173
3586
  /**
3587
+ * @public
3174
3588
  * <p>The identifier for the integration association.</p>
3175
3589
  */
3176
3590
  IntegrationAssociationId: string | undefined;
@@ -3180,10 +3594,12 @@ export interface DeleteIntegrationAssociationRequest {
3180
3594
  */
3181
3595
  export interface DeletePromptRequest {
3182
3596
  /**
3597
+ * @public
3183
3598
  * <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>
3184
3599
  */
3185
3600
  InstanceId: string | undefined;
3186
3601
  /**
3602
+ * @public
3187
3603
  * <p>A unique identifier for the prompt.</p>
3188
3604
  */
3189
3605
  PromptId: string | undefined;
@@ -3193,10 +3609,12 @@ export interface DeletePromptRequest {
3193
3609
  */
3194
3610
  export interface DeleteQueueRequest {
3195
3611
  /**
3612
+ * @public
3196
3613
  * <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>
3197
3614
  */
3198
3615
  InstanceId: string | undefined;
3199
3616
  /**
3617
+ * @public
3200
3618
  * <p>The identifier for the queue.</p>
3201
3619
  */
3202
3620
  QueueId: string | undefined;
@@ -3227,10 +3645,12 @@ export declare class ResourceInUseException extends __BaseException {
3227
3645
  readonly $fault: "client";
3228
3646
  Message?: string;
3229
3647
  /**
3648
+ * @public
3230
3649
  * <p>The type of resource.</p>
3231
3650
  */
3232
3651
  ResourceType?: ResourceType | string;
3233
3652
  /**
3653
+ * @public
3234
3654
  * <p>The identifier for the resource.</p>
3235
3655
  */
3236
3656
  ResourceId?: string;
@@ -3244,10 +3664,12 @@ export declare class ResourceInUseException extends __BaseException {
3244
3664
  */
3245
3665
  export interface DeleteQuickConnectRequest {
3246
3666
  /**
3667
+ * @public
3247
3668
  * <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>
3248
3669
  */
3249
3670
  InstanceId: string | undefined;
3250
3671
  /**
3672
+ * @public
3251
3673
  * <p>The identifier for the quick connect.</p>
3252
3674
  */
3253
3675
  QuickConnectId: string | undefined;
@@ -3257,10 +3679,12 @@ export interface DeleteQuickConnectRequest {
3257
3679
  */
3258
3680
  export interface DeleteRoutingProfileRequest {
3259
3681
  /**
3682
+ * @public
3260
3683
  * <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>
3261
3684
  */
3262
3685
  InstanceId: string | undefined;
3263
3686
  /**
3687
+ * @public
3264
3688
  * <p>The identifier of the routing profile.</p>
3265
3689
  */
3266
3690
  RoutingProfileId: string | undefined;
@@ -3270,10 +3694,12 @@ export interface DeleteRoutingProfileRequest {
3270
3694
  */
3271
3695
  export interface DeleteRuleRequest {
3272
3696
  /**
3697
+ * @public
3273
3698
  * <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>
3274
3699
  */
3275
3700
  InstanceId: string | undefined;
3276
3701
  /**
3702
+ * @public
3277
3703
  * <p>A unique identifier for the rule.</p>
3278
3704
  */
3279
3705
  RuleId: string | undefined;
@@ -3283,10 +3709,12 @@ export interface DeleteRuleRequest {
3283
3709
  */
3284
3710
  export interface DeleteSecurityProfileRequest {
3285
3711
  /**
3712
+ * @public
3286
3713
  * <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>
3287
3714
  */
3288
3715
  InstanceId: string | undefined;
3289
3716
  /**
3717
+ * @public
3290
3718
  * <p>The identifier for the security profle.</p>
3291
3719
  */
3292
3720
  SecurityProfileId: string | undefined;
@@ -3296,10 +3724,12 @@ export interface DeleteSecurityProfileRequest {
3296
3724
  */
3297
3725
  export interface DeleteTaskTemplateRequest {
3298
3726
  /**
3727
+ * @public
3299
3728
  * <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>
3300
3729
  */
3301
3730
  InstanceId: string | undefined;
3302
3731
  /**
3732
+ * @public
3303
3733
  * <p>A unique identifier for the task template.</p>
3304
3734
  */
3305
3735
  TaskTemplateId: string | undefined;
@@ -3314,6 +3744,7 @@ export interface DeleteTaskTemplateResponse {
3314
3744
  */
3315
3745
  export interface DeleteTrafficDistributionGroupRequest {
3316
3746
  /**
3747
+ * @public
3317
3748
  * <p>The identifier of the traffic distribution group.
3318
3749
  * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
3319
3750
  * The ARN must be provided if the call is from the replicated Region.</p>
@@ -3330,14 +3761,17 @@ export interface DeleteTrafficDistributionGroupResponse {
3330
3761
  */
3331
3762
  export interface DeleteUseCaseRequest {
3332
3763
  /**
3764
+ * @public
3333
3765
  * <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>
3334
3766
  */
3335
3767
  InstanceId: string | undefined;
3336
3768
  /**
3769
+ * @public
3337
3770
  * <p>The identifier for the integration association.</p>
3338
3771
  */
3339
3772
  IntegrationAssociationId: string | undefined;
3340
3773
  /**
3774
+ * @public
3341
3775
  * <p>The identifier for the use case.</p>
3342
3776
  */
3343
3777
  UseCaseId: string | undefined;
@@ -3347,10 +3781,12 @@ export interface DeleteUseCaseRequest {
3347
3781
  */
3348
3782
  export interface DeleteUserRequest {
3349
3783
  /**
3784
+ * @public
3350
3785
  * <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>
3351
3786
  */
3352
3787
  InstanceId: string | undefined;
3353
3788
  /**
3789
+ * @public
3354
3790
  * <p>The identifier of the user.</p>
3355
3791
  */
3356
3792
  UserId: string | undefined;
@@ -3360,10 +3796,12 @@ export interface DeleteUserRequest {
3360
3796
  */
3361
3797
  export interface DeleteUserHierarchyGroupRequest {
3362
3798
  /**
3799
+ * @public
3363
3800
  * <p>The identifier of the hierarchy group.</p>
3364
3801
  */
3365
3802
  HierarchyGroupId: string | undefined;
3366
3803
  /**
3804
+ * @public
3367
3805
  * <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>
3368
3806
  */
3369
3807
  InstanceId: string | undefined;
@@ -3373,10 +3811,12 @@ export interface DeleteUserHierarchyGroupRequest {
3373
3811
  */
3374
3812
  export interface DeleteVocabularyRequest {
3375
3813
  /**
3814
+ * @public
3376
3815
  * <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>
3377
3816
  */
3378
3817
  InstanceId: string | undefined;
3379
3818
  /**
3819
+ * @public
3380
3820
  * <p>The identifier of the custom vocabulary.</p>
3381
3821
  */
3382
3822
  VocabularyId: string | undefined;
@@ -3386,14 +3826,17 @@ export interface DeleteVocabularyRequest {
3386
3826
  */
3387
3827
  export interface DeleteVocabularyResponse {
3388
3828
  /**
3829
+ * @public
3389
3830
  * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
3390
3831
  */
3391
3832
  VocabularyArn: string | undefined;
3392
3833
  /**
3834
+ * @public
3393
3835
  * <p>The identifier of the custom vocabulary.</p>
3394
3836
  */
3395
3837
  VocabularyId: string | undefined;
3396
3838
  /**
3839
+ * @public
3397
3840
  * <p>The current state of the custom vocabulary.</p>
3398
3841
  */
3399
3842
  State: VocabularyState | string | undefined;
@@ -3403,10 +3846,12 @@ export interface DeleteVocabularyResponse {
3403
3846
  */
3404
3847
  export interface DescribeAgentStatusRequest {
3405
3848
  /**
3849
+ * @public
3406
3850
  * <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>
3407
3851
  */
3408
3852
  InstanceId: string | undefined;
3409
3853
  /**
3854
+ * @public
3410
3855
  * <p>The identifier for the agent status.</p>
3411
3856
  */
3412
3857
  AgentStatusId: string | undefined;
@@ -3416,6 +3861,7 @@ export interface DescribeAgentStatusRequest {
3416
3861
  */
3417
3862
  export interface DescribeAgentStatusResponse {
3418
3863
  /**
3864
+ * @public
3419
3865
  * <p>The agent status.</p>
3420
3866
  */
3421
3867
  AgentStatus?: AgentStatus;
@@ -3425,10 +3871,12 @@ export interface DescribeAgentStatusResponse {
3425
3871
  */
3426
3872
  export interface DescribeContactRequest {
3427
3873
  /**
3874
+ * @public
3428
3875
  * <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>
3429
3876
  */
3430
3877
  InstanceId: string | undefined;
3431
3878
  /**
3879
+ * @public
3432
3880
  * <p>The identifier of the contact.</p>
3433
3881
  */
3434
3882
  ContactId: string | undefined;
@@ -3439,10 +3887,12 @@ export interface DescribeContactRequest {
3439
3887
  */
3440
3888
  export interface QueueInfo {
3441
3889
  /**
3890
+ * @public
3442
3891
  * <p>The unique identifier for the queue.</p>
3443
3892
  */
3444
3893
  Id?: string;
3445
3894
  /**
3895
+ * @public
3446
3896
  * <p>The timestamp when the contact was added to the queue.</p>
3447
3897
  */
3448
3898
  EnqueueTimestamp?: Date;
@@ -3453,6 +3903,7 @@ export interface QueueInfo {
3453
3903
  */
3454
3904
  export interface WisdomInfo {
3455
3905
  /**
3906
+ * @public
3456
3907
  * <p>The Amazon Resource Name (ARN) of the Wisdom session.</p>
3457
3908
  */
3458
3909
  SessionArn?: string;
@@ -3463,46 +3914,57 @@ export interface WisdomInfo {
3463
3914
  */
3464
3915
  export interface Contact {
3465
3916
  /**
3917
+ * @public
3466
3918
  * <p>The Amazon Resource Name (ARN) for the contact.</p>
3467
3919
  */
3468
3920
  Arn?: string;
3469
3921
  /**
3922
+ * @public
3470
3923
  * <p>The identifier for the contact.</p>
3471
3924
  */
3472
3925
  Id?: string;
3473
3926
  /**
3927
+ * @public
3474
3928
  * <p>If this contact is related to other contacts, this is the ID of the initial contact.</p>
3475
3929
  */
3476
3930
  InitialContactId?: string;
3477
3931
  /**
3932
+ * @public
3478
3933
  * <p>If this contact is not the first contact, this is the ID of the previous contact.</p>
3479
3934
  */
3480
3935
  PreviousContactId?: string;
3481
3936
  /**
3937
+ * @public
3482
3938
  * <p>Indicates how the contact was initiated.</p>
3483
3939
  */
3484
3940
  InitiationMethod?: ContactInitiationMethod | string;
3485
3941
  /**
3942
+ * @public
3486
3943
  * <p>The name of the contact.</p>
3487
3944
  */
3488
3945
  Name?: string;
3489
3946
  /**
3947
+ * @public
3490
3948
  * <p>The description of the contact.</p>
3491
3949
  */
3492
3950
  Description?: string;
3493
3951
  /**
3952
+ * @public
3494
3953
  * <p>How the contact reached your contact center.</p>
3495
3954
  */
3496
3955
  Channel?: Channel | string;
3497
3956
  /**
3957
+ * @public
3498
3958
  * <p>If this contact was queued, this contains information about the queue. </p>
3499
3959
  */
3500
3960
  QueueInfo?: QueueInfo;
3501
3961
  /**
3962
+ * @public
3502
3963
  * <p>Information about the agent who accepted the contact.</p>
3503
3964
  */
3504
3965
  AgentInfo?: AgentInfo;
3505
3966
  /**
3967
+ * @public
3506
3968
  * <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
3507
3969
  * when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
3508
3970
  * <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
@@ -3513,24 +3975,29 @@ export interface Contact {
3513
3975
  */
3514
3976
  InitiationTimestamp?: Date;
3515
3977
  /**
3978
+ * @public
3516
3979
  * <p>The timestamp when the customer endpoint disconnected from Amazon Connect.</p>
3517
3980
  */
3518
3981
  DisconnectTimestamp?: Date;
3519
3982
  /**
3983
+ * @public
3520
3984
  * <p>The timestamp when contact was last updated.</p>
3521
3985
  */
3522
3986
  LastUpdateTimestamp?: Date;
3523
3987
  /**
3988
+ * @public
3524
3989
  * <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
3525
3990
  * </p>
3526
3991
  */
3527
3992
  ScheduledTimestamp?: Date;
3528
3993
  /**
3994
+ * @public
3529
3995
  * <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid">related</a> to this
3530
3996
  * contact.</p>
3531
3997
  */
3532
3998
  RelatedContactId?: string;
3533
3999
  /**
4000
+ * @public
3534
4001
  * <p>Information about Amazon Connect Wisdom.</p>
3535
4002
  */
3536
4003
  WisdomInfo?: WisdomInfo;
@@ -3540,6 +4007,7 @@ export interface Contact {
3540
4007
  */
3541
4008
  export interface DescribeContactResponse {
3542
4009
  /**
4010
+ * @public
3543
4011
  * <p>Information about the contact.</p>
3544
4012
  */
3545
4013
  Contact?: Contact;
@@ -3549,10 +4017,12 @@ export interface DescribeContactResponse {
3549
4017
  */
3550
4018
  export interface DescribeContactEvaluationRequest {
3551
4019
  /**
4020
+ * @public
3552
4021
  * <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>
3553
4022
  */
3554
4023
  InstanceId: string | undefined;
3555
4024
  /**
4025
+ * @public
3556
4026
  * <p>A unique identifier for the contact evaluation.</p>
3557
4027
  */
3558
4028
  EvaluationId: string | undefined;
@@ -3568,6 +4038,7 @@ export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | Ev
3568
4038
  */
3569
4039
  export declare namespace EvaluationAnswerData {
3570
4040
  /**
4041
+ * @public
3571
4042
  * <p>The string value for an answer in a contact evaluation.</p>
3572
4043
  */
3573
4044
  interface StringValueMember {
@@ -3577,6 +4048,7 @@ export declare namespace EvaluationAnswerData {
3577
4048
  $unknown?: never;
3578
4049
  }
3579
4050
  /**
4051
+ * @public
3580
4052
  * <p>The numeric value for an answer in a contact evaluation.</p>
3581
4053
  */
3582
4054
  interface NumericValueMember {
@@ -3586,6 +4058,7 @@ export declare namespace EvaluationAnswerData {
3586
4058
  $unknown?: never;
3587
4059
  }
3588
4060
  /**
4061
+ * @public
3589
4062
  * <p>The flag to mark the question as not applicable.</p>
3590
4063
  */
3591
4064
  interface NotApplicableMember {
@@ -3594,6 +4067,9 @@ export declare namespace EvaluationAnswerData {
3594
4067
  NotApplicable: boolean;
3595
4068
  $unknown?: never;
3596
4069
  }
4070
+ /**
4071
+ * @public
4072
+ */
3597
4073
  interface $UnknownMember {
3598
4074
  StringValue?: never;
3599
4075
  NumericValue?: never;
@@ -3614,10 +4090,12 @@ export declare namespace EvaluationAnswerData {
3614
4090
  */
3615
4091
  export interface EvaluationAnswerOutput {
3616
4092
  /**
4093
+ * @public
3617
4094
  * <p>The value for an answer in a contact evaluation.</p>
3618
4095
  */
3619
4096
  Value?: EvaluationAnswerData;
3620
4097
  /**
4098
+ * @public
3621
4099
  * <p>The system suggested value for an answer in a contact evaluation.</p>
3622
4100
  */
3623
4101
  SystemSuggestedValue?: EvaluationAnswerData;
@@ -3628,14 +4106,17 @@ export interface EvaluationAnswerOutput {
3628
4106
  */
3629
4107
  export interface EvaluationScore {
3630
4108
  /**
4109
+ * @public
3631
4110
  * <p>The score percentage for an item in a contact evaluation.</p>
3632
4111
  */
3633
4112
  Percentage?: number;
3634
4113
  /**
4114
+ * @public
3635
4115
  * <p>The flag to mark the item as not applicable for scoring.</p>
3636
4116
  */
3637
4117
  NotApplicable?: boolean;
3638
4118
  /**
4119
+ * @public
3639
4120
  * <p>The flag that marks the item as automatic fail. If the item or a child item gets an
3640
4121
  * automatic fail answer, this flag will be true.</p>
3641
4122
  */
@@ -3647,18 +4128,22 @@ export interface EvaluationScore {
3647
4128
  */
3648
4129
  export interface EvaluationMetadata {
3649
4130
  /**
4131
+ * @public
3650
4132
  * <p>The identifier of the contact in this instance of Amazon Connect. </p>
3651
4133
  */
3652
4134
  ContactId: string | undefined;
3653
4135
  /**
4136
+ * @public
3654
4137
  * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
3655
4138
  */
3656
4139
  EvaluatorArn: string | undefined;
3657
4140
  /**
4141
+ * @public
3658
4142
  * <p>The identifier of the agent who performed the contact.</p>
3659
4143
  */
3660
4144
  ContactAgentId?: string;
3661
4145
  /**
4146
+ * @public
3662
4147
  * <p>The overall score of the contact evaluation.</p>
3663
4148
  */
3664
4149
  Score?: EvaluationScore;
@@ -3669,6 +4154,7 @@ export interface EvaluationMetadata {
3669
4154
  */
3670
4155
  export interface EvaluationNote {
3671
4156
  /**
4157
+ * @public
3672
4158
  * <p>The note for an item (section or question) in a contact evaluation.</p>
3673
4159
  */
3674
4160
  Value?: string;
@@ -3691,42 +4177,52 @@ export type EvaluationStatus = (typeof EvaluationStatus)[keyof typeof Evaluation
3691
4177
  */
3692
4178
  export interface Evaluation {
3693
4179
  /**
4180
+ * @public
3694
4181
  * <p>A unique identifier for the contact evaluation.</p>
3695
4182
  */
3696
4183
  EvaluationId: string | undefined;
3697
4184
  /**
4185
+ * @public
3698
4186
  * <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
3699
4187
  */
3700
4188
  EvaluationArn: string | undefined;
3701
4189
  /**
4190
+ * @public
3702
4191
  * <p>Metadata about the contact evaluation.</p>
3703
4192
  */
3704
4193
  Metadata: EvaluationMetadata | undefined;
3705
4194
  /**
4195
+ * @public
3706
4196
  * <p>A map of question identifiers to answer value.</p>
3707
4197
  */
3708
4198
  Answers: Record<string, EvaluationAnswerOutput> | undefined;
3709
4199
  /**
4200
+ * @public
3710
4201
  * <p>A map of question identifiers to note value.</p>
3711
4202
  */
3712
4203
  Notes: Record<string, EvaluationNote> | undefined;
3713
4204
  /**
4205
+ * @public
3714
4206
  * <p>The status of the contact evaluation.</p>
3715
4207
  */
3716
4208
  Status: EvaluationStatus | string | undefined;
3717
4209
  /**
4210
+ * @public
3718
4211
  * <p>A map of item (section or question) identifiers to score value.</p>
3719
4212
  */
3720
4213
  Scores?: Record<string, EvaluationScore>;
3721
4214
  /**
4215
+ * @public
3722
4216
  * <p>The timestamp for when the evaluation was created.</p>
3723
4217
  */
3724
4218
  CreatedTime: Date | undefined;
3725
4219
  /**
4220
+ * @public
3726
4221
  * <p>The timestamp for when the evaluation was last updated.</p>
3727
4222
  */
3728
4223
  LastModifiedTime: Date | undefined;
3729
4224
  /**
4225
+ * @public
3730
4226
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
3731
4227
  */
3732
4228
  Tags?: Record<string, string>;
@@ -3749,10 +4245,12 @@ export declare class ContactFlowNotPublishedException extends __BaseException {
3749
4245
  */
3750
4246
  export interface DescribeContactFlowRequest {
3751
4247
  /**
4248
+ * @public
3752
4249
  * <p>The identifier of the Amazon Connect instance.</p>
3753
4250
  */
3754
4251
  InstanceId: string | undefined;
3755
4252
  /**
4253
+ * @public
3756
4254
  * <p>The identifier of the flow.</p>
3757
4255
  */
3758
4256
  ContactFlowId: string | undefined;
@@ -3775,35 +4273,43 @@ export type ContactFlowState = (typeof ContactFlowState)[keyof typeof ContactFlo
3775
4273
  */
3776
4274
  export interface ContactFlow {
3777
4275
  /**
4276
+ * @public
3778
4277
  * <p>The Amazon Resource Name (ARN) of the flow.</p>
3779
4278
  */
3780
4279
  Arn?: string;
3781
4280
  /**
4281
+ * @public
3782
4282
  * <p>The identifier of the flow.</p>
3783
4283
  */
3784
4284
  Id?: string;
3785
4285
  /**
4286
+ * @public
3786
4287
  * <p>The name of the flow.</p>
3787
4288
  */
3788
4289
  Name?: string;
3789
4290
  /**
4291
+ * @public
3790
4292
  * <p>The type of the flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a flow type</a> in the <i>Amazon Connect Administrator
3791
4293
  * Guide</i>.</p>
3792
4294
  */
3793
4295
  Type?: ContactFlowType | string;
3794
4296
  /**
4297
+ * @public
3795
4298
  * <p>The type of flow.</p>
3796
4299
  */
3797
4300
  State?: ContactFlowState | string;
3798
4301
  /**
4302
+ * @public
3799
4303
  * <p>The description of the flow.</p>
3800
4304
  */
3801
4305
  Description?: string;
3802
4306
  /**
4307
+ * @public
3803
4308
  * <p>The content of the flow.</p>
3804
4309
  */
3805
4310
  Content?: string;
3806
4311
  /**
4312
+ * @public
3807
4313
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
3808
4314
  */
3809
4315
  Tags?: Record<string, string>;
@@ -3813,6 +4319,7 @@ export interface ContactFlow {
3813
4319
  */
3814
4320
  export interface DescribeContactFlowResponse {
3815
4321
  /**
4322
+ * @public
3816
4323
  * <p>Information about the flow.</p>
3817
4324
  */
3818
4325
  ContactFlow?: ContactFlow;
@@ -3822,10 +4329,12 @@ export interface DescribeContactFlowResponse {
3822
4329
  */
3823
4330
  export interface DescribeContactFlowModuleRequest {
3824
4331
  /**
4332
+ * @public
3825
4333
  * <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>
3826
4334
  */
3827
4335
  InstanceId: string | undefined;
3828
4336
  /**
4337
+ * @public
3829
4338
  * <p>The identifier of the flow module.</p>
3830
4339
  */
3831
4340
  ContactFlowModuleId: string | undefined;
@@ -3860,34 +4369,42 @@ export type ContactFlowModuleStatus = (typeof ContactFlowModuleStatus)[keyof typ
3860
4369
  */
3861
4370
  export interface ContactFlowModule {
3862
4371
  /**
4372
+ * @public
3863
4373
  * <p>The Amazon Resource Name (ARN).</p>
3864
4374
  */
3865
4375
  Arn?: string;
3866
4376
  /**
4377
+ * @public
3867
4378
  * <p>The identifier of the flow module.</p>
3868
4379
  */
3869
4380
  Id?: string;
3870
4381
  /**
4382
+ * @public
3871
4383
  * <p>The name of the flow module.</p>
3872
4384
  */
3873
4385
  Name?: string;
3874
4386
  /**
4387
+ * @public
3875
4388
  * <p>The content of the flow module.</p>
3876
4389
  */
3877
4390
  Content?: string;
3878
4391
  /**
4392
+ * @public
3879
4393
  * <p>The description of the flow module.</p>
3880
4394
  */
3881
4395
  Description?: string;
3882
4396
  /**
4397
+ * @public
3883
4398
  * <p>The type of flow module.</p>
3884
4399
  */
3885
4400
  State?: ContactFlowModuleState | string;
3886
4401
  /**
4402
+ * @public
3887
4403
  * <p>The status of the flow module.</p>
3888
4404
  */
3889
4405
  Status?: ContactFlowModuleStatus | string;
3890
4406
  /**
4407
+ * @public
3891
4408
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
3892
4409
  */
3893
4410
  Tags?: Record<string, string>;
@@ -3897,6 +4414,7 @@ export interface ContactFlowModule {
3897
4414
  */
3898
4415
  export interface DescribeContactFlowModuleResponse {
3899
4416
  /**
4417
+ * @public
3900
4418
  * <p>Information about the flow module.</p>
3901
4419
  */
3902
4420
  ContactFlowModule?: ContactFlowModule;
@@ -3906,14 +4424,17 @@ export interface DescribeContactFlowModuleResponse {
3906
4424
  */
3907
4425
  export interface DescribeEvaluationFormRequest {
3908
4426
  /**
4427
+ * @public
3909
4428
  * <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>
3910
4429
  */
3911
4430
  InstanceId: string | undefined;
3912
4431
  /**
4432
+ * @public
3913
4433
  * <p>A unique identifier for the contact evaluation.</p>
3914
4434
  */
3915
4435
  EvaluationFormId: string | undefined;
3916
4436
  /**
4437
+ * @public
3917
4438
  * <p>A version of the evaluation form.</p>
3918
4439
  */
3919
4440
  EvaluationFormVersion?: number;
@@ -3935,10 +4456,12 @@ export type EvaluationFormVersionStatus = (typeof EvaluationFormVersionStatus)[k
3935
4456
  */
3936
4457
  export interface DescribeHoursOfOperationRequest {
3937
4458
  /**
4459
+ * @public
3938
4460
  * <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>
3939
4461
  */
3940
4462
  InstanceId: string | undefined;
3941
4463
  /**
4464
+ * @public
3942
4465
  * <p>The identifier for the hours of operation.</p>
3943
4466
  */
3944
4467
  HoursOfOperationId: string | undefined;
@@ -3949,30 +4472,37 @@ export interface DescribeHoursOfOperationRequest {
3949
4472
  */
3950
4473
  export interface HoursOfOperation {
3951
4474
  /**
4475
+ * @public
3952
4476
  * <p>The identifier for the hours of operation.</p>
3953
4477
  */
3954
4478
  HoursOfOperationId?: string;
3955
4479
  /**
4480
+ * @public
3956
4481
  * <p>The Amazon Resource Name (ARN) for the hours of operation.</p>
3957
4482
  */
3958
4483
  HoursOfOperationArn?: string;
3959
4484
  /**
4485
+ * @public
3960
4486
  * <p>The name for the hours of operation.</p>
3961
4487
  */
3962
4488
  Name?: string;
3963
4489
  /**
4490
+ * @public
3964
4491
  * <p>The description for the hours of operation.</p>
3965
4492
  */
3966
4493
  Description?: string;
3967
4494
  /**
4495
+ * @public
3968
4496
  * <p>The time zone for the hours of operation.</p>
3969
4497
  */
3970
4498
  TimeZone?: string;
3971
4499
  /**
4500
+ * @public
3972
4501
  * <p>Configuration information for the hours of operation.</p>
3973
4502
  */
3974
4503
  Config?: HoursOfOperationConfig[];
3975
4504
  /**
4505
+ * @public
3976
4506
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
3977
4507
  */
3978
4508
  Tags?: Record<string, string>;
@@ -3982,6 +4512,7 @@ export interface HoursOfOperation {
3982
4512
  */
3983
4513
  export interface DescribeHoursOfOperationResponse {
3984
4514
  /**
4515
+ * @public
3985
4516
  * <p>The hours of operation.</p>
3986
4517
  */
3987
4518
  HoursOfOperation?: HoursOfOperation;
@@ -3991,6 +4522,7 @@ export interface DescribeHoursOfOperationResponse {
3991
4522
  */
3992
4523
  export interface DescribeInstanceRequest {
3993
4524
  /**
4525
+ * @public
3994
4526
  * <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>
3995
4527
  */
3996
4528
  InstanceId: string | undefined;
@@ -4015,6 +4547,7 @@ export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus
4015
4547
  */
4016
4548
  export interface InstanceStatusReason {
4017
4549
  /**
4550
+ * @public
4018
4551
  * <p>The message.</p>
4019
4552
  */
4020
4553
  Message?: string;
@@ -4025,47 +4558,58 @@ export interface InstanceStatusReason {
4025
4558
  */
4026
4559
  export interface Instance {
4027
4560
  /**
4561
+ * @public
4028
4562
  * <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>
4029
4563
  */
4030
4564
  Id?: string;
4031
4565
  /**
4566
+ * @public
4032
4567
  * <p>The Amazon Resource Name (ARN) of the instance.</p>
4033
4568
  */
4034
4569
  Arn?: string;
4035
4570
  /**
4571
+ * @public
4036
4572
  * <p>The identity management type.</p>
4037
4573
  */
4038
4574
  IdentityManagementType?: DirectoryType | string;
4039
4575
  /**
4576
+ * @public
4040
4577
  * <p>The alias of instance.</p>
4041
4578
  */
4042
4579
  InstanceAlias?: string;
4043
4580
  /**
4581
+ * @public
4044
4582
  * <p>When the instance was created.</p>
4045
4583
  */
4046
4584
  CreatedTime?: Date;
4047
4585
  /**
4586
+ * @public
4048
4587
  * <p>The service role of the instance.</p>
4049
4588
  */
4050
4589
  ServiceRole?: string;
4051
4590
  /**
4591
+ * @public
4052
4592
  * <p>The state of the instance.</p>
4053
4593
  */
4054
4594
  InstanceStatus?: InstanceStatus | string;
4055
4595
  /**
4596
+ * @public
4056
4597
  * <p>Relevant
4057
4598
  * details why the instance was not successfully created. </p>
4058
4599
  */
4059
4600
  StatusReason?: InstanceStatusReason;
4060
4601
  /**
4602
+ * @public
4061
4603
  * <p>Whether inbound calls are enabled.</p>
4062
4604
  */
4063
4605
  InboundCallsEnabled?: boolean;
4064
4606
  /**
4607
+ * @public
4065
4608
  * <p>Whether outbound calls are enabled.</p>
4066
4609
  */
4067
4610
  OutboundCallsEnabled?: boolean;
4068
4611
  /**
4612
+ * @public
4069
4613
  * <p>This URL allows contact center users to access the Amazon Connect admin website.</p>
4070
4614
  */
4071
4615
  InstanceAccessUrl?: string;
@@ -4075,6 +4619,7 @@ export interface Instance {
4075
4619
  */
4076
4620
  export interface DescribeInstanceResponse {
4077
4621
  /**
4622
+ * @public
4078
4623
  * <p>The name of the instance.</p>
4079
4624
  */
4080
4625
  Instance?: Instance;
@@ -4104,10 +4649,12 @@ export type InstanceAttributeType = (typeof InstanceAttributeType)[keyof typeof
4104
4649
  */
4105
4650
  export interface DescribeInstanceAttributeRequest {
4106
4651
  /**
4652
+ * @public
4107
4653
  * <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>
4108
4654
  */
4109
4655
  InstanceId: string | undefined;
4110
4656
  /**
4657
+ * @public
4111
4658
  * <p>The type of attribute.</p>
4112
4659
  */
4113
4660
  AttributeType: InstanceAttributeType | string | undefined;
@@ -4118,10 +4665,12 @@ export interface DescribeInstanceAttributeRequest {
4118
4665
  */
4119
4666
  export interface Attribute {
4120
4667
  /**
4668
+ * @public
4121
4669
  * <p>The type of attribute.</p>
4122
4670
  */
4123
4671
  AttributeType?: InstanceAttributeType | string;
4124
4672
  /**
4673
+ * @public
4125
4674
  * <p>The value of the attribute.</p>
4126
4675
  */
4127
4676
  Value?: string;
@@ -4131,6 +4680,7 @@ export interface Attribute {
4131
4680
  */
4132
4681
  export interface DescribeInstanceAttributeResponse {
4133
4682
  /**
4683
+ * @public
4134
4684
  * <p>The
4135
4685
  * type
4136
4686
  * of attribute.</p>
@@ -4142,14 +4692,17 @@ export interface DescribeInstanceAttributeResponse {
4142
4692
  */
4143
4693
  export interface DescribeInstanceStorageConfigRequest {
4144
4694
  /**
4695
+ * @public
4145
4696
  * <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>
4146
4697
  */
4147
4698
  InstanceId: string | undefined;
4148
4699
  /**
4700
+ * @public
4149
4701
  * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
4150
4702
  */
4151
4703
  AssociationId: string | undefined;
4152
4704
  /**
4705
+ * @public
4153
4706
  * <p>A valid resource type.</p>
4154
4707
  */
4155
4708
  ResourceType: InstanceStorageResourceType | string | undefined;
@@ -4159,6 +4712,7 @@ export interface DescribeInstanceStorageConfigRequest {
4159
4712
  */
4160
4713
  export interface DescribeInstanceStorageConfigResponse {
4161
4714
  /**
4715
+ * @public
4162
4716
  * <p>A valid storage type.</p>
4163
4717
  */
4164
4718
  StorageConfig?: InstanceStorageConfig;
@@ -4168,6 +4722,7 @@ export interface DescribeInstanceStorageConfigResponse {
4168
4722
  */
4169
4723
  export interface DescribePhoneNumberRequest {
4170
4724
  /**
4725
+ * @public
4171
4726
  * <p>A unique identifier for the phone number.</p>
4172
4727
  */
4173
4728
  PhoneNumberId: string | undefined;
@@ -4462,10 +5017,12 @@ export type PhoneNumberWorkflowStatus = (typeof PhoneNumberWorkflowStatus)[keyof
4462
5017
  */
4463
5018
  export interface PhoneNumberStatus {
4464
5019
  /**
5020
+ * @public
4465
5021
  * <p>The status.</p>
4466
5022
  */
4467
5023
  Status?: PhoneNumberWorkflowStatus | string;
4468
5024
  /**
5025
+ * @public
4469
5026
  * <p>The status message.</p>
4470
5027
  */
4471
5028
  Message?: string;
@@ -4493,38 +5050,47 @@ export type PhoneNumberType = (typeof PhoneNumberType)[keyof typeof PhoneNumberT
4493
5050
  */
4494
5051
  export interface ClaimedPhoneNumberSummary {
4495
5052
  /**
5053
+ * @public
4496
5054
  * <p>A unique identifier for the phone number.</p>
4497
5055
  */
4498
5056
  PhoneNumberId?: string;
4499
5057
  /**
5058
+ * @public
4500
5059
  * <p>The Amazon Resource Name (ARN) of the phone number.</p>
4501
5060
  */
4502
5061
  PhoneNumberArn?: string;
4503
5062
  /**
5063
+ * @public
4504
5064
  * <p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
4505
5065
  */
4506
5066
  PhoneNumber?: string;
4507
5067
  /**
5068
+ * @public
4508
5069
  * <p>The ISO country code.</p>
4509
5070
  */
4510
5071
  PhoneNumberCountryCode?: PhoneNumberCountryCode | string;
4511
5072
  /**
5073
+ * @public
4512
5074
  * <p>The type of phone number.</p>
4513
5075
  */
4514
5076
  PhoneNumberType?: PhoneNumberType | string;
4515
5077
  /**
5078
+ * @public
4516
5079
  * <p>The description of the phone number.</p>
4517
5080
  */
4518
5081
  PhoneNumberDescription?: string;
4519
5082
  /**
5083
+ * @public
4520
5084
  * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
4521
5085
  */
4522
5086
  TargetArn?: string;
4523
5087
  /**
5088
+ * @public
4524
5089
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4525
5090
  */
4526
5091
  Tags?: Record<string, string>;
4527
5092
  /**
5093
+ * @public
4528
5094
  * <p>The status of the phone number.</p>
4529
5095
  * <ul>
4530
5096
  * <li>
@@ -4562,6 +5128,7 @@ export interface ClaimedPhoneNumberSummary {
4562
5128
  */
4563
5129
  export interface DescribePhoneNumberResponse {
4564
5130
  /**
5131
+ * @public
4565
5132
  * <p>Information about a phone number that's been claimed to your Amazon Connect instance or
4566
5133
  * traffic distribution group.</p>
4567
5134
  */
@@ -4572,10 +5139,12 @@ export interface DescribePhoneNumberResponse {
4572
5139
  */
4573
5140
  export interface DescribePromptRequest {
4574
5141
  /**
5142
+ * @public
4575
5143
  * <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>
4576
5144
  */
4577
5145
  InstanceId: string | undefined;
4578
5146
  /**
5147
+ * @public
4579
5148
  * <p>A unique identifier for the prompt.</p>
4580
5149
  */
4581
5150
  PromptId: string | undefined;
@@ -4586,22 +5155,27 @@ export interface DescribePromptRequest {
4586
5155
  */
4587
5156
  export interface Prompt {
4588
5157
  /**
5158
+ * @public
4589
5159
  * <p>The Amazon Resource Name (ARN) of the prompt.</p>
4590
5160
  */
4591
5161
  PromptARN?: string;
4592
5162
  /**
5163
+ * @public
4593
5164
  * <p>A unique identifier for the prompt.</p>
4594
5165
  */
4595
5166
  PromptId?: string;
4596
5167
  /**
5168
+ * @public
4597
5169
  * <p>The name of the prompt.</p>
4598
5170
  */
4599
5171
  Name?: string;
4600
5172
  /**
5173
+ * @public
4601
5174
  * <p>The description of the prompt.</p>
4602
5175
  */
4603
5176
  Description?: string;
4604
5177
  /**
5178
+ * @public
4605
5179
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4606
5180
  */
4607
5181
  Tags?: Record<string, string>;
@@ -4611,6 +5185,7 @@ export interface Prompt {
4611
5185
  */
4612
5186
  export interface DescribePromptResponse {
4613
5187
  /**
5188
+ * @public
4614
5189
  * <p>Information about the prompt.</p>
4615
5190
  */
4616
5191
  Prompt?: Prompt;
@@ -4620,10 +5195,12 @@ export interface DescribePromptResponse {
4620
5195
  */
4621
5196
  export interface DescribeQueueRequest {
4622
5197
  /**
5198
+ * @public
4623
5199
  * <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>
4624
5200
  */
4625
5201
  InstanceId: string | undefined;
4626
5202
  /**
5203
+ * @public
4627
5204
  * <p>The identifier for the queue.</p>
4628
5205
  */
4629
5206
  QueueId: string | undefined;
@@ -4646,38 +5223,47 @@ export type QueueStatus = (typeof QueueStatus)[keyof typeof QueueStatus];
4646
5223
  */
4647
5224
  export interface Queue {
4648
5225
  /**
5226
+ * @public
4649
5227
  * <p>The name of the queue.</p>
4650
5228
  */
4651
5229
  Name?: string;
4652
5230
  /**
5231
+ * @public
4653
5232
  * <p>The Amazon Resource Name (ARN) for the queue.</p>
4654
5233
  */
4655
5234
  QueueArn?: string;
4656
5235
  /**
5236
+ * @public
4657
5237
  * <p>The identifier for the queue.</p>
4658
5238
  */
4659
5239
  QueueId?: string;
4660
5240
  /**
5241
+ * @public
4661
5242
  * <p>The description of the queue.</p>
4662
5243
  */
4663
5244
  Description?: string;
4664
5245
  /**
5246
+ * @public
4665
5247
  * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
4666
5248
  */
4667
5249
  OutboundCallerConfig?: OutboundCallerConfig;
4668
5250
  /**
5251
+ * @public
4669
5252
  * <p>The identifier for the hours of operation.</p>
4670
5253
  */
4671
5254
  HoursOfOperationId?: string;
4672
5255
  /**
5256
+ * @public
4673
5257
  * <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
4674
5258
  */
4675
5259
  MaxContacts?: number;
4676
5260
  /**
5261
+ * @public
4677
5262
  * <p>The status of the queue.</p>
4678
5263
  */
4679
5264
  Status?: QueueStatus | string;
4680
5265
  /**
5266
+ * @public
4681
5267
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4682
5268
  */
4683
5269
  Tags?: Record<string, string>;
@@ -4687,6 +5273,7 @@ export interface Queue {
4687
5273
  */
4688
5274
  export interface DescribeQueueResponse {
4689
5275
  /**
5276
+ * @public
4690
5277
  * <p>The name of the queue.</p>
4691
5278
  */
4692
5279
  Queue?: Queue;
@@ -4696,10 +5283,12 @@ export interface DescribeQueueResponse {
4696
5283
  */
4697
5284
  export interface DescribeQuickConnectRequest {
4698
5285
  /**
5286
+ * @public
4699
5287
  * <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>
4700
5288
  */
4701
5289
  InstanceId: string | undefined;
4702
5290
  /**
5291
+ * @public
4703
5292
  * <p>The identifier for the quick connect.</p>
4704
5293
  */
4705
5294
  QuickConnectId: string | undefined;
@@ -4710,26 +5299,32 @@ export interface DescribeQuickConnectRequest {
4710
5299
  */
4711
5300
  export interface QuickConnect {
4712
5301
  /**
5302
+ * @public
4713
5303
  * <p>The Amazon Resource Name (ARN) of the quick connect.</p>
4714
5304
  */
4715
5305
  QuickConnectARN?: string;
4716
5306
  /**
5307
+ * @public
4717
5308
  * <p>The identifier for the quick connect.</p>
4718
5309
  */
4719
5310
  QuickConnectId?: string;
4720
5311
  /**
5312
+ * @public
4721
5313
  * <p>The name of the quick connect.</p>
4722
5314
  */
4723
5315
  Name?: string;
4724
5316
  /**
5317
+ * @public
4725
5318
  * <p>The description.</p>
4726
5319
  */
4727
5320
  Description?: string;
4728
5321
  /**
5322
+ * @public
4729
5323
  * <p>Contains information about the quick connect.</p>
4730
5324
  */
4731
5325
  QuickConnectConfig?: QuickConnectConfig;
4732
5326
  /**
5327
+ * @public
4733
5328
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4734
5329
  */
4735
5330
  Tags?: Record<string, string>;
@@ -4739,6 +5334,7 @@ export interface QuickConnect {
4739
5334
  */
4740
5335
  export interface DescribeQuickConnectResponse {
4741
5336
  /**
5337
+ * @public
4742
5338
  * <p>Information about the quick connect.</p>
4743
5339
  */
4744
5340
  QuickConnect?: QuickConnect;
@@ -4748,10 +5344,12 @@ export interface DescribeQuickConnectResponse {
4748
5344
  */
4749
5345
  export interface DescribeRoutingProfileRequest {
4750
5346
  /**
5347
+ * @public
4751
5348
  * <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>
4752
5349
  */
4753
5350
  InstanceId: string | undefined;
4754
5351
  /**
5352
+ * @public
4755
5353
  * <p>The identifier of the routing profile.</p>
4756
5354
  */
4757
5355
  RoutingProfileId: string | undefined;
@@ -4762,52 +5360,72 @@ export interface DescribeRoutingProfileRequest {
4762
5360
  */
4763
5361
  export interface RoutingProfile {
4764
5362
  /**
5363
+ * @public
4765
5364
  * <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>
4766
5365
  */
4767
5366
  InstanceId?: string;
4768
5367
  /**
5368
+ * @public
4769
5369
  * <p>The name of the routing profile.</p>
4770
5370
  */
4771
5371
  Name?: string;
4772
5372
  /**
5373
+ * @public
4773
5374
  * <p>The Amazon Resource Name (ARN) of the routing profile.</p>
4774
5375
  */
4775
5376
  RoutingProfileArn?: string;
4776
5377
  /**
5378
+ * @public
4777
5379
  * <p>The identifier of the routing profile.</p>
4778
5380
  */
4779
5381
  RoutingProfileId?: string;
4780
5382
  /**
5383
+ * @public
4781
5384
  * <p>The description of the routing profile.</p>
4782
5385
  */
4783
5386
  Description?: string;
4784
5387
  /**
5388
+ * @public
4785
5389
  * <p>The channels agents can handle in the Contact Control Panel (CCP) for this routing
4786
5390
  * profile.</p>
4787
5391
  */
4788
5392
  MediaConcurrencies?: MediaConcurrency[];
4789
5393
  /**
5394
+ * @public
4790
5395
  * <p>The identifier of the default outbound queue for this routing profile.</p>
4791
5396
  */
4792
5397
  DefaultOutboundQueueId?: string;
4793
5398
  /**
5399
+ * @public
4794
5400
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4795
5401
  */
4796
5402
  Tags?: Record<string, string>;
4797
5403
  /**
5404
+ * @public
4798
5405
  * <p>The number of associated queues in routing profile.</p>
4799
5406
  */
4800
5407
  NumberOfAssociatedQueues?: number;
4801
5408
  /**
5409
+ * @public
4802
5410
  * <p>The number of associated users in routing profile.</p>
4803
5411
  */
4804
5412
  NumberOfAssociatedUsers?: number;
5413
+ /**
5414
+ * @public
5415
+ * <p>Whether agents with this routing profile
5416
+ * will have their routing order calculated based on
5417
+ * <i>time since their last inbound
5418
+ * contact</i> or <i>longest idle
5419
+ * time</i>. </p>
5420
+ */
5421
+ AgentAvailabilityTimer?: AgentAvailabilityTimer | string;
4805
5422
  }
4806
5423
  /**
4807
5424
  * @public
4808
5425
  */
4809
5426
  export interface DescribeRoutingProfileResponse {
4810
5427
  /**
5428
+ * @public
4811
5429
  * <p>The routing profile.</p>
4812
5430
  */
4813
5431
  RoutingProfile?: RoutingProfile;
@@ -4817,10 +5435,12 @@ export interface DescribeRoutingProfileResponse {
4817
5435
  */
4818
5436
  export interface DescribeRuleRequest {
4819
5437
  /**
5438
+ * @public
4820
5439
  * <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>
4821
5440
  */
4822
5441
  InstanceId: string | undefined;
4823
5442
  /**
5443
+ * @public
4824
5444
  * <p>A unique identifier for the rule.</p>
4825
5445
  */
4826
5446
  RuleId: string | undefined;
@@ -4831,46 +5451,57 @@ export interface DescribeRuleRequest {
4831
5451
  */
4832
5452
  export interface Rule {
4833
5453
  /**
5454
+ * @public
4834
5455
  * <p>The name of the rule.</p>
4835
5456
  */
4836
5457
  Name: string | undefined;
4837
5458
  /**
5459
+ * @public
4838
5460
  * <p>A unique identifier for the rule.</p>
4839
5461
  */
4840
5462
  RuleId: string | undefined;
4841
5463
  /**
5464
+ * @public
4842
5465
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
4843
5466
  */
4844
5467
  RuleArn: string | undefined;
4845
5468
  /**
5469
+ * @public
4846
5470
  * <p>The event source to trigger the rule.</p>
4847
5471
  */
4848
5472
  TriggerEventSource: RuleTriggerEventSource | undefined;
4849
5473
  /**
5474
+ * @public
4850
5475
  * <p>The conditions of the rule.</p>
4851
5476
  */
4852
5477
  Function: string | undefined;
4853
5478
  /**
5479
+ * @public
4854
5480
  * <p>A list of actions to be run when the rule is triggered.</p>
4855
5481
  */
4856
5482
  Actions: RuleAction[] | undefined;
4857
5483
  /**
5484
+ * @public
4858
5485
  * <p>The publish status of the rule.</p>
4859
5486
  */
4860
5487
  PublishStatus: RulePublishStatus | string | undefined;
4861
5488
  /**
5489
+ * @public
4862
5490
  * <p>The timestamp for when the rule was created.</p>
4863
5491
  */
4864
5492
  CreatedTime: Date | undefined;
4865
5493
  /**
5494
+ * @public
4866
5495
  * <p>The timestamp for the when the rule was last updated.</p>
4867
5496
  */
4868
5497
  LastUpdatedTime: Date | undefined;
4869
5498
  /**
5499
+ * @public
4870
5500
  * <p>The Amazon Resource Name (ARN) of the user who last updated the rule.</p>
4871
5501
  */
4872
5502
  LastUpdatedBy: string | undefined;
4873
5503
  /**
5504
+ * @public
4874
5505
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4875
5506
  */
4876
5507
  Tags?: Record<string, string>;
@@ -4880,6 +5511,7 @@ export interface Rule {
4880
5511
  */
4881
5512
  export interface DescribeRuleResponse {
4882
5513
  /**
5514
+ * @public
4883
5515
  * <p>Information about the rule.</p>
4884
5516
  */
4885
5517
  Rule: Rule | undefined;
@@ -4889,10 +5521,12 @@ export interface DescribeRuleResponse {
4889
5521
  */
4890
5522
  export interface DescribeSecurityProfileRequest {
4891
5523
  /**
5524
+ * @public
4892
5525
  * <p>The identifier for the security profle.</p>
4893
5526
  */
4894
5527
  SecurityProfileId: string | undefined;
4895
5528
  /**
5529
+ * @public
4896
5530
  * <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>
4897
5531
  */
4898
5532
  InstanceId: string | undefined;
@@ -4903,34 +5537,42 @@ export interface DescribeSecurityProfileRequest {
4903
5537
  */
4904
5538
  export interface SecurityProfile {
4905
5539
  /**
5540
+ * @public
4906
5541
  * <p>The identifier for the security profile.</p>
4907
5542
  */
4908
5543
  Id?: string;
4909
5544
  /**
5545
+ * @public
4910
5546
  * <p>The organization resource identifier for the security profile.</p>
4911
5547
  */
4912
5548
  OrganizationResourceId?: string;
4913
5549
  /**
5550
+ * @public
4914
5551
  * <p>The Amazon Resource Name (ARN) for the secruity profile.</p>
4915
5552
  */
4916
5553
  Arn?: string;
4917
5554
  /**
5555
+ * @public
4918
5556
  * <p>The name for the security profile.</p>
4919
5557
  */
4920
5558
  SecurityProfileName?: string;
4921
5559
  /**
5560
+ * @public
4922
5561
  * <p>The description of the security profile.</p>
4923
5562
  */
4924
5563
  Description?: string;
4925
5564
  /**
5565
+ * @public
4926
5566
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4927
5567
  */
4928
5568
  Tags?: Record<string, string>;
4929
5569
  /**
5570
+ * @public
4930
5571
  * <p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>
4931
5572
  */
4932
5573
  AllowedAccessControlTags?: Record<string, string>;
4933
5574
  /**
5575
+ * @public
4934
5576
  * <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</p>
4935
5577
  */
4936
5578
  TagRestrictedResources?: string[];
@@ -4940,6 +5582,7 @@ export interface SecurityProfile {
4940
5582
  */
4941
5583
  export interface DescribeSecurityProfileResponse {
4942
5584
  /**
5585
+ * @public
4943
5586
  * <p>The security profile.</p>
4944
5587
  */
4945
5588
  SecurityProfile?: SecurityProfile;
@@ -4949,6 +5592,7 @@ export interface DescribeSecurityProfileResponse {
4949
5592
  */
4950
5593
  export interface DescribeTrafficDistributionGroupRequest {
4951
5594
  /**
5595
+ * @public
4952
5596
  * <p>The identifier of the traffic distribution group.
4953
5597
  * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
4954
5598
  * The ARN must be provided if the call is from the replicated Region.</p>
@@ -4977,28 +5621,34 @@ export type TrafficDistributionGroupStatus = (typeof TrafficDistributionGroupSta
4977
5621
  */
4978
5622
  export interface TrafficDistributionGroup {
4979
5623
  /**
5624
+ * @public
4980
5625
  * <p>The identifier of the traffic distribution group.
4981
5626
  * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
4982
5627
  * The ARN must be provided if the call is from the replicated Region.</p>
4983
5628
  */
4984
5629
  Id?: string;
4985
5630
  /**
5631
+ * @public
4986
5632
  * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
4987
5633
  */
4988
5634
  Arn?: string;
4989
5635
  /**
5636
+ * @public
4990
5637
  * <p>The name of the traffic distribution group.</p>
4991
5638
  */
4992
5639
  Name?: string;
4993
5640
  /**
5641
+ * @public
4994
5642
  * <p>The description of the traffic distribution group.</p>
4995
5643
  */
4996
5644
  Description?: string;
4997
5645
  /**
5646
+ * @public
4998
5647
  * <p>The Amazon Resource Name (ARN).</p>
4999
5648
  */
5000
5649
  InstanceArn?: string;
5001
5650
  /**
5651
+ * @public
5002
5652
  * <p>The status of the traffic distribution group.</p>
5003
5653
  * <ul>
5004
5654
  * <li>
@@ -5032,6 +5682,7 @@ export interface TrafficDistributionGroup {
5032
5682
  */
5033
5683
  Status?: TrafficDistributionGroupStatus | string;
5034
5684
  /**
5685
+ * @public
5035
5686
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
5036
5687
  */
5037
5688
  Tags?: Record<string, string>;
@@ -5041,6 +5692,7 @@ export interface TrafficDistributionGroup {
5041
5692
  */
5042
5693
  export interface DescribeTrafficDistributionGroupResponse {
5043
5694
  /**
5695
+ * @public
5044
5696
  * <p>Information about the traffic distribution group.</p>
5045
5697
  */
5046
5698
  TrafficDistributionGroup?: TrafficDistributionGroup;
@@ -5050,10 +5702,12 @@ export interface DescribeTrafficDistributionGroupResponse {
5050
5702
  */
5051
5703
  export interface DescribeUserRequest {
5052
5704
  /**
5705
+ * @public
5053
5706
  * <p>The identifier of the user account.</p>
5054
5707
  */
5055
5708
  UserId: string | undefined;
5056
5709
  /**
5710
+ * @public
5057
5711
  * <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>
5058
5712
  */
5059
5713
  InstanceId: string | undefined;
@@ -5064,42 +5718,52 @@ export interface DescribeUserRequest {
5064
5718
  */
5065
5719
  export interface User {
5066
5720
  /**
5721
+ * @public
5067
5722
  * <p>The identifier of the user account.</p>
5068
5723
  */
5069
5724
  Id?: string;
5070
5725
  /**
5726
+ * @public
5071
5727
  * <p>The Amazon Resource Name (ARN) of the user account.</p>
5072
5728
  */
5073
5729
  Arn?: string;
5074
5730
  /**
5731
+ * @public
5075
5732
  * <p>The user name assigned to the user account.</p>
5076
5733
  */
5077
5734
  Username?: string;
5078
5735
  /**
5736
+ * @public
5079
5737
  * <p>Information about the user identity.</p>
5080
5738
  */
5081
5739
  IdentityInfo?: UserIdentityInfo;
5082
5740
  /**
5741
+ * @public
5083
5742
  * <p>Information about the phone configuration for the user.</p>
5084
5743
  */
5085
5744
  PhoneConfig?: UserPhoneConfig;
5086
5745
  /**
5746
+ * @public
5087
5747
  * <p>The identifier of the user account in the directory used for identity management.</p>
5088
5748
  */
5089
5749
  DirectoryUserId?: string;
5090
5750
  /**
5751
+ * @public
5091
5752
  * <p>The identifiers of the security profiles for the user.</p>
5092
5753
  */
5093
5754
  SecurityProfileIds?: string[];
5094
5755
  /**
5756
+ * @public
5095
5757
  * <p>The identifier of the routing profile for the user.</p>
5096
5758
  */
5097
5759
  RoutingProfileId?: string;
5098
5760
  /**
5761
+ * @public
5099
5762
  * <p>The identifier of the hierarchy group for the user.</p>
5100
5763
  */
5101
5764
  HierarchyGroupId?: string;
5102
5765
  /**
5766
+ * @public
5103
5767
  * <p>The
5104
5768
  * tags.</p>
5105
5769
  */
@@ -5110,6 +5774,7 @@ export interface User {
5110
5774
  */
5111
5775
  export interface DescribeUserResponse {
5112
5776
  /**
5777
+ * @public
5113
5778
  * <p>Information about the user account and configuration settings.</p>
5114
5779
  */
5115
5780
  User?: User;
@@ -5119,10 +5784,12 @@ export interface DescribeUserResponse {
5119
5784
  */
5120
5785
  export interface DescribeUserHierarchyGroupRequest {
5121
5786
  /**
5787
+ * @public
5122
5788
  * <p>The identifier of the hierarchy group.</p>
5123
5789
  */
5124
5790
  HierarchyGroupId: string | undefined;
5125
5791
  /**
5792
+ * @public
5126
5793
  * <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>
5127
5794
  */
5128
5795
  InstanceId: string | undefined;
@@ -5133,14 +5800,17 @@ export interface DescribeUserHierarchyGroupRequest {
5133
5800
  */
5134
5801
  export interface HierarchyGroupSummary {
5135
5802
  /**
5803
+ * @public
5136
5804
  * <p>The identifier of the hierarchy group.</p>
5137
5805
  */
5138
5806
  Id?: string;
5139
5807
  /**
5808
+ * @public
5140
5809
  * <p>The Amazon Resource Name (ARN) of the hierarchy group.</p>
5141
5810
  */
5142
5811
  Arn?: string;
5143
5812
  /**
5813
+ * @public
5144
5814
  * <p>The name of the hierarchy group.</p>
5145
5815
  */
5146
5816
  Name?: string;
@@ -5151,22 +5821,27 @@ export interface HierarchyGroupSummary {
5151
5821
  */
5152
5822
  export interface HierarchyPath {
5153
5823
  /**
5824
+ * @public
5154
5825
  * <p>Information about level one.</p>
5155
5826
  */
5156
5827
  LevelOne?: HierarchyGroupSummary;
5157
5828
  /**
5829
+ * @public
5158
5830
  * <p>Information about level two.</p>
5159
5831
  */
5160
5832
  LevelTwo?: HierarchyGroupSummary;
5161
5833
  /**
5834
+ * @public
5162
5835
  * <p>Information about level three.</p>
5163
5836
  */
5164
5837
  LevelThree?: HierarchyGroupSummary;
5165
5838
  /**
5839
+ * @public
5166
5840
  * <p>Information about level four.</p>
5167
5841
  */
5168
5842
  LevelFour?: HierarchyGroupSummary;
5169
5843
  /**
5844
+ * @public
5170
5845
  * <p>Information about level five.</p>
5171
5846
  */
5172
5847
  LevelFive?: HierarchyGroupSummary;
@@ -5177,26 +5852,32 @@ export interface HierarchyPath {
5177
5852
  */
5178
5853
  export interface HierarchyGroup {
5179
5854
  /**
5855
+ * @public
5180
5856
  * <p>The identifier of the hierarchy group.</p>
5181
5857
  */
5182
5858
  Id?: string;
5183
5859
  /**
5860
+ * @public
5184
5861
  * <p>The Amazon Resource Name (ARN) of the hierarchy group.</p>
5185
5862
  */
5186
5863
  Arn?: string;
5187
5864
  /**
5865
+ * @public
5188
5866
  * <p>The name of the hierarchy group.</p>
5189
5867
  */
5190
5868
  Name?: string;
5191
5869
  /**
5870
+ * @public
5192
5871
  * <p>The identifier of the level in the hierarchy group.</p>
5193
5872
  */
5194
5873
  LevelId?: string;
5195
5874
  /**
5875
+ * @public
5196
5876
  * <p>Information about the levels in the hierarchy group.</p>
5197
5877
  */
5198
5878
  HierarchyPath?: HierarchyPath;
5199
5879
  /**
5880
+ * @public
5200
5881
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
5201
5882
  */
5202
5883
  Tags?: Record<string, string>;
@@ -5206,6 +5887,7 @@ export interface HierarchyGroup {
5206
5887
  */
5207
5888
  export interface DescribeUserHierarchyGroupResponse {
5208
5889
  /**
5890
+ * @public
5209
5891
  * <p>Information about the hierarchy group.</p>
5210
5892
  */
5211
5893
  HierarchyGroup?: HierarchyGroup;
@@ -5215,6 +5897,7 @@ export interface DescribeUserHierarchyGroupResponse {
5215
5897
  */
5216
5898
  export interface DescribeUserHierarchyStructureRequest {
5217
5899
  /**
5900
+ * @public
5218
5901
  * <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>
5219
5902
  */
5220
5903
  InstanceId: string | undefined;
@@ -5225,14 +5908,17 @@ export interface DescribeUserHierarchyStructureRequest {
5225
5908
  */
5226
5909
  export interface HierarchyLevel {
5227
5910
  /**
5911
+ * @public
5228
5912
  * <p>The identifier of the hierarchy level.</p>
5229
5913
  */
5230
5914
  Id?: string;
5231
5915
  /**
5916
+ * @public
5232
5917
  * <p>The Amazon Resource Name (ARN) of the hierarchy level.</p>
5233
5918
  */
5234
5919
  Arn?: string;
5235
5920
  /**
5921
+ * @public
5236
5922
  * <p>The name of the hierarchy level.</p>
5237
5923
  */
5238
5924
  Name?: string;
@@ -5243,22 +5929,27 @@ export interface HierarchyLevel {
5243
5929
  */
5244
5930
  export interface HierarchyStructure {
5245
5931
  /**
5932
+ * @public
5246
5933
  * <p>Information about level one.</p>
5247
5934
  */
5248
5935
  LevelOne?: HierarchyLevel;
5249
5936
  /**
5937
+ * @public
5250
5938
  * <p>Information about level two.</p>
5251
5939
  */
5252
5940
  LevelTwo?: HierarchyLevel;
5253
5941
  /**
5942
+ * @public
5254
5943
  * <p>Information about level three.</p>
5255
5944
  */
5256
5945
  LevelThree?: HierarchyLevel;
5257
5946
  /**
5947
+ * @public
5258
5948
  * <p>Information about level four.</p>
5259
5949
  */
5260
5950
  LevelFour?: HierarchyLevel;
5261
5951
  /**
5952
+ * @public
5262
5953
  * <p>Information about level five.</p>
5263
5954
  */
5264
5955
  LevelFive?: HierarchyLevel;
@@ -5268,6 +5959,7 @@ export interface HierarchyStructure {
5268
5959
  */
5269
5960
  export interface DescribeUserHierarchyStructureResponse {
5270
5961
  /**
5962
+ * @public
5271
5963
  * <p>Information about the hierarchy structure.</p>
5272
5964
  */
5273
5965
  HierarchyStructure?: HierarchyStructure;
@@ -5277,10 +5969,12 @@ export interface DescribeUserHierarchyStructureResponse {
5277
5969
  */
5278
5970
  export interface DescribeVocabularyRequest {
5279
5971
  /**
5972
+ * @public
5280
5973
  * <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>
5281
5974
  */
5282
5975
  InstanceId: string | undefined;
5283
5976
  /**
5977
+ * @public
5284
5978
  * <p>The identifier of the custom vocabulary.</p>
5285
5979
  */
5286
5980
  VocabularyId: string | undefined;
@@ -5291,36 +5985,44 @@ export interface DescribeVocabularyRequest {
5291
5985
  */
5292
5986
  export interface Vocabulary {
5293
5987
  /**
5988
+ * @public
5294
5989
  * <p>A unique name of the custom vocabulary.</p>
5295
5990
  */
5296
5991
  Name: string | undefined;
5297
5992
  /**
5993
+ * @public
5298
5994
  * <p>The identifier of the custom vocabulary.</p>
5299
5995
  */
5300
5996
  Id: string | undefined;
5301
5997
  /**
5998
+ * @public
5302
5999
  * <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
5303
6000
  */
5304
6001
  Arn: string | undefined;
5305
6002
  /**
6003
+ * @public
5306
6004
  * <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
5307
6005
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
5308
6006
  * </p>
5309
6007
  */
5310
6008
  LanguageCode: VocabularyLanguageCode | string | undefined;
5311
6009
  /**
6010
+ * @public
5312
6011
  * <p>The current state of the custom vocabulary.</p>
5313
6012
  */
5314
6013
  State: VocabularyState | string | undefined;
5315
6014
  /**
6015
+ * @public
5316
6016
  * <p>The timestamp when the custom vocabulary was last modified.</p>
5317
6017
  */
5318
6018
  LastModifiedTime: Date | undefined;
5319
6019
  /**
6020
+ * @public
5320
6021
  * <p>The reason why the custom vocabulary was not created.</p>
5321
6022
  */
5322
6023
  FailureReason?: string;
5323
6024
  /**
6025
+ * @public
5324
6026
  * <p>The content of the custom vocabulary in plain-text format with a table of values. Each row
5325
6027
  * in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>,
5326
6028
  * <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
@@ -5329,6 +6031,7 @@ export interface Vocabulary {
5329
6031
  */
5330
6032
  Content?: string;
5331
6033
  /**
6034
+ * @public
5332
6035
  * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
5333
6036
  */
5334
6037
  Tags?: Record<string, string>;
@@ -5338,6 +6041,7 @@ export interface Vocabulary {
5338
6041
  */
5339
6042
  export interface DescribeVocabularyResponse {
5340
6043
  /**
6044
+ * @public
5341
6045
  * <p>A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are
5342
6046
  * generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper
5343
6047
  * nouns.</p>
@@ -5349,10 +6053,12 @@ export interface DescribeVocabularyResponse {
5349
6053
  */
5350
6054
  export interface DisassociateApprovedOriginRequest {
5351
6055
  /**
6056
+ * @public
5352
6057
  * <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>
5353
6058
  */
5354
6059
  InstanceId: string | undefined;
5355
6060
  /**
6061
+ * @public
5356
6062
  * <p>The domain URL of the integrated application.</p>
5357
6063
  */
5358
6064
  Origin: string | undefined;
@@ -5362,14 +6068,17 @@ export interface DisassociateApprovedOriginRequest {
5362
6068
  */
5363
6069
  export interface DisassociateBotRequest {
5364
6070
  /**
6071
+ * @public
5365
6072
  * <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>
5366
6073
  */
5367
6074
  InstanceId: string | undefined;
5368
6075
  /**
6076
+ * @public
5369
6077
  * <p>Configuration information of an Amazon Lex bot.</p>
5370
6078
  */
5371
6079
  LexBot?: LexBot;
5372
6080
  /**
6081
+ * @public
5373
6082
  * <p>The Amazon Lex V2 bot to disassociate from the instance.</p>
5374
6083
  */
5375
6084
  LexV2Bot?: LexV2Bot;
@@ -5379,14 +6088,17 @@ export interface DisassociateBotRequest {
5379
6088
  */
5380
6089
  export interface DisassociateInstanceStorageConfigRequest {
5381
6090
  /**
6091
+ * @public
5382
6092
  * <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>
5383
6093
  */
5384
6094
  InstanceId: string | undefined;
5385
6095
  /**
6096
+ * @public
5386
6097
  * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
5387
6098
  */
5388
6099
  AssociationId: string | undefined;
5389
6100
  /**
6101
+ * @public
5390
6102
  * <p>A valid resource type.</p>
5391
6103
  */
5392
6104
  ResourceType: InstanceStorageResourceType | string | undefined;
@@ -5396,10 +6108,12 @@ export interface DisassociateInstanceStorageConfigRequest {
5396
6108
  */
5397
6109
  export interface DisassociateLambdaFunctionRequest {
5398
6110
  /**
6111
+ * @public
5399
6112
  * <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>
5400
6113
  */
5401
6114
  InstanceId: string | undefined;
5402
6115
  /**
6116
+ * @public
5403
6117
  * <p>The Amazon Resource Name (ARN) of the Lambda function being disassociated.</p>
5404
6118
  */
5405
6119
  FunctionArn: string | undefined;
@@ -5409,14 +6123,17 @@ export interface DisassociateLambdaFunctionRequest {
5409
6123
  */
5410
6124
  export interface DisassociateLexBotRequest {
5411
6125
  /**
6126
+ * @public
5412
6127
  * <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>
5413
6128
  */
5414
6129
  InstanceId: string | undefined;
5415
6130
  /**
6131
+ * @public
5416
6132
  * <p>The name of the Amazon Lex bot. Maximum character limit of 50.</p>
5417
6133
  */
5418
6134
  BotName: string | undefined;
5419
6135
  /**
6136
+ * @public
5420
6137
  * <p>The Amazon Web Services Region in which the Amazon Lex bot has been created.</p>
5421
6138
  */
5422
6139
  LexRegion: string | undefined;
@@ -5426,10 +6143,12 @@ export interface DisassociateLexBotRequest {
5426
6143
  */
5427
6144
  export interface DisassociatePhoneNumberContactFlowRequest {
5428
6145
  /**
6146
+ * @public
5429
6147
  * <p>A unique identifier for the phone number.</p>
5430
6148
  */
5431
6149
  PhoneNumberId: string | undefined;
5432
6150
  /**
6151
+ * @public
5433
6152
  * <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>
5434
6153
  */
5435
6154
  InstanceId: string | undefined;
@@ -5439,14 +6158,17 @@ export interface DisassociatePhoneNumberContactFlowRequest {
5439
6158
  */
5440
6159
  export interface DisassociateQueueQuickConnectsRequest {
5441
6160
  /**
6161
+ * @public
5442
6162
  * <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>
5443
6163
  */
5444
6164
  InstanceId: string | undefined;
5445
6165
  /**
6166
+ * @public
5446
6167
  * <p>The identifier for the queue.</p>
5447
6168
  */
5448
6169
  QueueId: string | undefined;
5449
6170
  /**
6171
+ * @public
5450
6172
  * <p>The quick connects to disassociate from the queue.</p>
5451
6173
  */
5452
6174
  QuickConnectIds: string[] | undefined;
@@ -5456,14 +6178,17 @@ export interface DisassociateQueueQuickConnectsRequest {
5456
6178
  */
5457
6179
  export interface DisassociateRoutingProfileQueuesRequest {
5458
6180
  /**
6181
+ * @public
5459
6182
  * <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>
5460
6183
  */
5461
6184
  InstanceId: string | undefined;
5462
6185
  /**
6186
+ * @public
5463
6187
  * <p>The identifier of the routing profile.</p>
5464
6188
  */
5465
6189
  RoutingProfileId: string | undefined;
5466
6190
  /**
6191
+ * @public
5467
6192
  * <p>The queues to disassociate from this routing profile.</p>
5468
6193
  */
5469
6194
  QueueReferences: RoutingProfileQueueReference[] | undefined;
@@ -5473,10 +6198,12 @@ export interface DisassociateRoutingProfileQueuesRequest {
5473
6198
  */
5474
6199
  export interface DisassociateSecurityKeyRequest {
5475
6200
  /**
6201
+ * @public
5476
6202
  * <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>
5477
6203
  */
5478
6204
  InstanceId: string | undefined;
5479
6205
  /**
6206
+ * @public
5480
6207
  * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
5481
6208
  */
5482
6209
  AssociationId: string | undefined;
@@ -5486,15 +6213,18 @@ export interface DisassociateSecurityKeyRequest {
5486
6213
  */
5487
6214
  export interface DismissUserContactRequest {
5488
6215
  /**
6216
+ * @public
5489
6217
  * <p>The identifier of the user account.</p>
5490
6218
  */
5491
6219
  UserId: string | undefined;
5492
6220
  /**
6221
+ * @public
5493
6222
  * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
5494
6223
  * instance.</p>
5495
6224
  */
5496
6225
  InstanceId: string | undefined;
5497
6226
  /**
6227
+ * @public
5498
6228
  * <p>The identifier of the contact.</p>
5499
6229
  */
5500
6230
  ContactId: string | undefined;
@@ -5509,10 +6239,12 @@ export interface DismissUserContactResponse {
5509
6239
  */
5510
6240
  export interface GetContactAttributesRequest {
5511
6241
  /**
6242
+ * @public
5512
6243
  * <p>The identifier of the Amazon Connect instance.</p>
5513
6244
  */
5514
6245
  InstanceId: string | undefined;
5515
6246
  /**
6247
+ * @public
5516
6248
  * <p>The identifier of the initial contact.</p>
5517
6249
  */
5518
6250
  InitialContactId: string | undefined;
@@ -5522,6 +6254,7 @@ export interface GetContactAttributesRequest {
5522
6254
  */
5523
6255
  export interface GetContactAttributesResponse {
5524
6256
  /**
6257
+ * @public
5525
6258
  * <p>Information about the attributes.</p>
5526
6259
  */
5527
6260
  Attributes?: Record<string, string>;
@@ -5569,10 +6302,12 @@ export type Unit = (typeof Unit)[keyof typeof Unit];
5569
6302
  */
5570
6303
  export interface CurrentMetric {
5571
6304
  /**
6305
+ * @public
5572
6306
  * <p>The name of the metric.</p>
5573
6307
  */
5574
6308
  Name?: CurrentMetricName | string;
5575
6309
  /**
6310
+ * @public
5576
6311
  * <p>The unit for the metric.</p>
5577
6312
  */
5578
6313
  Unit?: Unit | string;
@@ -5583,16 +6318,19 @@ export interface CurrentMetric {
5583
6318
  */
5584
6319
  export interface Filters {
5585
6320
  /**
6321
+ * @public
5586
6322
  * <p>The queues to use to filter the metrics. You should specify at least one queue, and can
5587
6323
  * specify up to 100 queues per request. The <code>GetCurrentMetricsData</code> API in particular
5588
6324
  * requires a queue when you include a <code>Filter</code> in your request. </p>
5589
6325
  */
5590
6326
  Queues?: string[];
5591
6327
  /**
6328
+ * @public
5592
6329
  * <p>The channel to use to filter the metrics.</p>
5593
6330
  */
5594
6331
  Channels?: (Channel | string)[];
5595
6332
  /**
6333
+ * @public
5596
6334
  * <p>A list of up to 100 routing profile IDs or ARNs.</p>
5597
6335
  */
5598
6336
  RoutingProfiles?: string[];
@@ -5610,18 +6348,6 @@ export declare const Grouping: {
5610
6348
  * @public
5611
6349
  */
5612
6350
  export type Grouping = (typeof Grouping)[keyof typeof Grouping];
5613
- /**
5614
- * @public
5615
- * @enum
5616
- */
5617
- export declare const SortOrder: {
5618
- readonly ASCENDING: "ASCENDING";
5619
- readonly DESCENDING: "DESCENDING";
5620
- };
5621
- /**
5622
- * @public
5623
- */
5624
- export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
5625
6351
  /**
5626
6352
  * @internal
5627
6353
  */