@aws-sdk/client-customer-profiles 3.1006.0 → 3.1007.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 +28 -0
- package/dist-cjs/index.js +69 -0
- package/dist-cjs/schemas/schemas_0.js +144 -14
- package/dist-es/CustomerProfiles.js +10 -0
- package/dist-es/commands/CreateRecommenderFilterCommand.js +16 -0
- package/dist-es/commands/DeleteRecommenderFilterCommand.js +16 -0
- package/dist-es/commands/GetRecommenderFilterCommand.js +16 -0
- package/dist-es/commands/ListRecommenderFiltersCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +8 -0
- package/dist-es/pagination/ListRecommenderFiltersPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +136 -6
- package/dist-types/CustomerProfiles.d.ts +35 -0
- package/dist-types/CustomerProfilesClient.d.ts +6 -2
- package/dist-types/commands/CreateRecommenderCommand.d.ts +5 -1
- package/dist-types/commands/CreateRecommenderFilterCommand.d.ts +98 -0
- package/dist-types/commands/DeleteRecommenderFilterCommand.d.ts +90 -0
- package/dist-types/commands/GetProfileRecommendationsCommand.d.ts +26 -0
- package/dist-types/commands/GetRecommenderCommand.d.ts +9 -1
- package/dist-types/commands/GetRecommenderFilterCommand.d.ts +98 -0
- package/dist-types/commands/ListRecommenderFiltersCommand.d.ts +104 -0
- package/dist-types/commands/ListRecommenderRecipesCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommendersCommand.d.ts +9 -1
- package/dist-types/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/commands/StartRecommenderCommand.d.ts +1 -1
- package/dist-types/commands/StartUploadJobCommand.d.ts +1 -1
- package/dist-types/commands/StopRecommenderCommand.d.ts +1 -2
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +4 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +16 -0
- package/dist-types/models/models_0.d.ts +297 -465
- package/dist-types/models/models_1.d.ts +465 -2
- package/dist-types/pagination/ListRecommenderFiltersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +17 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +75 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateRecommenderFilterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommenderFilterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommenderFilterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommenderFiltersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutProfileObjectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartRecommenderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartUploadJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopRecommenderCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +73 -94
- package/dist-types/ts3.4/models/models_1.d.ts +99 -0
- package/dist-types/ts3.4/pagination/ListRecommenderFiltersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +17 -0
- package/package.json +1 -1
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
+
import type { DeleteRecommenderFilterRequest, DeleteRecommenderFilterResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteRecommenderFilterCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteRecommenderFilterCommandInput extends DeleteRecommenderFilterRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteRecommenderFilterCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteRecommenderFilterCommandOutput extends DeleteRecommenderFilterResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteRecommenderFilterCommand_base: {
|
|
25
|
+
new (input: DeleteRecommenderFilterCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRecommenderFilterCommandInput, DeleteRecommenderFilterCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteRecommenderFilterCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRecommenderFilterCommandInput, DeleteRecommenderFilterCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a recommender filter from a domain.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, DeleteRecommenderFilterCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, DeleteRecommenderFilterCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
36
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
37
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
38
|
+
* const client = new CustomerProfilesClient(config);
|
|
39
|
+
* const input = { // DeleteRecommenderFilterRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* RecommenderFilterName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteRecommenderFilterCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DeleteRecommenderFilterResponse
|
|
46
|
+
* // Message: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param DeleteRecommenderFilterCommandInput - {@link DeleteRecommenderFilterCommandInput}
|
|
52
|
+
* @returns {@link DeleteRecommenderFilterCommandOutput}
|
|
53
|
+
* @see {@link DeleteRecommenderFilterCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link DeleteRecommenderFilterCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link BadRequestException} (client fault)
|
|
61
|
+
* <p>The input you provided is invalid.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerException} (server fault)
|
|
64
|
+
* <p>An internal service error occurred.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
74
|
+
*
|
|
75
|
+
*
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export declare class DeleteRecommenderFilterCommand extends DeleteRecommenderFilterCommand_base {
|
|
79
|
+
/** @internal type navigation helper, not in runtime. */
|
|
80
|
+
protected static __types: {
|
|
81
|
+
api: {
|
|
82
|
+
input: DeleteRecommenderFilterRequest;
|
|
83
|
+
output: DeleteRecommenderFilterResponse;
|
|
84
|
+
};
|
|
85
|
+
sdk: {
|
|
86
|
+
input: DeleteRecommenderFilterCommandInput;
|
|
87
|
+
output: DeleteRecommenderFilterCommandOutput;
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
}
|
|
@@ -43,7 +43,33 @@ declare const GetProfileRecommendationsCommand_base: {
|
|
|
43
43
|
* Context: { // RecommenderContext
|
|
44
44
|
* "<keys>": "STRING_VALUE",
|
|
45
45
|
* },
|
|
46
|
+
* RecommenderFilters: [ // RecommenderFilters
|
|
47
|
+
* { // RecommenderFilter
|
|
48
|
+
* Name: "STRING_VALUE",
|
|
49
|
+
* Values: { // RecommenderFilterValues
|
|
50
|
+
* "<keys>": "STRING_VALUE",
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* RecommenderPromotionalFilters: [ // RecommenderPromotionalFilters
|
|
55
|
+
* { // RecommenderPromotionalFilter
|
|
56
|
+
* Name: "STRING_VALUE",
|
|
57
|
+
* Values: {
|
|
58
|
+
* "<keys>": "STRING_VALUE",
|
|
59
|
+
* },
|
|
60
|
+
* PromotionName: "STRING_VALUE",
|
|
61
|
+
* PercentPromotedItems: Number("int"),
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* CandidateIds: [ // CandidateIdList
|
|
65
|
+
* "STRING_VALUE",
|
|
66
|
+
* ],
|
|
46
67
|
* MaxResults: Number("int"),
|
|
68
|
+
* MetadataConfig: { // MetadataConfig
|
|
69
|
+
* MetadataColumns: [ // MetadataColumnsList
|
|
70
|
+
* "STRING_VALUE",
|
|
71
|
+
* ],
|
|
72
|
+
* },
|
|
47
73
|
* };
|
|
48
74
|
* const command = new GetProfileRecommendationsCommand(input);
|
|
49
75
|
* const response = await client.send(command);
|
|
@@ -45,17 +45,21 @@ declare const GetRecommenderCommand_base: {
|
|
|
45
45
|
* const response = await client.send(command);
|
|
46
46
|
* // { // GetRecommenderResponse
|
|
47
47
|
* // RecommenderName: "STRING_VALUE", // required
|
|
48
|
-
* // RecommenderRecipeName: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now", // required
|
|
48
|
+
* // RecommenderRecipeName: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now" || "personalized-ranking", // required
|
|
49
49
|
* // RecommenderConfig: { // RecommenderConfig
|
|
50
50
|
* // EventsConfig: { // EventsConfig
|
|
51
51
|
* // EventParametersList: [ // EventParametersList // required
|
|
52
52
|
* // { // EventParameters
|
|
53
53
|
* // EventType: "STRING_VALUE", // required
|
|
54
54
|
* // EventValueThreshold: Number("double"),
|
|
55
|
+
* // EventWeight: Number("double"),
|
|
55
56
|
* // },
|
|
56
57
|
* // ],
|
|
57
58
|
* // },
|
|
58
59
|
* // TrainingFrequency: Number("int"),
|
|
60
|
+
* // InferenceConfig: { // InferenceConfig
|
|
61
|
+
* // MinProvisionedTPS: Number("int"),
|
|
62
|
+
* // },
|
|
59
63
|
* // },
|
|
60
64
|
* // Description: "STRING_VALUE",
|
|
61
65
|
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
|
|
@@ -69,10 +73,14 @@ declare const GetRecommenderCommand_base: {
|
|
|
69
73
|
* // {
|
|
70
74
|
* // EventType: "STRING_VALUE", // required
|
|
71
75
|
* // EventValueThreshold: Number("double"),
|
|
76
|
+
* // EventWeight: Number("double"),
|
|
72
77
|
* // },
|
|
73
78
|
* // ],
|
|
74
79
|
* // },
|
|
75
80
|
* // TrainingFrequency: Number("int"),
|
|
81
|
+
* // InferenceConfig: {
|
|
82
|
+
* // MinProvisionedTPS: Number("int"),
|
|
83
|
+
* // },
|
|
76
84
|
* // },
|
|
77
85
|
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
|
|
78
86
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
+
import type { GetRecommenderFilterRequest, GetRecommenderFilterResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetRecommenderFilterCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetRecommenderFilterCommandInput extends GetRecommenderFilterRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetRecommenderFilterCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetRecommenderFilterCommandOutput extends GetRecommenderFilterResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetRecommenderFilterCommand_base: {
|
|
25
|
+
new (input: GetRecommenderFilterCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecommenderFilterCommandInput, GetRecommenderFilterCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetRecommenderFilterCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecommenderFilterCommandInput, GetRecommenderFilterCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves information about a specific recommender filter in a domain.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, GetRecommenderFilterCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, GetRecommenderFilterCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
36
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
37
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
38
|
+
* const client = new CustomerProfilesClient(config);
|
|
39
|
+
* const input = { // GetRecommenderFilterRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* RecommenderFilterName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetRecommenderFilterCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetRecommenderFilterResponse
|
|
46
|
+
* // RecommenderFilterName: "STRING_VALUE", // required
|
|
47
|
+
* // RecommenderFilterExpression: "STRING_VALUE", // required
|
|
48
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // Status: "ACTIVE" || "PENDING" || "IN_PROGRESS" || "FAILED" || "DELETING", // required
|
|
50
|
+
* // Description: "STRING_VALUE",
|
|
51
|
+
* // FailureReason: "STRING_VALUE",
|
|
52
|
+
* // Tags: { // TagMap // required
|
|
53
|
+
* // "<keys>": "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param GetRecommenderFilterCommandInput - {@link GetRecommenderFilterCommandInput}
|
|
60
|
+
* @returns {@link GetRecommenderFilterCommandOutput}
|
|
61
|
+
* @see {@link GetRecommenderFilterCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link GetRecommenderFilterCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link BadRequestException} (client fault)
|
|
69
|
+
* <p>The input you provided is invalid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalServerException} (server fault)
|
|
72
|
+
* <p>An internal service error occurred.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export declare class GetRecommenderFilterCommand extends GetRecommenderFilterCommand_base {
|
|
87
|
+
/** @internal type navigation helper, not in runtime. */
|
|
88
|
+
protected static __types: {
|
|
89
|
+
api: {
|
|
90
|
+
input: GetRecommenderFilterRequest;
|
|
91
|
+
output: GetRecommenderFilterResponse;
|
|
92
|
+
};
|
|
93
|
+
sdk: {
|
|
94
|
+
input: GetRecommenderFilterCommandInput;
|
|
95
|
+
output: GetRecommenderFilterCommandOutput;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
+
import type { ListRecommenderFiltersRequest, ListRecommenderFiltersResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListRecommenderFiltersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListRecommenderFiltersCommandInput extends ListRecommenderFiltersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListRecommenderFiltersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListRecommenderFiltersCommandOutput extends ListRecommenderFiltersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListRecommenderFiltersCommand_base: {
|
|
25
|
+
new (input: ListRecommenderFiltersCommandInput): import("@smithy/smithy-client").CommandImpl<ListRecommenderFiltersCommandInput, ListRecommenderFiltersCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListRecommenderFiltersCommandInput): import("@smithy/smithy-client").CommandImpl<ListRecommenderFiltersCommandInput, ListRecommenderFiltersCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of recommender filters in the specified domain.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, ListRecommenderFiltersCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, ListRecommenderFiltersCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
36
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
37
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
38
|
+
* const client = new CustomerProfilesClient(config);
|
|
39
|
+
* const input = { // ListRecommenderFiltersRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListRecommenderFiltersCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListRecommenderFiltersResponse
|
|
47
|
+
* // NextToken: "STRING_VALUE",
|
|
48
|
+
* // RecommenderFilters: [ // RecommenderFilterSummaryList
|
|
49
|
+
* // { // RecommenderFilterSummary
|
|
50
|
+
* // RecommenderFilterName: "STRING_VALUE",
|
|
51
|
+
* // RecommenderFilterExpression: "STRING_VALUE",
|
|
52
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
53
|
+
* // Description: "STRING_VALUE",
|
|
54
|
+
* // Status: "ACTIVE" || "PENDING" || "IN_PROGRESS" || "FAILED" || "DELETING",
|
|
55
|
+
* // FailureReason: "STRING_VALUE",
|
|
56
|
+
* // Tags: { // TagMap
|
|
57
|
+
* // "<keys>": "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param ListRecommenderFiltersCommandInput - {@link ListRecommenderFiltersCommandInput}
|
|
66
|
+
* @returns {@link ListRecommenderFiltersCommandOutput}
|
|
67
|
+
* @see {@link ListRecommenderFiltersCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link ListRecommenderFiltersCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link BadRequestException} (client fault)
|
|
75
|
+
* <p>The input you provided is invalid.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServerException} (server fault)
|
|
78
|
+
* <p>An internal service error occurred.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
84
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class ListRecommenderFiltersCommand extends ListRecommenderFiltersCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: ListRecommenderFiltersRequest;
|
|
97
|
+
output: ListRecommenderFiltersResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: ListRecommenderFiltersCommandInput;
|
|
101
|
+
output: ListRecommenderFiltersCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -46,7 +46,7 @@ declare const ListRecommenderRecipesCommand_base: {
|
|
|
46
46
|
* // NextToken: "STRING_VALUE",
|
|
47
47
|
* // RecommenderRecipes: [ // RecommenderRecipesList
|
|
48
48
|
* // { // RecommenderRecipe
|
|
49
|
-
* // name: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now",
|
|
49
|
+
* // name: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now" || "personalized-ranking",
|
|
50
50
|
* // description: "STRING_VALUE",
|
|
51
51
|
* // },
|
|
52
52
|
* // ],
|
|
@@ -48,17 +48,21 @@ declare const ListRecommendersCommand_base: {
|
|
|
48
48
|
* // Recommenders: [ // RecommenderSummaryList
|
|
49
49
|
* // { // RecommenderSummary
|
|
50
50
|
* // RecommenderName: "STRING_VALUE",
|
|
51
|
-
* // RecipeName: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now",
|
|
51
|
+
* // RecipeName: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now" || "personalized-ranking",
|
|
52
52
|
* // RecommenderConfig: { // RecommenderConfig
|
|
53
53
|
* // EventsConfig: { // EventsConfig
|
|
54
54
|
* // EventParametersList: [ // EventParametersList // required
|
|
55
55
|
* // { // EventParameters
|
|
56
56
|
* // EventType: "STRING_VALUE", // required
|
|
57
57
|
* // EventValueThreshold: Number("double"),
|
|
58
|
+
* // EventWeight: Number("double"),
|
|
58
59
|
* // },
|
|
59
60
|
* // ],
|
|
60
61
|
* // },
|
|
61
62
|
* // TrainingFrequency: Number("int"),
|
|
63
|
+
* // InferenceConfig: { // InferenceConfig
|
|
64
|
+
* // MinProvisionedTPS: Number("int"),
|
|
65
|
+
* // },
|
|
62
66
|
* // },
|
|
63
67
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
64
68
|
* // Description: "STRING_VALUE",
|
|
@@ -75,10 +79,14 @@ declare const ListRecommendersCommand_base: {
|
|
|
75
79
|
* // {
|
|
76
80
|
* // EventType: "STRING_VALUE", // required
|
|
77
81
|
* // EventValueThreshold: Number("double"),
|
|
82
|
+
* // EventWeight: Number("double"),
|
|
78
83
|
* // },
|
|
79
84
|
* // ],
|
|
80
85
|
* // },
|
|
81
86
|
* // TrainingFrequency: Number("int"),
|
|
87
|
+
* // InferenceConfig: {
|
|
88
|
+
* // MinProvisionedTPS: Number("int"),
|
|
89
|
+
* // },
|
|
82
90
|
* // },
|
|
83
91
|
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
|
|
84
92
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { PutIntegrationRequest, PutIntegrationResponse } from "../models/
|
|
4
|
+
import type { PutIntegrationRequest, PutIntegrationResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { PutProfileObjectRequest, PutProfileObjectResponse } from "../models/
|
|
4
|
+
import type { PutProfileObjectRequest, PutProfileObjectResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { PutProfileObjectTypeRequest, PutProfileObjectTypeResponse } from "../models/
|
|
4
|
+
import type { PutProfileObjectTypeRequest, PutProfileObjectTypeResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { SearchProfilesRequest, SearchProfilesResponse } from "../models/
|
|
4
|
+
import type { SearchProfilesRequest, SearchProfilesResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { StartRecommenderRequest, StartRecommenderResponse } from "../models/
|
|
4
|
+
import type { StartRecommenderRequest, StartRecommenderResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { StartUploadJobRequest, StartUploadJobResponse } from "../models/
|
|
4
|
+
import type { StartUploadJobRequest, StartUploadJobResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import type { StopRecommenderRequest } from "../models/
|
|
5
|
-
import type { StopRecommenderResponse } from "../models/models_1";
|
|
4
|
+
import type { StopRecommenderRequest, StopRecommenderResponse } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -46,10 +46,14 @@ declare const UpdateRecommenderCommand_base: {
|
|
|
46
46
|
* { // EventParameters
|
|
47
47
|
* EventType: "STRING_VALUE", // required
|
|
48
48
|
* EventValueThreshold: Number("double"),
|
|
49
|
+
* EventWeight: Number("double"),
|
|
49
50
|
* },
|
|
50
51
|
* ],
|
|
51
52
|
* },
|
|
52
53
|
* TrainingFrequency: Number("int"),
|
|
54
|
+
* InferenceConfig: { // InferenceConfig
|
|
55
|
+
* MinProvisionedTPS: Number("int"),
|
|
56
|
+
* },
|
|
53
57
|
* },
|
|
54
58
|
* };
|
|
55
59
|
* const command = new UpdateRecommenderCommand(input);
|
|
@@ -9,6 +9,7 @@ export * from "./CreateEventTriggerCommand";
|
|
|
9
9
|
export * from "./CreateIntegrationWorkflowCommand";
|
|
10
10
|
export * from "./CreateProfileCommand";
|
|
11
11
|
export * from "./CreateRecommenderCommand";
|
|
12
|
+
export * from "./CreateRecommenderFilterCommand";
|
|
12
13
|
export * from "./CreateSegmentDefinitionCommand";
|
|
13
14
|
export * from "./CreateSegmentEstimateCommand";
|
|
14
15
|
export * from "./CreateSegmentSnapshotCommand";
|
|
@@ -25,6 +26,7 @@ export * from "./DeleteProfileKeyCommand";
|
|
|
25
26
|
export * from "./DeleteProfileObjectCommand";
|
|
26
27
|
export * from "./DeleteProfileObjectTypeCommand";
|
|
27
28
|
export * from "./DeleteRecommenderCommand";
|
|
29
|
+
export * from "./DeleteRecommenderFilterCommand";
|
|
28
30
|
export * from "./DeleteSegmentDefinitionCommand";
|
|
29
31
|
export * from "./DeleteWorkflowCommand";
|
|
30
32
|
export * from "./DetectProfileObjectTypeCommand";
|
|
@@ -45,6 +47,7 @@ export * from "./GetProfileObjectTypeCommand";
|
|
|
45
47
|
export * from "./GetProfileObjectTypeTemplateCommand";
|
|
46
48
|
export * from "./GetProfileRecommendationsCommand";
|
|
47
49
|
export * from "./GetRecommenderCommand";
|
|
50
|
+
export * from "./GetRecommenderFilterCommand";
|
|
48
51
|
export * from "./GetSegmentDefinitionCommand";
|
|
49
52
|
export * from "./GetSegmentEstimateCommand";
|
|
50
53
|
export * from "./GetSegmentMembershipCommand";
|
|
@@ -71,6 +74,7 @@ export * from "./ListProfileHistoryRecordsCommand";
|
|
|
71
74
|
export * from "./ListProfileObjectTypeTemplatesCommand";
|
|
72
75
|
export * from "./ListProfileObjectTypesCommand";
|
|
73
76
|
export * from "./ListProfileObjectsCommand";
|
|
77
|
+
export * from "./ListRecommenderFiltersCommand";
|
|
74
78
|
export * from "./ListRecommenderRecipesCommand";
|
|
75
79
|
export * from "./ListRecommendersCommand";
|
|
76
80
|
export * from "./ListRuleBasedMatchesCommand";
|
|
@@ -617,6 +617,7 @@ export type WorkflowType = (typeof WorkflowType)[keyof typeof WorkflowType];
|
|
|
617
617
|
*/
|
|
618
618
|
export declare const RecommenderRecipeName: {
|
|
619
619
|
readonly FREQUENTLY_PAIRED_ITEMS: "frequently-paired-items";
|
|
620
|
+
readonly PERSONALIZED_RANKING: "personalized-ranking";
|
|
620
621
|
readonly POPULAR_ITEMS: "popular-items";
|
|
621
622
|
readonly RECOMMENDED_FOR_YOU: "recommended-for-you";
|
|
622
623
|
readonly SIMILAR_ITEMS: "similar-items";
|
|
@@ -823,6 +824,21 @@ export declare const TrainingMetricName: {
|
|
|
823
824
|
* @public
|
|
824
825
|
*/
|
|
825
826
|
export type TrainingMetricName = (typeof TrainingMetricName)[keyof typeof TrainingMetricName];
|
|
827
|
+
/**
|
|
828
|
+
* @public
|
|
829
|
+
* @enum
|
|
830
|
+
*/
|
|
831
|
+
export declare const RecommenderFilterStatus: {
|
|
832
|
+
readonly ACTIVE: "ACTIVE";
|
|
833
|
+
readonly DELETING: "DELETING";
|
|
834
|
+
readonly FAILED: "FAILED";
|
|
835
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
836
|
+
readonly PENDING: "PENDING";
|
|
837
|
+
};
|
|
838
|
+
/**
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
841
|
+
export type RecommenderFilterStatus = (typeof RecommenderFilterStatus)[keyof typeof RecommenderFilterStatus];
|
|
826
842
|
/**
|
|
827
843
|
* @public
|
|
828
844
|
* @enum
|