@aws-sdk/client-customer-profiles 3.1133.0 → 3.1134.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -913,6 +913,13 @@ SearchProfiles
913
913
  </details>
914
914
  <details>
915
915
  <summary>
916
+ SearchRecommendations
917
+ </summary>
918
+
919
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/customer-profiles/command/SearchRecommendationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-customer-profiles/Interface/SearchRecommendationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-customer-profiles/Interface/SearchRecommendationsCommandOutput/)
920
+ </details>
921
+ <details>
922
+ <summary>
916
923
  StartRecommender
917
924
  </summary>
918
925
 
package/dist-cjs/index.js CHANGED
@@ -69,7 +69,7 @@ const commonParams = {
69
69
  UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
70
70
  };
71
71
 
72
- var version = "3.1132.0";
72
+ var version = "3.1133.0";
73
73
  var packageInfo = {
74
74
  version: version};
75
75
 
@@ -356,6 +356,7 @@ const _CUJRr = "CreateUploadJobResponse";
356
356
  const _Ca = "Category";
357
357
  const _Co = "County";
358
358
  const _Cod = "Code";
359
+ const _Col = "Columns";
359
360
  const _Con = "Consolidation";
360
361
  const _Cond = "Conditions";
361
362
  const _Cont = "Content";
@@ -457,6 +458,7 @@ const _DWR = "DeleteWorkflowRequest";
457
458
  const _DWRe = "DeleteWorkflowResponse";
458
459
  const _Di = "Dimensions";
459
460
  const _Dim = "Dimension";
461
+ const _Div = "Diversity";
460
462
  const _E = "Expression";
461
463
  const _EA = "EmailAddress";
462
464
  const _EC = "EventsConfig";
@@ -521,6 +523,7 @@ const _FT = "FeatureType";
521
523
  const _Fa = "Failures";
522
524
  const _Fi = "Filter";
523
525
  const _Fie = "Fields";
526
+ const _Fil = "Filters";
524
527
  const _G = "Gender";
525
528
  const _GAMP = "GetAutoMergingPreview";
526
529
  const _GAMPR = "GetAutoMergingPreviewRequest";
@@ -648,6 +651,8 @@ const _KA = "KmsArn";
648
651
  const _KM = "KeyMap";
649
652
  const _KN = "KeyName";
650
653
  const _KV = "KeyValue";
654
+ const _KVL = "KeyValuesList";
655
+ const _KVe = "KeyValues";
651
656
  const _L = "Link";
652
657
  const _LAI = "ListAccountIntegrations";
653
658
  const _LAIR = "ListAccountIntegrationsRequest";
@@ -781,6 +786,7 @@ const _MRa = "MatchingRequest";
781
786
  const _MRat = "MatchingResponse";
782
787
  const _MRatc = "MatchingRule";
783
788
  const _MRatch = "MatchingRules";
789
+ const _MRax = "MaxRecommendations";
784
790
  const _MSP = "MarketoSourceProperties";
785
791
  const _MT = "MatchType";
786
792
  const _Ma = "Marketo";
@@ -788,6 +794,7 @@ const _Mat = "Matching";
788
794
  const _Matc = "Matches";
789
795
  const _Max = "Maximum";
790
796
  const _Me = "Metrics";
797
+ const _Met = "Metadata";
791
798
  const _Mi = "Minimum";
792
799
  const _N = "Name";
793
800
  const _NEA = "NextExecutedAt";
@@ -823,6 +830,7 @@ const _PDOT = "PutDomainObjectType";
823
830
  const _PDOTR = "PutDomainObjectTypeRequest";
824
831
  const _PDOTRu = "PutDomainObjectTypeResponse";
825
832
  const _PEA = "PersonalEmailAddress";
833
+ const _PF = "PromotionalFilters";
826
834
  const _PHR = "ProfileHistoryRecords";
827
835
  const _PHRr = "ProfileHistoryRecord";
828
836
  const _PI = "ProfileId";
@@ -892,6 +900,7 @@ const _RFSL = "RecommenderFilterSummaryList";
892
900
  const _RFV = "RecommenderFilterValues";
893
901
  const _RFe = "RecommenderFilter";
894
902
  const _RL = "RuleLevel";
903
+ const _RM = "RecommendationMetadata";
895
904
  const _RN = "RecommenderName";
896
905
  const _RNFE = "ResourceNotFoundException";
897
906
  const _RNe = "RecipeName";
@@ -920,6 +929,7 @@ const _Re = "Readiness";
920
929
  const _Rec = "Recommendations";
921
930
  const _Reco = "Recommenders";
922
931
  const _Recom = "Recommendation";
932
+ const _Recomm = "Recommender";
923
933
  const _Ru = "Rule";
924
934
  const _S = "Statistic";
925
935
  const _SA = "ShippingAddress";
@@ -972,10 +982,13 @@ const _SPRe = "SearchProfilesResponse";
972
982
  const _SPe = "SearchProfiles";
973
983
  const _SQ = "SegmentQuery";
974
984
  const _SR = "StatusReason";
975
- const _SRR = "StartRecommenderRequest";
976
- const _SRRt = "StartRecommenderResponse";
985
+ const _SRR = "SearchRecommendationsRequest";
986
+ const _SRRe = "SearchRecommendationsResponse";
987
+ const _SRRt = "StartRecommenderRequest";
988
+ const _SRRta = "StartRecommenderResponse";
977
989
  const _SRRto = "StopRecommenderRequest";
978
990
  const _SRRtop = "StopRecommenderResponse";
991
+ const _SRe = "SearchRecommendations";
979
992
  const _SRt = "StartRecommender";
980
993
  const _SRto = "StopRecommender";
981
994
  const _SS = "SegmentSort";
@@ -2684,6 +2697,16 @@ var RecommendationDiversityConfig$ = [3, n0, _RDC,
2684
2697
  [_En, _V],
2685
2698
  [2, 128 | 1], 1
2686
2699
  ];
2700
+ var RecommendationMetadata$ = [3, n0, _RM,
2701
+ 0,
2702
+ [_Col],
2703
+ [64 | 0]
2704
+ ];
2705
+ var Recommender$ = [3, n0, _Recomm,
2706
+ 0,
2707
+ [_N, _Fil, _PF],
2708
+ [0, [() => RecommenderFilters, 0], [() => RecommenderPromotionalFilters, 0]], 1
2709
+ ];
2687
2710
  var RecommenderConfig$ = [3, n0, _RC,
2688
2711
  0,
2689
2712
  [_EC, _TFr, _ICn, _ICnc, _ECxc, _DCi],
@@ -2789,6 +2812,16 @@ var SearchProfilesResponse$ = [3, n0, _SPRe,
2789
2812
  [_It, _NT],
2790
2813
  [[() => ProfileList, 0], 0]
2791
2814
  ];
2815
+ var SearchRecommendationsRequest$ = [3, n0, _SRR,
2816
+ 0,
2817
+ [_DN, _KN, _KVe, _Recomm, _CIa, _Conte, _Div, _Met, _MRax],
2818
+ [[0, 1], 0, [() => KeyValuesList, 0], [() => Recommender$, 0], 64 | 0, [() => RecommenderContext, 0], () => RecommendationDiversityConfig$, () => RecommendationMetadata$, 1], 4
2819
+ ];
2820
+ var SearchRecommendationsResponse$ = [3, n0, _SRRe,
2821
+ 0,
2822
+ [_PI, _Rec],
2823
+ [0, [() => Recommendations, 0]]
2824
+ ];
2792
2825
  var SegmentDefinitionItem$ = [3, n0, _SDI,
2793
2826
  0,
2794
2827
  [_SDN, _DNi, _D, _SDA, _CA, _Ta, _STe],
@@ -2834,12 +2867,12 @@ var SourceSegment$ = [3, n0, _SSou,
2834
2867
  [_SDN],
2835
2868
  [[0, { [_jN]: _SDN }]]
2836
2869
  ];
2837
- var StartRecommenderRequest$ = [3, n0, _SRR,
2870
+ var StartRecommenderRequest$ = [3, n0, _SRRt,
2838
2871
  0,
2839
2872
  [_DN, _RN],
2840
2873
  [[0, 1], [0, 1]], 2
2841
2874
  ];
2842
- var StartRecommenderResponse$ = [3, n0, _SRRt,
2875
+ var StartRecommenderResponse$ = [3, n0, _SRRta,
2843
2876
  0,
2844
2877
  [],
2845
2878
  []
@@ -3116,6 +3149,9 @@ var IdentityResolutionJobsList = [1, n0, _IRJL,
3116
3149
  var IntegrationList = [1, n0, _ILn,
3117
3150
  0, () => ListIntegrationItem$
3118
3151
  ];
3152
+ var KeyValuesList = [1, n0, _KVL,
3153
+ 8, 0
3154
+ ];
3119
3155
  var LayoutList = [1, n0, _LL,
3120
3156
  0, [() => LayoutItem$,
3121
3157
  0]
@@ -3592,6 +3628,9 @@ var PutSegmentSubscription$ = [9, n0, _PSS,
3592
3628
  var SearchProfiles$ = [9, n0, _SPe,
3593
3629
  { [_h]: ["POST", "/domains/{DomainName}/profiles/search", 200] }, () => SearchProfilesRequest$, () => SearchProfilesResponse$
3594
3630
  ];
3631
+ var SearchRecommendations$ = [9, n0, _SRe,
3632
+ { [_h]: ["POST", "/domains/{DomainName}/recommendations", 200] }, () => SearchRecommendationsRequest$, () => SearchRecommendationsResponse$
3633
+ ];
3595
3634
  var StartRecommender$ = [9, n0, _SRt,
3596
3635
  { [_h]: ["PUT", "/domains/{DomainName}/recommenders/{RecommenderName}/start", 200] }, () => StartRecommenderRequest$, () => StartRecommenderResponse$
3597
3636
  ];
@@ -4085,6 +4124,9 @@ class PutSegmentSubscriptionCommand extends command(_ep0, _mw0, "PutSegmentSubsc
4085
4124
  class SearchProfilesCommand extends command(_ep0, _mw0, "SearchProfiles", SearchProfiles$) {
4086
4125
  }
4087
4126
 
4127
+ class SearchRecommendationsCommand extends command(_ep0, _mw0, "SearchRecommendations", SearchRecommendations$) {
4128
+ }
4129
+
4088
4130
  class StartRecommenderCommand extends command(_ep0, _mw0, "StartRecommender", StartRecommender$) {
4089
4131
  }
4090
4132
 
@@ -4252,6 +4294,7 @@ const commands = {
4252
4294
  PutProfileObjectTypeCommand,
4253
4295
  PutSegmentSubscriptionCommand,
4254
4296
  SearchProfilesCommand,
4297
+ SearchRecommendationsCommand,
4255
4298
  StartRecommenderCommand,
4256
4299
  StartUploadJobCommand,
4257
4300
  StopRecommenderCommand,
@@ -5371,6 +5414,8 @@ exports.Readiness$ = Readiness$;
5371
5414
  exports.ReadinessStatus = ReadinessStatus;
5372
5415
  exports.Recommendation$ = Recommendation$;
5373
5416
  exports.RecommendationDiversityConfig$ = RecommendationDiversityConfig$;
5417
+ exports.RecommendationMetadata$ = RecommendationMetadata$;
5418
+ exports.Recommender$ = Recommender$;
5374
5419
  exports.RecommenderConfig$ = RecommenderConfig$;
5375
5420
  exports.RecommenderFilter$ = RecommenderFilter$;
5376
5421
  exports.RecommenderFilterStatus = RecommenderFilterStatus;
@@ -5405,6 +5450,10 @@ exports.SearchProfiles$ = SearchProfiles$;
5405
5450
  exports.SearchProfilesCommand = SearchProfilesCommand;
5406
5451
  exports.SearchProfilesRequest$ = SearchProfilesRequest$;
5407
5452
  exports.SearchProfilesResponse$ = SearchProfilesResponse$;
5453
+ exports.SearchRecommendations$ = SearchRecommendations$;
5454
+ exports.SearchRecommendationsCommand = SearchRecommendationsCommand;
5455
+ exports.SearchRecommendationsRequest$ = SearchRecommendationsRequest$;
5456
+ exports.SearchRecommendationsResponse$ = SearchRecommendationsResponse$;
5408
5457
  exports.SegmentDefinitionItem$ = SegmentDefinitionItem$;
5409
5458
  exports.SegmentGroup$ = SegmentGroup$;
5410
5459
  exports.SegmentGroupStructure$ = SegmentGroupStructure$;
@@ -101,6 +101,7 @@ import { PutProfileObjectCommand, } from "./commands/PutProfileObjectCommand";
101
101
  import { PutProfileObjectTypeCommand, } from "./commands/PutProfileObjectTypeCommand";
102
102
  import { PutSegmentSubscriptionCommand, } from "./commands/PutSegmentSubscriptionCommand";
103
103
  import { SearchProfilesCommand, } from "./commands/SearchProfilesCommand";
104
+ import { SearchRecommendationsCommand, } from "./commands/SearchRecommendationsCommand";
104
105
  import { StartRecommenderCommand, } from "./commands/StartRecommenderCommand";
105
106
  import { StartUploadJobCommand, } from "./commands/StartUploadJobCommand";
106
107
  import { StopRecommenderCommand, } from "./commands/StopRecommenderCommand";
@@ -231,6 +232,7 @@ const commands = {
231
232
  PutProfileObjectTypeCommand,
232
233
  PutSegmentSubscriptionCommand,
233
234
  SearchProfilesCommand,
235
+ SearchRecommendationsCommand,
234
236
  StartRecommenderCommand,
235
237
  StartUploadJobCommand,
236
238
  StopRecommenderCommand,
@@ -0,0 +1,4 @@
1
+ import { _ep0, _mw0, command } from "../commandBuilder";
2
+ import { SearchRecommendations$ } from "../schemas/schemas_0";
3
+ export class SearchRecommendationsCommand extends command(_ep0, _mw0, "SearchRecommendations", SearchRecommendations$) {
4
+ }
@@ -100,6 +100,7 @@ export * from "./PutProfileObjectCommand";
100
100
  export * from "./PutProfileObjectTypeCommand";
101
101
  export * from "./PutSegmentSubscriptionCommand";
102
102
  export * from "./SearchProfilesCommand";
103
+ export * from "./SearchRecommendationsCommand";
103
104
  export * from "./StartRecommenderCommand";
104
105
  export * from "./StartUploadJobCommand";
105
106
  export * from "./StopRecommenderCommand";
@@ -145,6 +145,7 @@ const _CUJRr = "CreateUploadJobResponse";
145
145
  const _Ca = "Category";
146
146
  const _Co = "County";
147
147
  const _Cod = "Code";
148
+ const _Col = "Columns";
148
149
  const _Con = "Consolidation";
149
150
  const _Cond = "Conditions";
150
151
  const _Cont = "Content";
@@ -246,6 +247,7 @@ const _DWR = "DeleteWorkflowRequest";
246
247
  const _DWRe = "DeleteWorkflowResponse";
247
248
  const _Di = "Dimensions";
248
249
  const _Dim = "Dimension";
250
+ const _Div = "Diversity";
249
251
  const _E = "Expression";
250
252
  const _EA = "EmailAddress";
251
253
  const _EC = "EventsConfig";
@@ -310,6 +312,7 @@ const _FT = "FeatureType";
310
312
  const _Fa = "Failures";
311
313
  const _Fi = "Filter";
312
314
  const _Fie = "Fields";
315
+ const _Fil = "Filters";
313
316
  const _G = "Gender";
314
317
  const _GAMP = "GetAutoMergingPreview";
315
318
  const _GAMPR = "GetAutoMergingPreviewRequest";
@@ -437,6 +440,8 @@ const _KA = "KmsArn";
437
440
  const _KM = "KeyMap";
438
441
  const _KN = "KeyName";
439
442
  const _KV = "KeyValue";
443
+ const _KVL = "KeyValuesList";
444
+ const _KVe = "KeyValues";
440
445
  const _L = "Link";
441
446
  const _LAI = "ListAccountIntegrations";
442
447
  const _LAIR = "ListAccountIntegrationsRequest";
@@ -570,6 +575,7 @@ const _MRa = "MatchingRequest";
570
575
  const _MRat = "MatchingResponse";
571
576
  const _MRatc = "MatchingRule";
572
577
  const _MRatch = "MatchingRules";
578
+ const _MRax = "MaxRecommendations";
573
579
  const _MSP = "MarketoSourceProperties";
574
580
  const _MT = "MatchType";
575
581
  const _Ma = "Marketo";
@@ -577,6 +583,7 @@ const _Mat = "Matching";
577
583
  const _Matc = "Matches";
578
584
  const _Max = "Maximum";
579
585
  const _Me = "Metrics";
586
+ const _Met = "Metadata";
580
587
  const _Mi = "Minimum";
581
588
  const _N = "Name";
582
589
  const _NEA = "NextExecutedAt";
@@ -612,6 +619,7 @@ const _PDOT = "PutDomainObjectType";
612
619
  const _PDOTR = "PutDomainObjectTypeRequest";
613
620
  const _PDOTRu = "PutDomainObjectTypeResponse";
614
621
  const _PEA = "PersonalEmailAddress";
622
+ const _PF = "PromotionalFilters";
615
623
  const _PHR = "ProfileHistoryRecords";
616
624
  const _PHRr = "ProfileHistoryRecord";
617
625
  const _PI = "ProfileId";
@@ -681,6 +689,7 @@ const _RFSL = "RecommenderFilterSummaryList";
681
689
  const _RFV = "RecommenderFilterValues";
682
690
  const _RFe = "RecommenderFilter";
683
691
  const _RL = "RuleLevel";
692
+ const _RM = "RecommendationMetadata";
684
693
  const _RN = "RecommenderName";
685
694
  const _RNFE = "ResourceNotFoundException";
686
695
  const _RNe = "RecipeName";
@@ -709,6 +718,7 @@ const _Re = "Readiness";
709
718
  const _Rec = "Recommendations";
710
719
  const _Reco = "Recommenders";
711
720
  const _Recom = "Recommendation";
721
+ const _Recomm = "Recommender";
712
722
  const _Ru = "Rule";
713
723
  const _S = "Statistic";
714
724
  const _SA = "ShippingAddress";
@@ -761,10 +771,13 @@ const _SPRe = "SearchProfilesResponse";
761
771
  const _SPe = "SearchProfiles";
762
772
  const _SQ = "SegmentQuery";
763
773
  const _SR = "StatusReason";
764
- const _SRR = "StartRecommenderRequest";
765
- const _SRRt = "StartRecommenderResponse";
774
+ const _SRR = "SearchRecommendationsRequest";
775
+ const _SRRe = "SearchRecommendationsResponse";
776
+ const _SRRt = "StartRecommenderRequest";
777
+ const _SRRta = "StartRecommenderResponse";
766
778
  const _SRRto = "StopRecommenderRequest";
767
779
  const _SRRtop = "StopRecommenderResponse";
780
+ const _SRe = "SearchRecommendations";
768
781
  const _SRt = "StartRecommender";
769
782
  const _SRto = "StopRecommender";
770
783
  const _SS = "SegmentSort";
@@ -2476,6 +2489,16 @@ export var RecommendationDiversityConfig$ = [3, n0, _RDC,
2476
2489
  [_En, _V],
2477
2490
  [2, 128 | 1], 1
2478
2491
  ];
2492
+ export var RecommendationMetadata$ = [3, n0, _RM,
2493
+ 0,
2494
+ [_Col],
2495
+ [64 | 0]
2496
+ ];
2497
+ export var Recommender$ = [3, n0, _Recomm,
2498
+ 0,
2499
+ [_N, _Fil, _PF],
2500
+ [0, [() => RecommenderFilters, 0], [() => RecommenderPromotionalFilters, 0]], 1
2501
+ ];
2479
2502
  export var RecommenderConfig$ = [3, n0, _RC,
2480
2503
  0,
2481
2504
  [_EC, _TFr, _ICn, _ICnc, _ECxc, _DCi],
@@ -2581,6 +2604,16 @@ export var SearchProfilesResponse$ = [3, n0, _SPRe,
2581
2604
  [_It, _NT],
2582
2605
  [[() => ProfileList, 0], 0]
2583
2606
  ];
2607
+ export var SearchRecommendationsRequest$ = [3, n0, _SRR,
2608
+ 0,
2609
+ [_DN, _KN, _KVe, _Recomm, _CIa, _Conte, _Div, _Met, _MRax],
2610
+ [[0, 1], 0, [() => KeyValuesList, 0], [() => Recommender$, 0], 64 | 0, [() => RecommenderContext, 0], () => RecommendationDiversityConfig$, () => RecommendationMetadata$, 1], 4
2611
+ ];
2612
+ export var SearchRecommendationsResponse$ = [3, n0, _SRRe,
2613
+ 0,
2614
+ [_PI, _Rec],
2615
+ [0, [() => Recommendations, 0]]
2616
+ ];
2584
2617
  export var SegmentDefinitionItem$ = [3, n0, _SDI,
2585
2618
  0,
2586
2619
  [_SDN, _DNi, _D, _SDA, _CA, _Ta, _STe],
@@ -2626,12 +2659,12 @@ export var SourceSegment$ = [3, n0, _SSou,
2626
2659
  [_SDN],
2627
2660
  [[0, { [_jN]: _SDN }]]
2628
2661
  ];
2629
- export var StartRecommenderRequest$ = [3, n0, _SRR,
2662
+ export var StartRecommenderRequest$ = [3, n0, _SRRt,
2630
2663
  0,
2631
2664
  [_DN, _RN],
2632
2665
  [[0, 1], [0, 1]], 2
2633
2666
  ];
2634
- export var StartRecommenderResponse$ = [3, n0, _SRRt,
2667
+ export var StartRecommenderResponse$ = [3, n0, _SRRta,
2635
2668
  0,
2636
2669
  [],
2637
2670
  []
@@ -2919,6 +2952,9 @@ var IdentityResolutionJobsList = [1, n0, _IRJL,
2919
2952
  var IntegrationList = [1, n0, _ILn,
2920
2953
  0, () => ListIntegrationItem$
2921
2954
  ];
2955
+ var KeyValuesList = [1, n0, _KVL,
2956
+ 8, 0
2957
+ ];
2922
2958
  var LayoutList = [1, n0, _LL,
2923
2959
  0, [() => LayoutItem$,
2924
2960
  0]
@@ -3421,6 +3457,9 @@ export var PutSegmentSubscription$ = [9, n0, _PSS,
3421
3457
  export var SearchProfiles$ = [9, n0, _SPe,
3422
3458
  { [_h]: ["POST", "/domains/{DomainName}/profiles/search", 200] }, () => SearchProfilesRequest$, () => SearchProfilesResponse$
3423
3459
  ];
3460
+ export var SearchRecommendations$ = [9, n0, _SRe,
3461
+ { [_h]: ["POST", "/domains/{DomainName}/recommendations", 200] }, () => SearchRecommendationsRequest$, () => SearchRecommendationsResponse$
3462
+ ];
3424
3463
  export var StartRecommender$ = [9, n0, _SRt,
3425
3464
  { [_h]: ["PUT", "/domains/{DomainName}/recommenders/{RecommenderName}/start", 200] }, () => StartRecommenderRequest$, () => StartRecommenderResponse$
3426
3465
  ];
@@ -101,6 +101,7 @@ import { type PutProfileObjectCommandInput, type PutProfileObjectCommandOutput }
101
101
  import { type PutProfileObjectTypeCommandInput, type PutProfileObjectTypeCommandOutput } from "./commands/PutProfileObjectTypeCommand";
102
102
  import { type PutSegmentSubscriptionCommandInput, type PutSegmentSubscriptionCommandOutput } from "./commands/PutSegmentSubscriptionCommand";
103
103
  import { type SearchProfilesCommandInput, type SearchProfilesCommandOutput } from "./commands/SearchProfilesCommand";
104
+ import { type SearchRecommendationsCommandInput, type SearchRecommendationsCommandOutput } from "./commands/SearchRecommendationsCommand";
104
105
  import { type StartRecommenderCommandInput, type StartRecommenderCommandOutput } from "./commands/StartRecommenderCommand";
105
106
  import { type StartUploadJobCommandInput, type StartUploadJobCommandOutput } from "./commands/StartUploadJobCommand";
106
107
  import { type StopRecommenderCommandInput, type StopRecommenderCommandOutput } from "./commands/StopRecommenderCommand";
@@ -730,6 +731,12 @@ export interface CustomerProfiles {
730
731
  searchProfiles(args: SearchProfilesCommandInput, options?: __HttpHandlerOptions): Promise<SearchProfilesCommandOutput>;
731
732
  searchProfiles(args: SearchProfilesCommandInput, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void;
732
733
  searchProfiles(args: SearchProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void;
734
+ /**
735
+ * @see {@link SearchRecommendationsCommand}
736
+ */
737
+ searchRecommendations(args: SearchRecommendationsCommandInput, options?: __HttpHandlerOptions): Promise<SearchRecommendationsCommandOutput>;
738
+ searchRecommendations(args: SearchRecommendationsCommandInput, cb: (err: any, data?: SearchRecommendationsCommandOutput) => void): void;
739
+ searchRecommendations(args: SearchRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchRecommendationsCommandOutput) => void): void;
733
740
  /**
734
741
  * @see {@link StartRecommenderCommand}
735
742
  */
@@ -108,6 +108,7 @@ import type { PutProfileObjectCommandInput, PutProfileObjectCommandOutput } from
108
108
  import type { PutProfileObjectTypeCommandInput, PutProfileObjectTypeCommandOutput } from "./commands/PutProfileObjectTypeCommand";
109
109
  import type { PutSegmentSubscriptionCommandInput, PutSegmentSubscriptionCommandOutput } from "./commands/PutSegmentSubscriptionCommand";
110
110
  import type { SearchProfilesCommandInput, SearchProfilesCommandOutput } from "./commands/SearchProfilesCommand";
111
+ import type { SearchRecommendationsCommandInput, SearchRecommendationsCommandOutput } from "./commands/SearchRecommendationsCommand";
111
112
  import type { StartRecommenderCommandInput, StartRecommenderCommandOutput } from "./commands/StartRecommenderCommand";
112
113
  import type { StartUploadJobCommandInput, StartUploadJobCommandOutput } from "./commands/StartUploadJobCommand";
113
114
  import type { StopRecommenderCommandInput, StopRecommenderCommandOutput } from "./commands/StopRecommenderCommand";
@@ -126,11 +127,11 @@ export { __Client };
126
127
  /**
127
128
  * @public
128
129
  */
129
- export type ServiceInputTypes = AddProfileKeyCommandInput | AssociateStreamForSegmentsCommandInput | BatchGetCalculatedAttributeForProfileCommandInput | BatchGetProfileCommandInput | BatchPutProfileObjectCommandInput | CreateCalculatedAttributeDefinitionCommandInput | CreateDomainCommandInput | CreateDomainLayoutCommandInput | CreateEventStreamCommandInput | CreateEventTriggerCommandInput | CreateIntegrationWorkflowCommandInput | CreateProfileCommandInput | CreateRecommenderCommandInput | CreateRecommenderFilterCommandInput | CreateRecommenderSchemaCommandInput | CreateSegmentDefinitionCommandInput | CreateSegmentEstimateCommandInput | CreateSegmentSnapshotCommandInput | CreateUploadJobCommandInput | DeleteCalculatedAttributeDefinitionCommandInput | DeleteDomainCommandInput | DeleteDomainLayoutCommandInput | DeleteDomainObjectTypeCommandInput | DeleteEventStreamCommandInput | DeleteEventTriggerCommandInput | DeleteIntegrationCommandInput | DeleteProfileCommandInput | DeleteProfileKeyCommandInput | DeleteProfileObjectCommandInput | DeleteProfileObjectTypeCommandInput | DeleteRecommenderCommandInput | DeleteRecommenderFilterCommandInput | DeleteRecommenderSchemaCommandInput | DeleteSegmentDefinitionCommandInput | DeleteSegmentSubscriptionCommandInput | DeleteWorkflowCommandInput | DetectProfileObjectTypeCommandInput | DisassociateStreamForSegmentsCommandInput | GetAutoMergingPreviewCommandInput | GetCalculatedAttributeDefinitionCommandInput | GetCalculatedAttributeForProfileCommandInput | GetDomainCommandInput | GetDomainLayoutCommandInput | GetDomainObjectTypeCommandInput | GetEventStreamCommandInput | GetEventTriggerCommandInput | GetIdentityResolutionJobCommandInput | GetIntegrationCommandInput | GetMatchesCommandInput | GetObjectTypeAttributeStatisticsCommandInput | GetProfileHistoryRecordCommandInput | GetProfileObjectTypeCommandInput | GetProfileObjectTypeTemplateCommandInput | GetProfileRecommendationsCommandInput | GetRecommenderCommandInput | GetRecommenderFilterCommandInput | GetRecommenderSchemaCommandInput | GetSegmentDefinitionCommandInput | GetSegmentEstimateCommandInput | GetSegmentMembershipCommandInput | GetSegmentSnapshotCommandInput | GetSegmentSubscriptionCommandInput | GetSimilarProfilesCommandInput | GetStreamForSegmentsCommandInput | GetUploadJobCommandInput | GetUploadJobPathCommandInput | GetWorkflowCommandInput | GetWorkflowStepsCommandInput | ListAccountIntegrationsCommandInput | ListCalculatedAttributeDefinitionsCommandInput | ListCalculatedAttributesForProfileCommandInput | ListDomainLayoutsCommandInput | ListDomainObjectTypesCommandInput | ListDomainsCommandInput | ListEventStreamsCommandInput | ListEventTriggersCommandInput | ListIdentityResolutionJobsCommandInput | ListIntegrationsCommandInput | ListObjectTypeAttributeValuesCommandInput | ListObjectTypeAttributesCommandInput | ListProfileAttributeValuesCommandInput | ListProfileHistoryRecordsCommandInput | ListProfileObjectTypeTemplatesCommandInput | ListProfileObjectTypesCommandInput | ListProfileObjectsCommandInput | ListRecommenderFiltersCommandInput | ListRecommenderRecipesCommandInput | ListRecommenderSchemasCommandInput | ListRecommendersCommandInput | ListRuleBasedMatchesCommandInput | ListSegmentDefinitionsCommandInput | ListSegmentSubscriptionEventsCommandInput | ListTagsForResourceCommandInput | ListUploadJobsCommandInput | ListWorkflowsCommandInput | MergeProfilesCommandInput | PutDomainObjectTypeCommandInput | PutIntegrationCommandInput | PutProfileObjectCommandInput | PutProfileObjectTypeCommandInput | PutSegmentSubscriptionCommandInput | SearchProfilesCommandInput | StartRecommenderCommandInput | StartUploadJobCommandInput | StopRecommenderCommandInput | StopUploadJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCalculatedAttributeDefinitionCommandInput | UpdateDomainCommandInput | UpdateDomainLayoutCommandInput | UpdateEventTriggerCommandInput | UpdateProfileCommandInput | UpdateRecommenderCommandInput;
130
+ export type ServiceInputTypes = AddProfileKeyCommandInput | AssociateStreamForSegmentsCommandInput | BatchGetCalculatedAttributeForProfileCommandInput | BatchGetProfileCommandInput | BatchPutProfileObjectCommandInput | CreateCalculatedAttributeDefinitionCommandInput | CreateDomainCommandInput | CreateDomainLayoutCommandInput | CreateEventStreamCommandInput | CreateEventTriggerCommandInput | CreateIntegrationWorkflowCommandInput | CreateProfileCommandInput | CreateRecommenderCommandInput | CreateRecommenderFilterCommandInput | CreateRecommenderSchemaCommandInput | CreateSegmentDefinitionCommandInput | CreateSegmentEstimateCommandInput | CreateSegmentSnapshotCommandInput | CreateUploadJobCommandInput | DeleteCalculatedAttributeDefinitionCommandInput | DeleteDomainCommandInput | DeleteDomainLayoutCommandInput | DeleteDomainObjectTypeCommandInput | DeleteEventStreamCommandInput | DeleteEventTriggerCommandInput | DeleteIntegrationCommandInput | DeleteProfileCommandInput | DeleteProfileKeyCommandInput | DeleteProfileObjectCommandInput | DeleteProfileObjectTypeCommandInput | DeleteRecommenderCommandInput | DeleteRecommenderFilterCommandInput | DeleteRecommenderSchemaCommandInput | DeleteSegmentDefinitionCommandInput | DeleteSegmentSubscriptionCommandInput | DeleteWorkflowCommandInput | DetectProfileObjectTypeCommandInput | DisassociateStreamForSegmentsCommandInput | GetAutoMergingPreviewCommandInput | GetCalculatedAttributeDefinitionCommandInput | GetCalculatedAttributeForProfileCommandInput | GetDomainCommandInput | GetDomainLayoutCommandInput | GetDomainObjectTypeCommandInput | GetEventStreamCommandInput | GetEventTriggerCommandInput | GetIdentityResolutionJobCommandInput | GetIntegrationCommandInput | GetMatchesCommandInput | GetObjectTypeAttributeStatisticsCommandInput | GetProfileHistoryRecordCommandInput | GetProfileObjectTypeCommandInput | GetProfileObjectTypeTemplateCommandInput | GetProfileRecommendationsCommandInput | GetRecommenderCommandInput | GetRecommenderFilterCommandInput | GetRecommenderSchemaCommandInput | GetSegmentDefinitionCommandInput | GetSegmentEstimateCommandInput | GetSegmentMembershipCommandInput | GetSegmentSnapshotCommandInput | GetSegmentSubscriptionCommandInput | GetSimilarProfilesCommandInput | GetStreamForSegmentsCommandInput | GetUploadJobCommandInput | GetUploadJobPathCommandInput | GetWorkflowCommandInput | GetWorkflowStepsCommandInput | ListAccountIntegrationsCommandInput | ListCalculatedAttributeDefinitionsCommandInput | ListCalculatedAttributesForProfileCommandInput | ListDomainLayoutsCommandInput | ListDomainObjectTypesCommandInput | ListDomainsCommandInput | ListEventStreamsCommandInput | ListEventTriggersCommandInput | ListIdentityResolutionJobsCommandInput | ListIntegrationsCommandInput | ListObjectTypeAttributeValuesCommandInput | ListObjectTypeAttributesCommandInput | ListProfileAttributeValuesCommandInput | ListProfileHistoryRecordsCommandInput | ListProfileObjectTypeTemplatesCommandInput | ListProfileObjectTypesCommandInput | ListProfileObjectsCommandInput | ListRecommenderFiltersCommandInput | ListRecommenderRecipesCommandInput | ListRecommenderSchemasCommandInput | ListRecommendersCommandInput | ListRuleBasedMatchesCommandInput | ListSegmentDefinitionsCommandInput | ListSegmentSubscriptionEventsCommandInput | ListTagsForResourceCommandInput | ListUploadJobsCommandInput | ListWorkflowsCommandInput | MergeProfilesCommandInput | PutDomainObjectTypeCommandInput | PutIntegrationCommandInput | PutProfileObjectCommandInput | PutProfileObjectTypeCommandInput | PutSegmentSubscriptionCommandInput | SearchProfilesCommandInput | SearchRecommendationsCommandInput | StartRecommenderCommandInput | StartUploadJobCommandInput | StopRecommenderCommandInput | StopUploadJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCalculatedAttributeDefinitionCommandInput | UpdateDomainCommandInput | UpdateDomainLayoutCommandInput | UpdateEventTriggerCommandInput | UpdateProfileCommandInput | UpdateRecommenderCommandInput;
130
131
  /**
131
132
  * @public
132
133
  */
133
- export type ServiceOutputTypes = AddProfileKeyCommandOutput | AssociateStreamForSegmentsCommandOutput | BatchGetCalculatedAttributeForProfileCommandOutput | BatchGetProfileCommandOutput | BatchPutProfileObjectCommandOutput | CreateCalculatedAttributeDefinitionCommandOutput | CreateDomainCommandOutput | CreateDomainLayoutCommandOutput | CreateEventStreamCommandOutput | CreateEventTriggerCommandOutput | CreateIntegrationWorkflowCommandOutput | CreateProfileCommandOutput | CreateRecommenderCommandOutput | CreateRecommenderFilterCommandOutput | CreateRecommenderSchemaCommandOutput | CreateSegmentDefinitionCommandOutput | CreateSegmentEstimateCommandOutput | CreateSegmentSnapshotCommandOutput | CreateUploadJobCommandOutput | DeleteCalculatedAttributeDefinitionCommandOutput | DeleteDomainCommandOutput | DeleteDomainLayoutCommandOutput | DeleteDomainObjectTypeCommandOutput | DeleteEventStreamCommandOutput | DeleteEventTriggerCommandOutput | DeleteIntegrationCommandOutput | DeleteProfileCommandOutput | DeleteProfileKeyCommandOutput | DeleteProfileObjectCommandOutput | DeleteProfileObjectTypeCommandOutput | DeleteRecommenderCommandOutput | DeleteRecommenderFilterCommandOutput | DeleteRecommenderSchemaCommandOutput | DeleteSegmentDefinitionCommandOutput | DeleteSegmentSubscriptionCommandOutput | DeleteWorkflowCommandOutput | DetectProfileObjectTypeCommandOutput | DisassociateStreamForSegmentsCommandOutput | GetAutoMergingPreviewCommandOutput | GetCalculatedAttributeDefinitionCommandOutput | GetCalculatedAttributeForProfileCommandOutput | GetDomainCommandOutput | GetDomainLayoutCommandOutput | GetDomainObjectTypeCommandOutput | GetEventStreamCommandOutput | GetEventTriggerCommandOutput | GetIdentityResolutionJobCommandOutput | GetIntegrationCommandOutput | GetMatchesCommandOutput | GetObjectTypeAttributeStatisticsCommandOutput | GetProfileHistoryRecordCommandOutput | GetProfileObjectTypeCommandOutput | GetProfileObjectTypeTemplateCommandOutput | GetProfileRecommendationsCommandOutput | GetRecommenderCommandOutput | GetRecommenderFilterCommandOutput | GetRecommenderSchemaCommandOutput | GetSegmentDefinitionCommandOutput | GetSegmentEstimateCommandOutput | GetSegmentMembershipCommandOutput | GetSegmentSnapshotCommandOutput | GetSegmentSubscriptionCommandOutput | GetSimilarProfilesCommandOutput | GetStreamForSegmentsCommandOutput | GetUploadJobCommandOutput | GetUploadJobPathCommandOutput | GetWorkflowCommandOutput | GetWorkflowStepsCommandOutput | ListAccountIntegrationsCommandOutput | ListCalculatedAttributeDefinitionsCommandOutput | ListCalculatedAttributesForProfileCommandOutput | ListDomainLayoutsCommandOutput | ListDomainObjectTypesCommandOutput | ListDomainsCommandOutput | ListEventStreamsCommandOutput | ListEventTriggersCommandOutput | ListIdentityResolutionJobsCommandOutput | ListIntegrationsCommandOutput | ListObjectTypeAttributeValuesCommandOutput | ListObjectTypeAttributesCommandOutput | ListProfileAttributeValuesCommandOutput | ListProfileHistoryRecordsCommandOutput | ListProfileObjectTypeTemplatesCommandOutput | ListProfileObjectTypesCommandOutput | ListProfileObjectsCommandOutput | ListRecommenderFiltersCommandOutput | ListRecommenderRecipesCommandOutput | ListRecommenderSchemasCommandOutput | ListRecommendersCommandOutput | ListRuleBasedMatchesCommandOutput | ListSegmentDefinitionsCommandOutput | ListSegmentSubscriptionEventsCommandOutput | ListTagsForResourceCommandOutput | ListUploadJobsCommandOutput | ListWorkflowsCommandOutput | MergeProfilesCommandOutput | PutDomainObjectTypeCommandOutput | PutIntegrationCommandOutput | PutProfileObjectCommandOutput | PutProfileObjectTypeCommandOutput | PutSegmentSubscriptionCommandOutput | SearchProfilesCommandOutput | StartRecommenderCommandOutput | StartUploadJobCommandOutput | StopRecommenderCommandOutput | StopUploadJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCalculatedAttributeDefinitionCommandOutput | UpdateDomainCommandOutput | UpdateDomainLayoutCommandOutput | UpdateEventTriggerCommandOutput | UpdateProfileCommandOutput | UpdateRecommenderCommandOutput;
134
+ export type ServiceOutputTypes = AddProfileKeyCommandOutput | AssociateStreamForSegmentsCommandOutput | BatchGetCalculatedAttributeForProfileCommandOutput | BatchGetProfileCommandOutput | BatchPutProfileObjectCommandOutput | CreateCalculatedAttributeDefinitionCommandOutput | CreateDomainCommandOutput | CreateDomainLayoutCommandOutput | CreateEventStreamCommandOutput | CreateEventTriggerCommandOutput | CreateIntegrationWorkflowCommandOutput | CreateProfileCommandOutput | CreateRecommenderCommandOutput | CreateRecommenderFilterCommandOutput | CreateRecommenderSchemaCommandOutput | CreateSegmentDefinitionCommandOutput | CreateSegmentEstimateCommandOutput | CreateSegmentSnapshotCommandOutput | CreateUploadJobCommandOutput | DeleteCalculatedAttributeDefinitionCommandOutput | DeleteDomainCommandOutput | DeleteDomainLayoutCommandOutput | DeleteDomainObjectTypeCommandOutput | DeleteEventStreamCommandOutput | DeleteEventTriggerCommandOutput | DeleteIntegrationCommandOutput | DeleteProfileCommandOutput | DeleteProfileKeyCommandOutput | DeleteProfileObjectCommandOutput | DeleteProfileObjectTypeCommandOutput | DeleteRecommenderCommandOutput | DeleteRecommenderFilterCommandOutput | DeleteRecommenderSchemaCommandOutput | DeleteSegmentDefinitionCommandOutput | DeleteSegmentSubscriptionCommandOutput | DeleteWorkflowCommandOutput | DetectProfileObjectTypeCommandOutput | DisassociateStreamForSegmentsCommandOutput | GetAutoMergingPreviewCommandOutput | GetCalculatedAttributeDefinitionCommandOutput | GetCalculatedAttributeForProfileCommandOutput | GetDomainCommandOutput | GetDomainLayoutCommandOutput | GetDomainObjectTypeCommandOutput | GetEventStreamCommandOutput | GetEventTriggerCommandOutput | GetIdentityResolutionJobCommandOutput | GetIntegrationCommandOutput | GetMatchesCommandOutput | GetObjectTypeAttributeStatisticsCommandOutput | GetProfileHistoryRecordCommandOutput | GetProfileObjectTypeCommandOutput | GetProfileObjectTypeTemplateCommandOutput | GetProfileRecommendationsCommandOutput | GetRecommenderCommandOutput | GetRecommenderFilterCommandOutput | GetRecommenderSchemaCommandOutput | GetSegmentDefinitionCommandOutput | GetSegmentEstimateCommandOutput | GetSegmentMembershipCommandOutput | GetSegmentSnapshotCommandOutput | GetSegmentSubscriptionCommandOutput | GetSimilarProfilesCommandOutput | GetStreamForSegmentsCommandOutput | GetUploadJobCommandOutput | GetUploadJobPathCommandOutput | GetWorkflowCommandOutput | GetWorkflowStepsCommandOutput | ListAccountIntegrationsCommandOutput | ListCalculatedAttributeDefinitionsCommandOutput | ListCalculatedAttributesForProfileCommandOutput | ListDomainLayoutsCommandOutput | ListDomainObjectTypesCommandOutput | ListDomainsCommandOutput | ListEventStreamsCommandOutput | ListEventTriggersCommandOutput | ListIdentityResolutionJobsCommandOutput | ListIntegrationsCommandOutput | ListObjectTypeAttributeValuesCommandOutput | ListObjectTypeAttributesCommandOutput | ListProfileAttributeValuesCommandOutput | ListProfileHistoryRecordsCommandOutput | ListProfileObjectTypeTemplatesCommandOutput | ListProfileObjectTypesCommandOutput | ListProfileObjectsCommandOutput | ListRecommenderFiltersCommandOutput | ListRecommenderRecipesCommandOutput | ListRecommenderSchemasCommandOutput | ListRecommendersCommandOutput | ListRuleBasedMatchesCommandOutput | ListSegmentDefinitionsCommandOutput | ListSegmentSubscriptionEventsCommandOutput | ListTagsForResourceCommandOutput | ListUploadJobsCommandOutput | ListWorkflowsCommandOutput | MergeProfilesCommandOutput | PutDomainObjectTypeCommandOutput | PutIntegrationCommandOutput | PutProfileObjectCommandOutput | PutProfileObjectTypeCommandOutput | PutSegmentSubscriptionCommandOutput | SearchProfilesCommandOutput | SearchRecommendationsCommandOutput | StartRecommenderCommandOutput | StartUploadJobCommandOutput | StopRecommenderCommandOutput | StopUploadJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCalculatedAttributeDefinitionCommandOutput | UpdateDomainCommandOutput | UpdateDomainLayoutCommandOutput | UpdateEventTriggerCommandOutput | UpdateProfileCommandOutput | UpdateRecommenderCommandOutput;
134
135
  /**
135
136
  * @public
136
137
  */
@@ -0,0 +1,158 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { SearchRecommendationsRequest, SearchRecommendationsResponse } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link SearchRecommendationsCommand}.
11
+ */
12
+ export interface SearchRecommendationsCommandInput extends SearchRecommendationsRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link SearchRecommendationsCommand}.
18
+ */
19
+ export interface SearchRecommendationsCommandOutput extends SearchRecommendationsResponse, __MetadataBearer {
20
+ }
21
+ declare const SearchRecommendationsCommand_base: {
22
+ new (input: SearchRecommendationsCommandInput): import("@smithy/core/client").CommandImpl<SearchRecommendationsCommandInput, SearchRecommendationsCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: SearchRecommendationsCommandInput): import("@smithy/core/client").CommandImpl<SearchRecommendationsCommandInput, SearchRecommendationsCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves recommendations for a profile in a specific domain. The profile is identified
28
+ * using a search key, which consists of a <code>KeyName</code> and a <code>KeyValues</code> list.
29
+ * The <code>KeyName</code> can be a predefined key (for example, <code>_profileId</code>,
30
+ * <code>_phone</code>, <code>_email</code>) or a custom-defined key.</p>
31
+ * <p>The search key must match exactly one profile. If no profile matches the search key, the
32
+ * operation returns a <code>ResourceNotFoundException</code>. If more than one profile matches
33
+ * the search key, the operation returns a <code>BadRequestException</code>. You can use the
34
+ * SearchProfiles API to review the matching profiles.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { CustomerProfilesClient, SearchRecommendationsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
39
+ * // const { CustomerProfilesClient, SearchRecommendationsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
40
+ * // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
41
+ * const config = {}; // type is CustomerProfilesClientConfig
42
+ * const client = new CustomerProfilesClient(config);
43
+ * const input = { // SearchRecommendationsRequest
44
+ * DomainName: "STRING_VALUE", // required
45
+ * KeyName: "STRING_VALUE", // required
46
+ * KeyValues: [ // KeyValuesList // required
47
+ * "STRING_VALUE",
48
+ * ],
49
+ * Recommender: { // Recommender
50
+ * Name: "STRING_VALUE", // required
51
+ * Filters: [ // RecommenderFilters
52
+ * { // RecommenderFilter
53
+ * Name: "STRING_VALUE",
54
+ * Values: { // RecommenderFilterValues
55
+ * "<keys>": "STRING_VALUE",
56
+ * },
57
+ * },
58
+ * ],
59
+ * PromotionalFilters: [ // RecommenderPromotionalFilters
60
+ * { // RecommenderPromotionalFilter
61
+ * Name: "STRING_VALUE",
62
+ * Values: {
63
+ * "<keys>": "STRING_VALUE",
64
+ * },
65
+ * PromotionName: "STRING_VALUE",
66
+ * PercentPromotedItems: Number("int"),
67
+ * },
68
+ * ],
69
+ * },
70
+ * CandidateIds: [ // CandidateIdList
71
+ * "STRING_VALUE",
72
+ * ],
73
+ * Context: { // RecommenderContext
74
+ * "<keys>": "STRING_VALUE",
75
+ * },
76
+ * Diversity: { // RecommendationDiversityConfig
77
+ * Enabled: true || false, // required
78
+ * Values: { // DiversityValuesMap
79
+ * "<keys>": Number("int"),
80
+ * },
81
+ * },
82
+ * Metadata: { // RecommendationMetadata
83
+ * Columns: [ // MetadataColumnsList
84
+ * "STRING_VALUE",
85
+ * ],
86
+ * },
87
+ * MaxRecommendations: Number("int"),
88
+ * };
89
+ * const command = new SearchRecommendationsCommand(input);
90
+ * const response = await client.send(command);
91
+ * // { // SearchRecommendationsResponse
92
+ * // ProfileId: "STRING_VALUE",
93
+ * // Recommendations: [ // Recommendations
94
+ * // { // Recommendation
95
+ * // CatalogItem: { // CatalogItem
96
+ * // Id: "STRING_VALUE",
97
+ * // Name: "STRING_VALUE",
98
+ * // Code: "STRING_VALUE",
99
+ * // Type: "STRING_VALUE",
100
+ * // Category: "STRING_VALUE",
101
+ * // Description: "STRING_VALUE",
102
+ * // AdditionalInformation: "STRING_VALUE",
103
+ * // ImageLink: "STRING_VALUE",
104
+ * // Link: "STRING_VALUE",
105
+ * // CreatedAt: new Date("TIMESTAMP"),
106
+ * // UpdatedAt: new Date("TIMESTAMP"),
107
+ * // Price: "STRING_VALUE",
108
+ * // Attributes: { // Attributes
109
+ * // "<keys>": "STRING_VALUE",
110
+ * // },
111
+ * // },
112
+ * // Score: Number("double"),
113
+ * // },
114
+ * // ],
115
+ * // };
116
+ *
117
+ * ```
118
+ *
119
+ * @param SearchRecommendationsCommandInput - {@link SearchRecommendationsCommandInput}
120
+ * @returns {@link SearchRecommendationsCommandOutput}
121
+ * @see {@link SearchRecommendationsCommandInput} for command's `input` shape.
122
+ * @see {@link SearchRecommendationsCommandOutput} for command's `response` shape.
123
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
124
+ *
125
+ * @throws {@link AccessDeniedException} (client fault)
126
+ * <p>You do not have sufficient access to perform this action.</p>
127
+ *
128
+ * @throws {@link BadRequestException} (client fault)
129
+ * <p>The input you provided is invalid.</p>
130
+ *
131
+ * @throws {@link InternalServerException} (server fault)
132
+ * <p>An internal service error occurred.</p>
133
+ *
134
+ * @throws {@link ResourceNotFoundException} (client fault)
135
+ * <p>The requested resource does not exist, or access was denied.</p>
136
+ *
137
+ * @throws {@link ThrottlingException} (client fault)
138
+ * <p>You exceeded the maximum number of requests.</p>
139
+ *
140
+ * @throws {@link CustomerProfilesServiceException}
141
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
142
+ *
143
+ *
144
+ * @public
145
+ */
146
+ export declare class SearchRecommendationsCommand extends SearchRecommendationsCommand_base {
147
+ /** @internal type navigation helper, not in runtime. */
148
+ protected static __types: {
149
+ api: {
150
+ input: SearchRecommendationsRequest;
151
+ output: SearchRecommendationsResponse;
152
+ };
153
+ sdk: {
154
+ input: SearchRecommendationsCommandInput;
155
+ output: SearchRecommendationsCommandOutput;
156
+ };
157
+ };
158
+ }
@@ -100,6 +100,7 @@ export * from "./PutProfileObjectCommand";
100
100
  export * from "./PutProfileObjectTypeCommand";
101
101
  export * from "./PutSegmentSubscriptionCommand";
102
102
  export * from "./SearchProfilesCommand";
103
+ export * from "./SearchRecommendationsCommand";
103
104
  export * from "./StartRecommenderCommand";
104
105
  export * from "./StartUploadJobCommand";
105
106
  export * from "./StopRecommenderCommand";
@@ -1,5 +1,5 @@
1
1
  import type { Gender, LayoutType, LogicalOperator, PartyType, ProfileType, ReadinessStatus, RecommenderFilterStatus, RecommenderRecipeName, RecommenderSchemaStatus, RecommenderStatus, Scope, SegmentSubscriptionStatus, SegmentType, Statistic, Status, StatusReason, SubscriptionEvent, SubscriptionEventType, UploadJobStatus, WorkflowType } from "./enums";
2
- import type { AdditionalSearchKey, AttributeDetails, Conditions, DataStoreRequest, DataStoreResponse, DomainObjectTypeField, EngagementPreferences, EventTriggerCondition, EventTriggerLimits, FlowDefinition, MatchingRequest, MatchingResponse, ObjectTypeField, ObjectTypeKey, Profile, Readiness, RecommenderConfig, RecommenderSchemaField, RecommenderUpdate, RuleBasedMatchingRequest, RuleBasedMatchingResponse, ScheduleConfiguration } from "./models_0";
2
+ import type { AdditionalSearchKey, AttributeDetails, Conditions, DataStoreRequest, DataStoreResponse, DomainObjectTypeField, EngagementPreferences, EventTriggerCondition, EventTriggerLimits, FlowDefinition, MatchingRequest, MatchingResponse, ObjectTypeField, ObjectTypeKey, Profile, Readiness, Recommendation, RecommendationDiversityConfig, RecommenderConfig, RecommenderFilter, RecommenderPromotionalFilter, RecommenderSchemaField, RecommenderUpdate, RuleBasedMatchingRequest, RuleBasedMatchingResponse, ScheduleConfiguration } from "./models_0";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -1431,6 +1431,104 @@ export interface SearchProfilesResponse {
1431
1431
  */
1432
1432
  NextToken?: string | undefined;
1433
1433
  }
1434
+ /**
1435
+ * <p>Configuration for metadata to include in recommendation responses.</p>
1436
+ * @public
1437
+ */
1438
+ export interface RecommendationMetadata {
1439
+ /**
1440
+ * <p>A list of metadata column names from your Items dataset to include in the recommendation response.</p>
1441
+ * @public
1442
+ */
1443
+ Columns?: string[] | undefined;
1444
+ }
1445
+ /**
1446
+ * <p>The recommender used to generate the recommendations.</p>
1447
+ * @public
1448
+ */
1449
+ export interface Recommender {
1450
+ /**
1451
+ * <p>The unique name of the recommender.</p>
1452
+ * @public
1453
+ */
1454
+ Name: string | undefined;
1455
+ /**
1456
+ * <p>A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.</p>
1457
+ * @public
1458
+ */
1459
+ Filters?: RecommenderFilter[] | undefined;
1460
+ /**
1461
+ * <p>A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.</p>
1462
+ * @public
1463
+ */
1464
+ PromotionalFilters?: RecommenderPromotionalFilter[] | undefined;
1465
+ }
1466
+ /**
1467
+ * @public
1468
+ */
1469
+ export interface SearchRecommendationsRequest {
1470
+ /**
1471
+ * <p>The unique name of the domain.</p>
1472
+ * @public
1473
+ */
1474
+ DomainName: string | undefined;
1475
+ /**
1476
+ * <p>A searchable identifier of a customer profile. You can use a predefined key, such as
1477
+ * <code>_profileId</code>, <code>_phone</code>, or <code>_email</code>, or a custom-defined key.</p>
1478
+ * @public
1479
+ */
1480
+ KeyName: string | undefined;
1481
+ /**
1482
+ * <p>A list of key values. Provide one value for each field of the search key.</p>
1483
+ * @public
1484
+ */
1485
+ KeyValues: string[] | undefined;
1486
+ /**
1487
+ * <p>The recommender used to generate the recommendations.</p>
1488
+ * @public
1489
+ */
1490
+ Recommender: Recommender | undefined;
1491
+ /**
1492
+ * <p>A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.</p>
1493
+ * @public
1494
+ */
1495
+ CandidateIds?: string[] | undefined;
1496
+ /**
1497
+ * <p>The contextual metadata used to provide dynamic runtime information to tailor recommendations.</p>
1498
+ * @public
1499
+ */
1500
+ Context?: Record<string, string> | undefined;
1501
+ /**
1502
+ * <p>Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.</p>
1503
+ * @public
1504
+ */
1505
+ Diversity?: RecommendationDiversityConfig | undefined;
1506
+ /**
1507
+ * <p>Configuration for metadata to include in recommendation responses.</p>
1508
+ * @public
1509
+ */
1510
+ Metadata?: RecommendationMetadata | undefined;
1511
+ /**
1512
+ * <p>The maximum number of recommendations to return. The default value is 5.</p>
1513
+ * @public
1514
+ */
1515
+ MaxRecommendations?: number | undefined;
1516
+ }
1517
+ /**
1518
+ * @public
1519
+ */
1520
+ export interface SearchRecommendationsResponse {
1521
+ /**
1522
+ * <p>The unique identifier of the profile for which to retrieve recommendations.</p>
1523
+ * @public
1524
+ */
1525
+ ProfileId?: string | undefined;
1526
+ /**
1527
+ * <p>List of recommendations generated by the recommender.</p>
1528
+ * @public
1529
+ */
1530
+ Recommendations?: Recommendation[] | undefined;
1531
+ }
1434
1532
  /**
1435
1533
  * @public
1436
1534
  */
@@ -315,6 +315,8 @@ export declare var RangeOverride$: StaticStructureSchema;
315
315
  export declare var Readiness$: StaticStructureSchema;
316
316
  export declare var Recommendation$: StaticStructureSchema;
317
317
  export declare var RecommendationDiversityConfig$: StaticStructureSchema;
318
+ export declare var RecommendationMetadata$: StaticStructureSchema;
319
+ export declare var Recommender$: StaticStructureSchema;
318
320
  export declare var RecommenderConfig$: StaticStructureSchema;
319
321
  export declare var RecommenderFilter$: StaticStructureSchema;
320
322
  export declare var RecommenderFilterSummary$: StaticStructureSchema;
@@ -336,6 +338,8 @@ export declare var ScheduledExecutions$: StaticStructureSchema;
336
338
  export declare var ScheduledTriggerProperties$: StaticStructureSchema;
337
339
  export declare var SearchProfilesRequest$: StaticStructureSchema;
338
340
  export declare var SearchProfilesResponse$: StaticStructureSchema;
341
+ export declare var SearchRecommendationsRequest$: StaticStructureSchema;
342
+ export declare var SearchRecommendationsResponse$: StaticStructureSchema;
339
343
  export declare var SegmentDefinitionItem$: StaticStructureSchema;
340
344
  export declare var SegmentGroup$: StaticStructureSchema;
341
345
  export declare var SegmentGroupStructure$: StaticStructureSchema;
@@ -485,6 +489,7 @@ export declare var PutProfileObject$: StaticOperationSchema;
485
489
  export declare var PutProfileObjectType$: StaticOperationSchema;
486
490
  export declare var PutSegmentSubscription$: StaticOperationSchema;
487
491
  export declare var SearchProfiles$: StaticOperationSchema;
492
+ export declare var SearchRecommendations$: StaticOperationSchema;
488
493
  export declare var StartRecommender$: StaticOperationSchema;
489
494
  export declare var StartUploadJob$: StaticOperationSchema;
490
495
  export declare var StopRecommender$: StaticOperationSchema;
@@ -399,6 +399,10 @@ import {
399
399
  SearchProfilesCommandInput,
400
400
  SearchProfilesCommandOutput,
401
401
  } from "./commands/SearchProfilesCommand";
402
+ import {
403
+ SearchRecommendationsCommandInput,
404
+ SearchRecommendationsCommandOutput,
405
+ } from "./commands/SearchRecommendationsCommand";
402
406
  import {
403
407
  StartRecommenderCommandInput,
404
408
  StartRecommenderCommandOutput,
@@ -1775,6 +1779,19 @@ export interface CustomerProfiles {
1775
1779
  options: __HttpHandlerOptions,
1776
1780
  cb: (err: any, data?: SearchProfilesCommandOutput) => void,
1777
1781
  ): void;
1782
+ searchRecommendations(
1783
+ args: SearchRecommendationsCommandInput,
1784
+ options?: __HttpHandlerOptions,
1785
+ ): Promise<SearchRecommendationsCommandOutput>;
1786
+ searchRecommendations(
1787
+ args: SearchRecommendationsCommandInput,
1788
+ cb: (err: any, data?: SearchRecommendationsCommandOutput) => void,
1789
+ ): void;
1790
+ searchRecommendations(
1791
+ args: SearchRecommendationsCommandInput,
1792
+ options: __HttpHandlerOptions,
1793
+ cb: (err: any, data?: SearchRecommendationsCommandOutput) => void,
1794
+ ): void;
1778
1795
  startRecommender(
1779
1796
  args: StartRecommenderCommandInput,
1780
1797
  options?: __HttpHandlerOptions,
@@ -429,6 +429,10 @@ import {
429
429
  SearchProfilesCommandInput,
430
430
  SearchProfilesCommandOutput,
431
431
  } from "./commands/SearchProfilesCommand";
432
+ import {
433
+ SearchRecommendationsCommandInput,
434
+ SearchRecommendationsCommandOutput,
435
+ } from "./commands/SearchRecommendationsCommand";
432
436
  import {
433
437
  StartRecommenderCommandInput,
434
438
  StartRecommenderCommandOutput,
@@ -584,6 +588,7 @@ export type ServiceInputTypes =
584
588
  | PutProfileObjectTypeCommandInput
585
589
  | PutSegmentSubscriptionCommandInput
586
590
  | SearchProfilesCommandInput
591
+ | SearchRecommendationsCommandInput
587
592
  | StartRecommenderCommandInput
588
593
  | StartUploadJobCommandInput
589
594
  | StopRecommenderCommandInput
@@ -699,6 +704,7 @@ export type ServiceOutputTypes =
699
704
  | PutProfileObjectTypeCommandOutput
700
705
  | PutSegmentSubscriptionCommandOutput
701
706
  | SearchProfilesCommandOutput
707
+ | SearchRecommendationsCommandOutput
702
708
  | StartRecommenderCommandOutput
703
709
  | StartUploadJobCommandOutput
704
710
  | StopRecommenderCommandOutput
@@ -0,0 +1,39 @@
1
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import { SearchRecommendationsRequest, SearchRecommendationsResponse } from "../models/models_1";
3
+ export { __MetadataBearer };
4
+ export interface SearchRecommendationsCommandInput extends SearchRecommendationsRequest {}
5
+ export interface SearchRecommendationsCommandOutput
6
+ extends SearchRecommendationsResponse, __MetadataBearer {}
7
+ declare const SearchRecommendationsCommand_base: {
8
+ new (
9
+ input: SearchRecommendationsCommandInput,
10
+ ): import("@smithy/core/client").CommandImpl<
11
+ SearchRecommendationsCommandInput,
12
+ SearchRecommendationsCommandOutput,
13
+ import("..").CustomerProfilesClientResolvedConfig,
14
+ import("..").ServiceInputTypes,
15
+ import("..").ServiceOutputTypes
16
+ >;
17
+ new (
18
+ input: SearchRecommendationsCommandInput,
19
+ ): import("@smithy/core/client").CommandImpl<
20
+ SearchRecommendationsCommandInput,
21
+ SearchRecommendationsCommandOutput,
22
+ import("..").CustomerProfilesClientResolvedConfig,
23
+ import("..").ServiceInputTypes,
24
+ import("..").ServiceOutputTypes
25
+ >;
26
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
27
+ };
28
+ export declare class SearchRecommendationsCommand extends SearchRecommendationsCommand_base {
29
+ protected static __types: {
30
+ api: {
31
+ input: SearchRecommendationsRequest;
32
+ output: SearchRecommendationsResponse;
33
+ };
34
+ sdk: {
35
+ input: SearchRecommendationsCommandInput;
36
+ output: SearchRecommendationsCommandOutput;
37
+ };
38
+ };
39
+ }
@@ -100,6 +100,7 @@ export * from "./PutProfileObjectCommand";
100
100
  export * from "./PutProfileObjectTypeCommand";
101
101
  export * from "./PutSegmentSubscriptionCommand";
102
102
  export * from "./SearchProfilesCommand";
103
+ export * from "./SearchRecommendationsCommand";
103
104
  export * from "./StartRecommenderCommand";
104
105
  export * from "./StartUploadJobCommand";
105
106
  export * from "./StopRecommenderCommand";
@@ -37,7 +37,11 @@ import {
37
37
  ObjectTypeKey,
38
38
  Profile,
39
39
  Readiness,
40
+ Recommendation,
41
+ RecommendationDiversityConfig,
40
42
  RecommenderConfig,
43
+ RecommenderFilter,
44
+ RecommenderPromotionalFilter,
41
45
  RecommenderSchemaField,
42
46
  RecommenderUpdate,
43
47
  RuleBasedMatchingRequest,
@@ -352,6 +356,29 @@ export interface SearchProfilesResponse {
352
356
  Items?: Profile[] | undefined;
353
357
  NextToken?: string | undefined;
354
358
  }
359
+ export interface RecommendationMetadata {
360
+ Columns?: string[] | undefined;
361
+ }
362
+ export interface Recommender {
363
+ Name: string | undefined;
364
+ Filters?: RecommenderFilter[] | undefined;
365
+ PromotionalFilters?: RecommenderPromotionalFilter[] | undefined;
366
+ }
367
+ export interface SearchRecommendationsRequest {
368
+ DomainName: string | undefined;
369
+ KeyName: string | undefined;
370
+ KeyValues: string[] | undefined;
371
+ Recommender: Recommender | undefined;
372
+ CandidateIds?: string[] | undefined;
373
+ Context?: Record<string, string> | undefined;
374
+ Diversity?: RecommendationDiversityConfig | undefined;
375
+ Metadata?: RecommendationMetadata | undefined;
376
+ MaxRecommendations?: number | undefined;
377
+ }
378
+ export interface SearchRecommendationsResponse {
379
+ ProfileId?: string | undefined;
380
+ Recommendations?: Recommendation[] | undefined;
381
+ }
355
382
  export interface StartRecommenderRequest {
356
383
  DomainName: string | undefined;
357
384
  RecommenderName: string | undefined;
@@ -315,6 +315,8 @@ export declare var RangeOverride$: StaticStructureSchema;
315
315
  export declare var Readiness$: StaticStructureSchema;
316
316
  export declare var Recommendation$: StaticStructureSchema;
317
317
  export declare var RecommendationDiversityConfig$: StaticStructureSchema;
318
+ export declare var RecommendationMetadata$: StaticStructureSchema;
319
+ export declare var Recommender$: StaticStructureSchema;
318
320
  export declare var RecommenderConfig$: StaticStructureSchema;
319
321
  export declare var RecommenderFilter$: StaticStructureSchema;
320
322
  export declare var RecommenderFilterSummary$: StaticStructureSchema;
@@ -336,6 +338,8 @@ export declare var ScheduledExecutions$: StaticStructureSchema;
336
338
  export declare var ScheduledTriggerProperties$: StaticStructureSchema;
337
339
  export declare var SearchProfilesRequest$: StaticStructureSchema;
338
340
  export declare var SearchProfilesResponse$: StaticStructureSchema;
341
+ export declare var SearchRecommendationsRequest$: StaticStructureSchema;
342
+ export declare var SearchRecommendationsResponse$: StaticStructureSchema;
339
343
  export declare var SegmentDefinitionItem$: StaticStructureSchema;
340
344
  export declare var SegmentGroup$: StaticStructureSchema;
341
345
  export declare var SegmentGroupStructure$: StaticStructureSchema;
@@ -485,6 +489,7 @@ export declare var PutProfileObject$: StaticOperationSchema;
485
489
  export declare var PutProfileObjectType$: StaticOperationSchema;
486
490
  export declare var PutSegmentSubscription$: StaticOperationSchema;
487
491
  export declare var SearchProfiles$: StaticOperationSchema;
492
+ export declare var SearchRecommendations$: StaticOperationSchema;
488
493
  export declare var StartRecommender$: StaticOperationSchema;
489
494
  export declare var StartUploadJob$: StaticOperationSchema;
490
495
  export declare var StopRecommender$: StaticOperationSchema;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-customer-profiles",
3
- "version": "3.1133.0",
3
+ "version": "3.1134.0",
4
4
  "description": "AWS SDK for JavaScript Customer Profiles Client for Node.js, Browser and React Native",
5
5
  "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-customer-profiles",
6
6
  "license": "Apache-2.0",