/
docs-2.json
1729 lines (1729 loc) · 109 KB
/
docs-2.json
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
{
"version": "2.0",
"service": "<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>",
"operations": {
"AddProfileKey": "<p>Associates a new key value with a specific profile, such as a Contact Record 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>",
"CreateDomain": "<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>",
"CreateIntegrationWorkflow": "<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>",
"CreateProfile": "<p>Creates a standard profile.</p> <p>A standard profile represents the following attributes for a customer profile in a domain.</p>",
"DeleteDomain": "<p>Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.</p>",
"DeleteIntegration": "<p>Removes an integration from a specific domain.</p>",
"DeleteProfile": "<p>Deletes the standard customer profile and all data pertaining to the profile.</p>",
"DeleteProfileKey": "<p>Removes a searchable key from a customer profile.</p>",
"DeleteProfileObject": "<p>Removes an object associated with a profile of a given ProfileObjectType.</p>",
"DeleteProfileObjectType": "<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>",
"DeleteWorkflow": "<p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>",
"GetAutoMergingPreview": "<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>",
"GetDomain": "<p>Returns information about a specific domain.</p>",
"GetIdentityResolutionJob": "<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>",
"GetIntegration": "<p>Returns an integration for a domain.</p>",
"GetMatches": "<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>",
"GetProfileObjectType": "<p>Returns the object types for a specific domain.</p>",
"GetProfileObjectTypeTemplate": "<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>",
"GetWorkflow": "<p>Get details of specified workflow.</p>",
"GetWorkflowSteps": "<p>Get granular list of steps in workflow.</p>",
"ListAccountIntegrations": "<p>Lists all of the integrations associated to a specific URI in the AWS account.</p>",
"ListDomains": "<p>Returns a list of all the domains for an AWS account that have been created.</p>",
"ListIdentityResolutionJobs": "<p>Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by <code>JobStartTime</code>.</p>",
"ListIntegrations": "<p>Lists all of the integrations in your domain.</p>",
"ListProfileObjectTypeTemplates": "<p>Lists all of the template information for object types.</p>",
"ListProfileObjectTypes": "<p>Lists all of the templates available within the service.</p>",
"ListProfileObjects": "<p>Returns a list of objects associated with a profile of a given ProfileObjectType.</p>",
"ListTagsForResource": "<p>Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.</p>",
"ListWorkflows": "<p>Query to list all workflows.</p>",
"MergeProfiles": "<p>Runs an AWS Lambda job that does the following:</p> <ol> <li> <p>All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the main profile.</p> </li> <li> <p>All the objects in the <code>ProfileToBeMerged</code> will be moved to the main profile.</p> </li> <li> <p>All the <code>ProfileToBeMerged</code> will be deleted at the end.</p> </li> <li> <p>All the profileKeys in the <code>ProfileIdsToBeMerged</code> will be moved to the main profile.</p> </li> <li> <p>Standard fields are merged as follows:</p> <ol> <li> <p>Fields are always \"union\"-ed if there are no conflicts in standard fields or attributeKeys.</p> </li> <li> <p>When there are conflicting fields:</p> <ol> <li> <p>If no <code>SourceProfileIds</code> entry is specified, the main Profile value is always taken. </p> </li> <li> <p>If a <code>SourceProfileIds</code> entry is specified, the specified profileId is always taken, even if it is a NULL value.</p> </li> </ol> </li> </ol> </li> </ol> <p>You can use MergeProfiles together with <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).</p>",
"PutIntegration": "<p>Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.</p> <p>An integration can belong to only one domain.</p> <p>To add or remove tags on an existing Integration, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\"> TagResource </a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\"> UntagResource</a>.</p>",
"PutProfileObject": "<p>Adds additional objects to customer profiles of a given ObjectType.</p> <p>When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.</p> <p>When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.</p> <p>PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.</p>",
"PutProfileObjectType": "<p>Defines a ProfileObjectType.</p> <p>To add or remove tags on an existing ObjectType, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\"> TagResource</a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\">UntagResource</a>.</p>",
"SearchProfiles": "<p>Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.</p>",
"TagResource": "<p>Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a resource.</p>",
"UntagResource": "<p>Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.</p>",
"UpdateDomain": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.</p> <p>After a domain is created, the name can’t be changed.</p> <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</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> <p>To add or remove tags on an existing Domain, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\">TagResource</a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\">UntagResource</a>.</p>",
"UpdateProfile": "<p>Updates the properties of a profile. The ProfileId is required for updating a customer profile.</p> <p>When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.</p>"
},
"shapes": {
"name": {
"base": null,
"refs": {
"AddProfileKeyRequest$KeyName": "<p>A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>",
"AddProfileKeyRequest$DomainName": "<p>The unique name of the domain.</p>",
"AddProfileKeyResponse$KeyName": "<p>A searchable identifier of a customer profile.</p>",
"CreateDomainRequest$DomainName": "<p>The unique name of the domain.</p>",
"CreateDomainResponse$DomainName": "<p>The unique name of the domain.</p>",
"CreateIntegrationWorkflowRequest$DomainName": "<p>The unique name of the domain.</p>",
"CreateProfileRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteDomainRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteIntegrationRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteProfileKeyRequest$KeyName": "<p>A searchable identifier of a customer profile.</p>",
"DeleteProfileKeyRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteProfileObjectRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteProfileObjectTypeRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteProfileRequest$DomainName": "<p>The unique name of the domain.</p>",
"DeleteWorkflowRequest$DomainName": "<p>The unique name of the domain.</p>",
"FieldMap$key": null,
"FieldNameList$member": null,
"GetAutoMergingPreviewRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetAutoMergingPreviewResponse$DomainName": "<p>The unique name of the domain.</p>",
"GetDomainRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetDomainResponse$DomainName": "<p>The unique name of the domain.</p>",
"GetIdentityResolutionJobRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetIdentityResolutionJobResponse$DomainName": "<p>The unique name of the domain.</p>",
"GetIntegrationRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetIntegrationResponse$DomainName": "<p>The unique name of the domain.</p>",
"GetMatchesRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetProfileObjectTypeRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetProfileObjectTypeResponse$TemplateId": "<p>A unique identifier for the object template.</p>",
"GetProfileObjectTypeTemplateRequest$TemplateId": "<p>A unique identifier for the object template.</p>",
"GetProfileObjectTypeTemplateResponse$TemplateId": "<p>A unique identifier for the object template.</p>",
"GetProfileObjectTypeTemplateResponse$SourceName": "<p>The name of the source of the object template.</p>",
"GetProfileObjectTypeTemplateResponse$SourceObject": "<p>The source of the object template.</p>",
"GetWorkflowRequest$DomainName": "<p>The unique name of the domain.</p>",
"GetWorkflowStepsRequest$DomainName": "<p>The unique name of the domain.</p>",
"IdentityResolutionJob$DomainName": "<p>The unique name of the domain.</p>",
"KeyMap$key": null,
"ListDomainItem$DomainName": "<p>The unique name of the domain.</p>",
"ListIdentityResolutionJobsRequest$DomainName": "<p>The unique name of the domain.</p>",
"ListIntegrationItem$DomainName": "<p>The unique name of the domain.</p>",
"ListIntegrationsRequest$DomainName": "<p>The unique name of the domain.</p>",
"ListProfileObjectTypeTemplateItem$TemplateId": "<p>A unique identifier for the object template.</p>",
"ListProfileObjectTypeTemplateItem$SourceName": "<p>The name of the source of the object template.</p>",
"ListProfileObjectTypeTemplateItem$SourceObject": "<p>The source of the object template.</p>",
"ListProfileObjectTypesRequest$DomainName": "<p>The unique name of the domain.</p>",
"ListProfileObjectsRequest$DomainName": "<p>The unique name of the domain.</p>",
"ListWorkflowsRequest$DomainName": "<p>The unique name of the domain.</p>",
"MergeProfilesRequest$DomainName": "<p>The unique name of the domain.</p>",
"ObjectFilter$KeyName": "<p>A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.</p>",
"PutIntegrationRequest$DomainName": "<p>The unique name of the domain.</p>",
"PutIntegrationResponse$DomainName": "<p>The unique name of the domain.</p>",
"PutProfileObjectRequest$DomainName": "<p>The unique name of the domain.</p>",
"PutProfileObjectTypeRequest$DomainName": "<p>The unique name of the domain.</p>",
"PutProfileObjectTypeRequest$TemplateId": "<p>A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a <code>BadRequestException</code>. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a <code>BadRequestException</code>.</p>",
"PutProfileObjectTypeResponse$TemplateId": "<p>A unique identifier for the object template.</p>",
"SearchProfilesRequest$DomainName": "<p>The unique name of the domain.</p>",
"SearchProfilesRequest$KeyName": "<p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>",
"UpdateDomainRequest$DomainName": "<p>The unique name of the domain.</p>",
"UpdateDomainResponse$DomainName": "<p>The unique name of the domain.</p>",
"UpdateProfileRequest$DomainName": "<p>The unique name of the domain.</p>"
}
},
"AccessDeniedException": {
"base": "<p>You do not have sufficient access to perform this action.</p>",
"refs": {
}
},
"AddProfileKeyRequest": {
"base": null,
"refs": {
}
},
"AddProfileKeyResponse": {
"base": null,
"refs": {
}
},
"Address": {
"base": "<p>A generic address associated with the customer that is not mailing, shipping, or billing.</p>",
"refs": {
"CreateProfileRequest$Address": "<p>A generic address associated with the customer that is not mailing, shipping, or billing.</p>",
"CreateProfileRequest$ShippingAddress": "<p>The customer’s shipping address.</p>",
"CreateProfileRequest$MailingAddress": "<p>The customer’s mailing address.</p>",
"CreateProfileRequest$BillingAddress": "<p>The customer’s billing address.</p>",
"Profile$Address": "<p>A generic address associated with the customer that is not mailing, shipping, or billing.</p>",
"Profile$ShippingAddress": "<p>The customer’s shipping address.</p>",
"Profile$MailingAddress": "<p>The customer’s mailing address.</p>",
"Profile$BillingAddress": "<p>The customer’s billing address.</p>"
}
},
"AppflowIntegration": {
"base": "<p>Details for workflow of type <code>APPFLOW_INTEGRATION</code>.</p>",
"refs": {
"IntegrationConfig$AppflowIntegration": "<p>Configuration data for <code>APPFLOW_INTEGRATION</code> workflow type.</p>"
}
},
"AppflowIntegrationWorkflowAttributes": {
"base": "<p>Structure holding all <code>APPFLOW_INTEGRATION</code> specific workflow attributes.</p>",
"refs": {
"WorkflowAttributes$AppflowIntegration": "<p>Workflow attributes specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>"
}
},
"AppflowIntegrationWorkflowMetrics": {
"base": "<p>Workflow specific execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"refs": {
"WorkflowMetrics$AppflowIntegration": "<p>Workflow execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
}
},
"AppflowIntegrationWorkflowStep": {
"base": "<p>Workflow step details for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"refs": {
"WorkflowStepItem$AppflowIntegration": "<p>Workflow step information specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>"
}
},
"AttributeSourceIdMap": {
"base": null,
"refs": {
"FieldSourceProfileIds$Attributes": "<p>A unique identifier for the attributes field to be merged.</p>"
}
},
"Attributes": {
"base": null,
"refs": {
"CreateProfileRequest$Attributes": "<p>A key value pair of attributes of a customer profile.</p>",
"Profile$Attributes": "<p>A key value pair of attributes of a customer profile.</p>"
}
},
"AutoMerging": {
"base": "<p>Configuration settings for how to perform the auto-merging of profiles.</p>",
"refs": {
"GetIdentityResolutionJobResponse$AutoMerging": "<p>Configuration settings for how to perform the auto-merging of profiles.</p>",
"MatchingRequest$AutoMerging": "<p>Configuration information about the auto-merging process.</p>",
"MatchingResponse$AutoMerging": "<p>Configuration information about the auto-merging process.</p>"
}
},
"BadRequestException": {
"base": "<p>The input you provided is invalid.</p>",
"refs": {
}
},
"Batch": {
"base": "<p>Batch defines the boundaries for ingestion for each step in <code>APPFLOW_INTEGRATION</code> workflow. <code>APPFLOW_INTEGRATION</code> workflow splits ingestion based on these boundaries.</p>",
"refs": {
"Batches$member": null
}
},
"Batches": {
"base": null,
"refs": {
"AppflowIntegration$Batches": "<p>Batches in workflow of type <code>APPFLOW_INTEGRATION</code>.</p>"
}
},
"BucketName": {
"base": null,
"refs": {
"S3SourceProperties$BucketName": "<p>The Amazon S3 bucket name where the source files are stored.</p>"
}
},
"BucketPrefix": {
"base": null,
"refs": {
"S3SourceProperties$BucketPrefix": "<p>The object key for the Amazon S3 bucket in which the source files are stored.</p>"
}
},
"ConflictResolution": {
"base": "<p>How the auto-merging process should resolve conflicts between different profiles.</p>",
"refs": {
"AutoMerging$ConflictResolution": "<p>How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same <code>FirstName</code> and <code>LastName</code> (and that is the matching criteria), which <code>EmailAddress</code> should be used? </p>",
"GetAutoMergingPreviewRequest$ConflictResolution": "<p>How the auto-merging process should resolve conflicts between different profiles.</p>"
}
},
"ConflictResolvingModel": {
"base": null,
"refs": {
"ConflictResolution$ConflictResolvingModel": "<p>How the auto-merging process should resolve conflicts between different profiles.</p> <ul> <li> <p> <code>RECENCY</code>: Uses the data that was most recently updated.</p> </li> <li> <p> <code>SOURCE</code>: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then <code>RECENCY</code> is used again.</p> </li> </ul>"
}
},
"ConnectorOperator": {
"base": "<p>The operation to be performed on the provided source fields.</p>",
"refs": {
"Task$ConnectorOperator": "<p>The operation to be performed on the provided source fields.</p>"
}
},
"ConnectorProfileName": {
"base": null,
"refs": {
"AppflowIntegrationWorkflowAttributes$ConnectorProfileName": "<p>The name of the AppFlow connector profile used for ingestion.</p>",
"SourceFlowConfig$ConnectorProfileName": "<p>The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.</p>"
}
},
"Consolidation": {
"base": "<p>The matching criteria to be used during the auto-merging process. </p>",
"refs": {
"AutoMerging$Consolidation": "<p>A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.</p>",
"GetAutoMergingPreviewRequest$Consolidation": "<p>A list of matching attributes that represent matching criteria.</p>"
}
},
"CreateDomainRequest": {
"base": null,
"refs": {
}
},
"CreateDomainResponse": {
"base": null,
"refs": {
}
},
"CreateIntegrationWorkflowRequest": {
"base": null,
"refs": {
}
},
"CreateIntegrationWorkflowResponse": {
"base": null,
"refs": {
}
},
"CreateProfileRequest": {
"base": null,
"refs": {
}
},
"CreateProfileResponse": {
"base": null,
"refs": {
}
},
"DataPullMode": {
"base": null,
"refs": {
"ScheduledTriggerProperties$DataPullMode": "<p>Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.</p>"
}
},
"Date": {
"base": null,
"refs": {
"ScheduledTriggerProperties$ScheduleStartTime": "<p>Specifies the scheduled start time for a scheduled-trigger flow.</p>",
"ScheduledTriggerProperties$ScheduleEndTime": "<p>Specifies the scheduled end time for a scheduled-trigger flow.</p>",
"ScheduledTriggerProperties$FirstExecutionFrom": "<p>Specifies the date range for the records to import from the connector in the first flow run.</p>"
}
},
"DatetimeTypeFieldName": {
"base": null,
"refs": {
"IncrementalPullConfig$DatetimeTypeFieldName": "<p>A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.</p>"
}
},
"DeleteDomainRequest": {
"base": null,
"refs": {
}
},
"DeleteDomainResponse": {
"base": null,
"refs": {
}
},
"DeleteIntegrationRequest": {
"base": null,
"refs": {
}
},
"DeleteIntegrationResponse": {
"base": null,
"refs": {
}
},
"DeleteProfileKeyRequest": {
"base": null,
"refs": {
}
},
"DeleteProfileKeyResponse": {
"base": null,
"refs": {
}
},
"DeleteProfileObjectRequest": {
"base": null,
"refs": {
}
},
"DeleteProfileObjectResponse": {
"base": null,
"refs": {
}
},
"DeleteProfileObjectTypeRequest": {
"base": null,
"refs": {
}
},
"DeleteProfileObjectTypeResponse": {
"base": null,
"refs": {
}
},
"DeleteProfileRequest": {
"base": null,
"refs": {
}
},
"DeleteProfileResponse": {
"base": null,
"refs": {
}
},
"DeleteWorkflowRequest": {
"base": null,
"refs": {
}
},
"DeleteWorkflowResponse": {
"base": null,
"refs": {
}
},
"DestinationField": {
"base": null,
"refs": {
"Task$DestinationField": "<p>A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.</p>"
}
},
"DomainList": {
"base": null,
"refs": {
"ListDomainsResponse$Items": "<p>The list of ListDomains instances.</p>"
}
},
"DomainStats": {
"base": "<p>Usage-specific statistics about the domain.</p>",
"refs": {
"GetDomainResponse$Stats": "<p>Usage-specific statistics about the domain.</p>"
}
},
"Double": {
"base": null,
"refs": {
"MatchItem$ConfidenceScore": "<p>A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.</p>"
}
},
"Double0To1": {
"base": null,
"refs": {
"AutoMerging$MinAllowedConfidenceScoreForMerging": "<p>A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles. </p>",
"GetAutoMergingPreviewRequest$MinAllowedConfidenceScoreForMerging": "<p>Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.</p>"
}
},
"ExportingConfig": {
"base": "<p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p> <note> <p>You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service\">Amazon Connect Customer Profiles cross-service confused deputy prevention</a>. </p> </note>",
"refs": {
"MatchingRequest$ExportingConfig": "<p>Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.</p>",
"MatchingResponse$ExportingConfig": "<p>Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.</p>"
}
},
"ExportingLocation": {
"base": "<p>The S3 location where Identity Resolution Jobs write result files.</p>",
"refs": {
"GetIdentityResolutionJobResponse$ExportingLocation": "<p>The S3 location where the Identity Resolution Job writes result files.</p>",
"IdentityResolutionJob$ExportingLocation": "<p>The S3 location where the Identity Resolution Job writes result files.</p>"
}
},
"FieldContentType": {
"base": null,
"refs": {
"ObjectTypeField$ContentType": "<p>The content type of the field. Used for determining equality when searching.</p>"
}
},
"FieldMap": {
"base": null,
"refs": {
"GetProfileObjectTypeResponse$Fields": "<p>A map of the name and ObjectType field.</p>",
"GetProfileObjectTypeTemplateResponse$Fields": "<p>A map of the name and ObjectType field.</p>",
"PutProfileObjectTypeRequest$Fields": "<p>A map of the name and ObjectType field.</p>",
"PutProfileObjectTypeResponse$Fields": "<p>A map of the name and ObjectType field.</p>"
}
},
"FieldNameList": {
"base": null,
"refs": {
"ObjectTypeKey$FieldNames": "<p>The reference for the key name of the fields map.</p>"
}
},
"FieldSourceProfileIds": {
"base": "<p>A duplicate customer profile that is to be merged into a main profile. </p>",
"refs": {
"MergeProfilesRequest$FieldSourceProfileIds": "<p>The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>"
}
},
"FlowDefinition": {
"base": "<p>The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.</p>",
"refs": {
"AppflowIntegration$FlowDefinition": null,
"PutIntegrationRequest$FlowDefinition": "<p>The configuration that controls how Customer Profiles retrieves data from the source.</p>"
}
},
"FlowDescription": {
"base": null,
"refs": {
"FlowDefinition$Description": "<p>A description of the flow you want to create.</p>"
}
},
"FlowName": {
"base": null,
"refs": {
"AppflowIntegrationWorkflowStep$FlowName": "<p>Name of the flow created during execution of workflow step. <code>APPFLOW_INTEGRATION</code> workflow type creates an appflow flow during workflow step execution on the customers behalf.</p>",
"FlowDefinition$FlowName": "<p>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.</p>"
}
},
"Gender": {
"base": null,
"refs": {
"CreateProfileRequest$Gender": "<p>The gender with which the customer identifies. </p>",
"Profile$Gender": "<p>The gender with which the customer identifies. </p>",
"UpdateProfileRequest$Gender": "<p>The gender with which the customer identifies. </p>"
}
},
"GetAutoMergingPreviewRequest": {
"base": null,
"refs": {
}
},
"GetAutoMergingPreviewResponse": {
"base": null,
"refs": {
}
},
"GetDomainRequest": {
"base": null,
"refs": {
}
},
"GetDomainResponse": {
"base": null,
"refs": {
}
},
"GetIdentityResolutionJobRequest": {
"base": null,
"refs": {
}
},
"GetIdentityResolutionJobResponse": {
"base": null,
"refs": {
}
},
"GetIntegrationRequest": {
"base": null,
"refs": {
}
},
"GetIntegrationResponse": {
"base": null,
"refs": {
}
},
"GetMatchesRequest": {
"base": null,
"refs": {
}
},
"GetMatchesResponse": {
"base": null,
"refs": {
}
},
"GetProfileObjectTypeRequest": {
"base": null,
"refs": {
}
},
"GetProfileObjectTypeResponse": {
"base": null,
"refs": {
}
},
"GetProfileObjectTypeTemplateRequest": {
"base": null,
"refs": {
}
},
"GetProfileObjectTypeTemplateResponse": {
"base": null,
"refs": {
}
},
"GetWorkflowRequest": {
"base": null,
"refs": {
}
},
"GetWorkflowResponse": {
"base": null,
"refs": {
}
},
"GetWorkflowStepsRequest": {
"base": null,
"refs": {
}
},
"GetWorkflowStepsResponse": {
"base": null,
"refs": {
}
},
"IdentityResolutionJob": {
"base": "<p>Information about the Identity Resolution Job.</p>",
"refs": {
"IdentityResolutionJobsList$member": null
}
},
"IdentityResolutionJobStatus": {
"base": null,
"refs": {
"GetIdentityResolutionJobResponse$Status": "<p>The status of the Identity Resolution Job.</p> <ul> <li> <p> <code>PENDING</code>: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the <code>PENDING</code> state are deleted.</p> </li> <li> <p> <code>PREPROCESSING</code>: The Identity Resolution Job is loading your data.</p> </li> <li> <p> <code>FIND_MATCHING</code>: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.</p> </li> <li> <p> <code>MERGING</code>: The Identity Resolution Job is merging duplicate profiles.</p> </li> <li> <p> <code>COMPLETED</code>: The Identity Resolution Job completed successfully.</p> </li> <li> <p> <code>PARTIAL_SUCCESS</code>: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.</p> </li> <li> <p> <code>FAILED</code>: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.</p> </li> </ul>",
"IdentityResolutionJob$Status": "<p>The status of the Identity Resolution Job.</p> <ul> <li> <p> <code>PENDING</code>: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the <code>PENDING</code> state are deleted.</p> </li> <li> <p> <code>PREPROCESSING</code>: The Identity Resolution Job is loading your data.</p> </li> <li> <p> <code>FIND_MATCHING</code>: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.</p> </li> <li> <p> <code>MERGING</code>: The Identity Resolution Job is merging duplicate profiles.</p> </li> <li> <p> <code>COMPLETED</code>: The Identity Resolution Job completed successfully.</p> </li> <li> <p> <code>PARTIAL_SUCCESS</code>: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.</p> </li> <li> <p> <code>FAILED</code>: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.</p> </li> </ul>"
}
},
"IdentityResolutionJobsList": {
"base": null,
"refs": {
"ListIdentityResolutionJobsResponse$IdentityResolutionJobsList": "<p>A list of Identity Resolution Jobs.</p>"
}
},
"IncrementalPullConfig": {
"base": "<p>Specifies the configuration used when importing incremental records from the source.</p>",
"refs": {
"SourceFlowConfig$IncrementalPullConfig": "<p>Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.</p>"
}
},
"IntegrationConfig": {
"base": "<p>Configuration data for integration workflow.</p>",
"refs": {
"CreateIntegrationWorkflowRequest$IntegrationConfig": "<p>Configuration data for integration workflow.</p>"
}
},
"IntegrationList": {
"base": null,
"refs": {
"ListAccountIntegrationsResponse$Items": "<p>The list of ListAccountIntegration instances.</p>",
"ListIntegrationsResponse$Items": "<p>The list of ListIntegrations instances.</p>"
}
},
"InternalServerException": {
"base": "<p>An internal service error occurred.</p>",
"refs": {
}
},
"JobSchedule": {
"base": "<p>The day and time when do you want to start the Identity Resolution Job every week.</p>",
"refs": {
"MatchingRequest$JobSchedule": "<p>The day and time when do you want to start the Identity Resolution Job every week.</p>",
"MatchingResponse$JobSchedule": "<p>The day and time when do you want to start the Identity Resolution Job every week.</p>"
}
},
"JobScheduleDayOfTheWeek": {
"base": null,
"refs": {
"JobSchedule$DayOfTheWeek": "<p>The day when the Identity Resolution Job should run every week.</p>"
}
},
"JobScheduleTime": {
"base": null,
"refs": {
"JobSchedule$Time": "<p>The time when the Identity Resolution Job should run every week.</p>"
}
},
"JobStats": {
"base": "<p>Statistics about the Identity Resolution Job.</p>",
"refs": {
"GetIdentityResolutionJobResponse$JobStats": "<p>Statistics about the Identity Resolution Job.</p>",
"IdentityResolutionJob$JobStats": "<p>Statistics about an Identity Resolution Job.</p>"
}
},
"KeyMap": {
"base": null,
"refs": {
"GetProfileObjectTypeResponse$Keys": "<p>A list of unique keys that can be used to map data to the profile.</p>",
"GetProfileObjectTypeTemplateResponse$Keys": "<p>A list of unique keys that can be used to map data to the profile.</p>",
"PutProfileObjectTypeRequest$Keys": "<p>A list of unique keys that can be used to map data to the profile.</p>",
"PutProfileObjectTypeResponse$Keys": "<p>A list of unique keys that can be used to map data to the profile.</p>"
}
},
"KmsArn": {
"base": null,
"refs": {
"FlowDefinition$KmsArn": "<p>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</p>"
}
},
"ListAccountIntegrationsRequest": {
"base": null,
"refs": {
}
},
"ListAccountIntegrationsResponse": {
"base": null,
"refs": {
}
},
"ListDomainItem": {
"base": "<p>An object in a list that represents a domain.</p>",
"refs": {
"DomainList$member": null
}
},
"ListDomainsRequest": {
"base": null,
"refs": {
}
},
"ListDomainsResponse": {
"base": null,
"refs": {
}
},
"ListIdentityResolutionJobsRequest": {
"base": null,
"refs": {
}
},
"ListIdentityResolutionJobsResponse": {
"base": null,
"refs": {
}
},
"ListIntegrationItem": {
"base": "<p>An integration in list of integrations.</p>",
"refs": {
"IntegrationList$member": null
}
},
"ListIntegrationsRequest": {
"base": null,
"refs": {
}
},
"ListIntegrationsResponse": {
"base": null,
"refs": {
}
},
"ListProfileObjectTypeItem": {
"base": "<p>A ProfileObjectType instance.</p>",
"refs": {
"ProfileObjectTypeList$member": null
}
},
"ListProfileObjectTypeTemplateItem": {
"base": "<p>A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.</p>",
"refs": {
"ProfileObjectTypeTemplateList$member": null
}
},
"ListProfileObjectTypeTemplatesRequest": {
"base": null,
"refs": {
}
},
"ListProfileObjectTypeTemplatesResponse": {
"base": null,
"refs": {
}
},
"ListProfileObjectTypesRequest": {
"base": null,
"refs": {
}
},
"ListProfileObjectTypesResponse": {
"base": null,
"refs": {
}
},
"ListProfileObjectsItem": {
"base": "<p>A ProfileObject in a list of ProfileObjects.</p>",
"refs": {
"ProfileObjectList$member": null
}
},
"ListProfileObjectsRequest": {
"base": null,
"refs": {
}
},
"ListProfileObjectsResponse": {
"base": null,
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"ListWorkflowsItem": {
"base": "<p>A workflow in list of workflows.</p>",
"refs": {
"WorkflowList$member": null
}
},
"ListWorkflowsRequest": {
"base": null,
"refs": {
}
},
"ListWorkflowsResponse": {
"base": null,
"refs": {
}
},
"MarketoConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$Marketo": "<p>The operation to be performed on the provided Marketo source fields.</p>"
}
},
"MarketoSourceProperties": {
"base": "<p>The properties that are applied when Marketo is being used as a source.</p>",
"refs": {
"SourceConnectorProperties$Marketo": "<p>The properties that are applied when Marketo is being used as a source.</p>"
}
},
"MatchItem": {
"base": "<p>The Match group object.</p>",
"refs": {
"MatchesList$member": null
}
},
"MatchesList": {
"base": null,
"refs": {
"GetMatchesResponse$Matches": "<p>The list of matched profiles for this instance.</p>"
}
},
"MatchingAttributes": {
"base": null,
"refs": {
"MatchingAttributesList$member": null
}
},
"MatchingAttributesList": {
"base": null,
"refs": {
"Consolidation$MatchingAttributesList": "<p>A list of matching criteria.</p>"
}
},
"MatchingRequest": {
"base": "<p>The flag that enables the matching process of duplicate profiles.</p>",
"refs": {
"CreateDomainRequest$Matching": "<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>",
"UpdateDomainRequest$Matching": "<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>"
}
},
"MatchingResponse": {
"base": "<p>The flag that enables the matching process of duplicate profiles.</p>",
"refs": {
"CreateDomainResponse$Matching": "<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>",
"GetDomainResponse$Matching": "<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>",
"UpdateDomainResponse$Matching": "<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>"
}
},
"MergeProfilesRequest": {
"base": null,
"refs": {
}
},
"MergeProfilesResponse": {
"base": null,
"refs": {
}
},
"Object": {
"base": null,
"refs": {
"MarketoSourceProperties$Object": "<p>The object specified in the Marketo flow source.</p>",
"SalesforceSourceProperties$Object": "<p>The object specified in the Salesforce flow source.</p>",
"ServiceNowSourceProperties$Object": "<p>The object specified in the ServiceNow flow source.</p>",
"ZendeskSourceProperties$Object": "<p>The object specified in the Zendesk flow source.</p>"
}
},
"ObjectFilter": {
"base": "<p>The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.</p>",
"refs": {
"ListProfileObjectsRequest$ObjectFilter": "<p>Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.</p>"
}
},
"ObjectTypeField": {
"base": "<p>Represents a field in a ProfileObjectType.</p>",
"refs": {
"FieldMap$value": null
}
},
"ObjectTypeKey": {
"base": "<p>An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.</p>",
"refs": {
"ObjectTypeKeyList$member": null
}
},
"ObjectTypeKeyList": {
"base": null,
"refs": {
"KeyMap$value": null
}
},
"ObjectTypeNames": {
"base": null,
"refs": {
"GetIntegrationResponse$ObjectTypeNames": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>",
"ListIntegrationItem$ObjectTypeNames": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>",
"PutIntegrationRequest$ObjectTypeNames": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>",
"PutIntegrationResponse$ObjectTypeNames": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
}
},
"OperatorPropertiesKeys": {
"base": null,
"refs": {
"TaskPropertiesMap$key": null
}
},
"PartyType": {
"base": null,
"refs": {
"CreateProfileRequest$PartyType": "<p>The type of profile used to describe the customer.</p>",
"Profile$PartyType": "<p>The type of profile used to describe the customer.</p>",
"UpdateProfileRequest$PartyType": "<p>The type of profile used to describe the customer.</p>"
}
},
"Profile": {
"base": "<p>The standard profile of a customer.</p>",
"refs": {
"ProfileList$member": null
}
},
"ProfileIdList": {
"base": null,
"refs": {
"MatchItem$ProfileIds": "<p>A list of identifiers for profiles that match.</p>"
}
},
"ProfileIdToBeMergedList": {
"base": null,
"refs": {
"MergeProfilesRequest$ProfileIdsToBeMerged": "<p>The identifier of the profile to be merged into MainProfileId.</p>"
}
},
"ProfileList": {
"base": null,
"refs": {
"SearchProfilesResponse$Items": "<p>The list of SearchProfiles instances.</p>"
}
},
"ProfileObjectList": {
"base": null,
"refs": {
"ListProfileObjectsResponse$Items": "<p>The list of ListProfileObject instances.</p>"
}
},
"ProfileObjectTypeList": {
"base": null,
"refs": {
"ListProfileObjectTypesResponse$Items": "<p>The list of ListProfileObjectTypes instances.</p>"
}
},
"ProfileObjectTypeTemplateList": {
"base": null,
"refs": {
"ListProfileObjectTypeTemplatesResponse$Items": "<p>The list of ListProfileObjectType template instances.</p>"
}
},
"Property": {
"base": null,
"refs": {
"TaskPropertiesMap$value": null
}
},
"PutIntegrationRequest": {
"base": null,
"refs": {
}
},
"PutIntegrationResponse": {
"base": null,
"refs": {
}
},
"PutProfileObjectRequest": {
"base": null,
"refs": {
}
},
"PutProfileObjectResponse": {
"base": null,
"refs": {
}
},
"PutProfileObjectTypeRequest": {
"base": null,
"refs": {
}
},
"PutProfileObjectTypeResponse": {
"base": null,
"refs": {
}
},
"ResourceNotFoundException": {
"base": "<p>The requested resource does not exist, or access was denied.</p>",
"refs": {
}
},
"RoleArn": {
"base": null,
"refs": {
"CreateIntegrationWorkflowRequest$RoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.</p>"
}
},
"S3ConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$S3": "<p>The operation to be performed on the provided Amazon S3 source fields.</p>"
}
},
"S3ExportingConfig": {
"base": "<p>Configuration information about the S3 bucket where Identity Resolution Jobs write result files.</p>",
"refs": {
"ExportingConfig$S3Exporting": "<p>The S3 location where Identity Resolution Jobs write result files.</p>"
}
},
"S3ExportingLocation": {
"base": "<p>The S3 location where Identity Resolution Jobs write result files.</p>",
"refs": {
"ExportingLocation$S3Exporting": "<p>Information about the S3 location where Identity Resolution Jobs write result files.</p>"
}
},
"S3SourceProperties": {
"base": "<p>The properties that are applied when Amazon S3 is being used as the flow source.</p>",
"refs": {
"SourceConnectorProperties$S3": "<p>The properties that are applied when Amazon S3 is being used as the flow source.</p>"
}
},
"SalesforceConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$Salesforce": "<p>The operation to be performed on the provided Salesforce source fields.</p>"
}
},
"SalesforceSourceProperties": {