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