@aws-sdk/client-customer-profiles 3.41.0 → 3.46.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 (40) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/CustomerProfiles.js +45 -0
  3. package/dist-cjs/commands/GetAutoMergingPreviewCommand.js +36 -0
  4. package/dist-cjs/commands/GetIdentityResolutionJobCommand.js +36 -0
  5. package/dist-cjs/commands/ListIdentityResolutionJobsCommand.js +36 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoints.js +1 -0
  8. package/dist-cjs/models/models_0.js +125 -3
  9. package/dist-cjs/protocols/Aws_restJson1.js +658 -2
  10. package/dist-cjs/runtimeConfig.js +0 -2
  11. package/dist-es/CustomerProfiles.js +45 -0
  12. package/dist-es/commands/GetAutoMergingPreviewCommand.js +39 -0
  13. package/dist-es/commands/GetIdentityResolutionJobCommand.js +39 -0
  14. package/dist-es/commands/ListIdentityResolutionJobsCommand.js +39 -0
  15. package/dist-es/commands/index.js +3 -0
  16. package/dist-es/endpoints.js +1 -0
  17. package/dist-es/models/models_0.js +90 -0
  18. package/dist-es/protocols/Aws_restJson1.js +689 -6
  19. package/dist-es/runtimeConfig.js +0 -2
  20. package/dist-types/CustomerProfiles.d.ts +50 -6
  21. package/dist-types/CustomerProfilesClient.d.ts +5 -2
  22. package/dist-types/commands/CreateDomainCommand.d.ts +2 -0
  23. package/dist-types/commands/GetAutoMergingPreviewCommand.d.ts +48 -0
  24. package/dist-types/commands/GetIdentityResolutionJobCommand.d.ts +37 -0
  25. package/dist-types/commands/GetMatchesCommand.d.ts +8 -4
  26. package/dist-types/commands/ListIdentityResolutionJobsCommand.d.ts +36 -0
  27. package/dist-types/commands/MergeProfilesCommand.d.ts +1 -2
  28. package/dist-types/commands/UpdateDomainCommand.d.ts +2 -0
  29. package/dist-types/commands/index.d.ts +3 -0
  30. package/dist-types/models/models_0.d.ts +616 -35
  31. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  32. package/dist-types/ts3.4/CustomerProfiles.d.ts +15 -0
  33. package/dist-types/ts3.4/CustomerProfilesClient.d.ts +5 -2
  34. package/dist-types/ts3.4/commands/GetAutoMergingPreviewCommand.d.ts +17 -0
  35. package/dist-types/ts3.4/commands/GetIdentityResolutionJobCommand.d.ts +17 -0
  36. package/dist-types/ts3.4/commands/ListIdentityResolutionJobsCommand.d.ts +17 -0
  37. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  38. package/dist-types/ts3.4/models/models_0.d.ts +271 -4
  39. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +9 -0
  40. package/package.json +36 -43
@@ -12,10 +12,8 @@ import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
12
12
  import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
13
13
  import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
14
14
  import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
15
- import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
16
15
  export var getRuntimeConfig = function (config) {
17
16
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
18
- emitWarningIfUnsupportedVersion(process.version);
19
17
  var clientSharedValues = getSharedRuntimeConfig(config);
20
18
  return __assign(__assign(__assign({}, clientSharedValues), config), { runtime: "node", base64Decoder: (_a = config === null || config === void 0 ? void 0 : config.base64Decoder) !== null && _a !== void 0 ? _a : fromBase64, base64Encoder: (_b = config === null || config === void 0 ? void 0 : config.base64Encoder) !== null && _b !== void 0 ? _b : toBase64, bodyLengthChecker: (_c = config === null || config === void 0 ? void 0 : config.bodyLengthChecker) !== null && _c !== void 0 ? _c : calculateBodyLength, credentialDefaultProvider: (_d = config === null || config === void 0 ? void 0 : config.credentialDefaultProvider) !== null && _d !== void 0 ? _d : decorateDefaultCredentialProvider(credentialDefaultProvider), defaultUserAgentProvider: (_e = config === null || config === void 0 ? void 0 : config.defaultUserAgentProvider) !== null && _e !== void 0 ? _e : defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }), maxAttempts: (_f = config === null || config === void 0 ? void 0 : config.maxAttempts) !== null && _f !== void 0 ? _f : loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS), region: (_g = config === null || config === void 0 ? void 0 : config.region) !== null && _g !== void 0 ? _g : loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS), requestHandler: (_h = config === null || config === void 0 ? void 0 : config.requestHandler) !== null && _h !== void 0 ? _h : new NodeHttpHandler(), retryMode: (_j = config === null || config === void 0 ? void 0 : config.retryMode) !== null && _j !== void 0 ? _j : loadNodeConfig(NODE_RETRY_MODE_CONFIG_OPTIONS), sha256: (_k = config === null || config === void 0 ? void 0 : config.sha256) !== null && _k !== void 0 ? _k : Hash.bind(null, "sha256"), streamCollector: (_l = config === null || config === void 0 ? void 0 : config.streamCollector) !== null && _l !== void 0 ? _l : streamCollector, useDualstackEndpoint: (_m = config === null || config === void 0 ? void 0 : config.useDualstackEndpoint) !== null && _m !== void 0 ? _m : loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS), useFipsEndpoint: (_o = config === null || config === void 0 ? void 0 : config.useFipsEndpoint) !== null && _o !== void 0 ? _o : loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS), utf8Decoder: (_p = config === null || config === void 0 ? void 0 : config.utf8Decoder) !== null && _p !== void 0 ? _p : fromUtf8, utf8Encoder: (_q = config === null || config === void 0 ? void 0 : config.utf8Encoder) !== null && _q !== void 0 ? _q : toUtf8 });
21
19
  };
@@ -8,13 +8,16 @@ import { DeleteProfileCommandInput, DeleteProfileCommandOutput } from "./command
8
8
  import { DeleteProfileKeyCommandInput, DeleteProfileKeyCommandOutput } from "./commands/DeleteProfileKeyCommand";
9
9
  import { DeleteProfileObjectCommandInput, DeleteProfileObjectCommandOutput } from "./commands/DeleteProfileObjectCommand";
10
10
  import { DeleteProfileObjectTypeCommandInput, DeleteProfileObjectTypeCommandOutput } from "./commands/DeleteProfileObjectTypeCommand";
11
+ import { GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput } from "./commands/GetAutoMergingPreviewCommand";
11
12
  import { GetDomainCommandInput, GetDomainCommandOutput } from "./commands/GetDomainCommand";
13
+ import { GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput } from "./commands/GetIdentityResolutionJobCommand";
12
14
  import { GetIntegrationCommandInput, GetIntegrationCommandOutput } from "./commands/GetIntegrationCommand";
13
15
  import { GetMatchesCommandInput, GetMatchesCommandOutput } from "./commands/GetMatchesCommand";
14
16
  import { GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput } from "./commands/GetProfileObjectTypeCommand";
15
17
  import { GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput } from "./commands/GetProfileObjectTypeTemplateCommand";
16
18
  import { ListAccountIntegrationsCommandInput, ListAccountIntegrationsCommandOutput } from "./commands/ListAccountIntegrationsCommand";
17
19
  import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
20
+ import { ListIdentityResolutionJobsCommandInput, ListIdentityResolutionJobsCommandOutput } from "./commands/ListIdentityResolutionJobsCommand";
18
21
  import { ListIntegrationsCommandInput, ListIntegrationsCommandOutput } from "./commands/ListIntegrationsCommand";
19
22
  import { ListProfileObjectsCommandInput, ListProfileObjectsCommandOutput } from "./commands/ListProfileObjectsCommand";
20
23
  import { ListProfileObjectTypesCommandInput, ListProfileObjectTypesCommandOutput } from "./commands/ListProfileObjectTypesCommand";
@@ -61,6 +64,8 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
61
64
  * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
62
65
  * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
63
66
  * resolution</a>: set <code>Matching</code> to true. </p>
67
+ * <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
68
+ * apply. </p>
64
69
  */
65
70
  createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise<CreateDomainCommandOutput>;
66
71
  createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
@@ -113,12 +118,39 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
113
118
  deleteProfileObjectType(args: DeleteProfileObjectTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProfileObjectTypeCommandOutput>;
114
119
  deleteProfileObjectType(args: DeleteProfileObjectTypeCommandInput, cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void): void;
115
120
  deleteProfileObjectType(args: DeleteProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void): void;
121
+ /**
122
+ * <p>Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly
123
+ * selects a sample of matching groups from the existing matching results, and applies the
124
+ * automerging settings that you provided. You can then view the number of profiles in the
125
+ * sample, the number of matches, and the number of profiles identified to be merged. This
126
+ * enables you to evaluate the accuracy of the attributes in your matching list. </p>
127
+ * <p>You can't view which profiles are matched and would be merged.</p>
128
+ * <important>
129
+ *
130
+ * <p>We strongly recommend you use this API to do a dry run of the automerging process
131
+ * before running the Identity Resolution Job. Include <b>at least</b> two matching
132
+ * attributes. If your matching list includes too few attributes (such as only
133
+ * <code>FirstName</code> or only <code>LastName</code>), there may be a large number of
134
+ * matches. This increases the chances of erroneous merges.</p>
135
+ * </important>
136
+ */
137
+ getAutoMergingPreview(args: GetAutoMergingPreviewCommandInput, options?: __HttpHandlerOptions): Promise<GetAutoMergingPreviewCommandOutput>;
138
+ getAutoMergingPreview(args: GetAutoMergingPreviewCommandInput, cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void): void;
139
+ getAutoMergingPreview(args: GetAutoMergingPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void): void;
116
140
  /**
117
141
  * <p>Returns information about a specific domain.</p>
118
142
  */
119
143
  getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise<GetDomainCommandOutput>;
120
144
  getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
121
145
  getDomain(args: GetDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
146
+ /**
147
+ * <p>Returns information about an Identity Resolution Job in a specific domain. </p>
148
+ * <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
149
+ * Identity Resolution to consolidate similar profiles</a>.</p>
150
+ */
151
+ getIdentityResolutionJob(args: GetIdentityResolutionJobCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityResolutionJobCommandOutput>;
152
+ getIdentityResolutionJob(args: GetIdentityResolutionJobCommandInput, cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void): void;
153
+ getIdentityResolutionJob(args: GetIdentityResolutionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void): void;
122
154
  /**
123
155
  * <p>Returns an integration for a domain.</p>
124
156
  */
@@ -126,15 +158,19 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
126
158
  getIntegration(args: GetIntegrationCommandInput, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void;
127
159
  getIntegration(args: GetIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void;
128
160
  /**
129
- * <p>This API is in preview release for Amazon Connect and subject to change.</p>
130
- * <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
161
+ * <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
131
162
  * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
132
163
  * enable identity resolution: set <code>Matching</code> to true.</p>
133
164
  * <p>GetMatches returns potentially matching profiles, based on the results of the latest run
134
165
  * of a machine learning process. </p>
135
166
  * <important>
136
- * <p>Amazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles.
137
- * The results are returned up to seven days after the Saturday run.</p>
167
+ * <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
168
+ * 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
169
+ * Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
170
+ * <p>After the Identity Resolution Job completes, use the
171
+ * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
172
+ * 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
173
+ * S3.</p>
138
174
  * </important>
139
175
  *
140
176
  * <p>Amazon Connect uses the following profile attributes to identify matches:</p>
@@ -203,6 +239,13 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
203
239
  listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
204
240
  listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
205
241
  listDomains(args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
242
+ /**
243
+ * <p>Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
244
+ * <code>JobStartTime</code>.</p>
245
+ */
246
+ listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListIdentityResolutionJobsCommandOutput>;
247
+ listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void): void;
248
+ listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void): void;
206
249
  /**
207
250
  * <p>Lists all of the integrations in your domain.</p>
208
251
  */
@@ -235,8 +278,7 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
235
278
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
236
279
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
237
280
  /**
238
- * <p>This API is in preview release for Amazon Connect and subject to change.</p>
239
- * <p>Runs an AWS Lambda job that does the following:</p>
281
+ * <p>Runs an AWS Lambda job that does the following:</p>
240
282
  * <ol>
241
283
  * <li>
242
284
  * <p>All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the
@@ -351,6 +393,8 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
351
393
  * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to
352
394
  * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
353
395
  * resolution</a>: set <code>Matching</code> to true. </p>
396
+ * <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
397
+ * apply. </p>
354
398
  */
355
399
  updateDomain(args: UpdateDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDomainCommandOutput>;
356
400
  updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void;
@@ -15,13 +15,16 @@ import { DeleteProfileCommandInput, DeleteProfileCommandOutput } from "./command
15
15
  import { DeleteProfileKeyCommandInput, DeleteProfileKeyCommandOutput } from "./commands/DeleteProfileKeyCommand";
16
16
  import { DeleteProfileObjectCommandInput, DeleteProfileObjectCommandOutput } from "./commands/DeleteProfileObjectCommand";
17
17
  import { DeleteProfileObjectTypeCommandInput, DeleteProfileObjectTypeCommandOutput } from "./commands/DeleteProfileObjectTypeCommand";
18
+ import { GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput } from "./commands/GetAutoMergingPreviewCommand";
18
19
  import { GetDomainCommandInput, GetDomainCommandOutput } from "./commands/GetDomainCommand";
20
+ import { GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput } from "./commands/GetIdentityResolutionJobCommand";
19
21
  import { GetIntegrationCommandInput, GetIntegrationCommandOutput } from "./commands/GetIntegrationCommand";
20
22
  import { GetMatchesCommandInput, GetMatchesCommandOutput } from "./commands/GetMatchesCommand";
21
23
  import { GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput } from "./commands/GetProfileObjectTypeCommand";
22
24
  import { GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput } from "./commands/GetProfileObjectTypeTemplateCommand";
23
25
  import { ListAccountIntegrationsCommandInput, ListAccountIntegrationsCommandOutput } from "./commands/ListAccountIntegrationsCommand";
24
26
  import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
27
+ import { ListIdentityResolutionJobsCommandInput, ListIdentityResolutionJobsCommandOutput } from "./commands/ListIdentityResolutionJobsCommand";
25
28
  import { ListIntegrationsCommandInput, ListIntegrationsCommandOutput } from "./commands/ListIntegrationsCommand";
26
29
  import { ListProfileObjectsCommandInput, ListProfileObjectsCommandOutput } from "./commands/ListProfileObjectsCommand";
27
30
  import { ListProfileObjectTypesCommandInput, ListProfileObjectTypesCommandOutput } from "./commands/ListProfileObjectTypesCommand";
@@ -36,8 +39,8 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
36
39
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
37
40
  import { UpdateDomainCommandInput, UpdateDomainCommandOutput } from "./commands/UpdateDomainCommand";
38
41
  import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./commands/UpdateProfileCommand";
39
- export declare type ServiceInputTypes = AddProfileKeyCommandInput | CreateDomainCommandInput | CreateProfileCommandInput | DeleteDomainCommandInput | DeleteIntegrationCommandInput | DeleteProfileCommandInput | DeleteProfileKeyCommandInput | DeleteProfileObjectCommandInput | DeleteProfileObjectTypeCommandInput | GetDomainCommandInput | GetIntegrationCommandInput | GetMatchesCommandInput | GetProfileObjectTypeCommandInput | GetProfileObjectTypeTemplateCommandInput | ListAccountIntegrationsCommandInput | ListDomainsCommandInput | ListIntegrationsCommandInput | ListProfileObjectTypeTemplatesCommandInput | ListProfileObjectTypesCommandInput | ListProfileObjectsCommandInput | ListTagsForResourceCommandInput | MergeProfilesCommandInput | PutIntegrationCommandInput | PutProfileObjectCommandInput | PutProfileObjectTypeCommandInput | SearchProfilesCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDomainCommandInput | UpdateProfileCommandInput;
40
- export declare type ServiceOutputTypes = AddProfileKeyCommandOutput | CreateDomainCommandOutput | CreateProfileCommandOutput | DeleteDomainCommandOutput | DeleteIntegrationCommandOutput | DeleteProfileCommandOutput | DeleteProfileKeyCommandOutput | DeleteProfileObjectCommandOutput | DeleteProfileObjectTypeCommandOutput | GetDomainCommandOutput | GetIntegrationCommandOutput | GetMatchesCommandOutput | GetProfileObjectTypeCommandOutput | GetProfileObjectTypeTemplateCommandOutput | ListAccountIntegrationsCommandOutput | ListDomainsCommandOutput | ListIntegrationsCommandOutput | ListProfileObjectTypeTemplatesCommandOutput | ListProfileObjectTypesCommandOutput | ListProfileObjectsCommandOutput | ListTagsForResourceCommandOutput | MergeProfilesCommandOutput | PutIntegrationCommandOutput | PutProfileObjectCommandOutput | PutProfileObjectTypeCommandOutput | SearchProfilesCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDomainCommandOutput | UpdateProfileCommandOutput;
42
+ export declare type ServiceInputTypes = AddProfileKeyCommandInput | CreateDomainCommandInput | CreateProfileCommandInput | DeleteDomainCommandInput | DeleteIntegrationCommandInput | DeleteProfileCommandInput | DeleteProfileKeyCommandInput | DeleteProfileObjectCommandInput | DeleteProfileObjectTypeCommandInput | GetAutoMergingPreviewCommandInput | GetDomainCommandInput | GetIdentityResolutionJobCommandInput | GetIntegrationCommandInput | GetMatchesCommandInput | GetProfileObjectTypeCommandInput | GetProfileObjectTypeTemplateCommandInput | ListAccountIntegrationsCommandInput | ListDomainsCommandInput | ListIdentityResolutionJobsCommandInput | ListIntegrationsCommandInput | ListProfileObjectTypeTemplatesCommandInput | ListProfileObjectTypesCommandInput | ListProfileObjectsCommandInput | ListTagsForResourceCommandInput | MergeProfilesCommandInput | PutIntegrationCommandInput | PutProfileObjectCommandInput | PutProfileObjectTypeCommandInput | SearchProfilesCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDomainCommandInput | UpdateProfileCommandInput;
43
+ export declare type ServiceOutputTypes = AddProfileKeyCommandOutput | CreateDomainCommandOutput | CreateProfileCommandOutput | DeleteDomainCommandOutput | DeleteIntegrationCommandOutput | DeleteProfileCommandOutput | DeleteProfileKeyCommandOutput | DeleteProfileObjectCommandOutput | DeleteProfileObjectTypeCommandOutput | GetAutoMergingPreviewCommandOutput | GetDomainCommandOutput | GetIdentityResolutionJobCommandOutput | GetIntegrationCommandOutput | GetMatchesCommandOutput | GetProfileObjectTypeCommandOutput | GetProfileObjectTypeTemplateCommandOutput | ListAccountIntegrationsCommandOutput | ListDomainsCommandOutput | ListIdentityResolutionJobsCommandOutput | ListIntegrationsCommandOutput | ListProfileObjectTypeTemplatesCommandOutput | ListProfileObjectTypesCommandOutput | ListProfileObjectsCommandOutput | ListTagsForResourceCommandOutput | MergeProfilesCommandOutput | PutIntegrationCommandOutput | PutProfileObjectCommandOutput | PutProfileObjectTypeCommandOutput | SearchProfilesCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDomainCommandOutput | UpdateProfileCommandOutput;
41
44
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
42
45
  /**
43
46
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -15,6 +15,8 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
15
15
  * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
16
16
  * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
17
17
  * resolution</a>: set <code>Matching</code> to true. </p>
18
+ * <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
19
+ * apply. </p>
18
20
  * @example
19
21
  * Use a bare-bones client and the command you need to make an API call.
20
22
  * ```javascript
@@ -0,0 +1,48 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
4
+ import { GetAutoMergingPreviewRequest, GetAutoMergingPreviewResponse } from "../models/models_0";
5
+ export interface GetAutoMergingPreviewCommandInput extends GetAutoMergingPreviewRequest {
6
+ }
7
+ export interface GetAutoMergingPreviewCommandOutput extends GetAutoMergingPreviewResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly
11
+ * selects a sample of matching groups from the existing matching results, and applies the
12
+ * automerging settings that you provided. You can then view the number of profiles in the
13
+ * sample, the number of matches, and the number of profiles identified to be merged. This
14
+ * enables you to evaluate the accuracy of the attributes in your matching list. </p>
15
+ * <p>You can't view which profiles are matched and would be merged.</p>
16
+ * <important>
17
+ *
18
+ * <p>We strongly recommend you use this API to do a dry run of the automerging process
19
+ * before running the Identity Resolution Job. Include <b>at least</b> two matching
20
+ * attributes. If your matching list includes too few attributes (such as only
21
+ * <code>FirstName</code> or only <code>LastName</code>), there may be a large number of
22
+ * matches. This increases the chances of erroneous merges.</p>
23
+ * </important>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { CustomerProfilesClient, GetAutoMergingPreviewCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
28
+ * // const { CustomerProfilesClient, GetAutoMergingPreviewCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
29
+ * const client = new CustomerProfilesClient(config);
30
+ * const command = new GetAutoMergingPreviewCommand(input);
31
+ * const response = await client.send(command);
32
+ * ```
33
+ *
34
+ * @see {@link GetAutoMergingPreviewCommandInput} for command's `input` shape.
35
+ * @see {@link GetAutoMergingPreviewCommandOutput} for command's `response` shape.
36
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
37
+ *
38
+ */
39
+ export declare class GetAutoMergingPreviewCommand extends $Command<GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput, CustomerProfilesClientResolvedConfig> {
40
+ readonly input: GetAutoMergingPreviewCommandInput;
41
+ constructor(input: GetAutoMergingPreviewCommandInput);
42
+ /**
43
+ * @internal
44
+ */
45
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput>;
46
+ private serialize;
47
+ private deserialize;
48
+ }
@@ -0,0 +1,37 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
4
+ import { GetIdentityResolutionJobRequest, GetIdentityResolutionJobResponse } from "../models/models_0";
5
+ export interface GetIdentityResolutionJobCommandInput extends GetIdentityResolutionJobRequest {
6
+ }
7
+ export interface GetIdentityResolutionJobCommandOutput extends GetIdentityResolutionJobResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Returns information about an Identity Resolution Job in a specific domain. </p>
11
+ * <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
12
+ * Identity Resolution to consolidate similar profiles</a>.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { CustomerProfilesClient, GetIdentityResolutionJobCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
17
+ * // const { CustomerProfilesClient, GetIdentityResolutionJobCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
18
+ * const client = new CustomerProfilesClient(config);
19
+ * const command = new GetIdentityResolutionJobCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link GetIdentityResolutionJobCommandInput} for command's `input` shape.
24
+ * @see {@link GetIdentityResolutionJobCommandOutput} for command's `response` shape.
25
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class GetIdentityResolutionJobCommand extends $Command<GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput, CustomerProfilesClientResolvedConfig> {
29
+ readonly input: GetIdentityResolutionJobCommandInput;
30
+ constructor(input: GetIdentityResolutionJobCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -7,15 +7,19 @@ export interface GetMatchesCommandInput extends GetMatchesRequest {
7
7
  export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>This API is in preview release for Amazon Connect and subject to change.</p>
11
- * <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
10
+ * <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
12
11
  * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
13
12
  * enable identity resolution: set <code>Matching</code> to true.</p>
14
13
  * <p>GetMatches returns potentially matching profiles, based on the results of the latest run
15
14
  * of a machine learning process. </p>
16
15
  * <important>
17
- * <p>Amazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles.
18
- * The results are returned up to seven days after the Saturday run.</p>
16
+ * <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
17
+ * 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
18
+ * Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
19
+ * <p>After the Identity Resolution Job completes, use the
20
+ * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
21
+ * 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
22
+ * S3.</p>
19
23
  * </important>
20
24
  *
21
25
  * <p>Amazon Connect uses the following profile attributes to identify matches:</p>
@@ -0,0 +1,36 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
4
+ import { ListIdentityResolutionJobsRequest, ListIdentityResolutionJobsResponse } from "../models/models_0";
5
+ export interface ListIdentityResolutionJobsCommandInput extends ListIdentityResolutionJobsRequest {
6
+ }
7
+ export interface ListIdentityResolutionJobsCommandOutput extends ListIdentityResolutionJobsResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
11
+ * <code>JobStartTime</code>.</p>
12
+ * @example
13
+ * Use a bare-bones client and the command you need to make an API call.
14
+ * ```javascript
15
+ * import { CustomerProfilesClient, ListIdentityResolutionJobsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
16
+ * // const { CustomerProfilesClient, ListIdentityResolutionJobsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
17
+ * const client = new CustomerProfilesClient(config);
18
+ * const command = new ListIdentityResolutionJobsCommand(input);
19
+ * const response = await client.send(command);
20
+ * ```
21
+ *
22
+ * @see {@link ListIdentityResolutionJobsCommandInput} for command's `input` shape.
23
+ * @see {@link ListIdentityResolutionJobsCommandOutput} for command's `response` shape.
24
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
25
+ *
26
+ */
27
+ export declare class ListIdentityResolutionJobsCommand extends $Command<ListIdentityResolutionJobsCommandInput, ListIdentityResolutionJobsCommandOutput, CustomerProfilesClientResolvedConfig> {
28
+ readonly input: ListIdentityResolutionJobsCommandInput;
29
+ constructor(input: ListIdentityResolutionJobsCommandInput);
30
+ /**
31
+ * @internal
32
+ */
33
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListIdentityResolutionJobsCommandInput, ListIdentityResolutionJobsCommandOutput>;
34
+ private serialize;
35
+ private deserialize;
36
+ }
@@ -7,8 +7,7 @@ export interface MergeProfilesCommandInput extends MergeProfilesRequest {
7
7
  export interface MergeProfilesCommandOutput extends MergeProfilesResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>This API is in preview release for Amazon Connect and subject to change.</p>
11
- * <p>Runs an AWS Lambda job that does the following:</p>
10
+ * <p>Runs an AWS Lambda job that does the following:</p>
12
11
  * <ol>
13
12
  * <li>
14
13
  * <p>All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the
@@ -13,6 +13,8 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
13
13
  * <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to
14
14
  * enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
15
15
  * resolution</a>: set <code>Matching</code> to true. </p>
16
+ * <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
17
+ * apply. </p>
16
18
  * @example
17
19
  * Use a bare-bones client and the command you need to make an API call.
18
20
  * ```javascript
@@ -7,13 +7,16 @@ export * from "./DeleteProfileCommand";
7
7
  export * from "./DeleteProfileKeyCommand";
8
8
  export * from "./DeleteProfileObjectCommand";
9
9
  export * from "./DeleteProfileObjectTypeCommand";
10
+ export * from "./GetAutoMergingPreviewCommand";
10
11
  export * from "./GetDomainCommand";
12
+ export * from "./GetIdentityResolutionJobCommand";
11
13
  export * from "./GetIntegrationCommand";
12
14
  export * from "./GetMatchesCommand";
13
15
  export * from "./GetProfileObjectTypeCommand";
14
16
  export * from "./GetProfileObjectTypeTemplateCommand";
15
17
  export * from "./ListAccountIntegrationsCommand";
16
18
  export * from "./ListDomainsCommand";
19
+ export * from "./ListIdentityResolutionJobsCommand";
17
20
  export * from "./ListIntegrationsCommand";
18
21
  export * from "./ListProfileObjectTypeTemplatesCommand";
19
22
  export * from "./ListProfileObjectTypesCommand";