@aws-sdk/client-customer-profiles 3.1049.0 → 3.1051.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
@@ -6,7 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Native.
8
8
 
9
- <fullname>Amazon Connect Customer Profiles</fullname>
9
+ <fullname>Connect Customer Customer Profiles</fullname>
10
10
  <ul>
11
11
  <li>
12
12
  <p>
@@ -19,12 +19,12 @@ AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Na
19
19
  </p>
20
20
  </li>
21
21
  </ul>
22
- <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
22
+ <p>Connect Customer Customer Profiles is a unified customer profile for your contact
23
23
  center that has pre-built connectors powered by AppFlow that make it easy to combine
24
24
  customer information from third party applications, such as Salesforce (CRM), ServiceNow
25
- (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
26
- <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
27
- Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
25
+ (ITSM), and your enterprise resource planning (ERP), with contact history from your Connect Customer contact center. </p>
26
+ <p>For more information about the Connect Customer Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
27
+ Profiles</a> in the <i>Connect Customer Administrator's Guide</i>. </p>
28
28
 
29
29
  ## Installing
30
30
 
@@ -231,6 +231,7 @@ const _E = "Expression";
231
231
  const _EA = "EmailAddress";
232
232
  const _EC = "EventsConfig";
233
233
  const _ECx = "ExportingConfig";
234
+ const _ECxc = "ExcludedColumns";
234
235
  const _ED = "ExpirationDays";
235
236
  const _EDFU = "EnableDynamicFieldUpdate";
236
237
  const _EDr = "ErrorDescription";
@@ -2316,8 +2317,8 @@ exports.Recommendation$ = [3, n0, _Recom,
2316
2317
  ];
2317
2318
  exports.RecommenderConfig$ = [3, n0, _RC,
2318
2319
  0,
2319
- [_EC, _TFr, _ICn, _ICnc],
2320
- [() => exports.EventsConfig$, 1, () => exports.InferenceConfig$, [2, n0, _ICnc, 0, 0, 64 | 0]]
2320
+ [_EC, _TFr, _ICn, _ICnc, _ECxc],
2321
+ [() => exports.EventsConfig$, 1, () => exports.InferenceConfig$, [2, n0, _ICnc, 0, 0, 64 | 0], [2, n0, _ICnc, 0, 0, 64 | 0]]
2321
2322
  ];
2322
2323
  exports.RecommenderFilter$ = [3, n0, _RFe,
2323
2324
  0,
@@ -219,6 +219,7 @@ const _E = "Expression";
219
219
  const _EA = "EmailAddress";
220
220
  const _EC = "EventsConfig";
221
221
  const _ECx = "ExportingConfig";
222
+ const _ECxc = "ExcludedColumns";
222
223
  const _ED = "ExpirationDays";
223
224
  const _EDFU = "EnableDynamicFieldUpdate";
224
225
  const _EDr = "ErrorDescription";
@@ -2304,8 +2305,8 @@ export var Recommendation$ = [3, n0, _Recom,
2304
2305
  ];
2305
2306
  export var RecommenderConfig$ = [3, n0, _RC,
2306
2307
  0,
2307
- [_EC, _TFr, _ICn, _ICnc],
2308
- [() => EventsConfig$, 1, () => InferenceConfig$, [2, n0, _ICnc, 0, 0, 64 | 0]]
2308
+ [_EC, _TFr, _ICn, _ICnc, _ECxc],
2309
+ [() => EventsConfig$, 1, () => InferenceConfig$, [2, n0, _ICnc, 0, 0, 64 | 0], [2, n0, _ICnc, 0, 0, 64 | 0]]
2309
2310
  ];
2310
2311
  export var RecommenderFilter$ = [3, n0, _RFe,
2311
2312
  0,
@@ -839,7 +839,7 @@ export interface CustomerProfiles {
839
839
  paginateListUploadJobs(args: ListUploadJobsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListUploadJobsCommandOutput>;
840
840
  }
841
841
  /**
842
- * <fullname>Amazon Connect Customer Profiles</fullname>
842
+ * <fullname>Connect Customer Customer Profiles</fullname>
843
843
  * <ul>
844
844
  * <li>
845
845
  * <p>
@@ -852,12 +852,12 @@ export interface CustomerProfiles {
852
852
  * </p>
853
853
  * </li>
854
854
  * </ul>
855
- * <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
855
+ * <p>Connect Customer Customer Profiles is a unified customer profile for your contact
856
856
  * center that has pre-built connectors powered by AppFlow that make it easy to combine
857
857
  * customer information from third party applications, such as Salesforce (CRM), ServiceNow
858
- * (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
859
- * <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
860
- * Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
858
+ * (ITSM), and your enterprise resource planning (ERP), with contact history from your Connect Customer contact center. </p>
859
+ * <p>For more information about the Connect Customer Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
860
+ * Profiles</a> in the <i>Connect Customer Administrator's Guide</i>. </p>
861
861
  * @public
862
862
  */
863
863
  export declare class CustomerProfiles extends CustomerProfilesClient implements CustomerProfiles {
@@ -274,7 +274,7 @@ export type CustomerProfilesClientResolvedConfigType = __SmithyResolvedConfigura
274
274
  export interface CustomerProfilesClientResolvedConfig extends CustomerProfilesClientResolvedConfigType {
275
275
  }
276
276
  /**
277
- * <fullname>Amazon Connect Customer Profiles</fullname>
277
+ * <fullname>Connect Customer Customer Profiles</fullname>
278
278
  * <ul>
279
279
  * <li>
280
280
  * <p>
@@ -287,12 +287,12 @@ export interface CustomerProfilesClientResolvedConfig extends CustomerProfilesCl
287
287
  * </p>
288
288
  * </li>
289
289
  * </ul>
290
- * <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
290
+ * <p>Connect Customer Customer Profiles is a unified customer profile for your contact
291
291
  * center that has pre-built connectors powered by AppFlow that make it easy to combine
292
292
  * customer information from third party applications, such as Salesforce (CRM), ServiceNow
293
- * (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
294
- * <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
295
- * Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
293
+ * (ITSM), and your enterprise resource planning (ERP), with contact history from your Connect Customer contact center. </p>
294
+ * <p>For more information about the Connect Customer Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
295
+ * Profiles</a> in the <i>Connect Customer Administrator's Guide</i>. </p>
296
296
  * @public
297
297
  */
298
298
  export declare class CustomerProfilesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CustomerProfilesClientResolvedConfig> {
@@ -32,8 +32,8 @@ declare const CreateDomainCommand_base: {
32
32
  * <p>Creates a domain, which is a container for all customer data, such as customer profile
33
33
  * attributes, object types, profile keys, and encryption keys. You can create multiple
34
34
  * domains, and each domain can have multiple third-party integrations.</p>
35
- * <p>Each Amazon Connect instance can be associated with only one domain. Multiple
36
- * Amazon Connect instances can be associated with one domain.</p>
35
+ * <p>Each Connect Customer instance can be associated with only one domain. Multiple
36
+ * Connect Customer instances can be associated with one domain.</p>
37
37
  * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
38
38
  * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
39
39
  * resolution</a>: set <code>Matching</code> to true.</p>
@@ -30,7 +30,7 @@ declare const CreateEventStreamCommand_base: {
30
30
  };
31
31
  /**
32
32
  * <p>Creates an event stream, which is a subscription to real-time events, such as when
33
- * profiles are created and updated through Amazon Connect Customer Profiles.</p>
33
+ * profiles are created and updated through Connect Customer Customer Profiles.</p>
34
34
  * <p>Each event stream can be associated with only one Kinesis Data Stream destination in the
35
35
  * same region and Amazon Web Services account as the customer profiles domain</p>
36
36
  * @example
@@ -61,6 +61,11 @@ declare const CreateRecommenderCommand_base: {
61
61
  * "STRING_VALUE",
62
62
  * ],
63
63
  * },
64
+ * ExcludedColumns: {
65
+ * "<keys>": [
66
+ * "STRING_VALUE",
67
+ * ],
68
+ * },
64
69
  * },
65
70
  * Description: "STRING_VALUE",
66
71
  * RecommenderSchemaName: "STRING_VALUE",
@@ -68,6 +68,11 @@ declare const GetRecommenderCommand_base: {
68
68
  * // "STRING_VALUE",
69
69
  * // ],
70
70
  * // },
71
+ * // ExcludedColumns: {
72
+ * // "<keys>": [
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // },
71
76
  * // },
72
77
  * // Description: "STRING_VALUE",
73
78
  * // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
@@ -94,6 +99,11 @@ declare const GetRecommenderCommand_base: {
94
99
  * // "STRING_VALUE",
95
100
  * // ],
96
101
  * // },
102
+ * // ExcludedColumns: {
103
+ * // "<keys>": [
104
+ * // "STRING_VALUE",
105
+ * // ],
106
+ * // },
97
107
  * // },
98
108
  * // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
99
109
  * // CreatedAt: new Date("TIMESTAMP"),
@@ -71,6 +71,11 @@ declare const ListRecommendersCommand_base: {
71
71
  * // "STRING_VALUE",
72
72
  * // ],
73
73
  * // },
74
+ * // ExcludedColumns: {
75
+ * // "<keys>": [
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // },
74
79
  * // },
75
80
  * // CreatedAt: new Date("TIMESTAMP"),
76
81
  * // Description: "STRING_VALUE",
@@ -100,6 +105,11 @@ declare const ListRecommendersCommand_base: {
100
105
  * // "STRING_VALUE",
101
106
  * // ],
102
107
  * // },
108
+ * // ExcludedColumns: {
109
+ * // "<keys>": [
110
+ * // "STRING_VALUE",
111
+ * // ],
112
+ * // },
103
113
  * // },
104
114
  * // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
105
115
  * // CreatedAt: new Date("TIMESTAMP"),
@@ -61,6 +61,11 @@ declare const UpdateRecommenderCommand_base: {
61
61
  * "STRING_VALUE",
62
62
  * ],
63
63
  * },
64
+ * ExcludedColumns: {
65
+ * "<keys>": [
66
+ * "STRING_VALUE",
67
+ * ],
68
+ * },
64
69
  * },
65
70
  * };
66
71
  * const command = new UpdateRecommenderCommand(input);
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <fullname>Amazon Connect Customer Profiles</fullname>
2
+ * <fullname>Connect Customer Customer Profiles</fullname>
3
3
  * <ul>
4
4
  * <li>
5
5
  * <p>
@@ -12,12 +12,12 @@
12
12
  * </p>
13
13
  * </li>
14
14
  * </ul>
15
- * <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
15
+ * <p>Connect Customer Customer Profiles is a unified customer profile for your contact
16
16
  * center that has pre-built connectors powered by AppFlow that make it easy to combine
17
17
  * customer information from third party applications, such as Salesforce (CRM), ServiceNow
18
- * (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
19
- * <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
20
- * Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
18
+ * (ITSM), and your enterprise resource planning (ERP), with contact history from your Connect Customer contact center. </p>
19
+ * <p>For more information about the Connect Customer Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
20
+ * Profiles</a> in the <i>Connect Customer Administrator's Guide</i>. </p>
21
21
  *
22
22
  * @packageDocumentation
23
23
  */
@@ -2013,7 +2013,7 @@ export interface CreateDomainRequest {
2013
2013
  Matching?: MatchingRequest | undefined;
2014
2014
  /**
2015
2015
  * <p>The process of matching duplicate profiles using the Rule-Based matching. If
2016
- * <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
2016
+ * <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start
2017
2017
  * to match and merge your profiles according to your configuration in the
2018
2018
  * <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
2019
2019
  * and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
@@ -2195,7 +2195,7 @@ export interface CreateDomainResponse {
2195
2195
  Matching?: MatchingResponse | undefined;
2196
2196
  /**
2197
2197
  * <p>The process of matching duplicate profiles using the Rule-Based matching. If
2198
- * <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
2198
+ * <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start
2199
2199
  * to match and merge your profiles according to your configuration in the
2200
2200
  * <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
2201
2201
  * and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
@@ -2836,7 +2836,7 @@ export interface RecommenderConfig {
2836
2836
  */
2837
2837
  EventsConfig?: EventsConfig | undefined;
2838
2838
  /**
2839
- * <p>How often the recommender should retrain its model with new data.</p>
2839
+ * <p>How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled.</p>
2840
2840
  * @public
2841
2841
  */
2842
2842
  TrainingFrequency?: number | undefined;
@@ -2846,10 +2846,15 @@ export interface RecommenderConfig {
2846
2846
  */
2847
2847
  InferenceConfig?: InferenceConfig | undefined;
2848
2848
  /**
2849
- * <p>A map of dataset type to a list of column names to train on. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included and do not need to be specified: <code>Item.Id</code>, <code>ItemList[].Id</code>, <code>EventTimestamp</code>, <code>EventType</code>, and <code>EventValue</code>.</p>
2849
+ * <p>A map of dataset type to a list of column names to train on. The <code>_webAnalytics</code> and <code>_catalogItem</code> keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: <code>Item.Id</code>, <code>EventTimestamp</code>, and <code>EventType</code> for <code>_webAnalytics</code>; <code>Id</code> for <code>_catalogItem</code>. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request.</p>
2850
2850
  * @public
2851
2851
  */
2852
2852
  IncludedColumns?: Record<string, string[]> | undefined;
2853
+ /**
2854
+ * <p>A map of dataset type to a list of column names to exclude from training. The <code>_webAnalytics</code> and <code>_catalogItem</code> keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: <code>Item.Id</code>, <code>EventTimestamp</code>, and <code>EventType</code> for <code>_webAnalytics</code>; <code>Id</code> for <code>_catalogItem</code>. Mutually exclusive with IncludedColumns — both cannot be specified in the same request.</p>
2855
+ * @public
2856
+ */
2857
+ ExcludedColumns?: Record<string, string[]> | undefined;
2853
2858
  }
2854
2859
  /**
2855
2860
  * @public
@@ -2992,7 +2997,7 @@ export interface CreateRecommenderSchemaRequest {
2992
2997
  */
2993
2998
  RecommenderSchemaName: string | undefined;
2994
2999
  /**
2995
- * <p>A map of dataset type to column definitions that specifies which data columns to include in the schema. Currently only the <code>_webAnalytics</code> key is supported.</p>
3000
+ * <p>A map of dataset type to column definitions that specifies which data columns to include in the schema. The <code>_webAnalytics</code> and <code>_catalogItem</code> keys are supported.</p>
2996
3001
  * @public
2997
3002
  */
2998
3003
  Fields: Record<string, RecommenderSchemaField[]> | undefined;
@@ -3509,7 +3514,7 @@ export interface CreateSegmentSnapshotRequest {
3509
3514
  RoleArn?: string | undefined;
3510
3515
  /**
3511
3516
  * <p>The destination to which the segment will be exported. This field must be provided if
3512
- * the request is not submitted from the Amazon Connect Admin Website.</p>
3517
+ * the request is not submitted from the Connect Customer Admin Website.</p>
3513
3518
  * @public
3514
3519
  */
3515
3520
  DestinationUri?: string | undefined;
@@ -4328,7 +4333,7 @@ export interface GetDomainResponse {
4328
4333
  Matching?: MatchingResponse | undefined;
4329
4334
  /**
4330
4335
  * <p>The process of matching duplicate profiles using the Rule-Based matching. If
4331
- * <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
4336
+ * <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start
4332
4337
  * to match and merge your profiles according to your configuration in the
4333
4338
  * <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
4334
4339
  * and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
@@ -5927,7 +5932,7 @@ export interface GetSegmentSnapshotResponse {
5927
5932
  RoleArn?: string | undefined;
5928
5933
  /**
5929
5934
  * <p>The destination to which the segment will be exported. This field must be provided if
5930
- * the request is not submitted from the Amazon Connect Admin Website.</p>
5935
+ * the request is not submitted from the Connect Customer Admin Website.</p>
5931
5936
  * @public
5932
5937
  */
5933
5938
  DestinationUri?: string | undefined;
@@ -1086,7 +1086,7 @@ export interface UpdateDomainRequest {
1086
1086
  Matching?: MatchingRequest | undefined;
1087
1087
  /**
1088
1088
  * <p>The process of matching duplicate profiles using the rule-Based matching. If
1089
- * <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
1089
+ * <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start
1090
1090
  * to match and merge your profiles according to your configuration in the
1091
1091
  * <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
1092
1092
  * and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
@@ -1146,7 +1146,7 @@ export interface UpdateDomainResponse {
1146
1146
  Matching?: MatchingResponse | undefined;
1147
1147
  /**
1148
1148
  * <p>The process of matching duplicate profiles using the rule-Based matching. If
1149
- * <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
1149
+ * <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start
1150
1150
  * to match and merge your profiles according to your configuration in the
1151
1151
  * <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
1152
1152
  * and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
@@ -636,6 +636,7 @@ export interface RecommenderConfig {
636
636
  TrainingFrequency?: number | undefined;
637
637
  InferenceConfig?: InferenceConfig | undefined;
638
638
  IncludedColumns?: Record<string, string[]> | undefined;
639
+ ExcludedColumns?: Record<string, string[]> | undefined;
639
640
  }
640
641
  export interface CreateRecommenderRequest {
641
642
  DomainName: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-customer-profiles",
3
3
  "description": "AWS SDK for JavaScript Customer Profiles Client for Node.js, Browser and React Native",
4
- "version": "3.1049.0",
4
+ "version": "3.1051.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-customer-profiles",