@aws-sdk/client-customer-profiles 3.52.0 → 3.53.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/CHANGELOG.md +12 -0
- package/dist-cjs/CustomerProfiles.js +75 -0
- package/dist-cjs/commands/CreateIntegrationWorkflowCommand.js +36 -0
- package/dist-cjs/commands/DeleteWorkflowCommand.js +36 -0
- package/dist-cjs/commands/GetWorkflowCommand.js +36 -0
- package/dist-cjs/commands/GetWorkflowStepsCommand.js +36 -0
- package/dist-cjs/commands/ListWorkflowsCommand.js +36 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/CustomerProfilesServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +349 -144
- package/dist-cjs/protocols/Aws_restJson1.js +997 -1353
- package/dist-es/CustomerProfiles.js +75 -0
- package/dist-es/commands/CreateIntegrationWorkflowCommand.js +39 -0
- package/dist-es/commands/DeleteWorkflowCommand.js +39 -0
- package/dist-es/commands/GetWorkflowCommand.js +39 -0
- package/dist-es/commands/GetWorkflowStepsCommand.js +39 -0
- package/dist-es/commands/ListWorkflowsCommand.js +39 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/CustomerProfilesServiceException.js +12 -0
- package/dist-es/models/models_0.js +276 -116
- package/dist-es/protocols/Aws_restJson1.js +1569 -1539
- package/dist-types/CustomerProfiles.d.ts +37 -3
- package/dist-types/CustomerProfilesClient.d.ts +7 -2
- package/dist-types/commands/CreateIntegrationWorkflowCommand.d.ts +37 -0
- package/dist-types/commands/DeleteWorkflowCommand.d.ts +35 -0
- package/dist-types/commands/GetMatchesCommand.d.ts +0 -3
- package/dist-types/commands/GetWorkflowCommand.d.ts +35 -0
- package/dist-types/commands/GetWorkflowStepsCommand.d.ts +35 -0
- package/dist-types/commands/ListWorkflowsCommand.d.ts +35 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/CustomerProfilesServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +986 -477
- package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +25 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +7 -2
- package/dist-types/ts3.4/commands/CreateIntegrationWorkflowCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteWorkflowCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetWorkflowCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetWorkflowStepsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/CustomerProfilesServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +549 -254
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +15 -0
- package/package.json +25 -25
|
@@ -1,11 +1,16 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { CustomerProfilesServiceException as __BaseException } from "./CustomerProfilesServiceException";
|
|
2
3
|
/**
|
|
3
4
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
4
5
|
*/
|
|
5
|
-
export
|
|
6
|
-
name: "AccessDeniedException";
|
|
7
|
-
$fault: "client";
|
|
6
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
7
|
+
readonly name: "AccessDeniedException";
|
|
8
|
+
readonly $fault: "client";
|
|
8
9
|
Message?: string;
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
9
14
|
}
|
|
10
15
|
export interface AddProfileKeyRequest {
|
|
11
16
|
/**
|
|
@@ -50,34 +55,50 @@ export declare namespace AddProfileKeyResponse {
|
|
|
50
55
|
/**
|
|
51
56
|
* <p>The input you provided is invalid.</p>
|
|
52
57
|
*/
|
|
53
|
-
export
|
|
54
|
-
name: "BadRequestException";
|
|
55
|
-
$fault: "client";
|
|
58
|
+
export declare class BadRequestException extends __BaseException {
|
|
59
|
+
readonly name: "BadRequestException";
|
|
60
|
+
readonly $fault: "client";
|
|
56
61
|
Message?: string;
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
57
66
|
}
|
|
58
67
|
/**
|
|
59
68
|
* <p>An internal service error occurred.</p>
|
|
60
69
|
*/
|
|
61
|
-
export
|
|
62
|
-
name: "InternalServerException";
|
|
63
|
-
$fault: "server";
|
|
70
|
+
export declare class InternalServerException extends __BaseException {
|
|
71
|
+
readonly name: "InternalServerException";
|
|
72
|
+
readonly $fault: "server";
|
|
64
73
|
Message?: string;
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
65
78
|
}
|
|
66
79
|
/**
|
|
67
80
|
* <p>The requested resource does not exist, or access was denied.</p>
|
|
68
81
|
*/
|
|
69
|
-
export
|
|
70
|
-
name: "ResourceNotFoundException";
|
|
71
|
-
$fault: "client";
|
|
82
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
83
|
+
readonly name: "ResourceNotFoundException";
|
|
84
|
+
readonly $fault: "client";
|
|
72
85
|
Message?: string;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
73
90
|
}
|
|
74
91
|
/**
|
|
75
92
|
* <p>You exceeded the maximum number of requests.</p>
|
|
76
93
|
*/
|
|
77
|
-
export
|
|
78
|
-
name: "ThrottlingException";
|
|
79
|
-
$fault: "client";
|
|
94
|
+
export declare class ThrottlingException extends __BaseException {
|
|
95
|
+
readonly name: "ThrottlingException";
|
|
96
|
+
readonly $fault: "client";
|
|
80
97
|
Message?: string;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
81
102
|
}
|
|
82
103
|
/**
|
|
83
104
|
* <p>A generic address associated with the customer that is not mailing, shipping, or
|
|
@@ -131,84 +152,200 @@ export declare namespace Address {
|
|
|
131
152
|
*/
|
|
132
153
|
const filterSensitiveLog: (obj: Address) => any;
|
|
133
154
|
}
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
155
|
+
/**
|
|
156
|
+
* <p>Batch defines the boundaries for ingestion for each step in <code>APPFLOW_INTEGRATION</code> workflow. <code>APPFLOW_INTEGRATION</code> workflow splits ingestion based on these boundaries.</p>
|
|
157
|
+
*/
|
|
158
|
+
export interface Batch {
|
|
159
|
+
/**
|
|
160
|
+
* <p>Start time of batch to split ingestion.</p>
|
|
161
|
+
*/
|
|
162
|
+
StartTime: Date | undefined;
|
|
163
|
+
/**
|
|
164
|
+
* <p>End time of batch to split ingestion.</p>
|
|
165
|
+
*/
|
|
166
|
+
EndTime: Date | undefined;
|
|
167
|
+
}
|
|
168
|
+
export declare namespace Batch {
|
|
169
|
+
/**
|
|
170
|
+
* @internal
|
|
171
|
+
*/
|
|
172
|
+
const filterSensitiveLog: (obj: Batch) => any;
|
|
173
|
+
}
|
|
174
|
+
export declare enum SourceConnectorType {
|
|
175
|
+
MARKETO = "Marketo",
|
|
176
|
+
S3 = "S3",
|
|
177
|
+
SALESFORCE = "Salesforce",
|
|
178
|
+
SERVICENOW = "Servicenow",
|
|
179
|
+
ZENDESK = "Zendesk"
|
|
137
180
|
}
|
|
138
181
|
/**
|
|
139
|
-
* <p>
|
|
182
|
+
* <p>Specifies the configuration used when importing incremental records from the
|
|
183
|
+
* source.</p>
|
|
140
184
|
*/
|
|
141
|
-
export interface
|
|
185
|
+
export interface IncrementalPullConfig {
|
|
142
186
|
/**
|
|
143
|
-
* <p>
|
|
144
|
-
*
|
|
145
|
-
* <li>
|
|
146
|
-
* <p>
|
|
147
|
-
* <code>RECENCY</code>: Uses the data that was most recently updated.</p>
|
|
148
|
-
* </li>
|
|
149
|
-
* <li>
|
|
150
|
-
* <p>
|
|
151
|
-
* <code>SOURCE</code>: Uses the data from a specific source. For example, if a
|
|
152
|
-
* company has been aquired or two departments have merged, data from the specified
|
|
153
|
-
* source is used. If two duplicate profiles are from the same source, then
|
|
154
|
-
* <code>RECENCY</code> is used again.</p>
|
|
155
|
-
* </li>
|
|
156
|
-
* </ul>
|
|
187
|
+
* <p>A field that specifies the date time or timestamp field as the criteria to use when
|
|
188
|
+
* importing incremental records from the source.</p>
|
|
157
189
|
*/
|
|
158
|
-
|
|
190
|
+
DatetimeTypeFieldName?: string;
|
|
191
|
+
}
|
|
192
|
+
export declare namespace IncrementalPullConfig {
|
|
159
193
|
/**
|
|
160
|
-
*
|
|
161
|
-
* choosing <code>SOURCE</code> as the <code>ConflictResolvingModel</code>.</p>
|
|
194
|
+
* @internal
|
|
162
195
|
*/
|
|
163
|
-
|
|
196
|
+
const filterSensitiveLog: (obj: IncrementalPullConfig) => any;
|
|
164
197
|
}
|
|
165
|
-
|
|
198
|
+
/**
|
|
199
|
+
* <p>The properties that are applied when Marketo is being used as a source.</p>
|
|
200
|
+
*/
|
|
201
|
+
export interface MarketoSourceProperties {
|
|
202
|
+
/**
|
|
203
|
+
* <p>The object specified in the Marketo flow source.</p>
|
|
204
|
+
*/
|
|
205
|
+
Object: string | undefined;
|
|
206
|
+
}
|
|
207
|
+
export declare namespace MarketoSourceProperties {
|
|
166
208
|
/**
|
|
167
209
|
* @internal
|
|
168
210
|
*/
|
|
169
|
-
const filterSensitiveLog: (obj:
|
|
211
|
+
const filterSensitiveLog: (obj: MarketoSourceProperties) => any;
|
|
170
212
|
}
|
|
171
213
|
/**
|
|
172
|
-
* <p>The
|
|
214
|
+
* <p>The properties that are applied when Amazon S3 is being used as the flow source.</p>
|
|
173
215
|
*/
|
|
174
|
-
export interface
|
|
216
|
+
export interface S3SourceProperties {
|
|
175
217
|
/**
|
|
176
|
-
* <p>
|
|
218
|
+
* <p>The Amazon S3 bucket name where the source files are stored.</p>
|
|
177
219
|
*/
|
|
178
|
-
|
|
220
|
+
BucketName: string | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* <p>The object key for the Amazon S3 bucket in which the source files are stored.</p>
|
|
223
|
+
*/
|
|
224
|
+
BucketPrefix?: string;
|
|
179
225
|
}
|
|
180
|
-
export declare namespace
|
|
226
|
+
export declare namespace S3SourceProperties {
|
|
181
227
|
/**
|
|
182
228
|
* @internal
|
|
183
229
|
*/
|
|
184
|
-
const filterSensitiveLog: (obj:
|
|
230
|
+
const filterSensitiveLog: (obj: S3SourceProperties) => any;
|
|
185
231
|
}
|
|
186
232
|
/**
|
|
187
|
-
* <p>
|
|
233
|
+
* <p>The properties that are applied when Salesforce is being used as a source.</p>
|
|
188
234
|
*/
|
|
189
|
-
export interface
|
|
235
|
+
export interface SalesforceSourceProperties {
|
|
190
236
|
/**
|
|
191
|
-
* <p>The
|
|
237
|
+
* <p>The object specified in the Salesforce flow source.</p>
|
|
192
238
|
*/
|
|
193
|
-
|
|
239
|
+
Object: string | undefined;
|
|
194
240
|
/**
|
|
195
|
-
* <p>
|
|
196
|
-
*
|
|
241
|
+
* <p>The flag that enables dynamic fetching of new (recently added) fields in the Salesforce
|
|
242
|
+
* objects while running a flow.</p>
|
|
197
243
|
*/
|
|
198
|
-
|
|
244
|
+
EnableDynamicFieldUpdate?: boolean;
|
|
199
245
|
/**
|
|
200
|
-
* <p>
|
|
201
|
-
* example, if Profile A and Profile B have the same <code>FirstName</code> and
|
|
202
|
-
* <code>LastName</code> (and that is the matching criteria), which
|
|
203
|
-
* <code>EmailAddress</code> should be used? </p>
|
|
246
|
+
* <p>Indicates whether Amazon AppFlow includes deleted files in the flow run.</p>
|
|
204
247
|
*/
|
|
205
|
-
|
|
248
|
+
IncludeDeletedRecords?: boolean;
|
|
206
249
|
}
|
|
207
|
-
export declare namespace
|
|
250
|
+
export declare namespace SalesforceSourceProperties {
|
|
208
251
|
/**
|
|
209
252
|
* @internal
|
|
210
253
|
*/
|
|
211
|
-
const filterSensitiveLog: (obj:
|
|
254
|
+
const filterSensitiveLog: (obj: SalesforceSourceProperties) => any;
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* <p>The properties that are applied when ServiceNow is being used as a source.</p>
|
|
258
|
+
*/
|
|
259
|
+
export interface ServiceNowSourceProperties {
|
|
260
|
+
/**
|
|
261
|
+
* <p>The object specified in the ServiceNow flow source.</p>
|
|
262
|
+
*/
|
|
263
|
+
Object: string | undefined;
|
|
264
|
+
}
|
|
265
|
+
export declare namespace ServiceNowSourceProperties {
|
|
266
|
+
/**
|
|
267
|
+
* @internal
|
|
268
|
+
*/
|
|
269
|
+
const filterSensitiveLog: (obj: ServiceNowSourceProperties) => any;
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* <p>The properties that are applied when using Zendesk as a flow source.</p>
|
|
273
|
+
*/
|
|
274
|
+
export interface ZendeskSourceProperties {
|
|
275
|
+
/**
|
|
276
|
+
* <p>The object specified in the Zendesk flow source.</p>
|
|
277
|
+
*/
|
|
278
|
+
Object: string | undefined;
|
|
279
|
+
}
|
|
280
|
+
export declare namespace ZendeskSourceProperties {
|
|
281
|
+
/**
|
|
282
|
+
* @internal
|
|
283
|
+
*/
|
|
284
|
+
const filterSensitiveLog: (obj: ZendeskSourceProperties) => any;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* <p>Specifies the information that is required to query a particular Amazon AppFlow connector.
|
|
288
|
+
* Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.</p>
|
|
289
|
+
*/
|
|
290
|
+
export interface SourceConnectorProperties {
|
|
291
|
+
/**
|
|
292
|
+
* <p>The properties that are applied when Marketo is being used as a source.</p>
|
|
293
|
+
*/
|
|
294
|
+
Marketo?: MarketoSourceProperties;
|
|
295
|
+
/**
|
|
296
|
+
* <p>The properties that are applied when Amazon S3 is being used as the flow source.</p>
|
|
297
|
+
*/
|
|
298
|
+
S3?: S3SourceProperties;
|
|
299
|
+
/**
|
|
300
|
+
* <p>The properties that are applied when Salesforce is being used as a source.</p>
|
|
301
|
+
*/
|
|
302
|
+
Salesforce?: SalesforceSourceProperties;
|
|
303
|
+
/**
|
|
304
|
+
* <p>The properties that are applied when ServiceNow is being used as a source.</p>
|
|
305
|
+
*/
|
|
306
|
+
ServiceNow?: ServiceNowSourceProperties;
|
|
307
|
+
/**
|
|
308
|
+
* <p>The properties that are applied when using Zendesk as a flow source.</p>
|
|
309
|
+
*/
|
|
310
|
+
Zendesk?: ZendeskSourceProperties;
|
|
311
|
+
}
|
|
312
|
+
export declare namespace SourceConnectorProperties {
|
|
313
|
+
/**
|
|
314
|
+
* @internal
|
|
315
|
+
*/
|
|
316
|
+
const filterSensitiveLog: (obj: SourceConnectorProperties) => any;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* <p>Contains information about the configuration of the source connector used in the
|
|
320
|
+
* flow.</p>
|
|
321
|
+
*/
|
|
322
|
+
export interface SourceFlowConfig {
|
|
323
|
+
/**
|
|
324
|
+
* <p>The name of the AppFlow connector profile. This name must be unique for each connector
|
|
325
|
+
* profile in the AWS account.</p>
|
|
326
|
+
*/
|
|
327
|
+
ConnectorProfileName?: string;
|
|
328
|
+
/**
|
|
329
|
+
* <p>The type of connector, such as Salesforce, Marketo, and so on.</p>
|
|
330
|
+
*/
|
|
331
|
+
ConnectorType: SourceConnectorType | string | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* <p>Defines the configuration for a scheduled incremental data pull. If a valid
|
|
334
|
+
* configuration is provided, the fields specified in the configuration are used when querying
|
|
335
|
+
* for the incremental data pull.</p>
|
|
336
|
+
*/
|
|
337
|
+
IncrementalPullConfig?: IncrementalPullConfig;
|
|
338
|
+
/**
|
|
339
|
+
* <p>Specifies the information that is required to query a particular source
|
|
340
|
+
* connector.</p>
|
|
341
|
+
*/
|
|
342
|
+
SourceConnectorProperties: SourceConnectorProperties | undefined;
|
|
343
|
+
}
|
|
344
|
+
export declare namespace SourceFlowConfig {
|
|
345
|
+
/**
|
|
346
|
+
* @internal
|
|
347
|
+
*/
|
|
348
|
+
const filterSensitiveLog: (obj: SourceFlowConfig) => any;
|
|
212
349
|
}
|
|
213
350
|
export declare enum MarketoConnectorOperator {
|
|
214
351
|
ADDITION = "ADDITION",
|
|
@@ -343,22 +480,412 @@ export declare namespace ConnectorOperator {
|
|
|
343
480
|
*/
|
|
344
481
|
const filterSensitiveLog: (obj: ConnectorOperator) => any;
|
|
345
482
|
}
|
|
483
|
+
export declare enum OperatorPropertiesKeys {
|
|
484
|
+
CONCAT_FORMAT = "CONCAT_FORMAT",
|
|
485
|
+
DATA_TYPE = "DATA_TYPE",
|
|
486
|
+
DESTINATION_DATA_TYPE = "DESTINATION_DATA_TYPE",
|
|
487
|
+
LOWER_BOUND = "LOWER_BOUND",
|
|
488
|
+
MASK_LENGTH = "MASK_LENGTH",
|
|
489
|
+
MASK_VALUE = "MASK_VALUE",
|
|
490
|
+
MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER",
|
|
491
|
+
SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE",
|
|
492
|
+
SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP",
|
|
493
|
+
TRUNCATE_LENGTH = "TRUNCATE_LENGTH",
|
|
494
|
+
UPPER_BOUND = "UPPER_BOUND",
|
|
495
|
+
VALIDATION_ACTION = "VALIDATION_ACTION",
|
|
496
|
+
VALUE = "VALUE",
|
|
497
|
+
VALUES = "VALUES"
|
|
498
|
+
}
|
|
499
|
+
export declare enum TaskType {
|
|
500
|
+
ARITHMETIC = "Arithmetic",
|
|
501
|
+
FILTER = "Filter",
|
|
502
|
+
MAP = "Map",
|
|
503
|
+
MASK = "Mask",
|
|
504
|
+
MERGE = "Merge",
|
|
505
|
+
TRUNCATE = "Truncate",
|
|
506
|
+
VALIDATE = "Validate"
|
|
507
|
+
}
|
|
346
508
|
/**
|
|
347
|
-
* <p>
|
|
509
|
+
* <p>A class for modeling different type of tasks. Task implementation varies based on the
|
|
510
|
+
* TaskType.</p>
|
|
348
511
|
*/
|
|
349
|
-
export interface
|
|
512
|
+
export interface Task {
|
|
350
513
|
/**
|
|
351
|
-
* <p>The
|
|
514
|
+
* <p>The operation to be performed on the provided source fields.</p>
|
|
352
515
|
*/
|
|
353
|
-
|
|
516
|
+
ConnectorOperator?: ConnectorOperator;
|
|
354
517
|
/**
|
|
355
|
-
* <p>
|
|
518
|
+
* <p>A field in a destination connector, or a field value against which Amazon AppFlow validates a
|
|
519
|
+
* source field.</p>
|
|
356
520
|
*/
|
|
357
|
-
|
|
358
|
-
}
|
|
359
|
-
export declare namespace S3ExportingConfig {
|
|
521
|
+
DestinationField?: string;
|
|
360
522
|
/**
|
|
361
|
-
*
|
|
523
|
+
* <p>The source fields to which a particular task is applied.</p>
|
|
524
|
+
*/
|
|
525
|
+
SourceFields: string[] | undefined;
|
|
526
|
+
/**
|
|
527
|
+
* <p>A map used to store task-related information. The service looks for particular
|
|
528
|
+
* information based on the TaskType.</p>
|
|
529
|
+
*/
|
|
530
|
+
TaskProperties?: {
|
|
531
|
+
[key: string]: string;
|
|
532
|
+
};
|
|
533
|
+
/**
|
|
534
|
+
* <p>Specifies the particular task implementation that Amazon AppFlow performs.</p>
|
|
535
|
+
*/
|
|
536
|
+
TaskType: TaskType | string | undefined;
|
|
537
|
+
}
|
|
538
|
+
export declare namespace Task {
|
|
539
|
+
/**
|
|
540
|
+
* @internal
|
|
541
|
+
*/
|
|
542
|
+
const filterSensitiveLog: (obj: Task) => any;
|
|
543
|
+
}
|
|
544
|
+
export declare enum DataPullMode {
|
|
545
|
+
COMPLETE = "Complete",
|
|
546
|
+
INCREMENTAL = "Incremental"
|
|
547
|
+
}
|
|
548
|
+
/**
|
|
549
|
+
* <p>Specifies the configuration details of a scheduled-trigger flow that you define.
|
|
550
|
+
* Currently, these settings only apply to the scheduled-trigger type.</p>
|
|
551
|
+
*/
|
|
552
|
+
export interface ScheduledTriggerProperties {
|
|
553
|
+
/**
|
|
554
|
+
* <p>The scheduling expression that determines the rate at which the schedule will run, for
|
|
555
|
+
* example rate (5 minutes).</p>
|
|
556
|
+
*/
|
|
557
|
+
ScheduleExpression: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>Specifies whether a scheduled flow has an incremental data transfer or a complete data
|
|
560
|
+
* transfer for each flow run.</p>
|
|
561
|
+
*/
|
|
562
|
+
DataPullMode?: DataPullMode | string;
|
|
563
|
+
/**
|
|
564
|
+
* <p>Specifies the scheduled start time for a scheduled-trigger flow.</p>
|
|
565
|
+
*/
|
|
566
|
+
ScheduleStartTime?: Date;
|
|
567
|
+
/**
|
|
568
|
+
* <p>Specifies the scheduled end time for a scheduled-trigger flow.</p>
|
|
569
|
+
*/
|
|
570
|
+
ScheduleEndTime?: Date;
|
|
571
|
+
/**
|
|
572
|
+
* <p>Specifies the time zone used when referring to the date and time of a
|
|
573
|
+
* scheduled-triggered flow, such as America/New_York.</p>
|
|
574
|
+
*/
|
|
575
|
+
Timezone?: string;
|
|
576
|
+
/**
|
|
577
|
+
* <p>Specifies the optional offset that is added to the time interval for a
|
|
578
|
+
* schedule-triggered flow.</p>
|
|
579
|
+
*/
|
|
580
|
+
ScheduleOffset?: number;
|
|
581
|
+
/**
|
|
582
|
+
* <p>Specifies the date range for the records to import from the connector in the first flow
|
|
583
|
+
* run.</p>
|
|
584
|
+
*/
|
|
585
|
+
FirstExecutionFrom?: Date;
|
|
586
|
+
}
|
|
587
|
+
export declare namespace ScheduledTriggerProperties {
|
|
588
|
+
/**
|
|
589
|
+
* @internal
|
|
590
|
+
*/
|
|
591
|
+
const filterSensitiveLog: (obj: ScheduledTriggerProperties) => any;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* <p>Specifies the configuration details that control the trigger for a flow. Currently,
|
|
595
|
+
* these settings only apply to the Scheduled trigger type.</p>
|
|
596
|
+
*/
|
|
597
|
+
export interface TriggerProperties {
|
|
598
|
+
/**
|
|
599
|
+
* <p>Specifies the configuration details of a schedule-triggered flow that you define.</p>
|
|
600
|
+
*/
|
|
601
|
+
Scheduled?: ScheduledTriggerProperties;
|
|
602
|
+
}
|
|
603
|
+
export declare namespace TriggerProperties {
|
|
604
|
+
/**
|
|
605
|
+
* @internal
|
|
606
|
+
*/
|
|
607
|
+
const filterSensitiveLog: (obj: TriggerProperties) => any;
|
|
608
|
+
}
|
|
609
|
+
export declare enum TriggerType {
|
|
610
|
+
EVENT = "Event",
|
|
611
|
+
ONDEMAND = "OnDemand",
|
|
612
|
+
SCHEDULED = "Scheduled"
|
|
613
|
+
}
|
|
614
|
+
/**
|
|
615
|
+
* <p>The trigger settings that determine how and when Amazon AppFlow runs the specified
|
|
616
|
+
* flow.</p>
|
|
617
|
+
*/
|
|
618
|
+
export interface TriggerConfig {
|
|
619
|
+
/**
|
|
620
|
+
* <p>Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.</p>
|
|
621
|
+
*/
|
|
622
|
+
TriggerType: TriggerType | string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* <p>Specifies the configuration details of a schedule-triggered flow that you define.
|
|
625
|
+
* Currently, these settings only apply to the Scheduled trigger type.</p>
|
|
626
|
+
*/
|
|
627
|
+
TriggerProperties?: TriggerProperties;
|
|
628
|
+
}
|
|
629
|
+
export declare namespace TriggerConfig {
|
|
630
|
+
/**
|
|
631
|
+
* @internal
|
|
632
|
+
*/
|
|
633
|
+
const filterSensitiveLog: (obj: TriggerConfig) => any;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* <p>The configurations that control how Customer Profiles retrieves data from the source,
|
|
637
|
+
* Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of
|
|
638
|
+
* customers.</p>
|
|
639
|
+
*/
|
|
640
|
+
export interface FlowDefinition {
|
|
641
|
+
/**
|
|
642
|
+
* <p>A description of the flow you want to create.</p>
|
|
643
|
+
*/
|
|
644
|
+
Description?: string;
|
|
645
|
+
/**
|
|
646
|
+
* <p>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not
|
|
647
|
+
* allowed.</p>
|
|
648
|
+
*/
|
|
649
|
+
FlowName: string | undefined;
|
|
650
|
+
/**
|
|
651
|
+
* <p>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</p>
|
|
652
|
+
*/
|
|
653
|
+
KmsArn: string | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* <p>The configuration that controls how Customer Profiles retrieves data from the
|
|
656
|
+
* source.</p>
|
|
657
|
+
*/
|
|
658
|
+
SourceFlowConfig: SourceFlowConfig | undefined;
|
|
659
|
+
/**
|
|
660
|
+
* <p>A list of tasks that Customer Profiles performs while transferring the data in the flow
|
|
661
|
+
* run.</p>
|
|
662
|
+
*/
|
|
663
|
+
Tasks: Task[] | undefined;
|
|
664
|
+
/**
|
|
665
|
+
* <p>The trigger settings that determine how and when the flow runs.</p>
|
|
666
|
+
*/
|
|
667
|
+
TriggerConfig: TriggerConfig | undefined;
|
|
668
|
+
}
|
|
669
|
+
export declare namespace FlowDefinition {
|
|
670
|
+
/**
|
|
671
|
+
* @internal
|
|
672
|
+
*/
|
|
673
|
+
const filterSensitiveLog: (obj: FlowDefinition) => any;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* <p>Details for workflow of type <code>APPFLOW_INTEGRATION</code>.</p>
|
|
677
|
+
*/
|
|
678
|
+
export interface AppflowIntegration {
|
|
679
|
+
/**
|
|
680
|
+
* <p>The configurations that control how Customer Profiles retrieves data from the source,
|
|
681
|
+
* Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of
|
|
682
|
+
* customers.</p>
|
|
683
|
+
*/
|
|
684
|
+
FlowDefinition: FlowDefinition | undefined;
|
|
685
|
+
/**
|
|
686
|
+
* <p>Batches in workflow of type <code>APPFLOW_INTEGRATION</code>.</p>
|
|
687
|
+
*/
|
|
688
|
+
Batches?: Batch[];
|
|
689
|
+
}
|
|
690
|
+
export declare namespace AppflowIntegration {
|
|
691
|
+
/**
|
|
692
|
+
* @internal
|
|
693
|
+
*/
|
|
694
|
+
const filterSensitiveLog: (obj: AppflowIntegration) => any;
|
|
695
|
+
}
|
|
696
|
+
/**
|
|
697
|
+
* <p>Structure holding all <code>APPFLOW_INTEGRATION</code> specific workflow attributes.</p>
|
|
698
|
+
*/
|
|
699
|
+
export interface AppflowIntegrationWorkflowAttributes {
|
|
700
|
+
/**
|
|
701
|
+
* <p>Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.</p>
|
|
702
|
+
*/
|
|
703
|
+
SourceConnectorType: SourceConnectorType | string | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* <p>The name of the AppFlow connector profile used for ingestion.</p>
|
|
706
|
+
*/
|
|
707
|
+
ConnectorProfileName: string | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.</p>
|
|
710
|
+
*/
|
|
711
|
+
RoleArn?: string;
|
|
712
|
+
}
|
|
713
|
+
export declare namespace AppflowIntegrationWorkflowAttributes {
|
|
714
|
+
/**
|
|
715
|
+
* @internal
|
|
716
|
+
*/
|
|
717
|
+
const filterSensitiveLog: (obj: AppflowIntegrationWorkflowAttributes) => any;
|
|
718
|
+
}
|
|
719
|
+
/**
|
|
720
|
+
* <p>Workflow specific execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
721
|
+
*/
|
|
722
|
+
export interface AppflowIntegrationWorkflowMetrics {
|
|
723
|
+
/**
|
|
724
|
+
* <p>Number of records processed in <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
725
|
+
*/
|
|
726
|
+
RecordsProcessed: number | undefined;
|
|
727
|
+
/**
|
|
728
|
+
* <p>Total steps completed in <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
729
|
+
*/
|
|
730
|
+
StepsCompleted: number | undefined;
|
|
731
|
+
/**
|
|
732
|
+
* <p>Total steps in <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
733
|
+
*/
|
|
734
|
+
TotalSteps: number | undefined;
|
|
735
|
+
}
|
|
736
|
+
export declare namespace AppflowIntegrationWorkflowMetrics {
|
|
737
|
+
/**
|
|
738
|
+
* @internal
|
|
739
|
+
*/
|
|
740
|
+
const filterSensitiveLog: (obj: AppflowIntegrationWorkflowMetrics) => any;
|
|
741
|
+
}
|
|
742
|
+
export declare enum Status {
|
|
743
|
+
CANCELLED = "CANCELLED",
|
|
744
|
+
COMPLETE = "COMPLETE",
|
|
745
|
+
FAILED = "FAILED",
|
|
746
|
+
IN_PROGRESS = "IN_PROGRESS",
|
|
747
|
+
NOT_STARTED = "NOT_STARTED",
|
|
748
|
+
RETRY = "RETRY",
|
|
749
|
+
SPLIT = "SPLIT"
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* <p>Workflow step details for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
753
|
+
*/
|
|
754
|
+
export interface AppflowIntegrationWorkflowStep {
|
|
755
|
+
/**
|
|
756
|
+
* <p>Name of the flow created during execution of workflow step. <code>APPFLOW_INTEGRATION</code> workflow type creates an appflow flow during workflow step execution on the customers behalf.</p>
|
|
757
|
+
*/
|
|
758
|
+
FlowName: string | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* <p>Workflow step status for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
761
|
+
*/
|
|
762
|
+
Status: Status | string | undefined;
|
|
763
|
+
/**
|
|
764
|
+
* <p>Message indicating execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
765
|
+
*/
|
|
766
|
+
ExecutionMessage: string | undefined;
|
|
767
|
+
/**
|
|
768
|
+
* <p>Total number of records processed during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
769
|
+
*/
|
|
770
|
+
RecordsProcessed: number | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* <p>Start datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
773
|
+
*/
|
|
774
|
+
BatchRecordsStartTime: string | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>End datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
777
|
+
*/
|
|
778
|
+
BatchRecordsEndTime: string | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* <p>Creation timestamp of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
781
|
+
*/
|
|
782
|
+
CreatedAt: Date | undefined;
|
|
783
|
+
/**
|
|
784
|
+
* <p>Last updated timestamp for workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
785
|
+
*/
|
|
786
|
+
LastUpdatedAt: Date | undefined;
|
|
787
|
+
}
|
|
788
|
+
export declare namespace AppflowIntegrationWorkflowStep {
|
|
789
|
+
/**
|
|
790
|
+
* @internal
|
|
791
|
+
*/
|
|
792
|
+
const filterSensitiveLog: (obj: AppflowIntegrationWorkflowStep) => any;
|
|
793
|
+
}
|
|
794
|
+
export declare enum ConflictResolvingModel {
|
|
795
|
+
RECENCY = "RECENCY",
|
|
796
|
+
SOURCE = "SOURCE"
|
|
797
|
+
}
|
|
798
|
+
/**
|
|
799
|
+
* <p>How the auto-merging process should resolve conflicts between different profiles.</p>
|
|
800
|
+
*/
|
|
801
|
+
export interface ConflictResolution {
|
|
802
|
+
/**
|
|
803
|
+
* <p>How the auto-merging process should resolve conflicts between different profiles.</p>
|
|
804
|
+
* <ul>
|
|
805
|
+
* <li>
|
|
806
|
+
* <p>
|
|
807
|
+
* <code>RECENCY</code>: Uses the data that was most recently updated.</p>
|
|
808
|
+
* </li>
|
|
809
|
+
* <li>
|
|
810
|
+
* <p>
|
|
811
|
+
* <code>SOURCE</code>: Uses the data from a specific source. For example, if a
|
|
812
|
+
* company has been aquired or two departments have merged, data from the specified
|
|
813
|
+
* source is used. If two duplicate profiles are from the same source, then
|
|
814
|
+
* <code>RECENCY</code> is used again.</p>
|
|
815
|
+
* </li>
|
|
816
|
+
* </ul>
|
|
817
|
+
*/
|
|
818
|
+
ConflictResolvingModel: ConflictResolvingModel | string | undefined;
|
|
819
|
+
/**
|
|
820
|
+
* <p>The <code>ObjectType</code> name that is used to resolve profile merging conflicts when
|
|
821
|
+
* choosing <code>SOURCE</code> as the <code>ConflictResolvingModel</code>.</p>
|
|
822
|
+
*/
|
|
823
|
+
SourceName?: string;
|
|
824
|
+
}
|
|
825
|
+
export declare namespace ConflictResolution {
|
|
826
|
+
/**
|
|
827
|
+
* @internal
|
|
828
|
+
*/
|
|
829
|
+
const filterSensitiveLog: (obj: ConflictResolution) => any;
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
* <p>The matching criteria to be used during the auto-merging process. </p>
|
|
833
|
+
*/
|
|
834
|
+
export interface Consolidation {
|
|
835
|
+
/**
|
|
836
|
+
* <p>A list of matching criteria.</p>
|
|
837
|
+
*/
|
|
838
|
+
MatchingAttributesList: string[][] | undefined;
|
|
839
|
+
}
|
|
840
|
+
export declare namespace Consolidation {
|
|
841
|
+
/**
|
|
842
|
+
* @internal
|
|
843
|
+
*/
|
|
844
|
+
const filterSensitiveLog: (obj: Consolidation) => any;
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* <p>Configuration settings for how to perform the auto-merging of profiles.</p>
|
|
848
|
+
*/
|
|
849
|
+
export interface AutoMerging {
|
|
850
|
+
/**
|
|
851
|
+
* <p>The flag that enables the auto-merging of duplicate profiles.</p>
|
|
852
|
+
*/
|
|
853
|
+
Enabled: boolean | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* <p>A list of matching attributes that represent matching criteria. If two profiles meet at
|
|
856
|
+
* least one of the requirements in the matching attributes list, they will be merged.</p>
|
|
857
|
+
*/
|
|
858
|
+
Consolidation?: Consolidation;
|
|
859
|
+
/**
|
|
860
|
+
* <p>How the auto-merging process should resolve conflicts between different profiles. For
|
|
861
|
+
* example, if Profile A and Profile B have the same <code>FirstName</code> and
|
|
862
|
+
* <code>LastName</code> (and that is the matching criteria), which
|
|
863
|
+
* <code>EmailAddress</code> should be used? </p>
|
|
864
|
+
*/
|
|
865
|
+
ConflictResolution?: ConflictResolution;
|
|
866
|
+
}
|
|
867
|
+
export declare namespace AutoMerging {
|
|
868
|
+
/**
|
|
869
|
+
* @internal
|
|
870
|
+
*/
|
|
871
|
+
const filterSensitiveLog: (obj: AutoMerging) => any;
|
|
872
|
+
}
|
|
873
|
+
/**
|
|
874
|
+
* <p>Configuration information about the S3 bucket where Identity Resolution Jobs write result files.</p>
|
|
875
|
+
*/
|
|
876
|
+
export interface S3ExportingConfig {
|
|
877
|
+
/**
|
|
878
|
+
* <p>The name of the S3 bucket where Identity Resolution Jobs write result files.</p>
|
|
879
|
+
*/
|
|
880
|
+
S3BucketName: string | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>The S3 key name of the location where Identity Resolution Jobs write result files.</p>
|
|
883
|
+
*/
|
|
884
|
+
S3KeyName?: string;
|
|
885
|
+
}
|
|
886
|
+
export declare namespace S3ExportingConfig {
|
|
887
|
+
/**
|
|
888
|
+
* @internal
|
|
362
889
|
*/
|
|
363
890
|
const filterSensitiveLog: (obj: S3ExportingConfig) => any;
|
|
364
891
|
}
|
|
@@ -562,6 +1089,74 @@ export declare namespace CreateDomainResponse {
|
|
|
562
1089
|
*/
|
|
563
1090
|
const filterSensitiveLog: (obj: CreateDomainResponse) => any;
|
|
564
1091
|
}
|
|
1092
|
+
/**
|
|
1093
|
+
* <p>Configuration data for integration workflow.</p>
|
|
1094
|
+
*/
|
|
1095
|
+
export interface IntegrationConfig {
|
|
1096
|
+
/**
|
|
1097
|
+
* <p>Configuration data for <code>APPFLOW_INTEGRATION</code> workflow type.</p>
|
|
1098
|
+
*/
|
|
1099
|
+
AppflowIntegration?: AppflowIntegration;
|
|
1100
|
+
}
|
|
1101
|
+
export declare namespace IntegrationConfig {
|
|
1102
|
+
/**
|
|
1103
|
+
* @internal
|
|
1104
|
+
*/
|
|
1105
|
+
const filterSensitiveLog: (obj: IntegrationConfig) => any;
|
|
1106
|
+
}
|
|
1107
|
+
export declare enum WorkflowType {
|
|
1108
|
+
APPFLOW_INTEGRATION = "APPFLOW_INTEGRATION"
|
|
1109
|
+
}
|
|
1110
|
+
export interface CreateIntegrationWorkflowRequest {
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>The unique name of the domain.</p>
|
|
1113
|
+
*/
|
|
1114
|
+
DomainName: string | undefined;
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
WorkflowType: WorkflowType | string | undefined;
|
|
1119
|
+
/**
|
|
1120
|
+
* <p>Configuration data for integration workflow.</p>
|
|
1121
|
+
*/
|
|
1122
|
+
IntegrationConfig: IntegrationConfig | undefined;
|
|
1123
|
+
/**
|
|
1124
|
+
* <p>The name of the profile object type.</p>
|
|
1125
|
+
*/
|
|
1126
|
+
ObjectTypeName: string | undefined;
|
|
1127
|
+
/**
|
|
1128
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.</p>
|
|
1129
|
+
*/
|
|
1130
|
+
RoleArn: string | undefined;
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1133
|
+
*/
|
|
1134
|
+
Tags?: {
|
|
1135
|
+
[key: string]: string;
|
|
1136
|
+
};
|
|
1137
|
+
}
|
|
1138
|
+
export declare namespace CreateIntegrationWorkflowRequest {
|
|
1139
|
+
/**
|
|
1140
|
+
* @internal
|
|
1141
|
+
*/
|
|
1142
|
+
const filterSensitiveLog: (obj: CreateIntegrationWorkflowRequest) => any;
|
|
1143
|
+
}
|
|
1144
|
+
export interface CreateIntegrationWorkflowResponse {
|
|
1145
|
+
/**
|
|
1146
|
+
* <p>Unique identifier for the workflow.</p>
|
|
1147
|
+
*/
|
|
1148
|
+
WorkflowId: string | undefined;
|
|
1149
|
+
/**
|
|
1150
|
+
* <p>A message indicating create request was received.</p>
|
|
1151
|
+
*/
|
|
1152
|
+
Message: string | undefined;
|
|
1153
|
+
}
|
|
1154
|
+
export declare namespace CreateIntegrationWorkflowResponse {
|
|
1155
|
+
/**
|
|
1156
|
+
* @internal
|
|
1157
|
+
*/
|
|
1158
|
+
const filterSensitiveLog: (obj: CreateIntegrationWorkflowResponse) => any;
|
|
1159
|
+
}
|
|
565
1160
|
export declare enum Gender {
|
|
566
1161
|
FEMALE = "FEMALE",
|
|
567
1162
|
MALE = "MALE",
|
|
@@ -865,6 +1460,30 @@ export declare namespace DeleteProfileObjectTypeResponse {
|
|
|
865
1460
|
*/
|
|
866
1461
|
const filterSensitiveLog: (obj: DeleteProfileObjectTypeResponse) => any;
|
|
867
1462
|
}
|
|
1463
|
+
export interface DeleteWorkflowRequest {
|
|
1464
|
+
/**
|
|
1465
|
+
* <p>The unique name of the domain.</p>
|
|
1466
|
+
*/
|
|
1467
|
+
DomainName: string | undefined;
|
|
1468
|
+
/**
|
|
1469
|
+
* <p>Unique identifier for the workflow.</p>
|
|
1470
|
+
*/
|
|
1471
|
+
WorkflowId: string | undefined;
|
|
1472
|
+
}
|
|
1473
|
+
export declare namespace DeleteWorkflowRequest {
|
|
1474
|
+
/**
|
|
1475
|
+
* @internal
|
|
1476
|
+
*/
|
|
1477
|
+
const filterSensitiveLog: (obj: DeleteWorkflowRequest) => any;
|
|
1478
|
+
}
|
|
1479
|
+
export interface DeleteWorkflowResponse {
|
|
1480
|
+
}
|
|
1481
|
+
export declare namespace DeleteWorkflowResponse {
|
|
1482
|
+
/**
|
|
1483
|
+
* @internal
|
|
1484
|
+
*/
|
|
1485
|
+
const filterSensitiveLog: (obj: DeleteWorkflowResponse) => any;
|
|
1486
|
+
}
|
|
868
1487
|
export interface GetAutoMergingPreviewRequest {
|
|
869
1488
|
/**
|
|
870
1489
|
* <p>The unique name of the domain.</p>
|
|
@@ -1226,6 +1845,10 @@ export interface GetIntegrationResponse {
|
|
|
1226
1845
|
ObjectTypeNames?: {
|
|
1227
1846
|
[key: string]: string;
|
|
1228
1847
|
};
|
|
1848
|
+
/**
|
|
1849
|
+
* <p>Unique identifier for the workflow.</p>
|
|
1850
|
+
*/
|
|
1851
|
+
WorkflowId?: string;
|
|
1229
1852
|
}
|
|
1230
1853
|
export declare namespace GetIntegrationResponse {
|
|
1231
1854
|
/**
|
|
@@ -1506,11 +2129,161 @@ export interface GetProfileObjectTypeTemplateResponse {
|
|
|
1506
2129
|
[key: string]: ObjectTypeKey[];
|
|
1507
2130
|
};
|
|
1508
2131
|
}
|
|
1509
|
-
export declare namespace GetProfileObjectTypeTemplateResponse {
|
|
2132
|
+
export declare namespace GetProfileObjectTypeTemplateResponse {
|
|
2133
|
+
/**
|
|
2134
|
+
* @internal
|
|
2135
|
+
*/
|
|
2136
|
+
const filterSensitiveLog: (obj: GetProfileObjectTypeTemplateResponse) => any;
|
|
2137
|
+
}
|
|
2138
|
+
export interface GetWorkflowRequest {
|
|
2139
|
+
/**
|
|
2140
|
+
* <p>The unique name of the domain.</p>
|
|
2141
|
+
*/
|
|
2142
|
+
DomainName: string | undefined;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>Unique identifier for the workflow.</p>
|
|
2145
|
+
*/
|
|
2146
|
+
WorkflowId: string | undefined;
|
|
2147
|
+
}
|
|
2148
|
+
export declare namespace GetWorkflowRequest {
|
|
2149
|
+
/**
|
|
2150
|
+
* @internal
|
|
2151
|
+
*/
|
|
2152
|
+
const filterSensitiveLog: (obj: GetWorkflowRequest) => any;
|
|
2153
|
+
}
|
|
2154
|
+
/**
|
|
2155
|
+
* <p>Structure to hold workflow attributes.</p>
|
|
2156
|
+
*/
|
|
2157
|
+
export interface WorkflowAttributes {
|
|
2158
|
+
/**
|
|
2159
|
+
* <p>Workflow attributes specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
2160
|
+
*/
|
|
2161
|
+
AppflowIntegration?: AppflowIntegrationWorkflowAttributes;
|
|
2162
|
+
}
|
|
2163
|
+
export declare namespace WorkflowAttributes {
|
|
2164
|
+
/**
|
|
2165
|
+
* @internal
|
|
2166
|
+
*/
|
|
2167
|
+
const filterSensitiveLog: (obj: WorkflowAttributes) => any;
|
|
2168
|
+
}
|
|
2169
|
+
/**
|
|
2170
|
+
* <p>Generic object containing workflow execution metrics.</p>
|
|
2171
|
+
*/
|
|
2172
|
+
export interface WorkflowMetrics {
|
|
2173
|
+
/**
|
|
2174
|
+
* <p>Workflow execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
2175
|
+
*/
|
|
2176
|
+
AppflowIntegration?: AppflowIntegrationWorkflowMetrics;
|
|
2177
|
+
}
|
|
2178
|
+
export declare namespace WorkflowMetrics {
|
|
2179
|
+
/**
|
|
2180
|
+
* @internal
|
|
2181
|
+
*/
|
|
2182
|
+
const filterSensitiveLog: (obj: WorkflowMetrics) => any;
|
|
2183
|
+
}
|
|
2184
|
+
export interface GetWorkflowResponse {
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>Unique identifier for the workflow.</p>
|
|
2187
|
+
*/
|
|
2188
|
+
WorkflowId?: string;
|
|
2189
|
+
/**
|
|
2190
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
2191
|
+
*/
|
|
2192
|
+
WorkflowType?: WorkflowType | string;
|
|
2193
|
+
/**
|
|
2194
|
+
* <p>Status of workflow execution.</p>
|
|
2195
|
+
*/
|
|
2196
|
+
Status?: Status | string;
|
|
2197
|
+
/**
|
|
2198
|
+
* <p>Workflow error messages during execution (if any).</p>
|
|
2199
|
+
*/
|
|
2200
|
+
ErrorDescription?: string;
|
|
2201
|
+
/**
|
|
2202
|
+
* <p>The timestamp that represents when workflow execution started.</p>
|
|
2203
|
+
*/
|
|
2204
|
+
StartDate?: Date;
|
|
2205
|
+
/**
|
|
2206
|
+
* <p>The timestamp that represents when workflow execution last updated.</p>
|
|
2207
|
+
*/
|
|
2208
|
+
LastUpdatedAt?: Date;
|
|
2209
|
+
/**
|
|
2210
|
+
* <p>Attributes provided for workflow execution.</p>
|
|
2211
|
+
*/
|
|
2212
|
+
Attributes?: WorkflowAttributes;
|
|
2213
|
+
/**
|
|
2214
|
+
* <p>Workflow specific execution metrics.</p>
|
|
2215
|
+
*/
|
|
2216
|
+
Metrics?: WorkflowMetrics;
|
|
2217
|
+
}
|
|
2218
|
+
export declare namespace GetWorkflowResponse {
|
|
2219
|
+
/**
|
|
2220
|
+
* @internal
|
|
2221
|
+
*/
|
|
2222
|
+
const filterSensitiveLog: (obj: GetWorkflowResponse) => any;
|
|
2223
|
+
}
|
|
2224
|
+
export interface GetWorkflowStepsRequest {
|
|
2225
|
+
/**
|
|
2226
|
+
* <p>The unique name of the domain.</p>
|
|
2227
|
+
*/
|
|
2228
|
+
DomainName: string | undefined;
|
|
2229
|
+
/**
|
|
2230
|
+
* <p>Unique identifier for the workflow.</p>
|
|
2231
|
+
*/
|
|
2232
|
+
WorkflowId: string | undefined;
|
|
2233
|
+
/**
|
|
2234
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2235
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2236
|
+
*/
|
|
2237
|
+
NextToken?: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2240
|
+
*/
|
|
2241
|
+
MaxResults?: number;
|
|
2242
|
+
}
|
|
2243
|
+
export declare namespace GetWorkflowStepsRequest {
|
|
2244
|
+
/**
|
|
2245
|
+
* @internal
|
|
2246
|
+
*/
|
|
2247
|
+
const filterSensitiveLog: (obj: GetWorkflowStepsRequest) => any;
|
|
2248
|
+
}
|
|
2249
|
+
/**
|
|
2250
|
+
* <p>List containing steps in workflow.</p>
|
|
2251
|
+
*/
|
|
2252
|
+
export interface WorkflowStepItem {
|
|
2253
|
+
/**
|
|
2254
|
+
* <p>Workflow step information specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
2255
|
+
*/
|
|
2256
|
+
AppflowIntegration?: AppflowIntegrationWorkflowStep;
|
|
2257
|
+
}
|
|
2258
|
+
export declare namespace WorkflowStepItem {
|
|
2259
|
+
/**
|
|
2260
|
+
* @internal
|
|
2261
|
+
*/
|
|
2262
|
+
const filterSensitiveLog: (obj: WorkflowStepItem) => any;
|
|
2263
|
+
}
|
|
2264
|
+
export interface GetWorkflowStepsResponse {
|
|
2265
|
+
/**
|
|
2266
|
+
* <p>Unique identifier for the workflow.</p>
|
|
2267
|
+
*/
|
|
2268
|
+
WorkflowId?: string;
|
|
2269
|
+
/**
|
|
2270
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
2271
|
+
*/
|
|
2272
|
+
WorkflowType?: WorkflowType | string;
|
|
2273
|
+
/**
|
|
2274
|
+
* <p>List containing workflow step details.</p>
|
|
2275
|
+
*/
|
|
2276
|
+
Items?: WorkflowStepItem[];
|
|
2277
|
+
/**
|
|
2278
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2279
|
+
*/
|
|
2280
|
+
NextToken?: string;
|
|
2281
|
+
}
|
|
2282
|
+
export declare namespace GetWorkflowStepsResponse {
|
|
1510
2283
|
/**
|
|
1511
2284
|
* @internal
|
|
1512
2285
|
*/
|
|
1513
|
-
const filterSensitiveLog: (obj:
|
|
2286
|
+
const filterSensitiveLog: (obj: GetWorkflowStepsResponse) => any;
|
|
1514
2287
|
}
|
|
1515
2288
|
export interface ListAccountIntegrationsRequest {
|
|
1516
2289
|
/**
|
|
@@ -1525,6 +2298,10 @@ export interface ListAccountIntegrationsRequest {
|
|
|
1525
2298
|
* <p>The maximum number of objects returned per page.</p>
|
|
1526
2299
|
*/
|
|
1527
2300
|
MaxResults?: number;
|
|
2301
|
+
/**
|
|
2302
|
+
* <p>Boolean to indicate if hidden integration should be returned. Defaults to <code>False</code>.</p>
|
|
2303
|
+
*/
|
|
2304
|
+
IncludeHidden?: boolean;
|
|
1528
2305
|
}
|
|
1529
2306
|
export declare namespace ListAccountIntegrationsRequest {
|
|
1530
2307
|
/**
|
|
@@ -1570,6 +2347,10 @@ export interface ListIntegrationItem {
|
|
|
1570
2347
|
ObjectTypeNames?: {
|
|
1571
2348
|
[key: string]: string;
|
|
1572
2349
|
};
|
|
2350
|
+
/**
|
|
2351
|
+
* <p>Unique identifier for the workflow.</p>
|
|
2352
|
+
*/
|
|
2353
|
+
WorkflowId?: string;
|
|
1573
2354
|
}
|
|
1574
2355
|
export declare namespace ListIntegrationItem {
|
|
1575
2356
|
/**
|
|
@@ -1782,6 +2563,10 @@ export interface ListIntegrationsRequest {
|
|
|
1782
2563
|
* <p>The maximum number of objects returned per page.</p>
|
|
1783
2564
|
*/
|
|
1784
2565
|
MaxResults?: number;
|
|
2566
|
+
/**
|
|
2567
|
+
* <p>Boolean to indicate if hidden integration should be returned. Defaults to <code>False</code>.</p>
|
|
2568
|
+
*/
|
|
2569
|
+
IncludeHidden?: boolean;
|
|
1785
2570
|
}
|
|
1786
2571
|
export declare namespace ListIntegrationsRequest {
|
|
1787
2572
|
/**
|
|
@@ -2052,508 +2837,228 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
2052
2837
|
*/
|
|
2053
2838
|
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
2054
2839
|
}
|
|
2055
|
-
|
|
2056
|
-
* <p>A duplicate customer profile that is to be merged into a main profile. </p>
|
|
2057
|
-
*/
|
|
2058
|
-
export interface FieldSourceProfileIds {
|
|
2059
|
-
/**
|
|
2060
|
-
* <p>A unique identifier for the account number field to be merged. </p>
|
|
2061
|
-
*/
|
|
2062
|
-
AccountNumber?: string;
|
|
2063
|
-
/**
|
|
2064
|
-
* <p>A unique identifier for the additional information field to be merged.</p>
|
|
2065
|
-
*/
|
|
2066
|
-
AdditionalInformation?: string;
|
|
2067
|
-
/**
|
|
2068
|
-
* <p>A unique identifier for the party type field to be merged.</p>
|
|
2069
|
-
*/
|
|
2070
|
-
PartyType?: string;
|
|
2071
|
-
/**
|
|
2072
|
-
* <p>A unique identifier for the business name field to be merged.</p>
|
|
2073
|
-
*/
|
|
2074
|
-
BusinessName?: string;
|
|
2075
|
-
/**
|
|
2076
|
-
* <p>A unique identifier for the first name field to be merged.</p>
|
|
2077
|
-
*/
|
|
2078
|
-
FirstName?: string;
|
|
2079
|
-
/**
|
|
2080
|
-
* <p>A unique identifier for the middle name field to be merged.</p>
|
|
2081
|
-
*/
|
|
2082
|
-
MiddleName?: string;
|
|
2083
|
-
/**
|
|
2084
|
-
* <p>A unique identifier for the last name field to be merged.</p>
|
|
2085
|
-
*/
|
|
2086
|
-
LastName?: string;
|
|
2087
|
-
/**
|
|
2088
|
-
* <p>A unique identifier for the birthdate field to be merged.</p>
|
|
2089
|
-
*/
|
|
2090
|
-
BirthDate?: string;
|
|
2091
|
-
/**
|
|
2092
|
-
* <p>A unique identifier for the gender field to be merged.</p>
|
|
2093
|
-
*/
|
|
2094
|
-
Gender?: string;
|
|
2095
|
-
/**
|
|
2096
|
-
* <p>A unique identifier for the phone number field to be merged.</p>
|
|
2097
|
-
*/
|
|
2098
|
-
PhoneNumber?: string;
|
|
2099
|
-
/**
|
|
2100
|
-
* <p>A unique identifier for the mobile phone number field to be merged.</p>
|
|
2101
|
-
*/
|
|
2102
|
-
MobilePhoneNumber?: string;
|
|
2103
|
-
/**
|
|
2104
|
-
* <p>A unique identifier for the home phone number field to be merged.</p>
|
|
2105
|
-
*/
|
|
2106
|
-
HomePhoneNumber?: string;
|
|
2107
|
-
/**
|
|
2108
|
-
* <p>A unique identifier for the business phone number field to be merged.</p>
|
|
2109
|
-
*/
|
|
2110
|
-
BusinessPhoneNumber?: string;
|
|
2111
|
-
/**
|
|
2112
|
-
* <p>A unique identifier for the email address field to be merged.</p>
|
|
2113
|
-
*/
|
|
2114
|
-
EmailAddress?: string;
|
|
2115
|
-
/**
|
|
2116
|
-
* <p>A unique identifier for the personal email address field to be merged.</p>
|
|
2117
|
-
*/
|
|
2118
|
-
PersonalEmailAddress?: string;
|
|
2119
|
-
/**
|
|
2120
|
-
* <p>A unique identifier for the party type field to be merged.</p>
|
|
2121
|
-
*/
|
|
2122
|
-
BusinessEmailAddress?: string;
|
|
2123
|
-
/**
|
|
2124
|
-
* <p>A unique identifier for the party type field to be merged.</p>
|
|
2125
|
-
*/
|
|
2126
|
-
Address?: string;
|
|
2127
|
-
/**
|
|
2128
|
-
* <p>A unique identifier for the shipping address field to be merged.</p>
|
|
2129
|
-
*/
|
|
2130
|
-
ShippingAddress?: string;
|
|
2131
|
-
/**
|
|
2132
|
-
* <p>A unique identifier for the mailing address field to be merged.</p>
|
|
2133
|
-
*/
|
|
2134
|
-
MailingAddress?: string;
|
|
2135
|
-
/**
|
|
2136
|
-
* <p>A unique identifier for the billing type field to be merged.</p>
|
|
2137
|
-
*/
|
|
2138
|
-
BillingAddress?: string;
|
|
2139
|
-
/**
|
|
2140
|
-
* <p>A unique identifier for the attributes field to be merged.</p>
|
|
2141
|
-
*/
|
|
2142
|
-
Attributes?: {
|
|
2143
|
-
[key: string]: string;
|
|
2144
|
-
};
|
|
2145
|
-
}
|
|
2146
|
-
export declare namespace FieldSourceProfileIds {
|
|
2147
|
-
/**
|
|
2148
|
-
* @internal
|
|
2149
|
-
*/
|
|
2150
|
-
const filterSensitiveLog: (obj: FieldSourceProfileIds) => any;
|
|
2151
|
-
}
|
|
2152
|
-
export interface MergeProfilesRequest {
|
|
2840
|
+
export interface ListWorkflowsRequest {
|
|
2153
2841
|
/**
|
|
2154
2842
|
* <p>The unique name of the domain.</p>
|
|
2155
2843
|
*/
|
|
2156
2844
|
DomainName: string | undefined;
|
|
2157
2845
|
/**
|
|
2158
|
-
* <p>The
|
|
2159
|
-
*/
|
|
2160
|
-
MainProfileId: string | undefined;
|
|
2161
|
-
/**
|
|
2162
|
-
* <p>The identifier of the profile to be merged into MainProfileId.</p>
|
|
2163
|
-
*/
|
|
2164
|
-
ProfileIdsToBeMerged: string[] | undefined;
|
|
2165
|
-
/**
|
|
2166
|
-
* <p>The identifiers of the fields in the profile that has the information you want to apply
|
|
2167
|
-
* to the merge. For example, say you want to merge EmailAddress from Profile1 into
|
|
2168
|
-
* MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
|
|
2169
|
-
*/
|
|
2170
|
-
FieldSourceProfileIds?: FieldSourceProfileIds;
|
|
2171
|
-
}
|
|
2172
|
-
export declare namespace MergeProfilesRequest {
|
|
2173
|
-
/**
|
|
2174
|
-
* @internal
|
|
2175
|
-
*/
|
|
2176
|
-
const filterSensitiveLog: (obj: MergeProfilesRequest) => any;
|
|
2177
|
-
}
|
|
2178
|
-
export interface MergeProfilesResponse {
|
|
2179
|
-
/**
|
|
2180
|
-
* <p>A message that indicates the merge request is complete.</p>
|
|
2181
|
-
*/
|
|
2182
|
-
Message?: string;
|
|
2183
|
-
}
|
|
2184
|
-
export declare namespace MergeProfilesResponse {
|
|
2185
|
-
/**
|
|
2186
|
-
* @internal
|
|
2187
|
-
*/
|
|
2188
|
-
const filterSensitiveLog: (obj: MergeProfilesResponse) => any;
|
|
2189
|
-
}
|
|
2190
|
-
export declare enum SourceConnectorType {
|
|
2191
|
-
MARKETO = "Marketo",
|
|
2192
|
-
S3 = "S3",
|
|
2193
|
-
SALESFORCE = "Salesforce",
|
|
2194
|
-
SERVICENOW = "Servicenow",
|
|
2195
|
-
ZENDESK = "Zendesk"
|
|
2196
|
-
}
|
|
2197
|
-
/**
|
|
2198
|
-
* <p>Specifies the configuration used when importing incremental records from the
|
|
2199
|
-
* source.</p>
|
|
2200
|
-
*/
|
|
2201
|
-
export interface IncrementalPullConfig {
|
|
2202
|
-
/**
|
|
2203
|
-
* <p>A field that specifies the date time or timestamp field as the criteria to use when
|
|
2204
|
-
* importing incremental records from the source.</p>
|
|
2205
|
-
*/
|
|
2206
|
-
DatetimeTypeFieldName?: string;
|
|
2207
|
-
}
|
|
2208
|
-
export declare namespace IncrementalPullConfig {
|
|
2209
|
-
/**
|
|
2210
|
-
* @internal
|
|
2211
|
-
*/
|
|
2212
|
-
const filterSensitiveLog: (obj: IncrementalPullConfig) => any;
|
|
2213
|
-
}
|
|
2214
|
-
/**
|
|
2215
|
-
* <p>The properties that are applied when Marketo is being used as a source.</p>
|
|
2216
|
-
*/
|
|
2217
|
-
export interface MarketoSourceProperties {
|
|
2218
|
-
/**
|
|
2219
|
-
* <p>The object specified in the Marketo flow source.</p>
|
|
2220
|
-
*/
|
|
2221
|
-
Object: string | undefined;
|
|
2222
|
-
}
|
|
2223
|
-
export declare namespace MarketoSourceProperties {
|
|
2224
|
-
/**
|
|
2225
|
-
* @internal
|
|
2226
|
-
*/
|
|
2227
|
-
const filterSensitiveLog: (obj: MarketoSourceProperties) => any;
|
|
2228
|
-
}
|
|
2229
|
-
/**
|
|
2230
|
-
* <p>The properties that are applied when Amazon S3 is being used as the flow source.</p>
|
|
2231
|
-
*/
|
|
2232
|
-
export interface S3SourceProperties {
|
|
2233
|
-
/**
|
|
2234
|
-
* <p>The Amazon S3 bucket name where the source files are stored.</p>
|
|
2235
|
-
*/
|
|
2236
|
-
BucketName: string | undefined;
|
|
2237
|
-
/**
|
|
2238
|
-
* <p>The object key for the Amazon S3 bucket in which the source files are stored.</p>
|
|
2239
|
-
*/
|
|
2240
|
-
BucketPrefix?: string;
|
|
2241
|
-
}
|
|
2242
|
-
export declare namespace S3SourceProperties {
|
|
2243
|
-
/**
|
|
2244
|
-
* @internal
|
|
2245
|
-
*/
|
|
2246
|
-
const filterSensitiveLog: (obj: S3SourceProperties) => any;
|
|
2247
|
-
}
|
|
2248
|
-
/**
|
|
2249
|
-
* <p>The properties that are applied when Salesforce is being used as a source.</p>
|
|
2250
|
-
*/
|
|
2251
|
-
export interface SalesforceSourceProperties {
|
|
2252
|
-
/**
|
|
2253
|
-
* <p>The object specified in the Salesforce flow source.</p>
|
|
2254
|
-
*/
|
|
2255
|
-
Object: string | undefined;
|
|
2256
|
-
/**
|
|
2257
|
-
* <p>The flag that enables dynamic fetching of new (recently added) fields in the Salesforce
|
|
2258
|
-
* objects while running a flow.</p>
|
|
2259
|
-
*/
|
|
2260
|
-
EnableDynamicFieldUpdate?: boolean;
|
|
2261
|
-
/**
|
|
2262
|
-
* <p>Indicates whether Amazon AppFlow includes deleted files in the flow run.</p>
|
|
2263
|
-
*/
|
|
2264
|
-
IncludeDeletedRecords?: boolean;
|
|
2265
|
-
}
|
|
2266
|
-
export declare namespace SalesforceSourceProperties {
|
|
2267
|
-
/**
|
|
2268
|
-
* @internal
|
|
2269
|
-
*/
|
|
2270
|
-
const filterSensitiveLog: (obj: SalesforceSourceProperties) => any;
|
|
2271
|
-
}
|
|
2272
|
-
/**
|
|
2273
|
-
* <p>The properties that are applied when ServiceNow is being used as a source.</p>
|
|
2274
|
-
*/
|
|
2275
|
-
export interface ServiceNowSourceProperties {
|
|
2276
|
-
/**
|
|
2277
|
-
* <p>The object specified in the ServiceNow flow source.</p>
|
|
2278
|
-
*/
|
|
2279
|
-
Object: string | undefined;
|
|
2280
|
-
}
|
|
2281
|
-
export declare namespace ServiceNowSourceProperties {
|
|
2282
|
-
/**
|
|
2283
|
-
* @internal
|
|
2284
|
-
*/
|
|
2285
|
-
const filterSensitiveLog: (obj: ServiceNowSourceProperties) => any;
|
|
2286
|
-
}
|
|
2287
|
-
/**
|
|
2288
|
-
* <p>The properties that are applied when using Zendesk as a flow source.</p>
|
|
2289
|
-
*/
|
|
2290
|
-
export interface ZendeskSourceProperties {
|
|
2291
|
-
/**
|
|
2292
|
-
* <p>The object specified in the Zendesk flow source.</p>
|
|
2293
|
-
*/
|
|
2294
|
-
Object: string | undefined;
|
|
2295
|
-
}
|
|
2296
|
-
export declare namespace ZendeskSourceProperties {
|
|
2297
|
-
/**
|
|
2298
|
-
* @internal
|
|
2846
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
2299
2847
|
*/
|
|
2300
|
-
|
|
2301
|
-
}
|
|
2302
|
-
/**
|
|
2303
|
-
* <p>Specifies the information that is required to query a particular Amazon AppFlow connector.
|
|
2304
|
-
* Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.</p>
|
|
2305
|
-
*/
|
|
2306
|
-
export interface SourceConnectorProperties {
|
|
2848
|
+
WorkflowType?: WorkflowType | string;
|
|
2307
2849
|
/**
|
|
2308
|
-
* <p>
|
|
2850
|
+
* <p>Status of workflow execution.</p>
|
|
2309
2851
|
*/
|
|
2310
|
-
|
|
2852
|
+
Status?: Status | string;
|
|
2311
2853
|
/**
|
|
2312
|
-
* <p>
|
|
2854
|
+
* <p>Retrieve workflows started after timestamp.</p>
|
|
2313
2855
|
*/
|
|
2314
|
-
|
|
2856
|
+
QueryStartDate?: Date;
|
|
2315
2857
|
/**
|
|
2316
|
-
* <p>
|
|
2858
|
+
* <p>Retrieve workflows ended after timestamp.</p>
|
|
2317
2859
|
*/
|
|
2318
|
-
|
|
2860
|
+
QueryEndDate?: Date;
|
|
2319
2861
|
/**
|
|
2320
|
-
* <p>The
|
|
2862
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2863
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
2321
2864
|
*/
|
|
2322
|
-
|
|
2865
|
+
NextToken?: string;
|
|
2323
2866
|
/**
|
|
2324
|
-
* <p>The
|
|
2867
|
+
* <p>The maximum number of results to return per page.</p>
|
|
2325
2868
|
*/
|
|
2326
|
-
|
|
2869
|
+
MaxResults?: number;
|
|
2327
2870
|
}
|
|
2328
|
-
export declare namespace
|
|
2871
|
+
export declare namespace ListWorkflowsRequest {
|
|
2329
2872
|
/**
|
|
2330
2873
|
* @internal
|
|
2331
2874
|
*/
|
|
2332
|
-
const filterSensitiveLog: (obj:
|
|
2875
|
+
const filterSensitiveLog: (obj: ListWorkflowsRequest) => any;
|
|
2333
2876
|
}
|
|
2334
2877
|
/**
|
|
2335
|
-
* <p>
|
|
2336
|
-
* flow.</p>
|
|
2878
|
+
* <p>A workflow in list of workflows.</p>
|
|
2337
2879
|
*/
|
|
2338
|
-
export interface
|
|
2880
|
+
export interface ListWorkflowsItem {
|
|
2339
2881
|
/**
|
|
2340
|
-
* <p>The
|
|
2341
|
-
* profile in the AWS account.</p>
|
|
2882
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
2342
2883
|
*/
|
|
2343
|
-
|
|
2884
|
+
WorkflowType: WorkflowType | string | undefined;
|
|
2344
2885
|
/**
|
|
2345
|
-
* <p>
|
|
2886
|
+
* <p>Unique identifier for the workflow.</p>
|
|
2346
2887
|
*/
|
|
2347
|
-
|
|
2888
|
+
WorkflowId: string | undefined;
|
|
2348
2889
|
/**
|
|
2349
|
-
* <p>
|
|
2350
|
-
* configuration is provided, the fields specified in the configuration are used when querying
|
|
2351
|
-
* for the incremental data pull.</p>
|
|
2890
|
+
* <p>Status of workflow execution.</p>
|
|
2352
2891
|
*/
|
|
2353
|
-
|
|
2892
|
+
Status: Status | string | undefined;
|
|
2354
2893
|
/**
|
|
2355
|
-
* <p>
|
|
2356
|
-
* connector.</p>
|
|
2894
|
+
* <p>Description for workflow execution status.</p>
|
|
2357
2895
|
*/
|
|
2358
|
-
|
|
2896
|
+
StatusDescription: string | undefined;
|
|
2897
|
+
/**
|
|
2898
|
+
* <p>Creation timestamp for workflow.</p>
|
|
2899
|
+
*/
|
|
2900
|
+
CreatedAt: Date | undefined;
|
|
2901
|
+
/**
|
|
2902
|
+
* <p>Last updated timestamp for workflow.</p>
|
|
2903
|
+
*/
|
|
2904
|
+
LastUpdatedAt: Date | undefined;
|
|
2359
2905
|
}
|
|
2360
|
-
export declare namespace
|
|
2906
|
+
export declare namespace ListWorkflowsItem {
|
|
2361
2907
|
/**
|
|
2362
2908
|
* @internal
|
|
2363
2909
|
*/
|
|
2364
|
-
const filterSensitiveLog: (obj:
|
|
2910
|
+
const filterSensitiveLog: (obj: ListWorkflowsItem) => any;
|
|
2365
2911
|
}
|
|
2366
|
-
export
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP",
|
|
2376
|
-
TRUNCATE_LENGTH = "TRUNCATE_LENGTH",
|
|
2377
|
-
UPPER_BOUND = "UPPER_BOUND",
|
|
2378
|
-
VALIDATION_ACTION = "VALIDATION_ACTION",
|
|
2379
|
-
VALUE = "VALUE",
|
|
2380
|
-
VALUES = "VALUES"
|
|
2912
|
+
export interface ListWorkflowsResponse {
|
|
2913
|
+
/**
|
|
2914
|
+
* <p>List containing workflow details.</p>
|
|
2915
|
+
*/
|
|
2916
|
+
Items?: ListWorkflowsItem[];
|
|
2917
|
+
/**
|
|
2918
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2919
|
+
*/
|
|
2920
|
+
NextToken?: string;
|
|
2381
2921
|
}
|
|
2382
|
-
export declare
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
MERGE = "Merge",
|
|
2388
|
-
TRUNCATE = "Truncate",
|
|
2389
|
-
VALIDATE = "Validate"
|
|
2922
|
+
export declare namespace ListWorkflowsResponse {
|
|
2923
|
+
/**
|
|
2924
|
+
* @internal
|
|
2925
|
+
*/
|
|
2926
|
+
const filterSensitiveLog: (obj: ListWorkflowsResponse) => any;
|
|
2390
2927
|
}
|
|
2391
2928
|
/**
|
|
2392
|
-
* <p>A
|
|
2393
|
-
* TaskType.</p>
|
|
2929
|
+
* <p>A duplicate customer profile that is to be merged into a main profile. </p>
|
|
2394
2930
|
*/
|
|
2395
|
-
export interface
|
|
2931
|
+
export interface FieldSourceProfileIds {
|
|
2396
2932
|
/**
|
|
2397
|
-
* <p>
|
|
2933
|
+
* <p>A unique identifier for the account number field to be merged. </p>
|
|
2398
2934
|
*/
|
|
2399
|
-
|
|
2935
|
+
AccountNumber?: string;
|
|
2400
2936
|
/**
|
|
2401
|
-
* <p>A
|
|
2402
|
-
* source field.</p>
|
|
2937
|
+
* <p>A unique identifier for the additional information field to be merged.</p>
|
|
2403
2938
|
*/
|
|
2404
|
-
|
|
2939
|
+
AdditionalInformation?: string;
|
|
2405
2940
|
/**
|
|
2406
|
-
* <p>
|
|
2941
|
+
* <p>A unique identifier for the party type field to be merged.</p>
|
|
2407
2942
|
*/
|
|
2408
|
-
|
|
2943
|
+
PartyType?: string;
|
|
2409
2944
|
/**
|
|
2410
|
-
* <p>A
|
|
2411
|
-
* information based on the TaskType.</p>
|
|
2945
|
+
* <p>A unique identifier for the business name field to be merged.</p>
|
|
2412
2946
|
*/
|
|
2413
|
-
|
|
2414
|
-
[key: string]: string;
|
|
2415
|
-
};
|
|
2947
|
+
BusinessName?: string;
|
|
2416
2948
|
/**
|
|
2417
|
-
* <p>
|
|
2949
|
+
* <p>A unique identifier for the first name field to be merged.</p>
|
|
2418
2950
|
*/
|
|
2419
|
-
|
|
2420
|
-
}
|
|
2421
|
-
export declare namespace Task {
|
|
2951
|
+
FirstName?: string;
|
|
2422
2952
|
/**
|
|
2423
|
-
*
|
|
2953
|
+
* <p>A unique identifier for the middle name field to be merged.</p>
|
|
2424
2954
|
*/
|
|
2425
|
-
|
|
2426
|
-
}
|
|
2427
|
-
export declare enum DataPullMode {
|
|
2428
|
-
COMPLETE = "Complete",
|
|
2429
|
-
INCREMENTAL = "Incremental"
|
|
2430
|
-
}
|
|
2431
|
-
/**
|
|
2432
|
-
* <p>Specifies the configuration details of a scheduled-trigger flow that you define.
|
|
2433
|
-
* Currently, these settings only apply to the scheduled-trigger type.</p>
|
|
2434
|
-
*/
|
|
2435
|
-
export interface ScheduledTriggerProperties {
|
|
2955
|
+
MiddleName?: string;
|
|
2436
2956
|
/**
|
|
2437
|
-
* <p>
|
|
2438
|
-
* example rate (5 minutes).</p>
|
|
2957
|
+
* <p>A unique identifier for the last name field to be merged.</p>
|
|
2439
2958
|
*/
|
|
2440
|
-
|
|
2959
|
+
LastName?: string;
|
|
2441
2960
|
/**
|
|
2442
|
-
* <p>
|
|
2443
|
-
* transfer for each flow run.</p>
|
|
2961
|
+
* <p>A unique identifier for the birthdate field to be merged.</p>
|
|
2444
2962
|
*/
|
|
2445
|
-
|
|
2963
|
+
BirthDate?: string;
|
|
2446
2964
|
/**
|
|
2447
|
-
* <p>
|
|
2965
|
+
* <p>A unique identifier for the gender field to be merged.</p>
|
|
2448
2966
|
*/
|
|
2449
|
-
|
|
2967
|
+
Gender?: string;
|
|
2450
2968
|
/**
|
|
2451
|
-
* <p>
|
|
2969
|
+
* <p>A unique identifier for the phone number field to be merged.</p>
|
|
2452
2970
|
*/
|
|
2453
|
-
|
|
2971
|
+
PhoneNumber?: string;
|
|
2454
2972
|
/**
|
|
2455
|
-
* <p>
|
|
2456
|
-
* scheduled-triggered flow, such as America/New_York.</p>
|
|
2973
|
+
* <p>A unique identifier for the mobile phone number field to be merged.</p>
|
|
2457
2974
|
*/
|
|
2458
|
-
|
|
2975
|
+
MobilePhoneNumber?: string;
|
|
2459
2976
|
/**
|
|
2460
|
-
* <p>
|
|
2461
|
-
* schedule-triggered flow.</p>
|
|
2977
|
+
* <p>A unique identifier for the home phone number field to be merged.</p>
|
|
2462
2978
|
*/
|
|
2463
|
-
|
|
2979
|
+
HomePhoneNumber?: string;
|
|
2464
2980
|
/**
|
|
2465
|
-
* <p>
|
|
2466
|
-
* run.</p>
|
|
2981
|
+
* <p>A unique identifier for the business phone number field to be merged.</p>
|
|
2467
2982
|
*/
|
|
2468
|
-
|
|
2469
|
-
}
|
|
2470
|
-
export declare namespace ScheduledTriggerProperties {
|
|
2983
|
+
BusinessPhoneNumber?: string;
|
|
2471
2984
|
/**
|
|
2472
|
-
*
|
|
2985
|
+
* <p>A unique identifier for the email address field to be merged.</p>
|
|
2473
2986
|
*/
|
|
2474
|
-
|
|
2475
|
-
}
|
|
2476
|
-
/**
|
|
2477
|
-
* <p>Specifies the configuration details that control the trigger for a flow. Currently,
|
|
2478
|
-
* these settings only apply to the Scheduled trigger type.</p>
|
|
2479
|
-
*/
|
|
2480
|
-
export interface TriggerProperties {
|
|
2987
|
+
EmailAddress?: string;
|
|
2481
2988
|
/**
|
|
2482
|
-
* <p>
|
|
2989
|
+
* <p>A unique identifier for the personal email address field to be merged.</p>
|
|
2483
2990
|
*/
|
|
2484
|
-
|
|
2485
|
-
}
|
|
2486
|
-
export declare namespace TriggerProperties {
|
|
2991
|
+
PersonalEmailAddress?: string;
|
|
2487
2992
|
/**
|
|
2488
|
-
*
|
|
2993
|
+
* <p>A unique identifier for the party type field to be merged.</p>
|
|
2489
2994
|
*/
|
|
2490
|
-
|
|
2491
|
-
}
|
|
2492
|
-
export declare enum TriggerType {
|
|
2493
|
-
EVENT = "Event",
|
|
2494
|
-
ONDEMAND = "OnDemand",
|
|
2495
|
-
SCHEDULED = "Scheduled"
|
|
2496
|
-
}
|
|
2497
|
-
/**
|
|
2498
|
-
* <p>The trigger settings that determine how and when Amazon AppFlow runs the specified
|
|
2499
|
-
* flow.</p>
|
|
2500
|
-
*/
|
|
2501
|
-
export interface TriggerConfig {
|
|
2995
|
+
BusinessEmailAddress?: string;
|
|
2502
2996
|
/**
|
|
2503
|
-
* <p>
|
|
2997
|
+
* <p>A unique identifier for the party type field to be merged.</p>
|
|
2504
2998
|
*/
|
|
2505
|
-
|
|
2999
|
+
Address?: string;
|
|
2506
3000
|
/**
|
|
2507
|
-
* <p>
|
|
2508
|
-
* Currently, these settings only apply to the Scheduled trigger type.</p>
|
|
3001
|
+
* <p>A unique identifier for the shipping address field to be merged.</p>
|
|
2509
3002
|
*/
|
|
2510
|
-
|
|
3003
|
+
ShippingAddress?: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* <p>A unique identifier for the mailing address field to be merged.</p>
|
|
3006
|
+
*/
|
|
3007
|
+
MailingAddress?: string;
|
|
3008
|
+
/**
|
|
3009
|
+
* <p>A unique identifier for the billing type field to be merged.</p>
|
|
3010
|
+
*/
|
|
3011
|
+
BillingAddress?: string;
|
|
3012
|
+
/**
|
|
3013
|
+
* <p>A unique identifier for the attributes field to be merged.</p>
|
|
3014
|
+
*/
|
|
3015
|
+
Attributes?: {
|
|
3016
|
+
[key: string]: string;
|
|
3017
|
+
};
|
|
2511
3018
|
}
|
|
2512
|
-
export declare namespace
|
|
3019
|
+
export declare namespace FieldSourceProfileIds {
|
|
2513
3020
|
/**
|
|
2514
3021
|
* @internal
|
|
2515
3022
|
*/
|
|
2516
|
-
const filterSensitiveLog: (obj:
|
|
3023
|
+
const filterSensitiveLog: (obj: FieldSourceProfileIds) => any;
|
|
2517
3024
|
}
|
|
2518
|
-
|
|
2519
|
-
* <p>The configurations that control how Customer Profiles retrieves data from the source,
|
|
2520
|
-
* Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of
|
|
2521
|
-
* customers.</p>
|
|
2522
|
-
*/
|
|
2523
|
-
export interface FlowDefinition {
|
|
3025
|
+
export interface MergeProfilesRequest {
|
|
2524
3026
|
/**
|
|
2525
|
-
* <p>
|
|
3027
|
+
* <p>The unique name of the domain.</p>
|
|
2526
3028
|
*/
|
|
2527
|
-
|
|
3029
|
+
DomainName: string | undefined;
|
|
2528
3030
|
/**
|
|
2529
|
-
* <p>The
|
|
2530
|
-
* allowed.</p>
|
|
3031
|
+
* <p>The identifier of the profile to be taken.</p>
|
|
2531
3032
|
*/
|
|
2532
|
-
|
|
3033
|
+
MainProfileId: string | undefined;
|
|
2533
3034
|
/**
|
|
2534
|
-
* <p>The
|
|
3035
|
+
* <p>The identifier of the profile to be merged into MainProfileId.</p>
|
|
2535
3036
|
*/
|
|
2536
|
-
|
|
3037
|
+
ProfileIdsToBeMerged: string[] | undefined;
|
|
2537
3038
|
/**
|
|
2538
|
-
* <p>The
|
|
2539
|
-
*
|
|
3039
|
+
* <p>The identifiers of the fields in the profile that has the information you want to apply
|
|
3040
|
+
* to the merge. For example, say you want to merge EmailAddress from Profile1 into
|
|
3041
|
+
* MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
|
|
2540
3042
|
*/
|
|
2541
|
-
|
|
3043
|
+
FieldSourceProfileIds?: FieldSourceProfileIds;
|
|
3044
|
+
}
|
|
3045
|
+
export declare namespace MergeProfilesRequest {
|
|
2542
3046
|
/**
|
|
2543
|
-
*
|
|
2544
|
-
* run.</p>
|
|
3047
|
+
* @internal
|
|
2545
3048
|
*/
|
|
2546
|
-
|
|
3049
|
+
const filterSensitiveLog: (obj: MergeProfilesRequest) => any;
|
|
3050
|
+
}
|
|
3051
|
+
export interface MergeProfilesResponse {
|
|
2547
3052
|
/**
|
|
2548
|
-
* <p>
|
|
3053
|
+
* <p>A message that indicates the merge request is complete.</p>
|
|
2549
3054
|
*/
|
|
2550
|
-
|
|
3055
|
+
Message?: string;
|
|
2551
3056
|
}
|
|
2552
|
-
export declare namespace
|
|
3057
|
+
export declare namespace MergeProfilesResponse {
|
|
2553
3058
|
/**
|
|
2554
3059
|
* @internal
|
|
2555
3060
|
*/
|
|
2556
|
-
const filterSensitiveLog: (obj:
|
|
3061
|
+
const filterSensitiveLog: (obj: MergeProfilesResponse) => any;
|
|
2557
3062
|
}
|
|
2558
3063
|
export interface PutIntegrationRequest {
|
|
2559
3064
|
/**
|
|
@@ -2629,6 +3134,10 @@ export interface PutIntegrationResponse {
|
|
|
2629
3134
|
ObjectTypeNames?: {
|
|
2630
3135
|
[key: string]: string;
|
|
2631
3136
|
};
|
|
3137
|
+
/**
|
|
3138
|
+
* <p>Unique identifier for the workflow.</p>
|
|
3139
|
+
*/
|
|
3140
|
+
WorkflowId?: string;
|
|
2632
3141
|
}
|
|
2633
3142
|
export declare namespace PutIntegrationResponse {
|
|
2634
3143
|
/**
|