@aws-sdk/client-customer-profiles 3.940.0 → 3.943.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 +5 -5
|
@@ -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 { ListDomainObjectTypesRequest, ListDomainObjectTypesResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListDomainObjectTypesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListDomainObjectTypesCommandInput extends ListDomainObjectTypesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListDomainObjectTypesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListDomainObjectTypesCommandOutput extends ListDomainObjectTypesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListDomainObjectTypesCommand_base: {
|
|
25
|
+
new (input: ListDomainObjectTypesCommandInput): import("@smithy/smithy-client").CommandImpl<ListDomainObjectTypesCommandInput, ListDomainObjectTypesCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListDomainObjectTypesCommandInput): import("@smithy/smithy-client").CommandImpl<ListDomainObjectTypesCommandInput, ListDomainObjectTypesCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>List all DomainObjectType(s) in a Customer Profiles 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, ListDomainObjectTypesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, ListDomainObjectTypesCommand } = 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 = { // ListDomainObjectTypesRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListDomainObjectTypesCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListDomainObjectTypesResponse
|
|
47
|
+
* // Items: [ // DomainObjectTypesList
|
|
48
|
+
* // { // DomainObjectTypesListItem
|
|
49
|
+
* // ObjectTypeName: "STRING_VALUE", // required
|
|
50
|
+
* // Description: "STRING_VALUE",
|
|
51
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
52
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
53
|
+
* // Tags: { // TagMap
|
|
54
|
+
* // "<keys>": "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // NextToken: "STRING_VALUE",
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param ListDomainObjectTypesCommandInput - {@link ListDomainObjectTypesCommandInput}
|
|
64
|
+
* @returns {@link ListDomainObjectTypesCommandOutput}
|
|
65
|
+
* @see {@link ListDomainObjectTypesCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link ListDomainObjectTypesCommandOutput} 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 ListDomainObjectTypesCommand extends ListDomainObjectTypesCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: ListDomainObjectTypesRequest;
|
|
95
|
+
output: ListDomainObjectTypesResponse;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: ListDomainObjectTypesCommandInput;
|
|
99
|
+
output: ListDomainObjectTypesCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
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 { ListObjectTypeAttributeValuesRequest, ListObjectTypeAttributeValuesResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListObjectTypeAttributeValuesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListObjectTypeAttributeValuesCommandInput extends ListObjectTypeAttributeValuesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListObjectTypeAttributeValuesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListObjectTypeAttributeValuesCommandOutput extends ListObjectTypeAttributeValuesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListObjectTypeAttributeValuesCommand_base: {
|
|
25
|
+
new (input: ListObjectTypeAttributeValuesCommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectTypeAttributeValuesCommandInput, ListObjectTypeAttributeValuesCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListObjectTypeAttributeValuesCommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectTypeAttributeValuesCommandInput, ListObjectTypeAttributeValuesCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, ListObjectTypeAttributeValuesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, ListObjectTypeAttributeValuesCommand } = 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 = { // ListObjectTypeAttributeValuesRequest
|
|
40
|
+
* NextToken: "STRING_VALUE",
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* DomainName: "STRING_VALUE", // required
|
|
43
|
+
* ObjectTypeName: "STRING_VALUE", // required
|
|
44
|
+
* AttributeName: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListObjectTypeAttributeValuesCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListObjectTypeAttributeValuesResponse
|
|
49
|
+
* // Items: [ // ListObjectTypeAttributeValuesList
|
|
50
|
+
* // { // ListObjectTypeAttributeValuesItem
|
|
51
|
+
* // Value: "STRING_VALUE", // required
|
|
52
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListObjectTypeAttributeValuesCommandInput - {@link ListObjectTypeAttributeValuesCommandInput}
|
|
61
|
+
* @returns {@link ListObjectTypeAttributeValuesCommandOutput}
|
|
62
|
+
* @see {@link ListObjectTypeAttributeValuesCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListObjectTypeAttributeValuesCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link BadRequestException} (client fault)
|
|
70
|
+
* <p>The input you provided is invalid.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>An internal service error occurred.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export declare class ListObjectTypeAttributeValuesCommand extends ListObjectTypeAttributeValuesCommand_base {
|
|
88
|
+
/** @internal type navigation helper, not in runtime. */
|
|
89
|
+
protected static __types: {
|
|
90
|
+
api: {
|
|
91
|
+
input: ListObjectTypeAttributeValuesRequest;
|
|
92
|
+
output: ListObjectTypeAttributeValuesResponse;
|
|
93
|
+
};
|
|
94
|
+
sdk: {
|
|
95
|
+
input: ListObjectTypeAttributeValuesCommandInput;
|
|
96
|
+
output: ListObjectTypeAttributeValuesCommandOutput;
|
|
97
|
+
};
|
|
98
|
+
};
|
|
99
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
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 { ListRecommenderRecipesRequest, ListRecommenderRecipesResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListRecommenderRecipesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListRecommenderRecipesCommandInput extends ListRecommenderRecipesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListRecommenderRecipesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListRecommenderRecipesCommandOutput extends ListRecommenderRecipesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListRecommenderRecipesCommand_base: {
|
|
25
|
+
new (input: ListRecommenderRecipesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRecommenderRecipesCommandInput, ListRecommenderRecipesCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListRecommenderRecipesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListRecommenderRecipesCommandInput, ListRecommenderRecipesCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of available recommender recipes that can be used to create recommenders.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CustomerProfilesClient, ListRecommenderRecipesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, ListRecommenderRecipesCommand } = 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 = { // ListRecommenderRecipesRequest
|
|
40
|
+
* MaxResults: Number("int"),
|
|
41
|
+
* NextToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListRecommenderRecipesCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListRecommenderRecipesResponse
|
|
46
|
+
* // NextToken: "STRING_VALUE",
|
|
47
|
+
* // RecommenderRecipes: [ // RecommenderRecipesList
|
|
48
|
+
* // { // RecommenderRecipe
|
|
49
|
+
* // name: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now",
|
|
50
|
+
* // description: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param ListRecommenderRecipesCommandInput - {@link ListRecommenderRecipesCommandInput}
|
|
58
|
+
* @returns {@link ListRecommenderRecipesCommandOutput}
|
|
59
|
+
* @see {@link ListRecommenderRecipesCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link ListRecommenderRecipesCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link BadRequestException} (client fault)
|
|
67
|
+
* <p>The input you provided is invalid.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>An internal service error occurred.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class ListRecommenderRecipesCommand extends ListRecommenderRecipesCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: ListRecommenderRecipesRequest;
|
|
86
|
+
output: ListRecommenderRecipesResponse;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: ListRecommenderRecipesCommandInput;
|
|
90
|
+
output: ListRecommenderRecipesCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -0,0 +1,133 @@
|
|
|
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 { ListRecommendersRequest, ListRecommendersResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListRecommendersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListRecommendersCommandInput extends ListRecommendersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListRecommendersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListRecommendersCommandOutput extends ListRecommendersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListRecommendersCommand_base: {
|
|
25
|
+
new (input: ListRecommendersCommandInput): import("@smithy/smithy-client").CommandImpl<ListRecommendersCommandInput, ListRecommendersCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListRecommendersCommandInput): import("@smithy/smithy-client").CommandImpl<ListRecommendersCommandInput, ListRecommendersCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of recommenders 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, ListRecommendersCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, ListRecommendersCommand } = 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 = { // ListRecommendersRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListRecommendersCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListRecommendersResponse
|
|
47
|
+
* // NextToken: "STRING_VALUE",
|
|
48
|
+
* // Recommenders: [ // RecommenderSummaryList
|
|
49
|
+
* // { // RecommenderSummary
|
|
50
|
+
* // RecommenderName: "STRING_VALUE",
|
|
51
|
+
* // RecipeName: "recommended-for-you" || "similar-items" || "frequently-paired-items" || "popular-items" || "trending-now",
|
|
52
|
+
* // RecommenderConfig: { // RecommenderConfig
|
|
53
|
+
* // EventsConfig: { // EventsConfig
|
|
54
|
+
* // EventParametersList: [ // EventParametersList // required
|
|
55
|
+
* // { // EventParameters
|
|
56
|
+
* // EventType: "STRING_VALUE", // required
|
|
57
|
+
* // EventValueThreshold: Number("double"),
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // TrainingFrequency: Number("int"),
|
|
62
|
+
* // },
|
|
63
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
64
|
+
* // Description: "STRING_VALUE",
|
|
65
|
+
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
|
|
66
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
67
|
+
* // Tags: { // TagMap
|
|
68
|
+
* // "<keys>": "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // FailureReason: "STRING_VALUE",
|
|
71
|
+
* // LatestRecommenderUpdate: { // RecommenderUpdate
|
|
72
|
+
* // RecommenderConfig: {
|
|
73
|
+
* // EventsConfig: {
|
|
74
|
+
* // EventParametersList: [ // required
|
|
75
|
+
* // {
|
|
76
|
+
* // EventType: "STRING_VALUE", // required
|
|
77
|
+
* // EventValueThreshold: Number("double"),
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // },
|
|
81
|
+
* // TrainingFrequency: Number("int"),
|
|
82
|
+
* // },
|
|
83
|
+
* // Status: "PENDING" || "IN_PROGRESS" || "ACTIVE" || "FAILED" || "STOPPING" || "INACTIVE" || "STARTING" || "DELETING",
|
|
84
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
85
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
86
|
+
* // FailureReason: "STRING_VALUE",
|
|
87
|
+
* // },
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // };
|
|
91
|
+
*
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* @param ListRecommendersCommandInput - {@link ListRecommendersCommandInput}
|
|
95
|
+
* @returns {@link ListRecommendersCommandOutput}
|
|
96
|
+
* @see {@link ListRecommendersCommandInput} for command's `input` shape.
|
|
97
|
+
* @see {@link ListRecommendersCommandOutput} for command's `response` shape.
|
|
98
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
101
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link BadRequestException} (client fault)
|
|
104
|
+
* <p>The input you provided is invalid.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InternalServerException} (server fault)
|
|
107
|
+
* <p>An internal service error occurred.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
110
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
113
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
116
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
117
|
+
*
|
|
118
|
+
*
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
export declare class ListRecommendersCommand extends ListRecommendersCommand_base {
|
|
122
|
+
/** @internal type navigation helper, not in runtime. */
|
|
123
|
+
protected static __types: {
|
|
124
|
+
api: {
|
|
125
|
+
input: ListRecommendersRequest;
|
|
126
|
+
output: ListRecommendersResponse;
|
|
127
|
+
};
|
|
128
|
+
sdk: {
|
|
129
|
+
input: ListRecommendersCommandInput;
|
|
130
|
+
output: ListRecommendersCommandOutput;
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
}
|
|
@@ -0,0 +1,118 @@
|
|
|
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 { PutDomainObjectTypeRequest, PutDomainObjectTypeResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutDomainObjectTypeCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutDomainObjectTypeCommandInput extends PutDomainObjectTypeRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutDomainObjectTypeCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutDomainObjectTypeCommandOutput extends PutDomainObjectTypeResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutDomainObjectTypeCommand_base: {
|
|
25
|
+
new (input: PutDomainObjectTypeCommandInput): import("@smithy/smithy-client").CommandImpl<PutDomainObjectTypeCommandInput, PutDomainObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutDomainObjectTypeCommandInput): import("@smithy/smithy-client").CommandImpl<PutDomainObjectTypeCommandInput, PutDomainObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the 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, PutDomainObjectTypeCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
35
|
+
* // const { CustomerProfilesClient, PutDomainObjectTypeCommand } = 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 = { // PutDomainObjectTypeRequest
|
|
40
|
+
* DomainName: "STRING_VALUE", // required
|
|
41
|
+
* ObjectTypeName: "STRING_VALUE", // required
|
|
42
|
+
* Description: "STRING_VALUE",
|
|
43
|
+
* EncryptionKey: "STRING_VALUE",
|
|
44
|
+
* Fields: { // DomainObjectTypeFields // required
|
|
45
|
+
* "<keys>": { // DomainObjectTypeField
|
|
46
|
+
* Source: "STRING_VALUE", // required
|
|
47
|
+
* Target: "STRING_VALUE", // required
|
|
48
|
+
* ContentType: "STRING" || "NUMBER",
|
|
49
|
+
* FeatureType: "TEXTUAL" || "CATEGORICAL",
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* Tags: { // TagMap
|
|
53
|
+
* "<keys>": "STRING_VALUE",
|
|
54
|
+
* },
|
|
55
|
+
* };
|
|
56
|
+
* const command = new PutDomainObjectTypeCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* // { // PutDomainObjectTypeResponse
|
|
59
|
+
* // ObjectTypeName: "STRING_VALUE",
|
|
60
|
+
* // Description: "STRING_VALUE",
|
|
61
|
+
* // EncryptionKey: "STRING_VALUE",
|
|
62
|
+
* // Fields: { // DomainObjectTypeFields
|
|
63
|
+
* // "<keys>": { // DomainObjectTypeField
|
|
64
|
+
* // Source: "STRING_VALUE", // required
|
|
65
|
+
* // Target: "STRING_VALUE", // required
|
|
66
|
+
* // ContentType: "STRING" || "NUMBER",
|
|
67
|
+
* // FeatureType: "TEXTUAL" || "CATEGORICAL",
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
71
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
72
|
+
* // Tags: { // TagMap
|
|
73
|
+
* // "<keys>": "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @param PutDomainObjectTypeCommandInput - {@link PutDomainObjectTypeCommandInput}
|
|
80
|
+
* @returns {@link PutDomainObjectTypeCommandOutput}
|
|
81
|
+
* @see {@link PutDomainObjectTypeCommandInput} for command's `input` shape.
|
|
82
|
+
* @see {@link PutDomainObjectTypeCommandOutput} for command's `response` shape.
|
|
83
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
86
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link BadRequestException} (client fault)
|
|
89
|
+
* <p>The input you provided is invalid.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link InternalServerException} (server fault)
|
|
92
|
+
* <p>An internal service error occurred.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
95
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
98
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
101
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
102
|
+
*
|
|
103
|
+
*
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export declare class PutDomainObjectTypeCommand extends PutDomainObjectTypeCommand_base {
|
|
107
|
+
/** @internal type navigation helper, not in runtime. */
|
|
108
|
+
protected static __types: {
|
|
109
|
+
api: {
|
|
110
|
+
input: PutDomainObjectTypeRequest;
|
|
111
|
+
output: PutDomainObjectTypeResponse;
|
|
112
|
+
};
|
|
113
|
+
sdk: {
|
|
114
|
+
input: PutDomainObjectTypeCommandInput;
|
|
115
|
+
output: PutDomainObjectTypeCommandOutput;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
}
|
|
@@ -45,6 +45,9 @@ declare const PutIntegrationCommand_base: {
|
|
|
45
45
|
* DomainName: "STRING_VALUE", // required
|
|
46
46
|
* Uri: "STRING_VALUE",
|
|
47
47
|
* ObjectTypeName: "STRING_VALUE",
|
|
48
|
+
* ObjectTypeNames: { // ObjectTypeNames
|
|
49
|
+
* "<keys>": "STRING_VALUE",
|
|
50
|
+
* },
|
|
48
51
|
* Tags: { // TagMap
|
|
49
52
|
* "<keys>": "STRING_VALUE",
|
|
50
53
|
* },
|
|
@@ -113,13 +116,11 @@ declare const PutIntegrationCommand_base: {
|
|
|
113
116
|
* },
|
|
114
117
|
* },
|
|
115
118
|
* },
|
|
116
|
-
* ObjectTypeNames: { // ObjectTypeNames
|
|
117
|
-
* "<keys>": "STRING_VALUE",
|
|
118
|
-
* },
|
|
119
119
|
* RoleArn: "STRING_VALUE",
|
|
120
120
|
* EventTriggerNames: [ // EventTriggerNames
|
|
121
121
|
* "STRING_VALUE",
|
|
122
122
|
* ],
|
|
123
|
+
* Scope: "PROFILE" || "DOMAIN",
|
|
123
124
|
* };
|
|
124
125
|
* const command = new PutIntegrationCommand(input);
|
|
125
126
|
* const response = await client.send(command);
|
|
@@ -141,6 +142,7 @@ declare const PutIntegrationCommand_base: {
|
|
|
141
142
|
* // EventTriggerNames: [ // EventTriggerNames
|
|
142
143
|
* // "STRING_VALUE",
|
|
143
144
|
* // ],
|
|
145
|
+
* // Scope: "PROFILE" || "DOMAIN",
|
|
144
146
|
* // };
|
|
145
147
|
*
|
|
146
148
|
* ```
|