@aws-sdk/client-customer-profiles 3.1029.0 → 3.1031.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.
Files changed (59) hide show
  1. package/README.md +28 -0
  2. package/dist-cjs/index.js +92 -4
  3. package/dist-cjs/schemas/schemas_0.js +148 -31
  4. package/dist-es/CustomerProfiles.js +10 -0
  5. package/dist-es/commands/CreateRecommenderSchemaCommand.js +16 -0
  6. package/dist-es/commands/DeleteRecommenderSchemaCommand.js +16 -0
  7. package/dist-es/commands/GetRecommenderSchemaCommand.js +16 -0
  8. package/dist-es/commands/ListRecommenderSchemasCommand.js +16 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/enums.js +28 -4
  11. package/dist-es/pagination/ListRecommenderSchemasPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/schemas/schemas_0.js +139 -23
  14. package/dist-types/CustomerProfiles.d.ts +35 -0
  15. package/dist-types/CustomerProfilesClient.d.ts +6 -2
  16. package/dist-types/commands/CreateRecommenderCommand.d.ts +6 -0
  17. package/dist-types/commands/CreateRecommenderFilterCommand.d.ts +1 -0
  18. package/dist-types/commands/CreateRecommenderSchemaCommand.d.ts +117 -0
  19. package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +10 -0
  20. package/dist-types/commands/DeleteRecommenderSchemaCommand.d.ts +88 -0
  21. package/dist-types/commands/GetRecommenderCommand.d.ts +11 -0
  22. package/dist-types/commands/GetRecommenderFilterCommand.d.ts +1 -0
  23. package/dist-types/commands/GetRecommenderSchemaCommand.d.ts +101 -0
  24. package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +10 -0
  25. package/dist-types/commands/ListRecommenderFiltersCommand.d.ts +1 -0
  26. package/dist-types/commands/ListRecommenderSchemasCommand.d.ts +107 -0
  27. package/dist-types/commands/ListRecommendersCommand.d.ts +11 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  29. package/dist-types/commands/ListUploadJobsCommand.d.ts +1 -1
  30. package/dist-types/commands/ListWorkflowsCommand.d.ts +1 -1
  31. package/dist-types/commands/MergeProfilesCommand.d.ts +1 -1
  32. package/dist-types/commands/PutDomainObjectTypeCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateRecommenderCommand.d.ts +5 -0
  34. package/dist-types/commands/index.d.ts +4 -0
  35. package/dist-types/models/enums.d.ts +68 -12
  36. package/dist-types/models/models_0.d.ts +286 -414
  37. package/dist-types/models/models_1.d.ts +414 -2
  38. package/dist-types/pagination/ListRecommenderSchemasPaginator.d.ts +7 -0
  39. package/dist-types/pagination/index.d.ts +1 -0
  40. package/dist-types/schemas/schemas_0.d.ts +16 -0
  41. package/dist-types/ts3.4/CustomerProfiles.d.ts +75 -0
  42. package/dist-types/ts3.4/CustomerProfilesClient.d.ts +24 -0
  43. package/dist-types/ts3.4/commands/CreateRecommenderSchemaCommand.d.ts +51 -0
  44. package/dist-types/ts3.4/commands/DeleteRecommenderSchemaCommand.d.ts +51 -0
  45. package/dist-types/ts3.4/commands/GetRecommenderSchemaCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/ListRecommenderSchemasCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -4
  48. package/dist-types/ts3.4/commands/ListUploadJobsCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/MergeProfilesCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/PutDomainObjectTypeCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  53. package/dist-types/ts3.4/models/enums.d.ts +37 -5
  54. package/dist-types/ts3.4/models/models_0.d.ts +71 -93
  55. package/dist-types/ts3.4/models/models_1.d.ts +98 -0
  56. package/dist-types/ts3.4/pagination/ListRecommenderSchemasPaginator.d.ts +11 -0
  57. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  58. package/dist-types/ts3.4/schemas/schemas_0.d.ts +16 -0
  59. 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, SegmentType, ServiceNowConnectorOperator, 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>
@@ -3204,6 +3300,43 @@ export interface SegmentGroup {
3204
3300
  */
3205
3301
  Include?: IncludeOptions | undefined;
3206
3302
  }
3303
+ /**
3304
+ * <p>Defines the characteristics and rules for sorting by a specific attribute.</p>
3305
+ * @public
3306
+ */
3307
+ export interface SortAttribute {
3308
+ /**
3309
+ * <p>The name of the attribute to sort by.</p>
3310
+ * @public
3311
+ */
3312
+ Name: string | undefined;
3313
+ /**
3314
+ * <p>The data type of the sort attribute (e.g., string, number, date).</p>
3315
+ * @public
3316
+ */
3317
+ DataType?: SegmentSortDataType | undefined;
3318
+ /**
3319
+ * <p>The sort order for the attribute (ascending or descending).</p>
3320
+ * @public
3321
+ */
3322
+ Order: SegmentSortOrder | undefined;
3323
+ /**
3324
+ * <p>The type of attribute (e.g., profile, calculated).</p>
3325
+ * @public
3326
+ */
3327
+ Type?: SortAttributeType | undefined;
3328
+ }
3329
+ /**
3330
+ * <p>Defines how segments should be sorted and ordered in the results.</p>
3331
+ * @public
3332
+ */
3333
+ export interface SegmentSort {
3334
+ /**
3335
+ * <p>A list of attributes used to sort the segments and their ordering preferences.</p>
3336
+ * @public
3337
+ */
3338
+ Attributes: SortAttribute[] | undefined;
3339
+ }
3207
3340
  /**
3208
3341
  * @public
3209
3342
  */
@@ -3239,6 +3372,11 @@ export interface CreateSegmentDefinitionRequest {
3239
3372
  * @public
3240
3373
  */
3241
3374
  SegmentSqlQuery?: string | undefined;
3375
+ /**
3376
+ * <p>The segment sort.</p>
3377
+ * @public
3378
+ */
3379
+ SegmentSort?: SegmentSort | undefined;
3242
3380
  /**
3243
3381
  * <p>The tags used to organize, track, or control access for this resource.</p>
3244
3382
  * @public
@@ -3399,7 +3537,7 @@ export interface ObjectTypeField {
3399
3537
  Source?: string | undefined;
3400
3538
  /**
3401
3539
  * <p>The location of the data in the standard ProfileObject model. For example:
3402
- * _profile.Address.PostalCode.</p>
3540
+ * _profile.Address.PostalCode. Do not include sensitive or personally identifiable information (PII) in the target field name.</p>
3403
3541
  * @public
3404
3542
  */
3405
3543
  Target?: string | undefined;
@@ -3774,6 +3912,26 @@ export interface DeleteRecommenderFilterResponse {
3774
3912
  */
3775
3913
  Message: string | undefined;
3776
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
+ }
3777
3935
  /**
3778
3936
  * @public
3779
3937
  */
@@ -5348,6 +5506,11 @@ export interface GetRecommenderResponse {
5348
5506
  * @public
5349
5507
  */
5350
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;
5351
5514
  /**
5352
5515
  * <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
5353
5516
  * @public
@@ -5423,6 +5586,11 @@ export interface GetRecommenderFilterResponse {
5423
5586
  * @public
5424
5587
  */
5425
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;
5426
5594
  /**
5427
5595
  * <p>The timestamp of when the recommender filter was created.</p>
5428
5596
  * @public
@@ -5449,6 +5617,46 @@ export interface GetRecommenderFilterResponse {
5449
5617
  */
5450
5618
  Tags: Record<string, string> | undefined;
5451
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
+ }
5452
5660
  /**
5453
5661
  * @public
5454
5662
  */
@@ -5488,6 +5696,11 @@ export interface GetSegmentDefinitionResponse {
5488
5696
  * @public
5489
5697
  */
5490
5698
  SegmentGroups?: SegmentGroup | undefined;
5699
+ /**
5700
+ * <p>The segment sort.</p>
5701
+ * @public
5702
+ */
5703
+ SegmentSort?: SegmentSort | undefined;
5491
5704
  /**
5492
5705
  * <p>The arn of the segment definition.</p>
5493
5706
  * @public
@@ -7362,6 +7575,11 @@ export interface RecommenderFilterSummary {
7362
7575
  * @public
7363
7576
  */
7364
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;
7365
7583
  /**
7366
7584
  * <p>The filter expression that defines which items to include or exclude from recommendations.</p>
7367
7585
  * @public
@@ -7489,6 +7707,11 @@ export interface RecommenderSummary {
7489
7707
  * @public
7490
7708
  */
7491
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;
7492
7715
  /**
7493
7716
  * <p>The configuration settings applied to this recommender.</p>
7494
7717
  * @public
@@ -7545,6 +7768,67 @@ export interface ListRecommendersResponse {
7545
7768
  */
7546
7769
  Recommenders?: RecommenderSummary[] | undefined;
7547
7770
  }
7771
+ /**
7772
+ * @public
7773
+ */
7774
+ export interface ListRecommenderSchemasRequest {
7775
+ /**
7776
+ * <p>The unique name of the domain.</p>
7777
+ * @public
7778
+ */
7779
+ DomainName: string | undefined;
7780
+ /**
7781
+ * <p>The maximum number of recommender schemas to return in the response. The default value is 100.</p>
7782
+ * @public
7783
+ */
7784
+ MaxResults?: number | undefined;
7785
+ /**
7786
+ * <p>A token received from a previous ListRecommenderSchemas call to retrieve the next page of results.</p>
7787
+ * @public
7788
+ */
7789
+ NextToken?: string | undefined;
7790
+ }
7791
+ /**
7792
+ * <p>Provides a summary of a recommender schema's configuration and current state.</p>
7793
+ * @public
7794
+ */
7795
+ export interface RecommenderSchemaSummary {
7796
+ /**
7797
+ * <p>The name of the recommender schema.</p>
7798
+ * @public
7799
+ */
7800
+ RecommenderSchemaName: string | undefined;
7801
+ /**
7802
+ * <p>A map of dataset type to column definitions included in the schema.</p>
7803
+ * @public
7804
+ */
7805
+ Fields: Record<string, RecommenderSchemaField[]> | undefined;
7806
+ /**
7807
+ * <p>The timestamp when the recommender schema was created.</p>
7808
+ * @public
7809
+ */
7810
+ CreatedAt: Date | undefined;
7811
+ /**
7812
+ * <p>The current operational status of the recommender schema.</p>
7813
+ * @public
7814
+ */
7815
+ Status: RecommenderSchemaStatus | undefined;
7816
+ }
7817
+ /**
7818
+ * @public
7819
+ */
7820
+ export interface ListRecommenderSchemasResponse {
7821
+ /**
7822
+ * <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
7823
+ * @public
7824
+ */
7825
+ NextToken?: string | undefined;
7826
+ /**
7827
+ * <p>A list of recommender schemas and their properties in the specified domain.</p>
7828
+ * @public
7829
+ */
7830
+ RecommenderSchemas?: RecommenderSchemaSummary[] | undefined;
7831
+ }
7548
7832
  /**
7549
7833
  * @public
7550
7834
  */
@@ -7671,415 +7955,3 @@ export interface ListTagsForResourceRequest {
7671
7955
  */
7672
7956
  resourceArn: string | undefined;
7673
7957
  }
7674
- /**
7675
- * @public
7676
- */
7677
- export interface ListTagsForResourceResponse {
7678
- /**
7679
- * <p>The tags used to organize, track, or control access for this resource.</p>
7680
- * @public
7681
- */
7682
- tags?: Record<string, string> | undefined;
7683
- }
7684
- /**
7685
- * @public
7686
- */
7687
- export interface ListUploadJobsRequest {
7688
- /**
7689
- * <p>The unique name of the domain to list upload jobs for. </p>
7690
- * @public
7691
- */
7692
- DomainName: string | undefined;
7693
- /**
7694
- * <p>The maximum number of upload jobs to return per page. </p>
7695
- * @public
7696
- */
7697
- MaxResults?: number | undefined;
7698
- /**
7699
- * <p>The pagination token from the previous call to retrieve the next page of results.
7700
- * </p>
7701
- * @public
7702
- */
7703
- NextToken?: string | undefined;
7704
- }
7705
- /**
7706
- * <p>The summary information for an individual upload job. </p>
7707
- * @public
7708
- */
7709
- export interface UploadJobItem {
7710
- /**
7711
- * <p>The unique identifier of the upload job. </p>
7712
- * @public
7713
- */
7714
- JobId?: string | undefined;
7715
- /**
7716
- * <p>The name of the upload job. </p>
7717
- * @public
7718
- */
7719
- DisplayName?: string | undefined;
7720
- /**
7721
- * <p>The current status of the upload job. </p>
7722
- * @public
7723
- */
7724
- Status?: UploadJobStatus | undefined;
7725
- /**
7726
- * <p>The reason for the current status of the upload job. </p>
7727
- * @public
7728
- */
7729
- StatusReason?: StatusReason | undefined;
7730
- /**
7731
- * <p>The timestamp when the upload job was created. </p>
7732
- * @public
7733
- */
7734
- CreatedAt?: Date | undefined;
7735
- /**
7736
- * <p>The timestamp when the upload job was completed. </p>
7737
- * @public
7738
- */
7739
- CompletedAt?: Date | undefined;
7740
- /**
7741
- * <p>The expiry duration for the profiles ingested with the upload job. </p>
7742
- * @public
7743
- */
7744
- DataExpiry?: number | undefined;
7745
- }
7746
- /**
7747
- * @public
7748
- */
7749
- export interface ListUploadJobsResponse {
7750
- /**
7751
- * <p>The pagination token to use to retrieve the next page of results. </p>
7752
- * @public
7753
- */
7754
- NextToken?: string | undefined;
7755
- /**
7756
- * <p>The list of upload jobs for the specified domain. </p>
7757
- * @public
7758
- */
7759
- Items?: UploadJobItem[] | undefined;
7760
- }
7761
- /**
7762
- * @public
7763
- */
7764
- export interface ListWorkflowsRequest {
7765
- /**
7766
- * <p>The unique name of the domain.</p>
7767
- * @public
7768
- */
7769
- DomainName: string | undefined;
7770
- /**
7771
- * <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
7772
- * @public
7773
- */
7774
- WorkflowType?: WorkflowType | undefined;
7775
- /**
7776
- * <p>Status of workflow execution.</p>
7777
- * @public
7778
- */
7779
- Status?: Status | undefined;
7780
- /**
7781
- * <p>Retrieve workflows started after timestamp.</p>
7782
- * @public
7783
- */
7784
- QueryStartDate?: Date | undefined;
7785
- /**
7786
- * <p>Retrieve workflows ended after timestamp.</p>
7787
- * @public
7788
- */
7789
- QueryEndDate?: Date | undefined;
7790
- /**
7791
- * <p>The token for the next set of results. Use the value returned in the previous
7792
- * response in the next request to retrieve the next set of results.</p>
7793
- * @public
7794
- */
7795
- NextToken?: string | undefined;
7796
- /**
7797
- * <p>The maximum number of results to return per page.</p>
7798
- * @public
7799
- */
7800
- MaxResults?: number | undefined;
7801
- }
7802
- /**
7803
- * <p>A workflow in list of workflows.</p>
7804
- * @public
7805
- */
7806
- export interface ListWorkflowsItem {
7807
- /**
7808
- * <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
7809
- * @public
7810
- */
7811
- WorkflowType: WorkflowType | undefined;
7812
- /**
7813
- * <p>Unique identifier for the workflow.</p>
7814
- * @public
7815
- */
7816
- WorkflowId: string | undefined;
7817
- /**
7818
- * <p>Status of workflow execution.</p>
7819
- * @public
7820
- */
7821
- Status: Status | undefined;
7822
- /**
7823
- * <p>Description for workflow execution status.</p>
7824
- * @public
7825
- */
7826
- StatusDescription: string | undefined;
7827
- /**
7828
- * <p>Creation timestamp for workflow.</p>
7829
- * @public
7830
- */
7831
- CreatedAt: Date | undefined;
7832
- /**
7833
- * <p>Last updated timestamp for workflow.</p>
7834
- * @public
7835
- */
7836
- LastUpdatedAt: Date | undefined;
7837
- }
7838
- /**
7839
- * @public
7840
- */
7841
- export interface ListWorkflowsResponse {
7842
- /**
7843
- * <p>List containing workflow details.</p>
7844
- * @public
7845
- */
7846
- Items?: ListWorkflowsItem[] | undefined;
7847
- /**
7848
- * <p>If there are additional results, this is the token for the next set of results.</p>
7849
- * @public
7850
- */
7851
- NextToken?: string | undefined;
7852
- }
7853
- /**
7854
- * <p>A duplicate customer profile that is to be merged into a main profile. </p>
7855
- * @public
7856
- */
7857
- export interface FieldSourceProfileIds {
7858
- /**
7859
- * <p>A unique identifier for the account number field to be merged. </p>
7860
- * @public
7861
- */
7862
- AccountNumber?: string | undefined;
7863
- /**
7864
- * <p>A unique identifier for the additional information field to be merged.</p>
7865
- * @public
7866
- */
7867
- AdditionalInformation?: string | undefined;
7868
- /**
7869
- * <p>A unique identifier for the party type field to be merged.</p>
7870
- * @public
7871
- */
7872
- PartyType?: string | undefined;
7873
- /**
7874
- * <p>A unique identifier for the business name field to be merged.</p>
7875
- * @public
7876
- */
7877
- BusinessName?: string | undefined;
7878
- /**
7879
- * <p>A unique identifier for the first name field to be merged.</p>
7880
- * @public
7881
- */
7882
- FirstName?: string | undefined;
7883
- /**
7884
- * <p>A unique identifier for the middle name field to be merged.</p>
7885
- * @public
7886
- */
7887
- MiddleName?: string | undefined;
7888
- /**
7889
- * <p>A unique identifier for the last name field to be merged.</p>
7890
- * @public
7891
- */
7892
- LastName?: string | undefined;
7893
- /**
7894
- * <p>A unique identifier for the birthdate field to be merged.</p>
7895
- * @public
7896
- */
7897
- BirthDate?: string | undefined;
7898
- /**
7899
- * <p>A unique identifier for the gender field to be merged.</p>
7900
- * @public
7901
- */
7902
- Gender?: string | undefined;
7903
- /**
7904
- * <p>A unique identifier for the phone number field to be merged.</p>
7905
- * @public
7906
- */
7907
- PhoneNumber?: string | undefined;
7908
- /**
7909
- * <p>A unique identifier for the mobile phone number field to be merged.</p>
7910
- * @public
7911
- */
7912
- MobilePhoneNumber?: string | undefined;
7913
- /**
7914
- * <p>A unique identifier for the home phone number field to be merged.</p>
7915
- * @public
7916
- */
7917
- HomePhoneNumber?: string | undefined;
7918
- /**
7919
- * <p>A unique identifier for the business phone number field to be merged.</p>
7920
- * @public
7921
- */
7922
- BusinessPhoneNumber?: string | undefined;
7923
- /**
7924
- * <p>A unique identifier for the email address field to be merged.</p>
7925
- * @public
7926
- */
7927
- EmailAddress?: string | undefined;
7928
- /**
7929
- * <p>A unique identifier for the personal email address field to be merged.</p>
7930
- * @public
7931
- */
7932
- PersonalEmailAddress?: string | undefined;
7933
- /**
7934
- * <p>A unique identifier for the party type field to be merged.</p>
7935
- * @public
7936
- */
7937
- BusinessEmailAddress?: string | undefined;
7938
- /**
7939
- * <p>A unique identifier for the party type field to be merged.</p>
7940
- * @public
7941
- */
7942
- Address?: string | undefined;
7943
- /**
7944
- * <p>A unique identifier for the shipping address field to be merged.</p>
7945
- * @public
7946
- */
7947
- ShippingAddress?: string | undefined;
7948
- /**
7949
- * <p>A unique identifier for the mailing address field to be merged.</p>
7950
- * @public
7951
- */
7952
- MailingAddress?: string | undefined;
7953
- /**
7954
- * <p>A unique identifier for the billing type field to be merged.</p>
7955
- * @public
7956
- */
7957
- BillingAddress?: string | undefined;
7958
- /**
7959
- * <p>A unique identifier for the attributes field to be merged.</p>
7960
- * @public
7961
- */
7962
- Attributes?: Record<string, string> | undefined;
7963
- /**
7964
- * <p>A unique identifier for the profile type field to be merged.</p>
7965
- * @public
7966
- */
7967
- ProfileType?: string | undefined;
7968
- /**
7969
- * <p>A unique identifier for the engagement preferences field to be merged.</p>
7970
- * @public
7971
- */
7972
- EngagementPreferences?: string | undefined;
7973
- }
7974
- /**
7975
- * @public
7976
- */
7977
- export interface MergeProfilesRequest {
7978
- /**
7979
- * <p>The unique name of the domain.</p>
7980
- * @public
7981
- */
7982
- DomainName: string | undefined;
7983
- /**
7984
- * <p>The identifier of the profile to be taken.</p>
7985
- * @public
7986
- */
7987
- MainProfileId: string | undefined;
7988
- /**
7989
- * <p>The identifier of the profile to be merged into MainProfileId.</p>
7990
- * @public
7991
- */
7992
- ProfileIdsToBeMerged: string[] | undefined;
7993
- /**
7994
- * <p>The identifiers of the fields in the profile that has the information you want to apply
7995
- * to the merge. For example, say you want to merge EmailAddress from Profile1 into
7996
- * MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
7997
- * @public
7998
- */
7999
- FieldSourceProfileIds?: FieldSourceProfileIds | undefined;
8000
- }
8001
- /**
8002
- * @public
8003
- */
8004
- export interface MergeProfilesResponse {
8005
- /**
8006
- * <p>A message that indicates the merge request is complete.</p>
8007
- * @public
8008
- */
8009
- Message?: string | undefined;
8010
- }
8011
- /**
8012
- * @public
8013
- */
8014
- export interface PutDomainObjectTypeRequest {
8015
- /**
8016
- * <p>The unique name of the domain.</p>
8017
- * @public
8018
- */
8019
- DomainName: string | undefined;
8020
- /**
8021
- * <p>The unique name of the domain object type.</p>
8022
- * @public
8023
- */
8024
- ObjectTypeName: string | undefined;
8025
- /**
8026
- * <p>The description of the domain object type.</p>
8027
- * @public
8028
- */
8029
- Description?: string | undefined;
8030
- /**
8031
- * <p>The customer provided KMS key used to encrypt this type of domain object.</p>
8032
- * @public
8033
- */
8034
- EncryptionKey?: string | undefined;
8035
- /**
8036
- * <p>A map of field names to their corresponding domain object type field definitions.</p>
8037
- * @public
8038
- */
8039
- Fields: Record<string, DomainObjectTypeField> | undefined;
8040
- /**
8041
- * <p>The tags used to organize, track, or control access for this resource.</p>
8042
- * @public
8043
- */
8044
- Tags?: Record<string, string> | undefined;
8045
- }
8046
- /**
8047
- * @public
8048
- */
8049
- export interface PutDomainObjectTypeResponse {
8050
- /**
8051
- * <p>The unique name of the domain object type.</p>
8052
- * @public
8053
- */
8054
- ObjectTypeName?: string | undefined;
8055
- /**
8056
- * <p>The description of the domain object type.</p>
8057
- * @public
8058
- */
8059
- Description?: string | undefined;
8060
- /**
8061
- * <p>The customer provided KMS key used to encrypt this type of domain object.</p>
8062
- * @public
8063
- */
8064
- EncryptionKey?: string | undefined;
8065
- /**
8066
- * <p>A map of field names to their corresponding domain object type field definitions.</p>
8067
- * @public
8068
- */
8069
- Fields?: Record<string, DomainObjectTypeField> | undefined;
8070
- /**
8071
- * <p>The timestamp of when the domain object type was created.</p>
8072
- * @public
8073
- */
8074
- CreatedAt?: Date | undefined;
8075
- /**
8076
- * <p>The timestamp of when the domain object type was most recently edited.</p>
8077
- * @public
8078
- */
8079
- LastUpdatedAt?: Date | undefined;
8080
- /**
8081
- * <p>The tags used to organize, track, or control access for this resource.</p>
8082
- * @public
8083
- */
8084
- Tags?: Record<string, string> | undefined;
8085
- }