@aws-sdk/client-customer-profiles 3.934.0 → 3.935.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/dist-cjs/index.js +443 -443
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +420 -0
- package/dist-es/models/errors.js +71 -0
- package/dist-es/models/models_0.js +1 -487
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/MergeProfilesCommand.d.ts +1 -1
- package/dist-types/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/commands/StartUploadJobCommand.d.ts +1 -1
- 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 +1 -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/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +828 -0
- package/dist-types/models/errors.d.ts +67 -0
- package/dist-types/models/models_0.d.ts +1139 -884
- package/dist-types/ts3.4/commands/MergeProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutProfileObjectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartUploadJobCommand.d.ts +1 -1
- 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/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +500 -0
- package/dist-types/ts3.4/models/errors.d.ts +42 -0
- package/dist-types/ts3.4/models/models_0.d.ts +282 -536
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-es/models/models_1.js +0 -4
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/models/models_1.d.ts +0 -1150
- package/dist-types/ts3.4/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/models_1.d.ts +0 -259
|
@@ -1,1150 +0,0 @@
|
|
|
1
|
-
import { AdditionalSearchKey, AttributeDetails, Conditions, EngagementPreferences, EventTriggerCondition, EventTriggerLimits, FieldSourceProfileIds, FlowDefinition, Gender, LayoutType, MatchingRequest, MatchingResponse, ObjectTypeField, ObjectTypeKey, PartyType, Profile, ProfileType, Readiness, ReadinessStatus, RuleBasedMatchingRequest, RuleBasedMatchingResponse, Statistic } from "./models_0";
|
|
2
|
-
/**
|
|
3
|
-
* @public
|
|
4
|
-
*/
|
|
5
|
-
export interface MergeProfilesRequest {
|
|
6
|
-
/**
|
|
7
|
-
* <p>The unique name of the domain.</p>
|
|
8
|
-
* @public
|
|
9
|
-
*/
|
|
10
|
-
DomainName: string | undefined;
|
|
11
|
-
/**
|
|
12
|
-
* <p>The identifier of the profile to be taken.</p>
|
|
13
|
-
* @public
|
|
14
|
-
*/
|
|
15
|
-
MainProfileId: string | undefined;
|
|
16
|
-
/**
|
|
17
|
-
* <p>The identifier of the profile to be merged into MainProfileId.</p>
|
|
18
|
-
* @public
|
|
19
|
-
*/
|
|
20
|
-
ProfileIdsToBeMerged: string[] | undefined;
|
|
21
|
-
/**
|
|
22
|
-
* <p>The identifiers of the fields in the profile that has the information you want to apply
|
|
23
|
-
* to the merge. For example, say you want to merge EmailAddress from Profile1 into
|
|
24
|
-
* MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
|
-
FieldSourceProfileIds?: FieldSourceProfileIds | undefined;
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* @public
|
|
31
|
-
*/
|
|
32
|
-
export interface MergeProfilesResponse {
|
|
33
|
-
/**
|
|
34
|
-
* <p>A message that indicates the merge request is complete.</p>
|
|
35
|
-
* @public
|
|
36
|
-
*/
|
|
37
|
-
Message?: string | undefined;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* @public
|
|
41
|
-
*/
|
|
42
|
-
export interface PutIntegrationRequest {
|
|
43
|
-
/**
|
|
44
|
-
* <p>The unique name of the domain.</p>
|
|
45
|
-
* @public
|
|
46
|
-
*/
|
|
47
|
-
DomainName: string | undefined;
|
|
48
|
-
/**
|
|
49
|
-
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
50
|
-
* @public
|
|
51
|
-
*/
|
|
52
|
-
Uri?: string | undefined;
|
|
53
|
-
/**
|
|
54
|
-
* <p>The name of the profile object type.</p>
|
|
55
|
-
* @public
|
|
56
|
-
*/
|
|
57
|
-
ObjectTypeName?: string | undefined;
|
|
58
|
-
/**
|
|
59
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
60
|
-
* @public
|
|
61
|
-
*/
|
|
62
|
-
Tags?: Record<string, string> | undefined;
|
|
63
|
-
/**
|
|
64
|
-
* <p>The configuration that controls how Customer Profiles retrieves data from the
|
|
65
|
-
* source.</p>
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
FlowDefinition?: FlowDefinition | undefined;
|
|
69
|
-
/**
|
|
70
|
-
* <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
|
|
71
|
-
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
72
|
-
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
73
|
-
* @public
|
|
74
|
-
*/
|
|
75
|
-
ObjectTypeNames?: Record<string, string> | undefined;
|
|
76
|
-
/**
|
|
77
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
|
|
78
|
-
* Customer Profiles requests on your behalf.</p>
|
|
79
|
-
* @public
|
|
80
|
-
*/
|
|
81
|
-
RoleArn?: string | undefined;
|
|
82
|
-
/**
|
|
83
|
-
* <p>A list of unique names for active event triggers associated with the integration.</p>
|
|
84
|
-
* @public
|
|
85
|
-
*/
|
|
86
|
-
EventTriggerNames?: string[] | undefined;
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
|
-
export interface PutIntegrationResponse {
|
|
92
|
-
/**
|
|
93
|
-
* <p>The unique name of the domain.</p>
|
|
94
|
-
* @public
|
|
95
|
-
*/
|
|
96
|
-
DomainName: string | undefined;
|
|
97
|
-
/**
|
|
98
|
-
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
Uri: string | undefined;
|
|
102
|
-
/**
|
|
103
|
-
* <p>The name of the profile object type.</p>
|
|
104
|
-
* @public
|
|
105
|
-
*/
|
|
106
|
-
ObjectTypeName?: string | undefined;
|
|
107
|
-
/**
|
|
108
|
-
* <p>The timestamp of when the domain was created.</p>
|
|
109
|
-
* @public
|
|
110
|
-
*/
|
|
111
|
-
CreatedAt: Date | undefined;
|
|
112
|
-
/**
|
|
113
|
-
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
114
|
-
* @public
|
|
115
|
-
*/
|
|
116
|
-
LastUpdatedAt: Date | undefined;
|
|
117
|
-
/**
|
|
118
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
119
|
-
* @public
|
|
120
|
-
*/
|
|
121
|
-
Tags?: Record<string, string> | undefined;
|
|
122
|
-
/**
|
|
123
|
-
* <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
|
|
124
|
-
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
125
|
-
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
126
|
-
* @public
|
|
127
|
-
*/
|
|
128
|
-
ObjectTypeNames?: Record<string, string> | undefined;
|
|
129
|
-
/**
|
|
130
|
-
* <p>Unique identifier for the workflow.</p>
|
|
131
|
-
* @public
|
|
132
|
-
*/
|
|
133
|
-
WorkflowId?: string | undefined;
|
|
134
|
-
/**
|
|
135
|
-
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
136
|
-
* Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
137
|
-
* flowDefinition.</p>
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
|
-
IsUnstructured?: boolean | undefined;
|
|
141
|
-
/**
|
|
142
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
|
|
143
|
-
* Customer Profiles requests on your behalf.</p>
|
|
144
|
-
* @public
|
|
145
|
-
*/
|
|
146
|
-
RoleArn?: string | undefined;
|
|
147
|
-
/**
|
|
148
|
-
* <p>A list of unique names for active event triggers associated with the integration. This
|
|
149
|
-
* list would be empty if no Event Trigger is associated with the integration.</p>
|
|
150
|
-
* @public
|
|
151
|
-
*/
|
|
152
|
-
EventTriggerNames?: string[] | undefined;
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* @public
|
|
156
|
-
*/
|
|
157
|
-
export interface PutProfileObjectRequest {
|
|
158
|
-
/**
|
|
159
|
-
* <p>The name of the profile object type.</p>
|
|
160
|
-
* @public
|
|
161
|
-
*/
|
|
162
|
-
ObjectTypeName: string | undefined;
|
|
163
|
-
/**
|
|
164
|
-
* <p>A string that is serialized from a JSON object.</p>
|
|
165
|
-
* @public
|
|
166
|
-
*/
|
|
167
|
-
Object: string | undefined;
|
|
168
|
-
/**
|
|
169
|
-
* <p>The unique name of the domain.</p>
|
|
170
|
-
* @public
|
|
171
|
-
*/
|
|
172
|
-
DomainName: string | undefined;
|
|
173
|
-
}
|
|
174
|
-
/**
|
|
175
|
-
* @public
|
|
176
|
-
*/
|
|
177
|
-
export interface PutProfileObjectResponse {
|
|
178
|
-
/**
|
|
179
|
-
* <p>The unique identifier of the profile object generated by the service.</p>
|
|
180
|
-
* @public
|
|
181
|
-
*/
|
|
182
|
-
ProfileObjectUniqueKey?: string | undefined;
|
|
183
|
-
}
|
|
184
|
-
/**
|
|
185
|
-
* @public
|
|
186
|
-
*/
|
|
187
|
-
export interface PutProfileObjectTypeRequest {
|
|
188
|
-
/**
|
|
189
|
-
* <p>The unique name of the domain.</p>
|
|
190
|
-
* @public
|
|
191
|
-
*/
|
|
192
|
-
DomainName: string | undefined;
|
|
193
|
-
/**
|
|
194
|
-
* <p>The name of the profile object type.</p>
|
|
195
|
-
* @public
|
|
196
|
-
*/
|
|
197
|
-
ObjectTypeName: string | undefined;
|
|
198
|
-
/**
|
|
199
|
-
* <p>Description of the profile object type.</p>
|
|
200
|
-
* @public
|
|
201
|
-
*/
|
|
202
|
-
Description: string | undefined;
|
|
203
|
-
/**
|
|
204
|
-
* <p>A unique identifier for the object template. For some attributes in the request, the
|
|
205
|
-
* service will use the default value from the object template when TemplateId is present. If
|
|
206
|
-
* these attributes are present in the request, the service may return a
|
|
207
|
-
* <code>BadRequestException</code>. These attributes include: AllowProfileCreation,
|
|
208
|
-
* SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
|
|
209
|
-
* set to true when TemplateId is set, the service may return a
|
|
210
|
-
* <code>BadRequestException</code>.</p>
|
|
211
|
-
* @public
|
|
212
|
-
*/
|
|
213
|
-
TemplateId?: string | undefined;
|
|
214
|
-
/**
|
|
215
|
-
* <p>The number of days until the data in the object expires.</p>
|
|
216
|
-
* @public
|
|
217
|
-
*/
|
|
218
|
-
ExpirationDays?: number | undefined;
|
|
219
|
-
/**
|
|
220
|
-
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
221
|
-
* profile object type.</p>
|
|
222
|
-
* @public
|
|
223
|
-
*/
|
|
224
|
-
EncryptionKey?: string | undefined;
|
|
225
|
-
/**
|
|
226
|
-
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
227
|
-
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
228
|
-
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
229
|
-
* associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
|
|
230
|
-
* is found, then the service creates a new standard profile.</p>
|
|
231
|
-
* @public
|
|
232
|
-
*/
|
|
233
|
-
AllowProfileCreation?: boolean | undefined;
|
|
234
|
-
/**
|
|
235
|
-
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.
|
|
236
|
-
* </p>
|
|
237
|
-
* @public
|
|
238
|
-
*/
|
|
239
|
-
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
240
|
-
/**
|
|
241
|
-
* <p>The amount of profile object max count assigned to the object type</p>
|
|
242
|
-
* @public
|
|
243
|
-
*/
|
|
244
|
-
MaxProfileObjectCount?: number | undefined;
|
|
245
|
-
/**
|
|
246
|
-
* <p>A map of the name and ObjectType field.</p>
|
|
247
|
-
* @public
|
|
248
|
-
*/
|
|
249
|
-
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
250
|
-
/**
|
|
251
|
-
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
252
|
-
* @public
|
|
253
|
-
*/
|
|
254
|
-
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
255
|
-
/**
|
|
256
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
257
|
-
* @public
|
|
258
|
-
*/
|
|
259
|
-
Tags?: Record<string, string> | undefined;
|
|
260
|
-
}
|
|
261
|
-
/**
|
|
262
|
-
* @public
|
|
263
|
-
*/
|
|
264
|
-
export interface PutProfileObjectTypeResponse {
|
|
265
|
-
/**
|
|
266
|
-
* <p>The name of the profile object type.</p>
|
|
267
|
-
* @public
|
|
268
|
-
*/
|
|
269
|
-
ObjectTypeName: string | undefined;
|
|
270
|
-
/**
|
|
271
|
-
* <p>Description of the profile object type.</p>
|
|
272
|
-
* @public
|
|
273
|
-
*/
|
|
274
|
-
Description: string | undefined;
|
|
275
|
-
/**
|
|
276
|
-
* <p>A unique identifier for the object template.</p>
|
|
277
|
-
* @public
|
|
278
|
-
*/
|
|
279
|
-
TemplateId?: string | undefined;
|
|
280
|
-
/**
|
|
281
|
-
* <p>The number of days until the data in the object expires.</p>
|
|
282
|
-
* @public
|
|
283
|
-
*/
|
|
284
|
-
ExpirationDays?: number | undefined;
|
|
285
|
-
/**
|
|
286
|
-
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
287
|
-
* profile object type.</p>
|
|
288
|
-
* @public
|
|
289
|
-
*/
|
|
290
|
-
EncryptionKey?: string | undefined;
|
|
291
|
-
/**
|
|
292
|
-
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
293
|
-
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
294
|
-
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
295
|
-
* associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
|
|
296
|
-
* is found, then the service creates a new standard profile.</p>
|
|
297
|
-
* @public
|
|
298
|
-
*/
|
|
299
|
-
AllowProfileCreation?: boolean | undefined;
|
|
300
|
-
/**
|
|
301
|
-
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in
|
|
302
|
-
* fields that were parsed using <a href="https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>. If you have <code>sourceLastUpdatedTimestamp</code> in your
|
|
303
|
-
* field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
307
|
-
/**
|
|
308
|
-
* <p>The amount of profile object max count assigned to the object type.</p>
|
|
309
|
-
* @public
|
|
310
|
-
*/
|
|
311
|
-
MaxProfileObjectCount?: number | undefined;
|
|
312
|
-
/**
|
|
313
|
-
* <p>The amount of provisioned profile object max count available.</p>
|
|
314
|
-
* @public
|
|
315
|
-
*/
|
|
316
|
-
MaxAvailableProfileObjectCount?: number | undefined;
|
|
317
|
-
/**
|
|
318
|
-
* <p>A map of the name and ObjectType field.</p>
|
|
319
|
-
* @public
|
|
320
|
-
*/
|
|
321
|
-
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
322
|
-
/**
|
|
323
|
-
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
324
|
-
* @public
|
|
325
|
-
*/
|
|
326
|
-
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
327
|
-
/**
|
|
328
|
-
* <p>The timestamp of when the domain was created.</p>
|
|
329
|
-
* @public
|
|
330
|
-
*/
|
|
331
|
-
CreatedAt?: Date | undefined;
|
|
332
|
-
/**
|
|
333
|
-
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
334
|
-
* @public
|
|
335
|
-
*/
|
|
336
|
-
LastUpdatedAt?: Date | undefined;
|
|
337
|
-
/**
|
|
338
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
339
|
-
* @public
|
|
340
|
-
*/
|
|
341
|
-
Tags?: Record<string, string> | undefined;
|
|
342
|
-
}
|
|
343
|
-
/**
|
|
344
|
-
* @public
|
|
345
|
-
* @enum
|
|
346
|
-
*/
|
|
347
|
-
export declare const LogicalOperator: {
|
|
348
|
-
readonly AND: "AND";
|
|
349
|
-
readonly OR: "OR";
|
|
350
|
-
};
|
|
351
|
-
/**
|
|
352
|
-
* @public
|
|
353
|
-
*/
|
|
354
|
-
export type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOperator];
|
|
355
|
-
/**
|
|
356
|
-
* @public
|
|
357
|
-
*/
|
|
358
|
-
export interface SearchProfilesRequest {
|
|
359
|
-
/**
|
|
360
|
-
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
361
|
-
* @public
|
|
362
|
-
*/
|
|
363
|
-
NextToken?: string | undefined;
|
|
364
|
-
/**
|
|
365
|
-
* <p>The maximum number of objects returned per page.</p>
|
|
366
|
-
* <p>The default is 20 if this parameter is not included in the request.</p>
|
|
367
|
-
* @public
|
|
368
|
-
*/
|
|
369
|
-
MaxResults?: number | undefined;
|
|
370
|
-
/**
|
|
371
|
-
* <p>The unique name of the domain.</p>
|
|
372
|
-
* @public
|
|
373
|
-
*/
|
|
374
|
-
DomainName: string | undefined;
|
|
375
|
-
/**
|
|
376
|
-
* <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
|
|
377
|
-
* _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
|
|
378
|
-
* _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
|
|
379
|
-
* _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
|
|
380
|
-
* _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
|
|
381
|
-
* @public
|
|
382
|
-
*/
|
|
383
|
-
KeyName: string | undefined;
|
|
384
|
-
/**
|
|
385
|
-
* <p>A list of key values.</p>
|
|
386
|
-
* @public
|
|
387
|
-
*/
|
|
388
|
-
Values: string[] | undefined;
|
|
389
|
-
/**
|
|
390
|
-
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
|
|
391
|
-
* of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
|
|
392
|
-
* and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
|
|
393
|
-
* pair). These additional search keys will be used in conjunction with the
|
|
394
|
-
* <code>LogicalOperator</code> and the required <code>KeyName</code> and
|
|
395
|
-
* <code>Values</code> parameters to search for profiles that satisfy the search criteria.
|
|
396
|
-
* </p>
|
|
397
|
-
* @public
|
|
398
|
-
*/
|
|
399
|
-
AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
|
|
400
|
-
/**
|
|
401
|
-
* <p>Relationship between all specified search keys that will be used to search for profiles.
|
|
402
|
-
* This includes the required <code>KeyName</code> and <code>Values</code> parameters as well
|
|
403
|
-
* as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
|
|
404
|
-
* <p>This parameter influences which profiles will be returned in the response in the
|
|
405
|
-
* following manner:</p>
|
|
406
|
-
* <ul>
|
|
407
|
-
* <li>
|
|
408
|
-
* <p>
|
|
409
|
-
* <code>AND</code> - The response only includes profiles that match all of the
|
|
410
|
-
* search keys.</p>
|
|
411
|
-
* </li>
|
|
412
|
-
* <li>
|
|
413
|
-
* <p>
|
|
414
|
-
* <code>OR</code> - The response includes profiles that match at least one of the
|
|
415
|
-
* search keys.</p>
|
|
416
|
-
* </li>
|
|
417
|
-
* </ul>
|
|
418
|
-
* <p>The <code>OR</code> relationship is the default behavior if this parameter is not
|
|
419
|
-
* included in the request.</p>
|
|
420
|
-
* @public
|
|
421
|
-
*/
|
|
422
|
-
LogicalOperator?: LogicalOperator | undefined;
|
|
423
|
-
}
|
|
424
|
-
/**
|
|
425
|
-
* @public
|
|
426
|
-
*/
|
|
427
|
-
export interface SearchProfilesResponse {
|
|
428
|
-
/**
|
|
429
|
-
* <p>The list of Profiles matching the search criteria.</p>
|
|
430
|
-
* @public
|
|
431
|
-
*/
|
|
432
|
-
Items?: Profile[] | undefined;
|
|
433
|
-
/**
|
|
434
|
-
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
435
|
-
* @public
|
|
436
|
-
*/
|
|
437
|
-
NextToken?: string | undefined;
|
|
438
|
-
}
|
|
439
|
-
/**
|
|
440
|
-
* @public
|
|
441
|
-
*/
|
|
442
|
-
export interface StartUploadJobRequest {
|
|
443
|
-
/**
|
|
444
|
-
* <p>The unique name of the domain containing the upload job to start. </p>
|
|
445
|
-
* @public
|
|
446
|
-
*/
|
|
447
|
-
DomainName: string | undefined;
|
|
448
|
-
/**
|
|
449
|
-
* <p>The unique identifier of the upload job to start. </p>
|
|
450
|
-
* @public
|
|
451
|
-
*/
|
|
452
|
-
JobId: string | undefined;
|
|
453
|
-
}
|
|
454
|
-
/**
|
|
455
|
-
* @public
|
|
456
|
-
*/
|
|
457
|
-
export interface StartUploadJobResponse {
|
|
458
|
-
}
|
|
459
|
-
/**
|
|
460
|
-
* @public
|
|
461
|
-
*/
|
|
462
|
-
export interface StopUploadJobRequest {
|
|
463
|
-
/**
|
|
464
|
-
* <p>The unique name of the domain containing the upload job to stop. </p>
|
|
465
|
-
* @public
|
|
466
|
-
*/
|
|
467
|
-
DomainName: string | undefined;
|
|
468
|
-
/**
|
|
469
|
-
* <p>The unique identifier of the upload job to stop. </p>
|
|
470
|
-
* @public
|
|
471
|
-
*/
|
|
472
|
-
JobId: string | undefined;
|
|
473
|
-
}
|
|
474
|
-
/**
|
|
475
|
-
* @public
|
|
476
|
-
*/
|
|
477
|
-
export interface StopUploadJobResponse {
|
|
478
|
-
}
|
|
479
|
-
/**
|
|
480
|
-
* @public
|
|
481
|
-
*/
|
|
482
|
-
export interface TagResourceRequest {
|
|
483
|
-
/**
|
|
484
|
-
* <p>The ARN of the resource that you're adding tags to.</p>
|
|
485
|
-
* @public
|
|
486
|
-
*/
|
|
487
|
-
resourceArn: string | undefined;
|
|
488
|
-
/**
|
|
489
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
490
|
-
* @public
|
|
491
|
-
*/
|
|
492
|
-
tags: Record<string, string> | undefined;
|
|
493
|
-
}
|
|
494
|
-
/**
|
|
495
|
-
* @public
|
|
496
|
-
*/
|
|
497
|
-
export interface TagResourceResponse {
|
|
498
|
-
}
|
|
499
|
-
/**
|
|
500
|
-
* @public
|
|
501
|
-
*/
|
|
502
|
-
export interface UntagResourceRequest {
|
|
503
|
-
/**
|
|
504
|
-
* <p>The ARN of the resource from which you are removing tags.</p>
|
|
505
|
-
* @public
|
|
506
|
-
*/
|
|
507
|
-
resourceArn: string | undefined;
|
|
508
|
-
/**
|
|
509
|
-
* <p>The list of tag keys to remove from the resource.</p>
|
|
510
|
-
* @public
|
|
511
|
-
*/
|
|
512
|
-
tagKeys: string[] | undefined;
|
|
513
|
-
}
|
|
514
|
-
/**
|
|
515
|
-
* @public
|
|
516
|
-
*/
|
|
517
|
-
export interface UntagResourceResponse {
|
|
518
|
-
}
|
|
519
|
-
/**
|
|
520
|
-
* @public
|
|
521
|
-
*/
|
|
522
|
-
export interface UpdateCalculatedAttributeDefinitionRequest {
|
|
523
|
-
/**
|
|
524
|
-
* <p>The unique name of the domain.</p>
|
|
525
|
-
* @public
|
|
526
|
-
*/
|
|
527
|
-
DomainName: string | undefined;
|
|
528
|
-
/**
|
|
529
|
-
* <p>The unique name of the calculated attribute.</p>
|
|
530
|
-
* @public
|
|
531
|
-
*/
|
|
532
|
-
CalculatedAttributeName: string | undefined;
|
|
533
|
-
/**
|
|
534
|
-
* <p>The display name of the calculated attribute.</p>
|
|
535
|
-
* @public
|
|
536
|
-
*/
|
|
537
|
-
DisplayName?: string | undefined;
|
|
538
|
-
/**
|
|
539
|
-
* <p>The description of the calculated attribute.</p>
|
|
540
|
-
* @public
|
|
541
|
-
*/
|
|
542
|
-
Description?: string | undefined;
|
|
543
|
-
/**
|
|
544
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
545
|
-
* attribute.</p>
|
|
546
|
-
* @public
|
|
547
|
-
*/
|
|
548
|
-
Conditions?: Conditions | undefined;
|
|
549
|
-
}
|
|
550
|
-
/**
|
|
551
|
-
* @public
|
|
552
|
-
*/
|
|
553
|
-
export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
554
|
-
/**
|
|
555
|
-
* <p>The unique name of the calculated attribute.</p>
|
|
556
|
-
* @public
|
|
557
|
-
*/
|
|
558
|
-
CalculatedAttributeName?: string | undefined;
|
|
559
|
-
/**
|
|
560
|
-
* <p>The display name of the calculated attribute.</p>
|
|
561
|
-
* @public
|
|
562
|
-
*/
|
|
563
|
-
DisplayName?: string | undefined;
|
|
564
|
-
/**
|
|
565
|
-
* <p>The description of the calculated attribute.</p>
|
|
566
|
-
* @public
|
|
567
|
-
*/
|
|
568
|
-
Description?: string | undefined;
|
|
569
|
-
/**
|
|
570
|
-
* <p>The timestamp of when the calculated attribute definition was created.</p>
|
|
571
|
-
* @public
|
|
572
|
-
*/
|
|
573
|
-
CreatedAt?: Date | undefined;
|
|
574
|
-
/**
|
|
575
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
576
|
-
* edited.</p>
|
|
577
|
-
* @public
|
|
578
|
-
*/
|
|
579
|
-
LastUpdatedAt?: Date | undefined;
|
|
580
|
-
/**
|
|
581
|
-
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
582
|
-
* @public
|
|
583
|
-
*/
|
|
584
|
-
Statistic?: Statistic | undefined;
|
|
585
|
-
/**
|
|
586
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
587
|
-
* attribute.</p>
|
|
588
|
-
* @public
|
|
589
|
-
*/
|
|
590
|
-
Conditions?: Conditions | undefined;
|
|
591
|
-
/**
|
|
592
|
-
* <p>The mathematical expression and a list of attribute items specified in that
|
|
593
|
-
* expression.</p>
|
|
594
|
-
* @public
|
|
595
|
-
*/
|
|
596
|
-
AttributeDetails?: AttributeDetails | undefined;
|
|
597
|
-
/**
|
|
598
|
-
* <p>Whether historical data ingested before the Calculated Attribute was created should be
|
|
599
|
-
* included in calculations.</p>
|
|
600
|
-
* @public
|
|
601
|
-
*/
|
|
602
|
-
UseHistoricalData?: boolean | undefined;
|
|
603
|
-
/**
|
|
604
|
-
* <p>Status of the Calculated Attribute creation (whether all historical data has been
|
|
605
|
-
* indexed.)</p>
|
|
606
|
-
* @public
|
|
607
|
-
*/
|
|
608
|
-
Status?: ReadinessStatus | undefined;
|
|
609
|
-
/**
|
|
610
|
-
* <p>Information indicating if the Calculated Attribute is ready for use by confirming all
|
|
611
|
-
* historical data has been processed and reflected.</p>
|
|
612
|
-
* @public
|
|
613
|
-
*/
|
|
614
|
-
Readiness?: Readiness | undefined;
|
|
615
|
-
/**
|
|
616
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
617
|
-
* @public
|
|
618
|
-
*/
|
|
619
|
-
Tags?: Record<string, string> | undefined;
|
|
620
|
-
}
|
|
621
|
-
/**
|
|
622
|
-
* @public
|
|
623
|
-
*/
|
|
624
|
-
export interface UpdateDomainRequest {
|
|
625
|
-
/**
|
|
626
|
-
* <p>The unique name of the domain.</p>
|
|
627
|
-
* @public
|
|
628
|
-
*/
|
|
629
|
-
DomainName: string | undefined;
|
|
630
|
-
/**
|
|
631
|
-
* <p>The default number of days until the data within the domain expires.</p>
|
|
632
|
-
* @public
|
|
633
|
-
*/
|
|
634
|
-
DefaultExpirationDays?: number | undefined;
|
|
635
|
-
/**
|
|
636
|
-
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
637
|
-
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
638
|
-
* permanent or semi-permanent storage. If specified as an empty string, it will clear any
|
|
639
|
-
* existing value.</p>
|
|
640
|
-
* @public
|
|
641
|
-
*/
|
|
642
|
-
DefaultEncryptionKey?: string | undefined;
|
|
643
|
-
/**
|
|
644
|
-
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
645
|
-
* ingesting data from third party applications. If specified as an empty string, it will
|
|
646
|
-
* clear any existing value. You must set up a policy on the DeadLetterQueue for the
|
|
647
|
-
* SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the
|
|
648
|
-
* DeadLetterQueue.</p>
|
|
649
|
-
* @public
|
|
650
|
-
*/
|
|
651
|
-
DeadLetterQueueUrl?: string | undefined;
|
|
652
|
-
/**
|
|
653
|
-
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
654
|
-
* batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every
|
|
655
|
-
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
656
|
-
* <p>After the Identity Resolution Job completes, use the
|
|
657
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
658
|
-
* API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from
|
|
659
|
-
* S3.</p>
|
|
660
|
-
* @public
|
|
661
|
-
*/
|
|
662
|
-
Matching?: MatchingRequest | undefined;
|
|
663
|
-
/**
|
|
664
|
-
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
665
|
-
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
666
|
-
* to match and merge your profiles according to your configuration in the
|
|
667
|
-
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
668
|
-
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
669
|
-
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
670
|
-
* can download the results from S3.</p>
|
|
671
|
-
* @public
|
|
672
|
-
*/
|
|
673
|
-
RuleBasedMatching?: RuleBasedMatchingRequest | undefined;
|
|
674
|
-
/**
|
|
675
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
676
|
-
* @public
|
|
677
|
-
*/
|
|
678
|
-
Tags?: Record<string, string> | undefined;
|
|
679
|
-
}
|
|
680
|
-
/**
|
|
681
|
-
* @public
|
|
682
|
-
*/
|
|
683
|
-
export interface UpdateDomainResponse {
|
|
684
|
-
/**
|
|
685
|
-
* <p>The unique name of the domain.</p>
|
|
686
|
-
* @public
|
|
687
|
-
*/
|
|
688
|
-
DomainName: string | undefined;
|
|
689
|
-
/**
|
|
690
|
-
* <p>The default number of days until the data within the domain expires.</p>
|
|
691
|
-
* @public
|
|
692
|
-
*/
|
|
693
|
-
DefaultExpirationDays?: number | undefined;
|
|
694
|
-
/**
|
|
695
|
-
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
696
|
-
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
697
|
-
* permanent or semi-permanent storage.</p>
|
|
698
|
-
* @public
|
|
699
|
-
*/
|
|
700
|
-
DefaultEncryptionKey?: string | undefined;
|
|
701
|
-
/**
|
|
702
|
-
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
703
|
-
* ingesting data from third party applications.</p>
|
|
704
|
-
* @public
|
|
705
|
-
*/
|
|
706
|
-
DeadLetterQueueUrl?: string | undefined;
|
|
707
|
-
/**
|
|
708
|
-
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
709
|
-
* batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every
|
|
710
|
-
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
711
|
-
* <p>After the Identity Resolution Job completes, use the
|
|
712
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
713
|
-
* API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from
|
|
714
|
-
* S3.</p>
|
|
715
|
-
* @public
|
|
716
|
-
*/
|
|
717
|
-
Matching?: MatchingResponse | undefined;
|
|
718
|
-
/**
|
|
719
|
-
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
720
|
-
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
721
|
-
* to match and merge your profiles according to your configuration in the
|
|
722
|
-
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
723
|
-
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
724
|
-
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
725
|
-
* can download the results from S3.</p>
|
|
726
|
-
* @public
|
|
727
|
-
*/
|
|
728
|
-
RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
|
|
729
|
-
/**
|
|
730
|
-
* <p>The timestamp of when the domain was created.</p>
|
|
731
|
-
* @public
|
|
732
|
-
*/
|
|
733
|
-
CreatedAt: Date | undefined;
|
|
734
|
-
/**
|
|
735
|
-
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
736
|
-
* @public
|
|
737
|
-
*/
|
|
738
|
-
LastUpdatedAt: Date | undefined;
|
|
739
|
-
/**
|
|
740
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
741
|
-
* @public
|
|
742
|
-
*/
|
|
743
|
-
Tags?: Record<string, string> | undefined;
|
|
744
|
-
}
|
|
745
|
-
/**
|
|
746
|
-
* @public
|
|
747
|
-
*/
|
|
748
|
-
export interface UpdateDomainLayoutRequest {
|
|
749
|
-
/**
|
|
750
|
-
* <p>The unique name of the domain.</p>
|
|
751
|
-
* @public
|
|
752
|
-
*/
|
|
753
|
-
DomainName: string | undefined;
|
|
754
|
-
/**
|
|
755
|
-
* <p>The unique name of the layout.</p>
|
|
756
|
-
* @public
|
|
757
|
-
*/
|
|
758
|
-
LayoutDefinitionName: string | undefined;
|
|
759
|
-
/**
|
|
760
|
-
* <p>The description of the layout</p>
|
|
761
|
-
* @public
|
|
762
|
-
*/
|
|
763
|
-
Description?: string | undefined;
|
|
764
|
-
/**
|
|
765
|
-
* <p>The display name of the layout</p>
|
|
766
|
-
* @public
|
|
767
|
-
*/
|
|
768
|
-
DisplayName?: string | undefined;
|
|
769
|
-
/**
|
|
770
|
-
* <p>If set to true for a layout, this layout will be used by default to view data. If set to
|
|
771
|
-
* false, then the layout will not be used by default, but it can be used to view data by
|
|
772
|
-
* explicitly selecting it in the console.</p>
|
|
773
|
-
* @public
|
|
774
|
-
*/
|
|
775
|
-
IsDefault?: boolean | undefined;
|
|
776
|
-
/**
|
|
777
|
-
* <p>The type of layout that can be used to view data under a Customer Profiles domain.</p>
|
|
778
|
-
* @public
|
|
779
|
-
*/
|
|
780
|
-
LayoutType?: LayoutType | undefined;
|
|
781
|
-
/**
|
|
782
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
783
|
-
* @public
|
|
784
|
-
*/
|
|
785
|
-
Layout?: string | undefined;
|
|
786
|
-
}
|
|
787
|
-
/**
|
|
788
|
-
* @public
|
|
789
|
-
*/
|
|
790
|
-
export interface UpdateDomainLayoutResponse {
|
|
791
|
-
/**
|
|
792
|
-
* <p>The unique name of the layout.</p>
|
|
793
|
-
* @public
|
|
794
|
-
*/
|
|
795
|
-
LayoutDefinitionName?: string | undefined;
|
|
796
|
-
/**
|
|
797
|
-
* <p>The description of the layout</p>
|
|
798
|
-
* @public
|
|
799
|
-
*/
|
|
800
|
-
Description?: string | undefined;
|
|
801
|
-
/**
|
|
802
|
-
* <p>The display name of the layout</p>
|
|
803
|
-
* @public
|
|
804
|
-
*/
|
|
805
|
-
DisplayName?: string | undefined;
|
|
806
|
-
/**
|
|
807
|
-
* <p>If set to true for a layout, this layout will be used by default to view data. If set to
|
|
808
|
-
* false, then the layout will not be used by default, but it can be used to view data by
|
|
809
|
-
* explicitly selecting it in the console.</p>
|
|
810
|
-
* @public
|
|
811
|
-
*/
|
|
812
|
-
IsDefault?: boolean | undefined;
|
|
813
|
-
/**
|
|
814
|
-
* <p>The type of layout that can be used to view data under a Customer Profiles domain.</p>
|
|
815
|
-
* @public
|
|
816
|
-
*/
|
|
817
|
-
LayoutType?: LayoutType | undefined;
|
|
818
|
-
/**
|
|
819
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
820
|
-
* @public
|
|
821
|
-
*/
|
|
822
|
-
Layout?: string | undefined;
|
|
823
|
-
/**
|
|
824
|
-
* <p>The version used to create layout.</p>
|
|
825
|
-
* @public
|
|
826
|
-
*/
|
|
827
|
-
Version?: string | undefined;
|
|
828
|
-
/**
|
|
829
|
-
* <p>The timestamp of when the layout was created.</p>
|
|
830
|
-
* @public
|
|
831
|
-
*/
|
|
832
|
-
CreatedAt?: Date | undefined;
|
|
833
|
-
/**
|
|
834
|
-
* <p>The timestamp of when the layout was most recently updated.</p>
|
|
835
|
-
* @public
|
|
836
|
-
*/
|
|
837
|
-
LastUpdatedAt?: Date | undefined;
|
|
838
|
-
/**
|
|
839
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
840
|
-
* @public
|
|
841
|
-
*/
|
|
842
|
-
Tags?: Record<string, string> | undefined;
|
|
843
|
-
}
|
|
844
|
-
/**
|
|
845
|
-
* @public
|
|
846
|
-
*/
|
|
847
|
-
export interface UpdateEventTriggerRequest {
|
|
848
|
-
/**
|
|
849
|
-
* <p>The unique name of the domain.</p>
|
|
850
|
-
* @public
|
|
851
|
-
*/
|
|
852
|
-
DomainName: string | undefined;
|
|
853
|
-
/**
|
|
854
|
-
* <p>The unique name of the event trigger.</p>
|
|
855
|
-
* @public
|
|
856
|
-
*/
|
|
857
|
-
EventTriggerName: string | undefined;
|
|
858
|
-
/**
|
|
859
|
-
* <p>The unique name of the object type.</p>
|
|
860
|
-
* @public
|
|
861
|
-
*/
|
|
862
|
-
ObjectTypeName?: string | undefined;
|
|
863
|
-
/**
|
|
864
|
-
* <p>The description of the event trigger.</p>
|
|
865
|
-
* @public
|
|
866
|
-
*/
|
|
867
|
-
Description?: string | undefined;
|
|
868
|
-
/**
|
|
869
|
-
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
870
|
-
* @public
|
|
871
|
-
*/
|
|
872
|
-
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
873
|
-
/**
|
|
874
|
-
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
875
|
-
* definition.</p>
|
|
876
|
-
* @public
|
|
877
|
-
*/
|
|
878
|
-
SegmentFilter?: string | undefined;
|
|
879
|
-
/**
|
|
880
|
-
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
881
|
-
* latency and the number of invocations per profile over specific time periods.</p>
|
|
882
|
-
* @public
|
|
883
|
-
*/
|
|
884
|
-
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
885
|
-
}
|
|
886
|
-
/**
|
|
887
|
-
* @public
|
|
888
|
-
*/
|
|
889
|
-
export interface UpdateEventTriggerResponse {
|
|
890
|
-
/**
|
|
891
|
-
* <p>The unique name of the event trigger.</p>
|
|
892
|
-
* @public
|
|
893
|
-
*/
|
|
894
|
-
EventTriggerName?: string | undefined;
|
|
895
|
-
/**
|
|
896
|
-
* <p>The unique name of the object type.</p>
|
|
897
|
-
* @public
|
|
898
|
-
*/
|
|
899
|
-
ObjectTypeName?: string | undefined;
|
|
900
|
-
/**
|
|
901
|
-
* <p>The description of the event trigger.</p>
|
|
902
|
-
* @public
|
|
903
|
-
*/
|
|
904
|
-
Description?: string | undefined;
|
|
905
|
-
/**
|
|
906
|
-
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
907
|
-
* @public
|
|
908
|
-
*/
|
|
909
|
-
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
910
|
-
/**
|
|
911
|
-
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
912
|
-
* definition.</p>
|
|
913
|
-
* @public
|
|
914
|
-
*/
|
|
915
|
-
SegmentFilter?: string | undefined;
|
|
916
|
-
/**
|
|
917
|
-
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
918
|
-
* latency and the number of invocations per profile over specific time periods.</p>
|
|
919
|
-
* @public
|
|
920
|
-
*/
|
|
921
|
-
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
922
|
-
/**
|
|
923
|
-
* <p>The timestamp of when the event trigger was created.</p>
|
|
924
|
-
* @public
|
|
925
|
-
*/
|
|
926
|
-
CreatedAt?: Date | undefined;
|
|
927
|
-
/**
|
|
928
|
-
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
929
|
-
* @public
|
|
930
|
-
*/
|
|
931
|
-
LastUpdatedAt?: Date | undefined;
|
|
932
|
-
/**
|
|
933
|
-
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
934
|
-
* @public
|
|
935
|
-
*/
|
|
936
|
-
Tags?: Record<string, string> | undefined;
|
|
937
|
-
}
|
|
938
|
-
/**
|
|
939
|
-
* <p>Updates associated with the address properties of a customer profile.</p>
|
|
940
|
-
* @public
|
|
941
|
-
*/
|
|
942
|
-
export interface UpdateAddress {
|
|
943
|
-
/**
|
|
944
|
-
* <p>The first line of a customer address.</p>
|
|
945
|
-
* @public
|
|
946
|
-
*/
|
|
947
|
-
Address1?: string | undefined;
|
|
948
|
-
/**
|
|
949
|
-
* <p>The second line of a customer address.</p>
|
|
950
|
-
* @public
|
|
951
|
-
*/
|
|
952
|
-
Address2?: string | undefined;
|
|
953
|
-
/**
|
|
954
|
-
* <p>The third line of a customer address.</p>
|
|
955
|
-
* @public
|
|
956
|
-
*/
|
|
957
|
-
Address3?: string | undefined;
|
|
958
|
-
/**
|
|
959
|
-
* <p>The fourth line of a customer address.</p>
|
|
960
|
-
* @public
|
|
961
|
-
*/
|
|
962
|
-
Address4?: string | undefined;
|
|
963
|
-
/**
|
|
964
|
-
* <p>The city in which a customer lives.</p>
|
|
965
|
-
* @public
|
|
966
|
-
*/
|
|
967
|
-
City?: string | undefined;
|
|
968
|
-
/**
|
|
969
|
-
* <p>The county in which a customer lives.</p>
|
|
970
|
-
* @public
|
|
971
|
-
*/
|
|
972
|
-
County?: string | undefined;
|
|
973
|
-
/**
|
|
974
|
-
* <p>The state in which a customer lives.</p>
|
|
975
|
-
* @public
|
|
976
|
-
*/
|
|
977
|
-
State?: string | undefined;
|
|
978
|
-
/**
|
|
979
|
-
* <p>The province in which a customer lives.</p>
|
|
980
|
-
* @public
|
|
981
|
-
*/
|
|
982
|
-
Province?: string | undefined;
|
|
983
|
-
/**
|
|
984
|
-
* <p>The country in which a customer lives.</p>
|
|
985
|
-
* @public
|
|
986
|
-
*/
|
|
987
|
-
Country?: string | undefined;
|
|
988
|
-
/**
|
|
989
|
-
* <p>The postal code of a customer address.</p>
|
|
990
|
-
* @public
|
|
991
|
-
*/
|
|
992
|
-
PostalCode?: string | undefined;
|
|
993
|
-
}
|
|
994
|
-
/**
|
|
995
|
-
* @public
|
|
996
|
-
*/
|
|
997
|
-
export interface UpdateProfileRequest {
|
|
998
|
-
/**
|
|
999
|
-
* <p>The unique name of the domain.</p>
|
|
1000
|
-
* @public
|
|
1001
|
-
*/
|
|
1002
|
-
DomainName: string | undefined;
|
|
1003
|
-
/**
|
|
1004
|
-
* <p>The unique identifier of a customer profile.</p>
|
|
1005
|
-
* @public
|
|
1006
|
-
*/
|
|
1007
|
-
ProfileId: string | undefined;
|
|
1008
|
-
/**
|
|
1009
|
-
* <p>Any additional information relevant to the customer’s profile.</p>
|
|
1010
|
-
* @public
|
|
1011
|
-
*/
|
|
1012
|
-
AdditionalInformation?: string | undefined;
|
|
1013
|
-
/**
|
|
1014
|
-
* <p>An account number that you have assigned to the customer.</p>
|
|
1015
|
-
* @public
|
|
1016
|
-
*/
|
|
1017
|
-
AccountNumber?: string | undefined;
|
|
1018
|
-
/**
|
|
1019
|
-
* <p>The type of profile used to describe the customer.</p>
|
|
1020
|
-
*
|
|
1021
|
-
* @deprecated deprecated
|
|
1022
|
-
* @public
|
|
1023
|
-
*/
|
|
1024
|
-
PartyType?: PartyType | undefined;
|
|
1025
|
-
/**
|
|
1026
|
-
* <p>The name of the customer’s business.</p>
|
|
1027
|
-
* @public
|
|
1028
|
-
*/
|
|
1029
|
-
BusinessName?: string | undefined;
|
|
1030
|
-
/**
|
|
1031
|
-
* <p>The customer’s first name.</p>
|
|
1032
|
-
* @public
|
|
1033
|
-
*/
|
|
1034
|
-
FirstName?: string | undefined;
|
|
1035
|
-
/**
|
|
1036
|
-
* <p>The customer’s middle name.</p>
|
|
1037
|
-
* @public
|
|
1038
|
-
*/
|
|
1039
|
-
MiddleName?: string | undefined;
|
|
1040
|
-
/**
|
|
1041
|
-
* <p>The customer’s last name.</p>
|
|
1042
|
-
* @public
|
|
1043
|
-
*/
|
|
1044
|
-
LastName?: string | undefined;
|
|
1045
|
-
/**
|
|
1046
|
-
* <p>The customer’s birth date. </p>
|
|
1047
|
-
* @public
|
|
1048
|
-
*/
|
|
1049
|
-
BirthDate?: string | undefined;
|
|
1050
|
-
/**
|
|
1051
|
-
* <p>The gender with which the customer identifies. </p>
|
|
1052
|
-
*
|
|
1053
|
-
* @deprecated deprecated
|
|
1054
|
-
* @public
|
|
1055
|
-
*/
|
|
1056
|
-
Gender?: Gender | undefined;
|
|
1057
|
-
/**
|
|
1058
|
-
* <p>The customer’s phone number, which has not been specified as a mobile, home, or business
|
|
1059
|
-
* number. </p>
|
|
1060
|
-
* @public
|
|
1061
|
-
*/
|
|
1062
|
-
PhoneNumber?: string | undefined;
|
|
1063
|
-
/**
|
|
1064
|
-
* <p>The customer’s mobile phone number.</p>
|
|
1065
|
-
* @public
|
|
1066
|
-
*/
|
|
1067
|
-
MobilePhoneNumber?: string | undefined;
|
|
1068
|
-
/**
|
|
1069
|
-
* <p>The customer’s home phone number.</p>
|
|
1070
|
-
* @public
|
|
1071
|
-
*/
|
|
1072
|
-
HomePhoneNumber?: string | undefined;
|
|
1073
|
-
/**
|
|
1074
|
-
* <p>The customer’s business phone number.</p>
|
|
1075
|
-
* @public
|
|
1076
|
-
*/
|
|
1077
|
-
BusinessPhoneNumber?: string | undefined;
|
|
1078
|
-
/**
|
|
1079
|
-
* <p>The customer’s email address, which has not been specified as a personal or business
|
|
1080
|
-
* address. </p>
|
|
1081
|
-
* @public
|
|
1082
|
-
*/
|
|
1083
|
-
EmailAddress?: string | undefined;
|
|
1084
|
-
/**
|
|
1085
|
-
* <p>The customer’s personal email address.</p>
|
|
1086
|
-
* @public
|
|
1087
|
-
*/
|
|
1088
|
-
PersonalEmailAddress?: string | undefined;
|
|
1089
|
-
/**
|
|
1090
|
-
* <p>The customer’s business email address.</p>
|
|
1091
|
-
* @public
|
|
1092
|
-
*/
|
|
1093
|
-
BusinessEmailAddress?: string | undefined;
|
|
1094
|
-
/**
|
|
1095
|
-
* <p>A generic address associated with the customer that is not mailing, shipping, or
|
|
1096
|
-
* billing.</p>
|
|
1097
|
-
* @public
|
|
1098
|
-
*/
|
|
1099
|
-
Address?: UpdateAddress | undefined;
|
|
1100
|
-
/**
|
|
1101
|
-
* <p>The customer’s shipping address.</p>
|
|
1102
|
-
* @public
|
|
1103
|
-
*/
|
|
1104
|
-
ShippingAddress?: UpdateAddress | undefined;
|
|
1105
|
-
/**
|
|
1106
|
-
* <p>The customer’s mailing address.</p>
|
|
1107
|
-
* @public
|
|
1108
|
-
*/
|
|
1109
|
-
MailingAddress?: UpdateAddress | undefined;
|
|
1110
|
-
/**
|
|
1111
|
-
* <p>The customer’s billing address.</p>
|
|
1112
|
-
* @public
|
|
1113
|
-
*/
|
|
1114
|
-
BillingAddress?: UpdateAddress | undefined;
|
|
1115
|
-
/**
|
|
1116
|
-
* <p>A key value pair of attributes of a customer profile.</p>
|
|
1117
|
-
* @public
|
|
1118
|
-
*/
|
|
1119
|
-
Attributes?: Record<string, string> | undefined;
|
|
1120
|
-
/**
|
|
1121
|
-
* <p>An alternative to <code>PartyType</code> which accepts any string as input.</p>
|
|
1122
|
-
* @public
|
|
1123
|
-
*/
|
|
1124
|
-
PartyTypeString?: string | undefined;
|
|
1125
|
-
/**
|
|
1126
|
-
* <p>An alternative to <code>Gender</code> which accepts any string as input.</p>
|
|
1127
|
-
* @public
|
|
1128
|
-
*/
|
|
1129
|
-
GenderString?: string | undefined;
|
|
1130
|
-
/**
|
|
1131
|
-
* <p>Determines the type of the profile.</p>
|
|
1132
|
-
* @public
|
|
1133
|
-
*/
|
|
1134
|
-
ProfileType?: ProfileType | undefined;
|
|
1135
|
-
/**
|
|
1136
|
-
* <p>Object that defines users preferred methods of engagement.</p>
|
|
1137
|
-
* @public
|
|
1138
|
-
*/
|
|
1139
|
-
EngagementPreferences?: EngagementPreferences | undefined;
|
|
1140
|
-
}
|
|
1141
|
-
/**
|
|
1142
|
-
* @public
|
|
1143
|
-
*/
|
|
1144
|
-
export interface UpdateProfileResponse {
|
|
1145
|
-
/**
|
|
1146
|
-
* <p>The unique identifier of a customer profile.</p>
|
|
1147
|
-
* @public
|
|
1148
|
-
*/
|
|
1149
|
-
ProfileId: string | undefined;
|
|
1150
|
-
}
|