forked from aws/aws-sdk-js-v3
/
CustomerProfiles.ts
1528 lines (1489 loc) · 64.8 KB
/
CustomerProfiles.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
import {
AddProfileKeyCommand,
AddProfileKeyCommandInput,
AddProfileKeyCommandOutput,
} from "./commands/AddProfileKeyCommand";
import {
CreateDomainCommand,
CreateDomainCommandInput,
CreateDomainCommandOutput,
} from "./commands/CreateDomainCommand";
import {
CreateIntegrationWorkflowCommand,
CreateIntegrationWorkflowCommandInput,
CreateIntegrationWorkflowCommandOutput,
} from "./commands/CreateIntegrationWorkflowCommand";
import {
CreateProfileCommand,
CreateProfileCommandInput,
CreateProfileCommandOutput,
} from "./commands/CreateProfileCommand";
import {
DeleteDomainCommand,
DeleteDomainCommandInput,
DeleteDomainCommandOutput,
} from "./commands/DeleteDomainCommand";
import {
DeleteIntegrationCommand,
DeleteIntegrationCommandInput,
DeleteIntegrationCommandOutput,
} from "./commands/DeleteIntegrationCommand";
import {
DeleteProfileCommand,
DeleteProfileCommandInput,
DeleteProfileCommandOutput,
} from "./commands/DeleteProfileCommand";
import {
DeleteProfileKeyCommand,
DeleteProfileKeyCommandInput,
DeleteProfileKeyCommandOutput,
} from "./commands/DeleteProfileKeyCommand";
import {
DeleteProfileObjectCommand,
DeleteProfileObjectCommandInput,
DeleteProfileObjectCommandOutput,
} from "./commands/DeleteProfileObjectCommand";
import {
DeleteProfileObjectTypeCommand,
DeleteProfileObjectTypeCommandInput,
DeleteProfileObjectTypeCommandOutput,
} from "./commands/DeleteProfileObjectTypeCommand";
import {
DeleteWorkflowCommand,
DeleteWorkflowCommandInput,
DeleteWorkflowCommandOutput,
} from "./commands/DeleteWorkflowCommand";
import {
GetAutoMergingPreviewCommand,
GetAutoMergingPreviewCommandInput,
GetAutoMergingPreviewCommandOutput,
} from "./commands/GetAutoMergingPreviewCommand";
import { GetDomainCommand, GetDomainCommandInput, GetDomainCommandOutput } from "./commands/GetDomainCommand";
import {
GetIdentityResolutionJobCommand,
GetIdentityResolutionJobCommandInput,
GetIdentityResolutionJobCommandOutput,
} from "./commands/GetIdentityResolutionJobCommand";
import {
GetIntegrationCommand,
GetIntegrationCommandInput,
GetIntegrationCommandOutput,
} from "./commands/GetIntegrationCommand";
import { GetMatchesCommand, GetMatchesCommandInput, GetMatchesCommandOutput } from "./commands/GetMatchesCommand";
import {
GetProfileObjectTypeCommand,
GetProfileObjectTypeCommandInput,
GetProfileObjectTypeCommandOutput,
} from "./commands/GetProfileObjectTypeCommand";
import {
GetProfileObjectTypeTemplateCommand,
GetProfileObjectTypeTemplateCommandInput,
GetProfileObjectTypeTemplateCommandOutput,
} from "./commands/GetProfileObjectTypeTemplateCommand";
import { GetWorkflowCommand, GetWorkflowCommandInput, GetWorkflowCommandOutput } from "./commands/GetWorkflowCommand";
import {
GetWorkflowStepsCommand,
GetWorkflowStepsCommandInput,
GetWorkflowStepsCommandOutput,
} from "./commands/GetWorkflowStepsCommand";
import {
ListAccountIntegrationsCommand,
ListAccountIntegrationsCommandInput,
ListAccountIntegrationsCommandOutput,
} from "./commands/ListAccountIntegrationsCommand";
import { ListDomainsCommand, ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
import {
ListIdentityResolutionJobsCommand,
ListIdentityResolutionJobsCommandInput,
ListIdentityResolutionJobsCommandOutput,
} from "./commands/ListIdentityResolutionJobsCommand";
import {
ListIntegrationsCommand,
ListIntegrationsCommandInput,
ListIntegrationsCommandOutput,
} from "./commands/ListIntegrationsCommand";
import {
ListProfileObjectsCommand,
ListProfileObjectsCommandInput,
ListProfileObjectsCommandOutput,
} from "./commands/ListProfileObjectsCommand";
import {
ListProfileObjectTypesCommand,
ListProfileObjectTypesCommandInput,
ListProfileObjectTypesCommandOutput,
} from "./commands/ListProfileObjectTypesCommand";
import {
ListProfileObjectTypeTemplatesCommand,
ListProfileObjectTypeTemplatesCommandInput,
ListProfileObjectTypeTemplatesCommandOutput,
} from "./commands/ListProfileObjectTypeTemplatesCommand";
import {
ListTagsForResourceCommand,
ListTagsForResourceCommandInput,
ListTagsForResourceCommandOutput,
} from "./commands/ListTagsForResourceCommand";
import {
ListWorkflowsCommand,
ListWorkflowsCommandInput,
ListWorkflowsCommandOutput,
} from "./commands/ListWorkflowsCommand";
import {
MergeProfilesCommand,
MergeProfilesCommandInput,
MergeProfilesCommandOutput,
} from "./commands/MergeProfilesCommand";
import {
PutIntegrationCommand,
PutIntegrationCommandInput,
PutIntegrationCommandOutput,
} from "./commands/PutIntegrationCommand";
import {
PutProfileObjectCommand,
PutProfileObjectCommandInput,
PutProfileObjectCommandOutput,
} from "./commands/PutProfileObjectCommand";
import {
PutProfileObjectTypeCommand,
PutProfileObjectTypeCommandInput,
PutProfileObjectTypeCommandOutput,
} from "./commands/PutProfileObjectTypeCommand";
import {
SearchProfilesCommand,
SearchProfilesCommandInput,
SearchProfilesCommandOutput,
} from "./commands/SearchProfilesCommand";
import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
import {
UntagResourceCommand,
UntagResourceCommandInput,
UntagResourceCommandOutput,
} from "./commands/UntagResourceCommand";
import {
UpdateDomainCommand,
UpdateDomainCommandInput,
UpdateDomainCommandOutput,
} from "./commands/UpdateDomainCommand";
import {
UpdateProfileCommand,
UpdateProfileCommandInput,
UpdateProfileCommandOutput,
} from "./commands/UpdateProfileCommand";
import { CustomerProfilesClient } from "./CustomerProfilesClient";
/**
* <fullname>Amazon Connect Customer Profiles</fullname>
* <p>Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information
* about the Amazon Connect Customer Profiles API, including supported operations, data types,
* parameters, and schemas.</p>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
* pre-built connectors powered by AppFlow that make it easy to combine customer information
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact
* center.</p>
* <p>If you're new to Amazon Connect , you might find it helpful to also review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/what-is-amazon-connect.html">Amazon Connect Administrator Guide</a>.</p>
*/
export class CustomerProfiles extends CustomerProfilesClient {
/**
* <p>Associates a new key value with a specific profile, such as a Contact Trace Record (CTR)
* ContactId.</p>
* <p>A profile object can have a single unique key and any number of additional keys that can
* be used to identify the profile that it belongs to.</p>
*/
public addProfileKey(
args: AddProfileKeyCommandInput,
options?: __HttpHandlerOptions
): Promise<AddProfileKeyCommandOutput>;
public addProfileKey(
args: AddProfileKeyCommandInput,
cb: (err: any, data?: AddProfileKeyCommandOutput) => void
): void;
public addProfileKey(
args: AddProfileKeyCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: AddProfileKeyCommandOutput) => void
): void;
public addProfileKey(
args: AddProfileKeyCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddProfileKeyCommandOutput) => void),
cb?: (err: any, data?: AddProfileKeyCommandOutput) => void
): Promise<AddProfileKeyCommandOutput> | void {
const command = new AddProfileKeyCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Creates a domain, which is a container for all customer data, such as customer profile
* attributes, object types, profile keys, and encryption keys. You can create multiple
* domains, and each domain can have multiple third-party integrations.</p>
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can
* be associated with one domain.</p>
* <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
* enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
* resolution</a>: set <code>Matching</code> to true. </p>
* <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
* apply. </p>
*/
public createDomain(
args: CreateDomainCommandInput,
options?: __HttpHandlerOptions
): Promise<CreateDomainCommandOutput>;
public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
public createDomain(
args: CreateDomainCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CreateDomainCommandOutput) => void
): void;
public createDomain(
args: CreateDomainCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void),
cb?: (err: any, data?: CreateDomainCommandOutput) => void
): Promise<CreateDomainCommandOutput> | void {
const command = new CreateDomainCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>
* Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
* </p>
*/
public createIntegrationWorkflow(
args: CreateIntegrationWorkflowCommandInput,
options?: __HttpHandlerOptions
): Promise<CreateIntegrationWorkflowCommandOutput>;
public createIntegrationWorkflow(
args: CreateIntegrationWorkflowCommandInput,
cb: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void
): void;
public createIntegrationWorkflow(
args: CreateIntegrationWorkflowCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void
): void;
public createIntegrationWorkflow(
args: CreateIntegrationWorkflowCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntegrationWorkflowCommandOutput) => void),
cb?: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void
): Promise<CreateIntegrationWorkflowCommandOutput> | void {
const command = new CreateIntegrationWorkflowCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Creates a standard profile.</p>
* <p>A standard profile represents the following attributes for a customer profile in a
* domain.</p>
*/
public createProfile(
args: CreateProfileCommandInput,
options?: __HttpHandlerOptions
): Promise<CreateProfileCommandOutput>;
public createProfile(
args: CreateProfileCommandInput,
cb: (err: any, data?: CreateProfileCommandOutput) => void
): void;
public createProfile(
args: CreateProfileCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CreateProfileCommandOutput) => void
): void;
public createProfile(
args: CreateProfileCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfileCommandOutput) => void),
cb?: (err: any, data?: CreateProfileCommandOutput) => void
): Promise<CreateProfileCommandOutput> | void {
const command = new CreateProfileCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Deletes a specific domain and all of its customer data, such as customer profile
* attributes and their related objects.</p>
*/
public deleteDomain(
args: DeleteDomainCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteDomainCommandOutput>;
public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
public deleteDomain(
args: DeleteDomainCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteDomainCommandOutput) => void
): void;
public deleteDomain(
args: DeleteDomainCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void),
cb?: (err: any, data?: DeleteDomainCommandOutput) => void
): Promise<DeleteDomainCommandOutput> | void {
const command = new DeleteDomainCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Removes an integration from a specific domain.</p>
*/
public deleteIntegration(
args: DeleteIntegrationCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteIntegrationCommandOutput>;
public deleteIntegration(
args: DeleteIntegrationCommandInput,
cb: (err: any, data?: DeleteIntegrationCommandOutput) => void
): void;
public deleteIntegration(
args: DeleteIntegrationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteIntegrationCommandOutput) => void
): void;
public deleteIntegration(
args: DeleteIntegrationCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationCommandOutput) => void),
cb?: (err: any, data?: DeleteIntegrationCommandOutput) => void
): Promise<DeleteIntegrationCommandOutput> | void {
const command = new DeleteIntegrationCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Deletes the standard customer profile and all data pertaining to the profile.</p>
*/
public deleteProfile(
args: DeleteProfileCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteProfileCommandOutput>;
public deleteProfile(
args: DeleteProfileCommandInput,
cb: (err: any, data?: DeleteProfileCommandOutput) => void
): void;
public deleteProfile(
args: DeleteProfileCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteProfileCommandOutput) => void
): void;
public deleteProfile(
args: DeleteProfileCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileCommandOutput) => void),
cb?: (err: any, data?: DeleteProfileCommandOutput) => void
): Promise<DeleteProfileCommandOutput> | void {
const command = new DeleteProfileCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Removes a searchable key from a customer profile.</p>
*/
public deleteProfileKey(
args: DeleteProfileKeyCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteProfileKeyCommandOutput>;
public deleteProfileKey(
args: DeleteProfileKeyCommandInput,
cb: (err: any, data?: DeleteProfileKeyCommandOutput) => void
): void;
public deleteProfileKey(
args: DeleteProfileKeyCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteProfileKeyCommandOutput) => void
): void;
public deleteProfileKey(
args: DeleteProfileKeyCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileKeyCommandOutput) => void),
cb?: (err: any, data?: DeleteProfileKeyCommandOutput) => void
): Promise<DeleteProfileKeyCommandOutput> | void {
const command = new DeleteProfileKeyCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Removes an object associated with a profile of a given ProfileObjectType.</p>
*/
public deleteProfileObject(
args: DeleteProfileObjectCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteProfileObjectCommandOutput>;
public deleteProfileObject(
args: DeleteProfileObjectCommandInput,
cb: (err: any, data?: DeleteProfileObjectCommandOutput) => void
): void;
public deleteProfileObject(
args: DeleteProfileObjectCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteProfileObjectCommandOutput) => void
): void;
public deleteProfileObject(
args: DeleteProfileObjectCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileObjectCommandOutput) => void),
cb?: (err: any, data?: DeleteProfileObjectCommandOutput) => void
): Promise<DeleteProfileObjectCommandOutput> | void {
const command = new DeleteProfileObjectCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Removes a ProfileObjectType from a specific domain as well as removes all the
* ProfileObjects of that type. It also disables integrations from this specific
* ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that
* were populated from this ProfileObjectType.</p>
*/
public deleteProfileObjectType(
args: DeleteProfileObjectTypeCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteProfileObjectTypeCommandOutput>;
public deleteProfileObjectType(
args: DeleteProfileObjectTypeCommandInput,
cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void
): void;
public deleteProfileObjectType(
args: DeleteProfileObjectTypeCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void
): void;
public deleteProfileObjectType(
args: DeleteProfileObjectTypeCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileObjectTypeCommandOutput) => void),
cb?: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void
): Promise<DeleteProfileObjectTypeCommandOutput> | void {
const command = new DeleteProfileObjectTypeCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>
*/
public deleteWorkflow(
args: DeleteWorkflowCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteWorkflowCommandOutput>;
public deleteWorkflow(
args: DeleteWorkflowCommandInput,
cb: (err: any, data?: DeleteWorkflowCommandOutput) => void
): void;
public deleteWorkflow(
args: DeleteWorkflowCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteWorkflowCommandOutput) => void
): void;
public deleteWorkflow(
args: DeleteWorkflowCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowCommandOutput) => void),
cb?: (err: any, data?: DeleteWorkflowCommandOutput) => void
): Promise<DeleteWorkflowCommandOutput> | void {
const command = new DeleteWorkflowCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly
* selects a sample of matching groups from the existing matching results, and applies the
* automerging settings that you provided. You can then view the number of profiles in the
* sample, the number of matches, and the number of profiles identified to be merged. This
* enables you to evaluate the accuracy of the attributes in your matching list. </p>
* <p>You can't view which profiles are matched and would be merged.</p>
* <important>
*
* <p>We strongly recommend you use this API to do a dry run of the automerging process
* before running the Identity Resolution Job. Include <b>at least</b> two matching
* attributes. If your matching list includes too few attributes (such as only
* <code>FirstName</code> or only <code>LastName</code>), there may be a large number of
* matches. This increases the chances of erroneous merges.</p>
* </important>
*/
public getAutoMergingPreview(
args: GetAutoMergingPreviewCommandInput,
options?: __HttpHandlerOptions
): Promise<GetAutoMergingPreviewCommandOutput>;
public getAutoMergingPreview(
args: GetAutoMergingPreviewCommandInput,
cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void
): void;
public getAutoMergingPreview(
args: GetAutoMergingPreviewCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void
): void;
public getAutoMergingPreview(
args: GetAutoMergingPreviewCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutoMergingPreviewCommandOutput) => void),
cb?: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void
): Promise<GetAutoMergingPreviewCommandOutput> | void {
const command = new GetAutoMergingPreviewCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Returns information about a specific domain.</p>
*/
public getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise<GetDomainCommandOutput>;
public getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
public getDomain(
args: GetDomainCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetDomainCommandOutput) => void
): void;
public getDomain(
args: GetDomainCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainCommandOutput) => void),
cb?: (err: any, data?: GetDomainCommandOutput) => void
): Promise<GetDomainCommandOutput> | void {
const command = new GetDomainCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Returns information about an Identity Resolution Job in a specific domain. </p>
* <p>Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html">Use
* Identity Resolution to consolidate similar profiles</a>.</p>
*/
public getIdentityResolutionJob(
args: GetIdentityResolutionJobCommandInput,
options?: __HttpHandlerOptions
): Promise<GetIdentityResolutionJobCommandOutput>;
public getIdentityResolutionJob(
args: GetIdentityResolutionJobCommandInput,
cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void
): void;
public getIdentityResolutionJob(
args: GetIdentityResolutionJobCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void
): void;
public getIdentityResolutionJob(
args: GetIdentityResolutionJobCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityResolutionJobCommandOutput) => void),
cb?: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void
): Promise<GetIdentityResolutionJobCommandOutput> | void {
const command = new GetIdentityResolutionJobCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Returns an integration for a domain.</p>
*/
public getIntegration(
args: GetIntegrationCommandInput,
options?: __HttpHandlerOptions
): Promise<GetIntegrationCommandOutput>;
public getIntegration(
args: GetIntegrationCommandInput,
cb: (err: any, data?: GetIntegrationCommandOutput) => void
): void;
public getIntegration(
args: GetIntegrationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetIntegrationCommandOutput) => void
): void;
public getIntegration(
args: GetIntegrationCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationCommandOutput) => void),
cb?: (err: any, data?: GetIntegrationCommandOutput) => void
): Promise<GetIntegrationCommandOutput> | void {
const command = new GetIntegrationCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
* enable identity resolution: set <code>Matching</code> to true.</p>
* <p>GetMatches returns potentially matching profiles, based on the results of the latest run
* of a machine learning process. </p>
* <important>
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
* batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
* <p>After the Identity Resolution Job completes, use the
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
* API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from
* S3.</p>
* </important>
*
* <p>Amazon Connect uses the following profile attributes to identify matches:</p>
* <ul>
* <li>
* <p>PhoneNumber</p>
* </li>
* <li>
* <p>HomePhoneNumber</p>
* </li>
* <li>
* <p>BusinessPhoneNumber</p>
* </li>
* <li>
* <p>MobilePhoneNumber</p>
* </li>
* <li>
* <p>EmailAddress</p>
* </li>
* <li>
* <p>PersonalEmailAddress</p>
* </li>
* <li>
* <p>BusinessEmailAddress</p>
* </li>
* <li>
* <p>FullName</p>
* </li>
* </ul>
* <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing
* email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and
* <b>johndoe@anycompany.com</b>, or different phone number
* formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>
*/
public getMatches(args: GetMatchesCommandInput, options?: __HttpHandlerOptions): Promise<GetMatchesCommandOutput>;
public getMatches(args: GetMatchesCommandInput, cb: (err: any, data?: GetMatchesCommandOutput) => void): void;
public getMatches(
args: GetMatchesCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetMatchesCommandOutput) => void
): void;
public getMatches(
args: GetMatchesCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMatchesCommandOutput) => void),
cb?: (err: any, data?: GetMatchesCommandOutput) => void
): Promise<GetMatchesCommandOutput> | void {
const command = new GetMatchesCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Returns the object types for a specific domain.</p>
*/
public getProfileObjectType(
args: GetProfileObjectTypeCommandInput,
options?: __HttpHandlerOptions
): Promise<GetProfileObjectTypeCommandOutput>;
public getProfileObjectType(
args: GetProfileObjectTypeCommandInput,
cb: (err: any, data?: GetProfileObjectTypeCommandOutput) => void
): void;
public getProfileObjectType(
args: GetProfileObjectTypeCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetProfileObjectTypeCommandOutput) => void
): void;
public getProfileObjectType(
args: GetProfileObjectTypeCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileObjectTypeCommandOutput) => void),
cb?: (err: any, data?: GetProfileObjectTypeCommandOutput) => void
): Promise<GetProfileObjectTypeCommandOutput> | void {
const command = new GetProfileObjectTypeCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Returns the template information for a specific object type.</p>
* <p>A template is a predefined ProfileObjectType, such as “Salesforce-Account” or
* “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API,
* with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the
* template.</p>
*/
public getProfileObjectTypeTemplate(
args: GetProfileObjectTypeTemplateCommandInput,
options?: __HttpHandlerOptions
): Promise<GetProfileObjectTypeTemplateCommandOutput>;
public getProfileObjectTypeTemplate(
args: GetProfileObjectTypeTemplateCommandInput,
cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void
): void;
public getProfileObjectTypeTemplate(
args: GetProfileObjectTypeTemplateCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void
): void;
public getProfileObjectTypeTemplate(
args: GetProfileObjectTypeTemplateCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void),
cb?: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void
): Promise<GetProfileObjectTypeTemplateCommandOutput> | void {
const command = new GetProfileObjectTypeTemplateCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Get details of specified workflow.</p>
*/
public getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkflowCommandOutput>;
public getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void;
public getWorkflow(
args: GetWorkflowCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetWorkflowCommandOutput) => void
): void;
public getWorkflow(
args: GetWorkflowCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowCommandOutput) => void),
cb?: (err: any, data?: GetWorkflowCommandOutput) => void
): Promise<GetWorkflowCommandOutput> | void {
const command = new GetWorkflowCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Get granular list of steps in workflow.</p>
*/
public getWorkflowSteps(
args: GetWorkflowStepsCommandInput,
options?: __HttpHandlerOptions
): Promise<GetWorkflowStepsCommandOutput>;
public getWorkflowSteps(
args: GetWorkflowStepsCommandInput,
cb: (err: any, data?: GetWorkflowStepsCommandOutput) => void
): void;
public getWorkflowSteps(
args: GetWorkflowStepsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetWorkflowStepsCommandOutput) => void
): void;
public getWorkflowSteps(
args: GetWorkflowStepsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowStepsCommandOutput) => void),
cb?: (err: any, data?: GetWorkflowStepsCommandOutput) => void
): Promise<GetWorkflowStepsCommandOutput> | void {
const command = new GetWorkflowStepsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Lists all of the integrations associated to a specific URI in the AWS account.</p>
*/
public listAccountIntegrations(
args: ListAccountIntegrationsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListAccountIntegrationsCommandOutput>;
public listAccountIntegrations(
args: ListAccountIntegrationsCommandInput,
cb: (err: any, data?: ListAccountIntegrationsCommandOutput) => void
): void;
public listAccountIntegrations(
args: ListAccountIntegrationsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListAccountIntegrationsCommandOutput) => void
): void;
public listAccountIntegrations(
args: ListAccountIntegrationsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountIntegrationsCommandOutput) => void),
cb?: (err: any, data?: ListAccountIntegrationsCommandOutput) => void
): Promise<ListAccountIntegrationsCommandOutput> | void {
const command = new ListAccountIntegrationsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Returns a list of all the domains for an AWS account that have been created.</p>
*/
public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
public listDomains(
args: ListDomainsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListDomainsCommandOutput) => void
): void;
public listDomains(
args: ListDomainsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void),
cb?: (err: any, data?: ListDomainsCommandOutput) => void
): Promise<ListDomainsCommandOutput> | void {
const command = new ListDomainsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
* <code>JobStartTime</code>.</p>
*/
public listIdentityResolutionJobs(
args: ListIdentityResolutionJobsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListIdentityResolutionJobsCommandOutput>;
public listIdentityResolutionJobs(
args: ListIdentityResolutionJobsCommandInput,
cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void
): void;
public listIdentityResolutionJobs(
args: ListIdentityResolutionJobsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void
): void;
public listIdentityResolutionJobs(
args: ListIdentityResolutionJobsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityResolutionJobsCommandOutput) => void),
cb?: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void
): Promise<ListIdentityResolutionJobsCommandOutput> | void {
const command = new ListIdentityResolutionJobsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Lists all of the integrations in your domain.</p>
*/
public listIntegrations(
args: ListIntegrationsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListIntegrationsCommandOutput>;
public listIntegrations(
args: ListIntegrationsCommandInput,
cb: (err: any, data?: ListIntegrationsCommandOutput) => void
): void;
public listIntegrations(
args: ListIntegrationsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListIntegrationsCommandOutput) => void
): void;
public listIntegrations(
args: ListIntegrationsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIntegrationsCommandOutput) => void),
cb?: (err: any, data?: ListIntegrationsCommandOutput) => void
): Promise<ListIntegrationsCommandOutput> | void {
const command = new ListIntegrationsCommand(args);