@aws-sdk/client-customer-profiles 3.693.0 → 3.696.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.
Files changed (77) hide show
  1. package/README.md +104 -0
  2. package/dist-cjs/index.js +1265 -46
  3. package/dist-es/CustomerProfiles.js +26 -0
  4. package/dist-es/commands/BatchGetCalculatedAttributeForProfileCommand.js +23 -0
  5. package/dist-es/commands/BatchGetProfileCommand.js +23 -0
  6. package/dist-es/commands/CreateSegmentDefinitionCommand.js +23 -0
  7. package/dist-es/commands/CreateSegmentEstimateCommand.js +23 -0
  8. package/dist-es/commands/CreateSegmentSnapshotCommand.js +22 -0
  9. package/dist-es/commands/DeleteSegmentDefinitionCommand.js +22 -0
  10. package/dist-es/commands/GetSegmentDefinitionCommand.js +23 -0
  11. package/dist-es/commands/GetSegmentEstimateCommand.js +22 -0
  12. package/dist-es/commands/GetSegmentMembershipCommand.js +23 -0
  13. package/dist-es/commands/GetSegmentSnapshotCommand.js +22 -0
  14. package/dist-es/commands/ListObjectTypeAttributesCommand.js +22 -0
  15. package/dist-es/commands/ListProfileAttributeValuesCommand.js +22 -0
  16. package/dist-es/commands/ListSegmentDefinitionsCommand.js +23 -0
  17. package/dist-es/commands/index.js +13 -0
  18. package/dist-es/models/models_0.js +208 -34
  19. package/dist-es/pagination/GetSimilarProfilesPaginator.js +4 -0
  20. package/dist-es/pagination/ListObjectTypeAttributesPaginator.js +4 -0
  21. package/dist-es/pagination/ListRuleBasedMatchesPaginator.js +4 -0
  22. package/dist-es/pagination/ListSegmentDefinitionsPaginator.js +4 -0
  23. package/dist-es/pagination/index.js +4 -0
  24. package/dist-es/protocols/Aws_restJson1.js +739 -2
  25. package/dist-types/CustomerProfiles.d.ts +91 -0
  26. package/dist-types/CustomerProfilesClient.d.ts +15 -2
  27. package/dist-types/commands/BatchGetCalculatedAttributeForProfileCommand.d.ts +119 -0
  28. package/dist-types/commands/BatchGetProfileCommand.d.ts +177 -0
  29. package/dist-types/commands/CreateCalculatedAttributeDefinitionCommand.d.ts +40 -0
  30. package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +221 -0
  31. package/dist-types/commands/CreateSegmentEstimateCommand.d.ts +210 -0
  32. package/dist-types/commands/CreateSegmentSnapshotCommand.d.ts +91 -0
  33. package/dist-types/commands/DeleteSegmentDefinitionCommand.d.ts +87 -0
  34. package/dist-types/commands/DetectProfileObjectTypeCommand.d.ts +1 -1
  35. package/dist-types/commands/GetCalculatedAttributeDefinitionCommand.d.ts +20 -0
  36. package/dist-types/commands/GetProfileObjectTypeCommand.d.ts +1 -1
  37. package/dist-types/commands/GetProfileObjectTypeTemplateCommand.d.ts +1 -1
  38. package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +216 -0
  39. package/dist-types/commands/GetSegmentEstimateCommand.d.ts +92 -0
  40. package/dist-types/commands/GetSegmentMembershipCommand.d.ts +183 -0
  41. package/dist-types/commands/GetSegmentSnapshotCommand.d.ts +94 -0
  42. package/dist-types/commands/ListObjectTypeAttributesCommand.d.ts +95 -0
  43. package/dist-types/commands/ListProfileAttributeValuesCommand.d.ts +94 -0
  44. package/dist-types/commands/ListSegmentDefinitionsCommand.d.ts +100 -0
  45. package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +2 -2
  46. package/dist-types/commands/index.d.ts +13 -0
  47. package/dist-types/models/models_0.d.ts +2277 -826
  48. package/dist-types/pagination/GetSimilarProfilesPaginator.d.ts +7 -0
  49. package/dist-types/pagination/ListObjectTypeAttributesPaginator.d.ts +7 -0
  50. package/dist-types/pagination/ListRuleBasedMatchesPaginator.d.ts +7 -0
  51. package/dist-types/pagination/ListSegmentDefinitionsPaginator.d.ts +7 -0
  52. package/dist-types/pagination/index.d.ts +4 -0
  53. package/dist-types/protocols/Aws_restJson1.d.ts +117 -0
  54. package/dist-types/ts3.4/CustomerProfiles.d.ts +227 -0
  55. package/dist-types/ts3.4/CustomerProfilesClient.d.ts +78 -0
  56. package/dist-types/ts3.4/commands/BatchGetCalculatedAttributeForProfileCommand.d.ts +51 -0
  57. package/dist-types/ts3.4/commands/BatchGetProfileCommand.d.ts +50 -0
  58. package/dist-types/ts3.4/commands/CreateSegmentDefinitionCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/CreateSegmentEstimateCommand.d.ts +51 -0
  60. package/dist-types/ts3.4/commands/CreateSegmentSnapshotCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/DeleteSegmentDefinitionCommand.d.ts +51 -0
  62. package/dist-types/ts3.4/commands/GetSegmentDefinitionCommand.d.ts +51 -0
  63. package/dist-types/ts3.4/commands/GetSegmentEstimateCommand.d.ts +51 -0
  64. package/dist-types/ts3.4/commands/GetSegmentMembershipCommand.d.ts +51 -0
  65. package/dist-types/ts3.4/commands/GetSegmentSnapshotCommand.d.ts +51 -0
  66. package/dist-types/ts3.4/commands/ListObjectTypeAttributesCommand.d.ts +51 -0
  67. package/dist-types/ts3.4/commands/ListProfileAttributeValuesCommand.d.ts +51 -0
  68. package/dist-types/ts3.4/commands/ListSegmentDefinitionsCommand.d.ts +51 -0
  69. package/dist-types/ts3.4/commands/index.d.ts +13 -0
  70. package/dist-types/ts3.4/models/models_0.d.ts +503 -44
  71. package/dist-types/ts3.4/pagination/GetSimilarProfilesPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/ListObjectTypeAttributesPaginator.d.ts +11 -0
  73. package/dist-types/ts3.4/pagination/ListRuleBasedMatchesPaginator.d.ts +11 -0
  74. package/dist-types/ts3.4/pagination/ListSegmentDefinitionsPaginator.d.ts +11 -0
  75. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  76. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +156 -0
  77. package/package.json +35 -35
@@ -0,0 +1,221 @@
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 { CreateSegmentDefinitionRequest, CreateSegmentDefinitionResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateSegmentDefinitionCommand}.
14
+ */
15
+ export interface CreateSegmentDefinitionCommandInput extends CreateSegmentDefinitionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateSegmentDefinitionCommand}.
21
+ */
22
+ export interface CreateSegmentDefinitionCommandOutput extends CreateSegmentDefinitionResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateSegmentDefinitionCommand_base: {
25
+ new (input: CreateSegmentDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSegmentDefinitionCommandInput, CreateSegmentDefinitionCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateSegmentDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSegmentDefinitionCommandInput, CreateSegmentDefinitionCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a segment definition associated to the given 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, CreateSegmentDefinitionCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
35
+ * // const { CustomerProfilesClient, CreateSegmentDefinitionCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
36
+ * const client = new CustomerProfilesClient(config);
37
+ * const input = { // CreateSegmentDefinitionRequest
38
+ * DomainName: "STRING_VALUE", // required
39
+ * SegmentDefinitionName: "STRING_VALUE", // required
40
+ * DisplayName: "STRING_VALUE", // required
41
+ * Description: "STRING_VALUE",
42
+ * SegmentGroups: { // SegmentGroup
43
+ * Groups: [ // SegmentGroupList
44
+ * { // Group
45
+ * Dimensions: [ // DimensionList
46
+ * { // Dimension Union: only one key present
47
+ * ProfileAttributes: { // ProfileAttributes
48
+ * AccountNumber: { // ProfileDimension
49
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
50
+ * Values: [ // Values // required
51
+ * "STRING_VALUE",
52
+ * ],
53
+ * },
54
+ * AdditionalInformation: { // ExtraLengthValueProfileDimension
55
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
56
+ * Values: [ // ExtraLengthValues // required
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
60
+ * FirstName: {
61
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
62
+ * Values: [ // required
63
+ * "STRING_VALUE",
64
+ * ],
65
+ * },
66
+ * LastName: {
67
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
68
+ * Values: [ // required
69
+ * "STRING_VALUE",
70
+ * ],
71
+ * },
72
+ * MiddleName: {
73
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
74
+ * Values: [ // required
75
+ * "STRING_VALUE",
76
+ * ],
77
+ * },
78
+ * GenderString: {
79
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
80
+ * Values: [ // required
81
+ * "STRING_VALUE",
82
+ * ],
83
+ * },
84
+ * PartyTypeString: "<ProfileDimension>",
85
+ * BirthDate: { // DateDimension
86
+ * DimensionType: "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON", // required
87
+ * Values: [ // DateValues // required
88
+ * "STRING_VALUE",
89
+ * ],
90
+ * },
91
+ * PhoneNumber: "<ProfileDimension>",
92
+ * BusinessName: "<ProfileDimension>",
93
+ * BusinessPhoneNumber: "<ProfileDimension>",
94
+ * HomePhoneNumber: "<ProfileDimension>",
95
+ * MobilePhoneNumber: "<ProfileDimension>",
96
+ * EmailAddress: "<ProfileDimension>",
97
+ * PersonalEmailAddress: "<ProfileDimension>",
98
+ * BusinessEmailAddress: "<ProfileDimension>",
99
+ * Address: { // AddressDimension
100
+ * City: "<ProfileDimension>",
101
+ * Country: "<ProfileDimension>",
102
+ * County: "<ProfileDimension>",
103
+ * PostalCode: "<ProfileDimension>",
104
+ * Province: "<ProfileDimension>",
105
+ * State: "<ProfileDimension>",
106
+ * },
107
+ * ShippingAddress: {
108
+ * City: "<ProfileDimension>",
109
+ * Country: "<ProfileDimension>",
110
+ * County: "<ProfileDimension>",
111
+ * PostalCode: "<ProfileDimension>",
112
+ * Province: "<ProfileDimension>",
113
+ * State: "<ProfileDimension>",
114
+ * },
115
+ * MailingAddress: {
116
+ * City: "<ProfileDimension>",
117
+ * Country: "<ProfileDimension>",
118
+ * County: "<ProfileDimension>",
119
+ * PostalCode: "<ProfileDimension>",
120
+ * Province: "<ProfileDimension>",
121
+ * State: "<ProfileDimension>",
122
+ * },
123
+ * BillingAddress: {
124
+ * City: "<ProfileDimension>",
125
+ * Country: "<ProfileDimension>",
126
+ * County: "<ProfileDimension>",
127
+ * PostalCode: "<ProfileDimension>",
128
+ * Province: "<ProfileDimension>",
129
+ * State: "<ProfileDimension>",
130
+ * },
131
+ * Attributes: { // CustomAttributes
132
+ * "<keys>": { // AttributeDimension
133
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required
134
+ * Values: "<Values>", // required
135
+ * },
136
+ * },
137
+ * },
138
+ * CalculatedAttributes: { // CalculatedCustomAttributes
139
+ * "<keys>": { // CalculatedAttributeDimension
140
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required
141
+ * Values: "<Values>", // required
142
+ * ConditionOverrides: { // ConditionOverrides
143
+ * Range: { // RangeOverride
144
+ * Start: Number("int"), // required
145
+ * End: Number("int"),
146
+ * Unit: "DAYS", // required
147
+ * },
148
+ * },
149
+ * },
150
+ * },
151
+ * },
152
+ * ],
153
+ * SourceSegments: [ // SourceSegmentList
154
+ * { // SourceSegment
155
+ * SegmentDefinitionName: "STRING_VALUE",
156
+ * },
157
+ * ],
158
+ * SourceType: "ALL" || "ANY" || "NONE",
159
+ * Type: "ALL" || "ANY" || "NONE",
160
+ * },
161
+ * ],
162
+ * Include: "ALL" || "ANY" || "NONE",
163
+ * },
164
+ * Tags: { // TagMap
165
+ * "<keys>": "STRING_VALUE",
166
+ * },
167
+ * };
168
+ * const command = new CreateSegmentDefinitionCommand(input);
169
+ * const response = await client.send(command);
170
+ * // { // CreateSegmentDefinitionResponse
171
+ * // SegmentDefinitionName: "STRING_VALUE", // required
172
+ * // DisplayName: "STRING_VALUE",
173
+ * // Description: "STRING_VALUE",
174
+ * // CreatedAt: new Date("TIMESTAMP"),
175
+ * // SegmentDefinitionArn: "STRING_VALUE",
176
+ * // Tags: { // TagMap
177
+ * // "<keys>": "STRING_VALUE",
178
+ * // },
179
+ * // };
180
+ *
181
+ * ```
182
+ *
183
+ * @param CreateSegmentDefinitionCommandInput - {@link CreateSegmentDefinitionCommandInput}
184
+ * @returns {@link CreateSegmentDefinitionCommandOutput}
185
+ * @see {@link CreateSegmentDefinitionCommandInput} for command's `input` shape.
186
+ * @see {@link CreateSegmentDefinitionCommandOutput} for command's `response` shape.
187
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
188
+ *
189
+ * @throws {@link AccessDeniedException} (client fault)
190
+ * <p>You do not have sufficient access to perform this action.</p>
191
+ *
192
+ * @throws {@link BadRequestException} (client fault)
193
+ * <p>The input you provided is invalid.</p>
194
+ *
195
+ * @throws {@link InternalServerException} (server fault)
196
+ * <p>An internal service error occurred.</p>
197
+ *
198
+ * @throws {@link ResourceNotFoundException} (client fault)
199
+ * <p>The requested resource does not exist, or access was denied.</p>
200
+ *
201
+ * @throws {@link ThrottlingException} (client fault)
202
+ * <p>You exceeded the maximum number of requests.</p>
203
+ *
204
+ * @throws {@link CustomerProfilesServiceException}
205
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
206
+ *
207
+ * @public
208
+ */
209
+ export declare class CreateSegmentDefinitionCommand extends CreateSegmentDefinitionCommand_base {
210
+ /** @internal type navigation helper, not in runtime. */
211
+ protected static __types: {
212
+ api: {
213
+ input: CreateSegmentDefinitionRequest;
214
+ output: CreateSegmentDefinitionResponse;
215
+ };
216
+ sdk: {
217
+ input: CreateSegmentDefinitionCommandInput;
218
+ output: CreateSegmentDefinitionCommandOutput;
219
+ };
220
+ };
221
+ }
@@ -0,0 +1,210 @@
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 { CreateSegmentEstimateRequest, CreateSegmentEstimateResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateSegmentEstimateCommand}.
14
+ */
15
+ export interface CreateSegmentEstimateCommandInput extends CreateSegmentEstimateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateSegmentEstimateCommand}.
21
+ */
22
+ export interface CreateSegmentEstimateCommandOutput extends CreateSegmentEstimateResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateSegmentEstimateCommand_base: {
25
+ new (input: CreateSegmentEstimateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSegmentEstimateCommandInput, CreateSegmentEstimateCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateSegmentEstimateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSegmentEstimateCommandInput, CreateSegmentEstimateCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a segment estimate query.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { CustomerProfilesClient, CreateSegmentEstimateCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
35
+ * // const { CustomerProfilesClient, CreateSegmentEstimateCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
36
+ * const client = new CustomerProfilesClient(config);
37
+ * const input = { // CreateSegmentEstimateRequest
38
+ * DomainName: "STRING_VALUE", // required
39
+ * SegmentQuery: { // SegmentGroupStructure
40
+ * Groups: [ // SegmentGroupList
41
+ * { // Group
42
+ * Dimensions: [ // DimensionList
43
+ * { // Dimension Union: only one key present
44
+ * ProfileAttributes: { // ProfileAttributes
45
+ * AccountNumber: { // ProfileDimension
46
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
47
+ * Values: [ // Values // required
48
+ * "STRING_VALUE",
49
+ * ],
50
+ * },
51
+ * AdditionalInformation: { // ExtraLengthValueProfileDimension
52
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
53
+ * Values: [ // ExtraLengthValues // required
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * },
57
+ * FirstName: {
58
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
59
+ * Values: [ // required
60
+ * "STRING_VALUE",
61
+ * ],
62
+ * },
63
+ * LastName: {
64
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
65
+ * Values: [ // required
66
+ * "STRING_VALUE",
67
+ * ],
68
+ * },
69
+ * MiddleName: {
70
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
71
+ * Values: [ // required
72
+ * "STRING_VALUE",
73
+ * ],
74
+ * },
75
+ * GenderString: {
76
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required
77
+ * Values: [ // required
78
+ * "STRING_VALUE",
79
+ * ],
80
+ * },
81
+ * PartyTypeString: "<ProfileDimension>",
82
+ * BirthDate: { // DateDimension
83
+ * DimensionType: "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON", // required
84
+ * Values: [ // DateValues // required
85
+ * "STRING_VALUE",
86
+ * ],
87
+ * },
88
+ * PhoneNumber: "<ProfileDimension>",
89
+ * BusinessName: "<ProfileDimension>",
90
+ * BusinessPhoneNumber: "<ProfileDimension>",
91
+ * HomePhoneNumber: "<ProfileDimension>",
92
+ * MobilePhoneNumber: "<ProfileDimension>",
93
+ * EmailAddress: "<ProfileDimension>",
94
+ * PersonalEmailAddress: "<ProfileDimension>",
95
+ * BusinessEmailAddress: "<ProfileDimension>",
96
+ * Address: { // AddressDimension
97
+ * City: "<ProfileDimension>",
98
+ * Country: "<ProfileDimension>",
99
+ * County: "<ProfileDimension>",
100
+ * PostalCode: "<ProfileDimension>",
101
+ * Province: "<ProfileDimension>",
102
+ * State: "<ProfileDimension>",
103
+ * },
104
+ * ShippingAddress: {
105
+ * City: "<ProfileDimension>",
106
+ * Country: "<ProfileDimension>",
107
+ * County: "<ProfileDimension>",
108
+ * PostalCode: "<ProfileDimension>",
109
+ * Province: "<ProfileDimension>",
110
+ * State: "<ProfileDimension>",
111
+ * },
112
+ * MailingAddress: {
113
+ * City: "<ProfileDimension>",
114
+ * Country: "<ProfileDimension>",
115
+ * County: "<ProfileDimension>",
116
+ * PostalCode: "<ProfileDimension>",
117
+ * Province: "<ProfileDimension>",
118
+ * State: "<ProfileDimension>",
119
+ * },
120
+ * BillingAddress: {
121
+ * City: "<ProfileDimension>",
122
+ * Country: "<ProfileDimension>",
123
+ * County: "<ProfileDimension>",
124
+ * PostalCode: "<ProfileDimension>",
125
+ * Province: "<ProfileDimension>",
126
+ * State: "<ProfileDimension>",
127
+ * },
128
+ * Attributes: { // CustomAttributes
129
+ * "<keys>": { // AttributeDimension
130
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required
131
+ * Values: "<Values>", // required
132
+ * },
133
+ * },
134
+ * },
135
+ * CalculatedAttributes: { // CalculatedCustomAttributes
136
+ * "<keys>": { // CalculatedAttributeDimension
137
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required
138
+ * Values: "<Values>", // required
139
+ * ConditionOverrides: { // ConditionOverrides
140
+ * Range: { // RangeOverride
141
+ * Start: Number("int"), // required
142
+ * End: Number("int"),
143
+ * Unit: "DAYS", // required
144
+ * },
145
+ * },
146
+ * },
147
+ * },
148
+ * },
149
+ * ],
150
+ * SourceSegments: [ // SourceSegmentList
151
+ * { // SourceSegment
152
+ * SegmentDefinitionName: "STRING_VALUE",
153
+ * },
154
+ * ],
155
+ * SourceType: "ALL" || "ANY" || "NONE",
156
+ * Type: "ALL" || "ANY" || "NONE",
157
+ * },
158
+ * ],
159
+ * Include: "ALL" || "ANY" || "NONE",
160
+ * },
161
+ * };
162
+ * const command = new CreateSegmentEstimateCommand(input);
163
+ * const response = await client.send(command);
164
+ * // { // CreateSegmentEstimateResponse
165
+ * // DomainName: "STRING_VALUE",
166
+ * // EstimateId: "STRING_VALUE",
167
+ * // StatusCode: Number("int"),
168
+ * // };
169
+ *
170
+ * ```
171
+ *
172
+ * @param CreateSegmentEstimateCommandInput - {@link CreateSegmentEstimateCommandInput}
173
+ * @returns {@link CreateSegmentEstimateCommandOutput}
174
+ * @see {@link CreateSegmentEstimateCommandInput} for command's `input` shape.
175
+ * @see {@link CreateSegmentEstimateCommandOutput} for command's `response` shape.
176
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
177
+ *
178
+ * @throws {@link AccessDeniedException} (client fault)
179
+ * <p>You do not have sufficient access to perform this action.</p>
180
+ *
181
+ * @throws {@link BadRequestException} (client fault)
182
+ * <p>The input you provided is invalid.</p>
183
+ *
184
+ * @throws {@link InternalServerException} (server fault)
185
+ * <p>An internal service error occurred.</p>
186
+ *
187
+ * @throws {@link ResourceNotFoundException} (client fault)
188
+ * <p>The requested resource does not exist, or access was denied.</p>
189
+ *
190
+ * @throws {@link ThrottlingException} (client fault)
191
+ * <p>You exceeded the maximum number of requests.</p>
192
+ *
193
+ * @throws {@link CustomerProfilesServiceException}
194
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
195
+ *
196
+ * @public
197
+ */
198
+ export declare class CreateSegmentEstimateCommand extends CreateSegmentEstimateCommand_base {
199
+ /** @internal type navigation helper, not in runtime. */
200
+ protected static __types: {
201
+ api: {
202
+ input: CreateSegmentEstimateRequest;
203
+ output: CreateSegmentEstimateResponse;
204
+ };
205
+ sdk: {
206
+ input: CreateSegmentEstimateCommandInput;
207
+ output: CreateSegmentEstimateCommandOutput;
208
+ };
209
+ };
210
+ }
@@ -0,0 +1,91 @@
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 { CreateSegmentSnapshotRequest, CreateSegmentSnapshotResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateSegmentSnapshotCommand}.
14
+ */
15
+ export interface CreateSegmentSnapshotCommandInput extends CreateSegmentSnapshotRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateSegmentSnapshotCommand}.
21
+ */
22
+ export interface CreateSegmentSnapshotCommandOutput extends CreateSegmentSnapshotResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateSegmentSnapshotCommand_base: {
25
+ new (input: CreateSegmentSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSegmentSnapshotCommandInput, CreateSegmentSnapshotCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateSegmentSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSegmentSnapshotCommandInput, CreateSegmentSnapshotCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Triggers a job to export a segment to a specified destination.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { CustomerProfilesClient, CreateSegmentSnapshotCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
35
+ * // const { CustomerProfilesClient, CreateSegmentSnapshotCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
36
+ * const client = new CustomerProfilesClient(config);
37
+ * const input = { // CreateSegmentSnapshotRequest
38
+ * DomainName: "STRING_VALUE", // required
39
+ * SegmentDefinitionName: "STRING_VALUE", // required
40
+ * DataFormat: "CSV" || "JSONL" || "ORC", // required
41
+ * EncryptionKey: "STRING_VALUE",
42
+ * RoleArn: "STRING_VALUE",
43
+ * DestinationUri: "STRING_VALUE",
44
+ * };
45
+ * const command = new CreateSegmentSnapshotCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // CreateSegmentSnapshotResponse
48
+ * // SnapshotId: "STRING_VALUE", // required
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param CreateSegmentSnapshotCommandInput - {@link CreateSegmentSnapshotCommandInput}
54
+ * @returns {@link CreateSegmentSnapshotCommandOutput}
55
+ * @see {@link CreateSegmentSnapshotCommandInput} for command's `input` shape.
56
+ * @see {@link CreateSegmentSnapshotCommandOutput} for command's `response` shape.
57
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>You do not have sufficient access to perform this action.</p>
61
+ *
62
+ * @throws {@link BadRequestException} (client fault)
63
+ * <p>The input you provided is invalid.</p>
64
+ *
65
+ * @throws {@link InternalServerException} (server fault)
66
+ * <p>An internal service error occurred.</p>
67
+ *
68
+ * @throws {@link ResourceNotFoundException} (client fault)
69
+ * <p>The requested resource does not exist, or access was denied.</p>
70
+ *
71
+ * @throws {@link ThrottlingException} (client fault)
72
+ * <p>You exceeded the maximum number of requests.</p>
73
+ *
74
+ * @throws {@link CustomerProfilesServiceException}
75
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class CreateSegmentSnapshotCommand extends CreateSegmentSnapshotCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: CreateSegmentSnapshotRequest;
84
+ output: CreateSegmentSnapshotResponse;
85
+ };
86
+ sdk: {
87
+ input: CreateSegmentSnapshotCommandInput;
88
+ output: CreateSegmentSnapshotCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,87 @@
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 { DeleteSegmentDefinitionRequest, DeleteSegmentDefinitionResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteSegmentDefinitionCommand}.
14
+ */
15
+ export interface DeleteSegmentDefinitionCommandInput extends DeleteSegmentDefinitionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteSegmentDefinitionCommand}.
21
+ */
22
+ export interface DeleteSegmentDefinitionCommandOutput extends DeleteSegmentDefinitionResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteSegmentDefinitionCommand_base: {
25
+ new (input: DeleteSegmentDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSegmentDefinitionCommandInput, DeleteSegmentDefinitionCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteSegmentDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSegmentDefinitionCommandInput, DeleteSegmentDefinitionCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes a segment definition from 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, DeleteSegmentDefinitionCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
35
+ * // const { CustomerProfilesClient, DeleteSegmentDefinitionCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
36
+ * const client = new CustomerProfilesClient(config);
37
+ * const input = { // DeleteSegmentDefinitionRequest
38
+ * DomainName: "STRING_VALUE", // required
39
+ * SegmentDefinitionName: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteSegmentDefinitionCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // DeleteSegmentDefinitionResponse
44
+ * // Message: "STRING_VALUE",
45
+ * // };
46
+ *
47
+ * ```
48
+ *
49
+ * @param DeleteSegmentDefinitionCommandInput - {@link DeleteSegmentDefinitionCommandInput}
50
+ * @returns {@link DeleteSegmentDefinitionCommandOutput}
51
+ * @see {@link DeleteSegmentDefinitionCommandInput} for command's `input` shape.
52
+ * @see {@link DeleteSegmentDefinitionCommandOutput} 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
+ * @public
74
+ */
75
+ export declare class DeleteSegmentDefinitionCommand extends DeleteSegmentDefinitionCommand_base {
76
+ /** @internal type navigation helper, not in runtime. */
77
+ protected static __types: {
78
+ api: {
79
+ input: DeleteSegmentDefinitionRequest;
80
+ output: DeleteSegmentDefinitionResponse;
81
+ };
82
+ sdk: {
83
+ input: DeleteSegmentDefinitionCommandInput;
84
+ output: DeleteSegmentDefinitionCommandOutput;
85
+ };
86
+ };
87
+ }
@@ -57,7 +57,7 @@ declare const DetectProfileObjectTypeCommand_base: {
57
57
  * // "<keys>": [ // ObjectTypeKeyList
58
58
  * // { // ObjectTypeKey
59
59
  * // StandardIdentifiers: [ // StandardIdentifierList
60
- * // "PROFILE" || "ASSET" || "CASE" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY" || "ORDER",
60
+ * // "PROFILE" || "ASSET" || "CASE" || "ORDER" || "COMMUNICATION_RECORD" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY",
61
61
  * // ],
62
62
  * // FieldNames: [ // FieldNameList
63
63
  * // "STRING_VALUE",
@@ -48,6 +48,26 @@ declare const GetCalculatedAttributeDefinitionCommand_base: {
48
48
  * // CreatedAt: new Date("TIMESTAMP"),
49
49
  * // LastUpdatedAt: new Date("TIMESTAMP"),
50
50
  * // Statistic: "FIRST_OCCURRENCE" || "LAST_OCCURRENCE" || "COUNT" || "SUM" || "MINIMUM" || "MAXIMUM" || "AVERAGE" || "MAX_OCCURRENCE",
51
+ * // Filter: { // Filter
52
+ * // Include: "ALL" || "ANY" || "NONE", // required
53
+ * // Groups: [ // GroupList // required
54
+ * // { // FilterGroup
55
+ * // Type: "ALL" || "ANY" || "NONE", // required
56
+ * // Dimensions: [ // FilterDimensionList // required
57
+ * // { // FilterDimension
58
+ * // Attributes: { // AttributeMap // required
59
+ * // "<keys>": { // FilterAttributeDimension
60
+ * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required
61
+ * // Values: [ // ValueList // required
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // },
65
+ * // },
66
+ * // },
67
+ * // ],
68
+ * // },
69
+ * // ],
70
+ * // },
51
71
  * // Conditions: { // Conditions
52
72
  * // Range: { // Range
53
73
  * // Value: Number("int"), // required
@@ -61,7 +61,7 @@ declare const GetProfileObjectTypeCommand_base: {
61
61
  * // "<keys>": [ // ObjectTypeKeyList
62
62
  * // { // ObjectTypeKey
63
63
  * // StandardIdentifiers: [ // StandardIdentifierList
64
- * // "PROFILE" || "ASSET" || "CASE" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY" || "ORDER",
64
+ * // "PROFILE" || "ASSET" || "CASE" || "ORDER" || "COMMUNICATION_RECORD" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY",
65
65
  * // ],
66
66
  * // FieldNames: [ // FieldNameList
67
67
  * // "STRING_VALUE",