forked from awslabs/aws-sdk-kotlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
customer-profiles.json
10821 lines (10821 loc) · 500 KB
/
customer-profiles.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
{
"smithy": "2.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.customerprofiles#AccessDeniedException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.customerprofiles#message"
}
},
"traits": {
"smithy.api#documentation": "<p>You do not have sufficient access to perform this action.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.customerprofiles#AddProfileKey": {
"type": "operation",
"input": {
"target": "com.amazonaws.customerprofiles#AddProfileKeyRequest"
},
"output": {
"target": "com.amazonaws.customerprofiles#AddProfileKeyResponse"
},
"errors": [
{
"target": "com.amazonaws.customerprofiles#AccessDeniedException"
},
{
"target": "com.amazonaws.customerprofiles#BadRequestException"
},
{
"target": "com.amazonaws.customerprofiles#InternalServerException"
},
{
"target": "com.amazonaws.customerprofiles#ResourceNotFoundException"
},
{
"target": "com.amazonaws.customerprofiles#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associates a new key value with a specific profile, such as a Contact Record\n ContactId.</p>\n <p>A profile object can have a single unique key and any number of additional keys that can\n be used to identify the profile that it belongs to.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/domains/{DomainName}/profiles/keys",
"code": 200
}
}
},
"com.amazonaws.customerprofiles#AddProfileKeyRequest": {
"type": "structure",
"members": {
"ProfileId": {
"target": "com.amazonaws.customerprofiles#uuid",
"traits": {
"smithy.api#documentation": "<p>The unique identifier of a customer profile.</p>",
"smithy.api#required": {}
}
},
"KeyName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>A searchable identifier of a customer profile. The predefined keys you can use\n include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone,\n _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,\n _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId,\n _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId,\n _shopifyOrderId.</p>",
"smithy.api#required": {}
}
},
"Values": {
"target": "com.amazonaws.customerprofiles#requestValueList",
"traits": {
"smithy.api#documentation": "<p>A list of key values.</p>",
"smithy.api#required": {}
}
},
"DomainName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>The unique name of the domain.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.customerprofiles#AddProfileKeyResponse": {
"type": "structure",
"members": {
"KeyName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>A searchable identifier of a customer profile.</p>"
}
},
"Values": {
"target": "com.amazonaws.customerprofiles#requestValueList",
"traits": {
"smithy.api#documentation": "<p>A list of key values.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.customerprofiles#AdditionalSearchKey": {
"type": "structure",
"members": {
"KeyName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>A searchable identifier of a customer profile.</p>",
"smithy.api#required": {}
}
},
"Values": {
"target": "com.amazonaws.customerprofiles#requestValueList",
"traits": {
"smithy.api#documentation": "<p>A list of key values.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list that is\n used in conjunction with the\n <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName\">KeyName</a>\n and\n <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values\">Values</a>\n parameters to search for profiles using the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html\">SearchProfiles</a> API.</p>"
}
},
"com.amazonaws.customerprofiles#Address": {
"type": "structure",
"members": {
"Address1": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The first line of a customer address.</p>"
}
},
"Address2": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The second line of a customer address.</p>"
}
},
"Address3": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The third line of a customer address.</p>"
}
},
"Address4": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The fourth line of a customer address.</p>"
}
},
"City": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The city in which a customer lives.</p>"
}
},
"County": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The county in which a customer lives.</p>"
}
},
"State": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The state in which a customer lives.</p>"
}
},
"Province": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The province in which a customer lives.</p>"
}
},
"Country": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The country in which a customer lives.</p>"
}
},
"PostalCode": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The postal code of a customer address.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A generic address associated with the customer that is not mailing, shipping, or\n billing.</p>",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.customerprofiles#AddressList": {
"type": "list",
"member": {
"target": "com.amazonaws.customerprofiles#string1To255"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 4
}
}
},
"com.amazonaws.customerprofiles#AppflowIntegration": {
"type": "structure",
"members": {
"FlowDefinition": {
"target": "com.amazonaws.customerprofiles#FlowDefinition",
"traits": {
"smithy.api#required": {}
}
},
"Batches": {
"target": "com.amazonaws.customerprofiles#Batches",
"traits": {
"smithy.api#documentation": "<p>Batches in workflow of type <code>APPFLOW_INTEGRATION</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details for workflow of type <code>APPFLOW_INTEGRATION</code>.</p>"
}
},
"com.amazonaws.customerprofiles#AppflowIntegrationWorkflowAttributes": {
"type": "structure",
"members": {
"SourceConnectorType": {
"target": "com.amazonaws.customerprofiles#SourceConnectorType",
"traits": {
"smithy.api#documentation": "<p>Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.</p>",
"smithy.api#required": {}
}
},
"ConnectorProfileName": {
"target": "com.amazonaws.customerprofiles#ConnectorProfileName",
"traits": {
"smithy.api#documentation": "<p>The name of the AppFlow connector profile used for ingestion.</p>",
"smithy.api#required": {}
}
},
"RoleArn": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<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>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Structure holding all <code>APPFLOW_INTEGRATION</code> specific workflow attributes.</p>"
}
},
"com.amazonaws.customerprofiles#AppflowIntegrationWorkflowMetrics": {
"type": "structure",
"members": {
"RecordsProcessed": {
"target": "com.amazonaws.customerprofiles#long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Number of records processed in <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"StepsCompleted": {
"target": "com.amazonaws.customerprofiles#long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Total steps completed in <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"TotalSteps": {
"target": "com.amazonaws.customerprofiles#long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Total steps in <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Workflow specific execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
}
},
"com.amazonaws.customerprofiles#AppflowIntegrationWorkflowStep": {
"type": "structure",
"members": {
"FlowName": {
"target": "com.amazonaws.customerprofiles#FlowName",
"traits": {
"smithy.api#documentation": "<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>",
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.customerprofiles#Status",
"traits": {
"smithy.api#documentation": "<p>Workflow step status for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"ExecutionMessage": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>Message indicating execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"RecordsProcessed": {
"target": "com.amazonaws.customerprofiles#long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Total number of records processed during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"BatchRecordsStartTime": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>Start datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"BatchRecordsEndTime": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>End datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"CreatedAt": {
"target": "com.amazonaws.customerprofiles#timestamp",
"traits": {
"smithy.api#documentation": "<p>Creation timestamp of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
},
"LastUpdatedAt": {
"target": "com.amazonaws.customerprofiles#timestamp",
"traits": {
"smithy.api#documentation": "<p>Last updated timestamp for workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Workflow step details for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
}
},
"com.amazonaws.customerprofiles#AttributeDetails": {
"type": "structure",
"members": {
"Attributes": {
"target": "com.amazonaws.customerprofiles#AttributeList",
"traits": {
"smithy.api#documentation": "<p>A list of attribute items specified in the mathematical expression.</p>",
"smithy.api#required": {}
}
},
"Expression": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \\\"{ObjectTypeName.AttributeName}\\\".</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Mathematical expression and a list of attribute items specified in that expression.</p>",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.customerprofiles#AttributeItem": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.customerprofiles#attributeName",
"traits": {
"smithy.api#documentation": "<p>The name of an attribute defined in a profile object type.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of a single attribute item specified in the mathematical expression.</p>"
}
},
"com.amazonaws.customerprofiles#AttributeList": {
"type": "list",
"member": {
"target": "com.amazonaws.customerprofiles#AttributeItem"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2
}
}
},
"com.amazonaws.customerprofiles#AttributeMatchingModel": {
"type": "enum",
"members": {
"ONE_TO_ONE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ONE_TO_ONE"
}
},
"MANY_TO_MANY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MANY_TO_MANY"
}
}
}
},
"com.amazonaws.customerprofiles#AttributeSourceIdMap": {
"type": "map",
"key": {
"target": "com.amazonaws.customerprofiles#string1To255"
},
"value": {
"target": "com.amazonaws.customerprofiles#uuid"
}
},
"com.amazonaws.customerprofiles#AttributeTypesSelector": {
"type": "structure",
"members": {
"AttributeMatchingModel": {
"target": "com.amazonaws.customerprofiles#AttributeMatchingModel",
"traits": {
"smithy.api#documentation": "<p>Configures the <code>AttributeMatchingModel</code>, you can either choose <code>ONE_TO_ONE</code> or \n <code>MANY_TO_MANY</code>.</p>",
"smithy.api#required": {}
}
},
"Address": {
"target": "com.amazonaws.customerprofiles#AddressList",
"traits": {
"smithy.api#documentation": "<p>The <code>Address</code> type. You can choose from <code>Address</code>,\n <code>BusinessAddress</code>, <code>MaillingAddress</code>, and\n <code>ShippingAddress</code>.</p>\n <p>You only can use the Address type in the <code>MatchingRule</code>. For example, if you\n want to match profile based on <code>BusinessAddress.City</code> or\n <code>MaillingAddress.City</code>, you need to choose the <code>BusinessAddress</code>\n and the <code>MaillingAddress</code> to represent the Address type and specify the\n <code>Address.City</code> on the matching rule.</p>"
}
},
"PhoneNumber": {
"target": "com.amazonaws.customerprofiles#PhoneNumberList",
"traits": {
"smithy.api#documentation": "<p>The <code>PhoneNumber</code> type. You can choose from <code>PhoneNumber</code>,\n <code>HomePhoneNumber</code>, and <code>MobilePhoneNumber</code>.</p>\n <p>You only can use the <code>PhoneNumber</code> type in the <code>MatchingRule</code>. For\n example, if you want to match a profile based on <code>Phone</code> or\n <code>HomePhone</code>, you need to choose the <code>Phone</code> and the\n <code>HomePhone</code> to represent the <code>PhoneNumber</code> type and only specify\n the <code>PhoneNumber</code> on the matching rule.</p>"
}
},
"EmailAddress": {
"target": "com.amazonaws.customerprofiles#EmailList",
"traits": {
"smithy.api#documentation": "<p>The <code>Email</code> type. You can choose from <code>EmailAddress</code>,\n <code>BusinessEmailAddress</code> and <code>PersonalEmailAddress</code>.</p>\n <p>You only can use the <code>EmailAddress</code> type in the <code>MatchingRule</code>.\n For example, if you want to match profile based on <code>PersonalEmailAddress</code> or\n <code>BusinessEmailAddress</code>, you need to choose the\n <code>PersonalEmailAddress</code> and the <code>BusinessEmailAddress</code> to represent\n the <code>EmailAddress</code> type and only specify the <code>EmailAddress</code> on the\n matching rule.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration information about the <code>AttributeTypesSelector </code>where the\n rule-based identity resolution uses to match profiles. You can choose how profiles are\n compared across attribute types and which attribute to use for matching from each type.\n There are three attribute types you can configure:</p>\n <ul>\n <li>\n <p>Email type</p>\n <ul>\n <li>\n <p>You can choose from <code>Email</code>, <code>BusinessEmail</code>, and\n <code>PersonalEmail</code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>Phone number type</p>\n <ul>\n <li>\n <p>You can choose from <code>Phone</code>, <code>HomePhone</code>, and\n <code>MobilePhone</code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>Address type</p>\n <ul>\n <li>\n <p>You can choose from <code>Address</code>, <code>BusinessAddress</code>,\n <code>MaillingAddress</code>, and <code>ShippingAddress</code>\n </p>\n </li>\n </ul>\n </li>\n </ul>\n <p>You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the\n <code>AttributeMatchingModel</code>. When choosing <code>MANY_TO_MANY</code>, the system\n can match attribute across the sub-types of an attribute type. For example, if the value of\n the <code>Email</code> field of Profile A and the value of <code>BusinessEmail</code> field\n of Profile B matches, the two profiles are matched on the Email type. When choosing\n <code>ONE_TO_ONE</code> the system can only match if the sub-types are exact matches.\n For example, only when the value of the <code>Email</code> field of Profile A and the value\n of the <code>Email</code> field of Profile B matches, the two profiles are matched on the\n Email type.</p>"
}
},
"com.amazonaws.customerprofiles#Attributes": {
"type": "map",
"key": {
"target": "com.amazonaws.customerprofiles#string1To255"
},
"value": {
"target": "com.amazonaws.customerprofiles#string1To255"
},
"traits": {
"smithy.api#sensitive": {}
}
},
"com.amazonaws.customerprofiles#AutoMerging": {
"type": "structure",
"members": {
"Enabled": {
"target": "com.amazonaws.customerprofiles#optionalBoolean",
"traits": {
"smithy.api#documentation": "<p>The flag that enables the auto-merging of duplicate profiles.</p>",
"smithy.api#required": {}
}
},
"Consolidation": {
"target": "com.amazonaws.customerprofiles#Consolidation",
"traits": {
"smithy.api#documentation": "<p>A list of matching attributes that represent matching criteria. If two profiles meet at\n least one of the requirements in the matching attributes list, they will be merged.</p>"
}
},
"ConflictResolution": {
"target": "com.amazonaws.customerprofiles#ConflictResolution",
"traits": {
"smithy.api#documentation": "<p>How the auto-merging process should resolve conflicts between different profiles. For\n example, if Profile A and Profile B have the same <code>FirstName</code> and\n <code>LastName</code> (and that is the matching criteria), which\n <code>EmailAddress</code> should be used? </p>"
}
},
"MinAllowedConfidenceScoreForMerging": {
"target": "com.amazonaws.customerprofiles#Double0To1",
"traits": {
"smithy.api#documentation": "<p>A number between 0 and 1 that represents the minimum confidence score required for\n profiles within a matching group to be merged during the auto-merge process. A higher\n score means higher similarity required to merge profiles. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration settings for how to perform the auto-merging of profiles.</p>"
}
},
"com.amazonaws.customerprofiles#BadRequestException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.customerprofiles#message"
}
},
"traits": {
"smithy.api#documentation": "<p>The input you provided is invalid.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.customerprofiles#Batch": {
"type": "structure",
"members": {
"StartTime": {
"target": "com.amazonaws.customerprofiles#timestamp",
"traits": {
"smithy.api#documentation": "<p>Start time of batch to split ingestion.</p>",
"smithy.api#required": {}
}
},
"EndTime": {
"target": "com.amazonaws.customerprofiles#timestamp",
"traits": {
"smithy.api#documentation": "<p>End time of batch to split ingestion.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<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>"
}
},
"com.amazonaws.customerprofiles#Batches": {
"type": "list",
"member": {
"target": "com.amazonaws.customerprofiles#Batch"
}
},
"com.amazonaws.customerprofiles#BucketName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 3,
"max": 63
},
"smithy.api#pattern": "^\\S+$"
}
},
"com.amazonaws.customerprofiles#BucketPrefix": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 512
},
"smithy.api#pattern": ".*"
}
},
"com.amazonaws.customerprofiles#CalculatedAttributeDefinitionsList": {
"type": "list",
"member": {
"target": "com.amazonaws.customerprofiles#ListCalculatedAttributeDefinitionItem"
},
"traits": {
"smithy.api#sensitive": {}
}
},
"com.amazonaws.customerprofiles#CalculatedAttributesForProfileList": {
"type": "list",
"member": {
"target": "com.amazonaws.customerprofiles#ListCalculatedAttributeForProfileItem"
}
},
"com.amazonaws.customerprofiles#Conditions": {
"type": "structure",
"members": {
"Range": {
"target": "com.amazonaws.customerprofiles#Range",
"traits": {
"smithy.api#documentation": "<p>The relative time period over which data is included in the aggregation.</p>"
}
},
"ObjectCount": {
"target": "com.amazonaws.customerprofiles#ObjectCount",
"traits": {
"smithy.api#documentation": "<p>The number of profile objects used for the calculated attribute.</p>"
}
},
"Threshold": {
"target": "com.amazonaws.customerprofiles#Threshold",
"traits": {
"smithy.api#documentation": "<p>The threshold for the calculated attribute.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The conditions including range, object count, and threshold for the calculated attribute.</p>",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.customerprofiles#ConflictResolution": {
"type": "structure",
"members": {
"ConflictResolvingModel": {
"target": "com.amazonaws.customerprofiles#ConflictResolvingModel",
"traits": {
"smithy.api#documentation": "<p>How the auto-merging process should resolve conflicts between different profiles.</p>\n <ul>\n <li>\n <p>\n <code>RECENCY</code>: Uses the data that was most recently updated.</p>\n </li>\n <li>\n <p>\n <code>SOURCE</code>: Uses the data from a specific source. For example, if a\n company has been aquired or two departments have merged, data from the specified\n source is used. If two duplicate profiles are from the same source, then\n <code>RECENCY</code> is used again.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"SourceName": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The <code>ObjectType</code> name that is used to resolve profile merging conflicts when\n choosing <code>SOURCE</code> as the <code>ConflictResolvingModel</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>How the auto-merging process should resolve conflicts between different profiles.</p>"
}
},
"com.amazonaws.customerprofiles#ConflictResolvingModel": {
"type": "enum",
"members": {
"RECENCY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "RECENCY"
}
},
"SOURCE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SOURCE"
}
}
}
},
"com.amazonaws.customerprofiles#ConnectorOperator": {
"type": "structure",
"members": {
"Marketo": {
"target": "com.amazonaws.customerprofiles#MarketoConnectorOperator",
"traits": {
"smithy.api#documentation": "<p>The operation to be performed on the provided Marketo source fields.</p>"
}
},
"S3": {
"target": "com.amazonaws.customerprofiles#S3ConnectorOperator",
"traits": {
"smithy.api#documentation": "<p>The operation to be performed on the provided Amazon S3 source fields.</p>"
}
},
"Salesforce": {
"target": "com.amazonaws.customerprofiles#SalesforceConnectorOperator",
"traits": {
"smithy.api#documentation": "<p>The operation to be performed on the provided Salesforce source fields.</p>"
}
},
"ServiceNow": {
"target": "com.amazonaws.customerprofiles#ServiceNowConnectorOperator",
"traits": {
"smithy.api#documentation": "<p>The operation to be performed on the provided ServiceNow source fields.</p>"
}
},
"Zendesk": {
"target": "com.amazonaws.customerprofiles#ZendeskConnectorOperator",
"traits": {
"smithy.api#documentation": "<p>The operation to be performed on the provided Zendesk source fields.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The operation to be performed on the provided source fields.</p>"
}
},
"com.amazonaws.customerprofiles#ConnectorProfileName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
},
"smithy.api#pattern": "^[\\w/!@#+=.-]+$"
}
},
"com.amazonaws.customerprofiles#Consolidation": {
"type": "structure",
"members": {
"MatchingAttributesList": {
"target": "com.amazonaws.customerprofiles#MatchingAttributesList",
"traits": {
"smithy.api#documentation": "<p>A list of matching criteria.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The matching criteria to be used during the auto-merging process. </p>"
}
},
"com.amazonaws.customerprofiles#CreateCalculatedAttributeDefinition": {
"type": "operation",
"input": {
"target": "com.amazonaws.customerprofiles#CreateCalculatedAttributeDefinitionRequest"
},
"output": {
"target": "com.amazonaws.customerprofiles#CreateCalculatedAttributeDefinitionResponse"
},
"errors": [
{
"target": "com.amazonaws.customerprofiles#AccessDeniedException"
},
{
"target": "com.amazonaws.customerprofiles#BadRequestException"
},
{
"target": "com.amazonaws.customerprofiles#InternalServerException"
},
{
"target": "com.amazonaws.customerprofiles#ResourceNotFoundException"
},
{
"target": "com.amazonaws.customerprofiles#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new calculated attribute definition. After creation, new object data ingested \n into Customer Profiles will be included in the calculated attribute, which can be retrieved \n for a profile using the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html\">GetCalculatedAttributeForProfile</a> API. \n Defining a calculated attribute makes it available for all profiles within a domain. Each \n calculated attribute can only reference one <code>ObjectType</code> and at most, two fields \n from that <code>ObjectType</code>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}",
"code": 200
}
}
},
"com.amazonaws.customerprofiles#CreateCalculatedAttributeDefinitionRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>The unique name of the domain.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"CalculatedAttributeName": {
"target": "com.amazonaws.customerprofiles#typeName",
"traits": {
"smithy.api#documentation": "<p>The unique name of the calculated attribute.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"DisplayName": {
"target": "com.amazonaws.customerprofiles#displayName",
"traits": {
"smithy.api#documentation": "<p>The display name of the calculated attribute.</p>"
}
},
"Description": {
"target": "com.amazonaws.customerprofiles#sensitiveText",
"traits": {
"smithy.api#documentation": "<p>The description of the calculated attribute.</p>"
}
},
"AttributeDetails": {
"target": "com.amazonaws.customerprofiles#AttributeDetails",
"traits": {
"smithy.api#documentation": "<p>Mathematical expression and a list of attribute items specified in that expression.</p>",
"smithy.api#required": {}
}
},
"Conditions": {
"target": "com.amazonaws.customerprofiles#Conditions",
"traits": {
"smithy.api#documentation": "<p>The conditions including range, object count, and threshold for the calculated attribute.</p>"
}
},
"Statistic": {
"target": "com.amazonaws.customerprofiles#Statistic",
"traits": {
"smithy.api#documentation": "<p>The aggregation operation to perform for the calculated attribute.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.customerprofiles#TagMap",
"traits": {
"smithy.api#documentation": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.customerprofiles#CreateCalculatedAttributeDefinitionResponse": {
"type": "structure",
"members": {
"CalculatedAttributeName": {
"target": "com.amazonaws.customerprofiles#typeName",
"traits": {
"smithy.api#documentation": "<p>The unique name of the calculated attribute.</p>"
}
},
"DisplayName": {
"target": "com.amazonaws.customerprofiles#displayName",
"traits": {
"smithy.api#documentation": "<p>The display name of the calculated attribute.</p>"
}
},
"Description": {
"target": "com.amazonaws.customerprofiles#sensitiveText",
"traits": {
"smithy.api#documentation": "<p>The description of the calculated attribute.</p>"
}
},
"AttributeDetails": {
"target": "com.amazonaws.customerprofiles#AttributeDetails",
"traits": {
"smithy.api#documentation": "<p>Mathematical expression and a list of attribute items specified in that expression.</p>"
}
},
"Conditions": {
"target": "com.amazonaws.customerprofiles#Conditions",
"traits": {
"smithy.api#documentation": "<p>The conditions including range, object count, and threshold for the calculated attribute.</p>"
}
},
"Statistic": {
"target": "com.amazonaws.customerprofiles#Statistic",
"traits": {
"smithy.api#documentation": "<p>The aggregation operation to perform for the calculated attribute.</p>"
}
},
"CreatedAt": {
"target": "com.amazonaws.customerprofiles#timestamp",
"traits": {
"smithy.api#documentation": "<p>The timestamp of when the calculated attribute definition was created.</p>"
}
},
"LastUpdatedAt": {
"target": "com.amazonaws.customerprofiles#timestamp",
"traits": {
"smithy.api#documentation": "<p>The timestamp of when the calculated attribute definition was most recently edited.</p>"
}
},
"Tags": {
"target": "com.amazonaws.customerprofiles#TagMap",
"traits": {
"smithy.api#documentation": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.customerprofiles#CreateDomain": {
"type": "operation",
"input": {
"target": "com.amazonaws.customerprofiles#CreateDomainRequest"
},
"output": {
"target": "com.amazonaws.customerprofiles#CreateDomainResponse"
},
"errors": [
{
"target": "com.amazonaws.customerprofiles#AccessDeniedException"
},
{
"target": "com.amazonaws.customerprofiles#BadRequestException"
},
{
"target": "com.amazonaws.customerprofiles#InternalServerException"
},
{
"target": "com.amazonaws.customerprofiles#ResourceNotFoundException"
},
{
"target": "com.amazonaws.customerprofiles#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a domain, which is a container for all customer data, such as customer profile\n attributes, object types, profile keys, and encryption keys. You can create multiple\n domains, and each domain can have multiple third-party integrations.</p>\n <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.</p>\n <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to\n enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity\n resolution</a>: set <code>Matching</code> to true.</p>\n <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\n apply. </p>",
"smithy.api#http": {
"method": "POST",
"uri": "/domains/{DomainName}",
"code": 200
}
}
},
"com.amazonaws.customerprofiles#CreateDomainRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>The unique name of the domain.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"DefaultExpirationDays": {
"target": "com.amazonaws.customerprofiles#expirationDaysInteger",
"traits": {
"smithy.api#documentation": "<p>The default number of days until the data within the domain expires.</p>",
"smithy.api#required": {}
}
},
"DefaultEncryptionKey": {
"target": "com.amazonaws.customerprofiles#encryptionKey",
"traits": {
"smithy.api#documentation": "<p>The default encryption key, which is an AWS managed key, is used when no specific type\n of encryption key is specified. It is used to encrypt all data before it is placed in\n permanent or semi-permanent storage.</p>"
}
},
"DeadLetterQueueUrl": {
"target": "com.amazonaws.customerprofiles#sqsQueueUrl",
"traits": {
"smithy.api#documentation": "<p>The URL of the SQS dead letter queue, which is used for reporting errors associated with\n ingesting data from third party applications. You must set up a policy on the\n DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send\n messages to the DeadLetterQueue.</p>"
}
},
"Matching": {
"target": "com.amazonaws.customerprofiles#MatchingRequest",
"traits": {
"smithy.api#documentation": "<p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly\nbatch 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 \nSaturday at 12AM UTC to detect duplicate profiles in your domains. </p>\n <p>After the Identity Resolution Job completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI 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\nS3.</p>"
}
},
"RuleBasedMatching": {
"target": "com.amazonaws.customerprofiles#RuleBasedMatchingRequest",
"traits": {
"smithy.api#documentation": "<p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true, \n Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration \n in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and \n review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can \n download the results from S3.</p>"
}
},
"Tags": {
"target": "com.amazonaws.customerprofiles#TagMap",
"traits": {
"smithy.api#documentation": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.customerprofiles#CreateDomainResponse": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>The unique name of the domain.</p>",
"smithy.api#required": {}
}
},
"DefaultExpirationDays": {
"target": "com.amazonaws.customerprofiles#expirationDaysInteger",
"traits": {
"smithy.api#documentation": "<p>The default number of days until the data within the domain expires.</p>",