@aws-sdk/client-customer-profiles 3.315.0 → 3.316.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.
@@ -38,450 +38,244 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
38
38
  import { UpdateDomainCommandInput, UpdateDomainCommandOutput } from "./commands/UpdateDomainCommand";
39
39
  import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./commands/UpdateProfileCommand";
40
40
  import { CustomerProfilesClient } from "./CustomerProfilesClient";
41
- /**
42
- * @public
43
- * <fullname>Amazon Connect Customer Profiles</fullname>
44
- * <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
45
- * pre-built connectors powered by AppFlow that make it easy to combine customer information
46
- * from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
47
- * enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
48
- * If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
49
- */
50
- export declare class CustomerProfiles extends CustomerProfilesClient {
41
+ export interface CustomerProfiles {
51
42
  /**
52
- * @public
53
- * <p>Associates a new key value with a specific profile, such as a Contact Record
54
- * ContactId.</p>
55
- * <p>A profile object can have a single unique key and any number of additional keys that can
56
- * be used to identify the profile that it belongs to.</p>
43
+ * @see {@link AddProfileKeyCommand}
57
44
  */
58
45
  addProfileKey(args: AddProfileKeyCommandInput, options?: __HttpHandlerOptions): Promise<AddProfileKeyCommandOutput>;
59
46
  addProfileKey(args: AddProfileKeyCommandInput, cb: (err: any, data?: AddProfileKeyCommandOutput) => void): void;
60
47
  addProfileKey(args: AddProfileKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddProfileKeyCommandOutput) => void): void;
61
48
  /**
62
- * @public
63
- * <p>Creates a domain, which is a container for all customer data, such as customer profile
64
- * attributes, object types, profile keys, and encryption keys. You can create multiple
65
- * domains, and each domain can have multiple third-party integrations.</p>
66
- * <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can
67
- * be associated with one domain.</p>
68
- * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
69
- * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
70
- * resolution</a>: set <code>Matching</code> to true. </p>
71
- * <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
72
- * apply. </p>
49
+ * @see {@link CreateDomainCommand}
73
50
  */
74
51
  createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise<CreateDomainCommandOutput>;
75
52
  createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
76
53
  createDomain(args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
77
54
  /**
78
- * @public
79
- * <p>
80
- * Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
81
- * </p>
55
+ * @see {@link CreateIntegrationWorkflowCommand}
82
56
  */
83
57
  createIntegrationWorkflow(args: CreateIntegrationWorkflowCommandInput, options?: __HttpHandlerOptions): Promise<CreateIntegrationWorkflowCommandOutput>;
84
58
  createIntegrationWorkflow(args: CreateIntegrationWorkflowCommandInput, cb: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void): void;
85
59
  createIntegrationWorkflow(args: CreateIntegrationWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void): void;
86
60
  /**
87
- * @public
88
- * <p>Creates a standard profile.</p>
89
- * <p>A standard profile represents the following attributes for a customer profile in a
90
- * domain.</p>
61
+ * @see {@link CreateProfileCommand}
91
62
  */
92
63
  createProfile(args: CreateProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateProfileCommandOutput>;
93
64
  createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void;
94
65
  createProfile(args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void): void;
95
66
  /**
96
- * @public
97
- * <p>Deletes a specific domain and all of its customer data, such as customer profile
98
- * attributes and their related objects.</p>
67
+ * @see {@link DeleteDomainCommand}
99
68
  */
100
69
  deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDomainCommandOutput>;
101
70
  deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
102
71
  deleteDomain(args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
103
72
  /**
104
- * @public
105
- * <p>Removes an integration from a specific domain.</p>
73
+ * @see {@link DeleteIntegrationCommand}
106
74
  */
107
75
  deleteIntegration(args: DeleteIntegrationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIntegrationCommandOutput>;
108
76
  deleteIntegration(args: DeleteIntegrationCommandInput, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void): void;
109
77
  deleteIntegration(args: DeleteIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void): void;
110
78
  /**
111
- * @public
112
- * <p>Deletes the standard customer profile and all data pertaining to the profile.</p>
79
+ * @see {@link DeleteProfileCommand}
113
80
  */
114
81
  deleteProfile(args: DeleteProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProfileCommandOutput>;
115
82
  deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void;
116
83
  deleteProfile(args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void;
117
84
  /**
118
- * @public
119
- * <p>Removes a searchable key from a customer profile.</p>
85
+ * @see {@link DeleteProfileKeyCommand}
120
86
  */
121
87
  deleteProfileKey(args: DeleteProfileKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProfileKeyCommandOutput>;
122
88
  deleteProfileKey(args: DeleteProfileKeyCommandInput, cb: (err: any, data?: DeleteProfileKeyCommandOutput) => void): void;
123
89
  deleteProfileKey(args: DeleteProfileKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileKeyCommandOutput) => void): void;
124
90
  /**
125
- * @public
126
- * <p>Removes an object associated with a profile of a given ProfileObjectType.</p>
91
+ * @see {@link DeleteProfileObjectCommand}
127
92
  */
128
93
  deleteProfileObject(args: DeleteProfileObjectCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProfileObjectCommandOutput>;
129
94
  deleteProfileObject(args: DeleteProfileObjectCommandInput, cb: (err: any, data?: DeleteProfileObjectCommandOutput) => void): void;
130
95
  deleteProfileObject(args: DeleteProfileObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileObjectCommandOutput) => void): void;
131
96
  /**
132
- * @public
133
- * <p>Removes a ProfileObjectType from a specific domain as well as removes all the
134
- * ProfileObjects of that type. It also disables integrations from this specific
135
- * ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that
136
- * were populated from this ProfileObjectType.</p>
97
+ * @see {@link DeleteProfileObjectTypeCommand}
137
98
  */
138
99
  deleteProfileObjectType(args: DeleteProfileObjectTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProfileObjectTypeCommandOutput>;
139
100
  deleteProfileObjectType(args: DeleteProfileObjectTypeCommandInput, cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void): void;
140
101
  deleteProfileObjectType(args: DeleteProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void): void;
141
102
  /**
142
- * @public
143
- * <p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>
103
+ * @see {@link DeleteWorkflowCommand}
144
104
  */
145
105
  deleteWorkflow(args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkflowCommandOutput>;
146
106
  deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void;
147
107
  deleteWorkflow(args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void;
148
108
  /**
149
- * @public
150
- * <p>Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly
151
- * selects a sample of matching groups from the existing matching results, and applies the
152
- * automerging settings that you provided. You can then view the number of profiles in the
153
- * sample, the number of matches, and the number of profiles identified to be merged. This
154
- * enables you to evaluate the accuracy of the attributes in your matching list. </p>
155
- * <p>You can't view which profiles are matched and would be merged.</p>
156
- * <important>
157
- * <p>We strongly recommend you use this API to do a dry run of the automerging process
158
- * before running the Identity Resolution Job. Include <b>at least</b> two matching
159
- * attributes. If your matching list includes too few attributes (such as only
160
- * <code>FirstName</code> or only <code>LastName</code>), there may be a large number of
161
- * matches. This increases the chances of erroneous merges.</p>
162
- * </important>
109
+ * @see {@link GetAutoMergingPreviewCommand}
163
110
  */
164
111
  getAutoMergingPreview(args: GetAutoMergingPreviewCommandInput, options?: __HttpHandlerOptions): Promise<GetAutoMergingPreviewCommandOutput>;
165
112
  getAutoMergingPreview(args: GetAutoMergingPreviewCommandInput, cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void): void;
166
113
  getAutoMergingPreview(args: GetAutoMergingPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void): void;
167
114
  /**
168
- * @public
169
- * <p>Returns information about a specific domain.</p>
115
+ * @see {@link GetDomainCommand}
170
116
  */
171
117
  getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise<GetDomainCommandOutput>;
172
118
  getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
173
119
  getDomain(args: GetDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
174
120
  /**
175
- * @public
176
- * <p>Returns information about an Identity Resolution Job in a specific domain. </p>
177
- * <p>Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html">Use
178
- * Identity Resolution to consolidate similar profiles</a>.</p>
121
+ * @see {@link GetIdentityResolutionJobCommand}
179
122
  */
180
123
  getIdentityResolutionJob(args: GetIdentityResolutionJobCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityResolutionJobCommandOutput>;
181
124
  getIdentityResolutionJob(args: GetIdentityResolutionJobCommandInput, cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void): void;
182
125
  getIdentityResolutionJob(args: GetIdentityResolutionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void): void;
183
126
  /**
184
- * @public
185
- * <p>Returns an integration for a domain.</p>
127
+ * @see {@link GetIntegrationCommand}
186
128
  */
187
129
  getIntegration(args: GetIntegrationCommandInput, options?: __HttpHandlerOptions): Promise<GetIntegrationCommandOutput>;
188
130
  getIntegration(args: GetIntegrationCommandInput, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void;
189
131
  getIntegration(args: GetIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void;
190
132
  /**
191
- * @public
192
- * <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
193
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
194
- * enable identity resolution: set <code>Matching</code> to true.</p>
195
- * <p>GetMatches returns potentially matching profiles, based on the results of the latest run
196
- * of a machine learning process. </p>
197
- * <important>
198
- * <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
199
- * batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every
200
- * Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
201
- * <p>After the Identity Resolution Job completes, use the
202
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
203
- * API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from
204
- * S3.</p>
205
- * </important>
206
- * <p>Amazon Connect uses the following profile attributes to identify matches:</p>
207
- * <ul>
208
- * <li>
209
- * <p>PhoneNumber</p>
210
- * </li>
211
- * <li>
212
- * <p>HomePhoneNumber</p>
213
- * </li>
214
- * <li>
215
- * <p>BusinessPhoneNumber</p>
216
- * </li>
217
- * <li>
218
- * <p>MobilePhoneNumber</p>
219
- * </li>
220
- * <li>
221
- * <p>EmailAddress</p>
222
- * </li>
223
- * <li>
224
- * <p>PersonalEmailAddress</p>
225
- * </li>
226
- * <li>
227
- * <p>BusinessEmailAddress</p>
228
- * </li>
229
- * <li>
230
- * <p>FullName</p>
231
- * </li>
232
- * </ul>
233
- * <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing
234
- * email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and
235
- * <b>johndoe@anycompany.com</b>, or different phone number
236
- * formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>
133
+ * @see {@link GetMatchesCommand}
237
134
  */
238
135
  getMatches(args: GetMatchesCommandInput, options?: __HttpHandlerOptions): Promise<GetMatchesCommandOutput>;
239
136
  getMatches(args: GetMatchesCommandInput, cb: (err: any, data?: GetMatchesCommandOutput) => void): void;
240
137
  getMatches(args: GetMatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMatchesCommandOutput) => void): void;
241
138
  /**
242
- * @public
243
- * <p>Returns the object types for a specific domain.</p>
139
+ * @see {@link GetProfileObjectTypeCommand}
244
140
  */
245
141
  getProfileObjectType(args: GetProfileObjectTypeCommandInput, options?: __HttpHandlerOptions): Promise<GetProfileObjectTypeCommandOutput>;
246
142
  getProfileObjectType(args: GetProfileObjectTypeCommandInput, cb: (err: any, data?: GetProfileObjectTypeCommandOutput) => void): void;
247
143
  getProfileObjectType(args: GetProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileObjectTypeCommandOutput) => void): void;
248
144
  /**
249
- * @public
250
- * <p>Returns the template information for a specific object type.</p>
251
- * <p>A template is a predefined ProfileObjectType, such as “Salesforce-Account” or
252
- * “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API,
253
- * with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the
254
- * template.</p>
145
+ * @see {@link GetProfileObjectTypeTemplateCommand}
255
146
  */
256
147
  getProfileObjectTypeTemplate(args: GetProfileObjectTypeTemplateCommandInput, options?: __HttpHandlerOptions): Promise<GetProfileObjectTypeTemplateCommandOutput>;
257
148
  getProfileObjectTypeTemplate(args: GetProfileObjectTypeTemplateCommandInput, cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void): void;
258
149
  getProfileObjectTypeTemplate(args: GetProfileObjectTypeTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void): void;
259
150
  /**
260
- * @public
261
- * <p>Get details of specified workflow.</p>
151
+ * @see {@link GetWorkflowCommand}
262
152
  */
263
153
  getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkflowCommandOutput>;
264
154
  getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void;
265
155
  getWorkflow(args: GetWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void;
266
156
  /**
267
- * @public
268
- * <p>Get granular list of steps in workflow.</p>
157
+ * @see {@link GetWorkflowStepsCommand}
269
158
  */
270
159
  getWorkflowSteps(args: GetWorkflowStepsCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkflowStepsCommandOutput>;
271
160
  getWorkflowSteps(args: GetWorkflowStepsCommandInput, cb: (err: any, data?: GetWorkflowStepsCommandOutput) => void): void;
272
161
  getWorkflowSteps(args: GetWorkflowStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowStepsCommandOutput) => void): void;
273
162
  /**
274
- * @public
275
- * <p>Lists all of the integrations associated to a specific URI in the AWS account.</p>
163
+ * @see {@link ListAccountIntegrationsCommand}
276
164
  */
277
165
  listAccountIntegrations(args: ListAccountIntegrationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountIntegrationsCommandOutput>;
278
166
  listAccountIntegrations(args: ListAccountIntegrationsCommandInput, cb: (err: any, data?: ListAccountIntegrationsCommandOutput) => void): void;
279
167
  listAccountIntegrations(args: ListAccountIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountIntegrationsCommandOutput) => void): void;
280
168
  /**
281
- * @public
282
- * <p>Returns a list of all the domains for an AWS account that have been created.</p>
169
+ * @see {@link ListDomainsCommand}
283
170
  */
284
171
  listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
285
172
  listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
286
173
  listDomains(args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
287
174
  /**
288
- * @public
289
- * <p>Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
290
- * <code>JobStartTime</code>.</p>
175
+ * @see {@link ListIdentityResolutionJobsCommand}
291
176
  */
292
177
  listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListIdentityResolutionJobsCommandOutput>;
293
178
  listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void): void;
294
179
  listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void): void;
295
180
  /**
296
- * @public
297
- * <p>Lists all of the integrations in your domain.</p>
181
+ * @see {@link ListIntegrationsCommand}
298
182
  */
299
183
  listIntegrations(args: ListIntegrationsCommandInput, options?: __HttpHandlerOptions): Promise<ListIntegrationsCommandOutput>;
300
184
  listIntegrations(args: ListIntegrationsCommandInput, cb: (err: any, data?: ListIntegrationsCommandOutput) => void): void;
301
185
  listIntegrations(args: ListIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIntegrationsCommandOutput) => void): void;
302
186
  /**
303
- * @public
304
- * <p>Returns a list of objects associated with a profile of a given ProfileObjectType.</p>
187
+ * @see {@link ListProfileObjectsCommand}
305
188
  */
306
189
  listProfileObjects(args: ListProfileObjectsCommandInput, options?: __HttpHandlerOptions): Promise<ListProfileObjectsCommandOutput>;
307
190
  listProfileObjects(args: ListProfileObjectsCommandInput, cb: (err: any, data?: ListProfileObjectsCommandOutput) => void): void;
308
191
  listProfileObjects(args: ListProfileObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectsCommandOutput) => void): void;
309
192
  /**
310
- * @public
311
- * <p>Lists all of the templates available within the service.</p>
193
+ * @see {@link ListProfileObjectTypesCommand}
312
194
  */
313
195
  listProfileObjectTypes(args: ListProfileObjectTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListProfileObjectTypesCommandOutput>;
314
196
  listProfileObjectTypes(args: ListProfileObjectTypesCommandInput, cb: (err: any, data?: ListProfileObjectTypesCommandOutput) => void): void;
315
197
  listProfileObjectTypes(args: ListProfileObjectTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectTypesCommandOutput) => void): void;
316
198
  /**
317
- * @public
318
- * <p>Lists all of the template information for object types.</p>
199
+ * @see {@link ListProfileObjectTypeTemplatesCommand}
319
200
  */
320
201
  listProfileObjectTypeTemplates(args: ListProfileObjectTypeTemplatesCommandInput, options?: __HttpHandlerOptions): Promise<ListProfileObjectTypeTemplatesCommandOutput>;
321
202
  listProfileObjectTypeTemplates(args: ListProfileObjectTypeTemplatesCommandInput, cb: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void): void;
322
203
  listProfileObjectTypeTemplates(args: ListProfileObjectTypeTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void): void;
323
204
  /**
324
- * @public
325
- * <p>Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect
326
- * Customer Profiles, domains, profile object types, and integrations can be tagged.</p>
205
+ * @see {@link ListTagsForResourceCommand}
327
206
  */
328
207
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
329
208
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
330
209
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
331
210
  /**
332
- * @public
333
- * <p>Query to list all workflows.</p>
211
+ * @see {@link ListWorkflowsCommand}
334
212
  */
335
213
  listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkflowsCommandOutput>;
336
214
  listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void;
337
215
  listWorkflows(args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void;
338
216
  /**
339
- * @public
340
- * <p>Runs an AWS Lambda job that does the following:</p>
341
- * <ol>
342
- * <li>
343
- * <p>All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the
344
- * main profile.</p>
345
- * </li>
346
- * <li>
347
- * <p>All the objects in the <code>ProfileToBeMerged</code> will be moved to the main
348
- * profile.</p>
349
- * </li>
350
- * <li>
351
- * <p>All the <code>ProfileToBeMerged</code> will be deleted at the end.</p>
352
- * </li>
353
- * <li>
354
- * <p>All the profileKeys in the <code>ProfileIdsToBeMerged</code> will be moved to the
355
- * main profile.</p>
356
- * </li>
357
- * <li>
358
- * <p>Standard fields are merged as follows:</p>
359
- * <ol>
360
- * <li>
361
- * <p>Fields are always "union"-ed if there are no conflicts in standard fields or
362
- * attributeKeys.</p>
363
- * </li>
364
- * <li>
365
- * <p>When there are conflicting fields:</p>
366
- * <ol>
367
- * <li>
368
- * <p>If no <code>SourceProfileIds</code> entry is specified, the main
369
- * Profile value is always taken. </p>
370
- * </li>
371
- * <li>
372
- * <p>If a <code>SourceProfileIds</code> entry is specified, the specified
373
- * profileId is always taken, even if it is a NULL value.</p>
374
- * </li>
375
- * </ol>
376
- * </li>
377
- * </ol>
378
- * </li>
379
- * </ol>
380
- * <p>You can use MergeProfiles together with <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>, which
381
- * returns potentially matching profiles, or use it with the results of another matching
382
- * system. After profiles have been merged, they cannot be separated (unmerged).</p>
217
+ * @see {@link MergeProfilesCommand}
383
218
  */
384
219
  mergeProfiles(args: MergeProfilesCommandInput, options?: __HttpHandlerOptions): Promise<MergeProfilesCommandOutput>;
385
220
  mergeProfiles(args: MergeProfilesCommandInput, cb: (err: any, data?: MergeProfilesCommandOutput) => void): void;
386
221
  mergeProfiles(args: MergeProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeProfilesCommandOutput) => void): void;
387
222
  /**
388
- * @public
389
- * <p>Adds an integration between the service and a third-party service, which includes
390
- * Amazon AppFlow and Amazon Connect.</p>
391
- * <p>An integration can belong to only one domain.</p>
392
- * <p>To add or remove tags on an existing Integration, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource
393
- * </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
394
- * UntagResource</a>.</p>
223
+ * @see {@link PutIntegrationCommand}
395
224
  */
396
225
  putIntegration(args: PutIntegrationCommandInput, options?: __HttpHandlerOptions): Promise<PutIntegrationCommandOutput>;
397
226
  putIntegration(args: PutIntegrationCommandInput, cb: (err: any, data?: PutIntegrationCommandOutput) => void): void;
398
227
  putIntegration(args: PutIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutIntegrationCommandOutput) => void): void;
399
228
  /**
400
- * @public
401
- * <p>Adds additional objects to customer profiles of a given ObjectType.</p>
402
- * <p>When adding a specific profile object, like a Contact Record, an inferred profile can
403
- * get created if it is not mapped to an existing profile. The resulting profile will only
404
- * have a phone number populated in the standard ProfileObject. Any additional Contact Records
405
- * with the same phone number will be mapped to the same inferred profile.</p>
406
- * <p>When a ProfileObject is created and if a ProfileObjectType already exists for the
407
- * ProfileObject, it will provide data to a standard profile depending on the
408
- * ProfileObjectType definition.</p>
409
- * <p>PutProfileObject needs an ObjectType, which can be created using
410
- * PutProfileObjectType.</p>
229
+ * @see {@link PutProfileObjectCommand}
411
230
  */
412
231
  putProfileObject(args: PutProfileObjectCommandInput, options?: __HttpHandlerOptions): Promise<PutProfileObjectCommandOutput>;
413
232
  putProfileObject(args: PutProfileObjectCommandInput, cb: (err: any, data?: PutProfileObjectCommandOutput) => void): void;
414
233
  putProfileObject(args: PutProfileObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProfileObjectCommandOutput) => void): void;
415
234
  /**
416
- * @public
417
- * <p>Defines a ProfileObjectType.</p>
418
- * <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
419
- * TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
235
+ * @see {@link PutProfileObjectTypeCommand}
420
236
  */
421
237
  putProfileObjectType(args: PutProfileObjectTypeCommandInput, options?: __HttpHandlerOptions): Promise<PutProfileObjectTypeCommandOutput>;
422
238
  putProfileObjectType(args: PutProfileObjectTypeCommandInput, cb: (err: any, data?: PutProfileObjectTypeCommandOutput) => void): void;
423
239
  putProfileObjectType(args: PutProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProfileObjectTypeCommandOutput) => void): void;
424
240
  /**
425
- * @public
426
- * <p>Searches for profiles within a specific domain using one or more predefined search keys
427
- * (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key
428
- * is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
429
- * <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to
430
- * 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
241
+ * @see {@link SearchProfilesCommand}
431
242
  */
432
243
  searchProfiles(args: SearchProfilesCommandInput, options?: __HttpHandlerOptions): Promise<SearchProfilesCommandOutput>;
433
244
  searchProfiles(args: SearchProfilesCommandInput, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void;
434
245
  searchProfiles(args: SearchProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void;
435
246
  /**
436
- * @public
437
- * <p>Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles
438
- * resource. Tags can help you organize and categorize your resources. You can also use them
439
- * to scope user permissions by granting a user permission to access or change only resources
440
- * with certain tag values. In Connect Customer Profiles, domains, profile object types, and
441
- * integrations can be tagged.</p>
442
- * <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of
443
- * characters.</p>
444
- * <p>You can use the TagResource action with a resource that already has tags. If you specify
445
- * a new tag key, this tag is appended to the list of tags associated with the resource. If
446
- * you specify a tag key that is already associated with the resource, the new tag value that
447
- * you specify replaces the previous value for that tag.</p>
448
- * <p>You can associate as many as 50 tags with a resource.</p>
247
+ * @see {@link TagResourceCommand}
449
248
  */
450
249
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
451
250
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
452
251
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
453
252
  /**
454
- * @public
455
- * <p>Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect
456
- * Customer Profiles, domains, profile object types, and integrations can be tagged.</p>
253
+ * @see {@link UntagResourceCommand}
457
254
  */
458
255
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
459
256
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
460
257
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
461
258
  /**
462
- * @public
463
- * <p>Updates the properties of a domain, including creating or selecting a dead letter queue
464
- * or an encryption key.</p>
465
- * <p>After a domain is created, the name can’t be changed.</p>
466
- * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to
467
- * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
468
- * resolution</a>: set <code>Matching</code> to true. </p>
469
- * <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
470
- * apply. </p>
471
- * <p>To add or remove tags on an existing Domain, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
259
+ * @see {@link UpdateDomainCommand}
472
260
  */
473
261
  updateDomain(args: UpdateDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDomainCommandOutput>;
474
262
  updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void;
475
263
  updateDomain(args: UpdateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void;
476
264
  /**
477
- * @public
478
- * <p>Updates the properties of a profile. The ProfileId is required for updating a customer
479
- * profile.</p>
480
- * <p>When calling the UpdateProfile API, specifying an empty string value means that any
481
- * existing value will be removed. Not specifying a string value means that any value already
482
- * there will be kept.</p>
265
+ * @see {@link UpdateProfileCommand}
483
266
  */
484
267
  updateProfile(args: UpdateProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateProfileCommandOutput>;
485
268
  updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void;
486
269
  updateProfile(args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void;
487
270
  }
271
+ /**
272
+ * @public
273
+ * <fullname>Amazon Connect Customer Profiles</fullname>
274
+ * <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
275
+ * pre-built connectors powered by AppFlow that make it easy to combine customer information
276
+ * from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
277
+ * enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
278
+ * If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
279
+ */
280
+ export declare class CustomerProfiles extends CustomerProfilesClient implements CustomerProfiles {
281
+ }
@@ -152,7 +152,7 @@ import {
152
152
  UpdateProfileCommandOutput,
153
153
  } from "./commands/UpdateProfileCommand";
154
154
  import { CustomerProfilesClient } from "./CustomerProfilesClient";
155
- export declare class CustomerProfiles extends CustomerProfilesClient {
155
+ export interface CustomerProfiles {
156
156
  addProfileKey(
157
157
  args: AddProfileKeyCommandInput,
158
158
  options?: __HttpHandlerOptions
@@ -648,3 +648,6 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
648
648
  cb: (err: any, data?: UpdateProfileCommandOutput) => void
649
649
  ): void;
650
650
  }
651
+ export declare class CustomerProfiles
652
+ extends CustomerProfilesClient
653
+ implements CustomerProfiles {}
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.315.0",
4
+ "version": "3.316.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",