@aws-sdk/client-customer-profiles 3.379.1 → 3.385.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-types/models/models_0.d.ts +688 -0
- package/package.json +5 -5
|
@@ -24,10 +24,12 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
24
24
|
*/
|
|
25
25
|
export interface AdditionalSearchKey {
|
|
26
26
|
/**
|
|
27
|
+
* @public
|
|
27
28
|
* <p>A searchable identifier of a customer profile.</p>
|
|
28
29
|
*/
|
|
29
30
|
KeyName: string | undefined;
|
|
30
31
|
/**
|
|
32
|
+
* @public
|
|
31
33
|
* <p>A list of key values.</p>
|
|
32
34
|
*/
|
|
33
35
|
Values: string[] | undefined;
|
|
@@ -37,10 +39,12 @@ export interface AdditionalSearchKey {
|
|
|
37
39
|
*/
|
|
38
40
|
export interface AddProfileKeyRequest {
|
|
39
41
|
/**
|
|
42
|
+
* @public
|
|
40
43
|
* <p>The unique identifier of a customer profile.</p>
|
|
41
44
|
*/
|
|
42
45
|
ProfileId: string | undefined;
|
|
43
46
|
/**
|
|
47
|
+
* @public
|
|
44
48
|
* <p>A searchable identifier of a customer profile. The predefined keys you can use
|
|
45
49
|
* include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone,
|
|
46
50
|
* _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,
|
|
@@ -50,10 +54,12 @@ export interface AddProfileKeyRequest {
|
|
|
50
54
|
*/
|
|
51
55
|
KeyName: string | undefined;
|
|
52
56
|
/**
|
|
57
|
+
* @public
|
|
53
58
|
* <p>A list of key values.</p>
|
|
54
59
|
*/
|
|
55
60
|
Values: string[] | undefined;
|
|
56
61
|
/**
|
|
62
|
+
* @public
|
|
57
63
|
* <p>The unique name of the domain.</p>
|
|
58
64
|
*/
|
|
59
65
|
DomainName: string | undefined;
|
|
@@ -63,10 +69,12 @@ export interface AddProfileKeyRequest {
|
|
|
63
69
|
*/
|
|
64
70
|
export interface AddProfileKeyResponse {
|
|
65
71
|
/**
|
|
72
|
+
* @public
|
|
66
73
|
* <p>A searchable identifier of a customer profile.</p>
|
|
67
74
|
*/
|
|
68
75
|
KeyName?: string;
|
|
69
76
|
/**
|
|
77
|
+
* @public
|
|
70
78
|
* <p>A list of key values.</p>
|
|
71
79
|
*/
|
|
72
80
|
Values?: string[];
|
|
@@ -130,42 +138,52 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
130
138
|
*/
|
|
131
139
|
export interface Address {
|
|
132
140
|
/**
|
|
141
|
+
* @public
|
|
133
142
|
* <p>The first line of a customer address.</p>
|
|
134
143
|
*/
|
|
135
144
|
Address1?: string;
|
|
136
145
|
/**
|
|
146
|
+
* @public
|
|
137
147
|
* <p>The second line of a customer address.</p>
|
|
138
148
|
*/
|
|
139
149
|
Address2?: string;
|
|
140
150
|
/**
|
|
151
|
+
* @public
|
|
141
152
|
* <p>The third line of a customer address.</p>
|
|
142
153
|
*/
|
|
143
154
|
Address3?: string;
|
|
144
155
|
/**
|
|
156
|
+
* @public
|
|
145
157
|
* <p>The fourth line of a customer address.</p>
|
|
146
158
|
*/
|
|
147
159
|
Address4?: string;
|
|
148
160
|
/**
|
|
161
|
+
* @public
|
|
149
162
|
* <p>The city in which a customer lives.</p>
|
|
150
163
|
*/
|
|
151
164
|
City?: string;
|
|
152
165
|
/**
|
|
166
|
+
* @public
|
|
153
167
|
* <p>The county in which a customer lives.</p>
|
|
154
168
|
*/
|
|
155
169
|
County?: string;
|
|
156
170
|
/**
|
|
171
|
+
* @public
|
|
157
172
|
* <p>The state in which a customer lives.</p>
|
|
158
173
|
*/
|
|
159
174
|
State?: string;
|
|
160
175
|
/**
|
|
176
|
+
* @public
|
|
161
177
|
* <p>The province in which a customer lives.</p>
|
|
162
178
|
*/
|
|
163
179
|
Province?: string;
|
|
164
180
|
/**
|
|
181
|
+
* @public
|
|
165
182
|
* <p>The country in which a customer lives.</p>
|
|
166
183
|
*/
|
|
167
184
|
Country?: string;
|
|
168
185
|
/**
|
|
186
|
+
* @public
|
|
169
187
|
* <p>The postal code of a customer address.</p>
|
|
170
188
|
*/
|
|
171
189
|
PostalCode?: string;
|
|
@@ -176,10 +194,12 @@ export interface Address {
|
|
|
176
194
|
*/
|
|
177
195
|
export interface Batch {
|
|
178
196
|
/**
|
|
197
|
+
* @public
|
|
179
198
|
* <p>Start time of batch to split ingestion.</p>
|
|
180
199
|
*/
|
|
181
200
|
StartTime: Date | undefined;
|
|
182
201
|
/**
|
|
202
|
+
* @public
|
|
183
203
|
* <p>End time of batch to split ingestion.</p>
|
|
184
204
|
*/
|
|
185
205
|
EndTime: Date | undefined;
|
|
@@ -206,6 +226,7 @@ export type SourceConnectorType = (typeof SourceConnectorType)[keyof typeof Sour
|
|
|
206
226
|
*/
|
|
207
227
|
export interface IncrementalPullConfig {
|
|
208
228
|
/**
|
|
229
|
+
* @public
|
|
209
230
|
* <p>A field that specifies the date time or timestamp field as the criteria to use when
|
|
210
231
|
* importing incremental records from the source.</p>
|
|
211
232
|
*/
|
|
@@ -217,6 +238,7 @@ export interface IncrementalPullConfig {
|
|
|
217
238
|
*/
|
|
218
239
|
export interface MarketoSourceProperties {
|
|
219
240
|
/**
|
|
241
|
+
* @public
|
|
220
242
|
* <p>The object specified in the Marketo flow source.</p>
|
|
221
243
|
*/
|
|
222
244
|
Object: string | undefined;
|
|
@@ -227,10 +249,12 @@ export interface MarketoSourceProperties {
|
|
|
227
249
|
*/
|
|
228
250
|
export interface S3SourceProperties {
|
|
229
251
|
/**
|
|
252
|
+
* @public
|
|
230
253
|
* <p>The Amazon S3 bucket name where the source files are stored.</p>
|
|
231
254
|
*/
|
|
232
255
|
BucketName: string | undefined;
|
|
233
256
|
/**
|
|
257
|
+
* @public
|
|
234
258
|
* <p>The object key for the Amazon S3 bucket in which the source files are stored.</p>
|
|
235
259
|
*/
|
|
236
260
|
BucketPrefix?: string;
|
|
@@ -241,15 +265,18 @@ export interface S3SourceProperties {
|
|
|
241
265
|
*/
|
|
242
266
|
export interface SalesforceSourceProperties {
|
|
243
267
|
/**
|
|
268
|
+
* @public
|
|
244
269
|
* <p>The object specified in the Salesforce flow source.</p>
|
|
245
270
|
*/
|
|
246
271
|
Object: string | undefined;
|
|
247
272
|
/**
|
|
273
|
+
* @public
|
|
248
274
|
* <p>The flag that enables dynamic fetching of new (recently added) fields in the Salesforce
|
|
249
275
|
* objects while running a flow.</p>
|
|
250
276
|
*/
|
|
251
277
|
EnableDynamicFieldUpdate?: boolean;
|
|
252
278
|
/**
|
|
279
|
+
* @public
|
|
253
280
|
* <p>Indicates whether Amazon AppFlow includes deleted files in the flow run.</p>
|
|
254
281
|
*/
|
|
255
282
|
IncludeDeletedRecords?: boolean;
|
|
@@ -260,6 +287,7 @@ export interface SalesforceSourceProperties {
|
|
|
260
287
|
*/
|
|
261
288
|
export interface ServiceNowSourceProperties {
|
|
262
289
|
/**
|
|
290
|
+
* @public
|
|
263
291
|
* <p>The object specified in the ServiceNow flow source.</p>
|
|
264
292
|
*/
|
|
265
293
|
Object: string | undefined;
|
|
@@ -270,6 +298,7 @@ export interface ServiceNowSourceProperties {
|
|
|
270
298
|
*/
|
|
271
299
|
export interface ZendeskSourceProperties {
|
|
272
300
|
/**
|
|
301
|
+
* @public
|
|
273
302
|
* <p>The object specified in the Zendesk flow source.</p>
|
|
274
303
|
*/
|
|
275
304
|
Object: string | undefined;
|
|
@@ -281,22 +310,27 @@ export interface ZendeskSourceProperties {
|
|
|
281
310
|
*/
|
|
282
311
|
export interface SourceConnectorProperties {
|
|
283
312
|
/**
|
|
313
|
+
* @public
|
|
284
314
|
* <p>The properties that are applied when Marketo is being used as a source.</p>
|
|
285
315
|
*/
|
|
286
316
|
Marketo?: MarketoSourceProperties;
|
|
287
317
|
/**
|
|
318
|
+
* @public
|
|
288
319
|
* <p>The properties that are applied when Amazon S3 is being used as the flow source.</p>
|
|
289
320
|
*/
|
|
290
321
|
S3?: S3SourceProperties;
|
|
291
322
|
/**
|
|
323
|
+
* @public
|
|
292
324
|
* <p>The properties that are applied when Salesforce is being used as a source.</p>
|
|
293
325
|
*/
|
|
294
326
|
Salesforce?: SalesforceSourceProperties;
|
|
295
327
|
/**
|
|
328
|
+
* @public
|
|
296
329
|
* <p>The properties that are applied when ServiceNow is being used as a source.</p>
|
|
297
330
|
*/
|
|
298
331
|
ServiceNow?: ServiceNowSourceProperties;
|
|
299
332
|
/**
|
|
333
|
+
* @public
|
|
300
334
|
* <p>The properties that are applied when using Zendesk as a flow source.</p>
|
|
301
335
|
*/
|
|
302
336
|
Zendesk?: ZendeskSourceProperties;
|
|
@@ -308,21 +342,25 @@ export interface SourceConnectorProperties {
|
|
|
308
342
|
*/
|
|
309
343
|
export interface SourceFlowConfig {
|
|
310
344
|
/**
|
|
345
|
+
* @public
|
|
311
346
|
* <p>The name of the AppFlow connector profile. This name must be unique for each connector
|
|
312
347
|
* profile in the AWS account.</p>
|
|
313
348
|
*/
|
|
314
349
|
ConnectorProfileName?: string;
|
|
315
350
|
/**
|
|
351
|
+
* @public
|
|
316
352
|
* <p>The type of connector, such as Salesforce, Marketo, and so on.</p>
|
|
317
353
|
*/
|
|
318
354
|
ConnectorType: SourceConnectorType | string | undefined;
|
|
319
355
|
/**
|
|
356
|
+
* @public
|
|
320
357
|
* <p>Defines the configuration for a scheduled incremental data pull. If a valid
|
|
321
358
|
* configuration is provided, the fields specified in the configuration are used when querying
|
|
322
359
|
* for the incremental data pull.</p>
|
|
323
360
|
*/
|
|
324
361
|
IncrementalPullConfig?: IncrementalPullConfig;
|
|
325
362
|
/**
|
|
363
|
+
* @public
|
|
326
364
|
* <p>Specifies the information that is required to query a particular source
|
|
327
365
|
* connector.</p>
|
|
328
366
|
*/
|
|
@@ -476,22 +514,27 @@ export type ZendeskConnectorOperator = (typeof ZendeskConnectorOperator)[keyof t
|
|
|
476
514
|
*/
|
|
477
515
|
export interface ConnectorOperator {
|
|
478
516
|
/**
|
|
517
|
+
* @public
|
|
479
518
|
* <p>The operation to be performed on the provided Marketo source fields.</p>
|
|
480
519
|
*/
|
|
481
520
|
Marketo?: MarketoConnectorOperator | string;
|
|
482
521
|
/**
|
|
522
|
+
* @public
|
|
483
523
|
* <p>The operation to be performed on the provided Amazon S3 source fields.</p>
|
|
484
524
|
*/
|
|
485
525
|
S3?: S3ConnectorOperator | string;
|
|
486
526
|
/**
|
|
527
|
+
* @public
|
|
487
528
|
* <p>The operation to be performed on the provided Salesforce source fields.</p>
|
|
488
529
|
*/
|
|
489
530
|
Salesforce?: SalesforceConnectorOperator | string;
|
|
490
531
|
/**
|
|
532
|
+
* @public
|
|
491
533
|
* <p>The operation to be performed on the provided ServiceNow source fields.</p>
|
|
492
534
|
*/
|
|
493
535
|
ServiceNow?: ServiceNowConnectorOperator | string;
|
|
494
536
|
/**
|
|
537
|
+
* @public
|
|
495
538
|
* <p>The operation to be performed on the provided Zendesk source fields.</p>
|
|
496
539
|
*/
|
|
497
540
|
Zendesk?: ZendeskConnectorOperator | string;
|
|
@@ -544,24 +587,29 @@ export type TaskType = (typeof TaskType)[keyof typeof TaskType];
|
|
|
544
587
|
*/
|
|
545
588
|
export interface Task {
|
|
546
589
|
/**
|
|
590
|
+
* @public
|
|
547
591
|
* <p>The operation to be performed on the provided source fields.</p>
|
|
548
592
|
*/
|
|
549
593
|
ConnectorOperator?: ConnectorOperator;
|
|
550
594
|
/**
|
|
595
|
+
* @public
|
|
551
596
|
* <p>A field in a destination connector, or a field value against which Amazon AppFlow validates a
|
|
552
597
|
* source field.</p>
|
|
553
598
|
*/
|
|
554
599
|
DestinationField?: string;
|
|
555
600
|
/**
|
|
601
|
+
* @public
|
|
556
602
|
* <p>The source fields to which a particular task is applied.</p>
|
|
557
603
|
*/
|
|
558
604
|
SourceFields: string[] | undefined;
|
|
559
605
|
/**
|
|
606
|
+
* @public
|
|
560
607
|
* <p>A map used to store task-related information. The service looks for particular
|
|
561
608
|
* information based on the TaskType.</p>
|
|
562
609
|
*/
|
|
563
610
|
TaskProperties?: Record<string, string>;
|
|
564
611
|
/**
|
|
612
|
+
* @public
|
|
565
613
|
* <p>Specifies the particular task implementation that Amazon AppFlow performs.</p>
|
|
566
614
|
*/
|
|
567
615
|
TaskType: TaskType | string | undefined;
|
|
@@ -585,34 +633,41 @@ export type DataPullMode = (typeof DataPullMode)[keyof typeof DataPullMode];
|
|
|
585
633
|
*/
|
|
586
634
|
export interface ScheduledTriggerProperties {
|
|
587
635
|
/**
|
|
636
|
+
* @public
|
|
588
637
|
* <p>The scheduling expression that determines the rate at which the schedule will run, for
|
|
589
638
|
* example rate (5 minutes).</p>
|
|
590
639
|
*/
|
|
591
640
|
ScheduleExpression: string | undefined;
|
|
592
641
|
/**
|
|
642
|
+
* @public
|
|
593
643
|
* <p>Specifies whether a scheduled flow has an incremental data transfer or a complete data
|
|
594
644
|
* transfer for each flow run.</p>
|
|
595
645
|
*/
|
|
596
646
|
DataPullMode?: DataPullMode | string;
|
|
597
647
|
/**
|
|
648
|
+
* @public
|
|
598
649
|
* <p>Specifies the scheduled start time for a scheduled-trigger flow.</p>
|
|
599
650
|
*/
|
|
600
651
|
ScheduleStartTime?: Date;
|
|
601
652
|
/**
|
|
653
|
+
* @public
|
|
602
654
|
* <p>Specifies the scheduled end time for a scheduled-trigger flow.</p>
|
|
603
655
|
*/
|
|
604
656
|
ScheduleEndTime?: Date;
|
|
605
657
|
/**
|
|
658
|
+
* @public
|
|
606
659
|
* <p>Specifies the time zone used when referring to the date and time of a
|
|
607
660
|
* scheduled-triggered flow, such as America/New_York.</p>
|
|
608
661
|
*/
|
|
609
662
|
Timezone?: string;
|
|
610
663
|
/**
|
|
664
|
+
* @public
|
|
611
665
|
* <p>Specifies the optional offset that is added to the time interval for a
|
|
612
666
|
* schedule-triggered flow.</p>
|
|
613
667
|
*/
|
|
614
668
|
ScheduleOffset?: number;
|
|
615
669
|
/**
|
|
670
|
+
* @public
|
|
616
671
|
* <p>Specifies the date range for the records to import from the connector in the first flow
|
|
617
672
|
* run.</p>
|
|
618
673
|
*/
|
|
@@ -625,6 +680,7 @@ export interface ScheduledTriggerProperties {
|
|
|
625
680
|
*/
|
|
626
681
|
export interface TriggerProperties {
|
|
627
682
|
/**
|
|
683
|
+
* @public
|
|
628
684
|
* <p>Specifies the configuration details of a schedule-triggered flow that you define.</p>
|
|
629
685
|
*/
|
|
630
686
|
Scheduled?: ScheduledTriggerProperties;
|
|
@@ -649,10 +705,12 @@ export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType];
|
|
|
649
705
|
*/
|
|
650
706
|
export interface TriggerConfig {
|
|
651
707
|
/**
|
|
708
|
+
* @public
|
|
652
709
|
* <p>Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.</p>
|
|
653
710
|
*/
|
|
654
711
|
TriggerType: TriggerType | string | undefined;
|
|
655
712
|
/**
|
|
713
|
+
* @public
|
|
656
714
|
* <p>Specifies the configuration details of a schedule-triggered flow that you define.
|
|
657
715
|
* Currently, these settings only apply to the Scheduled trigger type.</p>
|
|
658
716
|
*/
|
|
@@ -666,29 +724,35 @@ export interface TriggerConfig {
|
|
|
666
724
|
*/
|
|
667
725
|
export interface FlowDefinition {
|
|
668
726
|
/**
|
|
727
|
+
* @public
|
|
669
728
|
* <p>A description of the flow you want to create.</p>
|
|
670
729
|
*/
|
|
671
730
|
Description?: string;
|
|
672
731
|
/**
|
|
732
|
+
* @public
|
|
673
733
|
* <p>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not
|
|
674
734
|
* allowed.</p>
|
|
675
735
|
*/
|
|
676
736
|
FlowName: string | undefined;
|
|
677
737
|
/**
|
|
738
|
+
* @public
|
|
678
739
|
* <p>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</p>
|
|
679
740
|
*/
|
|
680
741
|
KmsArn: string | undefined;
|
|
681
742
|
/**
|
|
743
|
+
* @public
|
|
682
744
|
* <p>The configuration that controls how Customer Profiles retrieves data from the
|
|
683
745
|
* source.</p>
|
|
684
746
|
*/
|
|
685
747
|
SourceFlowConfig: SourceFlowConfig | undefined;
|
|
686
748
|
/**
|
|
749
|
+
* @public
|
|
687
750
|
* <p>A list of tasks that Customer Profiles performs while transferring the data in the flow
|
|
688
751
|
* run.</p>
|
|
689
752
|
*/
|
|
690
753
|
Tasks: Task[] | undefined;
|
|
691
754
|
/**
|
|
755
|
+
* @public
|
|
692
756
|
* <p>The trigger settings that determine how and when the flow runs.</p>
|
|
693
757
|
*/
|
|
694
758
|
TriggerConfig: TriggerConfig | undefined;
|
|
@@ -699,12 +763,14 @@ export interface FlowDefinition {
|
|
|
699
763
|
*/
|
|
700
764
|
export interface AppflowIntegration {
|
|
701
765
|
/**
|
|
766
|
+
* @public
|
|
702
767
|
* <p>The configurations that control how Customer Profiles retrieves data from the source,
|
|
703
768
|
* Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of
|
|
704
769
|
* customers.</p>
|
|
705
770
|
*/
|
|
706
771
|
FlowDefinition: FlowDefinition | undefined;
|
|
707
772
|
/**
|
|
773
|
+
* @public
|
|
708
774
|
* <p>Batches in workflow of type <code>APPFLOW_INTEGRATION</code>.</p>
|
|
709
775
|
*/
|
|
710
776
|
Batches?: Batch[];
|
|
@@ -715,14 +781,17 @@ export interface AppflowIntegration {
|
|
|
715
781
|
*/
|
|
716
782
|
export interface AppflowIntegrationWorkflowAttributes {
|
|
717
783
|
/**
|
|
784
|
+
* @public
|
|
718
785
|
* <p>Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.</p>
|
|
719
786
|
*/
|
|
720
787
|
SourceConnectorType: SourceConnectorType | string | undefined;
|
|
721
788
|
/**
|
|
789
|
+
* @public
|
|
722
790
|
* <p>The name of the AppFlow connector profile used for ingestion.</p>
|
|
723
791
|
*/
|
|
724
792
|
ConnectorProfileName: string | undefined;
|
|
725
793
|
/**
|
|
794
|
+
* @public
|
|
726
795
|
* <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>
|
|
727
796
|
*/
|
|
728
797
|
RoleArn?: string;
|
|
@@ -733,14 +802,17 @@ export interface AppflowIntegrationWorkflowAttributes {
|
|
|
733
802
|
*/
|
|
734
803
|
export interface AppflowIntegrationWorkflowMetrics {
|
|
735
804
|
/**
|
|
805
|
+
* @public
|
|
736
806
|
* <p>Number of records processed in <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
737
807
|
*/
|
|
738
808
|
RecordsProcessed: number | undefined;
|
|
739
809
|
/**
|
|
810
|
+
* @public
|
|
740
811
|
* <p>Total steps completed in <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
741
812
|
*/
|
|
742
813
|
StepsCompleted: number | undefined;
|
|
743
814
|
/**
|
|
815
|
+
* @public
|
|
744
816
|
* <p>Total steps in <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
745
817
|
*/
|
|
746
818
|
TotalSteps: number | undefined;
|
|
@@ -768,34 +840,42 @@ export type Status = (typeof Status)[keyof typeof Status];
|
|
|
768
840
|
*/
|
|
769
841
|
export interface AppflowIntegrationWorkflowStep {
|
|
770
842
|
/**
|
|
843
|
+
* @public
|
|
771
844
|
* <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>
|
|
772
845
|
*/
|
|
773
846
|
FlowName: string | undefined;
|
|
774
847
|
/**
|
|
848
|
+
* @public
|
|
775
849
|
* <p>Workflow step status for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
776
850
|
*/
|
|
777
851
|
Status: Status | string | undefined;
|
|
778
852
|
/**
|
|
853
|
+
* @public
|
|
779
854
|
* <p>Message indicating execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
780
855
|
*/
|
|
781
856
|
ExecutionMessage: string | undefined;
|
|
782
857
|
/**
|
|
858
|
+
* @public
|
|
783
859
|
* <p>Total number of records processed during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
784
860
|
*/
|
|
785
861
|
RecordsProcessed: number | undefined;
|
|
786
862
|
/**
|
|
863
|
+
* @public
|
|
787
864
|
* <p>Start datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
788
865
|
*/
|
|
789
866
|
BatchRecordsStartTime: string | undefined;
|
|
790
867
|
/**
|
|
868
|
+
* @public
|
|
791
869
|
* <p>End datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
792
870
|
*/
|
|
793
871
|
BatchRecordsEndTime: string | undefined;
|
|
794
872
|
/**
|
|
873
|
+
* @public
|
|
795
874
|
* <p>Creation timestamp of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
796
875
|
*/
|
|
797
876
|
CreatedAt: Date | undefined;
|
|
798
877
|
/**
|
|
878
|
+
* @public
|
|
799
879
|
* <p>Last updated timestamp for workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
800
880
|
*/
|
|
801
881
|
LastUpdatedAt: Date | undefined;
|
|
@@ -806,6 +886,7 @@ export interface AppflowIntegrationWorkflowStep {
|
|
|
806
886
|
*/
|
|
807
887
|
export interface AttributeItem {
|
|
808
888
|
/**
|
|
889
|
+
* @public
|
|
809
890
|
* <p>The name of an attribute defined in a profile object type.</p>
|
|
810
891
|
*/
|
|
811
892
|
Name: string | undefined;
|
|
@@ -816,10 +897,12 @@ export interface AttributeItem {
|
|
|
816
897
|
*/
|
|
817
898
|
export interface AttributeDetails {
|
|
818
899
|
/**
|
|
900
|
+
* @public
|
|
819
901
|
* <p>A list of attribute items specified in the mathematical expression.</p>
|
|
820
902
|
*/
|
|
821
903
|
Attributes: AttributeItem[] | undefined;
|
|
822
904
|
/**
|
|
905
|
+
* @public
|
|
823
906
|
* <p>Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"\{ObjectTypeName.AttributeName\}\".</p>
|
|
824
907
|
*/
|
|
825
908
|
Expression: string | undefined;
|
|
@@ -886,11 +969,13 @@ export type AttributeMatchingModel = (typeof AttributeMatchingModel)[keyof typeo
|
|
|
886
969
|
*/
|
|
887
970
|
export interface AttributeTypesSelector {
|
|
888
971
|
/**
|
|
972
|
+
* @public
|
|
889
973
|
* <p>Configures the <code>AttributeMatchingModel</code>, you can either choose <code>ONE_TO_ONE</code> or
|
|
890
974
|
* <code>MANY_TO_MANY</code>.</p>
|
|
891
975
|
*/
|
|
892
976
|
AttributeMatchingModel: AttributeMatchingModel | string | undefined;
|
|
893
977
|
/**
|
|
978
|
+
* @public
|
|
894
979
|
* <p>The <code>Address</code> type. You can choose from <code>Address</code>,
|
|
895
980
|
* <code>BusinessAddress</code>, <code>MaillingAddress</code>, and
|
|
896
981
|
* <code>ShippingAddress</code>.</p>
|
|
@@ -902,6 +987,7 @@ export interface AttributeTypesSelector {
|
|
|
902
987
|
*/
|
|
903
988
|
Address?: string[];
|
|
904
989
|
/**
|
|
990
|
+
* @public
|
|
905
991
|
* <p>The <code>PhoneNumber</code> type. You can choose from <code>PhoneNumber</code>,
|
|
906
992
|
* <code>HomePhoneNumber</code>, and <code>MobilePhoneNumber</code>.</p>
|
|
907
993
|
* <p>You only can use the <code>PhoneNumber</code> type in the <code>MatchingRule</code>. For
|
|
@@ -912,6 +998,7 @@ export interface AttributeTypesSelector {
|
|
|
912
998
|
*/
|
|
913
999
|
PhoneNumber?: string[];
|
|
914
1000
|
/**
|
|
1001
|
+
* @public
|
|
915
1002
|
* <p>The <code>Email</code> type. You can choose from <code>EmailAddress</code>,
|
|
916
1003
|
* <code>BusinessEmailAddress</code> and <code>PersonalEmailAddress</code>.</p>
|
|
917
1004
|
* <p>You only can use the <code>EmailAddress</code> type in the <code>MatchingRule</code>.
|
|
@@ -941,6 +1028,7 @@ export type ConflictResolvingModel = (typeof ConflictResolvingModel)[keyof typeo
|
|
|
941
1028
|
*/
|
|
942
1029
|
export interface ConflictResolution {
|
|
943
1030
|
/**
|
|
1031
|
+
* @public
|
|
944
1032
|
* <p>How the auto-merging process should resolve conflicts between different profiles.</p>
|
|
945
1033
|
* <ul>
|
|
946
1034
|
* <li>
|
|
@@ -958,6 +1046,7 @@ export interface ConflictResolution {
|
|
|
958
1046
|
*/
|
|
959
1047
|
ConflictResolvingModel: ConflictResolvingModel | string | undefined;
|
|
960
1048
|
/**
|
|
1049
|
+
* @public
|
|
961
1050
|
* <p>The <code>ObjectType</code> name that is used to resolve profile merging conflicts when
|
|
962
1051
|
* choosing <code>SOURCE</code> as the <code>ConflictResolvingModel</code>.</p>
|
|
963
1052
|
*/
|
|
@@ -969,6 +1058,7 @@ export interface ConflictResolution {
|
|
|
969
1058
|
*/
|
|
970
1059
|
export interface Consolidation {
|
|
971
1060
|
/**
|
|
1061
|
+
* @public
|
|
972
1062
|
* <p>A list of matching criteria.</p>
|
|
973
1063
|
*/
|
|
974
1064
|
MatchingAttributesList: string[][] | undefined;
|
|
@@ -979,15 +1069,18 @@ export interface Consolidation {
|
|
|
979
1069
|
*/
|
|
980
1070
|
export interface AutoMerging {
|
|
981
1071
|
/**
|
|
1072
|
+
* @public
|
|
982
1073
|
* <p>The flag that enables the auto-merging of duplicate profiles.</p>
|
|
983
1074
|
*/
|
|
984
1075
|
Enabled: boolean | undefined;
|
|
985
1076
|
/**
|
|
1077
|
+
* @public
|
|
986
1078
|
* <p>A list of matching attributes that represent matching criteria. If two profiles meet at
|
|
987
1079
|
* least one of the requirements in the matching attributes list, they will be merged.</p>
|
|
988
1080
|
*/
|
|
989
1081
|
Consolidation?: Consolidation;
|
|
990
1082
|
/**
|
|
1083
|
+
* @public
|
|
991
1084
|
* <p>How the auto-merging process should resolve conflicts between different profiles. For
|
|
992
1085
|
* example, if Profile A and Profile B have the same <code>FirstName</code> and
|
|
993
1086
|
* <code>LastName</code> (and that is the matching criteria), which
|
|
@@ -995,6 +1088,7 @@ export interface AutoMerging {
|
|
|
995
1088
|
*/
|
|
996
1089
|
ConflictResolution?: ConflictResolution;
|
|
997
1090
|
/**
|
|
1091
|
+
* @public
|
|
998
1092
|
* <p>A number between 0 and 1 that represents the minimum confidence score required for
|
|
999
1093
|
* profiles within a matching group to be merged during the auto-merge process. A higher
|
|
1000
1094
|
* score means higher similarity required to merge profiles. </p>
|
|
@@ -1007,26 +1101,32 @@ export interface AutoMerging {
|
|
|
1007
1101
|
*/
|
|
1008
1102
|
export interface ListCalculatedAttributeDefinitionItem {
|
|
1009
1103
|
/**
|
|
1104
|
+
* @public
|
|
1010
1105
|
* <p>The unique name of the calculated attribute.</p>
|
|
1011
1106
|
*/
|
|
1012
1107
|
CalculatedAttributeName?: string;
|
|
1013
1108
|
/**
|
|
1109
|
+
* @public
|
|
1014
1110
|
* <p>The display name of the calculated attribute.</p>
|
|
1015
1111
|
*/
|
|
1016
1112
|
DisplayName?: string;
|
|
1017
1113
|
/**
|
|
1114
|
+
* @public
|
|
1018
1115
|
* <p>The threshold for the calculated attribute.</p>
|
|
1019
1116
|
*/
|
|
1020
1117
|
Description?: string;
|
|
1021
1118
|
/**
|
|
1119
|
+
* @public
|
|
1022
1120
|
* <p>The threshold for the calculated attribute.</p>
|
|
1023
1121
|
*/
|
|
1024
1122
|
CreatedAt?: Date;
|
|
1025
1123
|
/**
|
|
1124
|
+
* @public
|
|
1026
1125
|
* <p>The timestamp of when the calculated attribute definition was most recently edited.</p>
|
|
1027
1126
|
*/
|
|
1028
1127
|
LastUpdatedAt?: Date;
|
|
1029
1128
|
/**
|
|
1129
|
+
* @public
|
|
1030
1130
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1031
1131
|
*/
|
|
1032
1132
|
Tags?: Record<string, string>;
|
|
@@ -1037,18 +1137,22 @@ export interface ListCalculatedAttributeDefinitionItem {
|
|
|
1037
1137
|
*/
|
|
1038
1138
|
export interface ListCalculatedAttributeForProfileItem {
|
|
1039
1139
|
/**
|
|
1140
|
+
* @public
|
|
1040
1141
|
* <p>The unique name of the calculated attribute.</p>
|
|
1041
1142
|
*/
|
|
1042
1143
|
CalculatedAttributeName?: string;
|
|
1043
1144
|
/**
|
|
1145
|
+
* @public
|
|
1044
1146
|
* <p>The display name of the calculated attribute.</p>
|
|
1045
1147
|
*/
|
|
1046
1148
|
DisplayName?: string;
|
|
1047
1149
|
/**
|
|
1150
|
+
* @public
|
|
1048
1151
|
* <p>Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.</p>
|
|
1049
1152
|
*/
|
|
1050
1153
|
IsDataPartial?: string;
|
|
1051
1154
|
/**
|
|
1155
|
+
* @public
|
|
1052
1156
|
* <p>The value of the calculated attribute.</p>
|
|
1053
1157
|
*/
|
|
1054
1158
|
Value?: string;
|
|
@@ -1070,10 +1174,12 @@ export type Unit = (typeof Unit)[keyof typeof Unit];
|
|
|
1070
1174
|
*/
|
|
1071
1175
|
export interface Range {
|
|
1072
1176
|
/**
|
|
1177
|
+
* @public
|
|
1073
1178
|
* <p>The amount of time of the specified unit.</p>
|
|
1074
1179
|
*/
|
|
1075
1180
|
Value: number | undefined;
|
|
1076
1181
|
/**
|
|
1182
|
+
* @public
|
|
1077
1183
|
* <p>The unit of time.</p>
|
|
1078
1184
|
*/
|
|
1079
1185
|
Unit: Unit | string | undefined;
|
|
@@ -1098,10 +1204,12 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
|
1098
1204
|
*/
|
|
1099
1205
|
export interface Threshold {
|
|
1100
1206
|
/**
|
|
1207
|
+
* @public
|
|
1101
1208
|
* <p>The value of the threshold.</p>
|
|
1102
1209
|
*/
|
|
1103
1210
|
Value: string | undefined;
|
|
1104
1211
|
/**
|
|
1212
|
+
* @public
|
|
1105
1213
|
* <p>The operator of the threshold.</p>
|
|
1106
1214
|
*/
|
|
1107
1215
|
Operator: Operator | string | undefined;
|
|
@@ -1112,14 +1220,17 @@ export interface Threshold {
|
|
|
1112
1220
|
*/
|
|
1113
1221
|
export interface Conditions {
|
|
1114
1222
|
/**
|
|
1223
|
+
* @public
|
|
1115
1224
|
* <p>The relative time period over which data is included in the aggregation.</p>
|
|
1116
1225
|
*/
|
|
1117
1226
|
Range?: Range;
|
|
1118
1227
|
/**
|
|
1228
|
+
* @public
|
|
1119
1229
|
* <p>The number of profile objects used for the calculated attribute.</p>
|
|
1120
1230
|
*/
|
|
1121
1231
|
ObjectCount?: number;
|
|
1122
1232
|
/**
|
|
1233
|
+
* @public
|
|
1123
1234
|
* <p>The threshold for the calculated attribute.</p>
|
|
1124
1235
|
*/
|
|
1125
1236
|
Threshold?: Threshold;
|
|
@@ -1147,34 +1258,42 @@ export type Statistic = (typeof Statistic)[keyof typeof Statistic];
|
|
|
1147
1258
|
*/
|
|
1148
1259
|
export interface CreateCalculatedAttributeDefinitionRequest {
|
|
1149
1260
|
/**
|
|
1261
|
+
* @public
|
|
1150
1262
|
* <p>The unique name of the domain.</p>
|
|
1151
1263
|
*/
|
|
1152
1264
|
DomainName: string | undefined;
|
|
1153
1265
|
/**
|
|
1266
|
+
* @public
|
|
1154
1267
|
* <p>The unique name of the calculated attribute.</p>
|
|
1155
1268
|
*/
|
|
1156
1269
|
CalculatedAttributeName: string | undefined;
|
|
1157
1270
|
/**
|
|
1271
|
+
* @public
|
|
1158
1272
|
* <p>The display name of the calculated attribute.</p>
|
|
1159
1273
|
*/
|
|
1160
1274
|
DisplayName?: string;
|
|
1161
1275
|
/**
|
|
1276
|
+
* @public
|
|
1162
1277
|
* <p>The description of the calculated attribute.</p>
|
|
1163
1278
|
*/
|
|
1164
1279
|
Description?: string;
|
|
1165
1280
|
/**
|
|
1281
|
+
* @public
|
|
1166
1282
|
* <p>Mathematical expression and a list of attribute items specified in that expression.</p>
|
|
1167
1283
|
*/
|
|
1168
1284
|
AttributeDetails: AttributeDetails | undefined;
|
|
1169
1285
|
/**
|
|
1286
|
+
* @public
|
|
1170
1287
|
* <p>The conditions including range, object count, and threshold for the calculated attribute.</p>
|
|
1171
1288
|
*/
|
|
1172
1289
|
Conditions?: Conditions;
|
|
1173
1290
|
/**
|
|
1291
|
+
* @public
|
|
1174
1292
|
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
1175
1293
|
*/
|
|
1176
1294
|
Statistic: Statistic | string | undefined;
|
|
1177
1295
|
/**
|
|
1296
|
+
* @public
|
|
1178
1297
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1179
1298
|
*/
|
|
1180
1299
|
Tags?: Record<string, string>;
|
|
@@ -1184,38 +1303,47 @@ export interface CreateCalculatedAttributeDefinitionRequest {
|
|
|
1184
1303
|
*/
|
|
1185
1304
|
export interface CreateCalculatedAttributeDefinitionResponse {
|
|
1186
1305
|
/**
|
|
1306
|
+
* @public
|
|
1187
1307
|
* <p>The unique name of the calculated attribute.</p>
|
|
1188
1308
|
*/
|
|
1189
1309
|
CalculatedAttributeName?: string;
|
|
1190
1310
|
/**
|
|
1311
|
+
* @public
|
|
1191
1312
|
* <p>The display name of the calculated attribute.</p>
|
|
1192
1313
|
*/
|
|
1193
1314
|
DisplayName?: string;
|
|
1194
1315
|
/**
|
|
1316
|
+
* @public
|
|
1195
1317
|
* <p>The description of the calculated attribute.</p>
|
|
1196
1318
|
*/
|
|
1197
1319
|
Description?: string;
|
|
1198
1320
|
/**
|
|
1321
|
+
* @public
|
|
1199
1322
|
* <p>Mathematical expression and a list of attribute items specified in that expression.</p>
|
|
1200
1323
|
*/
|
|
1201
1324
|
AttributeDetails?: AttributeDetails;
|
|
1202
1325
|
/**
|
|
1326
|
+
* @public
|
|
1203
1327
|
* <p>The conditions including range, object count, and threshold for the calculated attribute.</p>
|
|
1204
1328
|
*/
|
|
1205
1329
|
Conditions?: Conditions;
|
|
1206
1330
|
/**
|
|
1331
|
+
* @public
|
|
1207
1332
|
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
1208
1333
|
*/
|
|
1209
1334
|
Statistic?: Statistic | string;
|
|
1210
1335
|
/**
|
|
1336
|
+
* @public
|
|
1211
1337
|
* <p>The timestamp of when the calculated attribute definition was created.</p>
|
|
1212
1338
|
*/
|
|
1213
1339
|
CreatedAt?: Date;
|
|
1214
1340
|
/**
|
|
1341
|
+
* @public
|
|
1215
1342
|
* <p>The timestamp of when the calculated attribute definition was most recently edited.</p>
|
|
1216
1343
|
*/
|
|
1217
1344
|
LastUpdatedAt?: Date;
|
|
1218
1345
|
/**
|
|
1346
|
+
* @public
|
|
1219
1347
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1220
1348
|
*/
|
|
1221
1349
|
Tags?: Record<string, string>;
|
|
@@ -1226,10 +1354,12 @@ export interface CreateCalculatedAttributeDefinitionResponse {
|
|
|
1226
1354
|
*/
|
|
1227
1355
|
export interface S3ExportingConfig {
|
|
1228
1356
|
/**
|
|
1357
|
+
* @public
|
|
1229
1358
|
* <p>The name of the S3 bucket where Identity Resolution Jobs write result files.</p>
|
|
1230
1359
|
*/
|
|
1231
1360
|
S3BucketName: string | undefined;
|
|
1232
1361
|
/**
|
|
1362
|
+
* @public
|
|
1233
1363
|
* <p>The S3 key name of the location where Identity Resolution Jobs write result files.</p>
|
|
1234
1364
|
*/
|
|
1235
1365
|
S3KeyName?: string;
|
|
@@ -1245,6 +1375,7 @@ export interface S3ExportingConfig {
|
|
|
1245
1375
|
*/
|
|
1246
1376
|
export interface ExportingConfig {
|
|
1247
1377
|
/**
|
|
1378
|
+
* @public
|
|
1248
1379
|
* <p>The S3 location where Identity Resolution Jobs write result files.</p>
|
|
1249
1380
|
*/
|
|
1250
1381
|
S3Exporting?: S3ExportingConfig;
|
|
@@ -1272,10 +1403,12 @@ export type JobScheduleDayOfTheWeek = (typeof JobScheduleDayOfTheWeek)[keyof typ
|
|
|
1272
1403
|
*/
|
|
1273
1404
|
export interface JobSchedule {
|
|
1274
1405
|
/**
|
|
1406
|
+
* @public
|
|
1275
1407
|
* <p>The day when the Identity Resolution Job should run every week.</p>
|
|
1276
1408
|
*/
|
|
1277
1409
|
DayOfTheWeek: JobScheduleDayOfTheWeek | string | undefined;
|
|
1278
1410
|
/**
|
|
1411
|
+
* @public
|
|
1279
1412
|
* <p>The time when the Identity Resolution Job should run every week.</p>
|
|
1280
1413
|
*/
|
|
1281
1414
|
Time: string | undefined;
|
|
@@ -1286,18 +1419,22 @@ export interface JobSchedule {
|
|
|
1286
1419
|
*/
|
|
1287
1420
|
export interface MatchingRequest {
|
|
1288
1421
|
/**
|
|
1422
|
+
* @public
|
|
1289
1423
|
* <p>The flag that enables the matching process of duplicate profiles.</p>
|
|
1290
1424
|
*/
|
|
1291
1425
|
Enabled: boolean | undefined;
|
|
1292
1426
|
/**
|
|
1427
|
+
* @public
|
|
1293
1428
|
* <p>The day and time when do you want to start the Identity Resolution Job every week.</p>
|
|
1294
1429
|
*/
|
|
1295
1430
|
JobSchedule?: JobSchedule;
|
|
1296
1431
|
/**
|
|
1432
|
+
* @public
|
|
1297
1433
|
* <p>Configuration information about the auto-merging process.</p>
|
|
1298
1434
|
*/
|
|
1299
1435
|
AutoMerging?: AutoMerging;
|
|
1300
1436
|
/**
|
|
1437
|
+
* @public
|
|
1301
1438
|
* <p>Configuration information for exporting Identity Resolution results, for example, to an S3
|
|
1302
1439
|
* bucket.</p>
|
|
1303
1440
|
*/
|
|
@@ -1364,6 +1501,7 @@ export interface MatchingRequest {
|
|
|
1364
1501
|
*/
|
|
1365
1502
|
export interface MatchingRule {
|
|
1366
1503
|
/**
|
|
1504
|
+
* @public
|
|
1367
1505
|
* <p>A single rule level of the <code>MatchRules</code>. Configures how the rule-based
|
|
1368
1506
|
* matching process should match profiles.</p>
|
|
1369
1507
|
*/
|
|
@@ -1375,34 +1513,41 @@ export interface MatchingRule {
|
|
|
1375
1513
|
*/
|
|
1376
1514
|
export interface RuleBasedMatchingRequest {
|
|
1377
1515
|
/**
|
|
1516
|
+
* @public
|
|
1378
1517
|
* <p>The flag that enables the rule-based matching process of duplicate profiles.</p>
|
|
1379
1518
|
*/
|
|
1380
1519
|
Enabled: boolean | undefined;
|
|
1381
1520
|
/**
|
|
1521
|
+
* @public
|
|
1382
1522
|
* <p>Configures how the rule-based matching process should match profiles. You can have up to 15
|
|
1383
1523
|
* <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
|
|
1384
1524
|
*/
|
|
1385
1525
|
MatchingRules?: MatchingRule[];
|
|
1386
1526
|
/**
|
|
1527
|
+
* @public
|
|
1387
1528
|
* <p>
|
|
1388
1529
|
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a>
|
|
1389
1530
|
* </p>
|
|
1390
1531
|
*/
|
|
1391
1532
|
MaxAllowedRuleLevelForMerging?: number;
|
|
1392
1533
|
/**
|
|
1534
|
+
* @public
|
|
1393
1535
|
* <p>Indicates the maximum allowed rule level.</p>
|
|
1394
1536
|
*/
|
|
1395
1537
|
MaxAllowedRuleLevelForMatching?: number;
|
|
1396
1538
|
/**
|
|
1539
|
+
* @public
|
|
1397
1540
|
* <p>Configures information about the <code>AttributeTypesSelector</code> where the
|
|
1398
1541
|
* rule-based identity resolution uses to match profiles.</p>
|
|
1399
1542
|
*/
|
|
1400
1543
|
AttributeTypesSelector?: AttributeTypesSelector;
|
|
1401
1544
|
/**
|
|
1545
|
+
* @public
|
|
1402
1546
|
* <p>How the auto-merging process should resolve conflicts between different profiles.</p>
|
|
1403
1547
|
*/
|
|
1404
1548
|
ConflictResolution?: ConflictResolution;
|
|
1405
1549
|
/**
|
|
1550
|
+
* @public
|
|
1406
1551
|
* <p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p>
|
|
1407
1552
|
* <note>
|
|
1408
1553
|
* <p>You need to give Customer Profiles service principal write permission to your S3 bucket.
|
|
@@ -1417,20 +1562,24 @@ export interface RuleBasedMatchingRequest {
|
|
|
1417
1562
|
*/
|
|
1418
1563
|
export interface CreateDomainRequest {
|
|
1419
1564
|
/**
|
|
1565
|
+
* @public
|
|
1420
1566
|
* <p>The unique name of the domain.</p>
|
|
1421
1567
|
*/
|
|
1422
1568
|
DomainName: string | undefined;
|
|
1423
1569
|
/**
|
|
1570
|
+
* @public
|
|
1424
1571
|
* <p>The default number of days until the data within the domain expires.</p>
|
|
1425
1572
|
*/
|
|
1426
1573
|
DefaultExpirationDays: number | undefined;
|
|
1427
1574
|
/**
|
|
1575
|
+
* @public
|
|
1428
1576
|
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
1429
1577
|
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
1430
1578
|
* permanent or semi-permanent storage.</p>
|
|
1431
1579
|
*/
|
|
1432
1580
|
DefaultEncryptionKey?: string;
|
|
1433
1581
|
/**
|
|
1582
|
+
* @public
|
|
1434
1583
|
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
1435
1584
|
* ingesting data from third party applications. You must set up a policy on the
|
|
1436
1585
|
* DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send
|
|
@@ -1438,6 +1587,7 @@ export interface CreateDomainRequest {
|
|
|
1438
1587
|
*/
|
|
1439
1588
|
DeadLetterQueueUrl?: string;
|
|
1440
1589
|
/**
|
|
1590
|
+
* @public
|
|
1441
1591
|
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
1442
1592
|
* 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
|
|
1443
1593
|
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
@@ -1448,6 +1598,7 @@ export interface CreateDomainRequest {
|
|
|
1448
1598
|
*/
|
|
1449
1599
|
Matching?: MatchingRequest;
|
|
1450
1600
|
/**
|
|
1601
|
+
* @public
|
|
1451
1602
|
* <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true,
|
|
1452
1603
|
* Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration
|
|
1453
1604
|
* in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and
|
|
@@ -1456,6 +1607,7 @@ export interface CreateDomainRequest {
|
|
|
1456
1607
|
*/
|
|
1457
1608
|
RuleBasedMatching?: RuleBasedMatchingRequest;
|
|
1458
1609
|
/**
|
|
1610
|
+
* @public
|
|
1459
1611
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1460
1612
|
*/
|
|
1461
1613
|
Tags?: Record<string, string>;
|
|
@@ -1466,18 +1618,22 @@ export interface CreateDomainRequest {
|
|
|
1466
1618
|
*/
|
|
1467
1619
|
export interface MatchingResponse {
|
|
1468
1620
|
/**
|
|
1621
|
+
* @public
|
|
1469
1622
|
* <p>The flag that enables the matching process of duplicate profiles.</p>
|
|
1470
1623
|
*/
|
|
1471
1624
|
Enabled?: boolean;
|
|
1472
1625
|
/**
|
|
1626
|
+
* @public
|
|
1473
1627
|
* <p>The day and time when do you want to start the Identity Resolution Job every week.</p>
|
|
1474
1628
|
*/
|
|
1475
1629
|
JobSchedule?: JobSchedule;
|
|
1476
1630
|
/**
|
|
1631
|
+
* @public
|
|
1477
1632
|
* <p>Configuration information about the auto-merging process.</p>
|
|
1478
1633
|
*/
|
|
1479
1634
|
AutoMerging?: AutoMerging;
|
|
1480
1635
|
/**
|
|
1636
|
+
* @public
|
|
1481
1637
|
* <p>Configuration information for exporting Identity Resolution results, for example, to an S3
|
|
1482
1638
|
* bucket.</p>
|
|
1483
1639
|
*/
|
|
@@ -1502,15 +1658,18 @@ export type RuleBasedMatchingStatus = (typeof RuleBasedMatchingStatus)[keyof typ
|
|
|
1502
1658
|
*/
|
|
1503
1659
|
export interface RuleBasedMatchingResponse {
|
|
1504
1660
|
/**
|
|
1661
|
+
* @public
|
|
1505
1662
|
* <p>The flag that enables the rule-based matching process of duplicate profiles.</p>
|
|
1506
1663
|
*/
|
|
1507
1664
|
Enabled?: boolean;
|
|
1508
1665
|
/**
|
|
1666
|
+
* @public
|
|
1509
1667
|
* <p>Configures how the rule-based matching process should match profiles. You can have up to 15
|
|
1510
1668
|
* <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
|
|
1511
1669
|
*/
|
|
1512
1670
|
MatchingRules?: MatchingRule[];
|
|
1513
1671
|
/**
|
|
1672
|
+
* @public
|
|
1514
1673
|
* <p>PENDING</p>
|
|
1515
1674
|
* <ul>
|
|
1516
1675
|
* <li>
|
|
@@ -1538,25 +1697,30 @@ export interface RuleBasedMatchingResponse {
|
|
|
1538
1697
|
*/
|
|
1539
1698
|
Status?: RuleBasedMatchingStatus | string;
|
|
1540
1699
|
/**
|
|
1700
|
+
* @public
|
|
1541
1701
|
* <p>
|
|
1542
1702
|
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a>
|
|
1543
1703
|
* </p>
|
|
1544
1704
|
*/
|
|
1545
1705
|
MaxAllowedRuleLevelForMerging?: number;
|
|
1546
1706
|
/**
|
|
1707
|
+
* @public
|
|
1547
1708
|
* <p>Indicates the maximum allowed rule level.</p>
|
|
1548
1709
|
*/
|
|
1549
1710
|
MaxAllowedRuleLevelForMatching?: number;
|
|
1550
1711
|
/**
|
|
1712
|
+
* @public
|
|
1551
1713
|
* <p>Configures information about the <code>AttributeTypesSelector</code> where the
|
|
1552
1714
|
* rule-based identity resolution uses to match profiles.</p>
|
|
1553
1715
|
*/
|
|
1554
1716
|
AttributeTypesSelector?: AttributeTypesSelector;
|
|
1555
1717
|
/**
|
|
1718
|
+
* @public
|
|
1556
1719
|
* <p>How the auto-merging process should resolve conflicts between different profiles.</p>
|
|
1557
1720
|
*/
|
|
1558
1721
|
ConflictResolution?: ConflictResolution;
|
|
1559
1722
|
/**
|
|
1723
|
+
* @public
|
|
1560
1724
|
* <p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p>
|
|
1561
1725
|
* <note>
|
|
1562
1726
|
* <p>You need to give Customer Profiles service principal write permission to your S3 bucket.
|
|
@@ -1571,25 +1735,30 @@ export interface RuleBasedMatchingResponse {
|
|
|
1571
1735
|
*/
|
|
1572
1736
|
export interface CreateDomainResponse {
|
|
1573
1737
|
/**
|
|
1738
|
+
* @public
|
|
1574
1739
|
* <p>The unique name of the domain.</p>
|
|
1575
1740
|
*/
|
|
1576
1741
|
DomainName: string | undefined;
|
|
1577
1742
|
/**
|
|
1743
|
+
* @public
|
|
1578
1744
|
* <p>The default number of days until the data within the domain expires.</p>
|
|
1579
1745
|
*/
|
|
1580
1746
|
DefaultExpirationDays: number | undefined;
|
|
1581
1747
|
/**
|
|
1748
|
+
* @public
|
|
1582
1749
|
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
1583
1750
|
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
1584
1751
|
* permanent or semi-permanent storage.</p>
|
|
1585
1752
|
*/
|
|
1586
1753
|
DefaultEncryptionKey?: string;
|
|
1587
1754
|
/**
|
|
1755
|
+
* @public
|
|
1588
1756
|
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
1589
1757
|
* ingesting data from third party applications.</p>
|
|
1590
1758
|
*/
|
|
1591
1759
|
DeadLetterQueueUrl?: string;
|
|
1592
1760
|
/**
|
|
1761
|
+
* @public
|
|
1593
1762
|
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
1594
1763
|
* 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
|
|
1595
1764
|
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
@@ -1600,6 +1769,7 @@ export interface CreateDomainResponse {
|
|
|
1600
1769
|
*/
|
|
1601
1770
|
Matching?: MatchingResponse;
|
|
1602
1771
|
/**
|
|
1772
|
+
* @public
|
|
1603
1773
|
* <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true,
|
|
1604
1774
|
* Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration
|
|
1605
1775
|
* in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and
|
|
@@ -1608,14 +1778,17 @@ export interface CreateDomainResponse {
|
|
|
1608
1778
|
*/
|
|
1609
1779
|
RuleBasedMatching?: RuleBasedMatchingResponse;
|
|
1610
1780
|
/**
|
|
1781
|
+
* @public
|
|
1611
1782
|
* <p>The timestamp of when the domain was created.</p>
|
|
1612
1783
|
*/
|
|
1613
1784
|
CreatedAt: Date | undefined;
|
|
1614
1785
|
/**
|
|
1786
|
+
* @public
|
|
1615
1787
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
1616
1788
|
*/
|
|
1617
1789
|
LastUpdatedAt: Date | undefined;
|
|
1618
1790
|
/**
|
|
1791
|
+
* @public
|
|
1619
1792
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1620
1793
|
*/
|
|
1621
1794
|
Tags?: Record<string, string>;
|
|
@@ -1625,19 +1798,23 @@ export interface CreateDomainResponse {
|
|
|
1625
1798
|
*/
|
|
1626
1799
|
export interface CreateEventStreamRequest {
|
|
1627
1800
|
/**
|
|
1801
|
+
* @public
|
|
1628
1802
|
* <p>The unique name of the domain.</p>
|
|
1629
1803
|
*/
|
|
1630
1804
|
DomainName: string | undefined;
|
|
1631
1805
|
/**
|
|
1806
|
+
* @public
|
|
1632
1807
|
* <p>The StreamARN of the destination to deliver profile events to. For example,
|
|
1633
1808
|
* arn:aws:kinesis:region:account-id:stream/stream-name</p>
|
|
1634
1809
|
*/
|
|
1635
1810
|
Uri: string | undefined;
|
|
1636
1811
|
/**
|
|
1812
|
+
* @public
|
|
1637
1813
|
* <p>The name of the event stream.</p>
|
|
1638
1814
|
*/
|
|
1639
1815
|
EventStreamName: string | undefined;
|
|
1640
1816
|
/**
|
|
1817
|
+
* @public
|
|
1641
1818
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1642
1819
|
*/
|
|
1643
1820
|
Tags?: Record<string, string>;
|
|
@@ -1647,10 +1824,12 @@ export interface CreateEventStreamRequest {
|
|
|
1647
1824
|
*/
|
|
1648
1825
|
export interface CreateEventStreamResponse {
|
|
1649
1826
|
/**
|
|
1827
|
+
* @public
|
|
1650
1828
|
* <p>A unique identifier for the event stream.</p>
|
|
1651
1829
|
*/
|
|
1652
1830
|
EventStreamArn: string | undefined;
|
|
1653
1831
|
/**
|
|
1832
|
+
* @public
|
|
1654
1833
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1655
1834
|
*/
|
|
1656
1835
|
Tags?: Record<string, string>;
|
|
@@ -1661,6 +1840,7 @@ export interface CreateEventStreamResponse {
|
|
|
1661
1840
|
*/
|
|
1662
1841
|
export interface IntegrationConfig {
|
|
1663
1842
|
/**
|
|
1843
|
+
* @public
|
|
1664
1844
|
* <p>Configuration data for <code>APPFLOW_INTEGRATION</code> workflow type.</p>
|
|
1665
1845
|
*/
|
|
1666
1846
|
AppflowIntegration?: AppflowIntegration;
|
|
@@ -1681,26 +1861,32 @@ export type WorkflowType = (typeof WorkflowType)[keyof typeof WorkflowType];
|
|
|
1681
1861
|
*/
|
|
1682
1862
|
export interface CreateIntegrationWorkflowRequest {
|
|
1683
1863
|
/**
|
|
1864
|
+
* @public
|
|
1684
1865
|
* <p>The unique name of the domain.</p>
|
|
1685
1866
|
*/
|
|
1686
1867
|
DomainName: string | undefined;
|
|
1687
1868
|
/**
|
|
1869
|
+
* @public
|
|
1688
1870
|
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
1689
1871
|
*/
|
|
1690
1872
|
WorkflowType: WorkflowType | string | undefined;
|
|
1691
1873
|
/**
|
|
1874
|
+
* @public
|
|
1692
1875
|
* <p>Configuration data for integration workflow.</p>
|
|
1693
1876
|
*/
|
|
1694
1877
|
IntegrationConfig: IntegrationConfig | undefined;
|
|
1695
1878
|
/**
|
|
1879
|
+
* @public
|
|
1696
1880
|
* <p>The name of the profile object type.</p>
|
|
1697
1881
|
*/
|
|
1698
1882
|
ObjectTypeName: string | undefined;
|
|
1699
1883
|
/**
|
|
1884
|
+
* @public
|
|
1700
1885
|
* <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>
|
|
1701
1886
|
*/
|
|
1702
1887
|
RoleArn: string | undefined;
|
|
1703
1888
|
/**
|
|
1889
|
+
* @public
|
|
1704
1890
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1705
1891
|
*/
|
|
1706
1892
|
Tags?: Record<string, string>;
|
|
@@ -1710,10 +1896,12 @@ export interface CreateIntegrationWorkflowRequest {
|
|
|
1710
1896
|
*/
|
|
1711
1897
|
export interface CreateIntegrationWorkflowResponse {
|
|
1712
1898
|
/**
|
|
1899
|
+
* @public
|
|
1713
1900
|
* <p>Unique identifier for the workflow.</p>
|
|
1714
1901
|
*/
|
|
1715
1902
|
WorkflowId: string | undefined;
|
|
1716
1903
|
/**
|
|
1904
|
+
* @public
|
|
1717
1905
|
* <p>A message indicating create request was received.</p>
|
|
1718
1906
|
*/
|
|
1719
1907
|
Message: string | undefined;
|
|
@@ -1749,105 +1937,129 @@ export type PartyType = (typeof PartyType)[keyof typeof PartyType];
|
|
|
1749
1937
|
*/
|
|
1750
1938
|
export interface CreateProfileRequest {
|
|
1751
1939
|
/**
|
|
1940
|
+
* @public
|
|
1752
1941
|
* <p>The unique name of the domain.</p>
|
|
1753
1942
|
*/
|
|
1754
1943
|
DomainName: string | undefined;
|
|
1755
1944
|
/**
|
|
1945
|
+
* @public
|
|
1756
1946
|
* <p>A unique account number that you have given to the customer.</p>
|
|
1757
1947
|
*/
|
|
1758
1948
|
AccountNumber?: string;
|
|
1759
1949
|
/**
|
|
1950
|
+
* @public
|
|
1760
1951
|
* <p>Any additional information relevant to the customer’s profile.</p>
|
|
1761
1952
|
*/
|
|
1762
1953
|
AdditionalInformation?: string;
|
|
1763
1954
|
/**
|
|
1955
|
+
* @public
|
|
1764
1956
|
* @deprecated
|
|
1765
1957
|
*
|
|
1766
1958
|
* <p>The type of profile used to describe the customer.</p>
|
|
1767
1959
|
*/
|
|
1768
1960
|
PartyType?: PartyType | string;
|
|
1769
1961
|
/**
|
|
1962
|
+
* @public
|
|
1770
1963
|
* <p>The name of the customer’s business.</p>
|
|
1771
1964
|
*/
|
|
1772
1965
|
BusinessName?: string;
|
|
1773
1966
|
/**
|
|
1967
|
+
* @public
|
|
1774
1968
|
* <p>The customer’s first name.</p>
|
|
1775
1969
|
*/
|
|
1776
1970
|
FirstName?: string;
|
|
1777
1971
|
/**
|
|
1972
|
+
* @public
|
|
1778
1973
|
* <p>The customer’s middle name.</p>
|
|
1779
1974
|
*/
|
|
1780
1975
|
MiddleName?: string;
|
|
1781
1976
|
/**
|
|
1977
|
+
* @public
|
|
1782
1978
|
* <p>The customer’s last name.</p>
|
|
1783
1979
|
*/
|
|
1784
1980
|
LastName?: string;
|
|
1785
1981
|
/**
|
|
1982
|
+
* @public
|
|
1786
1983
|
* <p>The customer’s birth date. </p>
|
|
1787
1984
|
*/
|
|
1788
1985
|
BirthDate?: string;
|
|
1789
1986
|
/**
|
|
1987
|
+
* @public
|
|
1790
1988
|
* @deprecated
|
|
1791
1989
|
*
|
|
1792
1990
|
* <p>The gender with which the customer identifies. </p>
|
|
1793
1991
|
*/
|
|
1794
1992
|
Gender?: Gender | string;
|
|
1795
1993
|
/**
|
|
1994
|
+
* @public
|
|
1796
1995
|
* <p>The customer’s phone number, which has not been specified as a mobile, home, or business
|
|
1797
1996
|
* number. </p>
|
|
1798
1997
|
*/
|
|
1799
1998
|
PhoneNumber?: string;
|
|
1800
1999
|
/**
|
|
2000
|
+
* @public
|
|
1801
2001
|
* <p>The customer’s mobile phone number.</p>
|
|
1802
2002
|
*/
|
|
1803
2003
|
MobilePhoneNumber?: string;
|
|
1804
2004
|
/**
|
|
2005
|
+
* @public
|
|
1805
2006
|
* <p>The customer’s home phone number.</p>
|
|
1806
2007
|
*/
|
|
1807
2008
|
HomePhoneNumber?: string;
|
|
1808
2009
|
/**
|
|
2010
|
+
* @public
|
|
1809
2011
|
* <p>The customer’s business phone number.</p>
|
|
1810
2012
|
*/
|
|
1811
2013
|
BusinessPhoneNumber?: string;
|
|
1812
2014
|
/**
|
|
2015
|
+
* @public
|
|
1813
2016
|
* <p>The customer’s email address, which has not been specified as a personal or business
|
|
1814
2017
|
* address. </p>
|
|
1815
2018
|
*/
|
|
1816
2019
|
EmailAddress?: string;
|
|
1817
2020
|
/**
|
|
2021
|
+
* @public
|
|
1818
2022
|
* <p>The customer’s personal email address.</p>
|
|
1819
2023
|
*/
|
|
1820
2024
|
PersonalEmailAddress?: string;
|
|
1821
2025
|
/**
|
|
2026
|
+
* @public
|
|
1822
2027
|
* <p>The customer’s business email address.</p>
|
|
1823
2028
|
*/
|
|
1824
2029
|
BusinessEmailAddress?: string;
|
|
1825
2030
|
/**
|
|
2031
|
+
* @public
|
|
1826
2032
|
* <p>A generic address associated with the customer that is not mailing, shipping, or
|
|
1827
2033
|
* billing.</p>
|
|
1828
2034
|
*/
|
|
1829
2035
|
Address?: Address;
|
|
1830
2036
|
/**
|
|
2037
|
+
* @public
|
|
1831
2038
|
* <p>The customer’s shipping address.</p>
|
|
1832
2039
|
*/
|
|
1833
2040
|
ShippingAddress?: Address;
|
|
1834
2041
|
/**
|
|
2042
|
+
* @public
|
|
1835
2043
|
* <p>The customer’s mailing address.</p>
|
|
1836
2044
|
*/
|
|
1837
2045
|
MailingAddress?: Address;
|
|
1838
2046
|
/**
|
|
2047
|
+
* @public
|
|
1839
2048
|
* <p>The customer’s billing address.</p>
|
|
1840
2049
|
*/
|
|
1841
2050
|
BillingAddress?: Address;
|
|
1842
2051
|
/**
|
|
2052
|
+
* @public
|
|
1843
2053
|
* <p>A key value pair of attributes of a customer profile.</p>
|
|
1844
2054
|
*/
|
|
1845
2055
|
Attributes?: Record<string, string>;
|
|
1846
2056
|
/**
|
|
2057
|
+
* @public
|
|
1847
2058
|
* <p>An alternative to <code>PartyType</code> which accepts any string as input.</p>
|
|
1848
2059
|
*/
|
|
1849
2060
|
PartyTypeString?: string;
|
|
1850
2061
|
/**
|
|
2062
|
+
* @public
|
|
1851
2063
|
* <p>An alternative to <code>Gender</code> which accepts any string as input.</p>
|
|
1852
2064
|
*/
|
|
1853
2065
|
GenderString?: string;
|
|
@@ -1857,6 +2069,7 @@ export interface CreateProfileRequest {
|
|
|
1857
2069
|
*/
|
|
1858
2070
|
export interface CreateProfileResponse {
|
|
1859
2071
|
/**
|
|
2072
|
+
* @public
|
|
1860
2073
|
* <p>The unique identifier of a customer profile.</p>
|
|
1861
2074
|
*/
|
|
1862
2075
|
ProfileId: string | undefined;
|
|
@@ -1866,10 +2079,12 @@ export interface CreateProfileResponse {
|
|
|
1866
2079
|
*/
|
|
1867
2080
|
export interface DeleteCalculatedAttributeDefinitionRequest {
|
|
1868
2081
|
/**
|
|
2082
|
+
* @public
|
|
1869
2083
|
* <p>The unique name of the domain.</p>
|
|
1870
2084
|
*/
|
|
1871
2085
|
DomainName: string | undefined;
|
|
1872
2086
|
/**
|
|
2087
|
+
* @public
|
|
1873
2088
|
* <p>The unique name of the calculated attribute.</p>
|
|
1874
2089
|
*/
|
|
1875
2090
|
CalculatedAttributeName: string | undefined;
|
|
@@ -1884,6 +2099,7 @@ export interface DeleteCalculatedAttributeDefinitionResponse {
|
|
|
1884
2099
|
*/
|
|
1885
2100
|
export interface DeleteDomainRequest {
|
|
1886
2101
|
/**
|
|
2102
|
+
* @public
|
|
1887
2103
|
* <p>The unique name of the domain.</p>
|
|
1888
2104
|
*/
|
|
1889
2105
|
DomainName: string | undefined;
|
|
@@ -1893,6 +2109,7 @@ export interface DeleteDomainRequest {
|
|
|
1893
2109
|
*/
|
|
1894
2110
|
export interface DeleteDomainResponse {
|
|
1895
2111
|
/**
|
|
2112
|
+
* @public
|
|
1896
2113
|
* <p>A message that indicates the delete request is done.</p>
|
|
1897
2114
|
*/
|
|
1898
2115
|
Message: string | undefined;
|
|
@@ -1902,10 +2119,12 @@ export interface DeleteDomainResponse {
|
|
|
1902
2119
|
*/
|
|
1903
2120
|
export interface DeleteEventStreamRequest {
|
|
1904
2121
|
/**
|
|
2122
|
+
* @public
|
|
1905
2123
|
* <p>The unique name of the domain.</p>
|
|
1906
2124
|
*/
|
|
1907
2125
|
DomainName: string | undefined;
|
|
1908
2126
|
/**
|
|
2127
|
+
* @public
|
|
1909
2128
|
* <p>The name of the event stream</p>
|
|
1910
2129
|
*/
|
|
1911
2130
|
EventStreamName: string | undefined;
|
|
@@ -1920,10 +2139,12 @@ export interface DeleteEventStreamResponse {
|
|
|
1920
2139
|
*/
|
|
1921
2140
|
export interface DeleteIntegrationRequest {
|
|
1922
2141
|
/**
|
|
2142
|
+
* @public
|
|
1923
2143
|
* <p>The unique name of the domain.</p>
|
|
1924
2144
|
*/
|
|
1925
2145
|
DomainName: string | undefined;
|
|
1926
2146
|
/**
|
|
2147
|
+
* @public
|
|
1927
2148
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
1928
2149
|
*/
|
|
1929
2150
|
Uri: string | undefined;
|
|
@@ -1933,6 +2154,7 @@ export interface DeleteIntegrationRequest {
|
|
|
1933
2154
|
*/
|
|
1934
2155
|
export interface DeleteIntegrationResponse {
|
|
1935
2156
|
/**
|
|
2157
|
+
* @public
|
|
1936
2158
|
* <p>A message that indicates the delete request is done.</p>
|
|
1937
2159
|
*/
|
|
1938
2160
|
Message: string | undefined;
|
|
@@ -1942,10 +2164,12 @@ export interface DeleteIntegrationResponse {
|
|
|
1942
2164
|
*/
|
|
1943
2165
|
export interface DeleteProfileRequest {
|
|
1944
2166
|
/**
|
|
2167
|
+
* @public
|
|
1945
2168
|
* <p>The unique identifier of a customer profile.</p>
|
|
1946
2169
|
*/
|
|
1947
2170
|
ProfileId: string | undefined;
|
|
1948
2171
|
/**
|
|
2172
|
+
* @public
|
|
1949
2173
|
* <p>The unique name of the domain.</p>
|
|
1950
2174
|
*/
|
|
1951
2175
|
DomainName: string | undefined;
|
|
@@ -1955,6 +2179,7 @@ export interface DeleteProfileRequest {
|
|
|
1955
2179
|
*/
|
|
1956
2180
|
export interface DeleteProfileResponse {
|
|
1957
2181
|
/**
|
|
2182
|
+
* @public
|
|
1958
2183
|
* <p>A message that indicates the delete request is done.</p>
|
|
1959
2184
|
*/
|
|
1960
2185
|
Message?: string;
|
|
@@ -1964,18 +2189,22 @@ export interface DeleteProfileResponse {
|
|
|
1964
2189
|
*/
|
|
1965
2190
|
export interface DeleteProfileKeyRequest {
|
|
1966
2191
|
/**
|
|
2192
|
+
* @public
|
|
1967
2193
|
* <p>The unique identifier of a customer profile.</p>
|
|
1968
2194
|
*/
|
|
1969
2195
|
ProfileId: string | undefined;
|
|
1970
2196
|
/**
|
|
2197
|
+
* @public
|
|
1971
2198
|
* <p>A searchable identifier of a customer profile.</p>
|
|
1972
2199
|
*/
|
|
1973
2200
|
KeyName: string | undefined;
|
|
1974
2201
|
/**
|
|
2202
|
+
* @public
|
|
1975
2203
|
* <p>A list of key values.</p>
|
|
1976
2204
|
*/
|
|
1977
2205
|
Values: string[] | undefined;
|
|
1978
2206
|
/**
|
|
2207
|
+
* @public
|
|
1979
2208
|
* <p>The unique name of the domain.</p>
|
|
1980
2209
|
*/
|
|
1981
2210
|
DomainName: string | undefined;
|
|
@@ -1985,6 +2214,7 @@ export interface DeleteProfileKeyRequest {
|
|
|
1985
2214
|
*/
|
|
1986
2215
|
export interface DeleteProfileKeyResponse {
|
|
1987
2216
|
/**
|
|
2217
|
+
* @public
|
|
1988
2218
|
* <p>A message that indicates the delete request is done.</p>
|
|
1989
2219
|
*/
|
|
1990
2220
|
Message?: string;
|
|
@@ -1994,18 +2224,22 @@ export interface DeleteProfileKeyResponse {
|
|
|
1994
2224
|
*/
|
|
1995
2225
|
export interface DeleteProfileObjectRequest {
|
|
1996
2226
|
/**
|
|
2227
|
+
* @public
|
|
1997
2228
|
* <p>The unique identifier of a customer profile.</p>
|
|
1998
2229
|
*/
|
|
1999
2230
|
ProfileId: string | undefined;
|
|
2000
2231
|
/**
|
|
2232
|
+
* @public
|
|
2001
2233
|
* <p>The unique identifier of the profile object generated by the service.</p>
|
|
2002
2234
|
*/
|
|
2003
2235
|
ProfileObjectUniqueKey: string | undefined;
|
|
2004
2236
|
/**
|
|
2237
|
+
* @public
|
|
2005
2238
|
* <p>The name of the profile object type.</p>
|
|
2006
2239
|
*/
|
|
2007
2240
|
ObjectTypeName: string | undefined;
|
|
2008
2241
|
/**
|
|
2242
|
+
* @public
|
|
2009
2243
|
* <p>The unique name of the domain.</p>
|
|
2010
2244
|
*/
|
|
2011
2245
|
DomainName: string | undefined;
|
|
@@ -2015,6 +2249,7 @@ export interface DeleteProfileObjectRequest {
|
|
|
2015
2249
|
*/
|
|
2016
2250
|
export interface DeleteProfileObjectResponse {
|
|
2017
2251
|
/**
|
|
2252
|
+
* @public
|
|
2018
2253
|
* <p>A message that indicates the delete request is done.</p>
|
|
2019
2254
|
*/
|
|
2020
2255
|
Message?: string;
|
|
@@ -2024,10 +2259,12 @@ export interface DeleteProfileObjectResponse {
|
|
|
2024
2259
|
*/
|
|
2025
2260
|
export interface DeleteProfileObjectTypeRequest {
|
|
2026
2261
|
/**
|
|
2262
|
+
* @public
|
|
2027
2263
|
* <p>The unique name of the domain.</p>
|
|
2028
2264
|
*/
|
|
2029
2265
|
DomainName: string | undefined;
|
|
2030
2266
|
/**
|
|
2267
|
+
* @public
|
|
2031
2268
|
* <p>The name of the profile object type.</p>
|
|
2032
2269
|
*/
|
|
2033
2270
|
ObjectTypeName: string | undefined;
|
|
@@ -2037,6 +2274,7 @@ export interface DeleteProfileObjectTypeRequest {
|
|
|
2037
2274
|
*/
|
|
2038
2275
|
export interface DeleteProfileObjectTypeResponse {
|
|
2039
2276
|
/**
|
|
2277
|
+
* @public
|
|
2040
2278
|
* <p>A message that indicates the delete request is done.</p>
|
|
2041
2279
|
*/
|
|
2042
2280
|
Message: string | undefined;
|
|
@@ -2046,10 +2284,12 @@ export interface DeleteProfileObjectTypeResponse {
|
|
|
2046
2284
|
*/
|
|
2047
2285
|
export interface DeleteWorkflowRequest {
|
|
2048
2286
|
/**
|
|
2287
|
+
* @public
|
|
2049
2288
|
* <p>The unique name of the domain.</p>
|
|
2050
2289
|
*/
|
|
2051
2290
|
DomainName: string | undefined;
|
|
2052
2291
|
/**
|
|
2292
|
+
* @public
|
|
2053
2293
|
* <p>Unique identifier for the workflow.</p>
|
|
2054
2294
|
*/
|
|
2055
2295
|
WorkflowId: string | undefined;
|
|
@@ -2064,18 +2304,22 @@ export interface DeleteWorkflowResponse {
|
|
|
2064
2304
|
*/
|
|
2065
2305
|
export interface GetAutoMergingPreviewRequest {
|
|
2066
2306
|
/**
|
|
2307
|
+
* @public
|
|
2067
2308
|
* <p>The unique name of the domain.</p>
|
|
2068
2309
|
*/
|
|
2069
2310
|
DomainName: string | undefined;
|
|
2070
2311
|
/**
|
|
2312
|
+
* @public
|
|
2071
2313
|
* <p>A list of matching attributes that represent matching criteria.</p>
|
|
2072
2314
|
*/
|
|
2073
2315
|
Consolidation: Consolidation | undefined;
|
|
2074
2316
|
/**
|
|
2317
|
+
* @public
|
|
2075
2318
|
* <p>How the auto-merging process should resolve conflicts between different profiles.</p>
|
|
2076
2319
|
*/
|
|
2077
2320
|
ConflictResolution: ConflictResolution | undefined;
|
|
2078
2321
|
/**
|
|
2322
|
+
* @public
|
|
2079
2323
|
* <p>Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.</p>
|
|
2080
2324
|
*/
|
|
2081
2325
|
MinAllowedConfidenceScoreForMerging?: number;
|
|
@@ -2085,19 +2329,23 @@ export interface GetAutoMergingPreviewRequest {
|
|
|
2085
2329
|
*/
|
|
2086
2330
|
export interface GetAutoMergingPreviewResponse {
|
|
2087
2331
|
/**
|
|
2332
|
+
* @public
|
|
2088
2333
|
* <p>The unique name of the domain.</p>
|
|
2089
2334
|
*/
|
|
2090
2335
|
DomainName: string | undefined;
|
|
2091
2336
|
/**
|
|
2337
|
+
* @public
|
|
2092
2338
|
* <p>The number of match groups in the domain that have been reviewed in this preview dry
|
|
2093
2339
|
* run.</p>
|
|
2094
2340
|
*/
|
|
2095
2341
|
NumberOfMatchesInSample?: number;
|
|
2096
2342
|
/**
|
|
2343
|
+
* @public
|
|
2097
2344
|
* <p>The number of profiles found in this preview dry run.</p>
|
|
2098
2345
|
*/
|
|
2099
2346
|
NumberOfProfilesInSample?: number;
|
|
2100
2347
|
/**
|
|
2348
|
+
* @public
|
|
2101
2349
|
* <p>The number of profiles that would be merged if this wasn't a preview dry run.</p>
|
|
2102
2350
|
*/
|
|
2103
2351
|
NumberOfProfilesWillBeMerged?: number;
|
|
@@ -2107,10 +2355,12 @@ export interface GetAutoMergingPreviewResponse {
|
|
|
2107
2355
|
*/
|
|
2108
2356
|
export interface GetCalculatedAttributeDefinitionRequest {
|
|
2109
2357
|
/**
|
|
2358
|
+
* @public
|
|
2110
2359
|
* <p>The unique name of the domain.</p>
|
|
2111
2360
|
*/
|
|
2112
2361
|
DomainName: string | undefined;
|
|
2113
2362
|
/**
|
|
2363
|
+
* @public
|
|
2114
2364
|
* <p>The unique name of the calculated attribute.</p>
|
|
2115
2365
|
*/
|
|
2116
2366
|
CalculatedAttributeName: string | undefined;
|
|
@@ -2120,38 +2370,47 @@ export interface GetCalculatedAttributeDefinitionRequest {
|
|
|
2120
2370
|
*/
|
|
2121
2371
|
export interface GetCalculatedAttributeDefinitionResponse {
|
|
2122
2372
|
/**
|
|
2373
|
+
* @public
|
|
2123
2374
|
* <p>The unique name of the calculated attribute.</p>
|
|
2124
2375
|
*/
|
|
2125
2376
|
CalculatedAttributeName?: string;
|
|
2126
2377
|
/**
|
|
2378
|
+
* @public
|
|
2127
2379
|
* <p>The display name of the calculated attribute.</p>
|
|
2128
2380
|
*/
|
|
2129
2381
|
DisplayName?: string;
|
|
2130
2382
|
/**
|
|
2383
|
+
* @public
|
|
2131
2384
|
* <p>The description of the calculated attribute.</p>
|
|
2132
2385
|
*/
|
|
2133
2386
|
Description?: string;
|
|
2134
2387
|
/**
|
|
2388
|
+
* @public
|
|
2135
2389
|
* <p>The timestamp of when the calculated attribute definition was created.</p>
|
|
2136
2390
|
*/
|
|
2137
2391
|
CreatedAt?: Date;
|
|
2138
2392
|
/**
|
|
2393
|
+
* @public
|
|
2139
2394
|
* <p>The timestamp of when the calculated attribute definition was most recently edited.</p>
|
|
2140
2395
|
*/
|
|
2141
2396
|
LastUpdatedAt?: Date;
|
|
2142
2397
|
/**
|
|
2398
|
+
* @public
|
|
2143
2399
|
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
2144
2400
|
*/
|
|
2145
2401
|
Statistic?: Statistic | string;
|
|
2146
2402
|
/**
|
|
2403
|
+
* @public
|
|
2147
2404
|
* <p>The conditions including range, object count, and threshold for the calculated attribute.</p>
|
|
2148
2405
|
*/
|
|
2149
2406
|
Conditions?: Conditions;
|
|
2150
2407
|
/**
|
|
2408
|
+
* @public
|
|
2151
2409
|
* <p>Mathematical expression and a list of attribute items specified in that expression.</p>
|
|
2152
2410
|
*/
|
|
2153
2411
|
AttributeDetails?: AttributeDetails;
|
|
2154
2412
|
/**
|
|
2413
|
+
* @public
|
|
2155
2414
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2156
2415
|
*/
|
|
2157
2416
|
Tags?: Record<string, string>;
|
|
@@ -2161,14 +2420,17 @@ export interface GetCalculatedAttributeDefinitionResponse {
|
|
|
2161
2420
|
*/
|
|
2162
2421
|
export interface GetCalculatedAttributeForProfileRequest {
|
|
2163
2422
|
/**
|
|
2423
|
+
* @public
|
|
2164
2424
|
* <p>The unique name of the domain.</p>
|
|
2165
2425
|
*/
|
|
2166
2426
|
DomainName: string | undefined;
|
|
2167
2427
|
/**
|
|
2428
|
+
* @public
|
|
2168
2429
|
* <p>The unique identifier of a customer profile.</p>
|
|
2169
2430
|
*/
|
|
2170
2431
|
ProfileId: string | undefined;
|
|
2171
2432
|
/**
|
|
2433
|
+
* @public
|
|
2172
2434
|
* <p>The unique name of the calculated attribute.</p>
|
|
2173
2435
|
*/
|
|
2174
2436
|
CalculatedAttributeName: string | undefined;
|
|
@@ -2178,18 +2440,22 @@ export interface GetCalculatedAttributeForProfileRequest {
|
|
|
2178
2440
|
*/
|
|
2179
2441
|
export interface GetCalculatedAttributeForProfileResponse {
|
|
2180
2442
|
/**
|
|
2443
|
+
* @public
|
|
2181
2444
|
* <p>The unique name of the calculated attribute.</p>
|
|
2182
2445
|
*/
|
|
2183
2446
|
CalculatedAttributeName?: string;
|
|
2184
2447
|
/**
|
|
2448
|
+
* @public
|
|
2185
2449
|
* <p>The display name of the calculated attribute.</p>
|
|
2186
2450
|
*/
|
|
2187
2451
|
DisplayName?: string;
|
|
2188
2452
|
/**
|
|
2453
|
+
* @public
|
|
2189
2454
|
* <p>Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.</p>
|
|
2190
2455
|
*/
|
|
2191
2456
|
IsDataPartial?: string;
|
|
2192
2457
|
/**
|
|
2458
|
+
* @public
|
|
2193
2459
|
* <p>The value of the calculated attribute.</p>
|
|
2194
2460
|
*/
|
|
2195
2461
|
Value?: string;
|
|
@@ -2199,6 +2465,7 @@ export interface GetCalculatedAttributeForProfileResponse {
|
|
|
2199
2465
|
*/
|
|
2200
2466
|
export interface GetDomainRequest {
|
|
2201
2467
|
/**
|
|
2468
|
+
* @public
|
|
2202
2469
|
* <p>The unique name of the domain.</p>
|
|
2203
2470
|
*/
|
|
2204
2471
|
DomainName: string | undefined;
|
|
@@ -2209,20 +2476,24 @@ export interface GetDomainRequest {
|
|
|
2209
2476
|
*/
|
|
2210
2477
|
export interface DomainStats {
|
|
2211
2478
|
/**
|
|
2479
|
+
* @public
|
|
2212
2480
|
* <p>The total number of profiles currently in the domain.</p>
|
|
2213
2481
|
*/
|
|
2214
2482
|
ProfileCount?: number;
|
|
2215
2483
|
/**
|
|
2484
|
+
* @public
|
|
2216
2485
|
* <p>The number of profiles that you are currently paying for in the domain. If you have more
|
|
2217
2486
|
* than 100 objects associated with a single profile, that profile counts as two profiles. If
|
|
2218
2487
|
* you have more than 200 objects, that profile counts as three, and so on.</p>
|
|
2219
2488
|
*/
|
|
2220
2489
|
MeteringProfileCount?: number;
|
|
2221
2490
|
/**
|
|
2491
|
+
* @public
|
|
2222
2492
|
* <p>The total number of objects in domain.</p>
|
|
2223
2493
|
*/
|
|
2224
2494
|
ObjectCount?: number;
|
|
2225
2495
|
/**
|
|
2496
|
+
* @public
|
|
2226
2497
|
* <p>The total size, in bytes, of all objects in the domain.</p>
|
|
2227
2498
|
*/
|
|
2228
2499
|
TotalSize?: number;
|
|
@@ -2232,29 +2503,35 @@ export interface DomainStats {
|
|
|
2232
2503
|
*/
|
|
2233
2504
|
export interface GetDomainResponse {
|
|
2234
2505
|
/**
|
|
2506
|
+
* @public
|
|
2235
2507
|
* <p>The unique name of the domain.</p>
|
|
2236
2508
|
*/
|
|
2237
2509
|
DomainName: string | undefined;
|
|
2238
2510
|
/**
|
|
2511
|
+
* @public
|
|
2239
2512
|
* <p>The default number of days until the data within the domain expires.</p>
|
|
2240
2513
|
*/
|
|
2241
2514
|
DefaultExpirationDays?: number;
|
|
2242
2515
|
/**
|
|
2516
|
+
* @public
|
|
2243
2517
|
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
2244
2518
|
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
2245
2519
|
* permanent or semi-permanent storage.</p>
|
|
2246
2520
|
*/
|
|
2247
2521
|
DefaultEncryptionKey?: string;
|
|
2248
2522
|
/**
|
|
2523
|
+
* @public
|
|
2249
2524
|
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
2250
2525
|
* ingesting data from third party applications.</p>
|
|
2251
2526
|
*/
|
|
2252
2527
|
DeadLetterQueueUrl?: string;
|
|
2253
2528
|
/**
|
|
2529
|
+
* @public
|
|
2254
2530
|
* <p>Usage-specific statistics about the domain.</p>
|
|
2255
2531
|
*/
|
|
2256
2532
|
Stats?: DomainStats;
|
|
2257
2533
|
/**
|
|
2534
|
+
* @public
|
|
2258
2535
|
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
2259
2536
|
* 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
|
|
2260
2537
|
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
@@ -2265,6 +2542,7 @@ export interface GetDomainResponse {
|
|
|
2265
2542
|
*/
|
|
2266
2543
|
Matching?: MatchingResponse;
|
|
2267
2544
|
/**
|
|
2545
|
+
* @public
|
|
2268
2546
|
* <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true,
|
|
2269
2547
|
* Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration
|
|
2270
2548
|
* in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and
|
|
@@ -2273,14 +2551,17 @@ export interface GetDomainResponse {
|
|
|
2273
2551
|
*/
|
|
2274
2552
|
RuleBasedMatching?: RuleBasedMatchingResponse;
|
|
2275
2553
|
/**
|
|
2554
|
+
* @public
|
|
2276
2555
|
* <p>The timestamp of when the domain was created.</p>
|
|
2277
2556
|
*/
|
|
2278
2557
|
CreatedAt: Date | undefined;
|
|
2279
2558
|
/**
|
|
2559
|
+
* @public
|
|
2280
2560
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
2281
2561
|
*/
|
|
2282
2562
|
LastUpdatedAt: Date | undefined;
|
|
2283
2563
|
/**
|
|
2564
|
+
* @public
|
|
2284
2565
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2285
2566
|
*/
|
|
2286
2567
|
Tags?: Record<string, string>;
|
|
@@ -2290,10 +2571,12 @@ export interface GetDomainResponse {
|
|
|
2290
2571
|
*/
|
|
2291
2572
|
export interface GetEventStreamRequest {
|
|
2292
2573
|
/**
|
|
2574
|
+
* @public
|
|
2293
2575
|
* <p>The unique name of the domain.</p>
|
|
2294
2576
|
*/
|
|
2295
2577
|
DomainName: string | undefined;
|
|
2296
2578
|
/**
|
|
2579
|
+
* @public
|
|
2297
2580
|
* <p>The name of the event stream provided during create operations.</p>
|
|
2298
2581
|
*/
|
|
2299
2582
|
EventStreamName: string | undefined;
|
|
@@ -2316,19 +2599,23 @@ export type EventStreamDestinationStatus = (typeof EventStreamDestinationStatus)
|
|
|
2316
2599
|
*/
|
|
2317
2600
|
export interface EventStreamDestinationDetails {
|
|
2318
2601
|
/**
|
|
2602
|
+
* @public
|
|
2319
2603
|
* <p>The StreamARN of the destination to deliver profile events to. For example,
|
|
2320
2604
|
* arn:aws:kinesis:region:account-id:stream/stream-name.</p>
|
|
2321
2605
|
*/
|
|
2322
2606
|
Uri: string | undefined;
|
|
2323
2607
|
/**
|
|
2608
|
+
* @public
|
|
2324
2609
|
* <p>The status of enabling the Kinesis stream as a destination for export.</p>
|
|
2325
2610
|
*/
|
|
2326
2611
|
Status: EventStreamDestinationStatus | string | undefined;
|
|
2327
2612
|
/**
|
|
2613
|
+
* @public
|
|
2328
2614
|
* <p>The timestamp when the status last changed to <code>UNHEALHY</code>.</p>
|
|
2329
2615
|
*/
|
|
2330
2616
|
UnhealthySince?: Date;
|
|
2331
2617
|
/**
|
|
2618
|
+
* @public
|
|
2332
2619
|
* <p>The human-readable string that corresponds to the error or success while enabling the streaming destination.</p>
|
|
2333
2620
|
*/
|
|
2334
2621
|
Message?: string;
|
|
@@ -2350,30 +2637,37 @@ export type EventStreamState = (typeof EventStreamState)[keyof typeof EventStrea
|
|
|
2350
2637
|
*/
|
|
2351
2638
|
export interface GetEventStreamResponse {
|
|
2352
2639
|
/**
|
|
2640
|
+
* @public
|
|
2353
2641
|
* <p>The unique name of the domain.</p>
|
|
2354
2642
|
*/
|
|
2355
2643
|
DomainName: string | undefined;
|
|
2356
2644
|
/**
|
|
2645
|
+
* @public
|
|
2357
2646
|
* <p>A unique identifier for the event stream.</p>
|
|
2358
2647
|
*/
|
|
2359
2648
|
EventStreamArn: string | undefined;
|
|
2360
2649
|
/**
|
|
2650
|
+
* @public
|
|
2361
2651
|
* <p>The timestamp of when the export was created.</p>
|
|
2362
2652
|
*/
|
|
2363
2653
|
CreatedAt: Date | undefined;
|
|
2364
2654
|
/**
|
|
2655
|
+
* @public
|
|
2365
2656
|
* <p>The operational state of destination stream for export.</p>
|
|
2366
2657
|
*/
|
|
2367
2658
|
State: EventStreamState | string | undefined;
|
|
2368
2659
|
/**
|
|
2660
|
+
* @public
|
|
2369
2661
|
* <p>The timestamp when the <code>State</code> changed to <code>STOPPED</code>.</p>
|
|
2370
2662
|
*/
|
|
2371
2663
|
StoppedSince?: Date;
|
|
2372
2664
|
/**
|
|
2665
|
+
* @public
|
|
2373
2666
|
* <p>Details regarding the Kinesis stream.</p>
|
|
2374
2667
|
*/
|
|
2375
2668
|
DestinationDetails: EventStreamDestinationDetails | undefined;
|
|
2376
2669
|
/**
|
|
2670
|
+
* @public
|
|
2377
2671
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2378
2672
|
*/
|
|
2379
2673
|
Tags?: Record<string, string>;
|
|
@@ -2383,10 +2677,12 @@ export interface GetEventStreamResponse {
|
|
|
2383
2677
|
*/
|
|
2384
2678
|
export interface GetIdentityResolutionJobRequest {
|
|
2385
2679
|
/**
|
|
2680
|
+
* @public
|
|
2386
2681
|
* <p>The unique name of the domain.</p>
|
|
2387
2682
|
*/
|
|
2388
2683
|
DomainName: string | undefined;
|
|
2389
2684
|
/**
|
|
2685
|
+
* @public
|
|
2390
2686
|
* <p>The unique identifier of the Identity Resolution Job.</p>
|
|
2391
2687
|
*/
|
|
2392
2688
|
JobId: string | undefined;
|
|
@@ -2397,10 +2693,12 @@ export interface GetIdentityResolutionJobRequest {
|
|
|
2397
2693
|
*/
|
|
2398
2694
|
export interface S3ExportingLocation {
|
|
2399
2695
|
/**
|
|
2696
|
+
* @public
|
|
2400
2697
|
* <p>The name of the S3 bucket name where Identity Resolution Jobs write result files.</p>
|
|
2401
2698
|
*/
|
|
2402
2699
|
S3BucketName?: string;
|
|
2403
2700
|
/**
|
|
2701
|
+
* @public
|
|
2404
2702
|
* <p>The S3 key name of the location where Identity Resolution Jobs write result files.</p>
|
|
2405
2703
|
*/
|
|
2406
2704
|
S3KeyName?: string;
|
|
@@ -2411,6 +2709,7 @@ export interface S3ExportingLocation {
|
|
|
2411
2709
|
*/
|
|
2412
2710
|
export interface ExportingLocation {
|
|
2413
2711
|
/**
|
|
2712
|
+
* @public
|
|
2414
2713
|
* <p>Information about the S3 location where Identity Resolution Jobs write result files.</p>
|
|
2415
2714
|
*/
|
|
2416
2715
|
S3Exporting?: S3ExportingLocation;
|
|
@@ -2421,14 +2720,17 @@ export interface ExportingLocation {
|
|
|
2421
2720
|
*/
|
|
2422
2721
|
export interface JobStats {
|
|
2423
2722
|
/**
|
|
2723
|
+
* @public
|
|
2424
2724
|
* <p>The number of profiles reviewed.</p>
|
|
2425
2725
|
*/
|
|
2426
2726
|
NumberOfProfilesReviewed?: number;
|
|
2427
2727
|
/**
|
|
2728
|
+
* @public
|
|
2428
2729
|
* <p>The number of matches found.</p>
|
|
2429
2730
|
*/
|
|
2430
2731
|
NumberOfMatchesFound?: number;
|
|
2431
2732
|
/**
|
|
2733
|
+
* @public
|
|
2432
2734
|
* <p>The number of merges completed.</p>
|
|
2433
2735
|
*/
|
|
2434
2736
|
NumberOfMergesDone?: number;
|
|
@@ -2455,14 +2757,17 @@ export type IdentityResolutionJobStatus = (typeof IdentityResolutionJobStatus)[k
|
|
|
2455
2757
|
*/
|
|
2456
2758
|
export interface GetIdentityResolutionJobResponse {
|
|
2457
2759
|
/**
|
|
2760
|
+
* @public
|
|
2458
2761
|
* <p>The unique name of the domain.</p>
|
|
2459
2762
|
*/
|
|
2460
2763
|
DomainName?: string;
|
|
2461
2764
|
/**
|
|
2765
|
+
* @public
|
|
2462
2766
|
* <p>The unique identifier of the Identity Resolution Job.</p>
|
|
2463
2767
|
*/
|
|
2464
2768
|
JobId?: string;
|
|
2465
2769
|
/**
|
|
2770
|
+
* @public
|
|
2466
2771
|
* <p>The status of the Identity Resolution Job.</p>
|
|
2467
2772
|
* <ul>
|
|
2468
2773
|
* <li>
|
|
@@ -2502,34 +2807,42 @@ export interface GetIdentityResolutionJobResponse {
|
|
|
2502
2807
|
*/
|
|
2503
2808
|
Status?: IdentityResolutionJobStatus | string;
|
|
2504
2809
|
/**
|
|
2810
|
+
* @public
|
|
2505
2811
|
* <p>The error messages that are generated when the Identity Resolution Job runs.</p>
|
|
2506
2812
|
*/
|
|
2507
2813
|
Message?: string;
|
|
2508
2814
|
/**
|
|
2815
|
+
* @public
|
|
2509
2816
|
* <p>The timestamp of when the Identity Resolution Job was started or will be started.</p>
|
|
2510
2817
|
*/
|
|
2511
2818
|
JobStartTime?: Date;
|
|
2512
2819
|
/**
|
|
2820
|
+
* @public
|
|
2513
2821
|
* <p>The timestamp of when the Identity Resolution Job was completed.</p>
|
|
2514
2822
|
*/
|
|
2515
2823
|
JobEndTime?: Date;
|
|
2516
2824
|
/**
|
|
2825
|
+
* @public
|
|
2517
2826
|
* <p>The timestamp of when the Identity Resolution Job was most recently edited.</p>
|
|
2518
2827
|
*/
|
|
2519
2828
|
LastUpdatedAt?: Date;
|
|
2520
2829
|
/**
|
|
2830
|
+
* @public
|
|
2521
2831
|
* <p>The timestamp of when the Identity Resolution Job will expire.</p>
|
|
2522
2832
|
*/
|
|
2523
2833
|
JobExpirationTime?: Date;
|
|
2524
2834
|
/**
|
|
2835
|
+
* @public
|
|
2525
2836
|
* <p>Configuration settings for how to perform the auto-merging of profiles.</p>
|
|
2526
2837
|
*/
|
|
2527
2838
|
AutoMerging?: AutoMerging;
|
|
2528
2839
|
/**
|
|
2840
|
+
* @public
|
|
2529
2841
|
* <p>The S3 location where the Identity Resolution Job writes result files.</p>
|
|
2530
2842
|
*/
|
|
2531
2843
|
ExportingLocation?: ExportingLocation;
|
|
2532
2844
|
/**
|
|
2845
|
+
* @public
|
|
2533
2846
|
* <p>Statistics about the Identity Resolution Job.</p>
|
|
2534
2847
|
*/
|
|
2535
2848
|
JobStats?: JobStats;
|
|
@@ -2539,10 +2852,12 @@ export interface GetIdentityResolutionJobResponse {
|
|
|
2539
2852
|
*/
|
|
2540
2853
|
export interface GetIntegrationRequest {
|
|
2541
2854
|
/**
|
|
2855
|
+
* @public
|
|
2542
2856
|
* <p>The unique name of the domain.</p>
|
|
2543
2857
|
*/
|
|
2544
2858
|
DomainName: string | undefined;
|
|
2545
2859
|
/**
|
|
2860
|
+
* @public
|
|
2546
2861
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
2547
2862
|
*/
|
|
2548
2863
|
Uri: string | undefined;
|
|
@@ -2552,40 +2867,49 @@ export interface GetIntegrationRequest {
|
|
|
2552
2867
|
*/
|
|
2553
2868
|
export interface GetIntegrationResponse {
|
|
2554
2869
|
/**
|
|
2870
|
+
* @public
|
|
2555
2871
|
* <p>The unique name of the domain.</p>
|
|
2556
2872
|
*/
|
|
2557
2873
|
DomainName: string | undefined;
|
|
2558
2874
|
/**
|
|
2875
|
+
* @public
|
|
2559
2876
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
2560
2877
|
*/
|
|
2561
2878
|
Uri: string | undefined;
|
|
2562
2879
|
/**
|
|
2880
|
+
* @public
|
|
2563
2881
|
* <p>The name of the profile object type.</p>
|
|
2564
2882
|
*/
|
|
2565
2883
|
ObjectTypeName?: string;
|
|
2566
2884
|
/**
|
|
2885
|
+
* @public
|
|
2567
2886
|
* <p>The timestamp of when the domain was created.</p>
|
|
2568
2887
|
*/
|
|
2569
2888
|
CreatedAt: Date | undefined;
|
|
2570
2889
|
/**
|
|
2890
|
+
* @public
|
|
2571
2891
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
2572
2892
|
*/
|
|
2573
2893
|
LastUpdatedAt: Date | undefined;
|
|
2574
2894
|
/**
|
|
2895
|
+
* @public
|
|
2575
2896
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2576
2897
|
*/
|
|
2577
2898
|
Tags?: Record<string, string>;
|
|
2578
2899
|
/**
|
|
2900
|
+
* @public
|
|
2579
2901
|
* <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.
|
|
2580
2902
|
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
2581
2903
|
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
2582
2904
|
*/
|
|
2583
2905
|
ObjectTypeNames?: Record<string, string>;
|
|
2584
2906
|
/**
|
|
2907
|
+
* @public
|
|
2585
2908
|
* <p>Unique identifier for the workflow.</p>
|
|
2586
2909
|
*/
|
|
2587
2910
|
WorkflowId?: string;
|
|
2588
2911
|
/**
|
|
2912
|
+
* @public
|
|
2589
2913
|
* <p>Boolean that shows if the Flow that's associated with the Integration is created in Amazon
|
|
2590
2914
|
* Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.</p>
|
|
2591
2915
|
*/
|
|
@@ -2596,15 +2920,18 @@ export interface GetIntegrationResponse {
|
|
|
2596
2920
|
*/
|
|
2597
2921
|
export interface GetMatchesRequest {
|
|
2598
2922
|
/**
|
|
2923
|
+
* @public
|
|
2599
2924
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2600
2925
|
* response in the next request to retrieve the next set of results.</p>
|
|
2601
2926
|
*/
|
|
2602
2927
|
NextToken?: string;
|
|
2603
2928
|
/**
|
|
2929
|
+
* @public
|
|
2604
2930
|
* <p>The maximum number of results to return per page.</p>
|
|
2605
2931
|
*/
|
|
2606
2932
|
MaxResults?: number;
|
|
2607
2933
|
/**
|
|
2934
|
+
* @public
|
|
2608
2935
|
* <p>The unique name of the domain.</p>
|
|
2609
2936
|
*/
|
|
2610
2937
|
DomainName: string | undefined;
|
|
@@ -2615,14 +2942,17 @@ export interface GetMatchesRequest {
|
|
|
2615
2942
|
*/
|
|
2616
2943
|
export interface MatchItem {
|
|
2617
2944
|
/**
|
|
2945
|
+
* @public
|
|
2618
2946
|
* <p>The unique identifiers for this group of profiles that match.</p>
|
|
2619
2947
|
*/
|
|
2620
2948
|
MatchId?: string;
|
|
2621
2949
|
/**
|
|
2950
|
+
* @public
|
|
2622
2951
|
* <p>A list of identifiers for profiles that match.</p>
|
|
2623
2952
|
*/
|
|
2624
2953
|
ProfileIds?: string[];
|
|
2625
2954
|
/**
|
|
2955
|
+
* @public
|
|
2626
2956
|
* <p>A number between 0 and 1, where a higher score means higher similarity.
|
|
2627
2957
|
* Examining match confidence scores lets you distinguish between groups of similar records in which
|
|
2628
2958
|
* the system is highly confident (which you may decide to merge), groups of similar records about
|
|
@@ -2638,18 +2968,22 @@ export interface MatchItem {
|
|
|
2638
2968
|
*/
|
|
2639
2969
|
export interface GetMatchesResponse {
|
|
2640
2970
|
/**
|
|
2971
|
+
* @public
|
|
2641
2972
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2642
2973
|
*/
|
|
2643
2974
|
NextToken?: string;
|
|
2644
2975
|
/**
|
|
2976
|
+
* @public
|
|
2645
2977
|
* <p>The timestamp this version of Match Result generated.</p>
|
|
2646
2978
|
*/
|
|
2647
2979
|
MatchGenerationDate?: Date;
|
|
2648
2980
|
/**
|
|
2981
|
+
* @public
|
|
2649
2982
|
* <p>The number of potential matches found.</p>
|
|
2650
2983
|
*/
|
|
2651
2984
|
PotentialMatches?: number;
|
|
2652
2985
|
/**
|
|
2986
|
+
* @public
|
|
2653
2987
|
* <p>The list of matched profiles for this instance.</p>
|
|
2654
2988
|
*/
|
|
2655
2989
|
Matches?: MatchItem[];
|
|
@@ -2659,10 +2993,12 @@ export interface GetMatchesResponse {
|
|
|
2659
2993
|
*/
|
|
2660
2994
|
export interface GetProfileObjectTypeRequest {
|
|
2661
2995
|
/**
|
|
2996
|
+
* @public
|
|
2662
2997
|
* <p>The unique name of the domain.</p>
|
|
2663
2998
|
*/
|
|
2664
2999
|
DomainName: string | undefined;
|
|
2665
3000
|
/**
|
|
3001
|
+
* @public
|
|
2666
3002
|
* <p>The name of the profile object type.</p>
|
|
2667
3003
|
*/
|
|
2668
3004
|
ObjectTypeName: string | undefined;
|
|
@@ -2688,16 +3024,19 @@ export type FieldContentType = (typeof FieldContentType)[keyof typeof FieldConte
|
|
|
2688
3024
|
*/
|
|
2689
3025
|
export interface ObjectTypeField {
|
|
2690
3026
|
/**
|
|
3027
|
+
* @public
|
|
2691
3028
|
* <p>A field of a ProfileObject. For example: _source.FirstName, where “_source” is a
|
|
2692
3029
|
* ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.</p>
|
|
2693
3030
|
*/
|
|
2694
3031
|
Source?: string;
|
|
2695
3032
|
/**
|
|
3033
|
+
* @public
|
|
2696
3034
|
* <p>The location of the data in the standard ProfileObject model. For example:
|
|
2697
3035
|
* _profile.Address.PostalCode.</p>
|
|
2698
3036
|
*/
|
|
2699
3037
|
Target?: string;
|
|
2700
3038
|
/**
|
|
3039
|
+
* @public
|
|
2701
3040
|
* <p>The content type of the field. Used for determining equality when searching.</p>
|
|
2702
3041
|
*/
|
|
2703
3042
|
ContentType?: FieldContentType | string;
|
|
@@ -2727,6 +3066,7 @@ export type StandardIdentifier = (typeof StandardIdentifier)[keyof typeof Standa
|
|
|
2727
3066
|
*/
|
|
2728
3067
|
export interface ObjectTypeKey {
|
|
2729
3068
|
/**
|
|
3069
|
+
* @public
|
|
2730
3070
|
* <p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1
|
|
2731
3071
|
* UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be
|
|
2732
3072
|
* used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be
|
|
@@ -2738,6 +3078,7 @@ export interface ObjectTypeKey {
|
|
|
2738
3078
|
*/
|
|
2739
3079
|
StandardIdentifiers?: (StandardIdentifier | string)[];
|
|
2740
3080
|
/**
|
|
3081
|
+
* @public
|
|
2741
3082
|
* <p>The reference for the key name of the fields map.</p>
|
|
2742
3083
|
*/
|
|
2743
3084
|
FieldNames?: string[];
|
|
@@ -2747,27 +3088,33 @@ export interface ObjectTypeKey {
|
|
|
2747
3088
|
*/
|
|
2748
3089
|
export interface GetProfileObjectTypeResponse {
|
|
2749
3090
|
/**
|
|
3091
|
+
* @public
|
|
2750
3092
|
* <p>The name of the profile object type.</p>
|
|
2751
3093
|
*/
|
|
2752
3094
|
ObjectTypeName: string | undefined;
|
|
2753
3095
|
/**
|
|
3096
|
+
* @public
|
|
2754
3097
|
* <p>The description of the profile object type.</p>
|
|
2755
3098
|
*/
|
|
2756
3099
|
Description: string | undefined;
|
|
2757
3100
|
/**
|
|
3101
|
+
* @public
|
|
2758
3102
|
* <p>A unique identifier for the object template.</p>
|
|
2759
3103
|
*/
|
|
2760
3104
|
TemplateId?: string;
|
|
2761
3105
|
/**
|
|
3106
|
+
* @public
|
|
2762
3107
|
* <p>The number of days until the data in the object expires.</p>
|
|
2763
3108
|
*/
|
|
2764
3109
|
ExpirationDays?: number;
|
|
2765
3110
|
/**
|
|
3111
|
+
* @public
|
|
2766
3112
|
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
2767
3113
|
* profile object type.</p>
|
|
2768
3114
|
*/
|
|
2769
3115
|
EncryptionKey?: string;
|
|
2770
3116
|
/**
|
|
3117
|
+
* @public
|
|
2771
3118
|
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
2772
3119
|
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
2773
3120
|
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
@@ -2776,27 +3123,33 @@ export interface GetProfileObjectTypeResponse {
|
|
|
2776
3123
|
*/
|
|
2777
3124
|
AllowProfileCreation?: boolean;
|
|
2778
3125
|
/**
|
|
3126
|
+
* @public
|
|
2779
3127
|
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set
|
|
2780
3128
|
* up.</p>
|
|
2781
3129
|
*/
|
|
2782
3130
|
SourceLastUpdatedTimestampFormat?: string;
|
|
2783
3131
|
/**
|
|
3132
|
+
* @public
|
|
2784
3133
|
* <p>A map of the name and ObjectType field.</p>
|
|
2785
3134
|
*/
|
|
2786
3135
|
Fields?: Record<string, ObjectTypeField>;
|
|
2787
3136
|
/**
|
|
3137
|
+
* @public
|
|
2788
3138
|
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
2789
3139
|
*/
|
|
2790
3140
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
2791
3141
|
/**
|
|
3142
|
+
* @public
|
|
2792
3143
|
* <p>The timestamp of when the domain was created.</p>
|
|
2793
3144
|
*/
|
|
2794
3145
|
CreatedAt?: Date;
|
|
2795
3146
|
/**
|
|
3147
|
+
* @public
|
|
2796
3148
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
2797
3149
|
*/
|
|
2798
3150
|
LastUpdatedAt?: Date;
|
|
2799
3151
|
/**
|
|
3152
|
+
* @public
|
|
2800
3153
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2801
3154
|
*/
|
|
2802
3155
|
Tags?: Record<string, string>;
|
|
@@ -2806,6 +3159,7 @@ export interface GetProfileObjectTypeResponse {
|
|
|
2806
3159
|
*/
|
|
2807
3160
|
export interface GetProfileObjectTypeTemplateRequest {
|
|
2808
3161
|
/**
|
|
3162
|
+
* @public
|
|
2809
3163
|
* <p>A unique identifier for the object template.</p>
|
|
2810
3164
|
*/
|
|
2811
3165
|
TemplateId: string | undefined;
|
|
@@ -2815,18 +3169,22 @@ export interface GetProfileObjectTypeTemplateRequest {
|
|
|
2815
3169
|
*/
|
|
2816
3170
|
export interface GetProfileObjectTypeTemplateResponse {
|
|
2817
3171
|
/**
|
|
3172
|
+
* @public
|
|
2818
3173
|
* <p>A unique identifier for the object template.</p>
|
|
2819
3174
|
*/
|
|
2820
3175
|
TemplateId?: string;
|
|
2821
3176
|
/**
|
|
3177
|
+
* @public
|
|
2822
3178
|
* <p>The name of the source of the object template.</p>
|
|
2823
3179
|
*/
|
|
2824
3180
|
SourceName?: string;
|
|
2825
3181
|
/**
|
|
3182
|
+
* @public
|
|
2826
3183
|
* <p>The source of the object template.</p>
|
|
2827
3184
|
*/
|
|
2828
3185
|
SourceObject?: string;
|
|
2829
3186
|
/**
|
|
3187
|
+
* @public
|
|
2830
3188
|
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
2831
3189
|
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
2832
3190
|
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
@@ -2835,15 +3193,18 @@ export interface GetProfileObjectTypeTemplateResponse {
|
|
|
2835
3193
|
*/
|
|
2836
3194
|
AllowProfileCreation?: boolean;
|
|
2837
3195
|
/**
|
|
3196
|
+
* @public
|
|
2838
3197
|
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set
|
|
2839
3198
|
* up.</p>
|
|
2840
3199
|
*/
|
|
2841
3200
|
SourceLastUpdatedTimestampFormat?: string;
|
|
2842
3201
|
/**
|
|
3202
|
+
* @public
|
|
2843
3203
|
* <p>A map of the name and ObjectType field.</p>
|
|
2844
3204
|
*/
|
|
2845
3205
|
Fields?: Record<string, ObjectTypeField>;
|
|
2846
3206
|
/**
|
|
3207
|
+
* @public
|
|
2847
3208
|
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
2848
3209
|
*/
|
|
2849
3210
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
@@ -2865,26 +3226,32 @@ export type MatchType = (typeof MatchType)[keyof typeof MatchType];
|
|
|
2865
3226
|
*/
|
|
2866
3227
|
export interface GetSimilarProfilesRequest {
|
|
2867
3228
|
/**
|
|
3229
|
+
* @public
|
|
2868
3230
|
* <p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p>
|
|
2869
3231
|
*/
|
|
2870
3232
|
NextToken?: string;
|
|
2871
3233
|
/**
|
|
3234
|
+
* @public
|
|
2872
3235
|
* <p>The maximum number of objects returned per page.</p>
|
|
2873
3236
|
*/
|
|
2874
3237
|
MaxResults?: number;
|
|
2875
3238
|
/**
|
|
3239
|
+
* @public
|
|
2876
3240
|
* <p>The unique name of the domain.</p>
|
|
2877
3241
|
*/
|
|
2878
3242
|
DomainName: string | undefined;
|
|
2879
3243
|
/**
|
|
3244
|
+
* @public
|
|
2880
3245
|
* <p>Specify the type of matching to get similar profiles for.</p>
|
|
2881
3246
|
*/
|
|
2882
3247
|
MatchType: MatchType | string | undefined;
|
|
2883
3248
|
/**
|
|
3249
|
+
* @public
|
|
2884
3250
|
* <p>The string indicating the search key to be used.</p>
|
|
2885
3251
|
*/
|
|
2886
3252
|
SearchKey: string | undefined;
|
|
2887
3253
|
/**
|
|
3254
|
+
* @public
|
|
2888
3255
|
* <p>The string based on <code>SearchKey</code> to be searched for similar profiles.</p>
|
|
2889
3256
|
*/
|
|
2890
3257
|
SearchValue: string | undefined;
|
|
@@ -2894,22 +3261,27 @@ export interface GetSimilarProfilesRequest {
|
|
|
2894
3261
|
*/
|
|
2895
3262
|
export interface GetSimilarProfilesResponse {
|
|
2896
3263
|
/**
|
|
3264
|
+
* @public
|
|
2897
3265
|
* <p>Set of <code>profileId</code>s that belong to the same matching group.</p>
|
|
2898
3266
|
*/
|
|
2899
3267
|
ProfileIds?: string[];
|
|
2900
3268
|
/**
|
|
3269
|
+
* @public
|
|
2901
3270
|
* <p>The string <code>matchId</code> that the similar profiles belong to.</p>
|
|
2902
3271
|
*/
|
|
2903
3272
|
MatchId?: string;
|
|
2904
3273
|
/**
|
|
3274
|
+
* @public
|
|
2905
3275
|
* <p>Specify the type of matching to get similar profiles for.</p>
|
|
2906
3276
|
*/
|
|
2907
3277
|
MatchType?: MatchType | string;
|
|
2908
3278
|
/**
|
|
3279
|
+
* @public
|
|
2909
3280
|
* <p>The integer rule level that the profiles matched on.</p>
|
|
2910
3281
|
*/
|
|
2911
3282
|
RuleLevel?: number;
|
|
2912
3283
|
/**
|
|
3284
|
+
* @public
|
|
2913
3285
|
* <p>It only has value when the <code>MatchType</code> is <code>ML_BASED_MATCHING</code>.A
|
|
2914
3286
|
* number between 0 and 1, where a higher score means higher similarity. Examining match
|
|
2915
3287
|
* confidence scores lets you distinguish between groups of similar records in which the
|
|
@@ -2921,6 +3293,7 @@ export interface GetSimilarProfilesResponse {
|
|
|
2921
3293
|
*/
|
|
2922
3294
|
ConfidenceScore?: number;
|
|
2923
3295
|
/**
|
|
3296
|
+
* @public
|
|
2924
3297
|
* <p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p>
|
|
2925
3298
|
*/
|
|
2926
3299
|
NextToken?: string;
|
|
@@ -2930,10 +3303,12 @@ export interface GetSimilarProfilesResponse {
|
|
|
2930
3303
|
*/
|
|
2931
3304
|
export interface GetWorkflowRequest {
|
|
2932
3305
|
/**
|
|
3306
|
+
* @public
|
|
2933
3307
|
* <p>The unique name of the domain.</p>
|
|
2934
3308
|
*/
|
|
2935
3309
|
DomainName: string | undefined;
|
|
2936
3310
|
/**
|
|
3311
|
+
* @public
|
|
2937
3312
|
* <p>Unique identifier for the workflow.</p>
|
|
2938
3313
|
*/
|
|
2939
3314
|
WorkflowId: string | undefined;
|
|
@@ -2944,6 +3319,7 @@ export interface GetWorkflowRequest {
|
|
|
2944
3319
|
*/
|
|
2945
3320
|
export interface WorkflowAttributes {
|
|
2946
3321
|
/**
|
|
3322
|
+
* @public
|
|
2947
3323
|
* <p>Workflow attributes specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
2948
3324
|
*/
|
|
2949
3325
|
AppflowIntegration?: AppflowIntegrationWorkflowAttributes;
|
|
@@ -2954,6 +3330,7 @@ export interface WorkflowAttributes {
|
|
|
2954
3330
|
*/
|
|
2955
3331
|
export interface WorkflowMetrics {
|
|
2956
3332
|
/**
|
|
3333
|
+
* @public
|
|
2957
3334
|
* <p>Workflow execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
2958
3335
|
*/
|
|
2959
3336
|
AppflowIntegration?: AppflowIntegrationWorkflowMetrics;
|
|
@@ -2963,34 +3340,42 @@ export interface WorkflowMetrics {
|
|
|
2963
3340
|
*/
|
|
2964
3341
|
export interface GetWorkflowResponse {
|
|
2965
3342
|
/**
|
|
3343
|
+
* @public
|
|
2966
3344
|
* <p>Unique identifier for the workflow.</p>
|
|
2967
3345
|
*/
|
|
2968
3346
|
WorkflowId?: string;
|
|
2969
3347
|
/**
|
|
3348
|
+
* @public
|
|
2970
3349
|
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
2971
3350
|
*/
|
|
2972
3351
|
WorkflowType?: WorkflowType | string;
|
|
2973
3352
|
/**
|
|
3353
|
+
* @public
|
|
2974
3354
|
* <p>Status of workflow execution.</p>
|
|
2975
3355
|
*/
|
|
2976
3356
|
Status?: Status | string;
|
|
2977
3357
|
/**
|
|
3358
|
+
* @public
|
|
2978
3359
|
* <p>Workflow error messages during execution (if any).</p>
|
|
2979
3360
|
*/
|
|
2980
3361
|
ErrorDescription?: string;
|
|
2981
3362
|
/**
|
|
3363
|
+
* @public
|
|
2982
3364
|
* <p>The timestamp that represents when workflow execution started.</p>
|
|
2983
3365
|
*/
|
|
2984
3366
|
StartDate?: Date;
|
|
2985
3367
|
/**
|
|
3368
|
+
* @public
|
|
2986
3369
|
* <p>The timestamp that represents when workflow execution last updated.</p>
|
|
2987
3370
|
*/
|
|
2988
3371
|
LastUpdatedAt?: Date;
|
|
2989
3372
|
/**
|
|
3373
|
+
* @public
|
|
2990
3374
|
* <p>Attributes provided for workflow execution.</p>
|
|
2991
3375
|
*/
|
|
2992
3376
|
Attributes?: WorkflowAttributes;
|
|
2993
3377
|
/**
|
|
3378
|
+
* @public
|
|
2994
3379
|
* <p>Workflow specific execution metrics.</p>
|
|
2995
3380
|
*/
|
|
2996
3381
|
Metrics?: WorkflowMetrics;
|
|
@@ -3000,19 +3385,23 @@ export interface GetWorkflowResponse {
|
|
|
3000
3385
|
*/
|
|
3001
3386
|
export interface GetWorkflowStepsRequest {
|
|
3002
3387
|
/**
|
|
3388
|
+
* @public
|
|
3003
3389
|
* <p>The unique name of the domain.</p>
|
|
3004
3390
|
*/
|
|
3005
3391
|
DomainName: string | undefined;
|
|
3006
3392
|
/**
|
|
3393
|
+
* @public
|
|
3007
3394
|
* <p>Unique identifier for the workflow.</p>
|
|
3008
3395
|
*/
|
|
3009
3396
|
WorkflowId: string | undefined;
|
|
3010
3397
|
/**
|
|
3398
|
+
* @public
|
|
3011
3399
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3012
3400
|
* response in the next request to retrieve the next set of results.</p>
|
|
3013
3401
|
*/
|
|
3014
3402
|
NextToken?: string;
|
|
3015
3403
|
/**
|
|
3404
|
+
* @public
|
|
3016
3405
|
* <p>The maximum number of results to return per page.</p>
|
|
3017
3406
|
*/
|
|
3018
3407
|
MaxResults?: number;
|
|
@@ -3023,6 +3412,7 @@ export interface GetWorkflowStepsRequest {
|
|
|
3023
3412
|
*/
|
|
3024
3413
|
export interface WorkflowStepItem {
|
|
3025
3414
|
/**
|
|
3415
|
+
* @public
|
|
3026
3416
|
* <p>Workflow step information specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
3027
3417
|
*/
|
|
3028
3418
|
AppflowIntegration?: AppflowIntegrationWorkflowStep;
|
|
@@ -3032,18 +3422,22 @@ export interface WorkflowStepItem {
|
|
|
3032
3422
|
*/
|
|
3033
3423
|
export interface GetWorkflowStepsResponse {
|
|
3034
3424
|
/**
|
|
3425
|
+
* @public
|
|
3035
3426
|
* <p>Unique identifier for the workflow.</p>
|
|
3036
3427
|
*/
|
|
3037
3428
|
WorkflowId?: string;
|
|
3038
3429
|
/**
|
|
3430
|
+
* @public
|
|
3039
3431
|
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
3040
3432
|
*/
|
|
3041
3433
|
WorkflowType?: WorkflowType | string;
|
|
3042
3434
|
/**
|
|
3435
|
+
* @public
|
|
3043
3436
|
* <p>List containing workflow step details.</p>
|
|
3044
3437
|
*/
|
|
3045
3438
|
Items?: WorkflowStepItem[];
|
|
3046
3439
|
/**
|
|
3440
|
+
* @public
|
|
3047
3441
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3048
3442
|
*/
|
|
3049
3443
|
NextToken?: string;
|
|
@@ -3053,18 +3447,22 @@ export interface GetWorkflowStepsResponse {
|
|
|
3053
3447
|
*/
|
|
3054
3448
|
export interface ListAccountIntegrationsRequest {
|
|
3055
3449
|
/**
|
|
3450
|
+
* @public
|
|
3056
3451
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
3057
3452
|
*/
|
|
3058
3453
|
Uri: string | undefined;
|
|
3059
3454
|
/**
|
|
3455
|
+
* @public
|
|
3060
3456
|
* <p>The pagination token from the previous ListAccountIntegrations API call.</p>
|
|
3061
3457
|
*/
|
|
3062
3458
|
NextToken?: string;
|
|
3063
3459
|
/**
|
|
3460
|
+
* @public
|
|
3064
3461
|
* <p>The maximum number of objects returned per page.</p>
|
|
3065
3462
|
*/
|
|
3066
3463
|
MaxResults?: number;
|
|
3067
3464
|
/**
|
|
3465
|
+
* @public
|
|
3068
3466
|
* <p>Boolean to indicate if hidden integration should be returned. Defaults to <code>False</code>.</p>
|
|
3069
3467
|
*/
|
|
3070
3468
|
IncludeHidden?: boolean;
|
|
@@ -3075,40 +3473,49 @@ export interface ListAccountIntegrationsRequest {
|
|
|
3075
3473
|
*/
|
|
3076
3474
|
export interface ListIntegrationItem {
|
|
3077
3475
|
/**
|
|
3476
|
+
* @public
|
|
3078
3477
|
* <p>The unique name of the domain.</p>
|
|
3079
3478
|
*/
|
|
3080
3479
|
DomainName: string | undefined;
|
|
3081
3480
|
/**
|
|
3481
|
+
* @public
|
|
3082
3482
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
3083
3483
|
*/
|
|
3084
3484
|
Uri: string | undefined;
|
|
3085
3485
|
/**
|
|
3486
|
+
* @public
|
|
3086
3487
|
* <p>The name of the profile object type.</p>
|
|
3087
3488
|
*/
|
|
3088
3489
|
ObjectTypeName?: string;
|
|
3089
3490
|
/**
|
|
3491
|
+
* @public
|
|
3090
3492
|
* <p>The timestamp of when the domain was created.</p>
|
|
3091
3493
|
*/
|
|
3092
3494
|
CreatedAt: Date | undefined;
|
|
3093
3495
|
/**
|
|
3496
|
+
* @public
|
|
3094
3497
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
3095
3498
|
*/
|
|
3096
3499
|
LastUpdatedAt: Date | undefined;
|
|
3097
3500
|
/**
|
|
3501
|
+
* @public
|
|
3098
3502
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3099
3503
|
*/
|
|
3100
3504
|
Tags?: Record<string, string>;
|
|
3101
3505
|
/**
|
|
3506
|
+
* @public
|
|
3102
3507
|
* <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.
|
|
3103
3508
|
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
3104
3509
|
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
3105
3510
|
*/
|
|
3106
3511
|
ObjectTypeNames?: Record<string, string>;
|
|
3107
3512
|
/**
|
|
3513
|
+
* @public
|
|
3108
3514
|
* <p>Unique identifier for the workflow.</p>
|
|
3109
3515
|
*/
|
|
3110
3516
|
WorkflowId?: string;
|
|
3111
3517
|
/**
|
|
3518
|
+
* @public
|
|
3112
3519
|
* <p>Boolean that shows if the Flow that's associated with the Integration is created in Amazon
|
|
3113
3520
|
* Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.</p>
|
|
3114
3521
|
*/
|
|
@@ -3119,10 +3526,12 @@ export interface ListIntegrationItem {
|
|
|
3119
3526
|
*/
|
|
3120
3527
|
export interface ListAccountIntegrationsResponse {
|
|
3121
3528
|
/**
|
|
3529
|
+
* @public
|
|
3122
3530
|
* <p>The list of ListAccountIntegration instances.</p>
|
|
3123
3531
|
*/
|
|
3124
3532
|
Items?: ListIntegrationItem[];
|
|
3125
3533
|
/**
|
|
3534
|
+
* @public
|
|
3126
3535
|
* <p>The pagination token from the previous ListAccountIntegrations API call.</p>
|
|
3127
3536
|
*/
|
|
3128
3537
|
NextToken?: string;
|
|
@@ -3132,14 +3541,17 @@ export interface ListAccountIntegrationsResponse {
|
|
|
3132
3541
|
*/
|
|
3133
3542
|
export interface ListCalculatedAttributeDefinitionsRequest {
|
|
3134
3543
|
/**
|
|
3544
|
+
* @public
|
|
3135
3545
|
* <p>The unique name of the domain.</p>
|
|
3136
3546
|
*/
|
|
3137
3547
|
DomainName: string | undefined;
|
|
3138
3548
|
/**
|
|
3549
|
+
* @public
|
|
3139
3550
|
* <p>The pagination token from the previous call to ListCalculatedAttributeDefinitions.</p>
|
|
3140
3551
|
*/
|
|
3141
3552
|
NextToken?: string;
|
|
3142
3553
|
/**
|
|
3554
|
+
* @public
|
|
3143
3555
|
* <p>The maximum number of calculated attribute definitions returned per page.</p>
|
|
3144
3556
|
*/
|
|
3145
3557
|
MaxResults?: number;
|
|
@@ -3149,10 +3561,12 @@ export interface ListCalculatedAttributeDefinitionsRequest {
|
|
|
3149
3561
|
*/
|
|
3150
3562
|
export interface ListCalculatedAttributeDefinitionsResponse {
|
|
3151
3563
|
/**
|
|
3564
|
+
* @public
|
|
3152
3565
|
* <p>The list of calculated attribute definitions.</p>
|
|
3153
3566
|
*/
|
|
3154
3567
|
Items?: ListCalculatedAttributeDefinitionItem[];
|
|
3155
3568
|
/**
|
|
3569
|
+
* @public
|
|
3156
3570
|
* <p>The pagination token from the previous call to ListCalculatedAttributeDefinitions.</p>
|
|
3157
3571
|
*/
|
|
3158
3572
|
NextToken?: string;
|
|
@@ -3162,18 +3576,22 @@ export interface ListCalculatedAttributeDefinitionsResponse {
|
|
|
3162
3576
|
*/
|
|
3163
3577
|
export interface ListCalculatedAttributesForProfileRequest {
|
|
3164
3578
|
/**
|
|
3579
|
+
* @public
|
|
3165
3580
|
* <p>The pagination token from the previous call to ListCalculatedAttributesForProfile.</p>
|
|
3166
3581
|
*/
|
|
3167
3582
|
NextToken?: string;
|
|
3168
3583
|
/**
|
|
3584
|
+
* @public
|
|
3169
3585
|
* <p>The maximum number of calculated attributes returned per page.</p>
|
|
3170
3586
|
*/
|
|
3171
3587
|
MaxResults?: number;
|
|
3172
3588
|
/**
|
|
3589
|
+
* @public
|
|
3173
3590
|
* <p>The unique name of the domain.</p>
|
|
3174
3591
|
*/
|
|
3175
3592
|
DomainName: string | undefined;
|
|
3176
3593
|
/**
|
|
3594
|
+
* @public
|
|
3177
3595
|
* <p>The unique identifier of a customer profile.</p>
|
|
3178
3596
|
*/
|
|
3179
3597
|
ProfileId: string | undefined;
|
|
@@ -3183,10 +3601,12 @@ export interface ListCalculatedAttributesForProfileRequest {
|
|
|
3183
3601
|
*/
|
|
3184
3602
|
export interface ListCalculatedAttributesForProfileResponse {
|
|
3185
3603
|
/**
|
|
3604
|
+
* @public
|
|
3186
3605
|
* <p>The list of calculated attributes.</p>
|
|
3187
3606
|
*/
|
|
3188
3607
|
Items?: ListCalculatedAttributeForProfileItem[];
|
|
3189
3608
|
/**
|
|
3609
|
+
* @public
|
|
3190
3610
|
* <p>The pagination token from the previous call to ListCalculatedAttributesForProfile.</p>
|
|
3191
3611
|
*/
|
|
3192
3612
|
NextToken?: string;
|
|
@@ -3196,10 +3616,12 @@ export interface ListCalculatedAttributesForProfileResponse {
|
|
|
3196
3616
|
*/
|
|
3197
3617
|
export interface ListDomainsRequest {
|
|
3198
3618
|
/**
|
|
3619
|
+
* @public
|
|
3199
3620
|
* <p>The pagination token from the previous ListDomain API call.</p>
|
|
3200
3621
|
*/
|
|
3201
3622
|
NextToken?: string;
|
|
3202
3623
|
/**
|
|
3624
|
+
* @public
|
|
3203
3625
|
* <p>The maximum number of objects returned per page.</p>
|
|
3204
3626
|
*/
|
|
3205
3627
|
MaxResults?: number;
|
|
@@ -3210,18 +3632,22 @@ export interface ListDomainsRequest {
|
|
|
3210
3632
|
*/
|
|
3211
3633
|
export interface ListDomainItem {
|
|
3212
3634
|
/**
|
|
3635
|
+
* @public
|
|
3213
3636
|
* <p>The unique name of the domain.</p>
|
|
3214
3637
|
*/
|
|
3215
3638
|
DomainName: string | undefined;
|
|
3216
3639
|
/**
|
|
3640
|
+
* @public
|
|
3217
3641
|
* <p>The timestamp of when the domain was created.</p>
|
|
3218
3642
|
*/
|
|
3219
3643
|
CreatedAt: Date | undefined;
|
|
3220
3644
|
/**
|
|
3645
|
+
* @public
|
|
3221
3646
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
3222
3647
|
*/
|
|
3223
3648
|
LastUpdatedAt: Date | undefined;
|
|
3224
3649
|
/**
|
|
3650
|
+
* @public
|
|
3225
3651
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3226
3652
|
*/
|
|
3227
3653
|
Tags?: Record<string, string>;
|
|
@@ -3231,10 +3657,12 @@ export interface ListDomainItem {
|
|
|
3231
3657
|
*/
|
|
3232
3658
|
export interface ListDomainsResponse {
|
|
3233
3659
|
/**
|
|
3660
|
+
* @public
|
|
3234
3661
|
* <p>The list of ListDomains instances.</p>
|
|
3235
3662
|
*/
|
|
3236
3663
|
Items?: ListDomainItem[];
|
|
3237
3664
|
/**
|
|
3665
|
+
* @public
|
|
3238
3666
|
* <p>The pagination token from the previous ListDomains API call.</p>
|
|
3239
3667
|
*/
|
|
3240
3668
|
NextToken?: string;
|
|
@@ -3244,14 +3672,17 @@ export interface ListDomainsResponse {
|
|
|
3244
3672
|
*/
|
|
3245
3673
|
export interface ListEventStreamsRequest {
|
|
3246
3674
|
/**
|
|
3675
|
+
* @public
|
|
3247
3676
|
* <p>The unique name of the domain.</p>
|
|
3248
3677
|
*/
|
|
3249
3678
|
DomainName: string | undefined;
|
|
3250
3679
|
/**
|
|
3680
|
+
* @public
|
|
3251
3681
|
* <p>Identifies the next page of results to return.</p>
|
|
3252
3682
|
*/
|
|
3253
3683
|
NextToken?: string;
|
|
3254
3684
|
/**
|
|
3685
|
+
* @public
|
|
3255
3686
|
* <p>The maximum number of objects returned per page.</p>
|
|
3256
3687
|
*/
|
|
3257
3688
|
MaxResults?: number;
|
|
@@ -3262,15 +3693,18 @@ export interface ListEventStreamsRequest {
|
|
|
3262
3693
|
*/
|
|
3263
3694
|
export interface DestinationSummary {
|
|
3264
3695
|
/**
|
|
3696
|
+
* @public
|
|
3265
3697
|
* <p>The StreamARN of the destination to deliver profile events to. For example,
|
|
3266
3698
|
* arn:aws:kinesis:region:account-id:stream/stream-name.</p>
|
|
3267
3699
|
*/
|
|
3268
3700
|
Uri: string | undefined;
|
|
3269
3701
|
/**
|
|
3702
|
+
* @public
|
|
3270
3703
|
* <p>The status of enabling the Kinesis stream as a destination for export.</p>
|
|
3271
3704
|
*/
|
|
3272
3705
|
Status: EventStreamDestinationStatus | string | undefined;
|
|
3273
3706
|
/**
|
|
3707
|
+
* @public
|
|
3274
3708
|
* <p>The timestamp when the status last changed to <code>UNHEALHY</code>.</p>
|
|
3275
3709
|
*/
|
|
3276
3710
|
UnhealthySince?: Date;
|
|
@@ -3281,30 +3715,37 @@ export interface DestinationSummary {
|
|
|
3281
3715
|
*/
|
|
3282
3716
|
export interface EventStreamSummary {
|
|
3283
3717
|
/**
|
|
3718
|
+
* @public
|
|
3284
3719
|
* <p>The unique name of the domain.</p>
|
|
3285
3720
|
*/
|
|
3286
3721
|
DomainName: string | undefined;
|
|
3287
3722
|
/**
|
|
3723
|
+
* @public
|
|
3288
3724
|
* <p>The name of the event stream.</p>
|
|
3289
3725
|
*/
|
|
3290
3726
|
EventStreamName: string | undefined;
|
|
3291
3727
|
/**
|
|
3728
|
+
* @public
|
|
3292
3729
|
* <p>A unique identifier for the event stream.</p>
|
|
3293
3730
|
*/
|
|
3294
3731
|
EventStreamArn: string | undefined;
|
|
3295
3732
|
/**
|
|
3733
|
+
* @public
|
|
3296
3734
|
* <p>The operational state of destination stream for export.</p>
|
|
3297
3735
|
*/
|
|
3298
3736
|
State: EventStreamState | string | undefined;
|
|
3299
3737
|
/**
|
|
3738
|
+
* @public
|
|
3300
3739
|
* <p>The timestamp when the <code>State</code> changed to <code>STOPPED</code>.</p>
|
|
3301
3740
|
*/
|
|
3302
3741
|
StoppedSince?: Date;
|
|
3303
3742
|
/**
|
|
3743
|
+
* @public
|
|
3304
3744
|
* <p>Summary information about the Kinesis data stream.</p>
|
|
3305
3745
|
*/
|
|
3306
3746
|
DestinationSummary?: DestinationSummary;
|
|
3307
3747
|
/**
|
|
3748
|
+
* @public
|
|
3308
3749
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3309
3750
|
*/
|
|
3310
3751
|
Tags?: Record<string, string>;
|
|
@@ -3314,10 +3755,12 @@ export interface EventStreamSummary {
|
|
|
3314
3755
|
*/
|
|
3315
3756
|
export interface ListEventStreamsResponse {
|
|
3316
3757
|
/**
|
|
3758
|
+
* @public
|
|
3317
3759
|
* <p>Contains summary information about an EventStream.</p>
|
|
3318
3760
|
*/
|
|
3319
3761
|
Items?: EventStreamSummary[];
|
|
3320
3762
|
/**
|
|
3763
|
+
* @public
|
|
3321
3764
|
* <p>Identifies the next page of results to return.</p>
|
|
3322
3765
|
*/
|
|
3323
3766
|
NextToken?: string;
|
|
@@ -3327,15 +3770,18 @@ export interface ListEventStreamsResponse {
|
|
|
3327
3770
|
*/
|
|
3328
3771
|
export interface ListIdentityResolutionJobsRequest {
|
|
3329
3772
|
/**
|
|
3773
|
+
* @public
|
|
3330
3774
|
* <p>The unique name of the domain.</p>
|
|
3331
3775
|
*/
|
|
3332
3776
|
DomainName: string | undefined;
|
|
3333
3777
|
/**
|
|
3778
|
+
* @public
|
|
3334
3779
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3335
3780
|
* response in the next request to retrieve the next set of results.</p>
|
|
3336
3781
|
*/
|
|
3337
3782
|
NextToken?: string;
|
|
3338
3783
|
/**
|
|
3784
|
+
* @public
|
|
3339
3785
|
* <p>The maximum number of results to return per page.</p>
|
|
3340
3786
|
*/
|
|
3341
3787
|
MaxResults?: number;
|
|
@@ -3346,14 +3792,17 @@ export interface ListIdentityResolutionJobsRequest {
|
|
|
3346
3792
|
*/
|
|
3347
3793
|
export interface IdentityResolutionJob {
|
|
3348
3794
|
/**
|
|
3795
|
+
* @public
|
|
3349
3796
|
* <p>The unique name of the domain.</p>
|
|
3350
3797
|
*/
|
|
3351
3798
|
DomainName?: string;
|
|
3352
3799
|
/**
|
|
3800
|
+
* @public
|
|
3353
3801
|
* <p>The unique identifier of the Identity Resolution Job.</p>
|
|
3354
3802
|
*/
|
|
3355
3803
|
JobId?: string;
|
|
3356
3804
|
/**
|
|
3805
|
+
* @public
|
|
3357
3806
|
* <p>The status of the Identity Resolution Job.</p>
|
|
3358
3807
|
* <ul>
|
|
3359
3808
|
* <li>
|
|
@@ -3393,22 +3842,27 @@ export interface IdentityResolutionJob {
|
|
|
3393
3842
|
*/
|
|
3394
3843
|
Status?: IdentityResolutionJobStatus | string;
|
|
3395
3844
|
/**
|
|
3845
|
+
* @public
|
|
3396
3846
|
* <p>The timestamp of when the job was started or will be started.</p>
|
|
3397
3847
|
*/
|
|
3398
3848
|
JobStartTime?: Date;
|
|
3399
3849
|
/**
|
|
3850
|
+
* @public
|
|
3400
3851
|
* <p>The timestamp of when the job was completed.</p>
|
|
3401
3852
|
*/
|
|
3402
3853
|
JobEndTime?: Date;
|
|
3403
3854
|
/**
|
|
3855
|
+
* @public
|
|
3404
3856
|
* <p>Statistics about an Identity Resolution Job.</p>
|
|
3405
3857
|
*/
|
|
3406
3858
|
JobStats?: JobStats;
|
|
3407
3859
|
/**
|
|
3860
|
+
* @public
|
|
3408
3861
|
* <p>The S3 location where the Identity Resolution Job writes result files.</p>
|
|
3409
3862
|
*/
|
|
3410
3863
|
ExportingLocation?: ExportingLocation;
|
|
3411
3864
|
/**
|
|
3865
|
+
* @public
|
|
3412
3866
|
* <p>The error messages that are generated when the Identity Resolution Job runs.</p>
|
|
3413
3867
|
*/
|
|
3414
3868
|
Message?: string;
|
|
@@ -3418,10 +3872,12 @@ export interface IdentityResolutionJob {
|
|
|
3418
3872
|
*/
|
|
3419
3873
|
export interface ListIdentityResolutionJobsResponse {
|
|
3420
3874
|
/**
|
|
3875
|
+
* @public
|
|
3421
3876
|
* <p>A list of Identity Resolution Jobs.</p>
|
|
3422
3877
|
*/
|
|
3423
3878
|
IdentityResolutionJobsList?: IdentityResolutionJob[];
|
|
3424
3879
|
/**
|
|
3880
|
+
* @public
|
|
3425
3881
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3426
3882
|
*/
|
|
3427
3883
|
NextToken?: string;
|
|
@@ -3431,18 +3887,22 @@ export interface ListIdentityResolutionJobsResponse {
|
|
|
3431
3887
|
*/
|
|
3432
3888
|
export interface ListIntegrationsRequest {
|
|
3433
3889
|
/**
|
|
3890
|
+
* @public
|
|
3434
3891
|
* <p>The unique name of the domain.</p>
|
|
3435
3892
|
*/
|
|
3436
3893
|
DomainName: string | undefined;
|
|
3437
3894
|
/**
|
|
3895
|
+
* @public
|
|
3438
3896
|
* <p>The pagination token from the previous ListIntegrations API call.</p>
|
|
3439
3897
|
*/
|
|
3440
3898
|
NextToken?: string;
|
|
3441
3899
|
/**
|
|
3900
|
+
* @public
|
|
3442
3901
|
* <p>The maximum number of objects returned per page.</p>
|
|
3443
3902
|
*/
|
|
3444
3903
|
MaxResults?: number;
|
|
3445
3904
|
/**
|
|
3905
|
+
* @public
|
|
3446
3906
|
* <p>Boolean to indicate if hidden integration should be returned. Defaults to <code>False</code>.</p>
|
|
3447
3907
|
*/
|
|
3448
3908
|
IncludeHidden?: boolean;
|
|
@@ -3452,10 +3912,12 @@ export interface ListIntegrationsRequest {
|
|
|
3452
3912
|
*/
|
|
3453
3913
|
export interface ListIntegrationsResponse {
|
|
3454
3914
|
/**
|
|
3915
|
+
* @public
|
|
3455
3916
|
* <p>The list of ListIntegrations instances.</p>
|
|
3456
3917
|
*/
|
|
3457
3918
|
Items?: ListIntegrationItem[];
|
|
3458
3919
|
/**
|
|
3920
|
+
* @public
|
|
3459
3921
|
* <p>The pagination token from the previous ListIntegrations API call.</p>
|
|
3460
3922
|
*/
|
|
3461
3923
|
NextToken?: string;
|
|
@@ -3467,6 +3929,7 @@ export interface ListIntegrationsResponse {
|
|
|
3467
3929
|
*/
|
|
3468
3930
|
export interface ObjectFilter {
|
|
3469
3931
|
/**
|
|
3932
|
+
* @public
|
|
3470
3933
|
* <p>A searchable identifier of a profile object. The predefined keys you can use to
|
|
3471
3934
|
* search for <code>_asset</code> include: <code>_assetId</code>, <code>_assetName</code>,
|
|
3472
3935
|
* and <code>_serialNumber</code>. The predefined keys you can use to search for <code>_case</code>
|
|
@@ -3475,6 +3938,7 @@ export interface ObjectFilter {
|
|
|
3475
3938
|
*/
|
|
3476
3939
|
KeyName: string | undefined;
|
|
3477
3940
|
/**
|
|
3941
|
+
* @public
|
|
3478
3942
|
* <p>A list of key values.</p>
|
|
3479
3943
|
*/
|
|
3480
3944
|
Values: string[] | undefined;
|
|
@@ -3484,26 +3948,32 @@ export interface ObjectFilter {
|
|
|
3484
3948
|
*/
|
|
3485
3949
|
export interface ListProfileObjectsRequest {
|
|
3486
3950
|
/**
|
|
3951
|
+
* @public
|
|
3487
3952
|
* <p>The pagination token from the previous call to ListProfileObjects.</p>
|
|
3488
3953
|
*/
|
|
3489
3954
|
NextToken?: string;
|
|
3490
3955
|
/**
|
|
3956
|
+
* @public
|
|
3491
3957
|
* <p>The maximum number of objects returned per page.</p>
|
|
3492
3958
|
*/
|
|
3493
3959
|
MaxResults?: number;
|
|
3494
3960
|
/**
|
|
3961
|
+
* @public
|
|
3495
3962
|
* <p>The unique name of the domain.</p>
|
|
3496
3963
|
*/
|
|
3497
3964
|
DomainName: string | undefined;
|
|
3498
3965
|
/**
|
|
3966
|
+
* @public
|
|
3499
3967
|
* <p>The name of the profile object type.</p>
|
|
3500
3968
|
*/
|
|
3501
3969
|
ObjectTypeName: string | undefined;
|
|
3502
3970
|
/**
|
|
3971
|
+
* @public
|
|
3503
3972
|
* <p>The unique identifier of a customer profile.</p>
|
|
3504
3973
|
*/
|
|
3505
3974
|
ProfileId: string | undefined;
|
|
3506
3975
|
/**
|
|
3976
|
+
* @public
|
|
3507
3977
|
* <p>Applies a filter to the response to include profile objects with the specified index
|
|
3508
3978
|
* values.</p>
|
|
3509
3979
|
*/
|
|
@@ -3515,15 +3985,18 @@ export interface ListProfileObjectsRequest {
|
|
|
3515
3985
|
*/
|
|
3516
3986
|
export interface ListProfileObjectsItem {
|
|
3517
3987
|
/**
|
|
3988
|
+
* @public
|
|
3518
3989
|
* <p>Specifies the kind of object being added to a profile, such as
|
|
3519
3990
|
* "Salesforce-Account."</p>
|
|
3520
3991
|
*/
|
|
3521
3992
|
ObjectTypeName?: string;
|
|
3522
3993
|
/**
|
|
3994
|
+
* @public
|
|
3523
3995
|
* <p>The unique identifier of the ProfileObject generated by the service.</p>
|
|
3524
3996
|
*/
|
|
3525
3997
|
ProfileObjectUniqueKey?: string;
|
|
3526
3998
|
/**
|
|
3999
|
+
* @public
|
|
3527
4000
|
* <p>A JSON representation of a ProfileObject that belongs to a profile.</p>
|
|
3528
4001
|
*/
|
|
3529
4002
|
Object?: string;
|
|
@@ -3533,10 +4006,12 @@ export interface ListProfileObjectsItem {
|
|
|
3533
4006
|
*/
|
|
3534
4007
|
export interface ListProfileObjectsResponse {
|
|
3535
4008
|
/**
|
|
4009
|
+
* @public
|
|
3536
4010
|
* <p>The list of ListProfileObject instances.</p>
|
|
3537
4011
|
*/
|
|
3538
4012
|
Items?: ListProfileObjectsItem[];
|
|
3539
4013
|
/**
|
|
4014
|
+
* @public
|
|
3540
4015
|
* <p>The pagination token from the previous call to ListProfileObjects.</p>
|
|
3541
4016
|
*/
|
|
3542
4017
|
NextToken?: string;
|
|
@@ -3546,14 +4021,17 @@ export interface ListProfileObjectsResponse {
|
|
|
3546
4021
|
*/
|
|
3547
4022
|
export interface ListProfileObjectTypesRequest {
|
|
3548
4023
|
/**
|
|
4024
|
+
* @public
|
|
3549
4025
|
* <p>The unique name of the domain.</p>
|
|
3550
4026
|
*/
|
|
3551
4027
|
DomainName: string | undefined;
|
|
3552
4028
|
/**
|
|
4029
|
+
* @public
|
|
3553
4030
|
* <p>Identifies the next page of results to return.</p>
|
|
3554
4031
|
*/
|
|
3555
4032
|
NextToken?: string;
|
|
3556
4033
|
/**
|
|
4034
|
+
* @public
|
|
3557
4035
|
* <p>The maximum number of objects returned per page.</p>
|
|
3558
4036
|
*/
|
|
3559
4037
|
MaxResults?: number;
|
|
@@ -3564,22 +4042,27 @@ export interface ListProfileObjectTypesRequest {
|
|
|
3564
4042
|
*/
|
|
3565
4043
|
export interface ListProfileObjectTypeItem {
|
|
3566
4044
|
/**
|
|
4045
|
+
* @public
|
|
3567
4046
|
* <p>The name of the profile object type.</p>
|
|
3568
4047
|
*/
|
|
3569
4048
|
ObjectTypeName: string | undefined;
|
|
3570
4049
|
/**
|
|
4050
|
+
* @public
|
|
3571
4051
|
* <p>Description of the profile object type.</p>
|
|
3572
4052
|
*/
|
|
3573
4053
|
Description: string | undefined;
|
|
3574
4054
|
/**
|
|
4055
|
+
* @public
|
|
3575
4056
|
* <p>The timestamp of when the domain was created.</p>
|
|
3576
4057
|
*/
|
|
3577
4058
|
CreatedAt?: Date;
|
|
3578
4059
|
/**
|
|
4060
|
+
* @public
|
|
3579
4061
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
3580
4062
|
*/
|
|
3581
4063
|
LastUpdatedAt?: Date;
|
|
3582
4064
|
/**
|
|
4065
|
+
* @public
|
|
3583
4066
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3584
4067
|
*/
|
|
3585
4068
|
Tags?: Record<string, string>;
|
|
@@ -3589,10 +4072,12 @@ export interface ListProfileObjectTypeItem {
|
|
|
3589
4072
|
*/
|
|
3590
4073
|
export interface ListProfileObjectTypesResponse {
|
|
3591
4074
|
/**
|
|
4075
|
+
* @public
|
|
3592
4076
|
* <p>The list of ListProfileObjectTypes instances.</p>
|
|
3593
4077
|
*/
|
|
3594
4078
|
Items?: ListProfileObjectTypeItem[];
|
|
3595
4079
|
/**
|
|
4080
|
+
* @public
|
|
3596
4081
|
* <p>Identifies the next page of results to return.</p>
|
|
3597
4082
|
*/
|
|
3598
4083
|
NextToken?: string;
|
|
@@ -3602,10 +4087,12 @@ export interface ListProfileObjectTypesResponse {
|
|
|
3602
4087
|
*/
|
|
3603
4088
|
export interface ListProfileObjectTypeTemplatesRequest {
|
|
3604
4089
|
/**
|
|
4090
|
+
* @public
|
|
3605
4091
|
* <p>The pagination token from the previous ListObjectTypeTemplates API call.</p>
|
|
3606
4092
|
*/
|
|
3607
4093
|
NextToken?: string;
|
|
3608
4094
|
/**
|
|
4095
|
+
* @public
|
|
3609
4096
|
* <p>The maximum number of objects returned per page.</p>
|
|
3610
4097
|
*/
|
|
3611
4098
|
MaxResults?: number;
|
|
@@ -3616,14 +4103,17 @@ export interface ListProfileObjectTypeTemplatesRequest {
|
|
|
3616
4103
|
*/
|
|
3617
4104
|
export interface ListProfileObjectTypeTemplateItem {
|
|
3618
4105
|
/**
|
|
4106
|
+
* @public
|
|
3619
4107
|
* <p>A unique identifier for the object template.</p>
|
|
3620
4108
|
*/
|
|
3621
4109
|
TemplateId?: string;
|
|
3622
4110
|
/**
|
|
4111
|
+
* @public
|
|
3623
4112
|
* <p>The name of the source of the object template.</p>
|
|
3624
4113
|
*/
|
|
3625
4114
|
SourceName?: string;
|
|
3626
4115
|
/**
|
|
4116
|
+
* @public
|
|
3627
4117
|
* <p>The source of the object template.</p>
|
|
3628
4118
|
*/
|
|
3629
4119
|
SourceObject?: string;
|
|
@@ -3633,10 +4123,12 @@ export interface ListProfileObjectTypeTemplateItem {
|
|
|
3633
4123
|
*/
|
|
3634
4124
|
export interface ListProfileObjectTypeTemplatesResponse {
|
|
3635
4125
|
/**
|
|
4126
|
+
* @public
|
|
3636
4127
|
* <p>The list of ListProfileObjectType template instances.</p>
|
|
3637
4128
|
*/
|
|
3638
4129
|
Items?: ListProfileObjectTypeTemplateItem[];
|
|
3639
4130
|
/**
|
|
4131
|
+
* @public
|
|
3640
4132
|
* <p>The pagination token from the previous ListObjectTypeTemplates API call. </p>
|
|
3641
4133
|
*/
|
|
3642
4134
|
NextToken?: string;
|
|
@@ -3646,15 +4138,18 @@ export interface ListProfileObjectTypeTemplatesResponse {
|
|
|
3646
4138
|
*/
|
|
3647
4139
|
export interface ListRuleBasedMatchesRequest {
|
|
3648
4140
|
/**
|
|
4141
|
+
* @public
|
|
3649
4142
|
* <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
|
|
3650
4143
|
* call.</p>
|
|
3651
4144
|
*/
|
|
3652
4145
|
NextToken?: string;
|
|
3653
4146
|
/**
|
|
4147
|
+
* @public
|
|
3654
4148
|
* <p>The maximum number of <code>MatchIds</code> returned per page.</p>
|
|
3655
4149
|
*/
|
|
3656
4150
|
MaxResults?: number;
|
|
3657
4151
|
/**
|
|
4152
|
+
* @public
|
|
3658
4153
|
* <p>The unique name of the domain.</p>
|
|
3659
4154
|
*/
|
|
3660
4155
|
DomainName: string | undefined;
|
|
@@ -3664,10 +4159,12 @@ export interface ListRuleBasedMatchesRequest {
|
|
|
3664
4159
|
*/
|
|
3665
4160
|
export interface ListRuleBasedMatchesResponse {
|
|
3666
4161
|
/**
|
|
4162
|
+
* @public
|
|
3667
4163
|
* <p>The list of <code>MatchIds</code> for the given domain.</p>
|
|
3668
4164
|
*/
|
|
3669
4165
|
MatchIds?: string[];
|
|
3670
4166
|
/**
|
|
4167
|
+
* @public
|
|
3671
4168
|
* <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
|
|
3672
4169
|
* call.</p>
|
|
3673
4170
|
*/
|
|
@@ -3678,6 +4175,7 @@ export interface ListRuleBasedMatchesResponse {
|
|
|
3678
4175
|
*/
|
|
3679
4176
|
export interface ListTagsForResourceRequest {
|
|
3680
4177
|
/**
|
|
4178
|
+
* @public
|
|
3681
4179
|
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
3682
4180
|
*/
|
|
3683
4181
|
resourceArn: string | undefined;
|
|
@@ -3687,6 +4185,7 @@ export interface ListTagsForResourceRequest {
|
|
|
3687
4185
|
*/
|
|
3688
4186
|
export interface ListTagsForResourceResponse {
|
|
3689
4187
|
/**
|
|
4188
|
+
* @public
|
|
3690
4189
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3691
4190
|
*/
|
|
3692
4191
|
tags?: Record<string, string>;
|
|
@@ -3696,31 +4195,38 @@ export interface ListTagsForResourceResponse {
|
|
|
3696
4195
|
*/
|
|
3697
4196
|
export interface ListWorkflowsRequest {
|
|
3698
4197
|
/**
|
|
4198
|
+
* @public
|
|
3699
4199
|
* <p>The unique name of the domain.</p>
|
|
3700
4200
|
*/
|
|
3701
4201
|
DomainName: string | undefined;
|
|
3702
4202
|
/**
|
|
4203
|
+
* @public
|
|
3703
4204
|
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
3704
4205
|
*/
|
|
3705
4206
|
WorkflowType?: WorkflowType | string;
|
|
3706
4207
|
/**
|
|
4208
|
+
* @public
|
|
3707
4209
|
* <p>Status of workflow execution.</p>
|
|
3708
4210
|
*/
|
|
3709
4211
|
Status?: Status | string;
|
|
3710
4212
|
/**
|
|
4213
|
+
* @public
|
|
3711
4214
|
* <p>Retrieve workflows started after timestamp.</p>
|
|
3712
4215
|
*/
|
|
3713
4216
|
QueryStartDate?: Date;
|
|
3714
4217
|
/**
|
|
4218
|
+
* @public
|
|
3715
4219
|
* <p>Retrieve workflows ended after timestamp.</p>
|
|
3716
4220
|
*/
|
|
3717
4221
|
QueryEndDate?: Date;
|
|
3718
4222
|
/**
|
|
4223
|
+
* @public
|
|
3719
4224
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3720
4225
|
* response in the next request to retrieve the next set of results.</p>
|
|
3721
4226
|
*/
|
|
3722
4227
|
NextToken?: string;
|
|
3723
4228
|
/**
|
|
4229
|
+
* @public
|
|
3724
4230
|
* <p>The maximum number of results to return per page.</p>
|
|
3725
4231
|
*/
|
|
3726
4232
|
MaxResults?: number;
|
|
@@ -3731,26 +4237,32 @@ export interface ListWorkflowsRequest {
|
|
|
3731
4237
|
*/
|
|
3732
4238
|
export interface ListWorkflowsItem {
|
|
3733
4239
|
/**
|
|
4240
|
+
* @public
|
|
3734
4241
|
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
3735
4242
|
*/
|
|
3736
4243
|
WorkflowType: WorkflowType | string | undefined;
|
|
3737
4244
|
/**
|
|
4245
|
+
* @public
|
|
3738
4246
|
* <p>Unique identifier for the workflow.</p>
|
|
3739
4247
|
*/
|
|
3740
4248
|
WorkflowId: string | undefined;
|
|
3741
4249
|
/**
|
|
4250
|
+
* @public
|
|
3742
4251
|
* <p>Status of workflow execution.</p>
|
|
3743
4252
|
*/
|
|
3744
4253
|
Status: Status | string | undefined;
|
|
3745
4254
|
/**
|
|
4255
|
+
* @public
|
|
3746
4256
|
* <p>Description for workflow execution status.</p>
|
|
3747
4257
|
*/
|
|
3748
4258
|
StatusDescription: string | undefined;
|
|
3749
4259
|
/**
|
|
4260
|
+
* @public
|
|
3750
4261
|
* <p>Creation timestamp for workflow.</p>
|
|
3751
4262
|
*/
|
|
3752
4263
|
CreatedAt: Date | undefined;
|
|
3753
4264
|
/**
|
|
4265
|
+
* @public
|
|
3754
4266
|
* <p>Last updated timestamp for workflow.</p>
|
|
3755
4267
|
*/
|
|
3756
4268
|
LastUpdatedAt: Date | undefined;
|
|
@@ -3760,10 +4272,12 @@ export interface ListWorkflowsItem {
|
|
|
3760
4272
|
*/
|
|
3761
4273
|
export interface ListWorkflowsResponse {
|
|
3762
4274
|
/**
|
|
4275
|
+
* @public
|
|
3763
4276
|
* <p>List containing workflow details.</p>
|
|
3764
4277
|
*/
|
|
3765
4278
|
Items?: ListWorkflowsItem[];
|
|
3766
4279
|
/**
|
|
4280
|
+
* @public
|
|
3767
4281
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3768
4282
|
*/
|
|
3769
4283
|
NextToken?: string;
|
|
@@ -3774,86 +4288,107 @@ export interface ListWorkflowsResponse {
|
|
|
3774
4288
|
*/
|
|
3775
4289
|
export interface FieldSourceProfileIds {
|
|
3776
4290
|
/**
|
|
4291
|
+
* @public
|
|
3777
4292
|
* <p>A unique identifier for the account number field to be merged. </p>
|
|
3778
4293
|
*/
|
|
3779
4294
|
AccountNumber?: string;
|
|
3780
4295
|
/**
|
|
4296
|
+
* @public
|
|
3781
4297
|
* <p>A unique identifier for the additional information field to be merged.</p>
|
|
3782
4298
|
*/
|
|
3783
4299
|
AdditionalInformation?: string;
|
|
3784
4300
|
/**
|
|
4301
|
+
* @public
|
|
3785
4302
|
* <p>A unique identifier for the party type field to be merged.</p>
|
|
3786
4303
|
*/
|
|
3787
4304
|
PartyType?: string;
|
|
3788
4305
|
/**
|
|
4306
|
+
* @public
|
|
3789
4307
|
* <p>A unique identifier for the business name field to be merged.</p>
|
|
3790
4308
|
*/
|
|
3791
4309
|
BusinessName?: string;
|
|
3792
4310
|
/**
|
|
4311
|
+
* @public
|
|
3793
4312
|
* <p>A unique identifier for the first name field to be merged.</p>
|
|
3794
4313
|
*/
|
|
3795
4314
|
FirstName?: string;
|
|
3796
4315
|
/**
|
|
4316
|
+
* @public
|
|
3797
4317
|
* <p>A unique identifier for the middle name field to be merged.</p>
|
|
3798
4318
|
*/
|
|
3799
4319
|
MiddleName?: string;
|
|
3800
4320
|
/**
|
|
4321
|
+
* @public
|
|
3801
4322
|
* <p>A unique identifier for the last name field to be merged.</p>
|
|
3802
4323
|
*/
|
|
3803
4324
|
LastName?: string;
|
|
3804
4325
|
/**
|
|
4326
|
+
* @public
|
|
3805
4327
|
* <p>A unique identifier for the birthdate field to be merged.</p>
|
|
3806
4328
|
*/
|
|
3807
4329
|
BirthDate?: string;
|
|
3808
4330
|
/**
|
|
4331
|
+
* @public
|
|
3809
4332
|
* <p>A unique identifier for the gender field to be merged.</p>
|
|
3810
4333
|
*/
|
|
3811
4334
|
Gender?: string;
|
|
3812
4335
|
/**
|
|
4336
|
+
* @public
|
|
3813
4337
|
* <p>A unique identifier for the phone number field to be merged.</p>
|
|
3814
4338
|
*/
|
|
3815
4339
|
PhoneNumber?: string;
|
|
3816
4340
|
/**
|
|
4341
|
+
* @public
|
|
3817
4342
|
* <p>A unique identifier for the mobile phone number field to be merged.</p>
|
|
3818
4343
|
*/
|
|
3819
4344
|
MobilePhoneNumber?: string;
|
|
3820
4345
|
/**
|
|
4346
|
+
* @public
|
|
3821
4347
|
* <p>A unique identifier for the home phone number field to be merged.</p>
|
|
3822
4348
|
*/
|
|
3823
4349
|
HomePhoneNumber?: string;
|
|
3824
4350
|
/**
|
|
4351
|
+
* @public
|
|
3825
4352
|
* <p>A unique identifier for the business phone number field to be merged.</p>
|
|
3826
4353
|
*/
|
|
3827
4354
|
BusinessPhoneNumber?: string;
|
|
3828
4355
|
/**
|
|
4356
|
+
* @public
|
|
3829
4357
|
* <p>A unique identifier for the email address field to be merged.</p>
|
|
3830
4358
|
*/
|
|
3831
4359
|
EmailAddress?: string;
|
|
3832
4360
|
/**
|
|
4361
|
+
* @public
|
|
3833
4362
|
* <p>A unique identifier for the personal email address field to be merged.</p>
|
|
3834
4363
|
*/
|
|
3835
4364
|
PersonalEmailAddress?: string;
|
|
3836
4365
|
/**
|
|
4366
|
+
* @public
|
|
3837
4367
|
* <p>A unique identifier for the party type field to be merged.</p>
|
|
3838
4368
|
*/
|
|
3839
4369
|
BusinessEmailAddress?: string;
|
|
3840
4370
|
/**
|
|
4371
|
+
* @public
|
|
3841
4372
|
* <p>A unique identifier for the party type field to be merged.</p>
|
|
3842
4373
|
*/
|
|
3843
4374
|
Address?: string;
|
|
3844
4375
|
/**
|
|
4376
|
+
* @public
|
|
3845
4377
|
* <p>A unique identifier for the shipping address field to be merged.</p>
|
|
3846
4378
|
*/
|
|
3847
4379
|
ShippingAddress?: string;
|
|
3848
4380
|
/**
|
|
4381
|
+
* @public
|
|
3849
4382
|
* <p>A unique identifier for the mailing address field to be merged.</p>
|
|
3850
4383
|
*/
|
|
3851
4384
|
MailingAddress?: string;
|
|
3852
4385
|
/**
|
|
4386
|
+
* @public
|
|
3853
4387
|
* <p>A unique identifier for the billing type field to be merged.</p>
|
|
3854
4388
|
*/
|
|
3855
4389
|
BillingAddress?: string;
|
|
3856
4390
|
/**
|
|
4391
|
+
* @public
|
|
3857
4392
|
* <p>A unique identifier for the attributes field to be merged.</p>
|
|
3858
4393
|
*/
|
|
3859
4394
|
Attributes?: Record<string, string>;
|
|
@@ -3863,18 +4398,22 @@ export interface FieldSourceProfileIds {
|
|
|
3863
4398
|
*/
|
|
3864
4399
|
export interface MergeProfilesRequest {
|
|
3865
4400
|
/**
|
|
4401
|
+
* @public
|
|
3866
4402
|
* <p>The unique name of the domain.</p>
|
|
3867
4403
|
*/
|
|
3868
4404
|
DomainName: string | undefined;
|
|
3869
4405
|
/**
|
|
4406
|
+
* @public
|
|
3870
4407
|
* <p>The identifier of the profile to be taken.</p>
|
|
3871
4408
|
*/
|
|
3872
4409
|
MainProfileId: string | undefined;
|
|
3873
4410
|
/**
|
|
4411
|
+
* @public
|
|
3874
4412
|
* <p>The identifier of the profile to be merged into MainProfileId.</p>
|
|
3875
4413
|
*/
|
|
3876
4414
|
ProfileIdsToBeMerged: string[] | undefined;
|
|
3877
4415
|
/**
|
|
4416
|
+
* @public
|
|
3878
4417
|
* <p>The identifiers of the fields in the profile that has the information you want to apply
|
|
3879
4418
|
* to the merge. For example, say you want to merge EmailAddress from Profile1 into
|
|
3880
4419
|
* MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
|
|
@@ -3886,6 +4425,7 @@ export interface MergeProfilesRequest {
|
|
|
3886
4425
|
*/
|
|
3887
4426
|
export interface MergeProfilesResponse {
|
|
3888
4427
|
/**
|
|
4428
|
+
* @public
|
|
3889
4429
|
* <p>A message that indicates the merge request is complete.</p>
|
|
3890
4430
|
*/
|
|
3891
4431
|
Message?: string;
|
|
@@ -3895,27 +4435,33 @@ export interface MergeProfilesResponse {
|
|
|
3895
4435
|
*/
|
|
3896
4436
|
export interface PutIntegrationRequest {
|
|
3897
4437
|
/**
|
|
4438
|
+
* @public
|
|
3898
4439
|
* <p>The unique name of the domain.</p>
|
|
3899
4440
|
*/
|
|
3900
4441
|
DomainName: string | undefined;
|
|
3901
4442
|
/**
|
|
4443
|
+
* @public
|
|
3902
4444
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
3903
4445
|
*/
|
|
3904
4446
|
Uri?: string;
|
|
3905
4447
|
/**
|
|
4448
|
+
* @public
|
|
3906
4449
|
* <p>The name of the profile object type.</p>
|
|
3907
4450
|
*/
|
|
3908
4451
|
ObjectTypeName?: string;
|
|
3909
4452
|
/**
|
|
4453
|
+
* @public
|
|
3910
4454
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3911
4455
|
*/
|
|
3912
4456
|
Tags?: Record<string, string>;
|
|
3913
4457
|
/**
|
|
4458
|
+
* @public
|
|
3914
4459
|
* <p>The configuration that controls how Customer Profiles retrieves data from the
|
|
3915
4460
|
* source.</p>
|
|
3916
4461
|
*/
|
|
3917
4462
|
FlowDefinition?: FlowDefinition;
|
|
3918
4463
|
/**
|
|
4464
|
+
* @public
|
|
3919
4465
|
* <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.
|
|
3920
4466
|
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
3921
4467
|
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
@@ -3927,40 +4473,49 @@ export interface PutIntegrationRequest {
|
|
|
3927
4473
|
*/
|
|
3928
4474
|
export interface PutIntegrationResponse {
|
|
3929
4475
|
/**
|
|
4476
|
+
* @public
|
|
3930
4477
|
* <p>The unique name of the domain.</p>
|
|
3931
4478
|
*/
|
|
3932
4479
|
DomainName: string | undefined;
|
|
3933
4480
|
/**
|
|
4481
|
+
* @public
|
|
3934
4482
|
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
3935
4483
|
*/
|
|
3936
4484
|
Uri: string | undefined;
|
|
3937
4485
|
/**
|
|
4486
|
+
* @public
|
|
3938
4487
|
* <p>The name of the profile object type.</p>
|
|
3939
4488
|
*/
|
|
3940
4489
|
ObjectTypeName?: string;
|
|
3941
4490
|
/**
|
|
4491
|
+
* @public
|
|
3942
4492
|
* <p>The timestamp of when the domain was created.</p>
|
|
3943
4493
|
*/
|
|
3944
4494
|
CreatedAt: Date | undefined;
|
|
3945
4495
|
/**
|
|
4496
|
+
* @public
|
|
3946
4497
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
3947
4498
|
*/
|
|
3948
4499
|
LastUpdatedAt: Date | undefined;
|
|
3949
4500
|
/**
|
|
4501
|
+
* @public
|
|
3950
4502
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3951
4503
|
*/
|
|
3952
4504
|
Tags?: Record<string, string>;
|
|
3953
4505
|
/**
|
|
4506
|
+
* @public
|
|
3954
4507
|
* <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.
|
|
3955
4508
|
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
3956
4509
|
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
3957
4510
|
*/
|
|
3958
4511
|
ObjectTypeNames?: Record<string, string>;
|
|
3959
4512
|
/**
|
|
4513
|
+
* @public
|
|
3960
4514
|
* <p>Unique identifier for the workflow.</p>
|
|
3961
4515
|
*/
|
|
3962
4516
|
WorkflowId?: string;
|
|
3963
4517
|
/**
|
|
4518
|
+
* @public
|
|
3964
4519
|
* <p>Boolean that shows if the Flow that's associated with the Integration is created in Amazon
|
|
3965
4520
|
* Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.</p>
|
|
3966
4521
|
*/
|
|
@@ -3971,14 +4526,17 @@ export interface PutIntegrationResponse {
|
|
|
3971
4526
|
*/
|
|
3972
4527
|
export interface PutProfileObjectRequest {
|
|
3973
4528
|
/**
|
|
4529
|
+
* @public
|
|
3974
4530
|
* <p>The name of the profile object type.</p>
|
|
3975
4531
|
*/
|
|
3976
4532
|
ObjectTypeName: string | undefined;
|
|
3977
4533
|
/**
|
|
4534
|
+
* @public
|
|
3978
4535
|
* <p>A string that is serialized from a JSON object.</p>
|
|
3979
4536
|
*/
|
|
3980
4537
|
Object: string | undefined;
|
|
3981
4538
|
/**
|
|
4539
|
+
* @public
|
|
3982
4540
|
* <p>The unique name of the domain.</p>
|
|
3983
4541
|
*/
|
|
3984
4542
|
DomainName: string | undefined;
|
|
@@ -3988,6 +4546,7 @@ export interface PutProfileObjectRequest {
|
|
|
3988
4546
|
*/
|
|
3989
4547
|
export interface PutProfileObjectResponse {
|
|
3990
4548
|
/**
|
|
4549
|
+
* @public
|
|
3991
4550
|
* <p>The unique identifier of the profile object generated by the service.</p>
|
|
3992
4551
|
*/
|
|
3993
4552
|
ProfileObjectUniqueKey?: string;
|
|
@@ -3997,18 +4556,22 @@ export interface PutProfileObjectResponse {
|
|
|
3997
4556
|
*/
|
|
3998
4557
|
export interface PutProfileObjectTypeRequest {
|
|
3999
4558
|
/**
|
|
4559
|
+
* @public
|
|
4000
4560
|
* <p>The unique name of the domain.</p>
|
|
4001
4561
|
*/
|
|
4002
4562
|
DomainName: string | undefined;
|
|
4003
4563
|
/**
|
|
4564
|
+
* @public
|
|
4004
4565
|
* <p>The name of the profile object type.</p>
|
|
4005
4566
|
*/
|
|
4006
4567
|
ObjectTypeName: string | undefined;
|
|
4007
4568
|
/**
|
|
4569
|
+
* @public
|
|
4008
4570
|
* <p>Description of the profile object type.</p>
|
|
4009
4571
|
*/
|
|
4010
4572
|
Description: string | undefined;
|
|
4011
4573
|
/**
|
|
4574
|
+
* @public
|
|
4012
4575
|
* <p>A unique identifier for the object template. For some attributes in the request, the
|
|
4013
4576
|
* service will use the default value from the object template when TemplateId is present. If
|
|
4014
4577
|
* these attributes are present in the request, the service may return a <code>BadRequestException</code>.
|
|
@@ -4018,15 +4581,18 @@ export interface PutProfileObjectTypeRequest {
|
|
|
4018
4581
|
*/
|
|
4019
4582
|
TemplateId?: string;
|
|
4020
4583
|
/**
|
|
4584
|
+
* @public
|
|
4021
4585
|
* <p>The number of days until the data in the object expires.</p>
|
|
4022
4586
|
*/
|
|
4023
4587
|
ExpirationDays?: number;
|
|
4024
4588
|
/**
|
|
4589
|
+
* @public
|
|
4025
4590
|
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
4026
4591
|
* profile object type.</p>
|
|
4027
4592
|
*/
|
|
4028
4593
|
EncryptionKey?: string;
|
|
4029
4594
|
/**
|
|
4595
|
+
* @public
|
|
4030
4596
|
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
4031
4597
|
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
4032
4598
|
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
@@ -4035,19 +4601,23 @@ export interface PutProfileObjectTypeRequest {
|
|
|
4035
4601
|
*/
|
|
4036
4602
|
AllowProfileCreation?: boolean;
|
|
4037
4603
|
/**
|
|
4604
|
+
* @public
|
|
4038
4605
|
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.
|
|
4039
4606
|
* </p>
|
|
4040
4607
|
*/
|
|
4041
4608
|
SourceLastUpdatedTimestampFormat?: string;
|
|
4042
4609
|
/**
|
|
4610
|
+
* @public
|
|
4043
4611
|
* <p>A map of the name and ObjectType field.</p>
|
|
4044
4612
|
*/
|
|
4045
4613
|
Fields?: Record<string, ObjectTypeField>;
|
|
4046
4614
|
/**
|
|
4615
|
+
* @public
|
|
4047
4616
|
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
4048
4617
|
*/
|
|
4049
4618
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
4050
4619
|
/**
|
|
4620
|
+
* @public
|
|
4051
4621
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4052
4622
|
*/
|
|
4053
4623
|
Tags?: Record<string, string>;
|
|
@@ -4057,27 +4627,33 @@ export interface PutProfileObjectTypeRequest {
|
|
|
4057
4627
|
*/
|
|
4058
4628
|
export interface PutProfileObjectTypeResponse {
|
|
4059
4629
|
/**
|
|
4630
|
+
* @public
|
|
4060
4631
|
* <p>The name of the profile object type.</p>
|
|
4061
4632
|
*/
|
|
4062
4633
|
ObjectTypeName: string | undefined;
|
|
4063
4634
|
/**
|
|
4635
|
+
* @public
|
|
4064
4636
|
* <p>Description of the profile object type.</p>
|
|
4065
4637
|
*/
|
|
4066
4638
|
Description: string | undefined;
|
|
4067
4639
|
/**
|
|
4640
|
+
* @public
|
|
4068
4641
|
* <p>A unique identifier for the object template.</p>
|
|
4069
4642
|
*/
|
|
4070
4643
|
TemplateId?: string;
|
|
4071
4644
|
/**
|
|
4645
|
+
* @public
|
|
4072
4646
|
* <p>The number of days until the data in the object expires.</p>
|
|
4073
4647
|
*/
|
|
4074
4648
|
ExpirationDays?: number;
|
|
4075
4649
|
/**
|
|
4650
|
+
* @public
|
|
4076
4651
|
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
4077
4652
|
* profile object type.</p>
|
|
4078
4653
|
*/
|
|
4079
4654
|
EncryptionKey?: string;
|
|
4080
4655
|
/**
|
|
4656
|
+
* @public
|
|
4081
4657
|
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
4082
4658
|
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
4083
4659
|
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
@@ -4086,28 +4662,34 @@ export interface PutProfileObjectTypeResponse {
|
|
|
4086
4662
|
*/
|
|
4087
4663
|
AllowProfileCreation?: boolean;
|
|
4088
4664
|
/**
|
|
4665
|
+
* @public
|
|
4089
4666
|
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in
|
|
4090
4667
|
* 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
|
|
4091
4668
|
* field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>
|
|
4092
4669
|
*/
|
|
4093
4670
|
SourceLastUpdatedTimestampFormat?: string;
|
|
4094
4671
|
/**
|
|
4672
|
+
* @public
|
|
4095
4673
|
* <p>A map of the name and ObjectType field.</p>
|
|
4096
4674
|
*/
|
|
4097
4675
|
Fields?: Record<string, ObjectTypeField>;
|
|
4098
4676
|
/**
|
|
4677
|
+
* @public
|
|
4099
4678
|
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
4100
4679
|
*/
|
|
4101
4680
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
4102
4681
|
/**
|
|
4682
|
+
* @public
|
|
4103
4683
|
* <p>The timestamp of when the domain was created.</p>
|
|
4104
4684
|
*/
|
|
4105
4685
|
CreatedAt?: Date;
|
|
4106
4686
|
/**
|
|
4687
|
+
* @public
|
|
4107
4688
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
4108
4689
|
*/
|
|
4109
4690
|
LastUpdatedAt?: Date;
|
|
4110
4691
|
/**
|
|
4692
|
+
* @public
|
|
4111
4693
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4112
4694
|
*/
|
|
4113
4695
|
Tags?: Record<string, string>;
|
|
@@ -4129,19 +4711,23 @@ export type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOpera
|
|
|
4129
4711
|
*/
|
|
4130
4712
|
export interface SearchProfilesRequest {
|
|
4131
4713
|
/**
|
|
4714
|
+
* @public
|
|
4132
4715
|
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
4133
4716
|
*/
|
|
4134
4717
|
NextToken?: string;
|
|
4135
4718
|
/**
|
|
4719
|
+
* @public
|
|
4136
4720
|
* <p>The maximum number of objects returned per page.</p>
|
|
4137
4721
|
* <p>The default is 20 if this parameter is not included in the request.</p>
|
|
4138
4722
|
*/
|
|
4139
4723
|
MaxResults?: number;
|
|
4140
4724
|
/**
|
|
4725
|
+
* @public
|
|
4141
4726
|
* <p>The unique name of the domain.</p>
|
|
4142
4727
|
*/
|
|
4143
4728
|
DomainName: string | undefined;
|
|
4144
4729
|
/**
|
|
4730
|
+
* @public
|
|
4145
4731
|
* <p>A searchable identifier of a customer profile. The predefined keys you can use
|
|
4146
4732
|
* to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone,
|
|
4147
4733
|
* _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,
|
|
@@ -4151,10 +4737,12 @@ export interface SearchProfilesRequest {
|
|
|
4151
4737
|
*/
|
|
4152
4738
|
KeyName: string | undefined;
|
|
4153
4739
|
/**
|
|
4740
|
+
* @public
|
|
4154
4741
|
* <p>A list of key values.</p>
|
|
4155
4742
|
*/
|
|
4156
4743
|
Values: string[] | undefined;
|
|
4157
4744
|
/**
|
|
4745
|
+
* @public
|
|
4158
4746
|
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers of a
|
|
4159
4747
|
* profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code> and a
|
|
4160
4748
|
* list of <code>Values</code> associated with that specific key (i.e., a key-value(s) pair).
|
|
@@ -4164,6 +4752,7 @@ export interface SearchProfilesRequest {
|
|
|
4164
4752
|
*/
|
|
4165
4753
|
AdditionalSearchKeys?: AdditionalSearchKey[];
|
|
4166
4754
|
/**
|
|
4755
|
+
* @public
|
|
4167
4756
|
* <p>Relationship between all specified search keys that will be used to search for
|
|
4168
4757
|
* profiles. This includes the required <code>KeyName</code> and <code>Values</code> parameters
|
|
4169
4758
|
* as well as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
|
|
@@ -4189,10 +4778,12 @@ export interface SearchProfilesRequest {
|
|
|
4189
4778
|
*/
|
|
4190
4779
|
export interface FoundByKeyValue {
|
|
4191
4780
|
/**
|
|
4781
|
+
* @public
|
|
4192
4782
|
* <p>A searchable identifier of a customer profile.</p>
|
|
4193
4783
|
*/
|
|
4194
4784
|
KeyName?: string;
|
|
4195
4785
|
/**
|
|
4786
|
+
* @public
|
|
4196
4787
|
* <p>A list of key values.</p>
|
|
4197
4788
|
*/
|
|
4198
4789
|
Values?: string[];
|
|
@@ -4203,101 +4794,124 @@ export interface FoundByKeyValue {
|
|
|
4203
4794
|
*/
|
|
4204
4795
|
export interface Profile {
|
|
4205
4796
|
/**
|
|
4797
|
+
* @public
|
|
4206
4798
|
* <p>The unique identifier of a customer profile.</p>
|
|
4207
4799
|
*/
|
|
4208
4800
|
ProfileId?: string;
|
|
4209
4801
|
/**
|
|
4802
|
+
* @public
|
|
4210
4803
|
* <p>A unique account number that you have given to the customer.</p>
|
|
4211
4804
|
*/
|
|
4212
4805
|
AccountNumber?: string;
|
|
4213
4806
|
/**
|
|
4807
|
+
* @public
|
|
4214
4808
|
* <p>Any additional information relevant to the customer’s profile.</p>
|
|
4215
4809
|
*/
|
|
4216
4810
|
AdditionalInformation?: string;
|
|
4217
4811
|
/**
|
|
4812
|
+
* @public
|
|
4218
4813
|
* @deprecated
|
|
4219
4814
|
*
|
|
4220
4815
|
* <p>The type of profile used to describe the customer.</p>
|
|
4221
4816
|
*/
|
|
4222
4817
|
PartyType?: PartyType | string;
|
|
4223
4818
|
/**
|
|
4819
|
+
* @public
|
|
4224
4820
|
* <p>The name of the customer’s business.</p>
|
|
4225
4821
|
*/
|
|
4226
4822
|
BusinessName?: string;
|
|
4227
4823
|
/**
|
|
4824
|
+
* @public
|
|
4228
4825
|
* <p>The customer’s first name.</p>
|
|
4229
4826
|
*/
|
|
4230
4827
|
FirstName?: string;
|
|
4231
4828
|
/**
|
|
4829
|
+
* @public
|
|
4232
4830
|
* <p>The customer’s middle name.</p>
|
|
4233
4831
|
*/
|
|
4234
4832
|
MiddleName?: string;
|
|
4235
4833
|
/**
|
|
4834
|
+
* @public
|
|
4236
4835
|
* <p>The customer’s last name.</p>
|
|
4237
4836
|
*/
|
|
4238
4837
|
LastName?: string;
|
|
4239
4838
|
/**
|
|
4839
|
+
* @public
|
|
4240
4840
|
* <p>The customer’s birth date. </p>
|
|
4241
4841
|
*/
|
|
4242
4842
|
BirthDate?: string;
|
|
4243
4843
|
/**
|
|
4844
|
+
* @public
|
|
4244
4845
|
* @deprecated
|
|
4245
4846
|
*
|
|
4246
4847
|
* <p>The gender with which the customer identifies. </p>
|
|
4247
4848
|
*/
|
|
4248
4849
|
Gender?: Gender | string;
|
|
4249
4850
|
/**
|
|
4851
|
+
* @public
|
|
4250
4852
|
* <p>The customer's phone number, which has not been specified as a mobile, home, or business
|
|
4251
4853
|
* number.</p>
|
|
4252
4854
|
*/
|
|
4253
4855
|
PhoneNumber?: string;
|
|
4254
4856
|
/**
|
|
4857
|
+
* @public
|
|
4255
4858
|
* <p>The customer’s mobile phone number.</p>
|
|
4256
4859
|
*/
|
|
4257
4860
|
MobilePhoneNumber?: string;
|
|
4258
4861
|
/**
|
|
4862
|
+
* @public
|
|
4259
4863
|
* <p>The customer’s home phone number.</p>
|
|
4260
4864
|
*/
|
|
4261
4865
|
HomePhoneNumber?: string;
|
|
4262
4866
|
/**
|
|
4867
|
+
* @public
|
|
4263
4868
|
* <p>The customer’s home phone number.</p>
|
|
4264
4869
|
*/
|
|
4265
4870
|
BusinessPhoneNumber?: string;
|
|
4266
4871
|
/**
|
|
4872
|
+
* @public
|
|
4267
4873
|
* <p>The customer’s email address, which has not been specified as a personal or business
|
|
4268
4874
|
* address. </p>
|
|
4269
4875
|
*/
|
|
4270
4876
|
EmailAddress?: string;
|
|
4271
4877
|
/**
|
|
4878
|
+
* @public
|
|
4272
4879
|
* <p>The customer’s personal email address.</p>
|
|
4273
4880
|
*/
|
|
4274
4881
|
PersonalEmailAddress?: string;
|
|
4275
4882
|
/**
|
|
4883
|
+
* @public
|
|
4276
4884
|
* <p>The customer’s business email address.</p>
|
|
4277
4885
|
*/
|
|
4278
4886
|
BusinessEmailAddress?: string;
|
|
4279
4887
|
/**
|
|
4888
|
+
* @public
|
|
4280
4889
|
* <p>A generic address associated with the customer that is not mailing, shipping, or
|
|
4281
4890
|
* billing.</p>
|
|
4282
4891
|
*/
|
|
4283
4892
|
Address?: Address;
|
|
4284
4893
|
/**
|
|
4894
|
+
* @public
|
|
4285
4895
|
* <p>The customer’s shipping address.</p>
|
|
4286
4896
|
*/
|
|
4287
4897
|
ShippingAddress?: Address;
|
|
4288
4898
|
/**
|
|
4899
|
+
* @public
|
|
4289
4900
|
* <p>The customer’s mailing address.</p>
|
|
4290
4901
|
*/
|
|
4291
4902
|
MailingAddress?: Address;
|
|
4292
4903
|
/**
|
|
4904
|
+
* @public
|
|
4293
4905
|
* <p>The customer’s billing address.</p>
|
|
4294
4906
|
*/
|
|
4295
4907
|
BillingAddress?: Address;
|
|
4296
4908
|
/**
|
|
4909
|
+
* @public
|
|
4297
4910
|
* <p>A key value pair of attributes of a customer profile.</p>
|
|
4298
4911
|
*/
|
|
4299
4912
|
Attributes?: Record<string, string>;
|
|
4300
4913
|
/**
|
|
4914
|
+
* @public
|
|
4301
4915
|
* <p>A list of items used to find a profile returned in a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> response.
|
|
4302
4916
|
* An item is a key-value(s) pair that matches an attribute in the profile.</p>
|
|
4303
4917
|
* <p>If the optional <code>AdditionalSearchKeys</code> parameter was included in the
|
|
@@ -4322,10 +4936,12 @@ export interface Profile {
|
|
|
4322
4936
|
*/
|
|
4323
4937
|
FoundByItems?: FoundByKeyValue[];
|
|
4324
4938
|
/**
|
|
4939
|
+
* @public
|
|
4325
4940
|
* <p>An alternative to PartyType which accepts any string as input.</p>
|
|
4326
4941
|
*/
|
|
4327
4942
|
PartyTypeString?: string;
|
|
4328
4943
|
/**
|
|
4944
|
+
* @public
|
|
4329
4945
|
* <p>An alternative to Gender which accepts any string as input.</p>
|
|
4330
4946
|
*/
|
|
4331
4947
|
GenderString?: string;
|
|
@@ -4335,10 +4951,12 @@ export interface Profile {
|
|
|
4335
4951
|
*/
|
|
4336
4952
|
export interface SearchProfilesResponse {
|
|
4337
4953
|
/**
|
|
4954
|
+
* @public
|
|
4338
4955
|
* <p>The list of Profiles matching the search criteria.</p>
|
|
4339
4956
|
*/
|
|
4340
4957
|
Items?: Profile[];
|
|
4341
4958
|
/**
|
|
4959
|
+
* @public
|
|
4342
4960
|
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
4343
4961
|
*/
|
|
4344
4962
|
NextToken?: string;
|
|
@@ -4348,10 +4966,12 @@ export interface SearchProfilesResponse {
|
|
|
4348
4966
|
*/
|
|
4349
4967
|
export interface TagResourceRequest {
|
|
4350
4968
|
/**
|
|
4969
|
+
* @public
|
|
4351
4970
|
* <p>The ARN of the resource that you're adding tags to.</p>
|
|
4352
4971
|
*/
|
|
4353
4972
|
resourceArn: string | undefined;
|
|
4354
4973
|
/**
|
|
4974
|
+
* @public
|
|
4355
4975
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4356
4976
|
*/
|
|
4357
4977
|
tags: Record<string, string> | undefined;
|
|
@@ -4366,10 +4986,12 @@ export interface TagResourceResponse {
|
|
|
4366
4986
|
*/
|
|
4367
4987
|
export interface UntagResourceRequest {
|
|
4368
4988
|
/**
|
|
4989
|
+
* @public
|
|
4369
4990
|
* <p>The ARN of the resource from which you are removing tags.</p>
|
|
4370
4991
|
*/
|
|
4371
4992
|
resourceArn: string | undefined;
|
|
4372
4993
|
/**
|
|
4994
|
+
* @public
|
|
4373
4995
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
4374
4996
|
*/
|
|
4375
4997
|
tagKeys: string[] | undefined;
|
|
@@ -4384,22 +5006,27 @@ export interface UntagResourceResponse {
|
|
|
4384
5006
|
*/
|
|
4385
5007
|
export interface UpdateCalculatedAttributeDefinitionRequest {
|
|
4386
5008
|
/**
|
|
5009
|
+
* @public
|
|
4387
5010
|
* <p>The unique name of the domain.</p>
|
|
4388
5011
|
*/
|
|
4389
5012
|
DomainName: string | undefined;
|
|
4390
5013
|
/**
|
|
5014
|
+
* @public
|
|
4391
5015
|
* <p>The unique name of the calculated attribute.</p>
|
|
4392
5016
|
*/
|
|
4393
5017
|
CalculatedAttributeName: string | undefined;
|
|
4394
5018
|
/**
|
|
5019
|
+
* @public
|
|
4395
5020
|
* <p>The display name of the calculated attribute.</p>
|
|
4396
5021
|
*/
|
|
4397
5022
|
DisplayName?: string;
|
|
4398
5023
|
/**
|
|
5024
|
+
* @public
|
|
4399
5025
|
* <p>The description of the calculated attribute.</p>
|
|
4400
5026
|
*/
|
|
4401
5027
|
Description?: string;
|
|
4402
5028
|
/**
|
|
5029
|
+
* @public
|
|
4403
5030
|
* <p>The conditions including range, object count, and threshold for the calculated attribute.</p>
|
|
4404
5031
|
*/
|
|
4405
5032
|
Conditions?: Conditions;
|
|
@@ -4409,38 +5036,47 @@ export interface UpdateCalculatedAttributeDefinitionRequest {
|
|
|
4409
5036
|
*/
|
|
4410
5037
|
export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
4411
5038
|
/**
|
|
5039
|
+
* @public
|
|
4412
5040
|
* <p>The unique name of the calculated attribute.</p>
|
|
4413
5041
|
*/
|
|
4414
5042
|
CalculatedAttributeName?: string;
|
|
4415
5043
|
/**
|
|
5044
|
+
* @public
|
|
4416
5045
|
* <p>The display name of the calculated attribute.</p>
|
|
4417
5046
|
*/
|
|
4418
5047
|
DisplayName?: string;
|
|
4419
5048
|
/**
|
|
5049
|
+
* @public
|
|
4420
5050
|
* <p>The description of the calculated attribute.</p>
|
|
4421
5051
|
*/
|
|
4422
5052
|
Description?: string;
|
|
4423
5053
|
/**
|
|
5054
|
+
* @public
|
|
4424
5055
|
* <p>The timestamp of when the calculated attribute definition was created.</p>
|
|
4425
5056
|
*/
|
|
4426
5057
|
CreatedAt?: Date;
|
|
4427
5058
|
/**
|
|
5059
|
+
* @public
|
|
4428
5060
|
* <p>The timestamp of when the calculated attribute definition was most recently edited.</p>
|
|
4429
5061
|
*/
|
|
4430
5062
|
LastUpdatedAt?: Date;
|
|
4431
5063
|
/**
|
|
5064
|
+
* @public
|
|
4432
5065
|
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
4433
5066
|
*/
|
|
4434
5067
|
Statistic?: Statistic | string;
|
|
4435
5068
|
/**
|
|
5069
|
+
* @public
|
|
4436
5070
|
* <p>The conditions including range, object count, and threshold for the calculated attribute.</p>
|
|
4437
5071
|
*/
|
|
4438
5072
|
Conditions?: Conditions;
|
|
4439
5073
|
/**
|
|
5074
|
+
* @public
|
|
4440
5075
|
* <p>The mathematical expression and a list of attribute items specified in that expression.</p>
|
|
4441
5076
|
*/
|
|
4442
5077
|
AttributeDetails?: AttributeDetails;
|
|
4443
5078
|
/**
|
|
5079
|
+
* @public
|
|
4444
5080
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4445
5081
|
*/
|
|
4446
5082
|
Tags?: Record<string, string>;
|
|
@@ -4450,14 +5086,17 @@ export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
|
4450
5086
|
*/
|
|
4451
5087
|
export interface UpdateDomainRequest {
|
|
4452
5088
|
/**
|
|
5089
|
+
* @public
|
|
4453
5090
|
* <p>The unique name of the domain.</p>
|
|
4454
5091
|
*/
|
|
4455
5092
|
DomainName: string | undefined;
|
|
4456
5093
|
/**
|
|
5094
|
+
* @public
|
|
4457
5095
|
* <p>The default number of days until the data within the domain expires.</p>
|
|
4458
5096
|
*/
|
|
4459
5097
|
DefaultExpirationDays?: number;
|
|
4460
5098
|
/**
|
|
5099
|
+
* @public
|
|
4461
5100
|
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
4462
5101
|
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
4463
5102
|
* permanent or semi-permanent storage. If specified as an empty string, it will clear any
|
|
@@ -4465,6 +5104,7 @@ export interface UpdateDomainRequest {
|
|
|
4465
5104
|
*/
|
|
4466
5105
|
DefaultEncryptionKey?: string;
|
|
4467
5106
|
/**
|
|
5107
|
+
* @public
|
|
4468
5108
|
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
4469
5109
|
* ingesting data from third party applications. If specified as an empty string, it will
|
|
4470
5110
|
* clear any existing value. You must set up a policy on the DeadLetterQueue for the
|
|
@@ -4473,6 +5113,7 @@ export interface UpdateDomainRequest {
|
|
|
4473
5113
|
*/
|
|
4474
5114
|
DeadLetterQueueUrl?: string;
|
|
4475
5115
|
/**
|
|
5116
|
+
* @public
|
|
4476
5117
|
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
4477
5118
|
* 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
|
|
4478
5119
|
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
@@ -4483,6 +5124,7 @@ export interface UpdateDomainRequest {
|
|
|
4483
5124
|
*/
|
|
4484
5125
|
Matching?: MatchingRequest;
|
|
4485
5126
|
/**
|
|
5127
|
+
* @public
|
|
4486
5128
|
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
4487
5129
|
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
4488
5130
|
* to match and merge your profiles according to your configuration in the
|
|
@@ -4493,6 +5135,7 @@ export interface UpdateDomainRequest {
|
|
|
4493
5135
|
*/
|
|
4494
5136
|
RuleBasedMatching?: RuleBasedMatchingRequest;
|
|
4495
5137
|
/**
|
|
5138
|
+
* @public
|
|
4496
5139
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4497
5140
|
*/
|
|
4498
5141
|
Tags?: Record<string, string>;
|
|
@@ -4502,25 +5145,30 @@ export interface UpdateDomainRequest {
|
|
|
4502
5145
|
*/
|
|
4503
5146
|
export interface UpdateDomainResponse {
|
|
4504
5147
|
/**
|
|
5148
|
+
* @public
|
|
4505
5149
|
* <p>The unique name of the domain.</p>
|
|
4506
5150
|
*/
|
|
4507
5151
|
DomainName: string | undefined;
|
|
4508
5152
|
/**
|
|
5153
|
+
* @public
|
|
4509
5154
|
* <p>The default number of days until the data within the domain expires.</p>
|
|
4510
5155
|
*/
|
|
4511
5156
|
DefaultExpirationDays?: number;
|
|
4512
5157
|
/**
|
|
5158
|
+
* @public
|
|
4513
5159
|
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
4514
5160
|
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
4515
5161
|
* permanent or semi-permanent storage.</p>
|
|
4516
5162
|
*/
|
|
4517
5163
|
DefaultEncryptionKey?: string;
|
|
4518
5164
|
/**
|
|
5165
|
+
* @public
|
|
4519
5166
|
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
4520
5167
|
* ingesting data from third party applications.</p>
|
|
4521
5168
|
*/
|
|
4522
5169
|
DeadLetterQueueUrl?: string;
|
|
4523
5170
|
/**
|
|
5171
|
+
* @public
|
|
4524
5172
|
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
4525
5173
|
* 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
|
|
4526
5174
|
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
@@ -4531,6 +5179,7 @@ export interface UpdateDomainResponse {
|
|
|
4531
5179
|
*/
|
|
4532
5180
|
Matching?: MatchingResponse;
|
|
4533
5181
|
/**
|
|
5182
|
+
* @public
|
|
4534
5183
|
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
4535
5184
|
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
4536
5185
|
* to match and merge your profiles according to your configuration in the
|
|
@@ -4541,14 +5190,17 @@ export interface UpdateDomainResponse {
|
|
|
4541
5190
|
*/
|
|
4542
5191
|
RuleBasedMatching?: RuleBasedMatchingResponse;
|
|
4543
5192
|
/**
|
|
5193
|
+
* @public
|
|
4544
5194
|
* <p>The timestamp of when the domain was created.</p>
|
|
4545
5195
|
*/
|
|
4546
5196
|
CreatedAt: Date | undefined;
|
|
4547
5197
|
/**
|
|
5198
|
+
* @public
|
|
4548
5199
|
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
4549
5200
|
*/
|
|
4550
5201
|
LastUpdatedAt: Date | undefined;
|
|
4551
5202
|
/**
|
|
5203
|
+
* @public
|
|
4552
5204
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4553
5205
|
*/
|
|
4554
5206
|
Tags?: Record<string, string>;
|
|
@@ -4559,42 +5211,52 @@ export interface UpdateDomainResponse {
|
|
|
4559
5211
|
*/
|
|
4560
5212
|
export interface UpdateAddress {
|
|
4561
5213
|
/**
|
|
5214
|
+
* @public
|
|
4562
5215
|
* <p>The first line of a customer address.</p>
|
|
4563
5216
|
*/
|
|
4564
5217
|
Address1?: string;
|
|
4565
5218
|
/**
|
|
5219
|
+
* @public
|
|
4566
5220
|
* <p>The second line of a customer address.</p>
|
|
4567
5221
|
*/
|
|
4568
5222
|
Address2?: string;
|
|
4569
5223
|
/**
|
|
5224
|
+
* @public
|
|
4570
5225
|
* <p>The third line of a customer address.</p>
|
|
4571
5226
|
*/
|
|
4572
5227
|
Address3?: string;
|
|
4573
5228
|
/**
|
|
5229
|
+
* @public
|
|
4574
5230
|
* <p>The fourth line of a customer address.</p>
|
|
4575
5231
|
*/
|
|
4576
5232
|
Address4?: string;
|
|
4577
5233
|
/**
|
|
5234
|
+
* @public
|
|
4578
5235
|
* <p>The city in which a customer lives.</p>
|
|
4579
5236
|
*/
|
|
4580
5237
|
City?: string;
|
|
4581
5238
|
/**
|
|
5239
|
+
* @public
|
|
4582
5240
|
* <p>The county in which a customer lives.</p>
|
|
4583
5241
|
*/
|
|
4584
5242
|
County?: string;
|
|
4585
5243
|
/**
|
|
5244
|
+
* @public
|
|
4586
5245
|
* <p>The state in which a customer lives.</p>
|
|
4587
5246
|
*/
|
|
4588
5247
|
State?: string;
|
|
4589
5248
|
/**
|
|
5249
|
+
* @public
|
|
4590
5250
|
* <p>The province in which a customer lives.</p>
|
|
4591
5251
|
*/
|
|
4592
5252
|
Province?: string;
|
|
4593
5253
|
/**
|
|
5254
|
+
* @public
|
|
4594
5255
|
* <p>The country in which a customer lives.</p>
|
|
4595
5256
|
*/
|
|
4596
5257
|
Country?: string;
|
|
4597
5258
|
/**
|
|
5259
|
+
* @public
|
|
4598
5260
|
* <p>The postal code of a customer address.</p>
|
|
4599
5261
|
*/
|
|
4600
5262
|
PostalCode?: string;
|
|
@@ -4604,109 +5266,134 @@ export interface UpdateAddress {
|
|
|
4604
5266
|
*/
|
|
4605
5267
|
export interface UpdateProfileRequest {
|
|
4606
5268
|
/**
|
|
5269
|
+
* @public
|
|
4607
5270
|
* <p>The unique name of the domain.</p>
|
|
4608
5271
|
*/
|
|
4609
5272
|
DomainName: string | undefined;
|
|
4610
5273
|
/**
|
|
5274
|
+
* @public
|
|
4611
5275
|
* <p>The unique identifier of a customer profile.</p>
|
|
4612
5276
|
*/
|
|
4613
5277
|
ProfileId: string | undefined;
|
|
4614
5278
|
/**
|
|
5279
|
+
* @public
|
|
4615
5280
|
* <p>Any additional information relevant to the customer’s profile.</p>
|
|
4616
5281
|
*/
|
|
4617
5282
|
AdditionalInformation?: string;
|
|
4618
5283
|
/**
|
|
5284
|
+
* @public
|
|
4619
5285
|
* <p>A unique account number that you have given to the customer.</p>
|
|
4620
5286
|
*/
|
|
4621
5287
|
AccountNumber?: string;
|
|
4622
5288
|
/**
|
|
5289
|
+
* @public
|
|
4623
5290
|
* @deprecated
|
|
4624
5291
|
*
|
|
4625
5292
|
* <p>The type of profile used to describe the customer.</p>
|
|
4626
5293
|
*/
|
|
4627
5294
|
PartyType?: PartyType | string;
|
|
4628
5295
|
/**
|
|
5296
|
+
* @public
|
|
4629
5297
|
* <p>The name of the customer’s business.</p>
|
|
4630
5298
|
*/
|
|
4631
5299
|
BusinessName?: string;
|
|
4632
5300
|
/**
|
|
5301
|
+
* @public
|
|
4633
5302
|
* <p>The customer’s first name.</p>
|
|
4634
5303
|
*/
|
|
4635
5304
|
FirstName?: string;
|
|
4636
5305
|
/**
|
|
5306
|
+
* @public
|
|
4637
5307
|
* <p>The customer’s middle name.</p>
|
|
4638
5308
|
*/
|
|
4639
5309
|
MiddleName?: string;
|
|
4640
5310
|
/**
|
|
5311
|
+
* @public
|
|
4641
5312
|
* <p>The customer’s last name.</p>
|
|
4642
5313
|
*/
|
|
4643
5314
|
LastName?: string;
|
|
4644
5315
|
/**
|
|
5316
|
+
* @public
|
|
4645
5317
|
* <p>The customer’s birth date. </p>
|
|
4646
5318
|
*/
|
|
4647
5319
|
BirthDate?: string;
|
|
4648
5320
|
/**
|
|
5321
|
+
* @public
|
|
4649
5322
|
* @deprecated
|
|
4650
5323
|
*
|
|
4651
5324
|
* <p>The gender with which the customer identifies. </p>
|
|
4652
5325
|
*/
|
|
4653
5326
|
Gender?: Gender | string;
|
|
4654
5327
|
/**
|
|
5328
|
+
* @public
|
|
4655
5329
|
* <p>The customer’s phone number, which has not been specified as a mobile, home, or business
|
|
4656
5330
|
* number. </p>
|
|
4657
5331
|
*/
|
|
4658
5332
|
PhoneNumber?: string;
|
|
4659
5333
|
/**
|
|
5334
|
+
* @public
|
|
4660
5335
|
* <p>The customer’s mobile phone number.</p>
|
|
4661
5336
|
*/
|
|
4662
5337
|
MobilePhoneNumber?: string;
|
|
4663
5338
|
/**
|
|
5339
|
+
* @public
|
|
4664
5340
|
* <p>The customer’s home phone number.</p>
|
|
4665
5341
|
*/
|
|
4666
5342
|
HomePhoneNumber?: string;
|
|
4667
5343
|
/**
|
|
5344
|
+
* @public
|
|
4668
5345
|
* <p>The customer’s business phone number.</p>
|
|
4669
5346
|
*/
|
|
4670
5347
|
BusinessPhoneNumber?: string;
|
|
4671
5348
|
/**
|
|
5349
|
+
* @public
|
|
4672
5350
|
* <p>The customer’s email address, which has not been specified as a personal or business
|
|
4673
5351
|
* address. </p>
|
|
4674
5352
|
*/
|
|
4675
5353
|
EmailAddress?: string;
|
|
4676
5354
|
/**
|
|
5355
|
+
* @public
|
|
4677
5356
|
* <p>The customer’s personal email address.</p>
|
|
4678
5357
|
*/
|
|
4679
5358
|
PersonalEmailAddress?: string;
|
|
4680
5359
|
/**
|
|
5360
|
+
* @public
|
|
4681
5361
|
* <p>The customer’s business email address.</p>
|
|
4682
5362
|
*/
|
|
4683
5363
|
BusinessEmailAddress?: string;
|
|
4684
5364
|
/**
|
|
5365
|
+
* @public
|
|
4685
5366
|
* <p>A generic address associated with the customer that is not mailing, shipping, or
|
|
4686
5367
|
* billing.</p>
|
|
4687
5368
|
*/
|
|
4688
5369
|
Address?: UpdateAddress;
|
|
4689
5370
|
/**
|
|
5371
|
+
* @public
|
|
4690
5372
|
* <p>The customer’s shipping address.</p>
|
|
4691
5373
|
*/
|
|
4692
5374
|
ShippingAddress?: UpdateAddress;
|
|
4693
5375
|
/**
|
|
5376
|
+
* @public
|
|
4694
5377
|
* <p>The customer’s mailing address.</p>
|
|
4695
5378
|
*/
|
|
4696
5379
|
MailingAddress?: UpdateAddress;
|
|
4697
5380
|
/**
|
|
5381
|
+
* @public
|
|
4698
5382
|
* <p>The customer’s billing address.</p>
|
|
4699
5383
|
*/
|
|
4700
5384
|
BillingAddress?: UpdateAddress;
|
|
4701
5385
|
/**
|
|
5386
|
+
* @public
|
|
4702
5387
|
* <p>A key value pair of attributes of a customer profile.</p>
|
|
4703
5388
|
*/
|
|
4704
5389
|
Attributes?: Record<string, string>;
|
|
4705
5390
|
/**
|
|
5391
|
+
* @public
|
|
4706
5392
|
* <p>An alternative to <code>PartyType</code> which accepts any string as input.</p>
|
|
4707
5393
|
*/
|
|
4708
5394
|
PartyTypeString?: string;
|
|
4709
5395
|
/**
|
|
5396
|
+
* @public
|
|
4710
5397
|
* <p>An alternative to <code>Gender</code> which accepts any string as input.</p>
|
|
4711
5398
|
*/
|
|
4712
5399
|
GenderString?: string;
|
|
@@ -4716,6 +5403,7 @@ export interface UpdateProfileRequest {
|
|
|
4716
5403
|
*/
|
|
4717
5404
|
export interface UpdateProfileResponse {
|
|
4718
5405
|
/**
|
|
5406
|
+
* @public
|
|
4719
5407
|
* <p>The unique identifier of a customer profile.</p>
|
|
4720
5408
|
*/
|
|
4721
5409
|
ProfileId: string | undefined;
|