@aws-sdk/client-customer-profiles 3.1030.0 → 3.1032.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 +28 -0
- package/dist-cjs/index.js +76 -4
- package/dist-cjs/schemas/schemas_0.js +122 -24
- package/dist-es/CustomerProfiles.js +10 -0
- package/dist-es/commands/CreateRecommenderSchemaCommand.js +16 -0
- package/dist-es/commands/DeleteRecommenderSchemaCommand.js +16 -0
- package/dist-es/commands/GetRecommenderSchemaCommand.js +16 -0
- package/dist-es/commands/ListRecommenderSchemasCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +15 -4
- package/dist-es/pagination/ListRecommenderSchemasPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +113 -16
- package/dist-types/CustomerProfiles.d.ts +35 -0
- package/dist-types/CustomerProfilesClient.d.ts +6 -2
- package/dist-types/commands/CreateRecommenderCommand.d.ts +6 -0
- package/dist-types/commands/CreateRecommenderFilterCommand.d.ts +1 -0
- package/dist-types/commands/CreateRecommenderSchemaCommand.d.ts +117 -0
- package/dist-types/commands/DeleteRecommenderSchemaCommand.d.ts +88 -0
- package/dist-types/commands/GetRecommenderCommand.d.ts +11 -0
- package/dist-types/commands/GetRecommenderFilterCommand.d.ts +1 -0
- package/dist-types/commands/GetRecommenderSchemaCommand.d.ts +101 -0
- package/dist-types/commands/ListRecommenderFiltersCommand.d.ts +1 -0
- package/dist-types/commands/ListRecommenderSchemasCommand.d.ts +107 -0
- package/dist-types/commands/ListRecommendersCommand.d.ts +11 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListUploadJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListWorkflowsCommand.d.ts +1 -1
- package/dist-types/commands/MergeProfilesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +5 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +31 -12
- package/dist-types/models/models_0.d.ts +238 -338
- package/dist-types/models/models_1.d.ts +338 -1
- package/dist-types/pagination/ListRecommenderSchemasPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +14 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +75 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateRecommenderSchemaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommenderSchemaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommenderSchemaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommenderSchemasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListUploadJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/MergeProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +18 -5
- package/dist-types/ts3.4/models/models_0.d.ts +57 -76
- package/dist-types/ts3.4/models/models_1.d.ts +80 -0
- package/dist-types/ts3.4/pagination/ListRecommenderSchemasPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
- package/package.json +33 -33
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ActionType, AttributeDimensionType, AttributeMatchingModel, ComparisonOperator, ConflictResolvingModel, ContactType, ContentType, DataFormat, DataPullMode, DateDimensionType, EstimateStatus, EventStreamDestinationStatus, EventStreamState, EventTriggerLogicalOperator, FeatureType, FieldContentType, FilterDimensionType, Gender, IdentityResolutionJobStatus, Include, IncludeOptions, JobScheduleDayOfTheWeek, LayoutType, MarketoConnectorOperator, MatchType, Operator, OperatorPropertiesKeys, PartyType, PeriodUnit, ProfileType, ProfileTypeDimensionType, QueryResult, RangeUnit, ReadinessStatus, RecommenderFilterStatus, RecommenderRecipeName, RecommenderStatus, RuleBasedMatchingStatus, S3ConnectorOperator, SalesforceConnectorOperator, Scope, SegmentSnapshotStatus, SegmentSortDataType, SegmentSortOrder, SegmentType, ServiceNowConnectorOperator, SortAttributeType, SourceConnectorType, StandardIdentifier, Statistic, Status, StatusReason, StringDimensionType, TaskType, TrainingMetricName, TriggerType, Type, Unit, UploadJobStatus, WorkflowType, ZendeskConnectorOperator } from "./enums";
|
|
1
|
+
import type { ActionType, AttributeDimensionType, AttributeMatchingModel, ComparisonOperator, ConflictResolvingModel, ContactType, ContentType, DataFormat, DataPullMode, DateDimensionType, EstimateStatus, EventStreamDestinationStatus, EventStreamState, EventTriggerLogicalOperator, FeatureType, FieldContentType, FilterDimensionType, Gender, IdentityResolutionJobStatus, Include, IncludeOptions, JobScheduleDayOfTheWeek, LayoutType, MarketoConnectorOperator, MatchType, Operator, OperatorPropertiesKeys, PartyType, PeriodUnit, ProfileType, ProfileTypeDimensionType, QueryResult, RangeUnit, ReadinessStatus, RecommenderFilterStatus, RecommenderRecipeName, RecommenderSchemaStatus, RecommenderStatus, RuleBasedMatchingStatus, S3ConnectorOperator, SalesforceConnectorOperator, Scope, SegmentSnapshotStatus, SegmentSortDataType, SegmentSortOrder, SegmentType, ServiceNowConnectorOperator, SortAttributeType, SourceConnectorType, StandardIdentifier, Statistic, Status, StatusReason, StringDimensionType, TaskType, TrainingMetricName, TriggerType, Type, Unit, UploadJobStatus, WorkflowType, ZendeskConnectorOperator } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
|
|
4
4
|
* that is used in conjunction with the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName">KeyName</a> and <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values">Values</a> parameters to search for profiles using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a>
|
|
@@ -2845,6 +2845,11 @@ export interface RecommenderConfig {
|
|
|
2845
2845
|
* @public
|
|
2846
2846
|
*/
|
|
2847
2847
|
InferenceConfig?: InferenceConfig | undefined;
|
|
2848
|
+
/**
|
|
2849
|
+
* <p>A map of dataset type to a list of column names to train on. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included and do not need to be specified: <code>Item.Id</code>, <code>ItemList[].Id</code>, <code>EventTimestamp</code>, <code>EventType</code>, and <code>EventValue</code>.</p>
|
|
2850
|
+
* @public
|
|
2851
|
+
*/
|
|
2852
|
+
IncludedColumns?: Record<string, string[]> | undefined;
|
|
2848
2853
|
}
|
|
2849
2854
|
/**
|
|
2850
2855
|
* @public
|
|
@@ -2875,6 +2880,11 @@ export interface CreateRecommenderRequest {
|
|
|
2875
2880
|
* @public
|
|
2876
2881
|
*/
|
|
2877
2882
|
Description?: string | undefined;
|
|
2883
|
+
/**
|
|
2884
|
+
* <p>The name of the recommender schema to use for this recommender. If not specified, the default schema is used.</p>
|
|
2885
|
+
* @public
|
|
2886
|
+
*/
|
|
2887
|
+
RecommenderSchemaName?: string | undefined;
|
|
2878
2888
|
/**
|
|
2879
2889
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2880
2890
|
* @public
|
|
@@ -2915,6 +2925,11 @@ export interface CreateRecommenderFilterRequest {
|
|
|
2915
2925
|
* @public
|
|
2916
2926
|
*/
|
|
2917
2927
|
RecommenderFilterExpression: string | undefined;
|
|
2928
|
+
/**
|
|
2929
|
+
* <p>The name of the recommender schema to use for this recommender filter. If not specified, the default schema is used.</p>
|
|
2930
|
+
* @public
|
|
2931
|
+
*/
|
|
2932
|
+
RecommenderSchemaName?: string | undefined;
|
|
2918
2933
|
/**
|
|
2919
2934
|
* <p>A description of the recommender filter.</p>
|
|
2920
2935
|
* @public
|
|
@@ -2941,6 +2956,87 @@ export interface CreateRecommenderFilterResponse {
|
|
|
2941
2956
|
*/
|
|
2942
2957
|
Tags?: Record<string, string> | undefined;
|
|
2943
2958
|
}
|
|
2959
|
+
/**
|
|
2960
|
+
* <p>Defines a column in a recommender schema, including the target field name and optional feature and content type settings for training.</p>
|
|
2961
|
+
* @public
|
|
2962
|
+
*/
|
|
2963
|
+
export interface RecommenderSchemaField {
|
|
2964
|
+
/**
|
|
2965
|
+
* <p>The name of the target field in the dataset, such as <code>Location.City</code> or <code>Attributes.MealTime</code>.</p>
|
|
2966
|
+
* @public
|
|
2967
|
+
*/
|
|
2968
|
+
TargetFieldName: string | undefined;
|
|
2969
|
+
/**
|
|
2970
|
+
* <p>The data type of the column value. Valid values are <code>String</code> and <code>Number</code>. The default value is <code>String</code>.</p>
|
|
2971
|
+
* @public
|
|
2972
|
+
*/
|
|
2973
|
+
ContentType?: ContentType | undefined;
|
|
2974
|
+
/**
|
|
2975
|
+
* <p>How the column is treated for model training. Valid values are <code>CATEGORICAL</code> and <code>TEXTUAL</code>.</p>
|
|
2976
|
+
* @public
|
|
2977
|
+
*/
|
|
2978
|
+
FeatureType?: FeatureType | undefined;
|
|
2979
|
+
}
|
|
2980
|
+
/**
|
|
2981
|
+
* @public
|
|
2982
|
+
*/
|
|
2983
|
+
export interface CreateRecommenderSchemaRequest {
|
|
2984
|
+
/**
|
|
2985
|
+
* <p>The unique name of the domain.</p>
|
|
2986
|
+
* @public
|
|
2987
|
+
*/
|
|
2988
|
+
DomainName: string | undefined;
|
|
2989
|
+
/**
|
|
2990
|
+
* <p>The name of the recommender schema. The name must be unique within the domain.</p>
|
|
2991
|
+
* @public
|
|
2992
|
+
*/
|
|
2993
|
+
RecommenderSchemaName: string | undefined;
|
|
2994
|
+
/**
|
|
2995
|
+
* <p>A map of dataset type to column definitions that specifies which data columns to include in the schema. Currently only the <code>_webAnalytics</code> key is supported.</p>
|
|
2996
|
+
* @public
|
|
2997
|
+
*/
|
|
2998
|
+
Fields: Record<string, RecommenderSchemaField[]> | undefined;
|
|
2999
|
+
/**
|
|
3000
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3001
|
+
* @public
|
|
3002
|
+
*/
|
|
3003
|
+
Tags?: Record<string, string> | undefined;
|
|
3004
|
+
}
|
|
3005
|
+
/**
|
|
3006
|
+
* @public
|
|
3007
|
+
*/
|
|
3008
|
+
export interface CreateRecommenderSchemaResponse {
|
|
3009
|
+
/**
|
|
3010
|
+
* <p>The Amazon Resource Name (ARN) of the recommender schema.</p>
|
|
3011
|
+
* @public
|
|
3012
|
+
*/
|
|
3013
|
+
RecommenderSchemaArn: string | undefined;
|
|
3014
|
+
/**
|
|
3015
|
+
* <p>The name of the recommender schema.</p>
|
|
3016
|
+
* @public
|
|
3017
|
+
*/
|
|
3018
|
+
RecommenderSchemaName: string | undefined;
|
|
3019
|
+
/**
|
|
3020
|
+
* <p>A map of dataset type to column definitions included in the schema.</p>
|
|
3021
|
+
* @public
|
|
3022
|
+
*/
|
|
3023
|
+
Fields: Record<string, RecommenderSchemaField[]> | undefined;
|
|
3024
|
+
/**
|
|
3025
|
+
* <p>The timestamp of when the recommender schema was created.</p>
|
|
3026
|
+
* @public
|
|
3027
|
+
*/
|
|
3028
|
+
CreatedAt: Date | undefined;
|
|
3029
|
+
/**
|
|
3030
|
+
* <p>The status of the recommender schema.</p>
|
|
3031
|
+
* @public
|
|
3032
|
+
*/
|
|
3033
|
+
Status: RecommenderSchemaStatus | undefined;
|
|
3034
|
+
/**
|
|
3035
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3036
|
+
* @public
|
|
3037
|
+
*/
|
|
3038
|
+
Tags?: Record<string, string> | undefined;
|
|
3039
|
+
}
|
|
2944
3040
|
/**
|
|
2945
3041
|
* <p>Object that segments on various Customer profile's fields that are larger than
|
|
2946
3042
|
* normal.</p>
|
|
@@ -3441,7 +3537,7 @@ export interface ObjectTypeField {
|
|
|
3441
3537
|
Source?: string | undefined;
|
|
3442
3538
|
/**
|
|
3443
3539
|
* <p>The location of the data in the standard ProfileObject model. For example:
|
|
3444
|
-
* _profile.Address.PostalCode.</p>
|
|
3540
|
+
* _profile.Address.PostalCode. Do not include sensitive or personally identifiable information (PII) in the target field name.</p>
|
|
3445
3541
|
* @public
|
|
3446
3542
|
*/
|
|
3447
3543
|
Target?: string | undefined;
|
|
@@ -3816,6 +3912,26 @@ export interface DeleteRecommenderFilterResponse {
|
|
|
3816
3912
|
*/
|
|
3817
3913
|
Message: string | undefined;
|
|
3818
3914
|
}
|
|
3915
|
+
/**
|
|
3916
|
+
* @public
|
|
3917
|
+
*/
|
|
3918
|
+
export interface DeleteRecommenderSchemaRequest {
|
|
3919
|
+
/**
|
|
3920
|
+
* <p>The unique name of the domain.</p>
|
|
3921
|
+
* @public
|
|
3922
|
+
*/
|
|
3923
|
+
DomainName: string | undefined;
|
|
3924
|
+
/**
|
|
3925
|
+
* <p>The name of the recommender schema to delete.</p>
|
|
3926
|
+
* @public
|
|
3927
|
+
*/
|
|
3928
|
+
RecommenderSchemaName: string | undefined;
|
|
3929
|
+
}
|
|
3930
|
+
/**
|
|
3931
|
+
* @public
|
|
3932
|
+
*/
|
|
3933
|
+
export interface DeleteRecommenderSchemaResponse {
|
|
3934
|
+
}
|
|
3819
3935
|
/**
|
|
3820
3936
|
* @public
|
|
3821
3937
|
*/
|
|
@@ -5390,6 +5506,11 @@ export interface GetRecommenderResponse {
|
|
|
5390
5506
|
* @public
|
|
5391
5507
|
*/
|
|
5392
5508
|
RecommenderRecipeName: RecommenderRecipeName | undefined;
|
|
5509
|
+
/**
|
|
5510
|
+
* <p>The name of the recommender schema associated with this recommender.</p>
|
|
5511
|
+
* @public
|
|
5512
|
+
*/
|
|
5513
|
+
RecommenderSchemaName?: string | undefined;
|
|
5393
5514
|
/**
|
|
5394
5515
|
* <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
|
|
5395
5516
|
* @public
|
|
@@ -5465,6 +5586,11 @@ export interface GetRecommenderFilterResponse {
|
|
|
5465
5586
|
* @public
|
|
5466
5587
|
*/
|
|
5467
5588
|
RecommenderFilterExpression: string | undefined;
|
|
5589
|
+
/**
|
|
5590
|
+
* <p>The name of the recommender schema associated with this recommender filter.</p>
|
|
5591
|
+
* @public
|
|
5592
|
+
*/
|
|
5593
|
+
RecommenderSchemaName?: string | undefined;
|
|
5468
5594
|
/**
|
|
5469
5595
|
* <p>The timestamp of when the recommender filter was created.</p>
|
|
5470
5596
|
* @public
|
|
@@ -5491,6 +5617,46 @@ export interface GetRecommenderFilterResponse {
|
|
|
5491
5617
|
*/
|
|
5492
5618
|
Tags: Record<string, string> | undefined;
|
|
5493
5619
|
}
|
|
5620
|
+
/**
|
|
5621
|
+
* @public
|
|
5622
|
+
*/
|
|
5623
|
+
export interface GetRecommenderSchemaRequest {
|
|
5624
|
+
/**
|
|
5625
|
+
* <p>The unique name of the domain.</p>
|
|
5626
|
+
* @public
|
|
5627
|
+
*/
|
|
5628
|
+
DomainName: string | undefined;
|
|
5629
|
+
/**
|
|
5630
|
+
* <p>The name of the recommender schema to retrieve.</p>
|
|
5631
|
+
* @public
|
|
5632
|
+
*/
|
|
5633
|
+
RecommenderSchemaName: string | undefined;
|
|
5634
|
+
}
|
|
5635
|
+
/**
|
|
5636
|
+
* @public
|
|
5637
|
+
*/
|
|
5638
|
+
export interface GetRecommenderSchemaResponse {
|
|
5639
|
+
/**
|
|
5640
|
+
* <p>The name of the recommender schema.</p>
|
|
5641
|
+
* @public
|
|
5642
|
+
*/
|
|
5643
|
+
RecommenderSchemaName: string | undefined;
|
|
5644
|
+
/**
|
|
5645
|
+
* <p>A map of dataset type to column definitions included in the schema.</p>
|
|
5646
|
+
* @public
|
|
5647
|
+
*/
|
|
5648
|
+
Fields: Record<string, RecommenderSchemaField[]> | undefined;
|
|
5649
|
+
/**
|
|
5650
|
+
* <p>The timestamp of when the recommender schema was created.</p>
|
|
5651
|
+
* @public
|
|
5652
|
+
*/
|
|
5653
|
+
CreatedAt: Date | undefined;
|
|
5654
|
+
/**
|
|
5655
|
+
* <p>The status of the recommender schema.</p>
|
|
5656
|
+
* @public
|
|
5657
|
+
*/
|
|
5658
|
+
Status: RecommenderSchemaStatus | undefined;
|
|
5659
|
+
}
|
|
5494
5660
|
/**
|
|
5495
5661
|
* @public
|
|
5496
5662
|
*/
|
|
@@ -7409,6 +7575,11 @@ export interface RecommenderFilterSummary {
|
|
|
7409
7575
|
* @public
|
|
7410
7576
|
*/
|
|
7411
7577
|
RecommenderFilterName?: string | undefined;
|
|
7578
|
+
/**
|
|
7579
|
+
* <p>The name of the recommender schema associated with this recommender filter.</p>
|
|
7580
|
+
* @public
|
|
7581
|
+
*/
|
|
7582
|
+
RecommenderSchemaName?: string | undefined;
|
|
7412
7583
|
/**
|
|
7413
7584
|
* <p>The filter expression that defines which items to include or exclude from recommendations.</p>
|
|
7414
7585
|
* @public
|
|
@@ -7536,6 +7707,11 @@ export interface RecommenderSummary {
|
|
|
7536
7707
|
* @public
|
|
7537
7708
|
*/
|
|
7538
7709
|
RecipeName?: RecommenderRecipeName | undefined;
|
|
7710
|
+
/**
|
|
7711
|
+
* <p>The name of the recommender schema associated with this recommender.</p>
|
|
7712
|
+
* @public
|
|
7713
|
+
*/
|
|
7714
|
+
RecommenderSchemaName?: string | undefined;
|
|
7539
7715
|
/**
|
|
7540
7716
|
* <p>The configuration settings applied to this recommender.</p>
|
|
7541
7717
|
* @public
|
|
@@ -7595,463 +7771,187 @@ export interface ListRecommendersResponse {
|
|
|
7595
7771
|
/**
|
|
7596
7772
|
* @public
|
|
7597
7773
|
*/
|
|
7598
|
-
export interface
|
|
7599
|
-
/**
|
|
7600
|
-
* <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
|
|
7601
|
-
* call.</p>
|
|
7602
|
-
* @public
|
|
7603
|
-
*/
|
|
7604
|
-
NextToken?: string | undefined;
|
|
7605
|
-
/**
|
|
7606
|
-
* <p>The maximum number of <code>MatchIds</code> returned per page.</p>
|
|
7607
|
-
* @public
|
|
7608
|
-
*/
|
|
7609
|
-
MaxResults?: number | undefined;
|
|
7774
|
+
export interface ListRecommenderSchemasRequest {
|
|
7610
7775
|
/**
|
|
7611
7776
|
* <p>The unique name of the domain.</p>
|
|
7612
7777
|
* @public
|
|
7613
7778
|
*/
|
|
7614
7779
|
DomainName: string | undefined;
|
|
7615
|
-
}
|
|
7616
|
-
/**
|
|
7617
|
-
* @public
|
|
7618
|
-
*/
|
|
7619
|
-
export interface ListRuleBasedMatchesResponse {
|
|
7620
|
-
/**
|
|
7621
|
-
* <p>The list of <code>MatchIds</code> for the given domain.</p>
|
|
7622
|
-
* @public
|
|
7623
|
-
*/
|
|
7624
|
-
MatchIds?: string[] | undefined;
|
|
7625
7780
|
/**
|
|
7626
|
-
* <p>The
|
|
7627
|
-
* call.</p>
|
|
7628
|
-
* @public
|
|
7629
|
-
*/
|
|
7630
|
-
NextToken?: string | undefined;
|
|
7631
|
-
}
|
|
7632
|
-
/**
|
|
7633
|
-
* @public
|
|
7634
|
-
*/
|
|
7635
|
-
export interface ListSegmentDefinitionsRequest {
|
|
7636
|
-
/**
|
|
7637
|
-
* <p>The unique identifier of the domain.</p>
|
|
7638
|
-
* @public
|
|
7639
|
-
*/
|
|
7640
|
-
DomainName: string | undefined;
|
|
7641
|
-
/**
|
|
7642
|
-
* <p>The maximum number of objects returned per page.</p>
|
|
7781
|
+
* <p>The maximum number of recommender schemas to return in the response. The default value is 100.</p>
|
|
7643
7782
|
* @public
|
|
7644
7783
|
*/
|
|
7645
7784
|
MaxResults?: number | undefined;
|
|
7646
7785
|
/**
|
|
7647
|
-
* <p>
|
|
7786
|
+
* <p>A token received from a previous ListRecommenderSchemas call to retrieve the next page of results.</p>
|
|
7648
7787
|
* @public
|
|
7649
7788
|
*/
|
|
7650
7789
|
NextToken?: string | undefined;
|
|
7651
7790
|
}
|
|
7652
7791
|
/**
|
|
7653
|
-
* <p>
|
|
7792
|
+
* <p>Provides a summary of a recommender schema's configuration and current state.</p>
|
|
7654
7793
|
* @public
|
|
7655
7794
|
*/
|
|
7656
|
-
export interface
|
|
7657
|
-
/**
|
|
7658
|
-
* <p>Name of the segment definition.</p>
|
|
7659
|
-
* @public
|
|
7660
|
-
*/
|
|
7661
|
-
SegmentDefinitionName?: string | undefined;
|
|
7795
|
+
export interface RecommenderSchemaSummary {
|
|
7662
7796
|
/**
|
|
7663
|
-
* <p>
|
|
7797
|
+
* <p>The name of the recommender schema.</p>
|
|
7664
7798
|
* @public
|
|
7665
7799
|
*/
|
|
7666
|
-
|
|
7800
|
+
RecommenderSchemaName: string | undefined;
|
|
7667
7801
|
/**
|
|
7668
|
-
* <p>
|
|
7802
|
+
* <p>A map of dataset type to column definitions included in the schema.</p>
|
|
7669
7803
|
* @public
|
|
7670
7804
|
*/
|
|
7671
|
-
|
|
7805
|
+
Fields: Record<string, RecommenderSchemaField[]> | undefined;
|
|
7672
7806
|
/**
|
|
7673
|
-
* <p>The
|
|
7807
|
+
* <p>The timestamp when the recommender schema was created.</p>
|
|
7674
7808
|
* @public
|
|
7675
7809
|
*/
|
|
7676
|
-
|
|
7677
|
-
/**
|
|
7678
|
-
* <p>When the segment definition was created.</p>
|
|
7679
|
-
* @public
|
|
7680
|
-
*/
|
|
7681
|
-
CreatedAt?: Date | undefined;
|
|
7682
|
-
/**
|
|
7683
|
-
* <p>The tags belonging to the segment definition.</p>
|
|
7684
|
-
* @public
|
|
7685
|
-
*/
|
|
7686
|
-
Tags?: Record<string, string> | undefined;
|
|
7810
|
+
CreatedAt: Date | undefined;
|
|
7687
7811
|
/**
|
|
7688
|
-
* <p>The
|
|
7689
|
-
* <p> Classic : Segments created using traditional SegmentGroup structure</p>
|
|
7690
|
-
* <p> Enhanced : Segments created using SQL queries
|
|
7691
|
-
* </p>
|
|
7812
|
+
* <p>The current operational status of the recommender schema.</p>
|
|
7692
7813
|
* @public
|
|
7693
7814
|
*/
|
|
7694
|
-
|
|
7815
|
+
Status: RecommenderSchemaStatus | undefined;
|
|
7695
7816
|
}
|
|
7696
7817
|
/**
|
|
7697
7818
|
* @public
|
|
7698
7819
|
*/
|
|
7699
|
-
export interface
|
|
7820
|
+
export interface ListRecommenderSchemasResponse {
|
|
7700
7821
|
/**
|
|
7701
|
-
* <p>
|
|
7822
|
+
* <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
|
|
7702
7823
|
* @public
|
|
7703
7824
|
*/
|
|
7704
7825
|
NextToken?: string | undefined;
|
|
7705
7826
|
/**
|
|
7706
|
-
* <p>
|
|
7707
|
-
* @public
|
|
7708
|
-
*/
|
|
7709
|
-
Items?: SegmentDefinitionItem[] | undefined;
|
|
7710
|
-
}
|
|
7711
|
-
/**
|
|
7712
|
-
* @public
|
|
7713
|
-
*/
|
|
7714
|
-
export interface ListTagsForResourceRequest {
|
|
7715
|
-
/**
|
|
7716
|
-
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
7717
|
-
* @public
|
|
7718
|
-
*/
|
|
7719
|
-
resourceArn: string | undefined;
|
|
7720
|
-
}
|
|
7721
|
-
/**
|
|
7722
|
-
* @public
|
|
7723
|
-
*/
|
|
7724
|
-
export interface ListTagsForResourceResponse {
|
|
7725
|
-
/**
|
|
7726
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7827
|
+
* <p>A list of recommender schemas and their properties in the specified domain.</p>
|
|
7727
7828
|
* @public
|
|
7728
7829
|
*/
|
|
7729
|
-
|
|
7830
|
+
RecommenderSchemas?: RecommenderSchemaSummary[] | undefined;
|
|
7730
7831
|
}
|
|
7731
7832
|
/**
|
|
7732
7833
|
* @public
|
|
7733
7834
|
*/
|
|
7734
|
-
export interface
|
|
7835
|
+
export interface ListRuleBasedMatchesRequest {
|
|
7735
7836
|
/**
|
|
7736
|
-
* <p>The
|
|
7837
|
+
* <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
|
|
7838
|
+
* call.</p>
|
|
7737
7839
|
* @public
|
|
7738
7840
|
*/
|
|
7739
|
-
|
|
7841
|
+
NextToken?: string | undefined;
|
|
7740
7842
|
/**
|
|
7741
|
-
* <p>The maximum number of
|
|
7843
|
+
* <p>The maximum number of <code>MatchIds</code> returned per page.</p>
|
|
7742
7844
|
* @public
|
|
7743
7845
|
*/
|
|
7744
7846
|
MaxResults?: number | undefined;
|
|
7745
7847
|
/**
|
|
7746
|
-
* <p>The
|
|
7747
|
-
* </p>
|
|
7848
|
+
* <p>The unique name of the domain.</p>
|
|
7748
7849
|
* @public
|
|
7749
7850
|
*/
|
|
7750
|
-
|
|
7851
|
+
DomainName: string | undefined;
|
|
7751
7852
|
}
|
|
7752
7853
|
/**
|
|
7753
|
-
* <p>The summary information for an individual upload job. </p>
|
|
7754
7854
|
* @public
|
|
7755
7855
|
*/
|
|
7756
|
-
export interface
|
|
7757
|
-
/**
|
|
7758
|
-
* <p>The unique identifier of the upload job. </p>
|
|
7759
|
-
* @public
|
|
7760
|
-
*/
|
|
7761
|
-
JobId?: string | undefined;
|
|
7762
|
-
/**
|
|
7763
|
-
* <p>The name of the upload job. </p>
|
|
7764
|
-
* @public
|
|
7765
|
-
*/
|
|
7766
|
-
DisplayName?: string | undefined;
|
|
7767
|
-
/**
|
|
7768
|
-
* <p>The current status of the upload job. </p>
|
|
7769
|
-
* @public
|
|
7770
|
-
*/
|
|
7771
|
-
Status?: UploadJobStatus | undefined;
|
|
7772
|
-
/**
|
|
7773
|
-
* <p>The reason for the current status of the upload job. </p>
|
|
7774
|
-
* @public
|
|
7775
|
-
*/
|
|
7776
|
-
StatusReason?: StatusReason | undefined;
|
|
7777
|
-
/**
|
|
7778
|
-
* <p>The timestamp when the upload job was created. </p>
|
|
7779
|
-
* @public
|
|
7780
|
-
*/
|
|
7781
|
-
CreatedAt?: Date | undefined;
|
|
7782
|
-
/**
|
|
7783
|
-
* <p>The timestamp when the upload job was completed. </p>
|
|
7784
|
-
* @public
|
|
7785
|
-
*/
|
|
7786
|
-
CompletedAt?: Date | undefined;
|
|
7856
|
+
export interface ListRuleBasedMatchesResponse {
|
|
7787
7857
|
/**
|
|
7788
|
-
* <p>The
|
|
7858
|
+
* <p>The list of <code>MatchIds</code> for the given domain.</p>
|
|
7789
7859
|
* @public
|
|
7790
7860
|
*/
|
|
7791
|
-
|
|
7792
|
-
}
|
|
7793
|
-
/**
|
|
7794
|
-
* @public
|
|
7795
|
-
*/
|
|
7796
|
-
export interface ListUploadJobsResponse {
|
|
7861
|
+
MatchIds?: string[] | undefined;
|
|
7797
7862
|
/**
|
|
7798
|
-
* <p>The pagination token
|
|
7863
|
+
* <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
|
|
7864
|
+
* call.</p>
|
|
7799
7865
|
* @public
|
|
7800
7866
|
*/
|
|
7801
7867
|
NextToken?: string | undefined;
|
|
7802
|
-
/**
|
|
7803
|
-
* <p>The list of upload jobs for the specified domain. </p>
|
|
7804
|
-
* @public
|
|
7805
|
-
*/
|
|
7806
|
-
Items?: UploadJobItem[] | undefined;
|
|
7807
7868
|
}
|
|
7808
7869
|
/**
|
|
7809
7870
|
* @public
|
|
7810
7871
|
*/
|
|
7811
|
-
export interface
|
|
7872
|
+
export interface ListSegmentDefinitionsRequest {
|
|
7812
7873
|
/**
|
|
7813
|
-
* <p>The unique
|
|
7874
|
+
* <p>The unique identifier of the domain.</p>
|
|
7814
7875
|
* @public
|
|
7815
7876
|
*/
|
|
7816
7877
|
DomainName: string | undefined;
|
|
7817
7878
|
/**
|
|
7818
|
-
* <p>The
|
|
7819
|
-
* @public
|
|
7820
|
-
*/
|
|
7821
|
-
WorkflowType?: WorkflowType | undefined;
|
|
7822
|
-
/**
|
|
7823
|
-
* <p>Status of workflow execution.</p>
|
|
7824
|
-
* @public
|
|
7825
|
-
*/
|
|
7826
|
-
Status?: Status | undefined;
|
|
7827
|
-
/**
|
|
7828
|
-
* <p>Retrieve workflows started after timestamp.</p>
|
|
7829
|
-
* @public
|
|
7830
|
-
*/
|
|
7831
|
-
QueryStartDate?: Date | undefined;
|
|
7832
|
-
/**
|
|
7833
|
-
* <p>Retrieve workflows ended after timestamp.</p>
|
|
7834
|
-
* @public
|
|
7835
|
-
*/
|
|
7836
|
-
QueryEndDate?: Date | undefined;
|
|
7837
|
-
/**
|
|
7838
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7839
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7840
|
-
* @public
|
|
7841
|
-
*/
|
|
7842
|
-
NextToken?: string | undefined;
|
|
7843
|
-
/**
|
|
7844
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7879
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
7845
7880
|
* @public
|
|
7846
7881
|
*/
|
|
7847
7882
|
MaxResults?: number | undefined;
|
|
7848
|
-
}
|
|
7849
|
-
/**
|
|
7850
|
-
* <p>A workflow in list of workflows.</p>
|
|
7851
|
-
* @public
|
|
7852
|
-
*/
|
|
7853
|
-
export interface ListWorkflowsItem {
|
|
7854
7883
|
/**
|
|
7855
|
-
* <p>The
|
|
7856
|
-
* @public
|
|
7857
|
-
*/
|
|
7858
|
-
WorkflowType: WorkflowType | undefined;
|
|
7859
|
-
/**
|
|
7860
|
-
* <p>Unique identifier for the workflow.</p>
|
|
7861
|
-
* @public
|
|
7862
|
-
*/
|
|
7863
|
-
WorkflowId: string | undefined;
|
|
7864
|
-
/**
|
|
7865
|
-
* <p>Status of workflow execution.</p>
|
|
7866
|
-
* @public
|
|
7867
|
-
*/
|
|
7868
|
-
Status: Status | undefined;
|
|
7869
|
-
/**
|
|
7870
|
-
* <p>Description for workflow execution status.</p>
|
|
7871
|
-
* @public
|
|
7872
|
-
*/
|
|
7873
|
-
StatusDescription: string | undefined;
|
|
7874
|
-
/**
|
|
7875
|
-
* <p>Creation timestamp for workflow.</p>
|
|
7876
|
-
* @public
|
|
7877
|
-
*/
|
|
7878
|
-
CreatedAt: Date | undefined;
|
|
7879
|
-
/**
|
|
7880
|
-
* <p>Last updated timestamp for workflow.</p>
|
|
7881
|
-
* @public
|
|
7882
|
-
*/
|
|
7883
|
-
LastUpdatedAt: Date | undefined;
|
|
7884
|
-
}
|
|
7885
|
-
/**
|
|
7886
|
-
* @public
|
|
7887
|
-
*/
|
|
7888
|
-
export interface ListWorkflowsResponse {
|
|
7889
|
-
/**
|
|
7890
|
-
* <p>List containing workflow details.</p>
|
|
7891
|
-
* @public
|
|
7892
|
-
*/
|
|
7893
|
-
Items?: ListWorkflowsItem[] | undefined;
|
|
7894
|
-
/**
|
|
7895
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7884
|
+
* <p>The pagination token from the previous call. </p>
|
|
7896
7885
|
* @public
|
|
7897
7886
|
*/
|
|
7898
7887
|
NextToken?: string | undefined;
|
|
7899
7888
|
}
|
|
7900
7889
|
/**
|
|
7901
|
-
* <p>
|
|
7890
|
+
* <p>Object holding the segment definition fields.</p>
|
|
7902
7891
|
* @public
|
|
7903
7892
|
*/
|
|
7904
|
-
export interface
|
|
7905
|
-
/**
|
|
7906
|
-
* <p>A unique identifier for the account number field to be merged. </p>
|
|
7907
|
-
* @public
|
|
7908
|
-
*/
|
|
7909
|
-
AccountNumber?: string | undefined;
|
|
7910
|
-
/**
|
|
7911
|
-
* <p>A unique identifier for the additional information field to be merged.</p>
|
|
7912
|
-
* @public
|
|
7913
|
-
*/
|
|
7914
|
-
AdditionalInformation?: string | undefined;
|
|
7915
|
-
/**
|
|
7916
|
-
* <p>A unique identifier for the party type field to be merged.</p>
|
|
7917
|
-
* @public
|
|
7918
|
-
*/
|
|
7919
|
-
PartyType?: string | undefined;
|
|
7920
|
-
/**
|
|
7921
|
-
* <p>A unique identifier for the business name field to be merged.</p>
|
|
7922
|
-
* @public
|
|
7923
|
-
*/
|
|
7924
|
-
BusinessName?: string | undefined;
|
|
7925
|
-
/**
|
|
7926
|
-
* <p>A unique identifier for the first name field to be merged.</p>
|
|
7927
|
-
* @public
|
|
7928
|
-
*/
|
|
7929
|
-
FirstName?: string | undefined;
|
|
7930
|
-
/**
|
|
7931
|
-
* <p>A unique identifier for the middle name field to be merged.</p>
|
|
7932
|
-
* @public
|
|
7933
|
-
*/
|
|
7934
|
-
MiddleName?: string | undefined;
|
|
7935
|
-
/**
|
|
7936
|
-
* <p>A unique identifier for the last name field to be merged.</p>
|
|
7937
|
-
* @public
|
|
7938
|
-
*/
|
|
7939
|
-
LastName?: string | undefined;
|
|
7940
|
-
/**
|
|
7941
|
-
* <p>A unique identifier for the birthdate field to be merged.</p>
|
|
7942
|
-
* @public
|
|
7943
|
-
*/
|
|
7944
|
-
BirthDate?: string | undefined;
|
|
7945
|
-
/**
|
|
7946
|
-
* <p>A unique identifier for the gender field to be merged.</p>
|
|
7947
|
-
* @public
|
|
7948
|
-
*/
|
|
7949
|
-
Gender?: string | undefined;
|
|
7950
|
-
/**
|
|
7951
|
-
* <p>A unique identifier for the phone number field to be merged.</p>
|
|
7952
|
-
* @public
|
|
7953
|
-
*/
|
|
7954
|
-
PhoneNumber?: string | undefined;
|
|
7955
|
-
/**
|
|
7956
|
-
* <p>A unique identifier for the mobile phone number field to be merged.</p>
|
|
7957
|
-
* @public
|
|
7958
|
-
*/
|
|
7959
|
-
MobilePhoneNumber?: string | undefined;
|
|
7960
|
-
/**
|
|
7961
|
-
* <p>A unique identifier for the home phone number field to be merged.</p>
|
|
7962
|
-
* @public
|
|
7963
|
-
*/
|
|
7964
|
-
HomePhoneNumber?: string | undefined;
|
|
7965
|
-
/**
|
|
7966
|
-
* <p>A unique identifier for the business phone number field to be merged.</p>
|
|
7967
|
-
* @public
|
|
7968
|
-
*/
|
|
7969
|
-
BusinessPhoneNumber?: string | undefined;
|
|
7970
|
-
/**
|
|
7971
|
-
* <p>A unique identifier for the email address field to be merged.</p>
|
|
7972
|
-
* @public
|
|
7973
|
-
*/
|
|
7974
|
-
EmailAddress?: string | undefined;
|
|
7975
|
-
/**
|
|
7976
|
-
* <p>A unique identifier for the personal email address field to be merged.</p>
|
|
7977
|
-
* @public
|
|
7978
|
-
*/
|
|
7979
|
-
PersonalEmailAddress?: string | undefined;
|
|
7980
|
-
/**
|
|
7981
|
-
* <p>A unique identifier for the party type field to be merged.</p>
|
|
7982
|
-
* @public
|
|
7983
|
-
*/
|
|
7984
|
-
BusinessEmailAddress?: string | undefined;
|
|
7893
|
+
export interface SegmentDefinitionItem {
|
|
7985
7894
|
/**
|
|
7986
|
-
* <p>
|
|
7895
|
+
* <p>Name of the segment definition.</p>
|
|
7987
7896
|
* @public
|
|
7988
7897
|
*/
|
|
7989
|
-
|
|
7898
|
+
SegmentDefinitionName?: string | undefined;
|
|
7990
7899
|
/**
|
|
7991
|
-
* <p>
|
|
7900
|
+
* <p>Display name of the segment definition.</p>
|
|
7992
7901
|
* @public
|
|
7993
7902
|
*/
|
|
7994
|
-
|
|
7903
|
+
DisplayName?: string | undefined;
|
|
7995
7904
|
/**
|
|
7996
|
-
* <p>
|
|
7905
|
+
* <p>The description of the segment definition.</p>
|
|
7997
7906
|
* @public
|
|
7998
7907
|
*/
|
|
7999
|
-
|
|
7908
|
+
Description?: string | undefined;
|
|
8000
7909
|
/**
|
|
8001
|
-
* <p>
|
|
7910
|
+
* <p>The arn of the segment definition.</p>
|
|
8002
7911
|
* @public
|
|
8003
7912
|
*/
|
|
8004
|
-
|
|
7913
|
+
SegmentDefinitionArn?: string | undefined;
|
|
8005
7914
|
/**
|
|
8006
|
-
* <p>
|
|
7915
|
+
* <p>When the segment definition was created.</p>
|
|
8007
7916
|
* @public
|
|
8008
7917
|
*/
|
|
8009
|
-
|
|
7918
|
+
CreatedAt?: Date | undefined;
|
|
8010
7919
|
/**
|
|
8011
|
-
* <p>
|
|
7920
|
+
* <p>The tags belonging to the segment definition.</p>
|
|
8012
7921
|
* @public
|
|
8013
7922
|
*/
|
|
8014
|
-
|
|
7923
|
+
Tags?: Record<string, string> | undefined;
|
|
8015
7924
|
/**
|
|
8016
|
-
* <p>
|
|
7925
|
+
* <p>The segment type.</p>
|
|
7926
|
+
* <p> Classic : Segments created using traditional SegmentGroup structure</p>
|
|
7927
|
+
* <p> Enhanced : Segments created using SQL queries
|
|
7928
|
+
* </p>
|
|
8017
7929
|
* @public
|
|
8018
7930
|
*/
|
|
8019
|
-
|
|
7931
|
+
SegmentType?: SegmentType | undefined;
|
|
8020
7932
|
}
|
|
8021
7933
|
/**
|
|
8022
7934
|
* @public
|
|
8023
7935
|
*/
|
|
8024
|
-
export interface
|
|
8025
|
-
/**
|
|
8026
|
-
* <p>The unique name of the domain.</p>
|
|
8027
|
-
* @public
|
|
8028
|
-
*/
|
|
8029
|
-
DomainName: string | undefined;
|
|
8030
|
-
/**
|
|
8031
|
-
* <p>The identifier of the profile to be taken.</p>
|
|
8032
|
-
* @public
|
|
8033
|
-
*/
|
|
8034
|
-
MainProfileId: string | undefined;
|
|
7936
|
+
export interface ListSegmentDefinitionsResponse {
|
|
8035
7937
|
/**
|
|
8036
|
-
* <p>The
|
|
7938
|
+
* <p>The pagination token from the previous call.</p>
|
|
8037
7939
|
* @public
|
|
8038
7940
|
*/
|
|
8039
|
-
|
|
7941
|
+
NextToken?: string | undefined;
|
|
8040
7942
|
/**
|
|
8041
|
-
* <p>
|
|
8042
|
-
* to the merge. For example, say you want to merge EmailAddress from Profile1 into
|
|
8043
|
-
* MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
|
|
7943
|
+
* <p>List of segment definitions.</p>
|
|
8044
7944
|
* @public
|
|
8045
7945
|
*/
|
|
8046
|
-
|
|
7946
|
+
Items?: SegmentDefinitionItem[] | undefined;
|
|
8047
7947
|
}
|
|
8048
7948
|
/**
|
|
8049
7949
|
* @public
|
|
8050
7950
|
*/
|
|
8051
|
-
export interface
|
|
7951
|
+
export interface ListTagsForResourceRequest {
|
|
8052
7952
|
/**
|
|
8053
|
-
* <p>
|
|
7953
|
+
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
8054
7954
|
* @public
|
|
8055
7955
|
*/
|
|
8056
|
-
|
|
7956
|
+
resourceArn: string | undefined;
|
|
8057
7957
|
}
|