@aws-sdk/client-customer-profiles 3.42.0 → 3.43.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/CHANGELOG.md +11 -0
- package/dist-cjs/CustomerProfiles.js +45 -0
- package/dist-cjs/commands/GetAutoMergingPreviewCommand.js +36 -0
- package/dist-cjs/commands/GetIdentityResolutionJobCommand.js +36 -0
- package/dist-cjs/commands/ListIdentityResolutionJobsCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +124 -3
- package/dist-cjs/protocols/Aws_restJson1.js +621 -2
- package/dist-es/CustomerProfiles.js +45 -0
- package/dist-es/commands/GetAutoMergingPreviewCommand.js +39 -0
- package/dist-es/commands/GetIdentityResolutionJobCommand.js +39 -0
- package/dist-es/commands/ListIdentityResolutionJobsCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +89 -0
- package/dist-es/protocols/Aws_restJson1.js +653 -4
- package/dist-types/CustomerProfiles.d.ts +48 -2
- package/dist-types/CustomerProfilesClient.d.ts +5 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -0
- package/dist-types/commands/GetAutoMergingPreviewCommand.d.ts +48 -0
- package/dist-types/commands/GetIdentityResolutionJobCommand.d.ts +37 -0
- package/dist-types/commands/GetMatchesCommand.d.ts +7 -2
- package/dist-types/commands/ListIdentityResolutionJobsCommand.d.ts +36 -0
- package/dist-types/commands/UpdateDomainCommand.d.ts +2 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +573 -28
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +15 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +5 -2
- package/dist-types/ts3.4/commands/GetAutoMergingPreviewCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetIdentityResolutionJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListIdentityResolutionJobsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +250 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +9 -0
- package/package.json +2 -2
|
@@ -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
|
*/
|
|
@@ -133,8 +165,13 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
|
|
|
133
165
|
* <p>GetMatches returns potentially matching profiles, based on the results of the latest run
|
|
134
166
|
* of a machine learning process. </p>
|
|
135
167
|
* <important>
|
|
136
|
-
* <p>
|
|
137
|
-
*
|
|
168
|
+
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
169
|
+
* 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
|
|
170
|
+
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
171
|
+
* <p>After the Identity Resolution Job completes, use the
|
|
172
|
+
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
173
|
+
* 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
|
|
174
|
+
* S3.</p>
|
|
138
175
|
* </important>
|
|
139
176
|
*
|
|
140
177
|
* <p>Amazon Connect uses the following profile attributes to identify matches:</p>
|
|
@@ -203,6 +240,13 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
|
|
|
203
240
|
listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
|
|
204
241
|
listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
|
|
205
242
|
listDomains(args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
|
|
243
|
+
/**
|
|
244
|
+
* <p>Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
|
|
245
|
+
* <code>JobStartTime</code>.</p>
|
|
246
|
+
*/
|
|
247
|
+
listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListIdentityResolutionJobsCommandOutput>;
|
|
248
|
+
listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void): void;
|
|
249
|
+
listIdentityResolutionJobs(args: ListIdentityResolutionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void): void;
|
|
206
250
|
/**
|
|
207
251
|
* <p>Lists all of the integrations in your domain.</p>
|
|
208
252
|
*/
|
|
@@ -351,6 +395,8 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
|
|
|
351
395
|
* <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to
|
|
352
396
|
* enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
|
|
353
397
|
* resolution</a>: set <code>Matching</code> to true. </p>
|
|
398
|
+
* <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
|
|
399
|
+
* apply. </p>
|
|
354
400
|
*/
|
|
355
401
|
updateDomain(args: UpdateDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDomainCommandOutput>;
|
|
356
402
|
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
|
+
}
|
|
@@ -14,8 +14,13 @@ export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataB
|
|
|
14
14
|
* <p>GetMatches returns potentially matching profiles, based on the results of the latest run
|
|
15
15
|
* of a machine learning process. </p>
|
|
16
16
|
* <important>
|
|
17
|
-
* <p>
|
|
18
|
-
*
|
|
17
|
+
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
18
|
+
* 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
|
|
19
|
+
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
20
|
+
* <p>After the Identity Resolution Job completes, use the
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
22
|
+
* 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
|
|
23
|
+
* S3.</p>
|
|
19
24
|
* </important>
|
|
20
25
|
*
|
|
21
26
|
* <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
|
+
}
|
|
@@ -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";
|