@aws-sdk/client-customer-profiles 3.370.0 → 3.378.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist-cjs/CustomerProfiles.js +4 -0
- package/dist-cjs/commands/GetSimilarProfilesCommand.js +46 -0
- package/dist-cjs/commands/ListRuleBasedMatchesCommand.js +46 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +14 -1
- package/dist-cjs/protocols/Aws_restJson1.js +158 -2
- package/dist-es/CustomerProfiles.js +4 -0
- package/dist-es/commands/GetSimilarProfilesCommand.js +42 -0
- package/dist-es/commands/ListRuleBasedMatchesCommand.js +42 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/protocols/Aws_restJson1.js +151 -0
- package/dist-types/CustomerProfiles.d.ts +14 -0
- package/dist-types/CustomerProfilesClient.d.ts +4 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +70 -1
- package/dist-types/commands/GetDomainCommand.d.ts +35 -0
- package/dist-types/commands/GetSimilarProfilesCommand.d.ts +102 -0
- package/dist-types/commands/ListRuleBasedMatchesCommand.d.ts +93 -0
- package/dist-types/commands/UpdateDomainCommand.d.ts +70 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +444 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +34 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetSimilarProfilesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListRuleBasedMatchesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +76 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +35 -35
|
@@ -66,6 +66,7 @@ export const se_CreateDomainCommand = async (input, context) => {
|
|
|
66
66
|
DefaultEncryptionKey: [],
|
|
67
67
|
DefaultExpirationDays: [],
|
|
68
68
|
Matching: (_) => se_MatchingRequest(_, context),
|
|
69
|
+
RuleBasedMatching: (_) => _json(_),
|
|
69
70
|
Tags: (_) => _json(_),
|
|
70
71
|
}));
|
|
71
72
|
return new __HttpRequest({
|
|
@@ -538,6 +539,34 @@ export const se_GetProfileObjectTypeTemplateCommand = async (input, context) =>
|
|
|
538
539
|
body,
|
|
539
540
|
});
|
|
540
541
|
};
|
|
542
|
+
export const se_GetSimilarProfilesCommand = async (input, context) => {
|
|
543
|
+
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
544
|
+
const headers = {
|
|
545
|
+
"content-type": "application/json",
|
|
546
|
+
};
|
|
547
|
+
let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/domains/{DomainName}/matches";
|
|
548
|
+
resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName, "{DomainName}", false);
|
|
549
|
+
const query = map({
|
|
550
|
+
"next-token": [, input.NextToken],
|
|
551
|
+
"max-results": [() => input.MaxResults !== void 0, () => input.MaxResults.toString()],
|
|
552
|
+
});
|
|
553
|
+
let body;
|
|
554
|
+
body = JSON.stringify(take(input, {
|
|
555
|
+
MatchType: [],
|
|
556
|
+
SearchKey: [],
|
|
557
|
+
SearchValue: [],
|
|
558
|
+
}));
|
|
559
|
+
return new __HttpRequest({
|
|
560
|
+
protocol,
|
|
561
|
+
hostname,
|
|
562
|
+
port,
|
|
563
|
+
method: "POST",
|
|
564
|
+
headers,
|
|
565
|
+
path: resolvedPath,
|
|
566
|
+
query,
|
|
567
|
+
body,
|
|
568
|
+
});
|
|
569
|
+
};
|
|
541
570
|
export const se_GetWorkflowCommand = async (input, context) => {
|
|
542
571
|
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
543
572
|
const headers = {};
|
|
@@ -804,6 +833,28 @@ export const se_ListProfileObjectTypeTemplatesCommand = async (input, context) =
|
|
|
804
833
|
body,
|
|
805
834
|
});
|
|
806
835
|
};
|
|
836
|
+
export const se_ListRuleBasedMatchesCommand = async (input, context) => {
|
|
837
|
+
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
838
|
+
const headers = {};
|
|
839
|
+
let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` +
|
|
840
|
+
"/domains/{DomainName}/profiles/ruleBasedMatches";
|
|
841
|
+
resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName, "{DomainName}", false);
|
|
842
|
+
const query = map({
|
|
843
|
+
"next-token": [, input.NextToken],
|
|
844
|
+
"max-results": [() => input.MaxResults !== void 0, () => input.MaxResults.toString()],
|
|
845
|
+
});
|
|
846
|
+
let body;
|
|
847
|
+
return new __HttpRequest({
|
|
848
|
+
protocol,
|
|
849
|
+
hostname,
|
|
850
|
+
port,
|
|
851
|
+
method: "GET",
|
|
852
|
+
headers,
|
|
853
|
+
path: resolvedPath,
|
|
854
|
+
query,
|
|
855
|
+
body,
|
|
856
|
+
});
|
|
857
|
+
};
|
|
807
858
|
export const se_ListTagsForResourceCommand = async (input, context) => {
|
|
808
859
|
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
809
860
|
const headers = {};
|
|
@@ -1062,6 +1113,7 @@ export const se_UpdateDomainCommand = async (input, context) => {
|
|
|
1062
1113
|
DefaultEncryptionKey: [],
|
|
1063
1114
|
DefaultExpirationDays: [],
|
|
1064
1115
|
Matching: (_) => se_MatchingRequest(_, context),
|
|
1116
|
+
RuleBasedMatching: (_) => _json(_),
|
|
1065
1117
|
Tags: (_) => _json(_),
|
|
1066
1118
|
}));
|
|
1067
1119
|
return new __HttpRequest({
|
|
@@ -1233,6 +1285,7 @@ export const de_CreateDomainCommand = async (output, context) => {
|
|
|
1233
1285
|
DomainName: __expectString,
|
|
1234
1286
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1235
1287
|
Matching: (_) => de_MatchingResponse(_, context),
|
|
1288
|
+
RuleBasedMatching: _json,
|
|
1236
1289
|
Tags: _json,
|
|
1237
1290
|
});
|
|
1238
1291
|
Object.assign(contents, doc);
|
|
@@ -1964,6 +2017,7 @@ export const de_GetDomainCommand = async (output, context) => {
|
|
|
1964
2017
|
DomainName: __expectString,
|
|
1965
2018
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1966
2019
|
Matching: (_) => de_MatchingResponse(_, context),
|
|
2020
|
+
RuleBasedMatching: _json,
|
|
1967
2021
|
Stats: _json,
|
|
1968
2022
|
Tags: _json,
|
|
1969
2023
|
});
|
|
@@ -2315,6 +2369,56 @@ const de_GetProfileObjectTypeTemplateCommandError = async (output, context) => {
|
|
|
2315
2369
|
});
|
|
2316
2370
|
}
|
|
2317
2371
|
};
|
|
2372
|
+
export const de_GetSimilarProfilesCommand = async (output, context) => {
|
|
2373
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2374
|
+
return de_GetSimilarProfilesCommandError(output, context);
|
|
2375
|
+
}
|
|
2376
|
+
const contents = map({
|
|
2377
|
+
$metadata: deserializeMetadata(output),
|
|
2378
|
+
});
|
|
2379
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
2380
|
+
const doc = take(data, {
|
|
2381
|
+
ConfidenceScore: __limitedParseDouble,
|
|
2382
|
+
MatchId: __expectString,
|
|
2383
|
+
MatchType: __expectString,
|
|
2384
|
+
NextToken: __expectString,
|
|
2385
|
+
ProfileIds: _json,
|
|
2386
|
+
RuleLevel: __expectInt32,
|
|
2387
|
+
});
|
|
2388
|
+
Object.assign(contents, doc);
|
|
2389
|
+
return contents;
|
|
2390
|
+
};
|
|
2391
|
+
const de_GetSimilarProfilesCommandError = async (output, context) => {
|
|
2392
|
+
const parsedOutput = {
|
|
2393
|
+
...output,
|
|
2394
|
+
body: await parseErrorBody(output.body, context),
|
|
2395
|
+
};
|
|
2396
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
2397
|
+
switch (errorCode) {
|
|
2398
|
+
case "AccessDeniedException":
|
|
2399
|
+
case "com.amazonaws.customerprofiles#AccessDeniedException":
|
|
2400
|
+
throw await de_AccessDeniedExceptionRes(parsedOutput, context);
|
|
2401
|
+
case "BadRequestException":
|
|
2402
|
+
case "com.amazonaws.customerprofiles#BadRequestException":
|
|
2403
|
+
throw await de_BadRequestExceptionRes(parsedOutput, context);
|
|
2404
|
+
case "InternalServerException":
|
|
2405
|
+
case "com.amazonaws.customerprofiles#InternalServerException":
|
|
2406
|
+
throw await de_InternalServerExceptionRes(parsedOutput, context);
|
|
2407
|
+
case "ResourceNotFoundException":
|
|
2408
|
+
case "com.amazonaws.customerprofiles#ResourceNotFoundException":
|
|
2409
|
+
throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
|
|
2410
|
+
case "ThrottlingException":
|
|
2411
|
+
case "com.amazonaws.customerprofiles#ThrottlingException":
|
|
2412
|
+
throw await de_ThrottlingExceptionRes(parsedOutput, context);
|
|
2413
|
+
default:
|
|
2414
|
+
const parsedBody = parsedOutput.body;
|
|
2415
|
+
return throwDefaultError({
|
|
2416
|
+
output,
|
|
2417
|
+
parsedBody,
|
|
2418
|
+
errorCode,
|
|
2419
|
+
});
|
|
2420
|
+
}
|
|
2421
|
+
};
|
|
2318
2422
|
export const de_GetWorkflowCommand = async (output, context) => {
|
|
2319
2423
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2320
2424
|
return de_GetWorkflowCommandError(output, context);
|
|
@@ -2875,6 +2979,52 @@ const de_ListProfileObjectTypeTemplatesCommandError = async (output, context) =>
|
|
|
2875
2979
|
});
|
|
2876
2980
|
}
|
|
2877
2981
|
};
|
|
2982
|
+
export const de_ListRuleBasedMatchesCommand = async (output, context) => {
|
|
2983
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2984
|
+
return de_ListRuleBasedMatchesCommandError(output, context);
|
|
2985
|
+
}
|
|
2986
|
+
const contents = map({
|
|
2987
|
+
$metadata: deserializeMetadata(output),
|
|
2988
|
+
});
|
|
2989
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
2990
|
+
const doc = take(data, {
|
|
2991
|
+
MatchIds: _json,
|
|
2992
|
+
NextToken: __expectString,
|
|
2993
|
+
});
|
|
2994
|
+
Object.assign(contents, doc);
|
|
2995
|
+
return contents;
|
|
2996
|
+
};
|
|
2997
|
+
const de_ListRuleBasedMatchesCommandError = async (output, context) => {
|
|
2998
|
+
const parsedOutput = {
|
|
2999
|
+
...output,
|
|
3000
|
+
body: await parseErrorBody(output.body, context),
|
|
3001
|
+
};
|
|
3002
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
3003
|
+
switch (errorCode) {
|
|
3004
|
+
case "AccessDeniedException":
|
|
3005
|
+
case "com.amazonaws.customerprofiles#AccessDeniedException":
|
|
3006
|
+
throw await de_AccessDeniedExceptionRes(parsedOutput, context);
|
|
3007
|
+
case "BadRequestException":
|
|
3008
|
+
case "com.amazonaws.customerprofiles#BadRequestException":
|
|
3009
|
+
throw await de_BadRequestExceptionRes(parsedOutput, context);
|
|
3010
|
+
case "InternalServerException":
|
|
3011
|
+
case "com.amazonaws.customerprofiles#InternalServerException":
|
|
3012
|
+
throw await de_InternalServerExceptionRes(parsedOutput, context);
|
|
3013
|
+
case "ResourceNotFoundException":
|
|
3014
|
+
case "com.amazonaws.customerprofiles#ResourceNotFoundException":
|
|
3015
|
+
throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
|
|
3016
|
+
case "ThrottlingException":
|
|
3017
|
+
case "com.amazonaws.customerprofiles#ThrottlingException":
|
|
3018
|
+
throw await de_ThrottlingExceptionRes(parsedOutput, context);
|
|
3019
|
+
default:
|
|
3020
|
+
const parsedBody = parsedOutput.body;
|
|
3021
|
+
return throwDefaultError({
|
|
3022
|
+
output,
|
|
3023
|
+
parsedBody,
|
|
3024
|
+
errorCode,
|
|
3025
|
+
});
|
|
3026
|
+
}
|
|
3027
|
+
};
|
|
2878
3028
|
export const de_ListTagsForResourceCommand = async (output, context) => {
|
|
2879
3029
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2880
3030
|
return de_ListTagsForResourceCommandError(output, context);
|
|
@@ -3341,6 +3491,7 @@ export const de_UpdateDomainCommand = async (output, context) => {
|
|
|
3341
3491
|
DomainName: __expectString,
|
|
3342
3492
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
3343
3493
|
Matching: (_) => de_MatchingResponse(_, context),
|
|
3494
|
+
RuleBasedMatching: _json,
|
|
3344
3495
|
Tags: _json,
|
|
3345
3496
|
});
|
|
3346
3497
|
Object.assign(contents, doc);
|
|
@@ -24,6 +24,7 @@ import { GetIntegrationCommandInput, GetIntegrationCommandOutput } from "./comma
|
|
|
24
24
|
import { GetMatchesCommandInput, GetMatchesCommandOutput } from "./commands/GetMatchesCommand";
|
|
25
25
|
import { GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput } from "./commands/GetProfileObjectTypeCommand";
|
|
26
26
|
import { GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput } from "./commands/GetProfileObjectTypeTemplateCommand";
|
|
27
|
+
import { GetSimilarProfilesCommandInput, GetSimilarProfilesCommandOutput } from "./commands/GetSimilarProfilesCommand";
|
|
27
28
|
import { GetWorkflowCommandInput, GetWorkflowCommandOutput } from "./commands/GetWorkflowCommand";
|
|
28
29
|
import { GetWorkflowStepsCommandInput, GetWorkflowStepsCommandOutput } from "./commands/GetWorkflowStepsCommand";
|
|
29
30
|
import { ListAccountIntegrationsCommandInput, ListAccountIntegrationsCommandOutput } from "./commands/ListAccountIntegrationsCommand";
|
|
@@ -36,6 +37,7 @@ import { ListIntegrationsCommandInput, ListIntegrationsCommandOutput } from "./c
|
|
|
36
37
|
import { ListProfileObjectsCommandInput, ListProfileObjectsCommandOutput } from "./commands/ListProfileObjectsCommand";
|
|
37
38
|
import { ListProfileObjectTypesCommandInput, ListProfileObjectTypesCommandOutput } from "./commands/ListProfileObjectTypesCommand";
|
|
38
39
|
import { ListProfileObjectTypeTemplatesCommandInput, ListProfileObjectTypeTemplatesCommandOutput } from "./commands/ListProfileObjectTypeTemplatesCommand";
|
|
40
|
+
import { ListRuleBasedMatchesCommandInput, ListRuleBasedMatchesCommandOutput } from "./commands/ListRuleBasedMatchesCommand";
|
|
39
41
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
40
42
|
import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "./commands/ListWorkflowsCommand";
|
|
41
43
|
import { MergeProfilesCommandInput, MergeProfilesCommandOutput } from "./commands/MergeProfilesCommand";
|
|
@@ -200,6 +202,12 @@ export interface CustomerProfiles {
|
|
|
200
202
|
getProfileObjectTypeTemplate(args: GetProfileObjectTypeTemplateCommandInput, options?: __HttpHandlerOptions): Promise<GetProfileObjectTypeTemplateCommandOutput>;
|
|
201
203
|
getProfileObjectTypeTemplate(args: GetProfileObjectTypeTemplateCommandInput, cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void): void;
|
|
202
204
|
getProfileObjectTypeTemplate(args: GetProfileObjectTypeTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void): void;
|
|
205
|
+
/**
|
|
206
|
+
* @see {@link GetSimilarProfilesCommand}
|
|
207
|
+
*/
|
|
208
|
+
getSimilarProfiles(args: GetSimilarProfilesCommandInput, options?: __HttpHandlerOptions): Promise<GetSimilarProfilesCommandOutput>;
|
|
209
|
+
getSimilarProfiles(args: GetSimilarProfilesCommandInput, cb: (err: any, data?: GetSimilarProfilesCommandOutput) => void): void;
|
|
210
|
+
getSimilarProfiles(args: GetSimilarProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSimilarProfilesCommandOutput) => void): void;
|
|
203
211
|
/**
|
|
204
212
|
* @see {@link GetWorkflowCommand}
|
|
205
213
|
*/
|
|
@@ -272,6 +280,12 @@ export interface CustomerProfiles {
|
|
|
272
280
|
listProfileObjectTypeTemplates(args: ListProfileObjectTypeTemplatesCommandInput, options?: __HttpHandlerOptions): Promise<ListProfileObjectTypeTemplatesCommandOutput>;
|
|
273
281
|
listProfileObjectTypeTemplates(args: ListProfileObjectTypeTemplatesCommandInput, cb: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void): void;
|
|
274
282
|
listProfileObjectTypeTemplates(args: ListProfileObjectTypeTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void): void;
|
|
283
|
+
/**
|
|
284
|
+
* @see {@link ListRuleBasedMatchesCommand}
|
|
285
|
+
*/
|
|
286
|
+
listRuleBasedMatches(args: ListRuleBasedMatchesCommandInput, options?: __HttpHandlerOptions): Promise<ListRuleBasedMatchesCommandOutput>;
|
|
287
|
+
listRuleBasedMatches(args: ListRuleBasedMatchesCommandInput, cb: (err: any, data?: ListRuleBasedMatchesCommandOutput) => void): void;
|
|
288
|
+
listRuleBasedMatches(args: ListRuleBasedMatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleBasedMatchesCommandOutput) => void): void;
|
|
275
289
|
/**
|
|
276
290
|
* @see {@link ListTagsForResourceCommand}
|
|
277
291
|
*/
|
|
@@ -33,6 +33,7 @@ import { GetIntegrationCommandInput, GetIntegrationCommandOutput } from "./comma
|
|
|
33
33
|
import { GetMatchesCommandInput, GetMatchesCommandOutput } from "./commands/GetMatchesCommand";
|
|
34
34
|
import { GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput } from "./commands/GetProfileObjectTypeCommand";
|
|
35
35
|
import { GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput } from "./commands/GetProfileObjectTypeTemplateCommand";
|
|
36
|
+
import { GetSimilarProfilesCommandInput, GetSimilarProfilesCommandOutput } from "./commands/GetSimilarProfilesCommand";
|
|
36
37
|
import { GetWorkflowCommandInput, GetWorkflowCommandOutput } from "./commands/GetWorkflowCommand";
|
|
37
38
|
import { GetWorkflowStepsCommandInput, GetWorkflowStepsCommandOutput } from "./commands/GetWorkflowStepsCommand";
|
|
38
39
|
import { ListAccountIntegrationsCommandInput, ListAccountIntegrationsCommandOutput } from "./commands/ListAccountIntegrationsCommand";
|
|
@@ -45,6 +46,7 @@ import { ListIntegrationsCommandInput, ListIntegrationsCommandOutput } from "./c
|
|
|
45
46
|
import { ListProfileObjectsCommandInput, ListProfileObjectsCommandOutput } from "./commands/ListProfileObjectsCommand";
|
|
46
47
|
import { ListProfileObjectTypesCommandInput, ListProfileObjectTypesCommandOutput } from "./commands/ListProfileObjectTypesCommand";
|
|
47
48
|
import { ListProfileObjectTypeTemplatesCommandInput, ListProfileObjectTypeTemplatesCommandOutput } from "./commands/ListProfileObjectTypeTemplatesCommand";
|
|
49
|
+
import { ListRuleBasedMatchesCommandInput, ListRuleBasedMatchesCommandOutput } from "./commands/ListRuleBasedMatchesCommand";
|
|
48
50
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
49
51
|
import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "./commands/ListWorkflowsCommand";
|
|
50
52
|
import { MergeProfilesCommandInput, MergeProfilesCommandOutput } from "./commands/MergeProfilesCommand";
|
|
@@ -62,11 +64,11 @@ export { __Client };
|
|
|
62
64
|
/**
|
|
63
65
|
* @public
|
|
64
66
|
*/
|
|
65
|
-
export type ServiceInputTypes = AddProfileKeyCommandInput | CreateCalculatedAttributeDefinitionCommandInput | CreateDomainCommandInput | CreateEventStreamCommandInput | CreateIntegrationWorkflowCommandInput | CreateProfileCommandInput | DeleteCalculatedAttributeDefinitionCommandInput | DeleteDomainCommandInput | DeleteEventStreamCommandInput | DeleteIntegrationCommandInput | DeleteProfileCommandInput | DeleteProfileKeyCommandInput | DeleteProfileObjectCommandInput | DeleteProfileObjectTypeCommandInput | DeleteWorkflowCommandInput | GetAutoMergingPreviewCommandInput | GetCalculatedAttributeDefinitionCommandInput | GetCalculatedAttributeForProfileCommandInput | GetDomainCommandInput | GetEventStreamCommandInput | GetIdentityResolutionJobCommandInput | GetIntegrationCommandInput | GetMatchesCommandInput | GetProfileObjectTypeCommandInput | GetProfileObjectTypeTemplateCommandInput | GetWorkflowCommandInput | GetWorkflowStepsCommandInput | ListAccountIntegrationsCommandInput | ListCalculatedAttributeDefinitionsCommandInput | ListCalculatedAttributesForProfileCommandInput | ListDomainsCommandInput | ListEventStreamsCommandInput | ListIdentityResolutionJobsCommandInput | ListIntegrationsCommandInput | ListProfileObjectTypeTemplatesCommandInput | ListProfileObjectTypesCommandInput | ListProfileObjectsCommandInput | ListTagsForResourceCommandInput | ListWorkflowsCommandInput | MergeProfilesCommandInput | PutIntegrationCommandInput | PutProfileObjectCommandInput | PutProfileObjectTypeCommandInput | SearchProfilesCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCalculatedAttributeDefinitionCommandInput | UpdateDomainCommandInput | UpdateProfileCommandInput;
|
|
67
|
+
export type ServiceInputTypes = AddProfileKeyCommandInput | CreateCalculatedAttributeDefinitionCommandInput | CreateDomainCommandInput | CreateEventStreamCommandInput | CreateIntegrationWorkflowCommandInput | CreateProfileCommandInput | DeleteCalculatedAttributeDefinitionCommandInput | DeleteDomainCommandInput | DeleteEventStreamCommandInput | DeleteIntegrationCommandInput | DeleteProfileCommandInput | DeleteProfileKeyCommandInput | DeleteProfileObjectCommandInput | DeleteProfileObjectTypeCommandInput | DeleteWorkflowCommandInput | GetAutoMergingPreviewCommandInput | GetCalculatedAttributeDefinitionCommandInput | GetCalculatedAttributeForProfileCommandInput | GetDomainCommandInput | GetEventStreamCommandInput | GetIdentityResolutionJobCommandInput | GetIntegrationCommandInput | GetMatchesCommandInput | GetProfileObjectTypeCommandInput | GetProfileObjectTypeTemplateCommandInput | GetSimilarProfilesCommandInput | GetWorkflowCommandInput | GetWorkflowStepsCommandInput | ListAccountIntegrationsCommandInput | ListCalculatedAttributeDefinitionsCommandInput | ListCalculatedAttributesForProfileCommandInput | ListDomainsCommandInput | ListEventStreamsCommandInput | ListIdentityResolutionJobsCommandInput | ListIntegrationsCommandInput | ListProfileObjectTypeTemplatesCommandInput | ListProfileObjectTypesCommandInput | ListProfileObjectsCommandInput | ListRuleBasedMatchesCommandInput | ListTagsForResourceCommandInput | ListWorkflowsCommandInput | MergeProfilesCommandInput | PutIntegrationCommandInput | PutProfileObjectCommandInput | PutProfileObjectTypeCommandInput | SearchProfilesCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCalculatedAttributeDefinitionCommandInput | UpdateDomainCommandInput | UpdateProfileCommandInput;
|
|
66
68
|
/**
|
|
67
69
|
* @public
|
|
68
70
|
*/
|
|
69
|
-
export type ServiceOutputTypes = AddProfileKeyCommandOutput | CreateCalculatedAttributeDefinitionCommandOutput | CreateDomainCommandOutput | CreateEventStreamCommandOutput | CreateIntegrationWorkflowCommandOutput | CreateProfileCommandOutput | DeleteCalculatedAttributeDefinitionCommandOutput | DeleteDomainCommandOutput | DeleteEventStreamCommandOutput | DeleteIntegrationCommandOutput | DeleteProfileCommandOutput | DeleteProfileKeyCommandOutput | DeleteProfileObjectCommandOutput | DeleteProfileObjectTypeCommandOutput | DeleteWorkflowCommandOutput | GetAutoMergingPreviewCommandOutput | GetCalculatedAttributeDefinitionCommandOutput | GetCalculatedAttributeForProfileCommandOutput | GetDomainCommandOutput | GetEventStreamCommandOutput | GetIdentityResolutionJobCommandOutput | GetIntegrationCommandOutput | GetMatchesCommandOutput | GetProfileObjectTypeCommandOutput | GetProfileObjectTypeTemplateCommandOutput | GetWorkflowCommandOutput | GetWorkflowStepsCommandOutput | ListAccountIntegrationsCommandOutput | ListCalculatedAttributeDefinitionsCommandOutput | ListCalculatedAttributesForProfileCommandOutput | ListDomainsCommandOutput | ListEventStreamsCommandOutput | ListIdentityResolutionJobsCommandOutput | ListIntegrationsCommandOutput | ListProfileObjectTypeTemplatesCommandOutput | ListProfileObjectTypesCommandOutput | ListProfileObjectsCommandOutput | ListTagsForResourceCommandOutput | ListWorkflowsCommandOutput | MergeProfilesCommandOutput | PutIntegrationCommandOutput | PutProfileObjectCommandOutput | PutProfileObjectTypeCommandOutput | SearchProfilesCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCalculatedAttributeDefinitionCommandOutput | UpdateDomainCommandOutput | UpdateProfileCommandOutput;
|
|
71
|
+
export type ServiceOutputTypes = AddProfileKeyCommandOutput | CreateCalculatedAttributeDefinitionCommandOutput | CreateDomainCommandOutput | CreateEventStreamCommandOutput | CreateIntegrationWorkflowCommandOutput | CreateProfileCommandOutput | DeleteCalculatedAttributeDefinitionCommandOutput | DeleteDomainCommandOutput | DeleteEventStreamCommandOutput | DeleteIntegrationCommandOutput | DeleteProfileCommandOutput | DeleteProfileKeyCommandOutput | DeleteProfileObjectCommandOutput | DeleteProfileObjectTypeCommandOutput | DeleteWorkflowCommandOutput | GetAutoMergingPreviewCommandOutput | GetCalculatedAttributeDefinitionCommandOutput | GetCalculatedAttributeForProfileCommandOutput | GetDomainCommandOutput | GetEventStreamCommandOutput | GetIdentityResolutionJobCommandOutput | GetIntegrationCommandOutput | GetMatchesCommandOutput | GetProfileObjectTypeCommandOutput | GetProfileObjectTypeTemplateCommandOutput | GetSimilarProfilesCommandOutput | GetWorkflowCommandOutput | GetWorkflowStepsCommandOutput | ListAccountIntegrationsCommandOutput | ListCalculatedAttributeDefinitionsCommandOutput | ListCalculatedAttributesForProfileCommandOutput | ListDomainsCommandOutput | ListEventStreamsCommandOutput | ListIdentityResolutionJobsCommandOutput | ListIntegrationsCommandOutput | ListProfileObjectTypeTemplatesCommandOutput | ListProfileObjectTypesCommandOutput | ListProfileObjectsCommandOutput | ListRuleBasedMatchesCommandOutput | ListTagsForResourceCommandOutput | ListWorkflowsCommandOutput | MergeProfilesCommandOutput | PutIntegrationCommandOutput | PutProfileObjectCommandOutput | PutProfileObjectTypeCommandOutput | SearchProfilesCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCalculatedAttributeDefinitionCommandOutput | UpdateDomainCommandOutput | UpdateProfileCommandOutput;
|
|
70
72
|
/**
|
|
71
73
|
* @public
|
|
72
74
|
*/
|
|
@@ -30,7 +30,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
|
|
|
30
30
|
* be associated with one domain.</p>
|
|
31
31
|
* <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
|
|
32
32
|
* enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
|
|
33
|
-
* resolution</a>: set <code>Matching</code> to true
|
|
33
|
+
* resolution</a>: set <code>Matching</code> to true.</p>
|
|
34
34
|
* <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
|
|
35
35
|
* apply. </p>
|
|
36
36
|
* @example
|
|
@@ -72,6 +72,40 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
|
|
|
72
72
|
* },
|
|
73
73
|
* },
|
|
74
74
|
* },
|
|
75
|
+
* RuleBasedMatching: { // RuleBasedMatchingRequest
|
|
76
|
+
* Enabled: true || false, // required
|
|
77
|
+
* MatchingRules: [ // MatchingRules
|
|
78
|
+
* { // MatchingRule
|
|
79
|
+
* Rule: [ // MatchingRuleAttributeList // required
|
|
80
|
+
* "STRING_VALUE",
|
|
81
|
+
* ],
|
|
82
|
+
* },
|
|
83
|
+
* ],
|
|
84
|
+
* MaxAllowedRuleLevelForMerging: Number("int"),
|
|
85
|
+
* MaxAllowedRuleLevelForMatching: Number("int"),
|
|
86
|
+
* AttributeTypesSelector: { // AttributeTypesSelector
|
|
87
|
+
* AttributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
|
|
88
|
+
* Address: [ // AddressList
|
|
89
|
+
* "STRING_VALUE",
|
|
90
|
+
* ],
|
|
91
|
+
* PhoneNumber: [ // PhoneNumberList
|
|
92
|
+
* "STRING_VALUE",
|
|
93
|
+
* ],
|
|
94
|
+
* EmailAddress: [ // EmailList
|
|
95
|
+
* "STRING_VALUE",
|
|
96
|
+
* ],
|
|
97
|
+
* },
|
|
98
|
+
* ConflictResolution: {
|
|
99
|
+
* ConflictResolvingModel: "RECENCY" || "SOURCE", // required
|
|
100
|
+
* SourceName: "STRING_VALUE",
|
|
101
|
+
* },
|
|
102
|
+
* ExportingConfig: {
|
|
103
|
+
* S3Exporting: {
|
|
104
|
+
* S3BucketName: "STRING_VALUE", // required
|
|
105
|
+
* S3KeyName: "STRING_VALUE",
|
|
106
|
+
* },
|
|
107
|
+
* },
|
|
108
|
+
* },
|
|
75
109
|
* Tags: { // TagMap
|
|
76
110
|
* "<keys>": "STRING_VALUE",
|
|
77
111
|
* },
|
|
@@ -111,6 +145,41 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
|
|
|
111
145
|
* // },
|
|
112
146
|
* // },
|
|
113
147
|
* // },
|
|
148
|
+
* // RuleBasedMatching: { // RuleBasedMatchingResponse
|
|
149
|
+
* // Enabled: true || false,
|
|
150
|
+
* // MatchingRules: [ // MatchingRules
|
|
151
|
+
* // { // MatchingRule
|
|
152
|
+
* // Rule: [ // MatchingRuleAttributeList // required
|
|
153
|
+
* // "STRING_VALUE",
|
|
154
|
+
* // ],
|
|
155
|
+
* // },
|
|
156
|
+
* // ],
|
|
157
|
+
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE",
|
|
158
|
+
* // MaxAllowedRuleLevelForMerging: Number("int"),
|
|
159
|
+
* // MaxAllowedRuleLevelForMatching: Number("int"),
|
|
160
|
+
* // AttributeTypesSelector: { // AttributeTypesSelector
|
|
161
|
+
* // AttributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
|
|
162
|
+
* // Address: [ // AddressList
|
|
163
|
+
* // "STRING_VALUE",
|
|
164
|
+
* // ],
|
|
165
|
+
* // PhoneNumber: [ // PhoneNumberList
|
|
166
|
+
* // "STRING_VALUE",
|
|
167
|
+
* // ],
|
|
168
|
+
* // EmailAddress: [ // EmailList
|
|
169
|
+
* // "STRING_VALUE",
|
|
170
|
+
* // ],
|
|
171
|
+
* // },
|
|
172
|
+
* // ConflictResolution: {
|
|
173
|
+
* // ConflictResolvingModel: "RECENCY" || "SOURCE", // required
|
|
174
|
+
* // SourceName: "STRING_VALUE",
|
|
175
|
+
* // },
|
|
176
|
+
* // ExportingConfig: {
|
|
177
|
+
* // S3Exporting: {
|
|
178
|
+
* // S3BucketName: "STRING_VALUE", // required
|
|
179
|
+
* // S3KeyName: "STRING_VALUE",
|
|
180
|
+
* // },
|
|
181
|
+
* // },
|
|
182
|
+
* // },
|
|
114
183
|
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
115
184
|
* // LastUpdatedAt: new Date("TIMESTAMP"), // required
|
|
116
185
|
* // Tags: { // TagMap
|
|
@@ -74,6 +74,41 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
|
|
|
74
74
|
* // },
|
|
75
75
|
* // },
|
|
76
76
|
* // },
|
|
77
|
+
* // RuleBasedMatching: { // RuleBasedMatchingResponse
|
|
78
|
+
* // Enabled: true || false,
|
|
79
|
+
* // MatchingRules: [ // MatchingRules
|
|
80
|
+
* // { // MatchingRule
|
|
81
|
+
* // Rule: [ // MatchingRuleAttributeList // required
|
|
82
|
+
* // "STRING_VALUE",
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE",
|
|
87
|
+
* // MaxAllowedRuleLevelForMerging: Number("int"),
|
|
88
|
+
* // MaxAllowedRuleLevelForMatching: Number("int"),
|
|
89
|
+
* // AttributeTypesSelector: { // AttributeTypesSelector
|
|
90
|
+
* // AttributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
|
|
91
|
+
* // Address: [ // AddressList
|
|
92
|
+
* // "STRING_VALUE",
|
|
93
|
+
* // ],
|
|
94
|
+
* // PhoneNumber: [ // PhoneNumberList
|
|
95
|
+
* // "STRING_VALUE",
|
|
96
|
+
* // ],
|
|
97
|
+
* // EmailAddress: [ // EmailList
|
|
98
|
+
* // "STRING_VALUE",
|
|
99
|
+
* // ],
|
|
100
|
+
* // },
|
|
101
|
+
* // ConflictResolution: {
|
|
102
|
+
* // ConflictResolvingModel: "RECENCY" || "SOURCE", // required
|
|
103
|
+
* // SourceName: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // ExportingConfig: {
|
|
106
|
+
* // S3Exporting: {
|
|
107
|
+
* // S3BucketName: "STRING_VALUE", // required
|
|
108
|
+
* // S3KeyName: "STRING_VALUE",
|
|
109
|
+
* // },
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
77
112
|
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
78
113
|
* // LastUpdatedAt: new Date("TIMESTAMP"), // required
|
|
79
114
|
* // Tags: { // TagMap
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
5
|
+
import { GetSimilarProfilesRequest, GetSimilarProfilesResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetSimilarProfilesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetSimilarProfilesCommandInput extends GetSimilarProfilesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetSimilarProfilesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetSimilarProfilesCommandOutput extends GetSimilarProfilesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a set of profiles that belong to the same matching group using the <code>matchId</code> or
|
|
27
|
+
* <code>profileId</code>. You can also specify the type of matching that you want for finding similar profiles using
|
|
28
|
+
* either <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { CustomerProfilesClient, GetSimilarProfilesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
33
|
+
* // const { CustomerProfilesClient, GetSimilarProfilesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
34
|
+
* const client = new CustomerProfilesClient(config);
|
|
35
|
+
* const input = { // GetSimilarProfilesRequest
|
|
36
|
+
* NextToken: "STRING_VALUE",
|
|
37
|
+
* MaxResults: Number("int"),
|
|
38
|
+
* DomainName: "STRING_VALUE", // required
|
|
39
|
+
* MatchType: "RULE_BASED_MATCHING" || "ML_BASED_MATCHING", // required
|
|
40
|
+
* SearchKey: "STRING_VALUE", // required
|
|
41
|
+
* SearchValue: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetSimilarProfilesCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetSimilarProfilesResponse
|
|
46
|
+
* // ProfileIds: [ // ProfileIdList
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // MatchId: "STRING_VALUE",
|
|
50
|
+
* // MatchType: "RULE_BASED_MATCHING" || "ML_BASED_MATCHING",
|
|
51
|
+
* // RuleLevel: Number("int"),
|
|
52
|
+
* // ConfidenceScore: Number("double"),
|
|
53
|
+
* // NextToken: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetSimilarProfilesCommandInput - {@link GetSimilarProfilesCommandInput}
|
|
59
|
+
* @returns {@link GetSimilarProfilesCommandOutput}
|
|
60
|
+
* @see {@link GetSimilarProfilesCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetSimilarProfilesCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link BadRequestException} (client fault)
|
|
68
|
+
* <p>The input you provided is invalid.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* <p>An internal service error occurred.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
81
|
+
*
|
|
82
|
+
*/
|
|
83
|
+
export declare class GetSimilarProfilesCommand extends $Command<GetSimilarProfilesCommandInput, GetSimilarProfilesCommandOutput, CustomerProfilesClientResolvedConfig> {
|
|
84
|
+
readonly input: GetSimilarProfilesCommandInput;
|
|
85
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
constructor(input: GetSimilarProfilesCommandInput);
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSimilarProfilesCommandInput, GetSimilarProfilesCommandOutput>;
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
private serialize;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
private deserialize;
|
|
102
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
5
|
+
import { ListRuleBasedMatchesRequest, ListRuleBasedMatchesResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListRuleBasedMatchesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListRuleBasedMatchesCommandInput extends ListRuleBasedMatchesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListRuleBasedMatchesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListRuleBasedMatchesCommandOutput extends ListRuleBasedMatchesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a set of <code>MatchIds</code> that belong to the given domain.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CustomerProfilesClient, ListRuleBasedMatchesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
31
|
+
* // const { CustomerProfilesClient, ListRuleBasedMatchesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
32
|
+
* const client = new CustomerProfilesClient(config);
|
|
33
|
+
* const input = { // ListRuleBasedMatchesRequest
|
|
34
|
+
* NextToken: "STRING_VALUE",
|
|
35
|
+
* MaxResults: Number("int"),
|
|
36
|
+
* DomainName: "STRING_VALUE", // required
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListRuleBasedMatchesCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // ListRuleBasedMatchesResponse
|
|
41
|
+
* // MatchIds: [ // MatchIdList
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // NextToken: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param ListRuleBasedMatchesCommandInput - {@link ListRuleBasedMatchesCommandInput}
|
|
50
|
+
* @returns {@link ListRuleBasedMatchesCommandOutput}
|
|
51
|
+
* @see {@link ListRuleBasedMatchesCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link ListRuleBasedMatchesCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link BadRequestException} (client fault)
|
|
59
|
+
* <p>The input you provided is invalid.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerException} (server fault)
|
|
62
|
+
* <p>An internal service error occurred.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
68
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
72
|
+
*
|
|
73
|
+
*/
|
|
74
|
+
export declare class ListRuleBasedMatchesCommand extends $Command<ListRuleBasedMatchesCommandInput, ListRuleBasedMatchesCommandOutput, CustomerProfilesClientResolvedConfig> {
|
|
75
|
+
readonly input: ListRuleBasedMatchesCommandInput;
|
|
76
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
constructor(input: ListRuleBasedMatchesCommandInput);
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRuleBasedMatchesCommandInput, ListRuleBasedMatchesCommandOutput>;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
private serialize;
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
private deserialize;
|
|
93
|
+
}
|