@aws-sdk/client-customer-profiles 3.840.0 → 3.844.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/dist-cjs/index.js +393 -67
- package/dist-es/CustomerProfiles.js +12 -0
- package/dist-es/commands/CreateUploadJobCommand.js +23 -0
- package/dist-es/commands/GetUploadJobCommand.js +23 -0
- package/dist-es/commands/GetUploadJobPathCommand.js +22 -0
- package/dist-es/commands/ListUploadJobsCommand.js +22 -0
- package/dist-es/commands/StartUploadJobCommand.js +22 -0
- package/dist-es/commands/StopUploadJobCommand.js +22 -0
- package/dist-es/commands/UpdateCalculatedAttributeDefinitionCommand.js +1 -1
- package/dist-es/commands/UpdateDomainLayoutCommand.js +1 -1
- package/dist-es/commands/UpdateEventTriggerCommand.js +1 -1
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +20 -35
- package/dist-es/models/models_1.js +35 -0
- package/dist-es/pagination/ListUploadJobsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +184 -0
- package/dist-types/CustomerProfiles.d.ts +42 -0
- package/dist-types/CustomerProfilesClient.d.ts +8 -2
- package/dist-types/commands/CreateUploadJobCommand.d.ts +98 -0
- package/dist-types/commands/GetUploadJobCommand.d.ts +107 -0
- package/dist-types/commands/GetUploadJobPathCommand.d.ts +91 -0
- package/dist-types/commands/ListUploadJobsCommand.d.ts +100 -0
- package/dist-types/commands/StartUploadJobCommand.d.ts +87 -0
- package/dist-types/commands/StopUploadJobCommand.d.ts +86 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCalculatedAttributeDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDomainCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDomainLayoutCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEventTriggerCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +480 -660
- package/dist-types/models/models_1.d.ts +569 -1
- package/dist-types/pagination/ListUploadJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +102 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateUploadJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetUploadJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetUploadJobPathCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListUploadJobsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartUploadJobCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/StopUploadJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCalculatedAttributeDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainLayoutCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateEventTriggerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +95 -137
- package/dist-types/ts3.4/models/models_1.d.ts +147 -1
- package/dist-types/ts3.4/pagination/ListUploadJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +14 -14
|
@@ -1370,7 +1370,8 @@ export interface CalculatedAttributeValue {
|
|
|
1370
1370
|
*/
|
|
1371
1371
|
Value?: string | undefined;
|
|
1372
1372
|
/**
|
|
1373
|
-
* <p>The timestamp of the newest object included in the calculated attribute
|
|
1373
|
+
* <p>The timestamp of the newest object included in the calculated attribute
|
|
1374
|
+
* calculation.</p>
|
|
1374
1375
|
* @public
|
|
1375
1376
|
*/
|
|
1376
1377
|
LastObjectTimestamp?: Date | undefined;
|
|
@@ -1784,7 +1785,8 @@ export interface ListCalculatedAttributeForProfileItem {
|
|
|
1784
1785
|
*/
|
|
1785
1786
|
Value?: string | undefined;
|
|
1786
1787
|
/**
|
|
1787
|
-
* <p>The timestamp of the newest object included in the calculated attribute
|
|
1788
|
+
* <p>The timestamp of the newest object included in the calculated attribute
|
|
1789
|
+
* calculation.</p>
|
|
1788
1790
|
* @public
|
|
1789
1791
|
*/
|
|
1790
1792
|
LastObjectTimestamp?: Date | undefined;
|
|
@@ -2679,8 +2681,7 @@ export interface CreateDomainLayoutRequest {
|
|
|
2679
2681
|
*/
|
|
2680
2682
|
LayoutType: LayoutType | undefined;
|
|
2681
2683
|
/**
|
|
2682
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles
|
|
2683
|
-
* domain.</p>
|
|
2684
|
+
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
2684
2685
|
* @public
|
|
2685
2686
|
*/
|
|
2686
2687
|
Layout: string | undefined;
|
|
@@ -3680,6 +3681,89 @@ export interface CreateSegmentSnapshotResponse {
|
|
|
3680
3681
|
*/
|
|
3681
3682
|
SnapshotId: string | undefined;
|
|
3682
3683
|
}
|
|
3684
|
+
/**
|
|
3685
|
+
* @public
|
|
3686
|
+
* @enum
|
|
3687
|
+
*/
|
|
3688
|
+
export declare const FieldContentType: {
|
|
3689
|
+
readonly EMAIL_ADDRESS: "EMAIL_ADDRESS";
|
|
3690
|
+
readonly NAME: "NAME";
|
|
3691
|
+
readonly NUMBER: "NUMBER";
|
|
3692
|
+
readonly PHONE_NUMBER: "PHONE_NUMBER";
|
|
3693
|
+
readonly STRING: "STRING";
|
|
3694
|
+
};
|
|
3695
|
+
/**
|
|
3696
|
+
* @public
|
|
3697
|
+
*/
|
|
3698
|
+
export type FieldContentType = (typeof FieldContentType)[keyof typeof FieldContentType];
|
|
3699
|
+
/**
|
|
3700
|
+
* <p>Represents a field in a ProfileObjectType.</p>
|
|
3701
|
+
* @public
|
|
3702
|
+
*/
|
|
3703
|
+
export interface ObjectTypeField {
|
|
3704
|
+
/**
|
|
3705
|
+
* <p>A field of a ProfileObject. For example: _source.FirstName, where “_source” is a
|
|
3706
|
+
* ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.</p>
|
|
3707
|
+
* @public
|
|
3708
|
+
*/
|
|
3709
|
+
Source?: string | undefined;
|
|
3710
|
+
/**
|
|
3711
|
+
* <p>The location of the data in the standard ProfileObject model. For example:
|
|
3712
|
+
* _profile.Address.PostalCode.</p>
|
|
3713
|
+
* @public
|
|
3714
|
+
*/
|
|
3715
|
+
Target?: string | undefined;
|
|
3716
|
+
/**
|
|
3717
|
+
* <p>The content type of the field. Used for determining equality when searching.</p>
|
|
3718
|
+
* @public
|
|
3719
|
+
*/
|
|
3720
|
+
ContentType?: FieldContentType | undefined;
|
|
3721
|
+
}
|
|
3722
|
+
/**
|
|
3723
|
+
* @public
|
|
3724
|
+
*/
|
|
3725
|
+
export interface CreateUploadJobRequest {
|
|
3726
|
+
/**
|
|
3727
|
+
* <p>The unique name of the domain. Domain should be exists for the upload job to be created.
|
|
3728
|
+
* </p>
|
|
3729
|
+
* @public
|
|
3730
|
+
*/
|
|
3731
|
+
DomainName: string | undefined;
|
|
3732
|
+
/**
|
|
3733
|
+
* <p>The unique name of the upload job. Could be a file name to identify the upload
|
|
3734
|
+
* job.</p>
|
|
3735
|
+
* @public
|
|
3736
|
+
*/
|
|
3737
|
+
DisplayName: string | undefined;
|
|
3738
|
+
/**
|
|
3739
|
+
* <p>The mapping between CSV Columns and Profile Object attributes. A map of the name and
|
|
3740
|
+
* ObjectType field.</p>
|
|
3741
|
+
* @public
|
|
3742
|
+
*/
|
|
3743
|
+
Fields: Record<string, ObjectTypeField> | undefined;
|
|
3744
|
+
/**
|
|
3745
|
+
* <p>The unique key columns for de-duping the profiles used to map data to the profile.
|
|
3746
|
+
* </p>
|
|
3747
|
+
* @public
|
|
3748
|
+
*/
|
|
3749
|
+
UniqueKey: string | undefined;
|
|
3750
|
+
/**
|
|
3751
|
+
* <p>The expiry duration for the profiles ingested with the job. If not provided, the system
|
|
3752
|
+
* default of 2 weeks is used. </p>
|
|
3753
|
+
* @public
|
|
3754
|
+
*/
|
|
3755
|
+
DataExpiry?: number | undefined;
|
|
3756
|
+
}
|
|
3757
|
+
/**
|
|
3758
|
+
* @public
|
|
3759
|
+
*/
|
|
3760
|
+
export interface CreateUploadJobResponse {
|
|
3761
|
+
/**
|
|
3762
|
+
* <p>The unique identifier for the created upload job. </p>
|
|
3763
|
+
* @public
|
|
3764
|
+
*/
|
|
3765
|
+
JobId: string | undefined;
|
|
3766
|
+
}
|
|
3683
3767
|
/**
|
|
3684
3768
|
* @public
|
|
3685
3769
|
*/
|
|
@@ -3995,44 +4079,6 @@ export interface DetectProfileObjectTypeRequest {
|
|
|
3995
4079
|
*/
|
|
3996
4080
|
DomainName: string | undefined;
|
|
3997
4081
|
}
|
|
3998
|
-
/**
|
|
3999
|
-
* @public
|
|
4000
|
-
* @enum
|
|
4001
|
-
*/
|
|
4002
|
-
export declare const FieldContentType: {
|
|
4003
|
-
readonly EMAIL_ADDRESS: "EMAIL_ADDRESS";
|
|
4004
|
-
readonly NAME: "NAME";
|
|
4005
|
-
readonly NUMBER: "NUMBER";
|
|
4006
|
-
readonly PHONE_NUMBER: "PHONE_NUMBER";
|
|
4007
|
-
readonly STRING: "STRING";
|
|
4008
|
-
};
|
|
4009
|
-
/**
|
|
4010
|
-
* @public
|
|
4011
|
-
*/
|
|
4012
|
-
export type FieldContentType = (typeof FieldContentType)[keyof typeof FieldContentType];
|
|
4013
|
-
/**
|
|
4014
|
-
* <p>Represents a field in a ProfileObjectType.</p>
|
|
4015
|
-
* @public
|
|
4016
|
-
*/
|
|
4017
|
-
export interface ObjectTypeField {
|
|
4018
|
-
/**
|
|
4019
|
-
* <p>A field of a ProfileObject. For example: _source.FirstName, where “_source” is a
|
|
4020
|
-
* ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.</p>
|
|
4021
|
-
* @public
|
|
4022
|
-
*/
|
|
4023
|
-
Source?: string | undefined;
|
|
4024
|
-
/**
|
|
4025
|
-
* <p>The location of the data in the standard ProfileObject model. For example:
|
|
4026
|
-
* _profile.Address.PostalCode.</p>
|
|
4027
|
-
* @public
|
|
4028
|
-
*/
|
|
4029
|
-
Target?: string | undefined;
|
|
4030
|
-
/**
|
|
4031
|
-
* <p>The content type of the field. Used for determining equality when searching.</p>
|
|
4032
|
-
* @public
|
|
4033
|
-
*/
|
|
4034
|
-
ContentType?: FieldContentType | undefined;
|
|
4035
|
-
}
|
|
4036
4082
|
/**
|
|
4037
4083
|
* @public
|
|
4038
4084
|
* @enum
|
|
@@ -4308,7 +4354,8 @@ export interface GetCalculatedAttributeForProfileResponse {
|
|
|
4308
4354
|
*/
|
|
4309
4355
|
Value?: string | undefined;
|
|
4310
4356
|
/**
|
|
4311
|
-
* <p>The timestamp of the newest object included in the calculated attribute
|
|
4357
|
+
* <p>The timestamp of the newest object included in the calculated attribute
|
|
4358
|
+
* calculation.</p>
|
|
4312
4359
|
* @public
|
|
4313
4360
|
*/
|
|
4314
4361
|
LastObjectTimestamp?: Date | undefined;
|
|
@@ -4468,8 +4515,7 @@ export interface GetDomainLayoutResponse {
|
|
|
4468
4515
|
*/
|
|
4469
4516
|
LayoutType: LayoutType | undefined;
|
|
4470
4517
|
/**
|
|
4471
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles
|
|
4472
|
-
* domain.</p>
|
|
4518
|
+
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
4473
4519
|
* @public
|
|
4474
4520
|
*/
|
|
4475
4521
|
Layout: string | undefined;
|
|
@@ -5530,156 +5576,374 @@ export interface GetSimilarProfilesResponse {
|
|
|
5530
5576
|
/**
|
|
5531
5577
|
* @public
|
|
5532
5578
|
*/
|
|
5533
|
-
export interface
|
|
5579
|
+
export interface GetUploadJobRequest {
|
|
5534
5580
|
/**
|
|
5535
|
-
* <p>The unique name of the domain
|
|
5581
|
+
* <p>The unique name of the domain containing the upload job. </p>
|
|
5536
5582
|
* @public
|
|
5537
5583
|
*/
|
|
5538
5584
|
DomainName: string | undefined;
|
|
5539
5585
|
/**
|
|
5540
|
-
* <p>
|
|
5586
|
+
* <p>The unique identifier of the upload job to retrieve. </p>
|
|
5541
5587
|
* @public
|
|
5542
5588
|
*/
|
|
5543
|
-
|
|
5589
|
+
JobId: string | undefined;
|
|
5544
5590
|
}
|
|
5545
5591
|
/**
|
|
5546
|
-
* <p>
|
|
5592
|
+
* <p>The summary of results for an upload job, including the number of updated, created, and
|
|
5593
|
+
* failed records. </p>
|
|
5547
5594
|
* @public
|
|
5548
5595
|
*/
|
|
5549
|
-
export interface
|
|
5596
|
+
export interface ResultsSummary {
|
|
5550
5597
|
/**
|
|
5551
|
-
* <p>
|
|
5598
|
+
* <p>The number of records that were updated during the upload job. </p>
|
|
5552
5599
|
* @public
|
|
5553
5600
|
*/
|
|
5554
|
-
|
|
5555
|
-
}
|
|
5556
|
-
/**
|
|
5557
|
-
* <p>Generic object containing workflow execution metrics.</p>
|
|
5558
|
-
* @public
|
|
5559
|
-
*/
|
|
5560
|
-
export interface WorkflowMetrics {
|
|
5601
|
+
UpdatedRecords?: number | undefined;
|
|
5561
5602
|
/**
|
|
5562
|
-
* <p>
|
|
5603
|
+
* <p>The number of records that were newly created during the upload job. </p>
|
|
5563
5604
|
* @public
|
|
5564
5605
|
*/
|
|
5565
|
-
|
|
5606
|
+
CreatedRecords?: number | undefined;
|
|
5607
|
+
/**
|
|
5608
|
+
* <p>The number of records that failed to be processed during the upload job. </p>
|
|
5609
|
+
* @public
|
|
5610
|
+
*/
|
|
5611
|
+
FailedRecords?: number | undefined;
|
|
5566
5612
|
}
|
|
5567
5613
|
/**
|
|
5568
5614
|
* @public
|
|
5615
|
+
* @enum
|
|
5569
5616
|
*/
|
|
5570
|
-
export
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5575
|
-
|
|
5576
|
-
|
|
5577
|
-
|
|
5578
|
-
|
|
5579
|
-
|
|
5580
|
-
|
|
5617
|
+
export declare const UploadJobStatus: {
|
|
5618
|
+
readonly CREATED: "CREATED";
|
|
5619
|
+
readonly FAILED: "FAILED";
|
|
5620
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
5621
|
+
readonly PARTIALLY_SUCCEEDED: "PARTIALLY_SUCCEEDED";
|
|
5622
|
+
readonly STOPPED: "STOPPED";
|
|
5623
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
5624
|
+
};
|
|
5625
|
+
/**
|
|
5626
|
+
* @public
|
|
5627
|
+
*/
|
|
5628
|
+
export type UploadJobStatus = (typeof UploadJobStatus)[keyof typeof UploadJobStatus];
|
|
5629
|
+
/**
|
|
5630
|
+
* @public
|
|
5631
|
+
* @enum
|
|
5632
|
+
*/
|
|
5633
|
+
export declare const StatusReason: {
|
|
5634
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
5635
|
+
readonly VALIDATION_FAILURE: "VALIDATION_FAILURE";
|
|
5636
|
+
};
|
|
5637
|
+
/**
|
|
5638
|
+
* @public
|
|
5639
|
+
*/
|
|
5640
|
+
export type StatusReason = (typeof StatusReason)[keyof typeof StatusReason];
|
|
5641
|
+
/**
|
|
5642
|
+
* @public
|
|
5643
|
+
*/
|
|
5644
|
+
export interface GetUploadJobResponse {
|
|
5581
5645
|
/**
|
|
5582
|
-
* <p>
|
|
5646
|
+
* <p>The unique identifier of the upload job. </p>
|
|
5583
5647
|
* @public
|
|
5584
5648
|
*/
|
|
5585
|
-
|
|
5649
|
+
JobId?: string | undefined;
|
|
5586
5650
|
/**
|
|
5587
|
-
* <p>
|
|
5651
|
+
* <p>The unique name of the upload job. Could be a file name to identify the upload job.
|
|
5652
|
+
* </p>
|
|
5588
5653
|
* @public
|
|
5589
5654
|
*/
|
|
5590
|
-
|
|
5655
|
+
DisplayName?: string | undefined;
|
|
5591
5656
|
/**
|
|
5592
|
-
* <p>The
|
|
5657
|
+
* <p>The status describing the status for the upload job. The following are Valid Values: </p>
|
|
5658
|
+
* <ul>
|
|
5659
|
+
* <li>
|
|
5660
|
+
* <p>
|
|
5661
|
+
* <b>CREATED</b>: The upload job has been created, but has
|
|
5662
|
+
* not started processing yet. </p>
|
|
5663
|
+
* </li>
|
|
5664
|
+
* <li>
|
|
5665
|
+
* <p>
|
|
5666
|
+
* <b>IN_PROGRESS</b>: The upload job is currently in
|
|
5667
|
+
* progress, ingesting and processing the profile data. </p>
|
|
5668
|
+
* </li>
|
|
5669
|
+
* <li>
|
|
5670
|
+
* <p>
|
|
5671
|
+
* <b>PARTIALLY_SUCCEEDED</b>: The upload job has
|
|
5672
|
+
* successfully completed the ingestion and processing of all profile data. </p>
|
|
5673
|
+
* </li>
|
|
5674
|
+
* <li>
|
|
5675
|
+
* <p>
|
|
5676
|
+
* <b>SUCCEEDED</b>: The upload job has successfully
|
|
5677
|
+
* completed the ingestion and processing of all profile data. </p>
|
|
5678
|
+
* </li>
|
|
5679
|
+
* <li>
|
|
5680
|
+
* <p>
|
|
5681
|
+
* <b>FAILED</b>: The upload job has failed to complete.
|
|
5682
|
+
* </p>
|
|
5683
|
+
* </li>
|
|
5684
|
+
* <li>
|
|
5685
|
+
* <p>
|
|
5686
|
+
* <b>STOPPED</b>: The upload job has been manually stopped
|
|
5687
|
+
* or terminated before completion. </p>
|
|
5688
|
+
* </li>
|
|
5689
|
+
* </ul>
|
|
5593
5690
|
* @public
|
|
5594
5691
|
*/
|
|
5595
|
-
|
|
5692
|
+
Status?: UploadJobStatus | undefined;
|
|
5596
5693
|
/**
|
|
5597
|
-
* <p>The
|
|
5694
|
+
* <p>The reason for the current status of the upload job. Possible reasons: </p>
|
|
5695
|
+
* <ul>
|
|
5696
|
+
* <li>
|
|
5697
|
+
* <p>
|
|
5698
|
+
* <b>VALIDATION_FAILURE</b>: The upload job has
|
|
5699
|
+
* encountered an error or issue and was unable to complete the profile data ingestion.
|
|
5700
|
+
* </p>
|
|
5701
|
+
* </li>
|
|
5702
|
+
* <li>
|
|
5703
|
+
* <p>
|
|
5704
|
+
* <b>INTERNAL_FAILURE</b>: Failure caused from service
|
|
5705
|
+
* side </p>
|
|
5706
|
+
* </li>
|
|
5707
|
+
* </ul>
|
|
5598
5708
|
* @public
|
|
5599
5709
|
*/
|
|
5600
|
-
|
|
5710
|
+
StatusReason?: StatusReason | undefined;
|
|
5601
5711
|
/**
|
|
5602
|
-
* <p>
|
|
5712
|
+
* <p>The timestamp when the upload job was created. </p>
|
|
5603
5713
|
* @public
|
|
5604
5714
|
*/
|
|
5605
|
-
|
|
5715
|
+
CreatedAt?: Date | undefined;
|
|
5606
5716
|
/**
|
|
5607
|
-
* <p>
|
|
5717
|
+
* <p>The timestamp when the upload job was completed. </p>
|
|
5608
5718
|
* @public
|
|
5609
5719
|
*/
|
|
5610
|
-
|
|
5611
|
-
}
|
|
5612
|
-
/**
|
|
5613
|
-
* @public
|
|
5614
|
-
*/
|
|
5615
|
-
export interface GetWorkflowStepsRequest {
|
|
5720
|
+
CompletedAt?: Date | undefined;
|
|
5616
5721
|
/**
|
|
5617
|
-
* <p>The
|
|
5722
|
+
* <p>The mapping between CSV Columns and Profile Object attributes for the upload job.
|
|
5723
|
+
* </p>
|
|
5618
5724
|
* @public
|
|
5619
5725
|
*/
|
|
5620
|
-
|
|
5726
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
5621
5727
|
/**
|
|
5622
|
-
* <p>
|
|
5728
|
+
* <p>The unique key columns used for de-duping the keys in the upload job. </p>
|
|
5623
5729
|
* @public
|
|
5624
5730
|
*/
|
|
5625
|
-
|
|
5731
|
+
UniqueKey?: string | undefined;
|
|
5626
5732
|
/**
|
|
5627
|
-
* <p>The
|
|
5628
|
-
*
|
|
5733
|
+
* <p>The summary of results for the upload job, including the number of updated, created, and
|
|
5734
|
+
* failed records. </p>
|
|
5629
5735
|
* @public
|
|
5630
5736
|
*/
|
|
5631
|
-
|
|
5737
|
+
ResultsSummary?: ResultsSummary | undefined;
|
|
5632
5738
|
/**
|
|
5633
|
-
* <p>The
|
|
5739
|
+
* <p>The expiry duration for the profiles ingested with the upload job. </p>
|
|
5634
5740
|
* @public
|
|
5635
5741
|
*/
|
|
5636
|
-
|
|
5742
|
+
DataExpiry?: number | undefined;
|
|
5637
5743
|
}
|
|
5638
5744
|
/**
|
|
5639
|
-
* <p>List containing steps in workflow.</p>
|
|
5640
5745
|
* @public
|
|
5641
5746
|
*/
|
|
5642
|
-
export interface
|
|
5747
|
+
export interface GetUploadJobPathRequest {
|
|
5643
5748
|
/**
|
|
5644
|
-
* <p>
|
|
5749
|
+
* <p>The unique name of the domain containing the upload job. </p>
|
|
5645
5750
|
* @public
|
|
5646
5751
|
*/
|
|
5647
|
-
|
|
5752
|
+
DomainName: string | undefined;
|
|
5753
|
+
/**
|
|
5754
|
+
* <p>The unique identifier of the upload job to retrieve the upload path for. This is
|
|
5755
|
+
* generated from the CreateUploadJob API. </p>
|
|
5756
|
+
* @public
|
|
5757
|
+
*/
|
|
5758
|
+
JobId: string | undefined;
|
|
5648
5759
|
}
|
|
5649
5760
|
/**
|
|
5650
5761
|
* @public
|
|
5651
5762
|
*/
|
|
5652
|
-
export interface
|
|
5763
|
+
export interface GetUploadJobPathResponse {
|
|
5653
5764
|
/**
|
|
5654
|
-
* <p>
|
|
5655
|
-
* @public
|
|
5656
|
-
*/
|
|
5657
|
-
WorkflowId?: string | undefined;
|
|
5658
|
-
/**
|
|
5659
|
-
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
5765
|
+
* <p>The pre-signed S3 URL for uploading the CSV file associated with the upload job. </p>
|
|
5660
5766
|
* @public
|
|
5661
5767
|
*/
|
|
5662
|
-
|
|
5768
|
+
Url: string | undefined;
|
|
5663
5769
|
/**
|
|
5664
|
-
* <p>
|
|
5770
|
+
* <p>The plaintext data key used to encrypt the upload file. </p>
|
|
5771
|
+
* <p>To persist to the pre-signed url, use the client token and MD5 client token as header.
|
|
5772
|
+
* The required headers are as follows: </p>
|
|
5773
|
+
* <ul>
|
|
5774
|
+
* <li>
|
|
5775
|
+
* <p>x-amz-server-side-encryption-customer-key: Client Token </p>
|
|
5776
|
+
* </li>
|
|
5777
|
+
* <li>
|
|
5778
|
+
* <p>x-amz-server-side-encryption-customer-key-MD5: MD5 Client Token </p>
|
|
5779
|
+
* </li>
|
|
5780
|
+
* <li>
|
|
5781
|
+
* <p>x-amz-server-side-encryption-customer-algorithm: AES256 </p>
|
|
5782
|
+
* </li>
|
|
5783
|
+
* </ul>
|
|
5665
5784
|
* @public
|
|
5666
5785
|
*/
|
|
5667
|
-
|
|
5786
|
+
ClientToken?: string | undefined;
|
|
5668
5787
|
/**
|
|
5669
|
-
* <p>
|
|
5788
|
+
* <p>The expiry timestamp for the pre-signed URL, after which the URL will no longer be
|
|
5789
|
+
* valid. </p>
|
|
5670
5790
|
* @public
|
|
5671
5791
|
*/
|
|
5672
|
-
|
|
5792
|
+
ValidUntil?: Date | undefined;
|
|
5673
5793
|
}
|
|
5674
5794
|
/**
|
|
5675
5795
|
* @public
|
|
5676
5796
|
*/
|
|
5677
|
-
export interface
|
|
5797
|
+
export interface GetWorkflowRequest {
|
|
5678
5798
|
/**
|
|
5679
|
-
* <p>The
|
|
5799
|
+
* <p>The unique name of the domain.</p>
|
|
5680
5800
|
* @public
|
|
5681
5801
|
*/
|
|
5682
|
-
|
|
5802
|
+
DomainName: string | undefined;
|
|
5803
|
+
/**
|
|
5804
|
+
* <p>Unique identifier for the workflow.</p>
|
|
5805
|
+
* @public
|
|
5806
|
+
*/
|
|
5807
|
+
WorkflowId: string | undefined;
|
|
5808
|
+
}
|
|
5809
|
+
/**
|
|
5810
|
+
* <p>Structure to hold workflow attributes.</p>
|
|
5811
|
+
* @public
|
|
5812
|
+
*/
|
|
5813
|
+
export interface WorkflowAttributes {
|
|
5814
|
+
/**
|
|
5815
|
+
* <p>Workflow attributes specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
5816
|
+
* @public
|
|
5817
|
+
*/
|
|
5818
|
+
AppflowIntegration?: AppflowIntegrationWorkflowAttributes | undefined;
|
|
5819
|
+
}
|
|
5820
|
+
/**
|
|
5821
|
+
* <p>Generic object containing workflow execution metrics.</p>
|
|
5822
|
+
* @public
|
|
5823
|
+
*/
|
|
5824
|
+
export interface WorkflowMetrics {
|
|
5825
|
+
/**
|
|
5826
|
+
* <p>Workflow execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
5827
|
+
* @public
|
|
5828
|
+
*/
|
|
5829
|
+
AppflowIntegration?: AppflowIntegrationWorkflowMetrics | undefined;
|
|
5830
|
+
}
|
|
5831
|
+
/**
|
|
5832
|
+
* @public
|
|
5833
|
+
*/
|
|
5834
|
+
export interface GetWorkflowResponse {
|
|
5835
|
+
/**
|
|
5836
|
+
* <p>Unique identifier for the workflow.</p>
|
|
5837
|
+
* @public
|
|
5838
|
+
*/
|
|
5839
|
+
WorkflowId?: string | undefined;
|
|
5840
|
+
/**
|
|
5841
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
5842
|
+
* @public
|
|
5843
|
+
*/
|
|
5844
|
+
WorkflowType?: WorkflowType | undefined;
|
|
5845
|
+
/**
|
|
5846
|
+
* <p>Status of workflow execution.</p>
|
|
5847
|
+
* @public
|
|
5848
|
+
*/
|
|
5849
|
+
Status?: Status | undefined;
|
|
5850
|
+
/**
|
|
5851
|
+
* <p>Workflow error messages during execution (if any).</p>
|
|
5852
|
+
* @public
|
|
5853
|
+
*/
|
|
5854
|
+
ErrorDescription?: string | undefined;
|
|
5855
|
+
/**
|
|
5856
|
+
* <p>The timestamp that represents when workflow execution started.</p>
|
|
5857
|
+
* @public
|
|
5858
|
+
*/
|
|
5859
|
+
StartDate?: Date | undefined;
|
|
5860
|
+
/**
|
|
5861
|
+
* <p>The timestamp that represents when workflow execution last updated.</p>
|
|
5862
|
+
* @public
|
|
5863
|
+
*/
|
|
5864
|
+
LastUpdatedAt?: Date | undefined;
|
|
5865
|
+
/**
|
|
5866
|
+
* <p>Attributes provided for workflow execution.</p>
|
|
5867
|
+
* @public
|
|
5868
|
+
*/
|
|
5869
|
+
Attributes?: WorkflowAttributes | undefined;
|
|
5870
|
+
/**
|
|
5871
|
+
* <p>Workflow specific execution metrics.</p>
|
|
5872
|
+
* @public
|
|
5873
|
+
*/
|
|
5874
|
+
Metrics?: WorkflowMetrics | undefined;
|
|
5875
|
+
}
|
|
5876
|
+
/**
|
|
5877
|
+
* @public
|
|
5878
|
+
*/
|
|
5879
|
+
export interface GetWorkflowStepsRequest {
|
|
5880
|
+
/**
|
|
5881
|
+
* <p>The unique name of the domain.</p>
|
|
5882
|
+
* @public
|
|
5883
|
+
*/
|
|
5884
|
+
DomainName: string | undefined;
|
|
5885
|
+
/**
|
|
5886
|
+
* <p>Unique identifier for the workflow.</p>
|
|
5887
|
+
* @public
|
|
5888
|
+
*/
|
|
5889
|
+
WorkflowId: string | undefined;
|
|
5890
|
+
/**
|
|
5891
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5892
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
5893
|
+
* @public
|
|
5894
|
+
*/
|
|
5895
|
+
NextToken?: string | undefined;
|
|
5896
|
+
/**
|
|
5897
|
+
* <p>The maximum number of results to return per page.</p>
|
|
5898
|
+
* @public
|
|
5899
|
+
*/
|
|
5900
|
+
MaxResults?: number | undefined;
|
|
5901
|
+
}
|
|
5902
|
+
/**
|
|
5903
|
+
* <p>List containing steps in workflow.</p>
|
|
5904
|
+
* @public
|
|
5905
|
+
*/
|
|
5906
|
+
export interface WorkflowStepItem {
|
|
5907
|
+
/**
|
|
5908
|
+
* <p>Workflow step information specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
5909
|
+
* @public
|
|
5910
|
+
*/
|
|
5911
|
+
AppflowIntegration?: AppflowIntegrationWorkflowStep | undefined;
|
|
5912
|
+
}
|
|
5913
|
+
/**
|
|
5914
|
+
* @public
|
|
5915
|
+
*/
|
|
5916
|
+
export interface GetWorkflowStepsResponse {
|
|
5917
|
+
/**
|
|
5918
|
+
* <p>Unique identifier for the workflow.</p>
|
|
5919
|
+
* @public
|
|
5920
|
+
*/
|
|
5921
|
+
WorkflowId?: string | undefined;
|
|
5922
|
+
/**
|
|
5923
|
+
* <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
|
|
5924
|
+
* @public
|
|
5925
|
+
*/
|
|
5926
|
+
WorkflowType?: WorkflowType | undefined;
|
|
5927
|
+
/**
|
|
5928
|
+
* <p>List containing workflow step details.</p>
|
|
5929
|
+
* @public
|
|
5930
|
+
*/
|
|
5931
|
+
Items?: WorkflowStepItem[] | undefined;
|
|
5932
|
+
/**
|
|
5933
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5934
|
+
* @public
|
|
5935
|
+
*/
|
|
5936
|
+
NextToken?: string | undefined;
|
|
5937
|
+
}
|
|
5938
|
+
/**
|
|
5939
|
+
* @public
|
|
5940
|
+
*/
|
|
5941
|
+
export interface ListAccountIntegrationsRequest {
|
|
5942
|
+
/**
|
|
5943
|
+
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
5944
|
+
* @public
|
|
5945
|
+
*/
|
|
5946
|
+
Uri: string | undefined;
|
|
5683
5947
|
/**
|
|
5684
5948
|
* <p>The pagination token from the previous ListAccountIntegrations API call.</p>
|
|
5685
5949
|
* @public
|
|
@@ -6767,6 +7031,83 @@ export interface ListTagsForResourceResponse {
|
|
|
6767
7031
|
*/
|
|
6768
7032
|
tags?: Record<string, string> | undefined;
|
|
6769
7033
|
}
|
|
7034
|
+
/**
|
|
7035
|
+
* @public
|
|
7036
|
+
*/
|
|
7037
|
+
export interface ListUploadJobsRequest {
|
|
7038
|
+
/**
|
|
7039
|
+
* <p>The unique name of the domain to list upload jobs for. </p>
|
|
7040
|
+
* @public
|
|
7041
|
+
*/
|
|
7042
|
+
DomainName: string | undefined;
|
|
7043
|
+
/**
|
|
7044
|
+
* <p>The maximum number of upload jobs to return per page. </p>
|
|
7045
|
+
* @public
|
|
7046
|
+
*/
|
|
7047
|
+
MaxResults?: number | undefined;
|
|
7048
|
+
/**
|
|
7049
|
+
* <p>The pagination token from the previous call to retrieve the next page of results.
|
|
7050
|
+
* </p>
|
|
7051
|
+
* @public
|
|
7052
|
+
*/
|
|
7053
|
+
NextToken?: string | undefined;
|
|
7054
|
+
}
|
|
7055
|
+
/**
|
|
7056
|
+
* <p>The summary information for an individual upload job. </p>
|
|
7057
|
+
* @public
|
|
7058
|
+
*/
|
|
7059
|
+
export interface UploadJobItem {
|
|
7060
|
+
/**
|
|
7061
|
+
* <p>The unique identifier of the upload job. </p>
|
|
7062
|
+
* @public
|
|
7063
|
+
*/
|
|
7064
|
+
JobId?: string | undefined;
|
|
7065
|
+
/**
|
|
7066
|
+
* <p>The name of the upload job. </p>
|
|
7067
|
+
* @public
|
|
7068
|
+
*/
|
|
7069
|
+
DisplayName?: string | undefined;
|
|
7070
|
+
/**
|
|
7071
|
+
* <p>The current status of the upload job. </p>
|
|
7072
|
+
* @public
|
|
7073
|
+
*/
|
|
7074
|
+
Status?: UploadJobStatus | undefined;
|
|
7075
|
+
/**
|
|
7076
|
+
* <p>The reason for the current status of the upload job. </p>
|
|
7077
|
+
* @public
|
|
7078
|
+
*/
|
|
7079
|
+
StatusReason?: StatusReason | undefined;
|
|
7080
|
+
/**
|
|
7081
|
+
* <p>The timestamp when the upload job was created. </p>
|
|
7082
|
+
* @public
|
|
7083
|
+
*/
|
|
7084
|
+
CreatedAt?: Date | undefined;
|
|
7085
|
+
/**
|
|
7086
|
+
* <p>The timestamp when the upload job was completed. </p>
|
|
7087
|
+
* @public
|
|
7088
|
+
*/
|
|
7089
|
+
CompletedAt?: Date | undefined;
|
|
7090
|
+
/**
|
|
7091
|
+
* <p>The expiry duration for the profiles ingested with the upload job. </p>
|
|
7092
|
+
* @public
|
|
7093
|
+
*/
|
|
7094
|
+
DataExpiry?: number | undefined;
|
|
7095
|
+
}
|
|
7096
|
+
/**
|
|
7097
|
+
* @public
|
|
7098
|
+
*/
|
|
7099
|
+
export interface ListUploadJobsResponse {
|
|
7100
|
+
/**
|
|
7101
|
+
* <p>The pagination token to use to retrieve the next page of results. </p>
|
|
7102
|
+
* @public
|
|
7103
|
+
*/
|
|
7104
|
+
NextToken?: string | undefined;
|
|
7105
|
+
/**
|
|
7106
|
+
* <p>The list of upload jobs for the specified domain. </p>
|
|
7107
|
+
* @public
|
|
7108
|
+
*/
|
|
7109
|
+
Items?: UploadJobItem[] | undefined;
|
|
7110
|
+
}
|
|
6770
7111
|
/**
|
|
6771
7112
|
* @public
|
|
6772
7113
|
*/
|
|
@@ -7410,537 +7751,36 @@ export interface SearchProfilesResponse {
|
|
|
7410
7751
|
/**
|
|
7411
7752
|
* @public
|
|
7412
7753
|
*/
|
|
7413
|
-
export interface
|
|
7754
|
+
export interface StartUploadJobRequest {
|
|
7414
7755
|
/**
|
|
7415
|
-
* <p>The
|
|
7756
|
+
* <p>The unique name of the domain containing the upload job to start. </p>
|
|
7416
7757
|
* @public
|
|
7417
7758
|
*/
|
|
7418
|
-
|
|
7759
|
+
DomainName: string | undefined;
|
|
7419
7760
|
/**
|
|
7420
|
-
* <p>The
|
|
7761
|
+
* <p>The unique identifier of the upload job to start. </p>
|
|
7421
7762
|
* @public
|
|
7422
7763
|
*/
|
|
7423
|
-
|
|
7764
|
+
JobId: string | undefined;
|
|
7424
7765
|
}
|
|
7425
7766
|
/**
|
|
7426
|
-
* @
|
|
7767
|
+
* @internal
|
|
7427
7768
|
*/
|
|
7428
|
-
export
|
|
7429
|
-
}
|
|
7769
|
+
export declare const AddressFilterSensitiveLog: (obj: Address) => any;
|
|
7430
7770
|
/**
|
|
7431
|
-
* @
|
|
7771
|
+
* @internal
|
|
7432
7772
|
*/
|
|
7433
|
-
export
|
|
7434
|
-
/**
|
|
7435
|
-
* <p>The ARN of the resource from which you are removing tags.</p>
|
|
7436
|
-
* @public
|
|
7437
|
-
*/
|
|
7438
|
-
resourceArn: string | undefined;
|
|
7439
|
-
/**
|
|
7440
|
-
* <p>The list of tag keys to remove from the resource.</p>
|
|
7441
|
-
* @public
|
|
7442
|
-
*/
|
|
7443
|
-
tagKeys: string[] | undefined;
|
|
7444
|
-
}
|
|
7773
|
+
export declare const FlowDefinitionFilterSensitiveLog: (obj: FlowDefinition) => any;
|
|
7445
7774
|
/**
|
|
7446
|
-
* @
|
|
7775
|
+
* @internal
|
|
7447
7776
|
*/
|
|
7448
|
-
export
|
|
7449
|
-
}
|
|
7777
|
+
export declare const AppflowIntegrationFilterSensitiveLog: (obj: AppflowIntegration) => any;
|
|
7450
7778
|
/**
|
|
7451
|
-
* @
|
|
7779
|
+
* @internal
|
|
7452
7780
|
*/
|
|
7453
|
-
export
|
|
7454
|
-
/**
|
|
7455
|
-
* <p>The unique name of the domain.</p>
|
|
7456
|
-
* @public
|
|
7457
|
-
*/
|
|
7458
|
-
DomainName: string | undefined;
|
|
7459
|
-
/**
|
|
7460
|
-
* <p>The unique name of the calculated attribute.</p>
|
|
7461
|
-
* @public
|
|
7462
|
-
*/
|
|
7463
|
-
CalculatedAttributeName: string | undefined;
|
|
7464
|
-
/**
|
|
7465
|
-
* <p>The display name of the calculated attribute.</p>
|
|
7466
|
-
* @public
|
|
7467
|
-
*/
|
|
7468
|
-
DisplayName?: string | undefined;
|
|
7469
|
-
/**
|
|
7470
|
-
* <p>The description of the calculated attribute.</p>
|
|
7471
|
-
* @public
|
|
7472
|
-
*/
|
|
7473
|
-
Description?: string | undefined;
|
|
7474
|
-
/**
|
|
7475
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
7476
|
-
* attribute.</p>
|
|
7477
|
-
* @public
|
|
7478
|
-
*/
|
|
7479
|
-
Conditions?: Conditions | undefined;
|
|
7480
|
-
}
|
|
7781
|
+
export declare const AttributeDetailsFilterSensitiveLog: (obj: AttributeDetails) => any;
|
|
7481
7782
|
/**
|
|
7482
|
-
* @
|
|
7483
|
-
*/
|
|
7484
|
-
export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
7485
|
-
/**
|
|
7486
|
-
* <p>The unique name of the calculated attribute.</p>
|
|
7487
|
-
* @public
|
|
7488
|
-
*/
|
|
7489
|
-
CalculatedAttributeName?: string | undefined;
|
|
7490
|
-
/**
|
|
7491
|
-
* <p>The display name of the calculated attribute.</p>
|
|
7492
|
-
* @public
|
|
7493
|
-
*/
|
|
7494
|
-
DisplayName?: string | undefined;
|
|
7495
|
-
/**
|
|
7496
|
-
* <p>The description of the calculated attribute.</p>
|
|
7497
|
-
* @public
|
|
7498
|
-
*/
|
|
7499
|
-
Description?: string | undefined;
|
|
7500
|
-
/**
|
|
7501
|
-
* <p>The timestamp of when the calculated attribute definition was created.</p>
|
|
7502
|
-
* @public
|
|
7503
|
-
*/
|
|
7504
|
-
CreatedAt?: Date | undefined;
|
|
7505
|
-
/**
|
|
7506
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
7507
|
-
* edited.</p>
|
|
7508
|
-
* @public
|
|
7509
|
-
*/
|
|
7510
|
-
LastUpdatedAt?: Date | undefined;
|
|
7511
|
-
/**
|
|
7512
|
-
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
7513
|
-
* @public
|
|
7514
|
-
*/
|
|
7515
|
-
Statistic?: Statistic | undefined;
|
|
7516
|
-
/**
|
|
7517
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
7518
|
-
* attribute.</p>
|
|
7519
|
-
* @public
|
|
7520
|
-
*/
|
|
7521
|
-
Conditions?: Conditions | undefined;
|
|
7522
|
-
/**
|
|
7523
|
-
* <p>The mathematical expression and a list of attribute items specified in that
|
|
7524
|
-
* expression.</p>
|
|
7525
|
-
* @public
|
|
7526
|
-
*/
|
|
7527
|
-
AttributeDetails?: AttributeDetails | undefined;
|
|
7528
|
-
/**
|
|
7529
|
-
* <p>Whether historical data ingested before the Calculated Attribute was created should be
|
|
7530
|
-
* included in calculations.</p>
|
|
7531
|
-
* @public
|
|
7532
|
-
*/
|
|
7533
|
-
UseHistoricalData?: boolean | undefined;
|
|
7534
|
-
/**
|
|
7535
|
-
* <p>Status of the Calculated Attribute creation (whether all historical data has been
|
|
7536
|
-
* indexed.)</p>
|
|
7537
|
-
* @public
|
|
7538
|
-
*/
|
|
7539
|
-
Status?: ReadinessStatus | undefined;
|
|
7540
|
-
/**
|
|
7541
|
-
* <p>Information indicating if the Calculated Attribute is ready for use by confirming all
|
|
7542
|
-
* historical data has been processed and reflected.</p>
|
|
7543
|
-
* @public
|
|
7544
|
-
*/
|
|
7545
|
-
Readiness?: Readiness | undefined;
|
|
7546
|
-
/**
|
|
7547
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7548
|
-
* @public
|
|
7549
|
-
*/
|
|
7550
|
-
Tags?: Record<string, string> | undefined;
|
|
7551
|
-
}
|
|
7552
|
-
/**
|
|
7553
|
-
* @public
|
|
7554
|
-
*/
|
|
7555
|
-
export interface UpdateDomainRequest {
|
|
7556
|
-
/**
|
|
7557
|
-
* <p>The unique name of the domain.</p>
|
|
7558
|
-
* @public
|
|
7559
|
-
*/
|
|
7560
|
-
DomainName: string | undefined;
|
|
7561
|
-
/**
|
|
7562
|
-
* <p>The default number of days until the data within the domain expires.</p>
|
|
7563
|
-
* @public
|
|
7564
|
-
*/
|
|
7565
|
-
DefaultExpirationDays?: number | undefined;
|
|
7566
|
-
/**
|
|
7567
|
-
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
7568
|
-
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
7569
|
-
* permanent or semi-permanent storage. If specified as an empty string, it will clear any
|
|
7570
|
-
* existing value.</p>
|
|
7571
|
-
* @public
|
|
7572
|
-
*/
|
|
7573
|
-
DefaultEncryptionKey?: string | undefined;
|
|
7574
|
-
/**
|
|
7575
|
-
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
7576
|
-
* ingesting data from third party applications. If specified as an empty string, it will
|
|
7577
|
-
* clear any existing value. You must set up a policy on the DeadLetterQueue for the
|
|
7578
|
-
* SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the
|
|
7579
|
-
* DeadLetterQueue.</p>
|
|
7580
|
-
* @public
|
|
7581
|
-
*/
|
|
7582
|
-
DeadLetterQueueUrl?: string | undefined;
|
|
7583
|
-
/**
|
|
7584
|
-
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
7585
|
-
* 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
|
|
7586
|
-
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
7587
|
-
* <p>After the Identity Resolution Job completes, use the
|
|
7588
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
7589
|
-
* API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from
|
|
7590
|
-
* S3.</p>
|
|
7591
|
-
* @public
|
|
7592
|
-
*/
|
|
7593
|
-
Matching?: MatchingRequest | undefined;
|
|
7594
|
-
/**
|
|
7595
|
-
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
7596
|
-
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
7597
|
-
* to match and merge your profiles according to your configuration in the
|
|
7598
|
-
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
7599
|
-
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
7600
|
-
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
7601
|
-
* can download the results from S3.</p>
|
|
7602
|
-
* @public
|
|
7603
|
-
*/
|
|
7604
|
-
RuleBasedMatching?: RuleBasedMatchingRequest | undefined;
|
|
7605
|
-
/**
|
|
7606
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7607
|
-
* @public
|
|
7608
|
-
*/
|
|
7609
|
-
Tags?: Record<string, string> | undefined;
|
|
7610
|
-
}
|
|
7611
|
-
/**
|
|
7612
|
-
* @public
|
|
7613
|
-
*/
|
|
7614
|
-
export interface UpdateDomainResponse {
|
|
7615
|
-
/**
|
|
7616
|
-
* <p>The unique name of the domain.</p>
|
|
7617
|
-
* @public
|
|
7618
|
-
*/
|
|
7619
|
-
DomainName: string | undefined;
|
|
7620
|
-
/**
|
|
7621
|
-
* <p>The default number of days until the data within the domain expires.</p>
|
|
7622
|
-
* @public
|
|
7623
|
-
*/
|
|
7624
|
-
DefaultExpirationDays?: number | undefined;
|
|
7625
|
-
/**
|
|
7626
|
-
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
7627
|
-
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
7628
|
-
* permanent or semi-permanent storage.</p>
|
|
7629
|
-
* @public
|
|
7630
|
-
*/
|
|
7631
|
-
DefaultEncryptionKey?: string | undefined;
|
|
7632
|
-
/**
|
|
7633
|
-
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
7634
|
-
* ingesting data from third party applications.</p>
|
|
7635
|
-
* @public
|
|
7636
|
-
*/
|
|
7637
|
-
DeadLetterQueueUrl?: string | undefined;
|
|
7638
|
-
/**
|
|
7639
|
-
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
7640
|
-
* 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
|
|
7641
|
-
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
7642
|
-
* <p>After the Identity Resolution Job completes, use the
|
|
7643
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
7644
|
-
* API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from
|
|
7645
|
-
* S3.</p>
|
|
7646
|
-
* @public
|
|
7647
|
-
*/
|
|
7648
|
-
Matching?: MatchingResponse | undefined;
|
|
7649
|
-
/**
|
|
7650
|
-
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
7651
|
-
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
7652
|
-
* to match and merge your profiles according to your configuration in the
|
|
7653
|
-
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
7654
|
-
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
7655
|
-
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
7656
|
-
* can download the results from S3.</p>
|
|
7657
|
-
* @public
|
|
7658
|
-
*/
|
|
7659
|
-
RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
|
|
7660
|
-
/**
|
|
7661
|
-
* <p>The timestamp of when the domain was created.</p>
|
|
7662
|
-
* @public
|
|
7663
|
-
*/
|
|
7664
|
-
CreatedAt: Date | undefined;
|
|
7665
|
-
/**
|
|
7666
|
-
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
7667
|
-
* @public
|
|
7668
|
-
*/
|
|
7669
|
-
LastUpdatedAt: Date | undefined;
|
|
7670
|
-
/**
|
|
7671
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7672
|
-
* @public
|
|
7673
|
-
*/
|
|
7674
|
-
Tags?: Record<string, string> | undefined;
|
|
7675
|
-
}
|
|
7676
|
-
/**
|
|
7677
|
-
* @public
|
|
7678
|
-
*/
|
|
7679
|
-
export interface UpdateDomainLayoutRequest {
|
|
7680
|
-
/**
|
|
7681
|
-
* <p>The unique name of the domain.</p>
|
|
7682
|
-
* @public
|
|
7683
|
-
*/
|
|
7684
|
-
DomainName: string | undefined;
|
|
7685
|
-
/**
|
|
7686
|
-
* <p>The unique name of the layout.</p>
|
|
7687
|
-
* @public
|
|
7688
|
-
*/
|
|
7689
|
-
LayoutDefinitionName: string | undefined;
|
|
7690
|
-
/**
|
|
7691
|
-
* <p>The description of the layout</p>
|
|
7692
|
-
* @public
|
|
7693
|
-
*/
|
|
7694
|
-
Description?: string | undefined;
|
|
7695
|
-
/**
|
|
7696
|
-
* <p>The display name of the layout</p>
|
|
7697
|
-
* @public
|
|
7698
|
-
*/
|
|
7699
|
-
DisplayName?: string | undefined;
|
|
7700
|
-
/**
|
|
7701
|
-
* <p>If set to true for a layout, this layout will be used by default to view data. If set to
|
|
7702
|
-
* false, then the layout will not be used by default, but it can be used to view data by
|
|
7703
|
-
* explicitly selecting it in the console.</p>
|
|
7704
|
-
* @public
|
|
7705
|
-
*/
|
|
7706
|
-
IsDefault?: boolean | undefined;
|
|
7707
|
-
/**
|
|
7708
|
-
* <p>The type of layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7709
|
-
* @public
|
|
7710
|
-
*/
|
|
7711
|
-
LayoutType?: LayoutType | undefined;
|
|
7712
|
-
/**
|
|
7713
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles
|
|
7714
|
-
* domain.</p>
|
|
7715
|
-
* @public
|
|
7716
|
-
*/
|
|
7717
|
-
Layout?: string | undefined;
|
|
7718
|
-
}
|
|
7719
|
-
/**
|
|
7720
|
-
* @public
|
|
7721
|
-
*/
|
|
7722
|
-
export interface UpdateDomainLayoutResponse {
|
|
7723
|
-
/**
|
|
7724
|
-
* <p>The unique name of the layout.</p>
|
|
7725
|
-
* @public
|
|
7726
|
-
*/
|
|
7727
|
-
LayoutDefinitionName?: string | undefined;
|
|
7728
|
-
/**
|
|
7729
|
-
* <p>The description of the layout</p>
|
|
7730
|
-
* @public
|
|
7731
|
-
*/
|
|
7732
|
-
Description?: string | undefined;
|
|
7733
|
-
/**
|
|
7734
|
-
* <p>The display name of the layout</p>
|
|
7735
|
-
* @public
|
|
7736
|
-
*/
|
|
7737
|
-
DisplayName?: string | undefined;
|
|
7738
|
-
/**
|
|
7739
|
-
* <p>If set to true for a layout, this layout will be used by default to view data. If set to
|
|
7740
|
-
* false, then the layout will not be used by default, but it can be used to view data by
|
|
7741
|
-
* explicitly selecting it in the console.</p>
|
|
7742
|
-
* @public
|
|
7743
|
-
*/
|
|
7744
|
-
IsDefault?: boolean | undefined;
|
|
7745
|
-
/**
|
|
7746
|
-
* <p>The type of layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7747
|
-
* @public
|
|
7748
|
-
*/
|
|
7749
|
-
LayoutType?: LayoutType | undefined;
|
|
7750
|
-
/**
|
|
7751
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7752
|
-
* @public
|
|
7753
|
-
*/
|
|
7754
|
-
Layout?: string | undefined;
|
|
7755
|
-
/**
|
|
7756
|
-
* <p>The version used to create layout.</p>
|
|
7757
|
-
* @public
|
|
7758
|
-
*/
|
|
7759
|
-
Version?: string | undefined;
|
|
7760
|
-
/**
|
|
7761
|
-
* <p>The timestamp of when the layout was created.</p>
|
|
7762
|
-
* @public
|
|
7763
|
-
*/
|
|
7764
|
-
CreatedAt?: Date | undefined;
|
|
7765
|
-
/**
|
|
7766
|
-
* <p>The timestamp of when the layout was most recently updated.</p>
|
|
7767
|
-
* @public
|
|
7768
|
-
*/
|
|
7769
|
-
LastUpdatedAt?: Date | undefined;
|
|
7770
|
-
/**
|
|
7771
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7772
|
-
* @public
|
|
7773
|
-
*/
|
|
7774
|
-
Tags?: Record<string, string> | undefined;
|
|
7775
|
-
}
|
|
7776
|
-
/**
|
|
7777
|
-
* @public
|
|
7778
|
-
*/
|
|
7779
|
-
export interface UpdateEventTriggerRequest {
|
|
7780
|
-
/**
|
|
7781
|
-
* <p>The unique name of the domain.</p>
|
|
7782
|
-
* @public
|
|
7783
|
-
*/
|
|
7784
|
-
DomainName: string | undefined;
|
|
7785
|
-
/**
|
|
7786
|
-
* <p>The unique name of the event trigger.</p>
|
|
7787
|
-
* @public
|
|
7788
|
-
*/
|
|
7789
|
-
EventTriggerName: string | undefined;
|
|
7790
|
-
/**
|
|
7791
|
-
* <p>The unique name of the object type.</p>
|
|
7792
|
-
* @public
|
|
7793
|
-
*/
|
|
7794
|
-
ObjectTypeName?: string | undefined;
|
|
7795
|
-
/**
|
|
7796
|
-
* <p>The description of the event trigger.</p>
|
|
7797
|
-
* @public
|
|
7798
|
-
*/
|
|
7799
|
-
Description?: string | undefined;
|
|
7800
|
-
/**
|
|
7801
|
-
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
7802
|
-
* @public
|
|
7803
|
-
*/
|
|
7804
|
-
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
7805
|
-
/**
|
|
7806
|
-
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
7807
|
-
* definition.</p>
|
|
7808
|
-
* @public
|
|
7809
|
-
*/
|
|
7810
|
-
SegmentFilter?: string | undefined;
|
|
7811
|
-
/**
|
|
7812
|
-
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
7813
|
-
* latency and the number of invocations per profile over specific time periods.</p>
|
|
7814
|
-
* @public
|
|
7815
|
-
*/
|
|
7816
|
-
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
7817
|
-
}
|
|
7818
|
-
/**
|
|
7819
|
-
* @public
|
|
7820
|
-
*/
|
|
7821
|
-
export interface UpdateEventTriggerResponse {
|
|
7822
|
-
/**
|
|
7823
|
-
* <p>The unique name of the event trigger.</p>
|
|
7824
|
-
* @public
|
|
7825
|
-
*/
|
|
7826
|
-
EventTriggerName?: string | undefined;
|
|
7827
|
-
/**
|
|
7828
|
-
* <p>The unique name of the object type.</p>
|
|
7829
|
-
* @public
|
|
7830
|
-
*/
|
|
7831
|
-
ObjectTypeName?: string | undefined;
|
|
7832
|
-
/**
|
|
7833
|
-
* <p>The description of the event trigger.</p>
|
|
7834
|
-
* @public
|
|
7835
|
-
*/
|
|
7836
|
-
Description?: string | undefined;
|
|
7837
|
-
/**
|
|
7838
|
-
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
7839
|
-
* @public
|
|
7840
|
-
*/
|
|
7841
|
-
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
7842
|
-
/**
|
|
7843
|
-
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
7844
|
-
* definition.</p>
|
|
7845
|
-
* @public
|
|
7846
|
-
*/
|
|
7847
|
-
SegmentFilter?: string | undefined;
|
|
7848
|
-
/**
|
|
7849
|
-
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
7850
|
-
* latency and the number of invocations per profile over specific time periods.</p>
|
|
7851
|
-
* @public
|
|
7852
|
-
*/
|
|
7853
|
-
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
7854
|
-
/**
|
|
7855
|
-
* <p>The timestamp of when the event trigger was created.</p>
|
|
7856
|
-
* @public
|
|
7857
|
-
*/
|
|
7858
|
-
CreatedAt?: Date | undefined;
|
|
7859
|
-
/**
|
|
7860
|
-
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
7861
|
-
* @public
|
|
7862
|
-
*/
|
|
7863
|
-
LastUpdatedAt?: Date | undefined;
|
|
7864
|
-
/**
|
|
7865
|
-
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
7866
|
-
* @public
|
|
7867
|
-
*/
|
|
7868
|
-
Tags?: Record<string, string> | undefined;
|
|
7869
|
-
}
|
|
7870
|
-
/**
|
|
7871
|
-
* <p>Updates associated with the address properties of a customer profile.</p>
|
|
7872
|
-
* @public
|
|
7873
|
-
*/
|
|
7874
|
-
export interface UpdateAddress {
|
|
7875
|
-
/**
|
|
7876
|
-
* <p>The first line of a customer address.</p>
|
|
7877
|
-
* @public
|
|
7878
|
-
*/
|
|
7879
|
-
Address1?: string | undefined;
|
|
7880
|
-
/**
|
|
7881
|
-
* <p>The second line of a customer address.</p>
|
|
7882
|
-
* @public
|
|
7883
|
-
*/
|
|
7884
|
-
Address2?: string | undefined;
|
|
7885
|
-
/**
|
|
7886
|
-
* <p>The third line of a customer address.</p>
|
|
7887
|
-
* @public
|
|
7888
|
-
*/
|
|
7889
|
-
Address3?: string | undefined;
|
|
7890
|
-
/**
|
|
7891
|
-
* <p>The fourth line of a customer address.</p>
|
|
7892
|
-
* @public
|
|
7893
|
-
*/
|
|
7894
|
-
Address4?: string | undefined;
|
|
7895
|
-
/**
|
|
7896
|
-
* <p>The city in which a customer lives.</p>
|
|
7897
|
-
* @public
|
|
7898
|
-
*/
|
|
7899
|
-
City?: string | undefined;
|
|
7900
|
-
/**
|
|
7901
|
-
* <p>The county in which a customer lives.</p>
|
|
7902
|
-
* @public
|
|
7903
|
-
*/
|
|
7904
|
-
County?: string | undefined;
|
|
7905
|
-
/**
|
|
7906
|
-
* <p>The state in which a customer lives.</p>
|
|
7907
|
-
* @public
|
|
7908
|
-
*/
|
|
7909
|
-
State?: string | undefined;
|
|
7910
|
-
/**
|
|
7911
|
-
* <p>The province in which a customer lives.</p>
|
|
7912
|
-
* @public
|
|
7913
|
-
*/
|
|
7914
|
-
Province?: string | undefined;
|
|
7915
|
-
/**
|
|
7916
|
-
* <p>The country in which a customer lives.</p>
|
|
7917
|
-
* @public
|
|
7918
|
-
*/
|
|
7919
|
-
Country?: string | undefined;
|
|
7920
|
-
/**
|
|
7921
|
-
* <p>The postal code of a customer address.</p>
|
|
7922
|
-
* @public
|
|
7923
|
-
*/
|
|
7924
|
-
PostalCode?: string | undefined;
|
|
7925
|
-
}
|
|
7926
|
-
/**
|
|
7927
|
-
* @internal
|
|
7928
|
-
*/
|
|
7929
|
-
export declare const AddressFilterSensitiveLog: (obj: Address) => any;
|
|
7930
|
-
/**
|
|
7931
|
-
* @internal
|
|
7932
|
-
*/
|
|
7933
|
-
export declare const FlowDefinitionFilterSensitiveLog: (obj: FlowDefinition) => any;
|
|
7934
|
-
/**
|
|
7935
|
-
* @internal
|
|
7936
|
-
*/
|
|
7937
|
-
export declare const AppflowIntegrationFilterSensitiveLog: (obj: AppflowIntegration) => any;
|
|
7938
|
-
/**
|
|
7939
|
-
* @internal
|
|
7940
|
-
*/
|
|
7941
|
-
export declare const AttributeDetailsFilterSensitiveLog: (obj: AttributeDetails) => any;
|
|
7942
|
-
/**
|
|
7943
|
-
* @internal
|
|
7783
|
+
* @internal
|
|
7944
7784
|
*/
|
|
7945
7785
|
export declare const ConditionOverridesFilterSensitiveLog: (obj: ConditionOverrides) => any;
|
|
7946
7786
|
/**
|
|
@@ -8039,6 +7879,10 @@ export declare const SegmentGroupStructureFilterSensitiveLog: (obj: SegmentGroup
|
|
|
8039
7879
|
* @internal
|
|
8040
7880
|
*/
|
|
8041
7881
|
export declare const CreateSegmentEstimateRequestFilterSensitiveLog: (obj: CreateSegmentEstimateRequest) => any;
|
|
7882
|
+
/**
|
|
7883
|
+
* @internal
|
|
7884
|
+
*/
|
|
7885
|
+
export declare const CreateUploadJobRequestFilterSensitiveLog: (obj: CreateUploadJobRequest) => any;
|
|
8042
7886
|
/**
|
|
8043
7887
|
* @internal
|
|
8044
7888
|
*/
|
|
@@ -8083,6 +7927,10 @@ export declare const ProfileQueryResultFilterSensitiveLog: (obj: ProfileQueryRes
|
|
|
8083
7927
|
* @internal
|
|
8084
7928
|
*/
|
|
8085
7929
|
export declare const GetSegmentMembershipResponseFilterSensitiveLog: (obj: GetSegmentMembershipResponse) => any;
|
|
7930
|
+
/**
|
|
7931
|
+
* @internal
|
|
7932
|
+
*/
|
|
7933
|
+
export declare const GetUploadJobResponseFilterSensitiveLog: (obj: GetUploadJobResponse) => any;
|
|
8086
7934
|
/**
|
|
8087
7935
|
* @internal
|
|
8088
7936
|
*/
|
|
@@ -8139,31 +7987,3 @@ export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (obj: PutPr
|
|
|
8139
7987
|
* @internal
|
|
8140
7988
|
*/
|
|
8141
7989
|
export declare const SearchProfilesResponseFilterSensitiveLog: (obj: SearchProfilesResponse) => any;
|
|
8142
|
-
/**
|
|
8143
|
-
* @internal
|
|
8144
|
-
*/
|
|
8145
|
-
export declare const UpdateCalculatedAttributeDefinitionRequestFilterSensitiveLog: (obj: UpdateCalculatedAttributeDefinitionRequest) => any;
|
|
8146
|
-
/**
|
|
8147
|
-
* @internal
|
|
8148
|
-
*/
|
|
8149
|
-
export declare const UpdateCalculatedAttributeDefinitionResponseFilterSensitiveLog: (obj: UpdateCalculatedAttributeDefinitionResponse) => any;
|
|
8150
|
-
/**
|
|
8151
|
-
* @internal
|
|
8152
|
-
*/
|
|
8153
|
-
export declare const UpdateDomainLayoutRequestFilterSensitiveLog: (obj: UpdateDomainLayoutRequest) => any;
|
|
8154
|
-
/**
|
|
8155
|
-
* @internal
|
|
8156
|
-
*/
|
|
8157
|
-
export declare const UpdateDomainLayoutResponseFilterSensitiveLog: (obj: UpdateDomainLayoutResponse) => any;
|
|
8158
|
-
/**
|
|
8159
|
-
* @internal
|
|
8160
|
-
*/
|
|
8161
|
-
export declare const UpdateEventTriggerRequestFilterSensitiveLog: (obj: UpdateEventTriggerRequest) => any;
|
|
8162
|
-
/**
|
|
8163
|
-
* @internal
|
|
8164
|
-
*/
|
|
8165
|
-
export declare const UpdateEventTriggerResponseFilterSensitiveLog: (obj: UpdateEventTriggerResponse) => any;
|
|
8166
|
-
/**
|
|
8167
|
-
* @internal
|
|
8168
|
-
*/
|
|
8169
|
-
export declare const UpdateAddressFilterSensitiveLog: (obj: UpdateAddress) => any;
|