@aws-sdk/client-customer-profiles 3.1006.0 → 3.1007.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/README.md +28 -0
  2. package/dist-cjs/index.js +69 -0
  3. package/dist-cjs/schemas/schemas_0.js +144 -14
  4. package/dist-es/CustomerProfiles.js +10 -0
  5. package/dist-es/commands/CreateRecommenderFilterCommand.js +16 -0
  6. package/dist-es/commands/DeleteRecommenderFilterCommand.js +16 -0
  7. package/dist-es/commands/GetRecommenderFilterCommand.js +16 -0
  8. package/dist-es/commands/ListRecommenderFiltersCommand.js +16 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/enums.js +8 -0
  11. package/dist-es/pagination/ListRecommenderFiltersPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/schemas/schemas_0.js +136 -6
  14. package/dist-types/CustomerProfiles.d.ts +35 -0
  15. package/dist-types/CustomerProfilesClient.d.ts +6 -2
  16. package/dist-types/commands/CreateRecommenderCommand.d.ts +5 -1
  17. package/dist-types/commands/CreateRecommenderFilterCommand.d.ts +98 -0
  18. package/dist-types/commands/DeleteRecommenderFilterCommand.d.ts +90 -0
  19. package/dist-types/commands/GetProfileRecommendationsCommand.d.ts +26 -0
  20. package/dist-types/commands/GetRecommenderCommand.d.ts +9 -1
  21. package/dist-types/commands/GetRecommenderFilterCommand.d.ts +98 -0
  22. package/dist-types/commands/ListRecommenderFiltersCommand.d.ts +104 -0
  23. package/dist-types/commands/ListRecommenderRecipesCommand.d.ts +1 -1
  24. package/dist-types/commands/ListRecommendersCommand.d.ts +9 -1
  25. package/dist-types/commands/PutIntegrationCommand.d.ts +1 -1
  26. package/dist-types/commands/PutProfileObjectCommand.d.ts +1 -1
  27. package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +1 -1
  28. package/dist-types/commands/SearchProfilesCommand.d.ts +1 -1
  29. package/dist-types/commands/StartRecommenderCommand.d.ts +1 -1
  30. package/dist-types/commands/StartUploadJobCommand.d.ts +1 -1
  31. package/dist-types/commands/StopRecommenderCommand.d.ts +1 -2
  32. package/dist-types/commands/UpdateRecommenderCommand.d.ts +4 -0
  33. package/dist-types/commands/index.d.ts +4 -0
  34. package/dist-types/models/enums.d.ts +16 -0
  35. package/dist-types/models/models_0.d.ts +297 -465
  36. package/dist-types/models/models_1.d.ts +465 -2
  37. package/dist-types/pagination/ListRecommenderFiltersPaginator.d.ts +7 -0
  38. package/dist-types/pagination/index.d.ts +1 -0
  39. package/dist-types/schemas/schemas_0.d.ts +17 -0
  40. package/dist-types/ts3.4/CustomerProfiles.d.ts +75 -0
  41. package/dist-types/ts3.4/CustomerProfilesClient.d.ts +24 -0
  42. package/dist-types/ts3.4/commands/CreateRecommenderFilterCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/DeleteRecommenderFilterCommand.d.ts +51 -0
  44. package/dist-types/ts3.4/commands/GetRecommenderFilterCommand.d.ts +51 -0
  45. package/dist-types/ts3.4/commands/ListRecommenderFiltersCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/PutIntegrationCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/PutProfileObjectCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/PutProfileObjectTypeCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/SearchProfilesCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/StartRecommenderCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/StartUploadJobCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/StopRecommenderCommand.d.ts +4 -2
  53. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  54. package/dist-types/ts3.4/models/enums.d.ts +10 -0
  55. package/dist-types/ts3.4/models/models_0.d.ts +73 -94
  56. package/dist-types/ts3.4/models/models_1.d.ts +99 -0
  57. package/dist-types/ts3.4/pagination/ListRecommenderFiltersPaginator.d.ts +11 -0
  58. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  59. package/dist-types/ts3.4/schemas/schemas_0.d.ts +17 -0
  60. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- import { ActionType, AttributeDimensionType, AttributeMatchingModel, ComparisonOperator, ConflictResolvingModel, ContactType, ContentType, DataFormat, DataPullMode, DateDimensionType, EstimateStatus, EventStreamDestinationStatus, EventStreamState, EventTriggerLogicalOperator, FeatureType, FieldContentType, FilterDimensionType, Gender, IdentityResolutionJobStatus, Include, IncludeOptions, JobScheduleDayOfTheWeek, LayoutType, LogicalOperator, MarketoConnectorOperator, MatchType, Operator, OperatorPropertiesKeys, PartyType, PeriodUnit, ProfileType, ProfileTypeDimensionType, QueryResult, RangeUnit, ReadinessStatus, RecommenderRecipeName, RecommenderStatus, RuleBasedMatchingStatus, S3ConnectorOperator, SalesforceConnectorOperator, Scope, SegmentSnapshotStatus, SegmentType, ServiceNowConnectorOperator, SourceConnectorType, StandardIdentifier, Statistic, Status, StatusReason, StringDimensionType, TaskType, TrainingMetricName, TriggerType, Type, Unit, UploadJobStatus, WorkflowType, ZendeskConnectorOperator } from "./enums";
1
+ import { ActionType, AttributeDimensionType, AttributeMatchingModel, ComparisonOperator, ConflictResolvingModel, ContactType, ContentType, DataFormat, DataPullMode, DateDimensionType, EstimateStatus, EventStreamDestinationStatus, EventStreamState, EventTriggerLogicalOperator, FeatureType, FieldContentType, FilterDimensionType, Gender, IdentityResolutionJobStatus, Include, IncludeOptions, JobScheduleDayOfTheWeek, LayoutType, MarketoConnectorOperator, MatchType, Operator, OperatorPropertiesKeys, PartyType, PeriodUnit, ProfileType, ProfileTypeDimensionType, QueryResult, RangeUnit, ReadinessStatus, RecommenderFilterStatus, RecommenderRecipeName, RecommenderStatus, RuleBasedMatchingStatus, S3ConnectorOperator, SalesforceConnectorOperator, Scope, SegmentSnapshotStatus, SegmentType, ServiceNowConnectorOperator, SourceConnectorType, StandardIdentifier, Statistic, Status, StatusReason, StringDimensionType, TaskType, TrainingMetricName, TriggerType, Type, Unit, UploadJobStatus, WorkflowType, ZendeskConnectorOperator } from "./enums";
2
2
  /**
3
3
  * <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
4
4
  * that is used in conjunction with the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName">KeyName</a> and <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values">Values</a> parameters to search for profiles using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a>
@@ -2797,6 +2797,11 @@ export interface EventParameters {
2797
2797
  * @public
2798
2798
  */
2799
2799
  EventValueThreshold?: number | undefined;
2800
+ /**
2801
+ * <p>The weight of the event type. A higher weight means higher importance of the event type for the created solution.</p>
2802
+ * @public
2803
+ */
2804
+ EventWeight?: number | undefined;
2800
2805
  }
2801
2806
  /**
2802
2807
  * <p>Configuration settings that define how events are processed and tracked.</p>
@@ -2809,6 +2814,17 @@ export interface EventsConfig {
2809
2814
  */
2810
2815
  EventParametersList: EventParameters[] | undefined;
2811
2816
  }
2817
+ /**
2818
+ * <p>Configuration settings for inference behavior of the recommender.</p>
2819
+ * @public
2820
+ */
2821
+ export interface InferenceConfig {
2822
+ /**
2823
+ * <p>The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.</p>
2824
+ * @public
2825
+ */
2826
+ MinProvisionedTPS?: number | undefined;
2827
+ }
2812
2828
  /**
2813
2829
  * <p>Configuration settings that define the behavior and parameters of a recommender.</p>
2814
2830
  * @public
@@ -2818,12 +2834,17 @@ export interface RecommenderConfig {
2818
2834
  * <p>Configuration settings for how the recommender processes and uses events.</p>
2819
2835
  * @public
2820
2836
  */
2821
- EventsConfig: EventsConfig | undefined;
2837
+ EventsConfig?: EventsConfig | undefined;
2822
2838
  /**
2823
2839
  * <p>How often the recommender should retrain its model with new data.</p>
2824
2840
  * @public
2825
2841
  */
2826
2842
  TrainingFrequency?: number | undefined;
2843
+ /**
2844
+ * <p>Configuration settings for how the recommender handles inference requests.</p>
2845
+ * @public
2846
+ */
2847
+ InferenceConfig?: InferenceConfig | undefined;
2827
2848
  }
2828
2849
  /**
2829
2850
  * @public
@@ -2875,6 +2896,51 @@ export interface CreateRecommenderResponse {
2875
2896
  */
2876
2897
  Tags?: Record<string, string> | undefined;
2877
2898
  }
2899
+ /**
2900
+ * @public
2901
+ */
2902
+ export interface CreateRecommenderFilterRequest {
2903
+ /**
2904
+ * <p>The unique name of the domain.</p>
2905
+ * @public
2906
+ */
2907
+ DomainName: string | undefined;
2908
+ /**
2909
+ * <p>The name of the recommender filter. The name must be unique within the domain.</p>
2910
+ * @public
2911
+ */
2912
+ RecommenderFilterName: string | undefined;
2913
+ /**
2914
+ * <p>The filter expression that defines which items to include or exclude from recommendations.</p>
2915
+ * @public
2916
+ */
2917
+ RecommenderFilterExpression: string | undefined;
2918
+ /**
2919
+ * <p>A description of the recommender filter.</p>
2920
+ * @public
2921
+ */
2922
+ Description?: string | undefined;
2923
+ /**
2924
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2925
+ * @public
2926
+ */
2927
+ Tags?: Record<string, string> | undefined;
2928
+ }
2929
+ /**
2930
+ * @public
2931
+ */
2932
+ export interface CreateRecommenderFilterResponse {
2933
+ /**
2934
+ * <p>The Amazon Resource Name (ARN) of the recommender filter.</p>
2935
+ * @public
2936
+ */
2937
+ RecommenderFilterArn: string | undefined;
2938
+ /**
2939
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2940
+ * @public
2941
+ */
2942
+ Tags?: Record<string, string> | undefined;
2943
+ }
2878
2944
  /**
2879
2945
  * <p>Object that segments on various Customer profile's fields that are larger than
2880
2946
  * normal.</p>
@@ -3683,6 +3749,31 @@ export interface DeleteRecommenderRequest {
3683
3749
  */
3684
3750
  export interface DeleteRecommenderResponse {
3685
3751
  }
3752
+ /**
3753
+ * @public
3754
+ */
3755
+ export interface DeleteRecommenderFilterRequest {
3756
+ /**
3757
+ * <p>The unique name of the domain.</p>
3758
+ * @public
3759
+ */
3760
+ DomainName: string | undefined;
3761
+ /**
3762
+ * <p>The name of the recommender filter to delete.</p>
3763
+ * @public
3764
+ */
3765
+ RecommenderFilterName: string | undefined;
3766
+ }
3767
+ /**
3768
+ * @public
3769
+ */
3770
+ export interface DeleteRecommenderFilterResponse {
3771
+ /**
3772
+ * <p>A message that indicates the delete request is done.</p>
3773
+ * @public
3774
+ */
3775
+ Message: string | undefined;
3776
+ }
3686
3777
  /**
3687
3778
  * @public
3688
3779
  */
@@ -5047,6 +5138,59 @@ export interface GetProfileObjectTypeTemplateResponse {
5047
5138
  */
5048
5139
  Keys?: Record<string, ObjectTypeKey[]> | undefined;
5049
5140
  }
5141
+ /**
5142
+ * <p>Configuration for metadata to include in recommendation responses.</p>
5143
+ * @public
5144
+ */
5145
+ export interface MetadataConfig {
5146
+ /**
5147
+ * <p>A list of metadata column names from your Items dataset to include in the recommendation response.</p>
5148
+ * @public
5149
+ */
5150
+ MetadataColumns?: string[] | undefined;
5151
+ }
5152
+ /**
5153
+ * <p>A filter that specifies criteria for including or excluding items from recommendations.</p>
5154
+ * @public
5155
+ */
5156
+ export interface RecommenderFilter {
5157
+ /**
5158
+ * <p>The name of the recommender filter to apply.</p>
5159
+ * @public
5160
+ */
5161
+ Name?: string | undefined;
5162
+ /**
5163
+ * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.</p>
5164
+ * @public
5165
+ */
5166
+ Values?: Record<string, string> | undefined;
5167
+ }
5168
+ /**
5169
+ * <p>Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>
5170
+ * @public
5171
+ */
5172
+ export interface RecommenderPromotionalFilter {
5173
+ /**
5174
+ * <p>The name of the recommender filter to use for the promotion.</p>
5175
+ * @public
5176
+ */
5177
+ Name?: string | undefined;
5178
+ /**
5179
+ * <p>The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.</p>
5180
+ * @public
5181
+ */
5182
+ Values?: Record<string, string> | undefined;
5183
+ /**
5184
+ * <p>The name of the promotion.</p>
5185
+ * @public
5186
+ */
5187
+ PromotionName?: string | undefined;
5188
+ /**
5189
+ * <p>The percentage of recommended items to apply the promotion to.</p>
5190
+ * @public
5191
+ */
5192
+ PercentPromotedItems?: number | undefined;
5193
+ }
5050
5194
  /**
5051
5195
  * @public
5052
5196
  */
@@ -5071,11 +5215,31 @@ export interface GetProfileRecommendationsRequest {
5071
5215
  * @public
5072
5216
  */
5073
5217
  Context?: Record<string, string> | undefined;
5218
+ /**
5219
+ * <p>A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.</p>
5220
+ * @public
5221
+ */
5222
+ RecommenderFilters?: RecommenderFilter[] | undefined;
5223
+ /**
5224
+ * <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>
5225
+ * @public
5226
+ */
5227
+ RecommenderPromotionalFilters?: RecommenderPromotionalFilter[] | undefined;
5228
+ /**
5229
+ * <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>
5230
+ * @public
5231
+ */
5232
+ CandidateIds?: string[] | undefined;
5074
5233
  /**
5075
5234
  * <p>The maximum number of recommendations to return. The default value is 10.</p>
5076
5235
  * @public
5077
5236
  */
5078
5237
  MaxResults?: number | undefined;
5238
+ /**
5239
+ * <p>Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.</p>
5240
+ * @public
5241
+ */
5242
+ MetadataConfig?: MetadataConfig | undefined;
5079
5243
  }
5080
5244
  /**
5081
5245
  * <p>Represents a single recommendation generated by the recommender system.</p>
@@ -5230,6 +5394,61 @@ export interface GetRecommenderResponse {
5230
5394
  */
5231
5395
  Tags?: Record<string, string> | undefined;
5232
5396
  }
5397
+ /**
5398
+ * @public
5399
+ */
5400
+ export interface GetRecommenderFilterRequest {
5401
+ /**
5402
+ * <p>The unique name of the domain.</p>
5403
+ * @public
5404
+ */
5405
+ DomainName: string | undefined;
5406
+ /**
5407
+ * <p>The name of the recommender filter to retrieve.</p>
5408
+ * @public
5409
+ */
5410
+ RecommenderFilterName: string | undefined;
5411
+ }
5412
+ /**
5413
+ * @public
5414
+ */
5415
+ export interface GetRecommenderFilterResponse {
5416
+ /**
5417
+ * <p>The name of the recommender filter.</p>
5418
+ * @public
5419
+ */
5420
+ RecommenderFilterName: string | undefined;
5421
+ /**
5422
+ * <p>The filter expression that defines which items to include or exclude from recommendations.</p>
5423
+ * @public
5424
+ */
5425
+ RecommenderFilterExpression: string | undefined;
5426
+ /**
5427
+ * <p>The timestamp of when the recommender filter was created.</p>
5428
+ * @public
5429
+ */
5430
+ CreatedAt: Date | undefined;
5431
+ /**
5432
+ * <p>The status of the recommender filter.</p>
5433
+ * @public
5434
+ */
5435
+ Status: RecommenderFilterStatus | undefined;
5436
+ /**
5437
+ * <p>The description of the recommender filter.</p>
5438
+ * @public
5439
+ */
5440
+ Description?: string | undefined;
5441
+ /**
5442
+ * <p>If the recommender filter failed, provides the reason for the failure.</p>
5443
+ * @public
5444
+ */
5445
+ FailureReason?: string | undefined;
5446
+ /**
5447
+ * <p>The tags used to organize, track, or control access for this resource.</p>
5448
+ * @public
5449
+ */
5450
+ Tags: Record<string, string> | undefined;
5451
+ }
5233
5452
  /**
5234
5453
  * @public
5235
5454
  */
@@ -7113,6 +7332,82 @@ export interface ListProfileObjectTypeTemplatesResponse {
7113
7332
  */
7114
7333
  NextToken?: string | undefined;
7115
7334
  }
7335
+ /**
7336
+ * @public
7337
+ */
7338
+ export interface ListRecommenderFiltersRequest {
7339
+ /**
7340
+ * <p>The unique name of the domain.</p>
7341
+ * @public
7342
+ */
7343
+ DomainName: string | undefined;
7344
+ /**
7345
+ * <p>The maximum number of recommender filters to return in the response. The default value is 100.</p>
7346
+ * @public
7347
+ */
7348
+ MaxResults?: number | undefined;
7349
+ /**
7350
+ * <p>A token received from a previous ListRecommenderFilters call to retrieve the next page of results.</p>
7351
+ * @public
7352
+ */
7353
+ NextToken?: string | undefined;
7354
+ }
7355
+ /**
7356
+ * <p>Provides a summary of a recommender filter's configuration and current state.</p>
7357
+ * @public
7358
+ */
7359
+ export interface RecommenderFilterSummary {
7360
+ /**
7361
+ * <p>The name of the recommender filter.</p>
7362
+ * @public
7363
+ */
7364
+ RecommenderFilterName?: string | undefined;
7365
+ /**
7366
+ * <p>The filter expression that defines which items to include or exclude from recommendations.</p>
7367
+ * @public
7368
+ */
7369
+ RecommenderFilterExpression?: string | undefined;
7370
+ /**
7371
+ * <p>The timestamp when the recommender filter was created.</p>
7372
+ * @public
7373
+ */
7374
+ CreatedAt?: Date | undefined;
7375
+ /**
7376
+ * <p>A description of the recommender filter's purpose and characteristics.</p>
7377
+ * @public
7378
+ */
7379
+ Description?: string | undefined;
7380
+ /**
7381
+ * <p>The current operational status of the recommender filter.</p>
7382
+ * @public
7383
+ */
7384
+ Status?: RecommenderFilterStatus | undefined;
7385
+ /**
7386
+ * <p>If the recommender filter is in a failed state, provides the reason for the failure.</p>
7387
+ * @public
7388
+ */
7389
+ FailureReason?: string | undefined;
7390
+ /**
7391
+ * <p>The tags used to organize, track, or control access for this resource.</p>
7392
+ * @public
7393
+ */
7394
+ Tags?: Record<string, string> | undefined;
7395
+ }
7396
+ /**
7397
+ * @public
7398
+ */
7399
+ export interface ListRecommenderFiltersResponse {
7400
+ /**
7401
+ * <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
7402
+ * @public
7403
+ */
7404
+ NextToken?: string | undefined;
7405
+ /**
7406
+ * <p>A list of recommender filters and their properties in the specified domain.</p>
7407
+ * @public
7408
+ */
7409
+ RecommenderFilters?: RecommenderFilterSummary[] | undefined;
7410
+ }
7116
7411
  /**
7117
7412
  * @public
7118
7413
  */
@@ -7788,466 +8083,3 @@ export interface PutDomainObjectTypeResponse {
7788
8083
  */
7789
8084
  Tags?: Record<string, string> | undefined;
7790
8085
  }
7791
- /**
7792
- * @public
7793
- */
7794
- export interface PutIntegrationRequest {
7795
- /**
7796
- * <p>The unique name of the domain.</p>
7797
- * @public
7798
- */
7799
- DomainName: string | undefined;
7800
- /**
7801
- * <p>The URI of the S3 bucket or any other type of data source.</p>
7802
- * @public
7803
- */
7804
- Uri?: string | undefined;
7805
- /**
7806
- * <p>The name of the profile object type.</p>
7807
- * @public
7808
- */
7809
- ObjectTypeName?: string | undefined;
7810
- /**
7811
- * <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
7812
- * It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
7813
- * <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
7814
- * @public
7815
- */
7816
- ObjectTypeNames?: Record<string, string> | undefined;
7817
- /**
7818
- * <p>The tags used to organize, track, or control access for this resource.</p>
7819
- * @public
7820
- */
7821
- Tags?: Record<string, string> | undefined;
7822
- /**
7823
- * <p>The configuration that controls how Customer Profiles retrieves data from the
7824
- * source.</p>
7825
- * @public
7826
- */
7827
- FlowDefinition?: FlowDefinition | undefined;
7828
- /**
7829
- * <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
7830
- * Customer Profiles requests on your behalf.</p>
7831
- * @public
7832
- */
7833
- RoleArn?: string | undefined;
7834
- /**
7835
- * <p>A list of unique names for active event triggers associated with the integration.</p>
7836
- * @public
7837
- */
7838
- EventTriggerNames?: string[] | undefined;
7839
- /**
7840
- * <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
7841
- * @public
7842
- */
7843
- Scope?: Scope | undefined;
7844
- }
7845
- /**
7846
- * @public
7847
- */
7848
- export interface PutIntegrationResponse {
7849
- /**
7850
- * <p>The unique name of the domain.</p>
7851
- * @public
7852
- */
7853
- DomainName: string | undefined;
7854
- /**
7855
- * <p>The URI of the S3 bucket or any other type of data source.</p>
7856
- * @public
7857
- */
7858
- Uri: string | undefined;
7859
- /**
7860
- * <p>The name of the profile object type.</p>
7861
- * @public
7862
- */
7863
- ObjectTypeName?: string | undefined;
7864
- /**
7865
- * <p>The timestamp of when the domain was created.</p>
7866
- * @public
7867
- */
7868
- CreatedAt: Date | undefined;
7869
- /**
7870
- * <p>The timestamp of when the domain was most recently edited.</p>
7871
- * @public
7872
- */
7873
- LastUpdatedAt: Date | undefined;
7874
- /**
7875
- * <p>The tags used to organize, track, or control access for this resource.</p>
7876
- * @public
7877
- */
7878
- Tags?: Record<string, string> | undefined;
7879
- /**
7880
- * <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
7881
- * It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
7882
- * <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
7883
- * @public
7884
- */
7885
- ObjectTypeNames?: Record<string, string> | undefined;
7886
- /**
7887
- * <p>Unique identifier for the workflow.</p>
7888
- * @public
7889
- */
7890
- WorkflowId?: string | undefined;
7891
- /**
7892
- * <p>Boolean that shows if the Flow that's associated with the Integration is created in
7893
- * Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
7894
- * flowDefinition.</p>
7895
- * @public
7896
- */
7897
- IsUnstructured?: boolean | undefined;
7898
- /**
7899
- * <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
7900
- * Customer Profiles requests on your behalf.</p>
7901
- * @public
7902
- */
7903
- RoleArn?: string | undefined;
7904
- /**
7905
- * <p>A list of unique names for active event triggers associated with the integration. This
7906
- * list would be empty if no Event Trigger is associated with the integration.</p>
7907
- * @public
7908
- */
7909
- EventTriggerNames?: string[] | undefined;
7910
- /**
7911
- * <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
7912
- * @public
7913
- */
7914
- Scope?: Scope | undefined;
7915
- }
7916
- /**
7917
- * @public
7918
- */
7919
- export interface PutProfileObjectRequest {
7920
- /**
7921
- * <p>The name of the profile object type.</p>
7922
- * @public
7923
- */
7924
- ObjectTypeName: string | undefined;
7925
- /**
7926
- * <p>A string that is serialized from a JSON object.</p>
7927
- * @public
7928
- */
7929
- Object: string | undefined;
7930
- /**
7931
- * <p>The unique name of the domain.</p>
7932
- * @public
7933
- */
7934
- DomainName: string | undefined;
7935
- }
7936
- /**
7937
- * @public
7938
- */
7939
- export interface PutProfileObjectResponse {
7940
- /**
7941
- * <p>The unique identifier of the profile object generated by the service.</p>
7942
- * @public
7943
- */
7944
- ProfileObjectUniqueKey?: string | undefined;
7945
- }
7946
- /**
7947
- * @public
7948
- */
7949
- export interface PutProfileObjectTypeRequest {
7950
- /**
7951
- * <p>The unique name of the domain.</p>
7952
- * @public
7953
- */
7954
- DomainName: string | undefined;
7955
- /**
7956
- * <p>The name of the profile object type.</p>
7957
- * @public
7958
- */
7959
- ObjectTypeName: string | undefined;
7960
- /**
7961
- * <p>Description of the profile object type.</p>
7962
- * @public
7963
- */
7964
- Description: string | undefined;
7965
- /**
7966
- * <p>A unique identifier for the object template. For some attributes in the request, the
7967
- * service will use the default value from the object template when TemplateId is present. If
7968
- * these attributes are present in the request, the service may return a
7969
- * <code>BadRequestException</code>. These attributes include: AllowProfileCreation,
7970
- * SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
7971
- * set to true when TemplateId is set, the service may return a
7972
- * <code>BadRequestException</code>.</p>
7973
- * @public
7974
- */
7975
- TemplateId?: string | undefined;
7976
- /**
7977
- * <p>The number of days until the data in the object expires.</p>
7978
- * @public
7979
- */
7980
- ExpirationDays?: number | undefined;
7981
- /**
7982
- * <p>The customer-provided key to encrypt the profile object that will be created in this
7983
- * profile object type.</p>
7984
- * @public
7985
- */
7986
- EncryptionKey?: string | undefined;
7987
- /**
7988
- * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
7989
- * for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
7990
- * flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
7991
- * associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
7992
- * is found, then the service creates a new standard profile.</p>
7993
- * @public
7994
- */
7995
- AllowProfileCreation?: boolean | undefined;
7996
- /**
7997
- * <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.
7998
- * </p>
7999
- * @public
8000
- */
8001
- SourceLastUpdatedTimestampFormat?: string | undefined;
8002
- /**
8003
- * <p>The amount of profile object max count assigned to the object type</p>
8004
- * @public
8005
- */
8006
- MaxProfileObjectCount?: number | undefined;
8007
- /**
8008
- * <p>An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.</p>
8009
- * @public
8010
- */
8011
- SourcePriority?: number | undefined;
8012
- /**
8013
- * <p>A map of the name and ObjectType field.</p>
8014
- * @public
8015
- */
8016
- Fields?: Record<string, ObjectTypeField> | undefined;
8017
- /**
8018
- * <p>A list of unique keys that can be used to map data to the profile.</p>
8019
- * @public
8020
- */
8021
- Keys?: Record<string, ObjectTypeKey[]> | undefined;
8022
- /**
8023
- * <p>The tags used to organize, track, or control access for this resource.</p>
8024
- * @public
8025
- */
8026
- Tags?: Record<string, string> | undefined;
8027
- }
8028
- /**
8029
- * @public
8030
- */
8031
- export interface PutProfileObjectTypeResponse {
8032
- /**
8033
- * <p>The name of the profile object type.</p>
8034
- * @public
8035
- */
8036
- ObjectTypeName: string | undefined;
8037
- /**
8038
- * <p>Description of the profile object type.</p>
8039
- * @public
8040
- */
8041
- Description: string | undefined;
8042
- /**
8043
- * <p>A unique identifier for the object template.</p>
8044
- * @public
8045
- */
8046
- TemplateId?: string | undefined;
8047
- /**
8048
- * <p>The number of days until the data in the object expires.</p>
8049
- * @public
8050
- */
8051
- ExpirationDays?: number | undefined;
8052
- /**
8053
- * <p>The customer-provided key to encrypt the profile object that will be created in this
8054
- * profile object type.</p>
8055
- * @public
8056
- */
8057
- EncryptionKey?: string | undefined;
8058
- /**
8059
- * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
8060
- * for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
8061
- * flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
8062
- * associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
8063
- * is found, then the service creates a new standard profile.</p>
8064
- * @public
8065
- */
8066
- AllowProfileCreation?: boolean | undefined;
8067
- /**
8068
- * <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in
8069
- * fields that were parsed using <a href="https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>. If you have <code>sourceLastUpdatedTimestamp</code> in your
8070
- * field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>
8071
- * @public
8072
- */
8073
- SourceLastUpdatedTimestampFormat?: string | undefined;
8074
- /**
8075
- * <p>The amount of profile object max count assigned to the object type.</p>
8076
- * @public
8077
- */
8078
- MaxProfileObjectCount?: number | undefined;
8079
- /**
8080
- * <p>The amount of provisioned profile object max count available.</p>
8081
- * @public
8082
- */
8083
- MaxAvailableProfileObjectCount?: number | undefined;
8084
- /**
8085
- * <p>An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.</p>
8086
- * @public
8087
- */
8088
- SourcePriority?: number | undefined;
8089
- /**
8090
- * <p>A map of the name and ObjectType field.</p>
8091
- * @public
8092
- */
8093
- Fields?: Record<string, ObjectTypeField> | undefined;
8094
- /**
8095
- * <p>A list of unique keys that can be used to map data to the profile.</p>
8096
- * @public
8097
- */
8098
- Keys?: Record<string, ObjectTypeKey[]> | undefined;
8099
- /**
8100
- * <p>The timestamp of when the domain was created.</p>
8101
- * @public
8102
- */
8103
- CreatedAt?: Date | undefined;
8104
- /**
8105
- * <p>The timestamp of when the domain was most recently edited.</p>
8106
- * @public
8107
- */
8108
- LastUpdatedAt?: Date | undefined;
8109
- /**
8110
- * <p>The tags used to organize, track, or control access for this resource.</p>
8111
- * @public
8112
- */
8113
- Tags?: Record<string, string> | undefined;
8114
- }
8115
- /**
8116
- * @public
8117
- */
8118
- export interface SearchProfilesRequest {
8119
- /**
8120
- * <p>The pagination token from the previous SearchProfiles API call.</p>
8121
- * @public
8122
- */
8123
- NextToken?: string | undefined;
8124
- /**
8125
- * <p>The maximum number of objects returned per page.</p>
8126
- * <p>The default is 20 if this parameter is not included in the request.</p>
8127
- * @public
8128
- */
8129
- MaxResults?: number | undefined;
8130
- /**
8131
- * <p>The unique name of the domain.</p>
8132
- * @public
8133
- */
8134
- DomainName: string | undefined;
8135
- /**
8136
- * <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
8137
- * _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
8138
- * _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
8139
- * _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
8140
- * _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
8141
- * @public
8142
- */
8143
- KeyName: string | undefined;
8144
- /**
8145
- * <p>A list of key values.</p>
8146
- * @public
8147
- */
8148
- Values: string[] | undefined;
8149
- /**
8150
- * <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
8151
- * of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
8152
- * and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
8153
- * pair). These additional search keys will be used in conjunction with the
8154
- * <code>LogicalOperator</code> and the required <code>KeyName</code> and
8155
- * <code>Values</code> parameters to search for profiles that satisfy the search criteria.
8156
- * </p>
8157
- * @public
8158
- */
8159
- AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
8160
- /**
8161
- * <p>Relationship between all specified search keys that will be used to search for profiles.
8162
- * This includes the required <code>KeyName</code> and <code>Values</code> parameters as well
8163
- * as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
8164
- * <p>This parameter influences which profiles will be returned in the response in the
8165
- * following manner:</p>
8166
- * <ul>
8167
- * <li>
8168
- * <p>
8169
- * <code>AND</code> - The response only includes profiles that match all of the
8170
- * search keys.</p>
8171
- * </li>
8172
- * <li>
8173
- * <p>
8174
- * <code>OR</code> - The response includes profiles that match at least one of the
8175
- * search keys.</p>
8176
- * </li>
8177
- * </ul>
8178
- * <p>The <code>OR</code> relationship is the default behavior if this parameter is not
8179
- * included in the request.</p>
8180
- * @public
8181
- */
8182
- LogicalOperator?: LogicalOperator | undefined;
8183
- }
8184
- /**
8185
- * @public
8186
- */
8187
- export interface SearchProfilesResponse {
8188
- /**
8189
- * <p>The list of Profiles matching the search criteria.</p>
8190
- * @public
8191
- */
8192
- Items?: Profile[] | undefined;
8193
- /**
8194
- * <p>The pagination token from the previous SearchProfiles API call.</p>
8195
- * @public
8196
- */
8197
- NextToken?: string | undefined;
8198
- }
8199
- /**
8200
- * @public
8201
- */
8202
- export interface StartRecommenderRequest {
8203
- /**
8204
- * <p>The unique name of the domain.</p>
8205
- * @public
8206
- */
8207
- DomainName: string | undefined;
8208
- /**
8209
- * <p>The name of the recommender to start.</p>
8210
- * @public
8211
- */
8212
- RecommenderName: string | undefined;
8213
- }
8214
- /**
8215
- * @public
8216
- */
8217
- export interface StartRecommenderResponse {
8218
- }
8219
- /**
8220
- * @public
8221
- */
8222
- export interface StartUploadJobRequest {
8223
- /**
8224
- * <p>The unique name of the domain containing the upload job to start. </p>
8225
- * @public
8226
- */
8227
- DomainName: string | undefined;
8228
- /**
8229
- * <p>The unique identifier of the upload job to start. </p>
8230
- * @public
8231
- */
8232
- JobId: string | undefined;
8233
- }
8234
- /**
8235
- * @public
8236
- */
8237
- export interface StartUploadJobResponse {
8238
- }
8239
- /**
8240
- * @public
8241
- */
8242
- export interface StopRecommenderRequest {
8243
- /**
8244
- * <p>The unique name of the domain.</p>
8245
- * @public
8246
- */
8247
- DomainName: string | undefined;
8248
- /**
8249
- * <p>The name of the recommender to stop.</p>
8250
- * @public
8251
- */
8252
- RecommenderName: string | undefined;
8253
- }