@aws-sdk/client-customer-profiles 3.940.0 → 3.942.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 +120 -0
- package/dist-cjs/index.js +1058 -84
- package/dist-es/CustomerProfiles.js +30 -0
- package/dist-es/commands/CreateRecommenderCommand.js +16 -0
- package/dist-es/commands/DeleteDomainObjectTypeCommand.js +16 -0
- package/dist-es/commands/DeleteRecommenderCommand.js +16 -0
- package/dist-es/commands/GetDomainObjectTypeCommand.js +16 -0
- package/dist-es/commands/GetObjectTypeAttributeStatisticsCommand.js +16 -0
- package/dist-es/commands/GetProfileRecommendationsCommand.js +16 -0
- package/dist-es/commands/GetRecommenderCommand.js +16 -0
- package/dist-es/commands/ListDomainObjectTypesCommand.js +16 -0
- package/dist-es/commands/ListObjectTypeAttributeValuesCommand.js +16 -0
- package/dist-es/commands/ListRecommenderRecipesCommand.js +16 -0
- package/dist-es/commands/ListRecommendersCommand.js +16 -0
- package/dist-es/commands/PutDomainObjectTypeCommand.js +16 -0
- package/dist-es/commands/StartRecommenderCommand.js +16 -0
- package/dist-es/commands/StopRecommenderCommand.js +16 -0
- package/dist-es/commands/UpdateRecommenderCommand.js +16 -0
- package/dist-es/commands/index.js +15 -0
- package/dist-es/models/enums.js +41 -0
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/pagination/ListDomainObjectTypesPaginator.js +4 -0
- package/dist-es/pagination/ListRecommenderRecipesPaginator.js +4 -0
- package/dist-es/pagination/ListRecommendersPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +792 -84
- package/dist-types/CustomerProfiles.d.ts +106 -0
- package/dist-types/CustomerProfilesClient.d.ts +17 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +10 -0
- package/dist-types/commands/CreateRecommenderCommand.d.ts +109 -0
- package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +1 -0
- package/dist-types/commands/CreateSegmentEstimateCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDomainObjectTypeCommand.d.ts +88 -0
- package/dist-types/commands/DeleteRecommenderCommand.d.ts +88 -0
- package/dist-types/commands/GetDomainCommand.d.ts +7 -0
- package/dist-types/commands/GetDomainObjectTypeCommand.d.ts +105 -0
- package/dist-types/commands/GetIntegrationCommand.d.ts +1 -0
- package/dist-types/commands/GetObjectTypeAttributeStatisticsCommand.d.ts +110 -0
- package/dist-types/commands/GetProfileRecommendationsCommand.d.ts +116 -0
- package/dist-types/commands/GetRecommenderCommand.d.ts +136 -0
- package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +2 -0
- package/dist-types/commands/GetSegmentMembershipCommand.d.ts +1 -0
- package/dist-types/commands/ListAccountIntegrationsCommand.d.ts +1 -0
- package/dist-types/commands/ListDomainObjectTypesCommand.d.ts +102 -0
- package/dist-types/commands/ListIntegrationsCommand.d.ts +1 -0
- package/dist-types/commands/ListObjectTypeAttributeValuesCommand.d.ts +99 -0
- package/dist-types/commands/ListRecommenderRecipesCommand.d.ts +93 -0
- package/dist-types/commands/ListRecommendersCommand.d.ts +133 -0
- package/dist-types/commands/ListSegmentDefinitionsCommand.d.ts +1 -0
- package/dist-types/commands/PutDomainObjectTypeCommand.d.ts +118 -0
- package/dist-types/commands/PutIntegrationCommand.d.ts +5 -3
- package/dist-types/commands/StartRecommenderCommand.d.ts +88 -0
- package/dist-types/commands/StopRecommenderCommand.d.ts +89 -0
- package/dist-types/commands/StopUploadJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCalculatedAttributeDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDomainCommand.d.ts +11 -1
- package/dist-types/commands/UpdateDomainLayoutCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEventTriggerCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +102 -0
- package/dist-types/commands/index.d.ts +15 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +97 -0
- package/dist-types/models/models_0.d.ts +1084 -738
- package/dist-types/models/models_1.d.ts +744 -0
- package/dist-types/pagination/ListDomainObjectTypesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRecommenderRecipesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRecommendersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +74 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +256 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +92 -2
- package/dist-types/ts3.4/commands/CreateRecommenderCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteDomainObjectTypeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommenderCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDomainObjectTypeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetObjectTypeAttributeStatisticsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetProfileRecommendationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommenderCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListDomainObjectTypesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListObjectTypeAttributeValuesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommenderRecipesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommendersCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutDomainObjectTypeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartRecommenderCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StopRecommenderCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/StopUploadJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCalculatedAttributeDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainLayoutCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateEventTriggerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRecommenderCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +15 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +51 -0
- package/dist-types/ts3.4/models/models_0.d.ts +251 -142
- package/dist-types/ts3.4/models/models_1.d.ts +176 -0
- package/dist-types/ts3.4/pagination/ListDomainObjectTypesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecommenderRecipesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecommendersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +74 -0
- package/package.json +1 -1
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
+
import { StartRecommenderRequest, StartRecommenderResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartRecommenderCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartRecommenderCommandInput extends StartRecommenderRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartRecommenderCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartRecommenderCommandOutput extends StartRecommenderResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartRecommenderCommand_base: {
|
|
25
|
+
new (input: StartRecommenderCommandInput): import("@smithy/smithy-client").CommandImpl<StartRecommenderCommandInput, StartRecommenderCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: StartRecommenderCommandInput): import("@smithy/smithy-client").CommandImpl<StartRecommenderCommandInput, StartRecommenderCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, StartRecommenderCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, StartRecommenderCommand } = 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 = { // StartRecommenderRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* RecommenderName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new StartRecommenderCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param StartRecommenderCommandInput - {@link StartRecommenderCommandInput}
|
|
50
|
+
* @returns {@link StartRecommenderCommandOutput}
|
|
51
|
+
* @see {@link StartRecommenderCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link StartRecommenderCommandOutput} 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
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare class StartRecommenderCommand extends StartRecommenderCommand_base {
|
|
77
|
+
/** @internal type navigation helper, not in runtime. */
|
|
78
|
+
protected static __types: {
|
|
79
|
+
api: {
|
|
80
|
+
input: StartRecommenderRequest;
|
|
81
|
+
output: {};
|
|
82
|
+
};
|
|
83
|
+
sdk: {
|
|
84
|
+
input: StartRecommenderCommandInput;
|
|
85
|
+
output: StartRecommenderCommandOutput;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
+
import { StopRecommenderRequest } from "../models/models_0";
|
|
5
|
+
import { StopRecommenderResponse } from "../models/models_1";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link StopRecommenderCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface StopRecommenderCommandInput extends StopRecommenderRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link StopRecommenderCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface StopRecommenderCommandOutput extends StopRecommenderResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const StopRecommenderCommand_base: {
|
|
26
|
+
new (input: StopRecommenderCommandInput): import("@smithy/smithy-client").CommandImpl<StopRecommenderCommandInput, StopRecommenderCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: StopRecommenderCommandInput): import("@smithy/smithy-client").CommandImpl<StopRecommenderCommandInput, StopRecommenderCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CustomerProfilesClient, StopRecommenderCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
36
|
+
* // const { CustomerProfilesClient, StopRecommenderCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
37
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
38
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
39
|
+
* const client = new CustomerProfilesClient(config);
|
|
40
|
+
* const input = { // StopRecommenderRequest
|
|
41
|
+
* DomainName: "STRING_VALUE", // required
|
|
42
|
+
* RecommenderName: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new StopRecommenderCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // {};
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param StopRecommenderCommandInput - {@link StopRecommenderCommandInput}
|
|
51
|
+
* @returns {@link StopRecommenderCommandOutput}
|
|
52
|
+
* @see {@link StopRecommenderCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link StopRecommenderCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link BadRequestException} (client fault)
|
|
60
|
+
* <p>The input you provided is invalid.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>An internal service error occurred.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export declare class StopRecommenderCommand extends StopRecommenderCommand_base {
|
|
78
|
+
/** @internal type navigation helper, not in runtime. */
|
|
79
|
+
protected static __types: {
|
|
80
|
+
api: {
|
|
81
|
+
input: StopRecommenderRequest;
|
|
82
|
+
output: {};
|
|
83
|
+
};
|
|
84
|
+
sdk: {
|
|
85
|
+
input: StopRecommenderCommandInput;
|
|
86
|
+
output: StopRecommenderCommandOutput;
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { StopUploadJobRequest, StopUploadJobResponse } from "../models/
|
|
4
|
+
import { StopUploadJobRequest, StopUploadJobResponse } 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { TagResourceRequest, TagResourceResponse } from "../models/
|
|
4
|
+
import { TagResourceRequest, TagResourceResponse } 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { UntagResourceRequest, UntagResourceResponse } from "../models/
|
|
4
|
+
import { UntagResourceRequest, UntagResourceResponse } 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { UpdateCalculatedAttributeDefinitionRequest, UpdateCalculatedAttributeDefinitionResponse } from "../models/
|
|
4
|
+
import { UpdateCalculatedAttributeDefinitionRequest, UpdateCalculatedAttributeDefinitionResponse } 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { UpdateDomainRequest, UpdateDomainResponse } from "../models/
|
|
4
|
+
import { UpdateDomainRequest, UpdateDomainResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -111,6 +111,9 @@ declare const UpdateDomainCommand_base: {
|
|
|
111
111
|
* },
|
|
112
112
|
* },
|
|
113
113
|
* },
|
|
114
|
+
* DataStore: { // DataStoreRequest
|
|
115
|
+
* Enabled: true || false,
|
|
116
|
+
* },
|
|
114
117
|
* Tags: { // TagMap
|
|
115
118
|
* "<keys>": "STRING_VALUE",
|
|
116
119
|
* },
|
|
@@ -185,6 +188,13 @@ declare const UpdateDomainCommand_base: {
|
|
|
185
188
|
* // },
|
|
186
189
|
* // },
|
|
187
190
|
* // },
|
|
191
|
+
* // DataStore: { // DataStoreResponse
|
|
192
|
+
* // Enabled: true || false,
|
|
193
|
+
* // Readiness: { // Readiness
|
|
194
|
+
* // ProgressPercentage: Number("int"),
|
|
195
|
+
* // Message: "STRING_VALUE",
|
|
196
|
+
* // },
|
|
197
|
+
* // },
|
|
188
198
|
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
189
199
|
* // LastUpdatedAt: new Date("TIMESTAMP"), // required
|
|
190
200
|
* // Tags: { // TagMap
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { UpdateDomainLayoutRequest, UpdateDomainLayoutResponse } from "../models/
|
|
4
|
+
import { UpdateDomainLayoutRequest, UpdateDomainLayoutResponse } 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { UpdateEventTriggerRequest, UpdateEventTriggerResponse } from "../models/
|
|
4
|
+
import { UpdateEventTriggerRequest, UpdateEventTriggerResponse } 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
-
import { UpdateProfileRequest, UpdateProfileResponse } from "../models/
|
|
4
|
+
import { UpdateProfileRequest, UpdateProfileResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
|
|
4
|
+
import { UpdateRecommenderRequest, UpdateRecommenderResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateRecommenderCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateRecommenderCommandInput extends UpdateRecommenderRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateRecommenderCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateRecommenderCommandOutput extends UpdateRecommenderResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateRecommenderCommand_base: {
|
|
25
|
+
new (input: UpdateRecommenderCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateRecommenderCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the properties of an existing recommender, allowing you to modify its configuration and description.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, UpdateRecommenderCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, UpdateRecommenderCommand } = 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 = { // UpdateRecommenderRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* RecommenderName: "STRING_VALUE", // required
|
|
42
|
+
* Description: "STRING_VALUE",
|
|
43
|
+
* RecommenderConfig: { // RecommenderConfig
|
|
44
|
+
* EventsConfig: { // EventsConfig
|
|
45
|
+
* EventParametersList: [ // EventParametersList // required
|
|
46
|
+
* { // EventParameters
|
|
47
|
+
* EventType: "STRING_VALUE", // required
|
|
48
|
+
* EventValueThreshold: Number("double"),
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
51
|
+
* },
|
|
52
|
+
* TrainingFrequency: Number("int"),
|
|
53
|
+
* },
|
|
54
|
+
* };
|
|
55
|
+
* const command = new UpdateRecommenderCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* // { // UpdateRecommenderResponse
|
|
58
|
+
* // RecommenderName: "STRING_VALUE", // required
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param UpdateRecommenderCommandInput - {@link UpdateRecommenderCommandInput}
|
|
64
|
+
* @returns {@link UpdateRecommenderCommandOutput}
|
|
65
|
+
* @see {@link UpdateRecommenderCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link UpdateRecommenderCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link BadRequestException} (client fault)
|
|
73
|
+
* <p>The input you provided is invalid.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServerException} (server fault)
|
|
76
|
+
* <p>An internal service error occurred.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class UpdateRecommenderCommand extends UpdateRecommenderCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: UpdateRecommenderRequest;
|
|
95
|
+
output: UpdateRecommenderResponse;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: UpdateRecommenderCommandInput;
|
|
99
|
+
output: UpdateRecommenderCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -8,6 +8,7 @@ export * from "./CreateEventStreamCommand";
|
|
|
8
8
|
export * from "./CreateEventTriggerCommand";
|
|
9
9
|
export * from "./CreateIntegrationWorkflowCommand";
|
|
10
10
|
export * from "./CreateProfileCommand";
|
|
11
|
+
export * from "./CreateRecommenderCommand";
|
|
11
12
|
export * from "./CreateSegmentDefinitionCommand";
|
|
12
13
|
export * from "./CreateSegmentEstimateCommand";
|
|
13
14
|
export * from "./CreateSegmentSnapshotCommand";
|
|
@@ -15,6 +16,7 @@ export * from "./CreateUploadJobCommand";
|
|
|
15
16
|
export * from "./DeleteCalculatedAttributeDefinitionCommand";
|
|
16
17
|
export * from "./DeleteDomainCommand";
|
|
17
18
|
export * from "./DeleteDomainLayoutCommand";
|
|
19
|
+
export * from "./DeleteDomainObjectTypeCommand";
|
|
18
20
|
export * from "./DeleteEventStreamCommand";
|
|
19
21
|
export * from "./DeleteEventTriggerCommand";
|
|
20
22
|
export * from "./DeleteIntegrationCommand";
|
|
@@ -22,6 +24,7 @@ export * from "./DeleteProfileCommand";
|
|
|
22
24
|
export * from "./DeleteProfileKeyCommand";
|
|
23
25
|
export * from "./DeleteProfileObjectCommand";
|
|
24
26
|
export * from "./DeleteProfileObjectTypeCommand";
|
|
27
|
+
export * from "./DeleteRecommenderCommand";
|
|
25
28
|
export * from "./DeleteSegmentDefinitionCommand";
|
|
26
29
|
export * from "./DeleteWorkflowCommand";
|
|
27
30
|
export * from "./DetectProfileObjectTypeCommand";
|
|
@@ -30,14 +33,18 @@ export * from "./GetCalculatedAttributeDefinitionCommand";
|
|
|
30
33
|
export * from "./GetCalculatedAttributeForProfileCommand";
|
|
31
34
|
export * from "./GetDomainCommand";
|
|
32
35
|
export * from "./GetDomainLayoutCommand";
|
|
36
|
+
export * from "./GetDomainObjectTypeCommand";
|
|
33
37
|
export * from "./GetEventStreamCommand";
|
|
34
38
|
export * from "./GetEventTriggerCommand";
|
|
35
39
|
export * from "./GetIdentityResolutionJobCommand";
|
|
36
40
|
export * from "./GetIntegrationCommand";
|
|
37
41
|
export * from "./GetMatchesCommand";
|
|
42
|
+
export * from "./GetObjectTypeAttributeStatisticsCommand";
|
|
38
43
|
export * from "./GetProfileHistoryRecordCommand";
|
|
39
44
|
export * from "./GetProfileObjectTypeCommand";
|
|
40
45
|
export * from "./GetProfileObjectTypeTemplateCommand";
|
|
46
|
+
export * from "./GetProfileRecommendationsCommand";
|
|
47
|
+
export * from "./GetRecommenderCommand";
|
|
41
48
|
export * from "./GetSegmentDefinitionCommand";
|
|
42
49
|
export * from "./GetSegmentEstimateCommand";
|
|
43
50
|
export * from "./GetSegmentMembershipCommand";
|
|
@@ -51,28 +58,35 @@ export * from "./ListAccountIntegrationsCommand";
|
|
|
51
58
|
export * from "./ListCalculatedAttributeDefinitionsCommand";
|
|
52
59
|
export * from "./ListCalculatedAttributesForProfileCommand";
|
|
53
60
|
export * from "./ListDomainLayoutsCommand";
|
|
61
|
+
export * from "./ListDomainObjectTypesCommand";
|
|
54
62
|
export * from "./ListDomainsCommand";
|
|
55
63
|
export * from "./ListEventStreamsCommand";
|
|
56
64
|
export * from "./ListEventTriggersCommand";
|
|
57
65
|
export * from "./ListIdentityResolutionJobsCommand";
|
|
58
66
|
export * from "./ListIntegrationsCommand";
|
|
67
|
+
export * from "./ListObjectTypeAttributeValuesCommand";
|
|
59
68
|
export * from "./ListObjectTypeAttributesCommand";
|
|
60
69
|
export * from "./ListProfileAttributeValuesCommand";
|
|
61
70
|
export * from "./ListProfileHistoryRecordsCommand";
|
|
62
71
|
export * from "./ListProfileObjectTypeTemplatesCommand";
|
|
63
72
|
export * from "./ListProfileObjectTypesCommand";
|
|
64
73
|
export * from "./ListProfileObjectsCommand";
|
|
74
|
+
export * from "./ListRecommenderRecipesCommand";
|
|
75
|
+
export * from "./ListRecommendersCommand";
|
|
65
76
|
export * from "./ListRuleBasedMatchesCommand";
|
|
66
77
|
export * from "./ListSegmentDefinitionsCommand";
|
|
67
78
|
export * from "./ListTagsForResourceCommand";
|
|
68
79
|
export * from "./ListUploadJobsCommand";
|
|
69
80
|
export * from "./ListWorkflowsCommand";
|
|
70
81
|
export * from "./MergeProfilesCommand";
|
|
82
|
+
export * from "./PutDomainObjectTypeCommand";
|
|
71
83
|
export * from "./PutIntegrationCommand";
|
|
72
84
|
export * from "./PutProfileObjectCommand";
|
|
73
85
|
export * from "./PutProfileObjectTypeCommand";
|
|
74
86
|
export * from "./SearchProfilesCommand";
|
|
87
|
+
export * from "./StartRecommenderCommand";
|
|
75
88
|
export * from "./StartUploadJobCommand";
|
|
89
|
+
export * from "./StopRecommenderCommand";
|
|
76
90
|
export * from "./StopUploadJobCommand";
|
|
77
91
|
export * from "./TagResourceCommand";
|
|
78
92
|
export * from "./UntagResourceCommand";
|
|
@@ -81,3 +95,4 @@ export * from "./UpdateDomainCommand";
|
|
|
81
95
|
export * from "./UpdateDomainLayoutCommand";
|
|
82
96
|
export * from "./UpdateEventTriggerCommand";
|
|
83
97
|
export * from "./UpdateProfileCommand";
|
|
98
|
+
export * from "./UpdateRecommenderCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -31,4 +31,5 @@ export * from "./pagination";
|
|
|
31
31
|
export * from "./models/enums";
|
|
32
32
|
export * from "./models/errors";
|
|
33
33
|
export type * from "./models/models_0";
|
|
34
|
+
export type * from "./models/models_1";
|
|
34
35
|
export { CustomerProfilesServiceException } from "./models/CustomerProfilesServiceException";
|
|
@@ -476,6 +476,18 @@ export declare const Operator: {
|
|
|
476
476
|
* @public
|
|
477
477
|
*/
|
|
478
478
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
479
|
+
/**
|
|
480
|
+
* @public
|
|
481
|
+
* @enum
|
|
482
|
+
*/
|
|
483
|
+
export declare const ContentType: {
|
|
484
|
+
readonly NUMBER: "NUMBER";
|
|
485
|
+
readonly STRING: "STRING";
|
|
486
|
+
};
|
|
487
|
+
/**
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
479
491
|
/**
|
|
480
492
|
* @public
|
|
481
493
|
* @enum
|
|
@@ -599,6 +611,21 @@ export declare const WorkflowType: {
|
|
|
599
611
|
* @public
|
|
600
612
|
*/
|
|
601
613
|
export type WorkflowType = (typeof WorkflowType)[keyof typeof WorkflowType];
|
|
614
|
+
/**
|
|
615
|
+
* @public
|
|
616
|
+
* @enum
|
|
617
|
+
*/
|
|
618
|
+
export declare const RecommenderRecipeName: {
|
|
619
|
+
readonly FREQUENTLY_PAIRED_ITEMS: "frequently-paired-items";
|
|
620
|
+
readonly POPULAR_ITEMS: "popular-items";
|
|
621
|
+
readonly RECOMMENDED_FOR_YOU: "recommended-for-you";
|
|
622
|
+
readonly SIMILAR_ITEMS: "similar-items";
|
|
623
|
+
readonly TRENDING_NOW: "trending-now";
|
|
624
|
+
};
|
|
625
|
+
/**
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
export type RecommenderRecipeName = (typeof RecommenderRecipeName)[keyof typeof RecommenderRecipeName];
|
|
602
629
|
/**
|
|
603
630
|
* @public
|
|
604
631
|
* @enum
|
|
@@ -695,6 +722,18 @@ export declare const StandardIdentifier: {
|
|
|
695
722
|
* @public
|
|
696
723
|
*/
|
|
697
724
|
export type StandardIdentifier = (typeof StandardIdentifier)[keyof typeof StandardIdentifier];
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* @enum
|
|
728
|
+
*/
|
|
729
|
+
export declare const FeatureType: {
|
|
730
|
+
readonly CATEGORICAL: "CATEGORICAL";
|
|
731
|
+
readonly TEXTUAL: "TEXTUAL";
|
|
732
|
+
};
|
|
733
|
+
/**
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
|
|
698
737
|
/**
|
|
699
738
|
* @public
|
|
700
739
|
* @enum
|
|
@@ -736,6 +775,64 @@ export declare const IdentityResolutionJobStatus: {
|
|
|
736
775
|
* @public
|
|
737
776
|
*/
|
|
738
777
|
export type IdentityResolutionJobStatus = (typeof IdentityResolutionJobStatus)[keyof typeof IdentityResolutionJobStatus];
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
* @enum
|
|
781
|
+
*/
|
|
782
|
+
export declare const Scope: {
|
|
783
|
+
readonly DOMAIN: "DOMAIN";
|
|
784
|
+
readonly PROFILE: "PROFILE";
|
|
785
|
+
};
|
|
786
|
+
/**
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
export type Scope = (typeof Scope)[keyof typeof Scope];
|
|
790
|
+
/**
|
|
791
|
+
* @public
|
|
792
|
+
* @enum
|
|
793
|
+
*/
|
|
794
|
+
export declare const RecommenderStatus: {
|
|
795
|
+
readonly ACTIVE: "ACTIVE";
|
|
796
|
+
readonly DELETING: "DELETING";
|
|
797
|
+
readonly FAILED: "FAILED";
|
|
798
|
+
readonly INACTIVE: "INACTIVE";
|
|
799
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
800
|
+
readonly PENDING: "PENDING";
|
|
801
|
+
readonly STARTING: "STARTING";
|
|
802
|
+
readonly STOPPING: "STOPPING";
|
|
803
|
+
};
|
|
804
|
+
/**
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
export type RecommenderStatus = (typeof RecommenderStatus)[keyof typeof RecommenderStatus];
|
|
808
|
+
/**
|
|
809
|
+
* @public
|
|
810
|
+
* @enum
|
|
811
|
+
*/
|
|
812
|
+
export declare const TrainingMetricName: {
|
|
813
|
+
readonly COVERAGE: "coverage";
|
|
814
|
+
readonly FRESHNESS: "freshness";
|
|
815
|
+
readonly HIT: "hit";
|
|
816
|
+
readonly POPULARITY: "popularity";
|
|
817
|
+
readonly RECALL: "recall";
|
|
818
|
+
readonly SIMILARITY: "similarity";
|
|
819
|
+
};
|
|
820
|
+
/**
|
|
821
|
+
* @public
|
|
822
|
+
*/
|
|
823
|
+
export type TrainingMetricName = (typeof TrainingMetricName)[keyof typeof TrainingMetricName];
|
|
824
|
+
/**
|
|
825
|
+
* @public
|
|
826
|
+
* @enum
|
|
827
|
+
*/
|
|
828
|
+
export declare const SegmentType: {
|
|
829
|
+
readonly CLASSIC: "CLASSIC";
|
|
830
|
+
readonly ENHANCED: "ENHANCED";
|
|
831
|
+
};
|
|
832
|
+
/**
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
export type SegmentType = (typeof SegmentType)[keyof typeof SegmentType];
|
|
739
836
|
/**
|
|
740
837
|
* @public
|
|
741
838
|
* @enum
|